CIM211 Class Declaration
CIM_FileExportService

Table of Contents:
Class Hierarchy
Class Attributes
Class Qualifiers
Properties
Methods
Associations in which the class can participate
Sub Profiling Summary

Class Hierarchy

CIM_FileExportService --> CIM_Service --> CIM_EnabledLogicalElement --> CIM_LogicalElement --> CIM_ManagedSystemElement --> CIM_ManagedElement --> [top]

Class Attributes

Class Declaration Attributes
NameValue
SUPERCLASSCIM_Service
NAMECIM_FileExportService

Class Qualifiers

Class CIM_FileExportService Qualifiers
NameTypeValueFrom Class
Experimentalbooleantrue CIM_FileExportService
Versionstring2.8.1000 CIM_FileExportService
DescriptionstringProvides configuration support for exporting elements ( ’ files ’ ) of a FileSystem. FileExportService(s) are hosted by a ComputerSystem that exports the files (these would be the Filers in a NAS Head). These shared elements (FileShares) are accessed through ProtocolEndpoint(s) hosted by the Filer that support the specified file-sharing protocol. FileShares are associated with the Service via ServiceAffectsElement and with the ProtocolEndpoint(s) via SAPAvailableForElement. CIM_FileExportService
DescriptionstringA CIM_Service is a Logical Element that contains the information that is necessary to represent and manage the functionality provided by a Device or a SoftwareFeature, or both. A Service is a general-purpose object that is used to configure and manage the implementation of functionality. It is not the functionality itself. CIM_Service
DescriptionstringThis class extends LogicalElement to abstract the concept of an element that is enabled and disabled, such as a LogicalDevice or a ServiceAccessPoint. CIM_EnabledLogicalElement
DescriptionstringCIM_LogicalElement is a base class for all the components of a System that represent abstract system components, such as Files, Processes, or LogicalDevices. CIM_LogicalElement
DescriptionstringCIM_ManagedSystemElement is the base class for the System Element hierarchy. Any distinguishable component of a System is a candidate for inclusion in this class. Examples of system components include: - software components such as application servers, databases, and applications - operating system components such as files, processes, and threads - device components such as disk drives, controllers, processors, and printers - physical components such as chips and cards. CIM_ManagedSystemElement
DescriptionstringManagedElement is an abstract class that provides a common superclass (or top of the inheritance tree) for the non-association classes in the CIM Schema. CIM_ManagedElement

Properties

Properties
NameTypeValueQualifiersClassOrigin
SystemCreationClassNamestring Key
Propagated
Description
MaxLen
CIM_Service
SystemNamestring Key
Propagated
Description
MaxLen
CIM_Service
CreationClassNamestring Key
Description
MaxLen
CIM_Service
Namestring Key
Override
Description
MaxLen
CIM_Service
PrimaryOwnerNamestring Write
Description
MaxLen
MappingStrings
CIM_Service
PrimaryOwnerContactstring Write
Description
MaxLen
MappingStrings
CIM_Service
StartModestring Deprecated
Description
ValueMap
MaxLen
CIM_Service
Startedboolean Description CIM_Service
EnabledStateuint165 Description
ValueMap
Values
ModelCorrespondence
CIM_EnabledLogicalElement
OtherEnabledStatestring Description
ModelCorrespondence
CIM_EnabledLogicalElement
RequestedStateuint1612 Description
ValueMap
Values
ModelCorrespondence
CIM_EnabledLogicalElement
EnabledDefaultuint162 Write
Description
ValueMap
Values
CIM_EnabledLogicalElement
TimeOfLastStateChangedatetime Description CIM_EnabledLogicalElement
InstallDatedatetime Description
MappingStrings
CIM_ManagedSystemElement
OperationalStatusuint16[] Description
ValueMap
Values
ArrayType
ModelCorrespondence
CIM_ManagedSystemElement
StatusDescriptionsstring[] Description
ArrayType
ModelCorrespondence
CIM_ManagedSystemElement
Statusstring Deprecated
Description
ValueMap
MaxLen
CIM_ManagedSystemElement
HealthStateuint16 Description
ValueMap
Values
CIM_ManagedSystemElement
Captionstring Description
MaxLen
CIM_ManagedElement
Descriptionstring Description CIM_ManagedElement
ElementNamestring Description CIM_ManagedElement

Property Qualifiers

Property SystemCreationClassName Qualifiers
NameTypeValueFrom Class
Keybooleantrue CIM_Service
PropagatedstringCIM_System.CreationClassName CIM_Service
DescriptionstringThe CreationClassName of the scoping System. CIM_Service
MaxLenuint32256 CIM_Service

Property SystemName Qualifiers
NameTypeValueFrom Class
Keybooleantrue CIM_Service
PropagatedstringCIM_System.Name CIM_Service
DescriptionstringThe Name of the scoping System. CIM_Service
MaxLenuint32256 CIM_Service

Property CreationClassName Qualifiers
NameTypeValueFrom Class
Keybooleantrue CIM_Service
DescriptionstringCreationClassName indicates the name of the class or the subclass that is used in the creation of an instance. When used with the other key properties of this class, this property allows all instances of this class and its subclasses to be uniquely identified. CIM_Service
MaxLenuint32256 CIM_Service

Property Name Qualifiers
NameTypeValueFrom Class
Keybooleantrue CIM_Service
OverridestringName CIM_Service
DescriptionstringThe Name property uniquely identifies the Service and provides an indication of the functionality that is managed. This functionality is described in more detail in the Description property of the object. CIM_Service
MaxLenuint32256 CIM_Service

Property PrimaryOwnerName Qualifiers
NameTypeValueFrom Class
Writebooleantrue CIM_Service
DescriptionstringThe name of the primary owner for the service, if one is defined. The primary owner is the initial support contact for the Service. CIM_Service
MaxLenuint3264 CIM_Service
MappingStringsstringMIF.DMTF|General Information|001.3 CIM_Service

Property PrimaryOwnerContact Qualifiers
NameTypeValueFrom Class
Writebooleantrue CIM_Service
DescriptionstringA string that provides information on how the primary owner of the Service can be reached (for example, phone number, e-mail address, and so on). CIM_Service
MaxLenuint32256 CIM_Service
MappingStringsstringMIF.DMTF|General Information|001.4 CIM_Service

