System\CIM_FileExportService.mof.mof (HTML version)

Return to index
CIM_FileExportService Superclass: CIM_Service
Provides 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.
Qualifiers:Version ( "2.8.1000" ) Experimental UMLPackagePath ( "CIM::System::FileServices" )
Parameters (local in grey)
ValueMap { "0" , "1" , "2" , "3" , "4" , "5" , "6" , "7" , "8" , "9" , "10" , "11.." , "0x1000" , "0x1001..0x7FFF" , "0x8000.." }
Values { "Job 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" }
uint32ModifyExportedShare(
Reference to the job (may be null if job completed).
Qualifiers:OUT IN ( false )
CIM_ConcreteJob REF Job
A reference indicating an element whose sub-element is being exported. The class that Root references must be a FileSystem, a FileShare that has a MountedElement association (or a derived class of MountedElement) to a Directory, or a Directory that has a MountedElement association to a FileShare or FileSystem. If the FileShare being modified is currently exported or imported, this parameter should indicate the same Root FileSystem or FileShare element.
If Root is NULL, it indicates no change to the current root.

Qualifiers:IN
CIM_LogicalElement REF Root
A 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.

Qualifiers:IN
string SharedElementPath
The 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.
Qualifiers:EmbeddedInstance ( "CIM_ExportedFileShareSetting" ) IN
string Goal
TheShare indicates the FileShare that is to be modified. This can be an existing exported FileShare or an existing imported FileShare.
Qualifiers:IN
CIM_FileShare REF TheShare
An 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.

Qualifiers:ValueMap { "2" , "3" , "4" , ".." , "0x1000..0xFFFF" } Values { "Do Not Execute Request" , "Wait for specified time, then Execute Request " "Immediately" , "Attempt Quiescence for specified time, " "then Execute Request Immediately" , "DMTF Reserved" , "Vendor Defined" } IN
uint16 InUseOptions
An 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.

Qualifiers:Punit ( "second" ) Units ( "seconds" ) IN
uint32 WaitTime
A reference to a concrete derived class of CIM_Identity that indicates the user id to use for default access to this share. A NULL value indicates that any existing user id is not changed. The provider is expected to surface this access using the privilege model. This method does not support disabling the currently specified default user id, which must be done using the privilege model.
Qualifiers:IN
CIM_Identity REF DefaultUserId
An 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.

Qualifiers:ArrayType ( "Indexed" ) ModelCorrespondence { "CIM_ExportedFileShareSetting.RootAccess" } IN
string RootAccessHosts [ ]
An 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.

Qualifiers:ArrayType ( "Indexed" ) ModelCorrespondence { "CIM_ExportedFileShareSetting.AccessPoints" } IN
string AccessPointPorts [ ]
)
Start 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.
ValueMap { "0" , "1" , "2" , "3" , "4" , "5" , "6" , "7" , "8" , "9" , "10.." , "0x1000" , "0x1001..0x7FFF" , "0x8000.." }
Values { "Job 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" }
uint32CreateExportedShare(
Reference to the job (may be null if job completed).
Qualifiers:OUT IN ( false )
CIM_ConcreteJob REF Job
A reference indicating an element whose sub-element is being exported. The class that Root references must be a FileSystem, a FileShare that has a MountedElement association (or a derived class of MountedElement) to a LogicalFile (or Directory), or a LogicalFile (or a derived class such as Directory) that has a MountedElement association to a FileShare or FileSystem.
If Root is NULL, it indicates the root of the FileExportService host's default local FileSystem, that is used as the default local name space.

Qualifiers:OUT IN
CIM_LogicalElement REF Root
A 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.

Qualifiers:IN
string SharedElementPath
The 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.
Qualifiers:EmbeddedInstance ( "CIM_ExportedFileShareSetting" ) IN
string Goal
This specifies the FileShare element (or its derived class) that is created by the method, if successful.
Qualifiers:OUT
CIM_FileShare REF TheShare
A reference to a concrete derived class of CIM_Identity that indicates the user id to use for default access to this share. A NULL value indicates that no user id is specified. The provider is expected to surface this access using the privilege model.
Qualifiers:IN
CIM_Identity REF DefaultUserId
An 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.

Qualifiers:ArrayType ( "Indexed" ) ModelCorrespondence { "CIM_ExportedFileShareSetting.RootAccess" } IN
string RootAccessHosts [ ]
An 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.

Qualifiers:ArrayType ( "Indexed" ) ModelCorrespondence { "CIM_ExportedFileShareSetting.AccessPoints" } IN
string AccessPointPorts [ ]
)
Start 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.
ValueMap { "0" , "1" , "2" , "3" , "4" , "5" , "10" , ".." , "0x1000" , "0x1001..0x7FFF" , "0x8000.." }
Values { "Job 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" }
uint32ReleaseExportedShare(
Reference to the job (may be null if job completed).
Qualifiers:OUT IN ( false )
CIM_ConcreteJob REF Job
The imported Share to be released.
Qualifiers:IN
CIM_Share REF TheShare
An 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.

Qualifiers:ValueMap { "2" , "3" , "4" , ".." , "0x1000..0xFFFF" } Values { "Do Not Execute Request" , "Wait for specified time, then Release Immediately" , "Attempt Quiescence for specified time, then Release " "Immediately" , "DMTF Reserved" , "Vendor Defined" } IN
uint16 InUseOptions
An 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.

Qualifiers:Punit ( "second" ) Units ( "seconds" ) IN
uint32 WaitTime
)
Start 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.
MaxLen ( 256 )
Propagated ( "CIM_System.Name" )
Key
string SystemName ;
The Name of the scoping System.
boolean Started ;
Started is a Boolean that indicates whether the Service has been started (TRUE), or stopped (FALSE).
uint32StopService()
The 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.
MaxLen ( 256 )
Propagated ( "CIM_System.CreationClassName" )
Key
string SystemCreationClassName ;
The CreationClassName of the scoping System.
MaxLen ( 64 )
MappingStrings { "MIF.DMTF|General Information|001.3" }
Write
string PrimaryOwnerName ;
The name of the primary owner for the service, if one is defined. The primary owner is the initial support contact for the Service.
uint32StartService()
The 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.
MaxLen ( 256 )
Key
Override ( "Name" )
string Name ;
The 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.
MaxLen ( 256 )
Key
string CreationClassName ;
CreationClassName 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.
ValueMap { "Automatic" , "Manual" }
MaxLen ( 10 )
Deprecated { "CIM_Service.EnabledDefault" }
string StartMode ;
Note: 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.
MaxLen ( 256 )
MappingStrings { "MIF.DMTF|General Information|001.4" }
Write
string PrimaryOwnerContact ;
A 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).
datetime TimeOfLastStateChange ;
The 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.
ValueMap { "0" , "1" , "2" , "3" , "4" , "5" , "6" , ".." , "4096" , "4097" , "4098" , "4099" , "4100..32767" , "32768..65535" }
Values { "Completed 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" }
ModelCorrespondence { "CIM_EnabledLogicalElement.RequestedState" }
uint32RequestStateChange(
The 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.
Qualifiers:ValueMap { "2" , "3" , "4" , "6" , "7" , "8" , "9" , "10" , "11" , ".." , "32768..65535" } Values { "Enabled" , "Disabled" , "Shut Down" , "Offline" , "Test" , "Defer" , "Quiesce" , "Reboot" , "Reset" , "DMTF Reserved" , "Vendor Reserved" } ModelCorrespondence { "CIM_EnabledLogicalElement.RequestedState" } IN
uint16 RequestedState
Reference to the job (can be null if the task is completed).
Qualifiers:OUT IN ( false )
CIM_ConcreteJob REF Job
A 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.

Qualifiers:IN
datetime TimeoutPeriod
)
Requests 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.
ValueMap { "2" , "3" , "4" , "5" , "6" , "7" , "8" , "9" , "10" , "11" , "12" , ".." , "32768..65535" }
Values { "Enabled" , "Disabled" , "Shut Down" , "No Change" , "Offline" , "Test" , "Deferred" , "Quiesce" , "Reboot" , "Reset" , "Not Applicable" , "DMTF Reserved" , "Vendor Reserved" }
ModelCorrespondence { "CIM_EnabledLogicalElement.EnabledState" }
uint16 RequestedState = 12 ;
RequestedState 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.
Offline (6) indicates that the element has been requested to transition to the Enabled but Offline EnabledState.
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.
ValueMap { "2" , "3" , "5" , "6" , "7" , "9" , ".." , "32768..65535" }
Values { "Enabled" , "Disabled" , "Not Applicable" , "Enabled but Offline" , "No Default" , "Quiesce" , "DMTF Reserved" , "Vendor Reserved" }
Write
uint16 EnabledDefault = 2 ;
An 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).
ModelCorrespondence { "CIM_EnabledLogicalElement.EnabledState" }
string OtherEnabledState ;
A 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.
ValueMap { "0" , "1" , "2" , "3" , ".." , "0x8000.." }
Values { "Unknown" , "OK" , "Degraded" , "Error" , "DMTF Reserved" , "Vendor Reserved" }
Experimental
ModelCorrespondence { "CIM_ManagedSystemElement.DetailedStatus" , "CIM_ManagedSystemElement.HealthState" }
uint16 PrimaryStatus ;
PrimaryStatus provides a high level status value, intended to align with Red-Yellow-Green type representation of status. It should be used in conjunction with DetailedStatus to provide high level and detailed health status of the ManagedElement and its subcomponents.
PrimaryStatus consists of one of the following values: Unknown, OK, Degraded or Error. 'Unknown' indicates the implementation is in general capable of returning this property, but is unable to do so at this time.
'OK' indicates the ManagedElement is functioning normally.
'Degraded' indicates the ManagedElement is functioning below normal.
'Error' indicates the ManagedElement is in an Error condition.
ValueMap { "0" , "1" , "2" , "3" , "4" , "5" , "6" , "7" , "8" , "9" , "10" , "11" , "12" , "13" , "14" , ".." , "0x8000.." }
Values { "Unknown" , "Not Available" , "In Service" , "Starting" , "Stopping" , "Stopped" , "Aborted" , "Dormant" , "Completed" , "Migrating" , "Emigrating" , "Immigrating" , "Snapshotting" , "Shutting Down" , "In Test" , "DMTF Reserved" , "Vendor Reserved" }
Experimental
ModelCorrespondence { "CIM_EnabledLogicalElement.EnabledState" }
uint16 OperatingStatus ;
OperatingStatus provides a current status value for the operational condition of the element and can be used for providing more detail with respect to the value of EnabledState. It can also provide the transitional states when an element is transitioning from one state to another, such as when an element is transitioning between EnabledState and RequestedState, as well as other transitional conditions.
OperatingStatus consists of one of the following values: Unknown, Not Available, In Service, Starting, Stopping, Stopped, Aborted, Dormant, Completed, Migrating, Emmigrating, Immigrating, Snapshotting. Shutting Down, In Test
A Null return indicates the implementation (provider) does not implement this property.
'Unknown' indicates the implementation is in general capable of returning this property, but is unable to do so at this time.
'None' indicates that the implementation (provider) is capable of returning a value for this property, but not ever for this particular piece of hardware/software or the property is intentionally not used because it adds no meaningful information (as in the case of a property that is intended to add additional info to another property).
'In Service' describes an element being configured, maintained, cleaned, or otherwise administered.
'Starting' describes an element being initialized.
'Stopping' describes an element being brought to an orderly stop.
'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.
'Completed' indicates that the element has completed its operation. This value should be combined with either OK, Error, or Degraded in the PrimaryStatus 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).
'Migrating' element is being moved between host elements.
'Immigrating' element is being moved to new host element.
'Emigrating' element is being moved away from host element.
'Shutting Down' describes an element being brought to an abrupt stop.
'In Test' element is performing test functions.
ValueMap { "0" , "1" , "2" , "3" , "4" , "5" , "6" , "7" , "8" , "9" , "10" , "11..32767" , "32768..65535" }
Values { "Unknown" , "Other" , "Enabled" , "Disabled" , "Shutting Down" , "Not Applicable" , "Enabled but Offline" , "In Test" , "Deferred" , "Quiesce" , "Starting" , "DMTF Reserved" , "Vendor Reserved" }
ModelCorrespondence { "CIM_EnabledLogicalElement.OtherEnabledState" }
uint16 EnabledState = 5 ;
EnabledState 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.
Starting (10) indicates that the element is in the process of going to an Enabled state. New requests are queued.
ValueMap { "0" , "1" , "2" , "3" , "4" , "5" , ".." , "0x8000.." }
Values { "Not Available" , "No Additional Information" , "Stressed" , "Predictive Failure" , "Non-Recoverable Error" , "Supporting Entity in Error" , "DMTF Reserved" , "Vendor Reserved" }
Experimental
ModelCorrespondence { "CIM_EnabledLogicalElement.PrimaryStatus" , "CIM_ManagedSystemElement.HealthState" }
uint16 DetailedStatus ;
DetailedStatus compliments PrimaryStatus with additional status detail. It consists of one of the following values: Not Available, No Additional Information, Stressed, Predictive Failure, Error, Non-Recoverable Error, SupportingEntityInError. Detailed status is used to expand upon the PrimaryStatus of the element.
A Null return indicates the implementation (provider) does not implement this property.
'Not Available' indicates that the implementation (provider) is capable of returning a value for this property, but not ever for this particular piece of hardware/software or the property is intentionally not used because it adds no meaningful information (as in the case of a property that is intended to add additional info to another property).
'No Additional Information' indicates that the element is functioning normally as indicated by PrimaryStatus = 'OK'.
'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 normally but a failure is predicted in the near future.
'Non-Recoverable Error ' indicates that this element is in an error condition that requires human intervention.
'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.
ValueMap { "0" , "1" , "2" , "3" , "4" , ".." , "0x8000.." }
Values { "Unknown" , "Not Available" , "Communication OK" , "Lost Communication" , "No Contact" , "DMTF Reserved" , "Vendor Reserved" }
Experimental
uint16 CommunicationStatus ;
CommunicationStatus indicates the ability of the instrumentation to communicate with the underlying ManagedElement. CommunicationStatus consists of one of the following values: Unknown, None, Communication OK, Lost Communication, or No Contact.
A Null return indicates the implementation (provider) does not implement this property.
'Unknown' indicates the implementation is in general capable of returning this property, but is unable to do so at this time.
'Not Available' indicates that the implementation (provider) is capable of returning a value for this property, but not ever for this particular piece of hardware/software or the property is intentionally not used because it adds no meaningful information (as in the case of a property that is intended to add additional info to another property).
'Communication OK ' indicates communication is established with the element, but does not convey any quality of service.
'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 Managed Element is known to exist and has been contacted successfully in the past, but is currently unreachable.
ValueMap { "0" , "1" , "2" , "3" , "4" , "5" , "6" , "7" , "8" , "9" , "10" , "11" , "12" , "13" , "14" , "15" , "16" , "17" , "18" , ".." , "0x8000.." }
ArrayType ( "Indexed" )
Values { "Unknown" , "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" }
ModelCorrespondence { "CIM_ManagedSystemElement.StatusDescriptions" }
uint16 OperationalStatus [ ] ;
Indicates 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.
ArrayType ( "Indexed" )
ModelCorrespondence { "CIM_ManagedSystemElement.OperationalStatus" }
string StatusDescriptions [ ] ;
Strings 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.
ValueMap { "OK" , "Error" , "Degraded" , "Unknown" , "Pred Fail" , "Starting" , "Stopping" , "Service" , "Stressed" , "NonRecover" , "No Contact" , "Lost Comm" , "Stopped" }
MaxLen ( 10 )
Deprecated { "CIM_ManagedSystemElement.OperationalStatus" }
string Status ;
A 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.
MappingStrings { "MIF.DMTF|ComponentID|001.5" }
datetime InstallDate ;
A datetime value that indicates when the object was installed. Lack of a value does not indicate that the object is not installed.
ValueMap { "0" , "5" , "10" , "15" , "20" , "25" , "30" , ".." }
Values { "Unknown" , "OK" , "Degraded/Warning" , "Minor failure" , "Major failure" , "Critical failure" , "Non-recoverable error" , "DMTF Reserved" }
uint16 HealthState ;
Indicates 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.
string ElementName ;
A 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.
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.