Class CIM_FileSystemCapabilities
extends CIM_Capabilities

FileSystemCapabilities specifies the combination of properties that a FileSystemService can support when creating or maintaining FileSystems. Each supported combination of properties is specified by a FileSystemSetting that is associated with the FileSystemCapabilities element via ElementSettingData. A FileSystemCapabilities element specifies the properties supported when using it. This class provides a CreateGoal method that can be used to create a FileSystemSetting element that can be used as a goal for creating or modifying a filesystem. This class also supports persistence and recoverability of a FileSystem and its contained elements as defined in CIM 2.8 for the use of DatabaseStorageArea.

Table of Contents
Hierarchy
Direct Known Subclasses
Class Qualifiers
Class Properties
Class Methods


Class Hierarchy

CIM_ManagedElement
   |
   +--CIM_Capabilities
   |
   +--CIM_FileSystemCapabilities

Direct Known Subclasses

Class Qualifiers

NameData TypeValue
DescriptionstringFileSystemCapabilities specifies the combination of properties that a FileSystemService can support when creating or maintaining FileSystems. Each supported combination of properties is specified by a FileSystemSetting that is associated with the FileSystemCapabilities element via ElementSettingData. A FileSystemCapabilities element specifies the properties supported when using it. This class provides a CreateGoal method that can be used to create a FileSystemSetting element that can be used as a goal for creating or modifying a filesystem. This class also supports persistence and recoverability of a FileSystem and its contained elements as defined in CIM 2.8 for the use of DatabaseStorageArea.
UMLPackagePathstringCIM::System::FilesystemServices
Versionstring2.39.0

Class Properties

Local Class Properties

NameData TypeDefault ValueQualifiers
NameData TypeValue
ActualFileSystemTypeuint160
DescriptionstringAn enumerated value that indicates the file system implementation type supported by this Capabilities.
Experimentalbooleantrue
ModelCorrespondencestringCIM_FileSystemSetting.ActualFileSystemType
Readbooleantrue
ValueMapstring0, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, .., 0x8000..
ValuesstringUnknown, UFS, HFS, FAT, FAT16, FAT32, NTFS4, NTFS5, XFS, AFS, EXT2, EXT3, REISERFS, DMTF Reserved, Vendor Defined
SupportedOperationsuint16[]
DescriptionstringAn array of enumerated values representing the operations to files and directories on the file system. Set of supported operations depends on the file system type. The operation information is used as the action type in the access control management.
Experimentalbooleantrue
ValueMapstring1, 2, 3, 4, 5, 6, 7, .., 0x8000..
ValuesstringRead, Write, Execute, Create, Rename, Delete, Change Attribute, DMTF Reserved, Vendor Reserved
SupportedOtherPersistenceTypesstring[]
ArrayTypestringIndexed
DeprecatedstringCIM_FileSystemSetting.OtherPersistenceTypes
DescriptionstringAn array of strings describing the persistence capabilities where the corresponding entry in SupportedPersistenceTypes has a value of "Other". This value is ignored in all other cases.
ModelCorrespondencestringCIM_FileSystemCapabilities.SupportedPersistenceTypes, CIM_FileSystem.OtherPersistenceType
SupportedPersistenceTypesuint16[]
ArrayTypestringIndexed
DeprecatedstringCIM_FileSystemSetting.PersistenceTypes
DescriptionstringAn array of enumerated values representing the persistence capabilities of the FileSystem. A value of "Persistent" indicates that the FileSystem supports persistence, can be preserved through an orderly shutdown and could be protected. A value of "Temporary" indicates that the FileSystem supports non-persistence, may not be protected and may not survive a shutdown. A value of "External" indicates that the FileSystem could controlled outside of the operating environment and may need to be protected by specialized means. A value of "Other" is provided to allow for additional persistence types, to be described in the OtherPersistenceType attribute, and is expected to be rarely, if ever, used.
ModelCorrespondencestringCIM_FileSystemCapabilities.SupportedPersistenceTypes, CIM_FileSystem.PersistenceType
ValueMapstring1, 2, 3, 4
ValuesstringOther, Persistent, Temporary, External
SupportedPropertiesuint16[]
DescriptionstringAn array of property names of the Setting that this Capabilities element supports. The Object-related parameters are not specified because they must always be supported even if not used.
Experimentalbooleantrue
Readbooleantrue
ValueMapstring2, 3, 4, 5, 6, 7, 8, 9, 10, .., 0x8000..
ValuesstringDataExtentsSharing, CopyTarget, FilenameCaseAttributes, FilenameStreamFormats, FilenameFormats, LockingSemantics, AuthorizationProtocols, AuthenticationProtocols, Persistence, DMTF Reserved, Vendor Defined

