Class CIM_PrivilegeManagementService
extends CIM_AuthorizationService

The PrivilegeManagementService is responsible for creating, deleting, and associating AuthorizedPrivilege instances. References to 'subject' and 'target' define the entities that are associated with an AuthorizedPrivilege instance via the relationships, AuthorizedSubject and AuthorizedTarget, respectively. When created, an AuthorizedPrivilege instance is related to this (PrivilegeManagement)Service via the association, ConcreteDependency.

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_SecurityService
   |
   +--CIM_AuthorizationService
   |
   +--CIM_PrivilegeManagementService

Direct Known Subclasses

CIM_RoleBasedAuthorizationService

Class Qualifiers

NameData TypeValue
DescriptionstringThe PrivilegeManagementService is responsible for creating, deleting, and associating AuthorizedPrivilege instances. References to 'subject' and 'target' define the entities that are associated with an AuthorizedPrivilege instance via the relationships, AuthorizedSubject and AuthorizedTarget, respectively. When created, an AuthorizedPrivilege instance is related to this (PrivilegeManagement)Service via the association, ConcreteDependency.
UMLPackagePathstringCIM::User::PrivilegeManagementService
Versionstring2.37.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

AssignAccess (uint32)

Method Qualifiers (AssignAccess)

NameData TypeValue
DescriptionstringWhen this method is called, a provider updates the specified Subject's rights to the Target according to the parameters of this call. The rights are modeled via an AuthorizedPrivilege instance. If an AuthorizedPrivilege instance is created as a result of this call, it MUST be linked to the Subject and Target via the AuthorizedSubject and AuthorizedTarget associations, respectively. When created, the AuthorizedPrivilege instance is associated to this PrivilegeManagementService via ConcreteDependency. If the execution of this call results in no rights between the Subject and Target, then they MUST NOT be linked to a particular AuthorizedPrivilege instance via AuthorizedSubject and AuthorizedTarget respectively. Note that regardless of whether specified via parameter, or template, the Activities, ActivityQualifiers and QualifierFormats, are mutually indexed. Also note that Subject and Target references MUST be supplied. The successful completion of the method SHALL create any necessary AuthorizedSubject, AuthorizedTarget, AuthorizedPrivilege, HostedDependency, and ConcreteDependency instances.
ValueMapstring0, 1, 2, 3, 4, 5, 6..15999, 16000, 16001, 16002, 16003, 16004, 16005, .., 32000..65535
ValuesstringSuccess, Not Supported, Unspecified Error, Timeout, Failed, Invalid Parameter, DMTF Reserved, Unsupported Subject, Unsupported Privilege, Unsupported Target, Authorization Error, NULL not supported, UnSupported Sharing Privileges, Method Reserved, Vendor Specific

Method Parameters (AssignAccess)

