The ZoneService if responsible for managing the zone enforcement for the fabric. The ZoneService is hosted on an AdminDomain. This is depicted by the HostedService association. | Qualifiers:Version ( "2.8.0" ) | Parameters (local in grey) | | Values { "Success" , "Not Supported" , "Unspecified Error" , "Timeout" , "Failed" , "Invalid Parameter" , "Access_Denied" , "Not_Found" , "Insufficient_Resources" , "DMTF_Reserved" , "Method_Reserved" , "Vendor_Reserved" } ValueMap { "0" , "1" , "2" , "3" , "4" , "5" , "6" , "7" , "9" , "10..0x0FFF" , "0x1000..0x7777" , "0x8000.." } uint32ActivateZoneSet( | | A reference to the ZoneSet to be activated. Qualifiers:Required
IN
| | CIM_ZoneSet ref ZoneSet | | | Activate indicates whether the references ZoneSet should be activated (Active=true) or deactivated (Active=false). Qualifiers:Required
IN
| | boolean Activate | ) Activates the specified ZoneSet. Once the ZoneSet in activated, the ZoneSet and associatiated Zone, ZoneAliases, and ZoneMembershipSettingData instances will have the active flag set to true. This method maybe deprecated in the future in lieu of intrinsics once limitations in the CIM Operations are addressed. | Values { "Start" , "End" , "Terminate" , "No Change" } ModelCorrespondence { "CIM_ZoneService.SessionState" , "CIM_ZoneService.SessionControl()" } ValueMap { "2" , "3" , "4" , "5" } uint16 RequestedSessionState = 5 ; RequestedSessionState is an integer enumeration indicating whether the ZoneService session has been requested to start (value = 2), end (3), or terminate (4). Note that when RequestedSessionState is set to 4 ('Not Applicable'), then this property is not used. By default, the element's RequestedSessionState is 5 ('No Change'). | Values { "Success" , "Not Supported" , "Unspecified Error" , "Timeout" , "Failed" , "Invalid Parameter" , "Access_Denied" , "Insufficient_Resources" , "DMTF_Reserved" , "Method_Reserved" , "Vendor_Reserved" } ValueMap { "0" , "1" , "2" , "3" , "4" , "5" , "6" , "9" , "10..0x0FFF" , "0x1000..0x7777" , "0x8000.." } uint32SessionControl( | | RequestedSessionState is an integer enumeration indicating whether the ZoneService session has been requested to start (value = 2), end (3), or terminate (4). Qualifiers:Values { "Start" , "End" , "Terminate" }
IN
ModelCorrespondence { "CIM_ZoneService.RequestedSessionState" }
ValueMap { "2" , "3" , "4" }
| | uint16 RequestedSessionState | ) SessionControl requests that a session start (value = 2), end (3), or terminate (4). | Values { "Success" , "Not Supported" , "Unspecified Error" , "Timeout" , "Failed" , "Invalid Parameter" , "Access_Denied" , "Not_Found" , "Already_Exists" , "Insufficient_Resources" , "DMTF_Reserved" , "Method_Reserved" , "Vendor_Reserved" } ValueMap { "0" , "1" , "2" , "3" , "4" , "5" , "6" , "7" , "8" , "9" , "10..0x0FFF" , "0x1000..0x7777" , "0x8000.." } uint32CreateZoneSet( | | A user-friendly name for the ZoneSet that is unique within the AdminDomain. Qualifiers:Required
IN
ModelCorrespondence { "CIM_ZoneSet.ElementName" }
| | string ZoneSetName | | | A reference to the newly created Zone. Qualifiers:OUT
IN ( false )
| | CIM_ZoneSet ref ZoneSet | ) The method creates a ZoneSet and the association HostedCollection. The newly created association, HostedCollection, associates the Zone to the same AdminDomain the ZoneService is hosted to. For the newly created ZoneSet, the Active property is always set to false. This method maybe deprecated in the future in lieu of intrinsics once limitations in the CIM Operations are addressed. | Values { "Success" , "Not Supported" , "Unspecified Error" , "Timeout" , "Failed" , "Invalid Parameter" , "Access_Denied" , "Not_Found" , "Already_Exists" , "Insufficient_Resources" , "DMTF_Reserved" , "Method_Reserved" , "Vendor_Reserved" } ValueMap { "0" , "1" , "2" , "3" , "4" , "5" , "6" , "7" , "8" , "9" , "10..0x0FFF" , "0x1000..0x7777" , "0x8000.." } uint32CreateZone( | | A user-friendly name for the Zone that is unique within the AdminDomain. Qualifiers:Required
IN
ModelCorrespondence { "CIM_Zone.ElementName" }
| | string ZoneName | | | The type of zoning to be enforced. Qualifiers:Values { "Default" , "Protocol" }
IN
ModelCorrespondence { "CIM_Zone.ZoneType" }
ValueMap { "2" , "3" }
| | uint16 ZoneType | | | Specific clarification when necessary when the ZoneType has an enumeration that requires it. Specifically, if ZoneType is 'Protocol', then SubType is the Fibre Channel FC4 type. Qualifiers:Values { "SCSI" , "VI" , "IP" }
IN
ModelCorrespondence { "CIM_Zone.ZoneSubType" }
ValueMap { "2" , "3" , "4" }
| | uint16 ZoneSubType | | | A reference to the newly created Zone. Qualifiers:OUT
IN ( false )
| | CIM_Zone ref Zone | ) The method creates a Zone and the association HostedCollection. The newly created association, HostedCollection, associates the Zone to the same AdminDomain the ZoneService is hosted to. For the newly created Zone, the Active property is always set to false. This method maybe deprecated in the future in lieu of intrinsics once limitations in the CIM Operations are addressed. | Values { "Success" , "Not Supported" , "Unspecified Error" , "Timeout" , "Failed" , "Invalid Parameter" , "Access_Denied" , "Not_Found" , "Already_Exists" , "Insufficient_Resources" , "DMTF_Reserved" , "Method_Reserved" , "Vendor_Reserved" } ValueMap { "0" , "1" , "2" , "3" , "4" , "5" , "6" , "7" , "8" , "9" , "10..0x0FFF" , "0x1000..0x7777" , "0x8000.." } uint32CreateZoneMembershipSettingData( | | Identifies the type of identification placed in ConnectivityMemberID. Qualifiers:Values { "Unknown" , "Other" , "PermanentAddress" , "NetworkAddress" , "SwitchPortID" , "LogicalPortGroup" , "DMTF_Reserved" , "Vendor_Reserved" }
Required
IN
ModelCorrespondence { "CIM_ZoneMembershipSettingData.ZoneMemberType" }
ValueMap { "0" , "1" , "2" , "3" , "4" , "5" , ".." , "0x8000.." }
| | uint16 ConnectivityMemberType | | | This specifies the type of identification used in the ConnectivityMemberID field. For Fibre Channel: * A ConnectivityMemberType of 'PermanentAddress', the ConnectivityMemberID is the NxPort WWN; * A ConnectivityMemberType of 'NetworkAddress', the ConnectivityMemberID is the NXPort Address ID; * A ConnectivityMemberType of 'SwitchPortID', the ConnectivityMemberID is 'Domain:PortNumber'. Qualifiers:Required
IN
ModelCorrespondence { "CIM_ZoneMembershipSettingData.ConnectivityMemberID" }
| | string ConnectivityMemberID | | | The collection that the ZoneMembershipSettingData should be added to. The collection is either a Zone or ZoneAlias. Qualifiers:Required
IN
| | CIM_SystemSpecificCollection ref SystemSpecificCollection | | | A reference to the newly created ZoneMembershipSettingData. Qualifiers:OUT
IN ( false )
| | CIM_ZoneMembershipSettingData ref ZoneMembershipSettingData | ) CreateZoneMembershipSettingData creates a ZoneMembershipSettingData and adds it to the specified Zone or ZoneAlias by creating a MemberOfCollection association.
This method maybe deprecated in the future in lieu of intrinsics once limitations in the CIM Operations are addressed. | Values { "Success" , "Not Supported" , "Unspecified Error" , "Timeout" , "Failed" , "Invalid Parameter" , "Access_Denied" , "Not_Found" , "Already_Exists" , "Insufficient_Resources" , "DMTF_Reserved" , "Method_Reserved" , "Vendor_Reserved" } ValueMap { "0" , "1" , "2" , "3" , "4" , "5" , "6" , "7" , "8" , "9" , "10..0x0FFF" , "0x1000..0x7777" , "0x8000.." } uint32CreateZoneAlias( | | A name (alias) for the ZoneAlias which is unique in the context of the hosting System. Qualifiers:Required
IN
ModelCorrespondence { "CIM_ZoneAlias.CollectionAlias" }
| | string CollectionAlias | | | A reference to the newly created ZoneAlias. Qualifiers:OUT
IN ( false )
| | CIM_NamedAddressCollection ref ZoneAlias | ) The method creates a ZoneAlias and the association HostedCollection. The newly created association, HostedCollection, associates the ZoneAlias to the same AdminDomain the ZoneService is hosted to. For the newly created ZoneAlias, the Active property is always set to false. This method maybe deprecated in the future in lieu of intrinsics once limitations in the CIM Operations are addressed. | Values { "Success" , "Not Supported" , "Unspecified Error" , "Timeout" , "Failed" , "Invalid Parameter" , "Access_Denied" , "Not_Found" , "Already_Exists" , "Insufficient_Resources" , "DMTF_Reserved" , "Method_Reserved" , "Vendor_Reserved" } ValueMap { "0" , "1" , "2" , "3" , "4" , "5" , "6" , "7" , "8" , "9" , "10..0x0FFF" , "0x1000..0x7777" , "0x8000.." } uint32AddZoneMembershipSettingData( | | A reference to the Zone or ZoneAlias the ZoneMembershipSettingData is to be added. Qualifiers:Required
IN
| | CIM_SystemSpecificCollection ref SystemSpecificCollection | | | A reference to the ZoneMembershipSettingData to be added to the Zone or ZoneAlias. Qualifiers:IN
| | CIM_ZoneMembershipSettingData ref ZoneMembershipSettingData | ) Adds to the Zone or ZoneAlias the specified ZoneMembershipSettingData. If adding the ZoneMembershipSettingData is successful, an ElementSettingData association will be created between the ZoneMembershipSettingData and either the Zone or ZoneAlias.
This method maybe deprecated in the future in lieu of intrinsics once limitations in the CIM Operations are addressed. | Values { "Success" , "Not Supported" , "Unspecified Error" , "Timeout" , "Failed" , "Invalid Parameter" , "Access_Denied" , "Not_Found" , "Already_Exists" , "Insufficient_Resources" , "DMTF_Reserved" , "Method_Reserved" , "Vendor_Reserved" } ValueMap { "0" , "1" , "2" , "3" , "4" , "5" , "6" , "7" , "8" , "9" , "10..0x0FFF" , "0x1000..0x7777" , "0x8000.." } uint32AddZoneAlias( | | A reference to the Zone the ZoneAlias is to be added. Qualifiers:Required
IN
| | CIM_Zone ref Zone | | | A reference to the ZoneAlias to be added to the Zone. Qualifiers:IN
| | CIM_NamedAddressCollection ref ZoneAlias | ) Adds to the Zone the specified ZoneAlias. This method maybe deprecated in the future in lieu of intrinsics once limitations in the CIM Operations are addressed. | Values { "Success" , "Not Supported" , "Unspecified Error" , "Timeout" , "Failed" , "Invalid Parameter" , "Access_Denied" , "Not_Found" , "Already_Exists" , "Insufficient_Resources" , "DMTF_Reserved" , "Method_Reserved" , "Vendor_Reserved" } ValueMap { "0" , "1" , "2" , "3" , "4" , "5" , "6" , "7" , "8" , "9" , "10..0x0FFF" , "0x1000..0x7777" , "0x8000.." } uint32AddZone( | | A reference to the ZoneSet the Zone is added to. Qualifiers:Required
IN
| | CIM_ZoneSet ref ZoneSet | | | A reference to the Zone to be added to the ZoneSet. Qualifiers:IN
| | CIM_Zone ref Zone | ) Adds to the ZoneSet the specified Zone. Adding a Zone to a ZoneSet, extends the zone enforcement definition of the ZoneSet to include the members of that Zone. If adding the Zone is, successful, the Zone should be associated to the ZoneSet by MemberOfCollection. This method maybe deprecated in the future in lieu of intrinsics once limitations in the CIM Operations are addressed. | Values { "Unknown" , "Starting" , "Ended" , "Not Applicable" } ValueMap { "0" , "2" , "3" , "4" } uint16 SessionState = 4 ; SessionState is an integer enumeration indicating whether the session is currently starting (value = 2), or ended (value = 3). It is possible that a particular instance of a ZoneService may not support sessions. If this occurs, the value 4 ('Not Applicable') is used. | boolean Started ; Started is a Boolean that indicates whether the Service has been started (TRUE), or stopped (FALSE). | Propagated ( "CIM_System.Name" ) MaxLen ( 256 ) Key string SystemName ; The Name of the scoping System. | MaxLen ( 10 ) Deprecated { "CIM_Service.EnabledDefault" } ValueMap { "Automatic" , "Manual" } 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. | 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. | 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. | Propagated ( "CIM_System.CreationClassName" ) MaxLen ( 256 ) Key string SystemCreationClassName ; The CreationClassName of the scoping System. | MaxLen ( 256 ) Override ( "Name" ) Key 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 ) Write MappingStrings { "MIF.DMTF|General Information|001.4" } 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). | 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. | MaxLen ( 64 ) Write MappingStrings { "MIF.DMTF|General Information|001.3" } 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. | 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. | 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" } ValueMap { "0" , "1" , "2" , "3" , "4" , "5" , "6" , "7" , "8" , "9" , "10" , "11..32767" , "32768..65535" } 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. 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. | 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. | 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" } ValueMap { "0" , "1" , "2" , "3" , "4" , "5" , "6" , ".." , "4096" , "4097" , "4098" , "4099" , "4100..32767" , "32768..65535" } 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:Values { "Enabled" , "Disabled" , "Shut Down" , "Offline" , "Test" , "Defer" , "Quiesce" , "Reboot" , "Reset" , "DMTF Reserved" , "Vendor Reserved" }
IN
ModelCorrespondence { "CIM_EnabledLogicalElement.RequestedState" }
ValueMap { "2" , "3" , "4" , "6" , "7" , "8" , "9" , "10" , "11" , ".." , "32768..65535" }
| | 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. | Values { "Enabled" , "Disabled" , "Shut Down" , "No Change" , "Offline" , "Test" , "Deferred" , "Quiesce" , "Reboot" , "Reset" , "Not Applicable" , "DMTF Reserved" , "Vendor Reserved" } ModelCorrespondence { "CIM_EnabledLogicalElement.EnabledState" } ValueMap { "2" , "3" , "4" , "5" , "6" , "7" , "8" , "9" , "10" , "11" , "12" , ".." , "32768..65535" } 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. 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. | Values { "Enabled" , "Disabled" , "Not Applicable" , "Enabled but Offline" , "No Default" , "DMTF Reserved" , "Vendor Reserved" } Write ValueMap { "2" , "3" , "5" , "6" , "7" , "8..32767" , "32768..65535" } 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_ManagedSystemElement.OperationalStatus" } ArrayType ( "Indexed" ) 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. | 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" } ValueMap { "0" , "1" , "2" , "3" , "4" , "5" , "6" , "7" , "8" , "9" , "10" , "11" , "12" , "13" , "14" , "15" , "16" , "17" , "18" , ".." , "0x8000.." } ArrayType ( "Indexed" ) uint16 OperationalStatus [ ] ; Indicates the current status(es) of the element. Various health and operational statuses are defined. Many of the enumeration's values are self- explanatory. However, a few are not and are described in more detail. 'Stressed' indicates that the element is functioning, but needs attention. Examples of 'Stressed' states are overload, overheated, etc. '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 element's state and configuration may need to be updated. 'Dormant' indicates that the element is inactive or quiesced. 'Supporting Entity in Error' describes that this element may 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 the element has completed its operation. This value should be combined with either OK, Error, or Degraded so that a client can till if the complete operation passed (Completed with OK), and failure (Completed with Error). Completed with Degraded would imply the operation finished, but did not complete OK or report an error. 'Power Mode' indicates 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 since it required the DEPRECATED qualifier. Due to the widespread use of the existing Status property in management applications, it is strongly RECOMMENDED that providers/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 (since it is single-valued) SHOULD also provide the primary status of the element. | MappingStrings { "MIF.DMTF|ComponentID|001.5" } datetime InstallDate ; A datetime value indicating when the object was installed. A lack of a value does not indicate that the object is not installed. | MaxLen ( 10 ) Deprecated { "CIM_ManagedSystemElement.OperationalStatus" } ValueMap { "OK" , "Error" , "Degraded" , "Unknown" , "Pred Fail" , "Starting" , "Stopping" , "Service" , "Stressed" , "NonRecover" , "No Contact" , "Lost Comm" , "Stopped" } 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 overcomes the limitation of describing status via a single value, when it is really a multi-valued property (for example, an element may be OK AND Stopped. 2) A MaxLen of 10 is too restrictive and leads to unclear enumerated values. And, 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. | 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. | 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. |
| | | | |
|