Inherited Properties

NameData TypeClass Origin
CaptionstringCIM_ManagedElement
DescriptionstringCIM_ManagedElement
ElementNamestringCIM_Capabilities
Generationuint64CIM_ManagedElement
InstanceIDstringCIM_Capabilities

Class Methods

Local Class Methods

CreateGoal (uint16)

Method Qualifiers (CreateGoal)

NameData TypeValue
DescriptionstringStart a job to create a supported FileSystemSetting from a FileSystemSetting provided by the caller. If the operation completes successfully and did not require a long-running ConcreteJob, it will return 0. If 4096/0x1000 is returned, a ConcreteJob will be started to create the element. A Reference to the ConcreteJob will be returned in the output parameter Job. This method MAY return a CIM_Error representing that a single named property of a setting (or other) parameter (either reference or embedded object) has an invalid value or that an invalid combination of named properties of a setting (or other) parameter (either reference or embedded object) has been requested. If the input TemplateGoal is NULL or the empty string, this method returns a default FileSystemSetting that is supported by this FileSystemCapabilities. The output is returned as the SupportedGoal parameter. Both TemplateGoal and SupportedGoal are embedded objects and do not exist in the provider but are maintained by the client. If the TemplateGoal specifies values that cannot be supported this method MUST return an appropriate error and should return a best match for a SupportedGoal.
Experimentalbooleantrue
ValueMapstring0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, .., 4097, 4098..32767, 32768..65535
ValuesstringJob Completed with No Error, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, TemplateGoal is not well-formed, TemplateGoal cannot be satisfied exactly, StorageSetting cannot be used with ActualFileSystemType, StorageSetting cannot be used with CopyTarget, StorageSetting cannot be used with ObjectType, DMTF Reserved, Method Parameters Checked - Job Started, Method Reserved, Vendor Specific

Method Parameters (CreateGoal)

NameTypeQualifiers
NameData TypeValue
SupportedGoalstring
DescriptionstringSupportedGoal is an element of class CIM_FileSystemSetting, or a derived class, encoded as a string-valued embedded object parameter, that is used to return the best supported match to the TemplateGoal.
EmbeddedInstancestringCIM_FileSystemSetting
INbooleanfalse
OUTbooleantrue
TemplateGoalstring
DescriptionstringTemplateGoal is an element of class CIM_FileSystemSetting, or a derived class, encoded as a string-valued embedded object parameter, that is used as the template to be matched .
EmbeddedInstancestringCIM_FileSystemSetting
INbooleantrue
Job REF CIM_ConcreteJob
DescriptionstringReference to the job (may be null if job completed).
INbooleanfalse
OUTbooleantrue

GetRequiredStorageSize (uint64)

Method Qualifiers (GetRequiredStorageSize)

NameData TypeValue
DescriptionstringThis method returns the "expected" size of StorageExtent that would support a file system specified by the input FileSystemGoal parameter assuming that the other settings for the StorageExtent are specified by the ExtentSetting parameter. If the input FileSystemGoal or the ExtentSetting are NULL, this method returns a value computed by using the default FileSystemSetting or some vendor-specific canned StorageSetting. A value of 0 is returned if this method is not able to determine a reasonable size or does not restrict sizes based on setting information.
Experimentalbooleantrue
PUnitstringbyte
UnitsstringBytes