Property StartMode Qualifiers
NameTypeValueFrom Class
DescriptionstringNote: The use of this element is deprecated in lieu of the EnabledDefault property that is inherited from EnabledLogicalElement. The EnabledLogicalElement addresses the same semantics. The change to a uint16 data type was discussed when CIM V2.0 was defined. However, existing V1.0 implementations used the string property. To remain compatible with those implementations, StartMode was grandfathered into the schema. Use of the deprecated qualifier allows the maintenance of the existing property but also permits an improved, clarified definition using EnabledDefault. Deprecated description: StartMode is a string value that indicates whether the Service is automatically started by a System, an Operating System, and so on, or is started only upon request. CIM_Service
ValueMapstring
[See below.]
CIM_Service
MaxLenuint3210 CIM_Service

NameValue
Automatic[none]
Manual[none]
Property Started Qualifiers
NameTypeValueFrom Class
DescriptionstringStarted is a Boolean that indicates whether the Service has been started (TRUE), or stopped (FALSE). CIM_Service

Property EnabledState Qualifiers
NameTypeValueFrom Class
DescriptionstringEnabledState is an integer enumeration that indicates the enabled and disabled states of an element. It can also indicate the transitions between these requested states. For example, shutting down (value=4) and starting (value=10) are transient states between enabled and disabled. The following text briefly summarizes the various enabled and disabled states: Enabled (2) indicates that the element is or could be executing commands, will process any queued commands, and queues new requests. Disabled (3) indicates that the element will not execute commands and will drop any new requests. Shutting Down (4) indicates that the element is in the process of going to a Disabled state. Not Applicable (5) indicates the element does not support being enabled or disabled. Enabled but Offline (6) indicates that the element might be completing commands, and will drop any new requests. Test (7) indicates that the element is in a test state. Deferred (8) indicates that the element might be completing commands, but will queue any new requests. Quiesce (9) indicates that the element is enabled but in a restricted mode. The behavior of the element is similar to the Enabled state, but it processes only a restricted set of commands. All other requests are queued. Starting (10) indicates that the element is in the process of going to an Enabled state. New requests are queued. CIM_EnabledLogicalElement
ValueMapstring
[See below.]
CIM_EnabledLogicalElement
ValuesstringUnknown
Other
Enabled
Disabled
Shutting Down
Not Applicable
Enabled but Offline
In Test
Deferred
Quiesce
Starting
DMTF Reserved
Vendor Reserved
CIM_EnabledLogicalElement
ModelCorrespondencestringCIM_EnabledLogicalElement.OtherEnabledState CIM_EnabledLogicalElement

NameValue
0Unknown
1Other
2Enabled
3Disabled
4Shutting Down
5Not Applicable
6Enabled but Offline
7In Test
8Deferred
9Quiesce
10Starting
11..32767DMTF Reserved
32768..65535Vendor Reserved
Property OtherEnabledState Qualifiers
NameTypeValueFrom Class
DescriptionstringA string that describes the enabled or disabled state of the element when the EnabledState property is set to 1 ( " Other " ). This property must be set to null when EnabledState is any value other than 1. CIM_EnabledLogicalElement
ModelCorrespondencestringCIM_EnabledLogicalElement.EnabledState CIM_EnabledLogicalElement

Property RequestedState Qualifiers
NameTypeValueFrom Class
DescriptionstringRequestedState is an integer enumeration that indicates the last requested or desired state for the element. The actual state of the element is represented by EnabledState. This property is provided to compare the last requested and current enabled or disabled states. Note that when EnabledState is set to 5 ( " Not Applicable " ), then this property has no meaning. By default, the RequestedState of the element is 5 ( " No Change " ). Refer to the EnabledState property description for explanations of the values in the RequestedState enumeration. It should be noted that there are two new values in RequestedState that build on the statuses of EnabledState. These are " Reboot " (10) and " Reset " (11). Reboot refers to doing a " Shut Down " and then moving to an " Enabled " state. Reset indicates that the element is first " Disabled " and then " Enabled " . The distinction between requesting " Shut Down " and " Disabled " should also be noted. Shut Down requests an orderly transition to the Disabled state, and might involve removing power, to completely erase any existing state. The Disabled state requests an immediate disabling of the element, such that it will not execute or accept any commands or processing requests. This property is set as the result of a method invocation (such as Start or StopService on CIM_Service), or can be overridden and defined as WRITEable in a subclass. The method approach is considered superior to a WRITEable property, because it allows an explicit invocation of the operation and the return of a result code. A particular instance of EnabledLogicalElement might not support RequestedStateChange. If this occurs, the value 12 ( " Not Applicable " ) is used. CIM_EnabledLogicalElement
ValueMapstring
[See below.]
CIM_EnabledLogicalElement
ValuesstringEnabled
Disabled
Shut Down
No Change
Offline
Test
Deferred
Quiesce
Reboot
Reset
Not Applicable
DMTF Reserved
Vendor Reserved
CIM_EnabledLogicalElement
ModelCorrespondencestringCIM_EnabledLogicalElement.EnabledState CIM_EnabledLogicalElement

NameValue
2Enabled
3Disabled
4Shut Down
5No Change
6Offline
7Test
8Deferred
9Quiesce
10Reboot
11Reset
12Not Applicable
..DMTF Reserved
32768..65535Vendor Reserved
Property EnabledDefault Qualifiers
NameTypeValueFrom Class
Writebooleantrue CIM_EnabledLogicalElement
DescriptionstringAn enumerated value indicating an administrator ’ s default or startup configuration for the Enabled State of an element. By default, the element is " Enabled " (value=2). CIM_EnabledLogicalElement
ValueMapstring
[See below.]
CIM_EnabledLogicalElement
ValuesstringEnabled
Disabled
Not Applicable
Enabled but Offline
No Default
DMTF Reserved
Vendor Reserved
CIM_EnabledLogicalElement

