Class CIM_ExportedFileShareSetting
extends CIM_SettingData

The ExportedFileShareSetting describes the attribute values that were set when a FileShare was created for a LogicalFile by a FileExportService. These settings may be associated with the created Share via the ElementSettingData association; or, associated with an ExportedFileShareCapabilities element via SettingAssociatedToCapabilities; or, used as an EmbeddedInstanceparameter in a method (for instance, as a Goal). If the setting is associated with a FileShare, it cannot have undefined or NULL properties. If it is associated with an ExportedFileShareCapabilities, a NULL property indicates that the property is not supported or that the value is a vendor-specific context-dependent default that may not be changed. The FileSharingProtocol and ProtocolVersions properties cannot have a default value. If this Setting is associated with a ExportedFileShareCapabilities element via SettingAssociatedToCapabilities, the corresponding FileSharingProtocol and ProtocolVersions properties must match.

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


Class Hierarchy

CIM_ManagedElement
   |
   +--CIM_SettingData
   |
   +--CIM_ExportedFileShareSetting

Direct Known Subclasses

Class Qualifiers

NameData TypeValue
DescriptionstringThe ExportedFileShareSetting describes the attribute values that were set when a FileShare was created for a LogicalFile by a FileExportService. These settings may be associated with the created Share via the ElementSettingData association; or, associated with an ExportedFileShareCapabilities element via SettingAssociatedToCapabilities; or, used as an EmbeddedInstanceparameter in a method (for instance, as a Goal). If the setting is associated with a FileShare, it cannot have undefined or NULL properties. If it is associated with an ExportedFileShareCapabilities, a NULL property indicates that the property is not supported or that the value is a vendor-specific context-dependent default that may not be changed. The FileSharingProtocol and ProtocolVersions properties cannot have a default value. If this Setting is associated with a ExportedFileShareCapabilities element via SettingAssociatedToCapabilities, the corresponding FileSharingProtocol and ProtocolVersions properties must match.
UMLPackagePathstringCIM::System::FileServices
Versionstring2.45.0

Class Properties

Local Class Properties

NameData TypeDefault ValueQualifiers
NameData TypeValue
AccessPointsuint162
DescriptionstringAn 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.
ValueMapstring0, 2, 3, 4, 5, .., 0x8000..
ValuesstringUnknown, None, Service Default, All, Named Points, DMTF Reserved, Vendor Defined
CASupportedboolean
DescriptionstringThis property applies to CIFS/SMB shares only. If it is true, it means that "Continuous Availability" is supported for this CIFS share. Continuous Availability (CA) - Client/Server mediated recovery from network and server failure with application transparency. Like Multi-Channel IO, this feature is somewhat analogous to capabilities available in NFSv4.
DefaultExecuteuint160
DescriptionstringAn 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.
ValueMapstring0, 2, 3, .., 0x8000..
ValuesstringUnknown, No Access, Execute, DMTF Reserved, Vendor Defined
DefaultReadWriteuint160
DescriptionstringAn 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.
ValueMapstring0, 2, 3, 4, .., 0x8000..
ValuesstringUnknown, No Access, Read Only, Read/Write, DMTF Reserved, Vendor Defined
DefaultUserIdSupporteduint160
DescriptionstringAn 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.
ValueMapstring0, 2, 3, 4, .., 0x8000..
ValuesstringUnknown, No Default User Id, System-Specified Default User Id, Share-Specified Default User Id, DMTF Reserved, Vendor Defined
ExecuteSupportuint160
DescriptionstringAn 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.
ValueMapstring0, 2, 3, .., 0x8000..
ValuesstringUnknown, Not Supported, Execution Supported, DMTF Reserved, Vendor Defined
FileSharingProtocoluint16
DescriptionstringAn 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.
ModelCorrespondencestringCIM_ExportedFileShareCapabilities.FileSharingProtocol, CIM_ExportedFileShareSetting.ProtocolVersions
ValueMapstring0, 2, 3, 4, 5, 6, 7, .., 0x8000..
ValuesstringUnknown, NFS, CIFS, DAFS, WebDAV, HTTP, FTP, DMTF Reserved, Vendor Defined
InitialEnabledStateuint168
DescriptionstringInitialEnabledState 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.
ModelCorrespondencestringCIM_ExportedFileShareSetting.OtherEnabledState, CIM_EnabledLogicalElement.EnabledState
ValueMapstring0, 1, 2, 3, 7, 8, 9, 11..32767, 32768..65535
ValuesstringUnknown, Other, Enabled, Disabled, In Test, Deferred, Quiesce, DMTF Reserved, Vendor Reserved
OtherEnabledStatestring
DescriptionstringA 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.
ModelCorrespondencestringCIM_ExportedFileShareSetting.InitialEnabledState
RootAccessuint160
DescriptionstringAn 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.
ModelCorrespondencestringCIM_FileExportService.CreateExportedShare(RootAccessHosts), CIM_FileExportService.ModifyExportedShare(RootAccessHosts)
ValueMapstring0, 2, 3, .., 0x8000..
ValuesstringUnknown, No Root Access, Allow Root Access, DMTF Reserved, Vendor Defined
WritePolicyuint160
DescriptionstringAn 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.)
ValueMapstring0, 2, 3, .., 0x8000..
ValuesstringUnknown, Synchronous, Asynchronous, DMTF Reserved, Vendor Defined
ProtocolVersionsstring[]
ArrayTypestringIndexed
DescriptionstringAn 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.
ModelCorrespondencestringCIM_ExportedFileShareCapabilities.ProtocolVersions, CIM_ExportedFileShareSetting.FileSharingProtocol

Inherited Properties

NameData Type
Captionstring
ChangeableTypeuint16
ConfigurationNamestring
Descriptionstring
ElementNamestring
Generationuint64
InstanceIDstring
SoIDstring
SoOrgIDstring
ComponentSettingstring[]

Class Methods