This service allows the active management of a Storage Server. It allows jobs to be started for the creation, modification and deletion of storage objects (StoragePools, StorageVolumes and LogicalDisks). | Qualifiers:Version ( "2.13.0" ) UMLPackagePath ( "CIM::Device::StorageServices" ) | Parameters (local in grey) | | ValueMap { "0" , "1" , "2" , "3" , "4" , "5" , "6" , ".." , "0x1000" , "0x1001..0x7FFF" , "0x8000..0xFFFF" } Values { "Job Completed with No Error" , "Not Supported" , "Unspecified Error" , "Timeout" , "Failed" , "Invalid Parameter" , "In Use" , "DMTF Reserved" , "Method Parameters Checked - Job Started" , "Method Reserved" , "Vendor Specific" } Experimental uint32AttachOrModifyReplica( | | Reference to the job (may be null if the task completed). Qualifiers:OUT
IN ( false )
| | CIM_ConcreteJob REF Job | | | The source storage element which may be a StorageVolume, StorageExtent, LogicalFile, FileSystem, CommonDatabase, or any other storage object. For this reason, the type is made very generic. Qualifiers:Required
IN
| | CIM_ManagedElement REF SourceElement | | | Reference to the target storage element (i.e., the replica). The target storage element which may be a StorageVolume, StorageExtent, LogicalFile, FileSystem, CommonDatabase, or any other storage object. For this reason, the type is made very generic. Qualifiers:Required
IN
| | CIM_ManagedElement REF TargetElement | | | CopyType describes the type of Synchronized relationship that will be created. Values are: Async: Create and maintain an asynchronous copy of the source. Sync: Create and maintain a synchronized copy of the source. UnSyncAssoc: Create an unsynchronized copy and maintain an association to the source element. UnSyncUnAssoc: Create an unassociated copy of the source element. UnSyncAssoc and UnSyncUnAssoc are not supported for remote mirror replicas. Qualifiers:ValueMap { "2" , "3" , "4" , "5" , "6..4095" , "0x1000..0xFFFF" }
Values { "Async" , "Sync" , "UnSyncAssoc" , "UnSyncUnAssoc" , "DMTF Reserved" , "Vendor Specific" }
Required
IN
| | uint16 CopyType | | | The StorageSetting properties to be created or modified for the target element. Qualifiers:EmbeddedInstance ( "CIM_SettingData" )
IN
| | string Goal | | | The NetworkPipe element that scopes the remote mirror pair. If the value is null, remote mirrors do not require a pre-established connection. Qualifiers:IN
| | CIM_NetworkPipe REF ReplicationPipe | ) Create (or start a job to create) a StorageSynchronized mirror relationship between two storage elements. The target element may be a local or a remote storage element. A remote mirror pair may be scoped by a peer-to-peer connection modeled as a NetworkPipe between peers. If Job Completed with No Error (0) is returned, the function completed successfully and a ConcreteJob instance is not created. If Method Parameters Checked - Job Started (0x1000) is returned, a ConcreteJob is started, a reference to which is returned in the Job output parameter. A return value of Not Supported (1) indicates the method is not supported. All other values indicate some type of error condition. | ValueMap { "0" , "1" , "2" , "3" , "4" , "5" , "6" , ".." , "0x1000" , "0x1001..0x7FFF" , "0x8000..0xFFFF" } Values { "Job Completed with No Error" , "Not Supported" , "Unspecified Error" , "Timeout" , "Failed" , "Invalid Parameter" , "In Use" , "DMTF Reserved" , "Method Parameters Checked - Job Started" , "Method Reserved" , "Vendor Specific" } uint32ModifySynchronization( | | Operation describes the type of modification to be made to the replica. Values are: Detach: 'Forget' the synchronization between two storage objects. Start to treat the objects as independent. Fracture: Suspend the synchronization between two storage objects using Sync or Async replication. The association and (typically) changes are remembered to allow a fast resynchronization. This may be used during a backup cycle to allow one of the objects to be copied while the other remains in production. Resync Replica: Re-establish the synchronization of a Sync or Async replication. This will negate the action of a previous Fracture operation. Recreate a Point In Time image for an UnSyncAssoc replication. Restore from Replica: Renew the contents of the original storage object from a replica. Prepare: Get the link ready for a Resync operation to take place. Some implementations will require this operation to be invoked to keep the Resync operation as fast as possible. May start the copy engine. Unprepare: Clear a prepared state if a Prepare is not to be followed by a Resync operation. Quiesce: Some applications require notification so that they can ready the link for an operation. For example flush any cached data or buffered changes. The copy engine is stopped for UnSyncAssoc replications. Unquiesce: Take the link from the quiesced state (without executing the intended operation. Start Copy: initiate a full background copy of the source to the UnSyncAssoc replica. Replica enters Frozen state when copy operation is completed. Stop Copy: stop the background copy previously started. Reset To Sync: Change the CopyType of the association to Sync (e.g., from the Async CopyType). Reset To Async: Change the CopyType of the association to Async (e.g., from the Sync CopyType). Qualifiers:ValueMap { "0" , "1" , "2" , "3" , "4" , "5" , "6" , "7" , "8" , "9" , "10" , "11" , "12" , "13" , ".." , "0x8000..0xFFFF" }
Values { "DMTF Reserved" , "DMTF Reserved" , "Detach" , "Fracture" , "Resync Replica" , "Restore from Replica" , "Prepare" , "Unprepare" , "Quiesce" , "Unquiesce" , "Reset To Sync" , "Reset To Async" , "Start Copy" , "Stop Copy" , "DMTF Reserved" , "Vendor Specific" }
IN
| | uint16 Operation | | | Reference to the job (may be null if the task completed). Qualifiers:OUT
IN ( false )
| | CIM_ConcreteJob REF Job | | | The referenced to the StorageSynchronized association describing the storage source/replica relationship. Qualifiers:IN
| | CIM_StorageSynchronized REF Synchronization | ) Modify (or start a job to modify) the synchronization association between two storage objects. If 0 is returned, the function completed successfully and no ConcreteJob instance was created. If 0x1000 is returned, a ConcreteJob was started and a reference to this Job is returned in the Job output parameter. A return value of 1 indicates the method is not supported. All other values indicate some type of error condition. | ValueMap { "0" , "1" , "2" , "3" , "4" , "5" , "6" , ".." , "4096" , "4097" , "4098..32767" , "32768..65535" } Values { "Completed with No Error" , "Not Supported" , "Unknown" , "Timeout" , "Failed" , "Invalid Parameter" , "In Use" , "DMTF Reserved" , "Method Parameters Checked - Job Started" , "Size Not Supported" , "Method Reserved" , "Vendor Specific" } uint32CreateOrModifyElementFromElements( | | A end user relevant name for the element being created. If NULL, then a system-supplied default name can be used. The value will be stored in the 'ElementName' property for the created element. If not NULL, this parameter will supply a new name when modifying an existing element. Qualifiers:IN
| | string ElementName | | | Enumeration indicating the type of element being created or modified. If the input parameter TheElement is specified when the operation is a 'modify', this type value must match the type of that instance. The actual CIM class of the created TheElement can be vendor-specific, but it must be a derived class of the appropriate CIM class -- i.e., CIM_StorageVolume, CIM_StorageExtent, CIM_LogicalDisk, or CIM_StoragePool. Qualifiers:ValueMap { "0" , "1" , "2" , "3" , "4" , "5" , ".." , "32768..65535" }
Values { "Unknown" , "Reserved" , "Storage Volume" , "Storage Extent" , "Storage Pool" , "Logical Disk" , "DMTF Reserved" , "Vendor Specific" }
Required
IN
| | uint16 ElementType | | | Reference to the job (may be null if job completed). Qualifiers:OUT
IN ( false )
| | CIM_ConcreteJob REF Job | | | The requirements for the element to maintain. If set to a null value, the default configuration associated with the Service will be used. This parameter should be a reference to a Setting, SettingData, or Profile appropriate to the element being created. If not NULL, this parameter will supply a new Goal when modifying an existing element. Qualifiers:IN
| | CIM_ManagedElement REF Goal | | | As an input parameter Size specifies the desired size. If not NULL, this parameter will supply a new size when modifying an existing element. As an output parameter Size specifies the size achieved. Qualifiers:Punit ( "byte" )
Units ( "Bytes" )
OUT
IN
| | uint64 Size | | | Array of references to storage element instances that are used to create or modify TheElement. Qualifiers:Required
IN
| | CIM_StorageExtent REF InElements [ ] | | | As an input parameter: if null, creates a new element. If not null, then the method modifies the specified element. As an output parameter, it is a reference to the resulting element. Qualifiers:OUT
IN
| | CIM_LogicalElement REF TheElement | ) Start a job to create (or modify) a specified storage element from specified input StorageExtents. The created or modified storage element can be a StorageExtent, StorageVolume, LogicalDisk, or StoragePool. An input list of InElements must be specified. The GetAvailableExtents method can be used to get a list of valid extents that can be used to achieve a desired goal. Validity of the extents is determined by the implementation. As an input parameter, Size specifies the desired size of the element. As an output parameter, it specifies the size achieved. Space is taken from the input InElements. The desired Settings for the element are specified by the Goal parameter. If the size of Extents passed is less than the size requested, then the capacity is drawn from the extents in the order, left to right, that the Extents were specified. The partial consumption of an Extent is represented by an Extent for the capacity used and an Extent for the capacity not used. If the Size is NULL, then a configuration using all Extents passed will be attempted. If the requested size cannot be created, no action will be taken, and the Return Value will be 4097/0x1001. Also, the output value of Size is set to the nearest possible size. If 0 is returned, the function completed successfully and no ConcreteJob instance was required. If 4096/0x1000 is returned, a ConcreteJob will be started to create the element. The Job's reference will be returned in the output parameter Job. | ValueMap { "0" , "1" , "2" , "3" , "4" , "5" , "6" , ".." , "4096" , "4097..32767" , "32768..65535" } Values { "Job Completed with No Error" , "Not Supported" , "Unknown" , "Timeout" , "Failed" , "Invalid Parameter" , "In Use" , "DMTF Reserved" , "Method Parameters Checked - Job Started" , "Method Reserved" , "Vendor Specific" } uint32CreateReplica( | | A end user relevant name for the element being created. If NULL, then a system supplied default name can be used. The value will be stored in the 'ElementName' property for the created element. Qualifiers:IN
| | string ElementName | | | Reference to the job (may be null if job completed). Qualifiers:OUT
IN ( false )
| | CIM_ConcreteJob REF Job | | | The source storage object which may be a StorageVolume or storage object. Qualifiers:Required
IN
| | CIM_LogicalElement REF SourceElement | | | Reference to the created target storage element (i.e., the replica). Qualifiers:OUT
IN ( false )
| | CIM_LogicalElement REF TargetElement | | | The definition for the StorageSetting to be maintained by the target storage object (the replica). Qualifiers:IN
| | CIM_StorageSetting REF TargetSettingGoal | | | The underlying storage for the target element (the replica) will be drawn from TargetPool if specified, otherwise the allocation is implementation specific. Qualifiers:IN
| | CIM_StoragePool REF TargetPool | | | CopyType describes the type of copy that will be made. Values are: Async: Create and maintain an asynchronous copy of the source. Sync: Create and maintain a synchronized copy of the source. UnSyncAssoc: Create an unsynchronized copy and maintain an association to the source. UnSyncUnAssoc: Create unassociated copy of the source element. Qualifiers:ValueMap { "2" , "3" , "4" , "5" , ".." , "32768..65535" }
Values { "Async" , "Sync" , "UnSyncAssoc" , "UnSyncUnAssoc" , "DMTF Reserved" , "Vendor Specific" }
IN
| | uint16 CopyType | ) Start a job to create a new storage object which is a replica of the specified source storage object. (SourceElement). Note that using the input paramter, CopyType, this function can be used to instantiate the replica, and to create an ongoing association between the source and replica. If 0 is returned, the function completed successfully and no ConcreteJob instance is created. If 4096/0x1000 is returned, a ConcreteJob is started, a reference to which is returned in the Job output parameter. | ValueMap { "0" , "1" , "2" , "3" , "4" , "5" , ".." , "0x1000" , "0x1001..0x7FFF" , "0x8000..0xFFFF" } Values { "Success" , "Not Supported" , "Unspecified Error" , "Timeout" , "Failed" , "Invalid Parameter" , "DMTF Reserved" , "Busy" , "Method Reserved" , "Vendor Specific" } Experimental uint32CreateOrModifyReplicationPipe( | | A user-friendly name for the element created. Qualifiers:IN
| | string PipeElementName | | | One of the two peer systems participating in the established peer-to-peer connection. If the provider supports uni-directional connections, this must identify the system hosting replica source elements. Qualifiers:Required
IN
| | CIM_ComputerSystem REF SourceSystem | | | One of the two peer systems participating in the established peer-to-peer connection. If the provider supports uni-directional connections, this must identify the system hosting replica target elements. Qualifiers:Required
IN
| | CIM_ComputerSystem REF TargetSystem | | | References to source system endpoints/ports assigned to the pipe. If a new pipe is created, this is the initial set of endpoints assigned. If an existing pipe is modified, this set replaces the previous set. The list must be null if a provider does not allow the client to manage port assignment. Qualifiers:IN
| | CIM_ProtocolEndpoint REF SourceEndpoint [ ] | | | References to target system endpoints/ports assigned to the pipe. If a new pipe is created, this is the initial set of endpoints assigned. If an existing pipe is modified, this set replaces the previous set. The list must be null if a provider does not allow the client to manage port assignment. Qualifiers:IN
| | CIM_ProtocolEndpoint REF TargetEndpoint [ ] | | | The setting properties to be maintained for the peer-to-peer connection. Qualifiers:EmbeddedInstance ( "CIM_SettingData" )
IN
| | string Goal | | | Reference to the created or modified NetworkPipe. Qualifiers:OUT
IN
| | CIM_NetworkPipe REF ReplicationPipe | ) This method establishes a peer-to-peer connection identified by a NetworkPipe element and two ProtocolEndpoint elements created by the method provider. The NetworkPipe is associated to a special peer-to-peer Network element. The provider will verify that two systems are capable of a peer relationship. If endpoints are assigned to the pipe, the same number of source and target endpoints must be supplied by the client to form a set of endpoint pairs. If ReplicationPipe is not supplied as an input parameter, a new pipe is created. If a pipe is supplied, a new set of endpoints is assigned to the existing pipe. If Success (0) is returned, the function completed successfully. A return value of Not Supported (1) indicates the method is not supported. A return value of Busy (0x1000) indicates the method is not supported. All other values indicate some type of error condition. | ValueMap { "0" , "1" , "2" , "3" , "4" , "5" , "6" , ".." , "4096" , "4097..32767" , "32768..65535" } Values { "Job Completed with No Error" , "Not Supported" , "Unknown" , "Timeout" , "Failed" , "Invalid Parameter" , "In Use" , "DMTF Reserved" , "Method Parameters Checked - Job Started" , "Method Reserved" , "Vendor Specific" } uint32ReturnToStoragePool( | | Reference to the job (may be null if job completed). Qualifiers:OUT
IN ( false )
| | CIM_ConcreteJob REF Job | | | Reference to the element to return to the StoragePool. Qualifiers:IN
| | CIM_LogicalElement REF TheElement | ) Start a job to delete an element previously created from a StoragePool. The freed space is returned to the source StoragePool. If 0 is returned, the function completed successfully and no ConcreteJob was required. If 4096/0x1000 is returned, a ConcreteJob will be started to delete the element. A reference to the Job is returned in the Job parameter. | ValueMap { "0" , "1" , "2" , "3" , "4" , "5" , "6" , ".." , "4096" , "4097..32767" , "32768..65535" } Values { "Completed with No Error" , "Not Supported" , "Unknown" , "Timeout" , "Failed" , "Invalid Parameter" , "Not Authorized" , "DMTF Reserved" , "Method Parameters Checked - Job Started" , "Method Reserved" , "Vendor Specific" } Experimental uint32RequestUsageChange( | | The action to perform. Qualifiers:ValueMap { "2" , "3" , ".." , "32768..65535" }
Values { "Set" , "Modify 'Other' description only" , "DMTF Reserved" , "Vendor Specific" }
IN
| | uint16 Operation | | | Applicable requested usage/restriction -- see the appropriate Usage ValueMap. Qualifiers:ModelCorrespondence { "CIM_StoragePool.Usage" , "CIM_StorageExtent.Usage" }
IN
| | uint16 UsageValue | | | New description text. Applicable when the usage value includes 'Other'. Qualifiers:ModelCorrespondence { "CIM_StorageConfigurationService.RequestUsageChange.UsageValue" }
IN
| | string OtherUsageDescription | | | Reference to the job (may be null if job completed). Qualifiers:OUT
| | CIM_ConcreteJob REF Job | | | The storage element to modify. Qualifiers:IN
| | CIM_LogicalElement REF TheElement | ) Allows a client to request the Usage to be set if the client has access to the element supplied and the request is valid. | ValueMap { "0" , "1" , "2" , "3" , "4" , "5" , "6" , ".." , "4096" , "4097..32767" , "32768..65535" } Values { "Job Completed with No Error" , "Not Supported" , "Unknown" , "Timeout" , "Failed" , "Invalid Parameter" , "In Use" , "DMTF Reserved" , "Method Parameters Checked - Job Started" , "Method Reserved" , "Vendor Specific" } uint32DeleteStoragePool( | | Reference to the job (may be null if job completed). Qualifiers:OUT
IN ( false )
| | CIM_ConcreteJob REF Job | | | Reference to the pool to delete. Qualifiers:IN
| | CIM_StoragePool REF Pool | ) Start a job to delete a StoragePool. The freed space is returned source StoragePools (indicated by AllocatedFrom StoragePool) or back to underlying storage extents. If 0 is returned, the function completed successfully, and no ConcreteJob was required. If 4096/0x1000 is returned, a ConcreteJob will be started to delete the StoragePool. A reference to the Job is returned in the Job parameter. | ValueMap { "0" , "1" , "2" , "3" , "4" , "5" , "6" , ".." , "0x1000" , "0x1001..0x7FFF" , "0x8000..0xFFFF" } Values { "Job Completed with No Error" , "Not Supported" , "Unspecified Error" , "Timeout" , "Failed" , "Invalid Parameter" , "In Use" , "DMTF Reserved" , "Method Parameters Checked - Job Started" , "Method Reserved" , "Vendor Specific" } Experimental uint32CreateReplicationBuffer( | | Reference to the job (may be null if the task completed). Qualifiers:OUT
IN ( false )
| | CIM_ConcreteJob REF Job | | | The hosting system or replication pipe that will be antecedent to the created buffer. Qualifiers:Required
IN
| | CIM_ManagedElement REF Host | | | Reference to a component extent for the buffer element. Qualifiers:IN
| | CIM_StorageExtent REF TargetElement | | | Reference to a container pool for the buffer element. Qualifiers:IN
| | CIM_StoragePool REF TargetPool | | | Reference to the created replica buffer element. Qualifiers:OUT
| | CIM_Memory REF ReplicaBuffer | ) Create (or start a job to create) a replication buffer that buffers asynchronous write operations for remote mirror pairs. The buffer is an instance of CIM_Memory with an AssociatedMemory association to a hosting system or to a replication network pipe. The buffer element may be created based on a StorageExtent, in a pool or in a manner opaque to a client. If 0 is returned, the function completed successfully and no ConcreteJob instance is created. If 0x1000 is returned, a ConcreteJob is started, a reference to which is returned in the Job output parameter. A return value of 1 indicates the method is not supported. All other values indicate some type of error condition. If Job Completed with No Error (0) is returned, the function completed successfully and a ConcreteJob instance is not created. If Method Parameters Checked - Job Started (0x1000) is returned, a ConcreteJob is started, a reference to which is returned in the Job output parameter. A return value of Not Supported (1) indicates the method is not supported. All other values indicate some type of error condition. | ValueMap { "0" , "1" , "2" , "3" , "4" , "5" , "6" , ".." , "32768..65535" } Values { "Completed with No Error" , "Not Supported" , "Unknown" , "Timeout" , "Failed" , "Invalid Parameter" , "DMTF Reserved" , "Vendor Specific" } Experimental uint32GetElementsBasedOnUsage( | | Enumeration indicating the type of elements to get. Qualifiers:ValueMap { "0" , "2" , "3" , "4" , "5" , ".." , "32768..65535" }
Values { "Unknown" , "StorageVolume" , "StorageExtent" , "StoragePool" , "Logical Disk" , "DMTF Reserved" , "Vendor Specific" }
IN
| | uint16 ElementType | | | The specific Usage to be retrieved. Qualifiers:ModelCorrespondence { "CIM_StoragePool.Usage" , "CIM_StorageExtent.Usage" }
IN
| | uint16 Usage | | | Specifies whether to retrieve all elements, available elements only, or the elements that are in use. Qualifiers:ValueMap { "0" , "2" , "3" , "4" , ".." , "32768..65535" }
Values { "Unknown" , "All" , "Available Only" , "In Use Only" , "DMTF Reserved" , "Vendor Specific" }
IN
| | uint16 Criteria | | | Limit the search for the elements that satisfy the criteria to this StoragePool only. If null, all appropriate StoragePools will be considered. Qualifiers:IN
| | CIM_StoragePool REF ThePool | | | Array of references to storage element instances retrieved. Qualifiers:OUT
| | CIM_ManagedSystemElement REF TheElements [ ] | ) Allows retrieving elements that meet the specified Usage. The criteria can be 'available only', 'in use only', or both. | ValueMap { "0" , "1" , "2" , "3" , "4" , "5" , "6" , ".." , "0x1000" , "0x1001..0x7FFF" , "0x8000..0xFFFF" } Values { "Job Completed with No Error" , "Not Supported" , "Unspecified Error" , "Timeout" , "Failed" , "Invalid Parameter" , "In Use" , "DMTF Reserved" , "Method Parameters Checked - Job Started" , "Method Reserved" , "Vendor Specific" } uint32AttachReplica( | | Reference to the job (may be null if the task completed). Qualifiers:OUT
IN ( false )
| | CIM_ConcreteJob REF Job | | | The source storage object which may be a StorageVolume or other storage object. Qualifiers:Required
IN
| | CIM_ManagedElement REF SourceElement | | | Reference to the target storage element (i.e., the replica). Qualifiers:IN
| | CIM_ManagedElement REF TargetElement | | | CopyType describes the type of Synchronized relationship that will be created. Values are: Async: Create and maintain an asynchronous copy of the source. Sync: Create and maintain a synchronized copy of the source. UnSyncAssoc: Create an unsynchronized copy and maintain an association to the source. UnSyncUnAssoc: Create unassociated copy of the source element. Qualifiers:ValueMap { "2" , "3" , "4" , "5" , ".." , "0x8000..0xFFFF" }
Values { "Async" , "Sync" , "UnSyncAssoc" , "UnSyncUnAssoc" , "DMTF Reserved" , "Vendor Specific" }
IN
| | uint16 CopyType | ) Create (or start a job to create) a StorageSynchronized relationship between two existing storage objects. Note that using the input parameter, CopyType, this function can be used to to create an ongoing association between the source and replica. If 0 is returned, the function completed successfully and no ConcreteJob instance is created. If 0x1000 is returned, a ConcreteJob is started, a reference to which is returned in the Job output parameter. A return value of 1 indicates the method is not supported. All other values indicate some type of error condition. | ValueMap { "0" , "1" , "2" , "3" , "4" , "5" , "6..4095" , "4096" , "4097" , "4098" , "4099" , "4100" , ".." , "32768..65535" } Values { "Success" , "Not Supported" , "Unknown" , "Timeout" , "Failed" , "Invalid Parameter" , "DMTF Reserved" , "Invalid connection type" , "Invalid Initiator" , "No matching target found" , "No matching LUs found" , "Prohibited by name binding configuration" , "DMTF Reserved" , "Vendor Specific" } Experimental uint32ScsiScan( | | Reference to the job (may be null if job completed). Qualifiers:OUT
IN
| | CIM_ConcreteJob REF Job | | | The type of connection, constrains the scan to initiator ports of this type. Only used if the Initiators parameter is null. Qualifiers:ValueMap { "1" , "2" , "3" , "4" , "5" , "6" , "7" , "8" , "9" }
Values { "Other" , "Fibre Channel" , "Parallel SCSI" , "SSA" , "IEEE 1394" , "RDMA" , "iSCSI" , "SAS" , "ADT" }
ModelCorrespondence { "CIM_SCSIProtocolEndpoint.ConnectionType" }
| | uint16 ConnectionType | | | The connection type, if the ConnectionType parameter is 'Other'. Qualifiers: | | string OtherConnectionType | | | A list of references to initiators. Scanning will be limited to SCSI targets attached to these initiators. If this parameter is null and connection is specified, all initiators of that connection type are scanned. If this parameter and ConnectionType are null, all targets on all system initiators are probed. Qualifiers: | | CIM_SCSIProtocolEndpoint REF Initiators [ ] | | | A list of names or numbers for targets. These should be formatted to match the appropriate connection type, For example, PortWWNs would be specified for Fibre Channel targets. Qualifiers: | | string Targets [ ] | | | A list of SCSI logical unit numbers representing logical units hosted on the targets specified in the Targets argument. Qualifiers: | | string LogicalUnits [ ] | ) This method requests that the system rescan SCSI devices for changes in their configuration. If called on a general-purpose host, the changes are reflected in the list of devices available to applications (for example, the UNIX 'device tree'. This method may also be used on a storage appliance to force rescanning of attached SCSI devices. This operation can be disruptive; optional parameters allow the caller to limit the scan to a single or set of SCSI device elements. All parameters are optional; if parameters other Job are passed in as null, a full scan is invoked. | ValueMap { "0" , "1" , "2" , "3" , "4" , "5" , "6" , ".." , "4096" , "4097" , "4098..32767" , "32768..65535" } Values { "Job Completed with No Error" , "Not Supported" , "Unknown" , "Timeout" , "Failed" , "Invalid Parameter" , "In Use" , "DMTF Reserved" , "Method Parameters Checked - Job Started" , "Size Not Supported" , "Method Reserved" , "Vendor Specific" } uint32CreateOrModifyStoragePool( | | A end user relevant name for the pool being created. If NULL, then a system supplied default name can be used. The value will be stored in the 'ElementName' property for the created pool. If not NULL, this parameter will supply a new name when modifying an existing pool. Qualifiers:IN
| | string ElementName | | | Reference to the job (may be null if job completed). Qualifiers:OUT
IN ( false )
| | CIM_ConcreteJob REF Job | | | Reference to an instance of StorageSetting that defines the desired capabilities of the StoragePool. If set to a null value, the default configuration from the source pool will be used. If not NULL, this parameter will supply a new Goal setting when modifying an existing pool. Qualifiers:IN
| | CIM_StorageSetting REF Goal | | | As an input parameter this specifies the desired pool size in bytes. As an output parameter this specifies the size achieved. Qualifiers:Punit ( "byte" )
Units ( "Bytes" )
OUT
IN
| | uint64 Size | | | Array of strings containing representations of references to CIM_StoragePool instances, that are used to create the Pool or modify the source pools. Qualifiers:IN
| | string InPools [ ] | | | Array of strings containing representations of references to CIM_StorageExtent instances, that are used to create the Pool or modify the source extents. Qualifiers:IN
| | string InExtents [ ] | | | As an input parameter: if null, creates a new StoragePool. If not null, modifies the referenced Pool. When returned, it is a reference to the resulting StoragePool. Qualifiers:OUT
IN
| | CIM_StoragePool REF Pool | ) Starts a job to create (or modify) a StoragePool. The StoragePool will be (or must be) scoped to the same System as this Service. One of the parameters for this method is Size. As an input parameter, Size specifies the desired size of the pool. As an output parameter, it specifies the size achieved. Space is taken from either or both of the specified input StoragePools and StorageExtents (InPools and InExtents). The capability requirements that the Pool must support are defined using the Goal parameter. If the requested pool size cannot be created, no action will be taken, the Return Value will be 4097/0x1001, and the output value of Size will be set to the nearest possible size. If 0 is returned, then the task completed successfully and the use of ConcreteJob was not required. If the task will take some time to complete, a ConcreteJob will be created and its reference returned in the output parameter Job. | ValueMap { "0" , "1" , "2" , "3" , "4" , "5" , "6" , ".." , "4096" , "4097" , "4098..32767" , "32768..65535" } Values { "Job Completed with No Error" , "Not Supported" , "Unknown" , "Timeout" , "Failed" , "Invalid Parameter" , "In Use" , "DMTF Reserved" , "Method Parameters Checked - Job Started" , "Size Not Supported" , "Method Reserved" , "Vendor Specific" } uint32CreateOrModifyElementFromStoragePool( | | A end user relevant name for the element being created. If NULL, then a system supplied default name can be used. The value will be stored in the 'ElementName' property for the created element. If not NULL, this parameter will supply a new name when modifying an existing element. Qualifiers:IN
| | string ElementName | | | Enumeration indicating the type of element being created or modified. If the input parameter TheElement is specified when the operation is a 'modify', this type value must match the type of that instance. Qualifiers:ValueMap { "0" , "1" , "2" , "3" , "4" , ".." , "32768..65535" }
Values { "Unknown" , "Reserved" , "StorageVolume" , "StorageExtent" , "LogicalDisk" , "DMTF Reserved" , "Vendor Specific" }
IN
| | uint16 ElementType | | | Reference to the job (may be null if job completed). Qualifiers:OUT
IN ( false )
| | CIM_ConcreteJob REF Job | | | The requirements for the element to maintain. If set to a null value, the default configuration from the source pool will be used. This parameter should be a reference to a Setting or Profile appropriate to the element being created. If not NULL, this parameter will supply a new Goal when modifying an existing element. Qualifiers:IN
| | CIM_ManagedElement REF Goal | | | As an input parameter Size specifies the desired size. If not NULL, this parameter will supply a new size when modifying an existing element. As an output parameter Size specifies the size achieved. Qualifiers:Punit ( "byte" )
Units ( "Bytes" )
OUT
IN
| | uint64 Size | | | The Pool from which to create the element. This parameter must be set to null if the input parameter TheElement is specified (in the case of a 'modify' operation). Qualifiers:IN
| | CIM_StoragePool REF InPool | | | As an input parameter: if null, creates a new element. If not null, then the method modifies the specified element. As an output parameter, it is a reference to the resulting element. Qualifiers:OUT
IN
| | CIM_LogicalElement REF TheElement | ) Start a job to create (or modify) a specified element (for example a StorageVolume or StorageExtent) from a StoragePool. One of the parameters for this method is Size. As an input parameter, Size specifies the desired size of the element. As an output parameter, it specifies the size achieved. Space is taken from the input StoragePool. The desired settings for the element are specified by the Goal parameter. If the requested size cannot be created, no action will be taken, and the Return Value will be 4097/0x1001. Also, the output value of Size is set to the nearest possible size. If 0 is returned, the function completed successfully and no ConcreteJob instance was required. If 4096/0x1000 is returned, a ConcreteJob will be started to create the element. The Job's reference will be returned in the output parameter Job. | 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. |
| | | | |
|