Class CIM_SharedDeviceManagementService
extends CIM_Service

A class derived from Service that describes the ability to control access to shared devices.

Table of Contents
Hierarchy
Direct Known Subclasses
Class Qualifiers
Class Properties
Class Methods


Class Hierarchy

CIM_ManagedElement
   |
   +--CIM_ManagedSystemElement
   |
   +--CIM_LogicalElement
   |
   +--CIM_EnabledLogicalElement
   |
   +--CIM_Service
   |
   +--CIM_SharedDeviceManagementService

Direct Known Subclasses

Class Qualifiers

NameData TypeValue
DescriptionstringA class derived from Service that describes the ability to control access to shared devices.
UMLPackagePathstringCIM::Device::SCSI
Versionstring2.22.0

Class Properties

Inherited Properties

NameData TypeClass Origin
CaptionstringCIM_ManagedElement
CommunicationStatusuint16CIM_ManagedSystemElement
CreationClassNamestringCIM_Service
DescriptionstringCIM_ManagedElement
DetailedStatusuint16CIM_ManagedSystemElement
ElementNamestringCIM_ManagedElement
EnabledDefaultuint16CIM_EnabledLogicalElement
EnabledStateuint16CIM_EnabledLogicalElement
HealthStateuint16CIM_ManagedSystemElement
InstallDatedatetimeCIM_ManagedSystemElement
InstanceIDstringCIM_ManagedElement
NamestringCIM_Service
OperatingStatusuint16CIM_ManagedSystemElement
OtherEnabledStatestringCIM_EnabledLogicalElement
PrimaryOwnerContactstringCIM_Service
PrimaryOwnerNamestringCIM_Service
PrimaryStatusuint16CIM_ManagedSystemElement
RequestedStateuint16CIM_EnabledLogicalElement
StartedbooleanCIM_Service
StartModestringCIM_Service
StatusstringCIM_ManagedSystemElement
SystemCreationClassNamestringCIM_Service
SystemNamestringCIM_Service
TimeOfLastStateChangedatetimeCIM_EnabledLogicalElement
TransitioningToStateuint16CIM_EnabledLogicalElement
AvailableRequestedStatesuint16[]CIM_EnabledLogicalElement
OperationalStatusuint16[]CIM_ManagedSystemElement
StatusDescriptionsstring[]CIM_ManagedSystemElement

Class Methods

Local Class Methods

ShareDevice (uint32)

Method Qualifiers (ShareDevice)

NameData TypeValue
DescriptionstringShareDevice defines the ability to change the access of a System to a shared LogicalDevice. If this method completes successfully the value of CurrentAccess for the instance of CIM_SharingDependency which references the LogicalDevice will have the value of the RequestedAccess parameter. 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.
ValueMapstring0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11..4095, 4096, 4097..32767, 32768..65535
ValuesstringCompleted with No Error, Not Supported, Unknown/Unspecified Error, Can NOT complete within Timeout Period, Failed, Invalid Parameter, Unsupported Access, Invalid Device, Invalid System, Use of Timeout Parameter Not Supported, Busy, DMTF Reserved, Method Parameters Checked - Job Started, DMTF Reserved, Vendor Reserved

Method Parameters (ShareDevice)

NameTypeQualifiers
NameData TypeValue
Forceboolean
DescriptionstringThis parameter is used by a client to indicate that they wish the requested access to be granted even if it requires forcibly revoking access currently granted to another system. When the value of this parameter is true, and a valid TimeoutPeriod is specified, the implementation shall wait for the duration specified by TimeoutPeriod before forcibly modifying access. If the access requested can be granted without disruption prior to the TimeoutPeriod expiring, the implementation should complete the request and not wait for the expiration of the interval specified by TimeoutPeriod.
INbooleantrue
RequestedAccessuint16
DescriptionstringThe desired access of the System to the shared Logical Device.
INbooleantrue
ModelCorrespondencestringCIM_SharingDependency.CurrentAccess, CIM_DeviceSharingCapabilities.SupportedAccessModes
ValueMapstring2, 3, 4, 5, .., 32768..65535
ValuesstringNo Access, Exclusive Access, Shared Read, Shared Full, DMTF Reserved, Vendor Reserved
TimeoutPerioddatetime
DescriptionstringA timeout period that specifies the maximum amount of time that the client is willing to wait for access to the shared device to be granted before the request should be abandoned. This value does not directly correlate to a timeout for the method invocation. That is, its possible for a job to be started to process the request and the method to return within the timeout period only to have the operation aborted later when the timeout period expires. The TimeoutPeriod shall be specified in interval format. A value of 0 indicates that if the requested access can not be granted immediately the client does not wish to wait and the request should fail. A null parameter indicates that the client has no time requirements for the request to be granted and wishes to wait indefinitely for access to be granted. If this property does not contain 0 or null and the implementation doesn't support this parameter, a return code of 'Use Of Timeout Parameter Not Supported' shall be returned.
INbooleantrue
Device REF CIM_LogicalDevice
DescriptionstringThe LogicalDevice to change access to.
INbooleantrue
Job REF CIM_ConcreteJob
DescriptionstringReference to the job spawned if the operation continues after the method returns. (may be null if task completed).
INbooleanfalse
OUTbooleantrue
System REF CIM_System
DescriptionstringThe System whose access to the LogicalDevice the change is requested for.
INbooleantrue

Inherited Class Methods

NameReturn TypeClass Origin
RequestStateChangeuint32CIM_EnabledLogicalElement
StartServiceuint32CIM_Service
StopServiceuint32CIM_Service