Class CIM_FileSystemSetting


  extends CIM_SettingData
The FileSystemSetting describes the attribute values set when creating a FileSystem by a FileSystemConfigurationService. These settings can be associated via the ElementSettingData association with the created FileSystem. If the setting is associated via SettingAssociatedToCapabilities to a FileSystemCapabilities, it is one of the canned settings supported by this capabilities instance. A setting can also be an embedded instance parameter to a method (for instance, when used as a Goal parameter). A NULL value for a property in a canned setting indicates support for a vendor-specific default. A NULL value for a property when the setting is used as a Goal parameter to a method indicates that the client does not care what value that property will have on creation and will accept any vendor-supplied default. When used with a FileSystem, a NULL value for a property must be interpreted as "Unknown". The ActualFileSystemType property cannot have a default value in any context. If this Setting is associated with a FileSystemCapabilities element via SettingAssociatedToCapabilities, the value of ActualFileSystemType in the Setting and the Capabilities MUST match. 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.
Details...
This class is not implemented.

Class Qualifiers

NameData TypeValueScopeFlavors
DescriptionstringThe FileSystemSetting describes the attribute values set when creating a FileSystem by a FileSystemConfigurationService. These settings can be associated via the ElementSettingData association with the created FileSystem. If the setting is associated via SettingAssociatedToCapabilities to a FileSystemCapabilities, it is one of the canned settings supported by this capabilities instance. A setting can also be an embedded instance parameter to a method (for instance, when used as a Goal parameter). A NULL value for a property in a canned setting indicates support for a vendor-specific default. A NULL value for a property when the setting is used as a Goal parameter to a method indicates that the client does not care what value that property will have on creation and will accept any vendor-supplied default. When used with a FileSystem, a NULL value for a property must be interpreted as "Unknown". The ActualFileSystemType property cannot have a default value in any context. If this Setting is associated with a FileSystemCapabilities element via SettingAssociatedToCapabilities, the value of ActualFileSystemType in the Setting and the Capabilities MUST match. 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.None TRANSLATABLE= true
ExperimentalbooleantrueTOSUBCLASS= falseNone
UMLPackagePathstringCIM::System::FilesystemServicesNone None
Versionstring2.10.0TOSUBCLASS= falseTRANSLATABLE= true

Local Class Properties