NameValue
2Enabled
3Disabled
5Not Applicable
6Enabled but Offline
7No Default
8..32767DMTF Reserved
32768..65535Vendor Reserved
Property TimeOfLastStateChange Qualifiers
NameTypeValueFrom Class
DescriptionstringThe date or time when the EnabledState of the element last changed. If the state of the element has not changed and this property is populated, then it must be set to a 0 interval value. If a state change was requested, but rejected or not yet processed, the property must not be updated. CIM_EnabledLogicalElement

Property InstallDate Qualifiers
NameTypeValueFrom Class
DescriptionstringA datetime value that indicates when the object was installed. Lack of a value does not indicate that the object is not installed. CIM_ManagedSystemElement
MappingStringsstringMIF.DMTF|ComponentID|001.5 CIM_ManagedSystemElement

Property Name Qualifiers
NameTypeValueFrom Class
DescriptionstringThe Name property defines the label by which the object is known. When subclassed, the Name property can be overridden to be a Key property. CIM_ManagedSystemElement
MaxLenuint321024 CIM_ManagedSystemElement

Property OperationalStatus Qualifiers
NameTypeValueFrom Class
DescriptionstringIndicates the current statuses of the element. Various operational statuses are defined. Many of the enumeration ’ s values are self-explanatory. However, a few are not and are described here in more detail. " Stressed " indicates that the element is functioning, but needs attention. Examples of " Stressed " states are overload, overheated, and so on. " Predictive Failure " indicates that an element is functioning nominally but predicting a failure in the near future. " In Service " describes an element being configured, maintained, cleaned, or otherwise administered. " No Contact " indicates that the monitoring system has knowledge of this element, but has never been able to establish communications with it. " Lost Communication " indicates that the ManagedSystem Element is known to exist and has been contacted successfully in the past, but is currently unreachable. " Stopped " and " Aborted " are similar, although the former implies a clean and orderly stop, while the latter implies an abrupt stop where the state and configuration of the element might need to be updated. " Dormant " indicates that the element is inactive or quiesced. " Supporting Entity in Error " indicates that this element might be " OK " but that another element, on which it is dependent, is in error. An example is a network service or endpoint that cannot function due to lower-layer networking problems. " Completed " indicates that the element has completed its operation. This value should be combined with either OK, Error, or Degraded so that a client can tell if the complete operation Completed with OK (passed), Completed with Error (failed), or Completed with Degraded (the operation finished, but it did not complete OK or did not report an error). " Power Mode " indicates that the element has additional power model information contained in the Associated PowerManagementService association. OperationalStatus replaces the Status property on ManagedSystemElement to provide a consistent approach to enumerations, to address implementation needs for an array property, and to provide a migration path from today ’ s environment to the future. This change was not made earlier because it required the deprecated qualifier. Due to the widespread use of the existing Status property in management applications, it is strongly recommended that providers or instrumentation provide both the Status and OperationalStatus properties. Further, the first value of OperationalStatus should contain the primary status for the element. When instrumented, Status (because it is single-valued) should also provide the primary status of the element. CIM_ManagedSystemElement
ValueMapstring
[See below.]
CIM_ManagedSystemElement
ValuesstringUnknown
Other
OK
Degraded
Stressed
Predictive Failure
Error
Non-Recoverable Error
Starting
Stopping
Stopped
In Service
No Contact
Lost Communication
Aborted
Dormant
Supporting Entity in Error
Completed
Power Mode
DMTF Reserved
Vendor Reserved
CIM_ManagedSystemElement
ArrayTypestringIndexed CIM_ManagedSystemElement
ModelCorrespondencestringCIM_ManagedSystemElement.StatusDescriptions CIM_ManagedSystemElement

NameValue
0Unknown
1Other
2OK
3Degraded
4Stressed
5Predictive Failure
6Error
7Non-Recoverable Error
8Starting
9Stopping
10Stopped
11In Service
12No Contact
13Lost Communication
14Aborted
15Dormant
16Supporting Entity in Error
17Completed
18Power Mode
..DMTF Reserved
0x8000..Vendor Reserved
Property StatusDescriptions Qualifiers
NameTypeValueFrom Class
DescriptionstringStrings describing the various OperationalStatus array values. For example, if " Stopping " is the value assigned to OperationalStatus, then this property may contain an explanation as to why an object is being stopped. Note that entries in this array are correlated with those at the same array index in OperationalStatus. CIM_ManagedSystemElement
ArrayTypestringIndexed CIM_ManagedSystemElement
ModelCorrespondencestringCIM_ManagedSystemElement.OperationalStatus CIM_ManagedSystemElement

Property Status Qualifiers
NameTypeValueFrom Class
DescriptionstringA string indicating the current status of the object. Various operational and non-operational statuses are defined. This property is deprecated in lieu of OperationalStatus, which includes the same semantics in its enumeration. This change is made for 3 reasons: 1) Status is more correctly defined as an array. This definition overcomes the limitation of describing status using a single value, when it is really a multi-valued property (for example, an element might be OK AND Stopped. 2) A MaxLen of 10 is too restrictive and leads to unclear enumerated values. 3) The change to a uint16 data type was discussed when CIM V2.0 was defined. However, existing V1.0 implementations used the string property and did not want to modify their code. Therefore, Status was grandfathered into the Schema. Use of the deprecated qualifier allows the maintenance of the existing property, but also permits an improved definition using OperationalStatus. CIM_ManagedSystemElement
ValueMapstring
[See below.]
CIM_ManagedSystemElement
MaxLenuint3210 CIM_ManagedSystemElement

NameValue
OK[none]
Error[none]
Degraded[none]
Unknown[none]
Pred Fail[none]
Starting[none]
Stopping[none]
Service[none]
Stressed[none]
NonRecover[none]
No Contact[none]
Lost Comm[none]
Stopped[none]
Property HealthState Qualifiers
NameTypeValueFrom Class
DescriptionstringIndicates the current health of the element. This attribute expresses the health of this element but not necessarily that of its subcomponents. The possible values are 0 to 30, where 5 means the element is entirely healthy and 30 means the element is completely non-functional. The following continuum is defined: " Non-recoverable Error " (30) - The element has completely failed, and recovery is not possible. All functionality provided by this element has been lost. " Critical Failure " (25) - The element is non-functional and recovery might not be possible. " Major Failure " (20) - The element is failing. It is possible that some or all of the functionality of this component is degraded or not working. " Minor Failure " (15) - All functionality is available but some might be degraded. " Degraded/Warning " (10) - The element is in working order and all functionality is provided. However, the element is not working to the best of its abilities. For example, the element might not be operating at optimal performance or it might be reporting recoverable errors. " OK " (5) - The element is fully functional and is operating within normal operational parameters and without error. " Unknown " (0) - The implementation cannot report on HealthState at this time. DMTF has reserved the unused portion of the continuum for additional HealthStates in the future. CIM_ManagedSystemElement
ValueMapstring
[See below.]
CIM_ManagedSystemElement
ValuesstringUnknown
OK
Degraded/Warning
Minor failure
Major failure
Critical failure
Non-recoverable error
DMTF Reserved
CIM_ManagedSystemElement

