Class CIM_USBRedirectionService
extends CIM_RedirectionService

USBRedirectionService describes the service that manages the USB Redirection of a system.

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_RedirectionService
   |
   +--CIM_USBRedirectionService

Direct Known Subclasses

Class Qualifiers

NameData TypeValue
DescriptionstringUSBRedirectionService describes the service that manages the USB Redirection of a system.
UMLPackagePathstringCIM::Network::USBRedirection
Versionstring2.22.0

Class Properties

Local Class Properties

NameData TypeDefault ValueQualifiers
NameData TypeValue
RedirectionServiceTypeuint16[]4
DescriptionstringRedirectionServiceType's enumeration is limited to the 'USB' and reserved RedirectionServiceType values for this subclass of CIM_RedirectionService.
ModelCorrespondencestringCIM_RedirectionService.OtherRedirectionServiceType
OverridestringRedirectionServiceType
ValueMapstring4, .., 32768..65535
ValuesstringUSB, DMTF Reserved, Vendor Specified

Inherited Properties

NameData TypeClass Origin
CaptionstringCIM_ManagedElement
CommunicationStatusuint16CIM_ManagedSystemElement
CreationClassNamestringCIM_Service
DescriptionstringCIM_ManagedElement
DetailedStatusuint16CIM_ManagedSystemElement
ElementNamestringCIM_ManagedElement
EnabledDefaultuint16CIM_EnabledLogicalElement
EnabledStateuint16CIM_EnabledLogicalElement
Generationuint64CIM_ManagedElement
HealthStateuint16CIM_ManagedSystemElement
InstallDatedatetimeCIM_ManagedSystemElement
InstanceIDstringCIM_ManagedElement
LoSIDstringCIM_Service
LoSOrgIDstringCIM_Service
MaxCurrentEnabledSAPsuint16CIM_RedirectionService
NamestringCIM_Service
OperatingStatusuint16CIM_ManagedSystemElement
OtherEnabledStatestringCIM_EnabledLogicalElement
OtherRedirectionServiceTypestringCIM_RedirectionService
PrimaryOwnerContactstringCIM_Service
PrimaryOwnerNamestringCIM_Service
PrimaryStatusuint16CIM_ManagedSystemElement
RequestedStateuint16CIM_EnabledLogicalElement
SharingModeuint16CIM_RedirectionService
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

CreateRedirectionSAP (uint32)

Method Qualifiers (CreateRedirectionSAP)

NameData TypeValue
DescriptionstringThis method is used to add new redirection sessions modeled by CIM_USBRedirectionSAP, to the USB Redirection Service. The USBDevice parameter may contain references to instances of CIM_USBDevice that model the USB Device to be redirected by the new USB Redirection Session. Alternatively new instances of CIM_USBDevice may be created to redirect in the new session. The NewUSBDevices parameter describes the new devices to be created. Typically the new CIM_USBDevices created represent devices that are emulated by the USB Redirection Service. Or the new USB devices may be associated to the existing logical devices specified in the RedirectedLogicalDevices parameter. When the ConnectionMode parameter specifies the new redirection session be in the 'Connect' mode, the AccessInfo parameter specifies the remote network location the redirection session should connect to when it is enabled. Upon completion the following instances will have been created, CIM_USBRedirectionSAP, CIM_ServiceAccessBySAP associating the new USBRedirectionSAP with the USBRedirectionService, CIM_HostedAccessPoint associating the new SAP with the CIM_ComputerSystem that hosts the new SAP, CIM_SAPAvailableForElement associating the CIM_ComputerSystem that has the USB device being redirection with the new SAP, EnabledLogicalElementCapabilities that describes the capabilities of the new SAP, ElementCapabilties associating the new EnabledLogicalElementCapabilities with the new SAP, SAPAvailableForElement associating the new SAP with the USBDevices specified in the parameters to this method. CIM_BindsTo a new CIM_ProtocolEndpoint to the new SAP if the ConnectionMode is 2, or if the ConnectionMode parameter is 3, a new CIM_RemoteAccessAvailableToElement associating the new SAP to a new CIM_RemoteServiceAccessPoint.
ValueMapstring0, 1, 2, 3, 4, 5, 6, 7..32767, 32768..65535
ValuesstringCompleted with No Error, Not Supported, Unknown/Unspecified Error, Busy, Invalid Reference, Invalid Parameter, Access Denied, DMTF Reserved, Vendor Specified

