| Name | Data Type | Qualifiers |
| Name | Data Type | Value | Scope | Flavors |
| AccessPoints | uint16 |
| Description | string | An enumerated value that specifies the service access points that are available to this FileShare by default for use by clients to connect. These default access points can always be overridden by the privileges explicitly defined by a supported authorization mechanism(s).
Any ServiceAccessPoints that actually connect to this share will be associated to it by CIM_SAPAvailableForElement. The resulting access privileges will be surfaced using the CIM_Privilege model.
'None' implies that no SAPs will have access by default.
'Service Default' indicates that any SAPs specified as the default port by the Service will have default access - this could be vendor-specific.
'All' indicates that all SAPs supported by the service will have access by default.
'Named Points' indicates that the Service Access Points that have default access may be specified as a parameter when this share was created or modified. These ports or endpoints will be given the necessary privileges to access this share. | None | TRANSLATABLE= true |
| Read | boolean | true | None | None |
| ValueMap | string | 0, 2, 3, 4, 5, .., 0x8000.. | None | None |
| Values | string | Unknown, None, Service Default, All, Named Points, DMTF Reserved, Vendor Defined | None | TRANSLATABLE= true |
| Caption | string |
| Description | string | The Caption property is a short textual description (one- line string) of the object. | None | TRANSLATABLE= true |
| MaxLen | uint32 | 64 | None | None |
| ChangeableType | uint16 |
| Description | string | Enumeration 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 |
| Experimental | boolean | true | TOSUBCLASS= false | None |
| ValueMap | string | 0, 1, 2, 3 | None | None |
| Values | string | Not Changeable - Persistent, Changeable - Transient, Changeable - Persistent, Not Changeable - Transient | None | TRANSLATABLE= true |
| ConfigurationName | string |
| Description | string | An 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 |
| Experimental | boolean | true | TOSUBCLASS= false | None |
| DefaultExecute | uint16 |
| Description | string | An enumerated value that specifies the default privileges that can be supported for 'execute' authorization in an appropriate operating environment. These default privileges can be overridden by privileges explicitly defined by a supported authorization mechanism(s).
'No Access' indicates that execute access is not allowed. 'Execute' indicates that execute access is implicitly granted to all clients. Any other execution privileges must be granted or denied explicitly using the vendor's authorization mechanism or by using the CIM_Privilege model. The resulting access privileges will be surfaced using the CIM_Privilege model. | None | TRANSLATABLE= true |
| Read | boolean | true | None | None |
| ValueMap | string | 0, 2, 3, .., 0x8000.. | None | None |
| Values | string | Unknown, No Access, Execute, DMTF Reserved, Vendor Defined | None | TRANSLATABLE= true |
| DefaultReadWrite | uint16 |
| Description | string | An enumerated value that specifies the default privileges that can be supported for read-write authorization. These default privileges can be overridden by privileges explicitly defined by a supported authorization mechanism(s).
'No Access' indicates that access is not allowed. 'Read Only' indicates that read-only access is implicitly granted to all clients and write access is implicitly denied to all clients. 'Read/Write' indicates that both read and write access is implicitly granted to all clients. Any other reading or writing privileges must be granted or denied explicitly using the vendor's authorization mechanism or by using the CIM_Privilege model. The resulting access privileges will be surfaced using the CIM_Privilege model. | None | TRANSLATABLE= true |
| Read | boolean | true | None | None |
| ValueMap | string | 0, 2, 3, 4, .., 0x8000.. | None | None |
| Values | string | Unknown, No Access, Read Only, Read/Write, DMTF Reserved, Vendor Defined | None | TRANSLATABLE= true |
| DefaultUserIdSupported | uint16 |
| Description | string | An enumerated integer that indicates whether the FileShare will use a default user id to control access to the share if the id of the importing client is not provided. 'No Default User Id' indicates that a default user should not be used. 'System-Specified Default User Id' indicates that only system-specified id should be used. 'Share-Specified Default Used Id' indicates that the default user id will be specified by the method that created or modified the share. If a default user id is supported, all the default access privileges will provided through that user as proxy. The resulting access privileges will be surfaced using the CIM_Privilege model. | None | TRANSLATABLE= true |
| Read | boolean | true | None | None |
| ValueMap | string | 0, 2, 3, 4, .., 0x8000.. | None | None |
| Values | string | Unknown, No Default User Id, System-Specified Default User Id, Share-Specified Default User Id, DMTF Reserved, Vendor Defined | None | TRANSLATABLE= true |
| Description | string |
| Description | string | The Description property provides a textual description of the object. | None | TRANSLATABLE= true |
| ElementName | string |
| Description | string | The 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 |
| Override | string | ElementName | TOSUBCLASS= false | None |
| Required | boolean | true | None | OVERRIDABLE= false
|
| ExecuteSupport | uint16 |
| Description | string | An enumerated value that specifies whether this share can support executable objects in any way. For instance, can this share be used as a paging file by a client.
'Not Supported' indicates that no special support for executable objects is provided. 'Execution Supported' indicates that execution is supported, though this does not specify the kind of support. A vendor can extend this to indicate specific support mechanisms that may be provided. | None | TRANSLATABLE= true |
| Read | boolean | true | None | None |
| ValueMap | string | 0, 2, 3, .., 0x8000.. | None | None |
| Values | string | Unknown, Not Supported, Execution Supported, DMTF Reserved, Vendor Defined | None | TRANSLATABLE= true |
| FileSharingProtocol | uint16 |
| Description | string | An enumerated integer indicating the filesharing protocol that this share can support. This property must exist and have a value. The version of the protocol must be specified in the corresponding ProtocolVersions property. | None | TRANSLATABLE= true |
| ModelCorrespondence | string | CIM_ExportedFileShareCapabilities.FileSharingProtocol, CIM_ImportedFileShareSetting.FileSharingProtocol, CIM_ExportedFileShareSetting.ProtocolVersions | None | None |
| Read | boolean | true | None | None |
| ValueMap | string | 0, 2, 3, 4, 5, 6, 7, .., 0x8000.. | None | None |
| Values | string | Unknown, NFS, CIFS, DAFS, WebDAV, HTTP, FTP, DMTF Reserved, Vendor Defined | None | TRANSLATABLE= true |
| Generation | uint64 |
| Description | string | Generation 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 |
| Experimental | boolean | true | TOSUBCLASS= false | None |
| InitialEnabledState | uint16 |
| Description | string | InitialEnabledState is an integer enumeration that indicates the enabled/disabled states initially set for a file share element. Unlike FileShare.EnabledState it cannot indicate transitions between requested states because those states cannot be requested. The following text briefly summarizes the various enabled/disabled initial states:
Enabled (2) indicates that the element will execute commands, will process any queued commands, and will queue new requests.
Disabled (3) indicates that the element will not execute commands and will drop any new requests.
In Test (7) indicates that the element will be in a test state.
Deferred (8) indicates that the element will not process any commands but will queue new requests.
Quiesce (9) indicates that the element is enabled but in a restricted mode. The element's behavior is similar to the Enabled state, but it only processes a restricted set of commands. All other requests are queued. | None | TRANSLATABLE= true |
| ModelCorrespondence | string | CIM_ExportedFileShareSetting.OtherEnabledState, CIM_EnabledLogicalElement.EnabledState | None | None |
| ValueMap | string | 0, 1, 2, 3, 7, 8, 9, 11..32767, 32768..65535 | None | None |
| Values | string | Unknown, Other, Enabled, Disabled, In Test, Deferred, Quiesce, DMTF Reserved, Vendor Reserved | None | TRANSLATABLE= true |
| InstanceID | string |
| Description | string | Within 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 |
| Key | boolean | true | None | OVERRIDABLE= false
|
| Override | string | InstanceID | TOSUBCLASS= false | None |
| OtherEnabledState | string |
| Description | string | A string describing the element's initial enabled/disabled state when the InitialEnabledState property is set to 1 ("Other"). This property MUST be set to NULL when InitialEnabledState is any value other than 1. | None | TRANSLATABLE= true |
| ModelCorrespondence | string | CIM_ExportedFileShareSetting.InitialEnabledState | None | None |
| ProtocolVersions | string |
| ArrayType | string | Indexed | None | OVERRIDABLE= false
|
| Description | string | An array of strings listing the versions of the file sharing protocol that this share can support. This property must exist and have at least one entry. | None | TRANSLATABLE= true |
| ModelCorrespondence | string | CIM_ExportedFileShareCapabilities.ProtocolVersions, CIM_ImportedFileShareSetting.ProtocolVersions, CIM_ExportedFileShareSetting.FileSharingProtocol | None | None |
| Read | boolean | true | None | None |
| RootAccess | uint16 |
| Description | string | An enumerated value that specifies whether the Share supports default access by privileged, system administrator- level ('root') users from specific hosts. These default privileges can always be overridden by privileges explicitly defined by a supported authorization mechanism(s).
'No Root Access' indicates that the Share will deny root access to all clients. 'Allow Root Access' indicates that the Share will allow root access as specified by the RootAccessHosts parameter when the FileShare was created. The actual access allowed will be mediated by the authorization mechanism supported by the device and provider.
Any other root-access privileges must be granted or denied explicitly using the vendor's authorization mechanism or by using the CIM-specified privilege model. The resulting access privileges will be surfaced using the CIM_Privilege model. | None | TRANSLATABLE= true |
| ModelCorrespondence | string | CIM_FileExportService.CreateExportedShare.RootAccessHosts, CIM_FileExportService.ModifyExportedShare.RootAccessHosts | None | None |
| Read | boolean | true | None | None |
| ValueMap | string | 0, 2, 3, .., 0x8000.. | None | None |
| Values | string | Unknown, No Root Access, Allow Root Access, DMTF Reserved, Vendor Defined | None | TRANSLATABLE= true |
| WritePolicy | uint16 |
| Description | string | An enumerated value that specifies the default policy followed by the Share for how to handle writes to the Share.
'Synchronous' indicates that the Share will perform synchronous writes. 'Asynchronous' indicates that the Share may perform asynchronous writes. (The WritePolicy settings may be overridden in the future with use of the Policy model.) | None | TRANSLATABLE= true |
| Read | boolean | true | None | None |
| ValueMap | string | 0, 2, 3, .., 0x8000.. | None | None |
| Values | string | Unknown, Synchronous, Asynchronous, DMTF Reserved, Vendor Defined | None | TRANSLATABLE= true |
Copyright © 2008-2010 VMware, Inc. All rights reserved.