NameValue
0Unknown
5OK
10Degraded/Warning
15Minor failure
20Major failure
25Critical failure
30Non-recoverable error
..DMTF Reserved
Property Caption Qualifiers
NameTypeValueFrom Class
DescriptionstringThe Caption property is a short textual description (one- line string) of the object. CIM_ManagedElement
MaxLenuint3264 CIM_ManagedElement

Property Description Qualifiers
NameTypeValueFrom Class
DescriptionstringThe Description property provides a textual description of the object. CIM_ManagedElement

Property ElementName Qualifiers
NameTypeValueFrom Class
DescriptionstringA user-friendly name for the object. This property allows each instance to define a user-friendly name in addition to its key properties, identity data, and description information. Note that the Name property of ManagedSystemElement is also defined as a user-friendly name. But, it is often subclassed to be a Key. It is not reasonable that the same property can convey both identity and a user-friendly name, without inconsistencies. Where Name exists and is not a Key (such as for instances of LogicalDevice), the same information can be present in both the Name and ElementName properties. CIM_ManagedElement

Methods

NameTypeValueQualifiersParametersClassOrigin
CreateExportedShareuint32 Description
ValueMap
Values
SharedElementPath
Goal
RootAccessHosts
AccessPointPorts
CIM_FileExportService
ModifyExportedShareuint32 Description
ValueMap
Values
SharedElementPath
Goal
InUseOptions
WaitTime
RootAccessHosts
AccessPointPorts
CIM_FileExportService
ReleaseExportedShareuint32 Description
ValueMap
Values
InUseOptions
WaitTime
CIM_FileExportService
StartServiceuint32 Description  CIM_Service
StopServiceuint32 Description  CIM_Service
RequestStateChangeuint32 Description
ValueMap
Values
ModelCorrespondence
RequestedState
TimeoutPeriod
CIM_EnabledLogicalElement

Method Qualifiers

Method CreateExportedShare Qualifiers
NameTypeValueFrom Class
DescriptionstringStart a Job to create a FileShare from an element of a FileSystem or an imported FileShare. Makes the element available as a FileShare and returns it as the parameter TheShare of type CIM_FileShare. If 0 is returned, the method completed successfully and no ConcreteJob instance was required. If 0x1000 is returned, a ConcreteJob has been started to create the FileShare. The Job ’ s reference will be returned in the output parameter Job. If the Job succeeds, the FileShare will be created and configured and ready to be exported. If the FileShare has been configured to be exported at a later time, its ’ EnabledState ’ attribute will not be set to " Enabled " , until exported. The FileShare will have a HostedShare association to the host ComputerSystem. This method MUST 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. The reference parameter Root indicates the FileSystem or FileShare whose element is being exported, either directly, or indirectly by specifying a Directory element that is associated via MountedElement to the FileSystem or FileShare. The string parameter SharedElementPath indicates the shared element within the file hierarchy by a path relative to the Root. If the Root is a FileSystem, this path begins at the root directory of the FileSystem; if the Root is a FileShare, this path begins at the directory associated to the FileShare via MountedElement; if the Root is a Directory, this path begins at that Directory. This is a string because multiple paths could lead to the same element but the access rights or other privileges could be specific to the path. Goal is a CIM_ExportedFileShareSetting element encoded as a string-valued EmbeddedInstance parameter; this allows the client to specify the properties desired for the share. If the method is successful, it will return a CIM_FileShare in the OUT parameter TheShare. The settings on the FileShare will be specified by the ExportedFileShareSetting element associated with the TheShare element via CIM_ElementSettingData. This ExportedFileShareSetting will also be associated via SettingGeneratedByCapabilities to the ExportedFileShareCapabilities element that was used for creating the FileShare. The FileShare will also be associated to the ComputerSystem via HostedShare, to the FileExportService via ServiceAffectsElement, and to one or more ServiceAccessPoints via SAPAvailableForElement. CIM_FileExportService
ValueMapstring
[See below.]
CIM_FileExportService
ValuesstringJob Completed with No Error
Not Supported
Unknown
Timeout
Failed
Invalid Parameter
FileExportService Not Accessible
Root is not accessible
Base Directory element of Root is Not Accessible
Path does not specify a shareable element
DMTF Reserved
Method Parameters Checked - Job Started
Method Reserved
Vendor Specific
CIM_FileExportService