Method Parameters (CreateRedirectionSAP)

NameTypeQualifiers
NameData TypeValue
CreateDevicesboolean
DescriptionstringCreateDevices is a boolean that when TRUE tells the method to create new instances of CIM_USBDevice for each embedded instance in the NewUSBDevices parameter. When CreateDevices is FALSE, the NewUSBDevices and RedirectedLogicalDevices parameters are unused.
INbooleantrue
NewRemoteServiceAccessPointstring
DescriptionstringWhen the ConnectionMode parameter of the new SAP is 3, 'Connect' this parameter contains a string-valued embedded instance of CIM_RemoteServiceAccessPoint to be created and associated by a CIM_RemoteAccessAvailableToElement association to the new SAP. The represents the remote redirection access point that the new SAP should connect to.
EmbeddedInstancestringCIM_RemoteServiceAccessPoint
INbooleantrue
NewUSBRedirectionSAPstring
DescriptionstringA string-valued embedded instance of CIM_USBRedirectionSAP describing the new SAP to be created.
EmbeddedInstancestringCIM_USBRedirectionSAP
INbooleantrue
NewSAPRequestedStatesSupporteduint16[]
Descriptionstringan enumeration of the RequestedStatesSupported capability for the newly created SAP. The values specified for this parameter must be from the set of values found in the Redirection Service's CIM_USBRedirectionCapabilities.RequestedStatesSupporteForCreatedSAP array.
INbooleantrue
ModelCorrespondencestringCIM_USBRedirectionCapabilities.RequestedStatesSupportedForCreatedSAP
NewUSBDevicesstring[]
ArrayTypestringIndexed
DescriptionstringThe NewUSBDevices parameter contains the description of the new CIM_USBDevice instances to be created and redirected via the redirection session. This is an array of class CIM_USBDevice encoded as a string-valued embedded instance parameter. The string-valued embedded instances allow specifying the properties desired for the CIM_USBDevice instances that will be created by this method. The new CIM_USBDevice instances created by this method will be associated with the CIM_USBRedirectionService instance by a CIM_ServiceAffectsElement association and with the newly created CIM_USBRedirectionSAP by a CIM_SAPAvailableForElement association. Each entry in this list of new USB Devices is related to the entry in the RedirectedLogicalDevices array that is located at the same index.
EmbeddedInstancestringCIM_USBDevice
INbooleantrue
ModelCorrespondencestringCIM_USBRedirectionService.CreateRedirectionSAP.RedirectedLogicalDevices
RedirectedLogicalDevicesCIM_LogicalDevice[]
ArrayTypestringIndexed
DescriptionstringRedirectedLogicalDevices parameter is an array of references to concrete subclass of CIM_LogicalDevice that will be associated with the new instances of CIM_USBDevice created from the embedded instances of NewUSBDevices. Each entry of this array is related to the entry of NewUSBDevices array that is located at the same index.
INbooleantrue
ModelCorrespondencestringCIM_USBRedirectionService.CreateRedirectionSAP.NewUSBDevices
USBDevicesCIM_USBDevice[]
DescriptionstringArray of existing devices to redirect via the redirection session. These will be associated with the new CIM_USBRedirectionSAP by a CIM_SAPAvailableForElement association.
INbooleantrue
Job REF CIM_ConcreteJob
DescriptionstringReference to the job spawned if the operation continues after the method returns. (May be null if the task is completed).
INbooleanfalse
OUTbooleantrue
SAP REF CIM_USBRedirectionSAP
DescriptionstringA reference to the instances of CIM_USBRedirectionSAP created by the method. This parameter is not returned when the method is run as a Job
INbooleanfalse
OUTbooleantrue

