Class CIM_ExportedFileShareCapabilities
extends CIM_Capabilities

ExportedFileShareCapabilities specifies the combination of properties that a FileExportService can support when creating or maintaining FileShares. Each supported combination of properties is specified by a ExportedFileShareSetting that is associated with the ExportedFileShareCapabilities element via SettingAssociatedToCapabilities. An ExportedFileShareCapabilities element specifies the properties supported when using it. A CreateGoal method is provided that creates an ExportedFileShareSetting element to be used as a goal when creating or modifying a file share.

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


Class Hierarchy

CIM_ManagedElement
   |
   +--CIM_Capabilities
   |
   +--CIM_ExportedFileShareCapabilities

Direct Known Subclasses

Class Qualifiers

NameData TypeValue
DescriptionstringExportedFileShareCapabilities specifies the combination of properties that a FileExportService can support when creating or maintaining FileShares. Each supported combination of properties is specified by a ExportedFileShareSetting that is associated with the ExportedFileShareCapabilities element via SettingAssociatedToCapabilities. An ExportedFileShareCapabilities element specifies the properties supported when using it. A CreateGoal method is provided that creates an ExportedFileShareSetting element to be used as a goal when creating or modifying a file share.
Experimentalbooleantrue
UMLPackagePathstringCIM::System::FileServices
Versionstring2.39.0

Class Properties

Local Class Properties

NameData TypeDefault ValueQualifiers
NameData TypeValue
FileSharingProtocoluint16
DescriptionstringAn enumerated integer indicating the filesharing protocol that this share can support. All settings associated with this Capabilities must have the same value for the FileSharingProtocol property. This property must exist and have a value.
ModelCorrespondencestringCIM_ImportedFileShareSetting.FileSharingProtocol, CIM_ExportedFileShareSetting.FileSharingProtocol, CIM_ExportedFileShareCapabilities.ProtocolVersions
Readbooleantrue
ValueMapstring0, 2, 3, 4, 5, 6, 7, .., 0x8000..
ValuesstringUnknown, NFS, CIFS, DAFS, WebDAV, HTTP, FTP, DMTF Reserved, Vendor Defined
ProtocolVersionsstring[]
DescriptionstringAn array of strings listing the versions of the file sharing protocol that can be supported via these capabilities. All settings associated with this Capabilities must have a non-empty subset of these values in the corresponding ProtocolVersions property.
ModelCorrespondencestringCIM_ExportedFileShareSetting.ProtocolVersions, CIM_ImportedFileShareSetting.ProtocolVersions, CIM_ExportedFileShareCapabilities.FileSharingProtocol
Readbooleantrue
SupportedPropertiesuint16[]
DescriptionstringAn array of property names of the Setting that this Capabilities element supports.
Readbooleantrue
ValueMapstring2, 3, 4, 5, 6, 7, 8, .., 0x8000..
ValuesstringDefaultReadWrite, DefaultExecute, DefaultUserId, RootAccess, WritePolicy, AccessPoints, InitialEnabledState, 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 an ExportedFileShareSetting from an ExportedFileShareSetting 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 ExportedFileShareSetting that is supported by this ExportedFileShareCapabilities. 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.
ValueMapstring0, 1, 2, 3, 4, 5, 6, .., 4096, 4097..32767, 32768..65535
ValuesstringJob Completed with No Error, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, Template Goal cannot be matched., DMTF Reserved, Method Parameters Checked - Job Started, Method Reserved, Vendor Specific

Method Parameters (CreateGoal)

NameTypeQualifiers
NameData TypeValue
SupportedGoalstring
DescriptionstringThis is an element of the CIM_ExportedFileShareSetting class, or a derived class, encoded as a string-valued embedded object parameter. It specifies the element that is returned as the best supported match to the TemplateGoal.
EmbeddedInstancestringCIM_ExportedFileShareSetting
INbooleanfalse
OUTbooleantrue
TemplateGoalstring
DescriptionstringThis is an element of the CIM_ExportedFileShareSetting class, or a derived class, encoded as a string-valued embedded object parameter. It specifies the goal element to be used for matching.
EmbeddedInstancestringCIM_ExportedFileShareSetting
INbooleantrue
Job REF CIM_ConcreteJob
DescriptionstringReference to the job (may be null if job completed).
INbooleanfalse
OUTbooleantrue

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
SupportedFeaturesuint16[]
DescriptionstringEnumeration indicating what methods can accept the element name for creation or modification of a storage element. CreateExportedShare 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