NameData TypeQualifiers
NameData TypeValueScopeFlavors
ActualFileSystemTypeuint16
DescriptionstringAn enumerated value that indicates the file system implementation type supported by this Setting. This property MUST exist and have a value.None TRANSLATABLE= true
ModelCorrespondencestringCIM_FileSystemCapabilities.ActualFileSystemTypeNone None
ReadbooleantrueNone None
ValueMapstring0, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, .., 0x8000..None None
ValuesstringUnknown, UFS, HFS, FAT, FAT16, FAT32, NTFS4, NTFS5, XFS, AFS, EXT2, EXT3, REISERFS, DMTF Reserved, Vendor DefinedNone TRANSLATABLE= true
Captionstring
DescriptionstringThe Caption property is a short textual description (one- line string) of the object.None TRANSLATABLE= true
MaxLenuint3264None None
ChangeableTypeuint16
DescriptionstringEnumeration indicating the type of setting. 0 "Not Changeable - Persistent" indicates the instance of SettingData represents primordial settings and shall not be modifiable. 1 "Changeable - Transient" indicates the SettingData represents modifiable settings that are not persisted. Establishing persistent settings from transient settings may be supported. 2 "Changeable - Persistent" indicates the SettingData represents a persistent configuration that may be modified. 3 "Not Changeable - Transient" indicates the SettingData represents a snapshot of the settings of the associated ManagedElement and is not persistent.None TRANSLATABLE= true
ExperimentalbooleantrueTOSUBCLASS= falseNone
ValueMapstring0, 1, 2, 3None None
ValuesstringNot Changeable - Persistent, Changeable - Transient, Changeable - Persistent, Not Changeable - TransientNone TRANSLATABLE= true
ConfigurationNamestring
DescriptionstringAn instance of CIM_SettingData may correspond to a well-known configuration that exists for an associated CIM_ManagedElement. If the ConfigurationName property is non-NULL, the instance of CIM_SettingData shall correspond to a well-known configuration for a Managed Element, the value of the ConfigurationName property shall be the name of the configuration, and the ChangeableType property shall have the value 0 or 2. A value of NULL for the ConfigurationName property shall mean that the instance of CIM_SettingData does not correspond to a well-known configuration for a Managed Element or that this information is unknown.None TRANSLATABLE= true
ExperimentalbooleantrueTOSUBCLASS= falseNone
CopyTargetuint16
DescriptionstringAn enumerated value that specifies if this FileSystem can be a target for synchronization with or mirror of another FileSystem, or if it cannot be a target.None TRANSLATABLE= true
ReadbooleantrueNone None
ValueMapstring0, 1, 2, 3, 4, 5, .., 0x8000..None None
ValuesstringUnknown, Can be a Primary only, Can be a Mirror only, Can be a Synchronization Target, Can be a Backup Target, Write Once, DMTF Reserved, Vendor DefinedNone TRANSLATABLE= true
DataExtentsSharinguint16
DescriptionstringAn enumerated value that specifies if the FileSystem supports or enforces sharing of data extents between objects.None TRANSLATABLE= true
ReadbooleantrueNone None
ValueMapstring0, 1, 2, 3, .., 0x8000..None None
ValuesstringUnknown, No Sharing, Sharing Possible/Optional, Sharing Enforced, DMTF Reserved, Vendor DefinedNone TRANSLATABLE= true
Descriptionstring
DescriptionstringThe Description property provides a textual description of the object.None TRANSLATABLE= true
ElementNamestring
DescriptionstringThe user-friendly name for this instance of SettingData. In addition, the user-friendly name can be used as an index property for a search or query. (Note: The name does not have to be unique within a namespace.)None TRANSLATABLE= true
OverridestringElementNameTOSUBCLASS= falseNone
RequiredbooleantrueNone OVERRIDABLE= false
FilenameCaseAttributesuint16
DescriptionstringAn enumerated value that specifies how this FileSystem supports the case of characters in the Filename. Note that the host and the service may support multiple conflicting features, but each FileSystem must be configured with only one of the supported features.None TRANSLATABLE= true
ReadbooleantrueNone None
ValueMapstring0, 1, 2, 3, 4, 5, .., 0x8000..None None
ValuesstringUnknown, Case-sensitive, Case-forced to upper case, Case-forced to lower-case, Case-indifferent but lost, Case-indifferent but preserved, DMTF Reserved, Vendor DefinedNone TRANSLATABLE= true
FilenameFormatsuint16
ArrayTypestringIndexedNone OVERRIDABLE= false
DescriptionstringAn array of enumerated values that specify the filename formats supported on this FileSystem for naming files. Some common formats are: a) DOS 8.3 b) VMS 'name.extension;version' where the extension specifies a file type c) Unix name (file type is not specified in the name) d) Windows 'name{.ext}*' where any of the exts can specify a file type For each entry in this array there is an associated maximum length for the name and an associated reserved set of characters. The interpretation of the maximum length of the name as well as the FilenameReservedCharacterSet string is vendor-specific.None TRANSLATABLE= true
ModelCorrespondencestringCIM_FileSystemSetting.FilenameLengthMax, CIM_FileSystemSetting.FilenameReservedCharacterSetNone None
ReadbooleantrueNone None
ValueMapstring1, 2, 3, 4, .., 0x8000..None None
ValuesstringDOS8.3, Unix, VMS, Windows LongNames, DMTF Reserved, Vendor DefinedNone TRANSLATABLE= true
FilenameLengthMaxuint16
ArrayTypestringIndexedNone OVERRIDABLE= false
DescriptionstringAn array of integers that specify the maximum number of characters in a filename corresponding to an entry in the FilenameFormats property. An entry of '0xFFFF' (the largest 16-bit integer) is interpreted as an indefinite length.None TRANSLATABLE= true
ModelCorrespondencestringCIM_FileSystemSetting.FilenameFormatsNone None
ReadbooleantrueNone None
FilenameReservedCharacterSetstring
ArrayTypestringIndexedNone OVERRIDABLE= false
DescriptionstringAn array of strings that specifies the characters that may not appear in the name of any file contained by this FileSystem corresponding to the entry in the FilenameFormats property. Note: It is not clear exactly how this works with the FilenameStreamFormats property above, since the format implicitly specifies the set of allowed characters.None TRANSLATABLE= true
ModelCorrespondencestringCIM_FileSystemSetting.FilenameFormatsNone None
ReadbooleantrueNone None
FilenameStreamFormatsuint16
ArrayTypestringIndexedNone OVERRIDABLE= false
DescriptionstringAn array of enumerated integers representing the filename stream formats that the file system can support for access. The interpretation of these stream formats can be specific to vendors, or provided by some standard. But even within those constraints, the interpretation could be locale-specific or version-specific. For instance, Bytestream is locale-specific and is interpreted as ASCII for NFS v2 and v3 but UTF-8 in NFS v4. This additional information will normally be provided in the setting for the protocol used to access an element of this file system.None TRANSLATABLE= true
ReadbooleantrueNone None
ValueMapstring1, 2, 3, 4, 5, 6, 7, 8, .., 0x8000..None None
ValuesstringASCII, WideChar, MBCS, UTF-8, UNICODE UCS-16, UNICODE UCS-32, CIFS Client-interpreted, Bytestream, DMTF Reserved, Vendor DefinedNone TRANSLATABLE= true
Generationuint64
DescriptionstringGeneration is an optional, monotonically increasing property that may be used to identify a particular generation of the resource represented by this class. If Generation is supported by the implementation, its value shall not be null. Except as otherwise specified, a value (including null) of Generation specified at creation time shall be replaced by null if Generation is not supported by the implementation or shall be a, (possibly different), non-null value if the implementation does support Generation. After creation and if supported, Generation shall be updated, at least once per access, whenever the represented resource is modified, regardless of the source of the modification. Note: the Generation value only needs to be updated once between references, even if the resource is updated many times. The key point is to assure that it will be different if there have been updates, not to count each update. Note: unless otherwise specified, the value of Generation within one instance is not required to be coordinated with the value of Generation in any other instance. Note:the semantics of the instance, (as defined by its creation class), define the underlying resource. That underlying resource may be a collection or aggregation of resources. And, in that case, the semantics of the instance further define when updates to constituent resources also require updates to the Generation of the collective resource. Default behavior of composite aggregations should be to update the Generation of the composite whenever the Generation of a component is updated. Subclasses may define additional requirements for updates on some or all of related instances. For a particular instance, the value of Generation may wrap through zero, but the elapsed time between wraps shall be greater than 10's of years. This class does not require Generation to be unique across instances of other classes nor across instances of the same class that have different keys. Generation shall be different across power cycles, resets, or reboots if any of those actions results in an update. Generation may be different across power cycles, resets, or reboots if those actions do not result in an update. If the Generation property of an instance is non-null, and if any attempt to update the instance includes the Generation property, then if it doesn't match the current value, the update shall fail. The usage of this property is intended to be further specified by applicable management profiles. Typically, a client will read the value of this property and then supply that value as input to an operation that modifies the instance in some means. This may be via an explicit parameter in an extrinsic method or via an embedded value in an extrinsic method or intrinsic operation. For example: a profile may require that an intrinsic instance modification supply the Generation property and that it must match for the modification to succeed.None TRANSLATABLE= true
ExperimentalbooleantrueTOSUBCLASS= falseNone
InstanceIDstring
DescriptionstringWithin the scope of the instantiating Namespace, InstanceID opaquely and uniquely identifies an instance of this class. 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 that is creating or defining the InstanceID or that is a registered ID assigned to the business entity by a recognized global authority. (This requirement 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 reused to identify different underlying (real-world) elements. If the above "preferred" algorithm is not used, the defining entity must assure that the resulting InstanceID is not reused across any InstanceIDs produced by this or other providers for the NameSpace of this instance. For DMTF-defined instances, the "preferred" algorithm must be used with the <OrgID> set to CIM.None TRANSLATABLE= true
KeybooleantrueNone OVERRIDABLE= false
OverridestringInstanceIDTOSUBCLASS= falseNone
NumberOfObjectsuint64
ArrayTypestringIndexedNone OVERRIDABLE= false
DescriptionstringAn array of integers that specifies the number of objects (corresponding to the entry in the ObjectTypes array) that this FileSystem will "normally" contain. A value of 0 implies that there is no specific number associated with this setting. When the Setting is associated with a FileSystemCapabilities element, this is the default; When the Setting is associated with a FileSystem element, this is the expected value; When the Setting is used as an embedded parameter to a method this is the goal.None TRANSLATABLE= true
ModelCorrespondencestringCIM_FileSystemSetting.ObjectTypesNone None
ReadbooleantrueNone None
NumberOfObjectsMaxuint64
ArrayTypestringIndexedNone OVERRIDABLE= false
DescriptionstringAn array of integers that specifies the maximum number of objects (corresponding to the entry in the ObjectTypes array) that this FileSystem MUST be able to contain. A value of 0 implies that there is no specific maximum associated with this setting.None TRANSLATABLE= true
ModelCorrespondencestringCIM_FileSystemSetting.ObjectTypesNone None
ReadbooleantrueNone None
NumberOfObjectsMinuint64
ArrayTypestringIndexedNone OVERRIDABLE= false
DescriptionstringAn array of integers that specifies the minimum number of objects (corresponding to the entry in the ObjectTypes array) that this FileSystem MUST be able to contain. A value of 0 implies that there is no specific minimum associated with this setting.None TRANSLATABLE= true
ModelCorrespondencestringCIM_FileSystemSetting.ObjectTypesNone None
ReadbooleantrueNone None
ObjectSizeuint64
ArrayTypestringIndexedNone OVERRIDABLE= false
DescriptionstringAn array of integers that specifies the size of objects (corresponding to the entry in the ObjectTypes array) that this FileSystem will "normally" contain. A value of 0 implies that there is no specific number associated with this setting. When the Setting is associated with a FileSystemCapabilities element, this is the default; When the Setting is associated with a FileSystem element, this is the expected value; When the Setting is used as an embedded parameter to a method this is the goal.None TRANSLATABLE= true
ModelCorrespondencestringCIM_FileSystemSetting.ObjectTypesNone None
PUnitstringbyteNone None
ReadbooleantrueNone None
UnitsstringBytesNone TRANSLATABLE= true
ObjectSizeMaxuint64
ArrayTypestringIndexedNone OVERRIDABLE= false
DescriptionstringAn array of integers that specifies the maximum size of objects (corresponding to the entry in the ObjectTypes array) that this FileSystem will "normally" contain. A value of 0 implies that there is no specific maximum associated with this setting.None TRANSLATABLE= true
ModelCorrespondencestringCIM_FileSystemSetting.ObjectTypesNone None
PUnitstringbyteNone None
ReadbooleantrueNone None
UnitsstringBytesNone TRANSLATABLE= true
ObjectSizeMinuint64
ArrayTypestringIndexedNone OVERRIDABLE= false
DescriptionstringAn array of integers that specifies the minimum size of objects (corresponding to the entry in the ObjectTypes array) that this FileSystem will "normally" contain. A value of 0 implies that there is no specific minimum associated with this setting.None TRANSLATABLE= true
ModelCorrespondencestringCIM_FileSystemSetting.ObjectTypesNone None
PUnitstringbyteNone None
ReadbooleantrueNone None
UnitsstringBytesNone TRANSLATABLE= true
ObjectTypesuint16
ArrayTypestringIndexedNone OVERRIDABLE= false
DescriptionstringAn array of enumerated values that specifies the set of object types that this FileSystem supports. This array is associated with a number of correspondingly indexed properties that specify the size and number of such objects. When used as a goal, the client needs to specify only the subset of objects that they wish to specify; when used in a Setting associated with the FileSystem, this should contain all the types that the provider knows about; when used in a Setting associated with a Capabilities, this may only contain the types that the client can modify. "inodes" indicates that the number of required inodes is specified."files" indicates that the number of required files is specified."directories" indicates that the number of required directories is specified."links" indicates that the number of required links is specified."devices" indicates that the number of required devices is specified."files/directories" indicates that the number of required files and directories is specified."blocks" indicates that the size of required storage in client-specific storage units is specified. This represents the desired size of available space in the filesystem, exclusive of space reserved for meta-data and for other system functions. If "blocks" is specified, the corresponding ObjectSize properties must all be the same and must specify the intended size of the blocks in bytes.None TRANSLATABLE= true
ModelCorrespondencestringCIM_FileSystemSetting.NumberOfObjects, CIM_FileSystemSetting.NumberOfObjectsMax, CIM_FileSystemSetting.NumberOfObjectsMin, CIM_FileSystemSetting.ObjectSize, CIM_FileSystemSetting.ObjectSizeMax, CIM_FileSystemSetting.ObjectSizeMinNone None
ReadbooleantrueNone None
ValueMapstring2, 3, 4, 5, 6, 7, 8, .., 0x8000..None None
Valuesstringinodes, files, directories, links, devices, files/directories, Blocks, DMTF Reserved, Vendor DefinedNone TRANSLATABLE= true
OtherPersistenceTypesstring
ArrayTypestringIndexedNone OVERRIDABLE= false
DescriptionstringAn array of strings describing the persistence attributes where the corresponding entry in the PersistenceTypes property has a value of "Other". This value is ignored in all other cases.None TRANSLATABLE= true
ModelCorrespondencestringCIM_FileSystemSetting.PersistenceTypes, CIM_FileSystem.OtherPersistenceTypeNone None
PersistenceTypesuint16
ArrayTypestringIndexedNone OVERRIDABLE= false
DescriptionstringAn array of enumerated values representing the persistence attributes 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 corresponding entry of the OtherPersistenceTypes property, and is expected to be rarely, if ever, used.None TRANSLATABLE= true
ModelCorrespondencestringCIM_FileSystemSetting.OtherPersistenceTypes, CIM_FileSystem.PersistenceTypeNone None
ValueMapstring0, 1, 2, 3, 4, 5..None None
ValuesstringUnknown, Other, Persistent, Temporary, External, DMTF ReservedNone TRANSLATABLE= true
SupportedAuthenticationProtocolsuint16
ArrayTypestringIndexedNone OVERRIDABLE= false
DescriptionstringAn array of enumerated values that represent the authentication protocols that the FileSystem will support for access to objects by users, groups, accounts, etc.. An entry of '0' is not allowed. A FileSystem can support more than one authentication protocol.None TRANSLATABLE= true
ReadbooleantrueNone None
ValueMapstring1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, .., 0x8000..None None
ValuesstringAUTH_NONE, AUTH_SYS, AUTH_DH, AUTH_KRB4, AUTH_KRB5, RPCSEC_GSS LIPKEY, RPCSEC_GSS SPKM-3, RPCSEC_GSS Challenge-Response, NTLM v1, NTLM v2, Plain Text, DMTF Reserved, Vendor DefinedNone TRANSLATABLE= true
SupportedAuthorizationProtocolsuint16
ArrayTypestringIndexedNone OVERRIDABLE= false
DescriptionstringAn array of enumerated values that represent the authorization protocols that the FileSystem will support for access to objects by users, groups, accounts, etc. A FileSystem can support more than one authorization protocol.None TRANSLATABLE= true
ReadbooleantrueNone None
ValueMapstring1, 2, 3, 4, 5, .., 0x8000..None None
ValuesstringPosix Permissions, Posix ACLs, NFSv4 ACLs, NTFS4, NTFS5, DMTF Reserved, Vendor DefinedNone TRANSLATABLE= true
SupportedLockingSemanticsuint16
ArrayTypestringIndexedNone OVERRIDABLE= false
DescriptionstringAn array of enumerated values that represent the locking semantics that the FileSystem can support for controlled access. A file system can support more than one locking model. Just because a file system supports more than one model does not imply that it supports them simultaneously for an element.None TRANSLATABLE= true
ReadbooleantrueNone None
ValueMapstring1, 2, 3, 4, 5, 6, 7, 8, .., 0x8000..None None
ValuesstringNLM/NFSv3, NFSv4 Share Reservations, NFSv4 Byte-range locking, NFSv4 Delegations, CIFS Sharing locks, CIFS Byte-range locks, CIFS Exclusive/Batch oplocks, CIFS Level II oplocks, DMTF Reserved, Vendor DefinedNone TRANSLATABLE= true

Copyright © 2008-2010 VMware, Inc. All rights reserved.