Method ModifyExportedShare Qualifiers
NameTypeValueFrom Class
DescriptionstringStart a Job to modify an Exported FileShare. If 0 is returned, the method completed successfully and no ConcreteJob instance was required. If 0x1000 is returned, a ConcreteJob has been started to modify the FileShare. The Job ’ s reference will be returned in the output parameter Job. If the Job succeeds, the FileShare will be modified and re-configured and ready to be exported. If the FileShare has been configured to be exported at a later time, its ’ EnabledState ’ attribute will not be set to " Enabled " , until exported. A reference to the FileShare will be returned in TheShare. The FileShare will have a HostedShare association to the host ComputerSystem, as before. If the parameters are, invalid, this method MUST 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. This method cannot be used to change the element that has been exported, but a provider may support changing the pathname used to access it by re-specifying Root and/or SubElementPath. The reference parameter Root indicates the FileSystem or FileShare whose element is being exported, either directly, or indirectly by specifying a Directory element that is associated via MountedElement to the FileSystem or FileShare. The FileSystem or FileShare so indicated cannot be changed by this method. The parameter SharedElementPath indicates the shared element within the file hierarchy by a path relative to the Root. If the Root is a FileSystem, this path begins at the root directory of the FileSystem; if the Root is a FileShare, this path begins at the directory associated to the FileShare via MountedElement; if the Root is a Directory, this path begins at that Directory. If this path is modified, it must still indicate the same terminal element. Goal is a CIM_ExportedFileShareSetting element encoded as a string-valued embedded object parameter; this allows the client to specify the properties desired for the share. If the method is successful, it will return a reference to the same CIM_FileShare in the INOUT parameter TheShare. The settings for the FileShare and the ServiceAccessPoint associations may change, but the HostedShare and ServiceAffectsElement associations to the share must not be changed by this method. The input TheShare must not be NULL. CIM_FileExportService
ValueMapstring
[See below.]
CIM_FileExportService
ValuesstringJob Completed with No Error
Not Supported
Unknown
Timeout
Failed
Invalid Parameter
FileExportService Not Accessible
Root is not accessible
Base Directory element of Root is Not Accessible
Path does not specify a shareable element
Share in use and cannot be Modified, Failed
DMTF Reserved
Method Parameters Checked - Job Started
Method Reserved
Vendor Specific
CIM_FileExportService

Method ReleaseExportedShare Qualifiers
NameTypeValueFrom Class
DescriptionstringStart a Job to release an exported Share. If 0 is returned, the method completed successfully and no ConcreteJob instance was required. If 0x1000 is returned, a ConcreteJob will be started to release the Share. The Job ’ s reference will be returned in the OUT parameter Job. If the method is successful, the Share element will not be surfaced for export and the shared element will not be exported anymore through this Share. If InUseOptions are specified, this method will succeed only if no more clients are accessing the share. CIM_FileExportService
ValueMapstring
[See below.]
CIM_FileExportService
ValuesstringJob Completed with No Error
Not Supported
Unknown
Timeout
Failed
Invalid Parameter
Share in use, Failed
DMTF Reserved
Method Parameters Checked - Job Started
Method Reserved
Vendor Specific
CIM_FileExportService

Method StartService Qualifiers
NameTypeValueFrom Class
DescriptionstringThe StartService method places the Service in the started state. Note that the function of this method overlaps with the RequestedState property. RequestedState was added to the model to maintain a record (such as a persisted value) of the last state request. Invoking the StartService method should set the RequestedState property appropriately. The method returns an integer value of 0 if the Service was successfully started, 1 if the request is not supported, and any other number to indicate an error. In a subclass, the set of possible return codes could be specified using a ValueMap qualifier on the method. The strings to which the ValueMap contents are translated can also be specified in the subclass as a Values array qualifier. Note: The semantics of this method overlap with the RequestStateChange method that is inherited from EnabledLogicalElement. This method is maintained because it has been widely implemented, and its simple " start " semantics are convenient to use. CIM_Service

Method StopService Qualifiers
NameTypeValueFrom Class
DescriptionstringThe StopService method places the Service in the stopped state. Note that the function of this method overlaps with the RequestedState property. RequestedState was added to the model to maintain a record (such as a persisted value) of the last state request. Invoking the StopService method should set the RequestedState property appropriately. The method returns an integer value of 0 if the Service was successfully stopped, 1 if the request is not supported, and any other number to indicate an error. In a subclass, the set of possible return codes could be specified using a ValueMap qualifier on the method. The strings to which the ValueMap contents are translated can also be specified in the subclass as a Values array qualifier. Note: The semantics of this method overlap with the RequestStateChange method that is inherited from EnabledLogicalElement. This method is maintained because it has been widely implemented, and its simple " stop " semantics are convenient to use. CIM_Service

Method RequestStateChange Qualifiers
NameTypeValueFrom Class
DescriptionstringRequests that the state of the element be changed to the value specified in the RequestedState parameter. When the requested state change takes place, the EnabledState and RequestedState of the element will be the same. Invoking the RequestStateChange method multiple times could result in earlier requests being overwritten or lost. If 0 is returned, then the task completed successfully and the use of ConcreteJob was not required. If 4096 (0x1000) is returned, then the task will take some time to complete, ConcreteJob will be created, and its reference returned in the output parameter Job. Any other return code indicates an error condition. CIM_EnabledLogicalElement
ValueMapstring
[See below.]
CIM_EnabledLogicalElement
ValuesstringCompleted with No Error
Not Supported
Unknown or Unspecified Error
Cannot complete within Timeout Period
Failed
Invalid Parameter
In Use
DMTF Reserved
Method Parameters Checked - Job Started
Invalid State Transition
Use of Timeout Parameter Not Supported
Busy
Method Reserved
Vendor Specific
CIM_EnabledLogicalElement
ModelCorrespondencestringCIM_EnabledLogicalElement.RequestedState CIM_EnabledLogicalElement

Parameters

Method CreateExportedShare Parameters
NameTypeQualifiers
SharedElementPathstringIN
Description
GoalstringIN
Description
EmbeddedInstance
RootAccessHostsstringIN
Description
ArrayType
ModelCorrespondence
AccessPointPortsstringIN
Description
ArrayType
ModelCorrespondence

Method ModifyExportedShare Parameters
NameTypeQualifiers
SharedElementPathstringIN
Description
GoalstringIN
Description
EmbeddedInstance
InUseOptionsuint16IN
Description
ValueMap
Values
WaitTimeuint32IN
Description
Units
RootAccessHostsstringIN
Description
ArrayType
ModelCorrespondence
AccessPointPortsstringIN
Description
ArrayType
ModelCorrespondence

Method ReleaseExportedShare Parameters
NameTypeQualifiers
InUseOptionsuint16IN
Description
ValueMap
Values
WaitTimeuint32IN
Description
Units

Method RequestStateChange Parameters
NameTypeQualifiers
RequestedStateuint16IN
Description
ValueMap
Values
ModelCorrespondence
TimeoutPerioddatetimeIN
Description

Parameter Qualifiers

Parameter SharedElementPath Qualifiers
NameTypeValueFrom Class
INbooleantrue CIM_FileExportService
DescriptionstringA string representing a path to the shared element from the Directory indicated by Root. Multiple paths could lead to the same element but the access rights or other privileges could be specific to the path. The client must specify the path. If SharedElementPath is NULL or the empty string, it indicates the " root " LogicalElement contained by Root. CIM_FileExportService