Method Parameters (GetRequiredStorageSize)

NameTypeQualifiers
NameData TypeValue
ExpectedSizeuint64
DescriptionstringA number that indicates the size of the storage extent that this FileSystem is expected to need. A value of 0 indicates that there is no expected size.
OUTbooleantrue
PUnitstringbyte
UnitsstringBytes
ExtentSettingstring
DescriptionstringExtentSetting is an element of class CIM_StorageSetting, or a derived class, encoded as a string-valued embedded object parameter, that is used to specify the settings of the StorageExtent to be used for this FileSystem.
EmbeddedInstancestringCIM_StorageSetting
INbooleantrue
FileSystemGoalstring
DescriptionstringFileSystemGoal is an element of class CIM_FileSystemSetting, or a derived class, encoded as a string-valued embedded object parameter, that is used to specify the settings for the FileSystem to be created.
EmbeddedInstancestringCIM_FileSystemSetting
INbooleantrue
MaximumSizeUsableuint64
DescriptionstringA number that indicates the size of the largest storage extent that would be usable for the specified FileSystem. A value of 0 indicates that there is no maximum size.
OUTbooleantrue
PUnitstringbyte
UnitsstringBytes
MinimumSizeAcceptableuint64
DescriptionstringA number that indicates the size of the smallest storage extent that would support the specified FileSystem. A value of 0 indicates that there is no minimum size.
OUTbooleantrue
PUnitstringbyte
UnitsstringBytes

GetElementNameCapabilities (uint32)

Method Qualifiers (GetElementNameCapabilities)

NameData TypeValue
DescriptionstringThis returns the restrictions on the ElementName in the related "OUT" parameters.
Experimentalbooleantrue
ValueMapstring0, 4, .., 0x8000..
ValuesstringSuccess, Failed, DMTF Reserved, Vendor Specific

Method Parameters (GetElementNameCapabilities)

NameTypeQualifiers
NameData TypeValue
ElementNameMaskstring
DescriptionstringThis string expresses the restrictions on ElementName. The mask is expressed as a regular expression. See DMTF standard ABNF with the Management Profile Specification Usage Guide, appendix C for the regular expression syntax permitted. Since the ElementNameMask can describe the maximum length of the ElementName,any length defined in the regexp is in addition to the restriction defined in MaxElementNameLen (causing the smaller value to be the maximum length). The ElementName value satisfies the restriction, if and only if it matches the regular expression. If NULL, it indicates no restrictions on the ElementName.
ModelCorrespondencestringCIM_EnabledLogicalElementCapabilities.ElementNameMask
Outbooleantrue
MaxElementNameLenuint16
DescriptionstringMaximum supported ElementName length in characters.
MappingStringsstringFC-SWAPI.INCITS-T11|SWAPI_UNIT_CONFIG_CAPS_T|MaxNameChars
MaxValuesint64256
ModelCorrespondencestringCIM_EnabledLogicalElementCapabilities.MaxElementNameLen
Outbooleantrue
SupportedFeaturesuint32[]
DescriptionstringEnumeration indicating what methods can accept the element name for creation or modification of a storage element. CreateFileSystem is an example of an InvokeMethod. ModifyInstance and SetProperty are examples of intrinsic methods. An empty array indicates ElementNaming for ElementType is not supported, in which case the other OUT parameters are null.
Outbooleantrue
ValueMapstring2, 3, 4, .., 32768..65535
ValuesstringElementName can be supplied during creation, ElementName can be modified with InvokeMethod, ElementName can be modified with intrinsic method, DMTF Reserved, Vendor Specific

Inherited Class Methods

NameReturn TypeClass Origin
CreateGoalSettingsuint16CIM_Capabilities