System\CIM_FileSystemCapabilities.mof.mof (HTML version)

Return to index
CIM_FileSystemCapabilities Superclass: 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.
Qualifiers:Version ( "2.8.1000" ) UMLPackagePath ( "CIM::System::FilesystemServices" )
Parameters (local in grey)
ArrayType ( "Indexed" )
ModelCorrespondence { "CIM_FileSystemCapabilities.SupportedPersistenceTypes" , "CIM_FileSystem.OtherPersistenceType" }
Deprecated { "CIM_FileSystemSetting.OtherPersistenceTypes" }
string SupportedOtherPersistenceTypes [ ] ;
An 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.
ValueMap { "1" , "2" , "3" , "4" }
ArrayType ( "Indexed" )
Values { "Other" , "Persistent" , "Temporary" , "External" }
ModelCorrespondence { "CIM_FileSystemCapabilities.SupportedPersistenceTypes" , "CIM_FileSystem.PersistenceType" }
Deprecated { "CIM_FileSystemSetting.PersistenceTypes" }
uint16 SupportedPersistenceTypes [ ] ;
An 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.
Units ( "Bytes" )
Experimental
uint64GetRequiredStorageSize(
FileSystemGoal 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.
Qualifiers:EmbeddedInstance ( "CIM_FileSystemSetting" ) IN
string FileSystemGoal
ExtentSetting 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.
Qualifiers:EmbeddedInstance ( "CIM_StorageSetting" ) IN
string ExtentSetting
A 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.
Qualifiers:Units ( "Bytes" ) OUT
uint64 ExpectedSize
A 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.
Qualifiers:Units ( "Bytes" ) OUT
uint64 MinimumSizeAcceptable
A 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.
Qualifiers:Units ( "Bytes" ) OUT
uint64 MaximumSizeUsable
)
This 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.
ValueMap { "0" , "1" , "2" , "3" , "4" , "5" , "6" , "7" , "8" , "9" , "10" , ".." , "4097" , "4098..32767" , "32768..65535" }
Values { "Job 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" }
Experimental
uint16CreateGoal(
Reference to the job (may be null if job completed).
Qualifiers:OUT IN ( false )
CIM_ConcreteJob REF Job
TemplateGoal 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 .
Qualifiers:EmbeddedInstance ( "CIM_FileSystemSetting" ) IN
string TemplateGoal
SupportedGoal 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.
Qualifiers:EmbeddedInstance ( "CIM_FileSystemSetting" ) OUT IN ( false )
string SupportedGoal
)
Start 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.
ValueMap { "2" , "3" , "4" , "5" , "6" , "7" , "8" , "9" , "10" , ".." , "0x8000.." }
Values { "DataExtentsSharing" , "CopyTarget" , "FilenameCaseAttributes" , "FilenameStreamFormats" , "FilenameFormats" , "LockingSemantics" , "AuthorizationProtocols" , "AuthenticationProtocols" , "Persistence" , "DMTF Reserved" , "Vendor Defined" }
Read
Experimental
uint16 SupportedProperties [ ] ;
An 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.
ValueMap { "0" , "2" , "3" , "4" , "5" , "6" , "7" , "8" , "9" , "10" , "11" , "12" , "13" , ".." , "0x8000.." }
Values { "Unknown" , "UFS" , "HFS" , "FAT" , "FAT16" , "FAT32" , "NTFS4" , "NTFS5" , "XFS" , "AFS" , "EXT2" , "EXT3" , "REISERFS" , "DMTF Reserved" , "Vendor Defined" }
Read
Experimental
ModelCorrespondence { "CIM_FileSystemSetting.ActualFileSystemType" }
uint16 ActualFileSystemType = 0 ;
An enumerated value that indicates the file system implementation type supported by this Capabilities.
Required
Override ( "ElementName" )
string ElementName ;
The user friendly name for this instance of Capabilities. In addition, the user friendly name can be used as a index property for a search of query. (Note: Name does not have to be unique within a namespace.)
Key
string InstanceID ;
Within the scope of the instantiating Namespace, InstanceID opaquely and uniquely identifies an instance of this class. In order to ensure uniqueness within the NameSpace, the value of InstanceID SHOULD be constructed using the following 'preferred' algorithm:
<OrgID>:<LocalID>
Where <OrgID> and <LocalID> are separated by a colon ':', and where <OrgID> MUST include a copyrighted, trademarked or otherwise unique name that is owned by the business entity creating/defining the InstanceID, or is a registered ID that is assigned to the business entity by a recognized global authority (This is similar to the <Schema Name>_<Class Name> structure of Schema class names.) In addition, to ensure uniqueness <OrgID> MUST NOT contain a colon (':'). When using this algorithm, the first colon to appear in InstanceID MUST appear between <OrgID> and <LocalID>.
<LocalID> is chosen by the business entity and SHOULD not be re-used to identify different underlying (real-world) elements. If the above 'preferred' algorithm is not used, the defining entity MUST assure that the resultant InstanceID is not re-used across any InstanceIDs produced by this or other providers for this instance's NameSpace.
For DMTF defined instances, the 'preferred' algorithm MUST be used with the <OrgID> set to 'CIM'.
ValueMap { "0" , "1" , "2" , "3" , "4" , "5" , "6" , ".." , "32768..65535" }
Values { "Success" , "Not Supported" , "Unknown" , "Timeout" , "Failed" , "Invalid Parameter" , "Alternative Proposed" , "DMTF Reserved" , "Vendor Specific" }
Experimental
uint16CreateGoalSettings(
If provided, TemplateGoalSettings are elements of class CIM_SettingData, or a derived class, that is used as the template to be matched. .
At most, one instance of each SettingData subclass may be supplied.
All SettingData instances provided by this property are interpreted as a set, relative to this Capabilities instance.
SettingData instances that are not relevant to this instance are ignored.
If not provided, it shall be set to NULL. In that case, a SettingData instance representing the default settings of the associated ManagedElement is used.

Qualifiers:EmbeddedInstance ( "CIM_SettingData" ) IN
string TemplateGoalSettings [ ]
SupportedGoalSettings are elements of class CIM_SettingData, or a derived class.
At most, one instance of each SettingData subclass may be supplied.
All SettingData instances provided by this property are interpreted as a set, relative to this Capabilities instance.

To enable a client to provide additional information towards achieving the TemplateGoalSettings, an input set of SettingData instances may be provided. If not provided, this property shall be set to NULL on input.. Note that when provided, what property values are changed, and how, is implementation dependent and may be the subject of other standards.
If provided, the input SettingData instances must be ones that the implementation is able to support relative to the ManagedElement associated via ElementCapabilities. Typically, the input SettingData instances are created by a previous instantiation of CreateGoalSettings.
If the input SupportedGoalSettings is not supported by the implementation, then an 'Invalid Parameter' (5) error is returned by this call. In this case, a corresponding CIM_ERROR should also be returned.
On output, this property is used to return the best supported match to the TemplateGoalSettings.
If the output SupportedGoalSettings matches the input SupportedGoalSettings, then the implementation is unable to improve further towards meeting the TemplateGoalSettings.

Qualifiers:EmbeddedInstance ( "CIM_SettingData" ) OUT IN
string SupportedGoalSettings [ ]
)
Method to create a set of supported SettingData elements, from two sets of SettingData elements, provided by the caller.
CreateGoal should be used when the SettingData instances that represents the goal will not persist beyond the execution of the client and where those instances are not intended to be shared with other, non-cooperating clients.
Both TemplateGoalSettings and SupportedGoalSettings are represented as strings containing EmbeddedInstances of a CIM_SettingData subclass. These embedded instances do not exist in the infrastructure supporting this method but are maintained by the caller/client.
This method should return CIM_Error(s) 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 TemplateGoalSettings is NULL or the empty string, this method returns a default SettingData element that is supported by this Capabilities element.
If the TemplateGoalSettings specifies values that cannot be supported, this method shall return an appropriate CIM_Error and should return a best match for a SupportedGoalSettings.
The client proposes a goal using the TemplateGoalSettings parameter and gets back Success if the TemplateGoalSettings is exactly supportable. It gets back 'Alternative Proposed' if the output SupportedGoalSettings represents a supported alternative. This alternative should be a best match, as defined by the implementation.
If the implementation is conformant to a RegisteredProfile, then that profile may specify the algorithms used to determine best match. A client may compare the returned value of each property against the requested value to determine if it is left unchanged, degraded or upgraded.

Otherwise, if the TemplateGoalSettings is not applicable an 'Invalid Parameter' error is returned.

When a mutually acceptable SupportedGoalSettings has been achieved, the client may use the contained SettingData instances as input to methods for creating a new object ormodifying an existing object. Also the embedded SettingData instances returned in the SupportedGoalSettings may be instantiated via CreateInstance, either by a client or as a side-effect of the execution of an extrinsic method for which the returned SupportedGoalSettings is passed as an embedded instance.
MaxLen ( 64 )
string Caption ;
The Caption property is a short textual description (one- line string) of the object.
string Description ;
The Description property provides a textual description of the object.