Parameter Goal Qualifiers
NameTypeValueFrom Class
INbooleantrue CIM_FileExportService
DescriptionstringThe client-specified requirements for how the specified FileShare element is to be shared or exported by the FileExportService. This is an element of the CIM_ExportedFileShareSetting class, or a derived class, encoded as a string-valued embedded object parameter. If NULL or the empty string, the default configuration will be specified by the FileExportService. CIM_FileExportService
EmbeddedInstancestringCIM_ExportedFileShareSetting CIM_FileExportService

Parameter RootAccessHosts Qualifiers
NameTypeValueFrom Class
INbooleantrue CIM_FileExportService
DescriptionstringAn array of strings that specify the hosts that have root access to this Share, if the CIM_ExportedFileShareSetting.RootAccess property is set to ’ Allow Root Access ’ . Each entry specifies a host by a vendor-specific host-id, prefixed with ’ + ’ or ’ - ’ to indicate that access is either Granted or Denied. The name of the host is its Durable Name, which is expected to be a fully-qualified-domain-name or its IP Address. If one of the entries is ’ +* ’ , root access will be allowed from all hosts. If one of the entries is ’ -* ’ , root access will be denied to all hosts, effectively overriding the value of the property CIM_ExportedFileShareSetting.RootAccess. The provider is expected to surface this access using the privilege model. This property needs to be a string because the remote host may not be known to the provider and therefore a reference to the host may not exist. CIM_FileExportService
ArrayTypestringIndexed CIM_FileExportService
ModelCorrespondencestringCIM_ExportedFileShareSetting.RootAccess CIM_FileExportService

Parameter AccessPointPorts Qualifiers
NameTypeValueFrom Class
INbooleantrue CIM_FileExportService
DescriptionstringAn array of strings that specify the ServiceAccessPoints that can connect to this Share, if the CIM_ExportedFileShareSettings.AccessPoints property is set to ’ Named Ports ’ . Each entry specifies one or more access points by its Name, unique within the System hosting the FileShare. The ids may be prefixed with ’ + ’ or ’ - ’ to indicate that access is to be granted or denied. If one of the entries is ’ +* ’ , all access points supported by the service will be supported. If one of the entries is ’ -* ’ , all access points will be denied access, effectively overriding the value of the property CIM_ExportedFileShareSetting.AccessPoints. The provider is expected to surface these access rights (whether granted or denied) using the privilege model. Any AccessPoints granted access via this parameter will also be associated to this share with CIM_SAPAvailableForElement. If the AccessPoint is not already enabled it will appear in a disabled state. This property needs to be a string because the access point may not be known to the provider and therefore a reference to the ServiceAccessPoint may not exist. CIM_FileExportService
ArrayTypestringIndexed CIM_FileExportService
ModelCorrespondencestringCIM_ExportedFileShareSetting.AccessPoints CIM_FileExportService

Parameter SharedElementPath Qualifiers
NameTypeValueFrom Class
INbooleantrue CIM_FileExportService
DescriptionstringA string representing a path to the shared element from the Directory element indicated by Root. If the FileShare being modified is currently exported or imported, this parameter should specify the same shared element, even if via a different path. Multiple paths could lead to the same element but the access rights or other privileges could be specific to the path. The client must specify the path during creation. If SharedElementPath is NULL, it indicates no change to the current path. If SharedElementPath is the empty string, it indicates the element indicated by Root. CIM_FileExportService

Parameter Goal Qualifiers
NameTypeValueFrom Class
INbooleantrue CIM_FileExportService
DescriptionstringThe client-specified requirements for how the export settings for the specified FileShare element are to be modifed by the FileExportService. If the FileShare is currently imported and not exported this will set up the necessary SharedElement, SharedElementRoot, HostedShare, and other associations. Goal is an element of the CIM_ExportedFileShareSetting class, or a derived class, encoded as a string-valued embedded object parameter. If NULL or the empty string, the existing configuration must include an ExportedFileShareSetting which will not be changed. Any differences in property values will be merged by the FileExportService. CIM_FileExportService
EmbeddedInstancestringCIM_ExportedFileShareSetting CIM_FileExportService

Parameter InUseOptions Qualifiers
NameTypeValueFrom Class
INbooleantrue CIM_FileExportService
DescriptionstringAn enumerated integer that specifies the action that the provider should take if the FileShare is still in use when this request is made. The WaitTime parameter indicates the ’ specified time ’ used for this function. This option is only relevant if the FileShare must be made unavailable while the request is being executed. CIM_FileExportService
ValueMapstring
[See below.]
CIM_FileExportService
ValuesstringDo Not Execute Request
Wait for specified time, then Execute Request Immediately
Attempt Quiescence for specified time, then Execute Request Immediately
DMTF Reserved
Vendor Defined
CIM_FileExportService

Parameter WaitTime Qualifiers
NameTypeValueFrom Class
INbooleantrue CIM_FileExportService
DescriptionstringAn integer that indicates the time (in seconds) that the provider must wait before executing this request if it cannot be done while the FileShare is in use. If WaitTime is not zero, the method will create a job, if supported by the provider, and return immediately. If the provider does not support asynchronous jobs, there is a possibility that the client could time-out before the job is completed. The combination of InUseOptions = ’ 4 ’ and WaitTime = ’ 0 ’ (the default) is interpreted as ’ Wait (forever) until Quiescence, then Execute Request ’ and will be performed asynchronously if possible. CIM_FileExportService
Unitsstringseconds CIM_FileExportService

