System\CIM_ImportedFileShareCapabilities.mof.mof (HTML version)

Return to index
CIM_ImportedFileShareCapabilities Superclass: CIM_Capabilities
ImportedFileShareCapabilities specifies the combination of properties that a FileImportService can support when creating or maintaining FileShares. Each supported combination of properties is specified by an ImportedFileShareSetting that is associated with the ImportedFileShareCapabilities element via SettingAssociatedToCapabilities.
A ImportedFileShareCapabilities element specifies the properties supported when using it.
This class also provides a CreateGoal method that can be used to create a ImportedFileShareSetting element that can be used as a goal for creating or modifying a file share.
Qualifiers:Experimental Version ( "2.8.1000" )
Parameters (local in grey)
Values { "Job 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" }
ValueMap { "0" , "1" , "2" , "3" , "4" , "5" , "6" , ".." , "4096" , "4097..32767" , "32768..65535" }
uint16CreateGoal(
Reference to the job (may be null if job completed).
Qualifiers:OUT IN ( false )
CIM_ConcreteJob REF Job
This is an element of the CIM_ImportedFileShareSetting class, or a derived class, encoded as a string-valued embedded object parameter. It specifies the goal element to be used for matching.
Qualifiers:IN EmbeddedInstance ( "CIM_ImportedFileShareSetting" )
string TemplateGoal
This is an element of the CIM_ImportedFileShareSetting 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.
Qualifiers:OUT IN ( false ) EmbeddedInstance ( "CIM_ImportedFileShareSetting" )
string SupportedGoal
)
Start a job to create a ImportedFileShareSetting from an ImportedFileShareSetting 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 ImportedFileShareSetting that is supported by this ImportedFileShareCapabilities.
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.
Values { "RequestRetryPolicy" , "TransmissionRetriesMax" , "RetransmissionTimeout" , "ImportFailurePolicy" , "ImportRetriesMax" , "ReadBufferSize" , "WriteBufferSize" , "AttributeCaching" , "AccessPoints" , "ReadWritePolicy" , "CifsLocksSupportPolicy" , "CifsNotificationPolicy" , "AccessPolicies" , "CifsLockPolicy" , "ReadWritePref" , "CachingOptions" , "ImportOnServiceStart" , "ExecutePref" , "RootAccessPref" , "InitialEnabledState" , "DMTF Reserved" , "Vendor Defined" }
Read
ValueMap { "2" , "3" , "4" , "5" , "6" , "7" , "8" , "9" , "10" , "11" , "12" , "13" , "14" , "15" , "16" , "17" , "18" , "19" , "20" , "21" , ".." , "0x8000.." }
uint16 SupportedProperties [ ] ;
An array of property names of the Setting that this Capabilities element supports.
Read
ModelCorrespondence { "CIM_ExportedFileShareSetting.ProtocolVersions" , "CIM_ImportedFileShareSetting.ProtocolVersions" , "CIM_ImportedFileShareCapabilities.FileSharingProtocol" }
string ProtocolVersions [ ] ;
An 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.
Values { "Unknown" , "NFS" , "CIFS" , "DAFS" , "WebDAV" , "HTTP" , "FTP" , "DMTF Reserved" , "Vendor Defined" }
Read
ModelCorrespondence { "CIM_ImportedFileShareSetting.FileSharingProtocol" , "CIM_ExportedFileShareSetting.FileSharingProtocol" , "CIM_ImportedFileShareCapabilities.ProtocolVersions" }
ValueMap { "0" , "2" , "3" , "4" , "5" , "6" , "7" , ".." , "0x8000.." }
uint16 FileSharingProtocol ;
An 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.
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'.
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.