NameTypeQualifiers
NameData TypeValue
PrivilegeGrantedboolean
DescriptionstringMUST be NULL unless Privilege is NULL on input. The PrivilegeGranted flag indicates whether the rights defined by the parameters in this call should be granted or denied to the named Subject/Target pair.
INbooleantrue
ModelCorrespondencestringCIM_AuthorizedPrivilege.PrivilegeGranted, CIM_PrivilegeManagementService.AssignAccess(Privilege)
Activitiesuint16[]
ArrayTypestringIndexed
DescriptionstringMUST be NULL unless the Privilege is NULL on input. This parameter specifies the activities to be granted or denied.
INbooleantrue
ModelCorrespondencestringCIM_AuthorizedPrivilege.Activities, CIM_PrivilegeManagementService.AssignAccess(Privilege)
ValueMapstring1, 2, 3, 4, 5, 6, 7, .., 16000..65535
ValuesstringOther, Create, Delete, Detect, Read, Write, Execute, DMTF Reserved, Vendor Reserved
ActivityQualifiersstring[]
ArrayTypestringIndexed
DescriptionstringMUST be NULL unless Privilege is NULL on input. This parameter defines the activity qualifiers for the Activities to be granted or denied.
INbooleantrue
ModelCorrespondencestringCIM_AuthorizedPrivilege.ActivityQualifers, CIM_PrivilegeManagementService.AssignAccess(Privilege)
QualifierFormatsuint16[]
ArrayTypestringIndexed
DescriptionstringMUST be NULL unless Privilege is NULL on input. This parameter defines the qualifier formats for the corresponding ActivityQualifiers.
INbooleantrue
ModelCorrespondencestringCIM_AuthorizedPrivilege.QualifierFormats, CIM_PrivilegeManagementService.AssignAccess(Privilege)
ValueMapstring2, 3, 4, 5, 6, 7, 8, 9, 10, 11, .., 16000..65535
ValuesstringClass Name, <Class.>Property, <Class.>Method, Object Reference, Namespace, URL, Directory/File Name, Command Line Instruction, SCSI Command, Packets, DMTF Reserved, Vendor Reserved
Privilege REF CIM_AuthorizedPrivilege
DescriptionstringOn input, this reference MUST be either NULL or refer to an instance of AuthorizedPrivilege that is used as a template. The rights granted by corresponding entries in the Activities, ActivityQualifiers and QualifierFormats array properties are applied incrementally and do not affect unnamed rights. If the property, PrivilegeGranted, is false, then the named rights are removed. If PrivilegeGranted is True, then the named rights are added. (Note that the RemoveAccess method SHOULD be used to completely remove all privileges between a subject and a target. On output, this property references an AuthorizedPrivilege instance that represents the resulting rights between the named Subject and the named Target. AuthorizedPrivilege instances used as a templates in this property SHOULD have a HostedDependency association to the PriviligeManagementService and SHOULD NOT have any AuthorizedTarget or AuthorizedSubject associations to it.
INbooleantrue
OUTbooleantrue
Subject REF CIM_ManagedElement
DescriptionstringThe Subject parameter is a reference to a ManagedElement instance. This parameter MUST be supplied.
INbooleantrue
Requiredbooleantrue
Target REF CIM_ManagedElement
DescriptionstringThe Target parameter is a reference to an instance of ManagedElement. This parameter MUST be supplied.
INbooleantrue
Requiredbooleantrue

RemoveAccess (uint32)

Method Qualifiers (RemoveAccess)

NameData TypeValue
DescriptionstringThis method revokes a specific AuthorizedPrivilege or all privileges for a particular target, subject, or subject/target pair. If an AuthorizedPrivilege instance is left with no AuthorizedTarget associations, it SHOULD be deleted. The successful completion of the method SHALL remove the directly or indirectly requested AuthorizedSubject, AuthorizedTarget and AuthorizedPrivilege instances.
ValueMapstring0, 1, 2, 3, 4, 5, 6..15999, 16000, 16001, 16002, 16003, 16004..32767, 32768..65535
ValuesstringSuccess, Not Supported, Unspecified Error, Timeout, Failed, Invalid Parameter, DMTF Reserved, Unsupported Privilege, Unsupported Target, Authorization Error, Null parameter not supported, Method Reserved, Vendor Specific

Method Parameters (RemoveAccess)

NameTypeQualifiers
NameData TypeValue
Privilege REF CIM_AuthorizedPrivilege
DescriptionstringA reference to the AuthorizedPrivilege to be revoked.
INbooleantrue
Subject REF CIM_ManagedElement
DescriptionstringThe Subject parameter is a reference to a ManagedElement instance (associated via AuthorizedSubject) for which privileges are to be revoked.
INbooleantrue
Target REF CIM_ManagedElement
DescriptionstringThe Target parameter is a reference to a ManagedElement (associated via AuthorizedTarget) which will no longer be protected via the AuthorizedPrivilege.
INbooleantrue

ShowAccess (uint32)

Method Qualifiers (ShowAccess)

NameData TypeValue
DescriptionstringShowAccess reports the Privileges (i.e., rights) granted to a particular Subject and/or Target pair. Either a Subject, a Target or both MUST be specified. In the case where only one is specified, the method will return all rights to all Targets for the specified Subject, or all rights for all subjects which apply to the specified Target. ShowAccess returns the cumulative rights granted between the OutSubjects and OutTargets at the same array index (filtered to return the information that the requestor is authorized to view). If a specific array entry is NULL, then there exist NO rights that the requestor is authorized to view between the Subject/Target pair. Note that the Privileges returned by this method MAY NOT correspond to what is actually instantiated in the model, and MAY be optimized for ease of reporting. Hence, the data is passed 'by value', as embedded objects. Also, note that multiple Privileges MAY be defined for a given Subject/Target pair. Other mechanisms MAY also be used to retrieve this information. CIM Operations' EnumerateInstances MAY be used to return all Privileges currently instantiated within a namespace. Also, if the AuthorizedPrivilege subclass is instantiated, the CIM Operation Associators MAY be used to navigate from the Privilege to AuthorizedSubjects and AuthorizedTargets. These CIM Operations will not generally provide the functionality or optimizations available with ShowAccess.
ValueMapstring0, 1, 2, 3, 4, 5, .., 16000, 16002, 16003, 16004, 16005..31999, 32000..65535
ValuesstringSuccess, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, DMTF Reserved, Unsupported Subject, Unsupported Target, Authorization Error, NULL not supported, Method Reserved, Vendor Specific

Method Parameters (ShowAccess)

NameTypeQualifiers
NameData TypeValue
Privilegesstring[]
ArrayTypestringIndexed
DescriptionstringThe returned Privilege objects represent the cumulative rights granted between the OutSubjects and OutTargets at the same array index (filtered to return the information that the requestor is authorized to view). If a specific array entry is NULL, then there exist NO rights that the requestor is authorized to view between the Subject/Target pair.
EmbeddedObjectbooleantrue
INbooleanfalse
ModelCorrespondencestringCIM_PrivilegeManagementService.ShowAccess(OutTargets), CIM_PrivilegeManagementService.ShowAccess(OutSubjects)
OUTbooleantrue
OutSubjectsCIM_ManagedElement[]
ArrayTypestringIndexed
DescriptionstringThe array of Subject REFs corresponding to the individual Privileges and OutTargets arrays. The resulting OutSubjects, Privileges and OutTargets arrays define the cumulative rights granted between the Subject/Target at the corresponding index (filtered to return the information that the requestor is authorized to view).
INbooleanfalse
ModelCorrespondencestringCIM_PrivilegeManagementService.ShowAccess(Subject), CIM_PrivilegeManagementService.ShowAccess(Privileges), CIM_PrivilegeManagementService.ShowAccess(OutTargets)
OUTbooleantrue
OutTargetsCIM_ManagedElement[]
ArrayTypestringIndexed
DescriptionstringThe array of Target REFs corresponding to the individual Privileges and OutSubjects arrays. The resulting OutSubjects, Privileges and OutTargets arrays define the cumulative rights granted between the Subject/Target at the corresponding index (filtered to return the information that the requestor is authorized to view).
INbooleanfalse
ModelCorrespondencestringCIM_PrivilegeManagementService.ShowAccess(Target), CIM_PrivilegeManagementService.ShowAccess(Privileges), CIM_PrivilegeManagementService.ShowAccess(OutSubjects)
OUTbooleantrue
Subject REF CIM_ManagedElement
DescriptionstringThe Subject parameter references an instance of ManagedElement. The result of this operation is that the cumulative rights of the Subject to access or define authorization rights for the Target will be reported. If no Subject is specified, then a Target MUST be supplied and ALL Subjects that have rights to access or define authorizations for the Target will be reported. (It should be noted that the information reported MUST be filtered by the rights of the requestor to view that data.) If the Subject element is a Collection, then the operation will specifically report the Privileges for all elements associated to the Collection via MemberOfCollection. These elements will be reported individually in the returned OutSubjects array.
INbooleantrue
ModelCorrespondencestringCIM_PrivilegeManagementService.ShowAccess(Target)
Target REF CIM_ManagedElement
DescriptionstringThe Target parameter references an instance of ManagedElement. The result of this operation is that the cumulative rights of the Subject to access or define authorization rights for the Target will be reported. If no Target is specified, then a Subject MUST be supplied and ALL Targets for which that the Subject has rights to access or define authorization will be reported. (It should be noted that the information reported MUST be filtered by the rights of the requestor to view that data.) If the Target element is a Collection, then the operation will be applied to all elements associated to the Collection via MemberOfCollection. These elements will be reported individually in the returned OutTargets array.
INbooleantrue
ModelCorrespondencestringCIM_PrivilegeManagementService.ShowAccess(Subject)

Inherited Class Methods

NameReturn TypeClass Origin
RequestStateChangeuint32CIM_EnabledLogicalElement
StartServiceuint32CIM_Service
StopServiceuint32CIM_Service