Parameter RootAccessHosts Qualifiers
NameTypeValueFrom Class
INbooleantrue CIM_FileExportService
DescriptionstringAn array of strings that specify additional hosts that have root access to this Share, if the CIM_ExportedFileShareSetting.RootAccess property is set to ’ Allow Root Access ’ . Each entry specifies a host by a vendor-specific host-id, prefixed with ’ + ’ or ’ - ’ to indicate that access is either Granted or Denied. The name of the host is its Durable Name, which is expected to be a fully-qualified-domain-name or its IP Address. If one of the entries is ’ +* ’ , root access will be allowed from all hosts. If one of the entries is ’ -* ’ , root access will be denied to all hosts, effectively overriding the value of the property CIM_ExportedFileShareSetting.RootAccess. If this is a null entry, the currently configured set of hosts will not be changed. If this is an empty array, the currently configured set of hosts will be cleared. The provider is expected to surface this access using the privilege model. This property needs to be a string because the remote host may not be known to the provider and therefore a REF to the host may not exist. CIM_FileExportService
ArrayTypestringIndexed CIM_FileExportService
ModelCorrespondencestringCIM_ExportedFileShareSetting.RootAccess CIM_FileExportService

Parameter AccessPointPorts Qualifiers
NameTypeValueFrom Class
INbooleantrue CIM_FileExportService
DescriptionstringAn array of strings that specify additional ServiceAccessPoints that can connect to this Share, if the CIM_ExportedFileShareSettings.AccessPoints property is set to ’ Named Ports ’ . Each entry specifies one or more access points by its Name, unique within the System hosting the FileShare. The ids may be prefixed with ’ + ’ or ’ - ’ to indicate that access is to be granted or denied. If one of the entries is ’ +* ’ , all access points supported by the service will be supported. If one of the entries is ’ -* ’ , all access points will be denied access, effectively overriding the value of the property CIM_ExportedFileShareSetting.AccessPoints. If this is a null entry, the currently configured set of access points will not be changed. If this is an empty array, the currently configured set of access points will be cleared. The provider is expected to surface these access rights (whether granted or denied) using the privilege model. Any AccessPoints granted access via this parameter will also be associated to this share with CIM_SAPAvailableForElement. If the AccessPoint is not already enabled it will appear in a disabled state. This property needs to be a string because the access point may not be known to the provider and therefore a REF to the ServiceAccessPoint may not exist. CIM_FileExportService
ArrayTypestringIndexed CIM_FileExportService
ModelCorrespondencestringCIM_ExportedFileShareSetting.AccessPoints CIM_FileExportService

Parameter InUseOptions Qualifiers
NameTypeValueFrom Class
INbooleantrue CIM_FileExportService
DescriptionstringAn enumerated integer that specifies the action that the provider should take if the FileShare is still in use when this request is made. The WaitTime parameter indicates the ’ specified time ’ used for this function. This option is only relevant if the FileShare must be made unavailable while the request is being executed. CIM_FileExportService
ValueMapstring
[See below.]
CIM_FileExportService
ValuesstringDo Not Execute Request
Wait for specified time, then Release Immediately
Attempt Quiescence for specified time, then Release Immediately
DMTF Reserved
Vendor Defined
CIM_FileExportService

Parameter WaitTime Qualifiers
NameTypeValueFrom Class
INbooleantrue CIM_FileExportService
DescriptionstringAn integer that indicates the time (in seconds) that the provider must wait before releasing this FileShare. If WaitTime is not zero, the method will create a job, if supported by the provider, and return immediately. If the provider does not support asynchronous jobs, there is a possibility that the client could time-out before the job is completed. The combination of InUseOptions = ’ 4 ’ and WaitTime = ’ 0 ’ (the default) is interpreted as ’ Wait (forever) until Quiescence, then Release ’ and will be performed asynchronously if possible. CIM_FileExportService
Unitsstringseconds CIM_FileExportService

Parameter RequestedState Qualifiers
NameTypeValueFrom Class
INbooleantrue CIM_EnabledLogicalElement
DescriptionstringThe state requested for the element. This information will be placed into the RequestedState property of the instance if the return code of the RequestStateChange method is 0 ( ’ Completed with No Error ’ ), 3 ( ’ Timeout ’ ), or 4096 (0x1000) ( ’ Job Started ’ ). Refer to the description of the EnabledState and RequestedState properties for the detailed explanations of the RequestedState values. CIM_EnabledLogicalElement
ValueMapstring
[See below.]
CIM_EnabledLogicalElement
ValuesstringEnabled
Disabled
Shut Down
Offline
Test
Defer
Quiesce
Reboot
Reset
DMTF Reserved
Vendor Reserved
CIM_EnabledLogicalElement
ModelCorrespondencestringCIM_EnabledLogicalElement.RequestedState CIM_EnabledLogicalElement

Parameter TimeoutPeriod Qualifiers
NameTypeValueFrom Class
INbooleantrue CIM_EnabledLogicalElement
DescriptionstringA timeout period that specifies the maximum amount of time that the client expects the transition to the new state to take. The interval format must be used to specify the TimeoutPeriod. A value of 0 or a null parameter indicates that the client has no time requirements for the transition. If this property does not contain 0 or null and the implementation does not support this parameter, a return code of ’ Use Of Timeout Parameter Not Supported ’ must be returned. CIM_EnabledLogicalElement

Associations this class can participate in