DeleteRedirectionSAP (uint32)

Method Qualifiers (DeleteRedirectionSAP)

NameData TypeValue
DescriptionstringThis method is invoked to delete a USB Redirection session. This includes the associations created by CreateRedirectionSession. The method may also delete the instances of USBDevice associated by a CIM_SAPAvailableForElement association with the CIM_USBRedirectionSAP instance being deleted.
ValueMapstring0, 1, 2, 3, 4, 5, 6, 7..32767, 32768..65535
ValuesstringCompleted with No Error, Not Supported, Unknown/Unspecified Error, Busy, Invalid Reference, Invalid Parameter, Access Denied, DMTF Reserved, Vendor Specified

Method Parameters (DeleteRedirectionSAP)

NameTypeQualifiers
NameData TypeValue
DeleteUSBDevicesboolean
DescriptionstringIndicates whether the USBDevices associated to the SAP shall also be deleted by this method.
INbooleantrue
Job REF CIM_ConcreteJob
DescriptionstringReference to the job spawned if the operation continues after the method returns. (May be null if the task is completed).
INbooleanfalse
OUTbooleantrue
SAP REF CIM_USBRedirectionSAP
DescriptionstringA reference to the instance of CIM_USBRedirectionSAP the method shall delete.
INbooleantrue

CreateUSBDevice (uint32)

Method Qualifiers (CreateUSBDevice)

NameData TypeValue
DescriptionstringThis method is invoked to create an new instance of USBDevice that will be redirected by the USB Redirection Service. The RedirectedLogicalDevice parameter may contain a reference to an existing instance of a concrete subclass of CIM_LogicalDevice that will be redirected via the USB RedirectionService. Upon Successful completion of this operation the following instances will have been created. A new instance of CIM_USBDevice, a new instance of ServiceAffectsElement associating the new instance of CIM_USBDevice with the instance of USBRedirectionService. If the RedirectedLogicalDevice parameter is not empty, a new CIM_LogicalIdentity is created associating the new CIM_USBDevice with the RedirectedLogicalDevice.
ValueMapstring0, 1, 2, 3, 4, 5, 6, 7..32767, 32768..65535
ValuesstringCompleted with No Error, Not Supported, Unknown/Unspecified Error, Busy, Invalid Reference, Invalid Parameter, Access Denied, DMTF Reserved, Vendor Specified

Method Parameters (CreateUSBDevice)

NameTypeQualifiers
NameData TypeValue
NewUSBDevicestring
DescriptionstringThe NewUSBDevice parameter contains the description of the new CIM_USBDevice instance to be created and redirected via the redirection session. This parameter is a string-valued embedded instance of the CIM_USBDevice class.
EmbeddedInstancestringCIM_USBDevice
INbooleantrue
ModelCorrespondencestringCIM_USBRedirectionService.CreateUSBDevice.RedirectedLogicalDevice
Job REF CIM_ConcreteJob
DescriptionstringReference to the job spawned if the operation continues after the method returns. (May be null if the task is completed).
INbooleanfalse
OUTbooleantrue
RedirectedLogicalDevice REF CIM_LogicalDevice
DescriptionstringIf not empty, this is a reference to a concrete subclasss of CIM_LogicalDevice representing the device to be redirected by the USB Redirection Service. This might, for example, be a CIM_CDROMDrive or a CIM_DisketteDrive.
INbooleantrue
USBDevice REF CIM_USBDevice
DescriptionstringA reference to the instance of CIM_USBDevice created by the method. This parameter is not returned when the method is run as a Job
INbooleanfalse
OUTbooleantrue

Inherited Class Methods

NameReturn TypeClass Origin
ChangeAffectedElementsAssignedSequenceuint32CIM_Service
RequestStateChangeuint32CIM_EnabledLogicalElement
StartServiceuint32CIM_Service
StopServiceuint32CIM_Service