Association
Class
Reference
Class
Role
CIM_ServiceComponentCIM_ServiceGroupComponent
CIM_ServiceComponentCIM_ServicePartComponent
CIM_ProductServiceComponentCIM_ServicePartComponent
CIM_HostedServiceCIM_ServiceDependent
CIM_ServiceSAPDependencyCIM_ServiceDependent
CIM_SoftwareElementServiceImplementationCIM_ServiceDependent
CIM_SoftwareFeatureServiceImplementationCIM_ServiceDependent
CIM_DeviceServiceImplementationCIM_ServiceDependent
CIM_ProvidesServiceToElementCIM_ServiceAntecedent
CIM_ServiceServiceDependencyCIM_ServiceAntecedent
CIM_ServiceServiceDependencyCIM_ServiceDependent
CIM_ServiceUsesSecurityServiceCIM_ServiceDependent
CIM_ServiceAccessBySAPCIM_ServiceAntecedent
CIM_ProvidesEndpointCIM_ServiceAntecedent
CIM_ServiceStatisticsCIM_ServiceElement
CIM_ServiceAffectsElementCIM_ServiceAffectingElement
CIM_ServiceAvailableToElementCIM_ServiceServiceProvided
CIM_ServiceProcessCIM_ServiceService
CIM_ReplicaPoolForStorageCIM_EnabledLogicalElementAntecedent
CIM_RemoteAccessAvailableToElementCIM_EnabledLogicalElementDependent
CIM_LogicalElementPerformsUoWCIM_LogicalElementAntecedent
CIM_ImportedShareRootCIM_LogicalElementAntecedent
CIM_ImportedShareRootCIM_LogicalElementDependent
CIM_LogicalElementUnitOfWorkDefCIM_LogicalElementAntecedent
CIM_SharedElementRootCIM_LogicalElementAntecedent
CIM_OperationLogCIM_LogicalElementDependent
CIM_AllocatedFromStoragePoolCIM_LogicalElementDependent
CIM_ResidesOnExtentCIM_LogicalElementDependent
CIM_AssociatedMemoryCIM_LogicalElementDependent
CIM_AttachedElementCIM_LogicalElementSystemElement
CIM_AttachedElementCIM_LogicalElementSameElement
CIM_MountedElementCIM_LogicalElementSystemElement
CIM_MountedElementCIM_LogicalElementSameElement
CIM_ImportedShareCIM_LogicalElementSystemElement
CIM_ImportedShareCIM_LogicalElementSameElement
CIM_SharedElementCIM_LogicalElementSystemElement
CIM_RedundancyComponentCIM_ManagedSystemElementPartComponent
CIM_SystemComponentCIM_ManagedSystemElementPartComponent
CIM_UseOfLogCIM_ManagedSystemElementDependent
CIM_DiagnosticTestForMSECIM_ManagedSystemElementDependent
CIM_CollectedMSEsCIM_ManagedSystemElementMember
CIM_DiagnosticResultForMSECIM_ManagedSystemElementSystemElement
CIM_ElementConfigurationCIM_ManagedSystemElementElement
CIM_ElementSettingCIM_ManagedSystemElementElement
CIM_ActsAsSpareCIM_ManagedSystemElementSpare
CIM_ComponentCIM_ManagedElementGroupComponent
CIM_ComponentCIM_ManagedElementPartComponent
CIM_ConcreteComponentCIM_ManagedElementGroupComponent
CIM_ConcreteComponentCIM_ManagedElementPartComponent
CIM_CredentialContextCIM_ManagedElementElementProvidingContext
CIM_DefaultElementCapabilitiesCIM_ManagedElementManagedElement
CIM_DependencyCIM_ManagedElementAntecedent
CIM_DependencyCIM_ManagedElementDependent
CIM_HostedDependencyCIM_ManagedElementAntecedent
CIM_HostedDependencyCIM_ManagedElementDependent
CIM_ScopedSettingCIM_ManagedElementAntecedent
CIM_MetricDefForMECIM_ManagedElementAntecedent
CIM_MetricForMECIM_ManagedElementAntecedent
CIM_RelatedElementCausingErrorCIM_ManagedElementDependent
CIM_RelatedElementCausingErrorCIM_ManagedElementAntecedent
CIM_SparedCIM_ManagedElementAntecedent
CIM_SparedCIM_ManagedElementDependent
CIM_ConcreteDependencyCIM_ManagedElementAntecedent
CIM_ConcreteDependencyCIM_ManagedElementDependent
CIM_ElementAsUserCIM_ManagedElementAntecedent
CIM_RecordAppliesToElementCIM_ManagedElementDependent
CIM_AuthenticationTargetCIM_ManagedElementDependent
CIM_AuthorizationSubjectCIM_ManagedElementDependent
CIM_AuthorizationTargetCIM_ManagedElementDependent
CIM_ElementSoftwareIdentityCIM_ManagedElementDependent
CIM_IsSpareCIM_ManagedElementAntecedent
CIM_ProvidesServiceToElementCIM_ManagedElementDependent
CIM_ElementCapabilitiesCIM_ManagedElementManagedElement
CIM_IdentityContextCIM_ManagedElementElementProvidingContext
CIM_LogicalIdentityCIM_ManagedElementSystemElement
CIM_LogicalIdentityCIM_ManagedElementSameElement
CIM_ConcreteIdentityCIM_ManagedElementSystemElement
CIM_ConcreteIdentityCIM_ManagedElementSameElement
CIM_SWRManageableAspectCIM_ManagedElementSystemElement
CIM_MemberOfCollectionCIM_ManagedElementMember
CIM_MemberPrincipalCIM_ManagedElementMember
CIM_ElementInPolicyRoleCollectionCIM_ManagedElementMember
CIM_OwningCollectionElementCIM_ManagedElementOwningElement
CIM_ParametersForMethodCIM_ManagedElementTheMethod
CIM_ParameterValueSourcesCIM_ManagedElementValueSource
CIM_PolicySetAppliesToElementCIM_ManagedElementManagedElement
CIM_AuthorizationRuleAppliesToTargetCIM_ManagedElementManagedElement
CIM_RoleLimitedToTargetCIM_ManagedElementTargetElement
CIM_StatisticsCIM_ManagedElementElement
CIM_SynchronizedCIM_ManagedElementSystemElement
CIM_SynchronizedCIM_ManagedElementSyncedElement
CIM_StorageSynchronizedCIM_ManagedElementSystemElement
CIM_StorageSynchronizedCIM_ManagedElementSyncedElement
CIM_AssignedIdentityCIM_ManagedElementManagedElement
CIM_AuthorizedSubjectCIM_ManagedElementPrivilegedElement
CIM_AuthorizedTargetCIM_ManagedElementTargetElement
CIM_ElementConformsToProfileCIM_ManagedElementManagedElement
CIM_ElementLocationCIM_ManagedElementElement
CIM_ElementProfileCIM_ManagedElementManagedElement
CIM_ElementSecuritySensitivityCIM_ManagedElementManagedElement
CIM_ElementSettingDataCIM_ManagedElementManagedElement
CIM_ElementStatisticalDataCIM_ManagedElementManagedElement
CIM_OwningJobElementCIM_ManagedElementOwningElement
CIM_AffectedJobElementCIM_ManagedElementAffectedElement
CIM_ServiceAffectsElementCIM_ManagedElementAffectedElement
CIM_ServiceAvailableToElementCIM_ManagedElementUserOfService
CIM_SAPAvailableForElementCIM_ManagedElementManagedElement
CIM_ManagementSAPCIM_ManagedElementManagedElement