# 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

Name | Data Type | Value
--- | --- | ---
Description | string | USBRedirectionService describes the service that manages the USB Redirection of a system.
UMLPackagePath | string | CIM::Network::USBRedirection
Version | string | 2.22.0

## Class Properties

### Local Class Properties

Name | Data Type | Default Value | Qualifiers
--- | --- | --- | ---
Name | Data Type | Value
RedirectionServiceType | uint16[] | 4
Description | string | RedirectionServiceType's enumeration is limited to the 'USB' and reserved RedirectionServiceType values for this subclass of CIM_RedirectionService.
ModelCorrespondence | string | CIM_RedirectionService.OtherRedirectionServiceType
Override | string | RedirectionServiceType
ValueMap | string | 4, .., 32768..65535
Values | string | USB, DMTF Reserved, Vendor Specified

### Inherited Properties

Name | Data Type | Class Origin
--- | --- | ---
Caption | string | CIM_ManagedElement
CommunicationStatus | uint16 | CIM_ManagedSystemElement
CreationClassName | string | CIM_Service
Description | string | CIM_ManagedElement
DetailedStatus | uint16 | CIM_ManagedSystemElement
ElementName | string | CIM_ManagedElement
EnabledDefault | uint16 | CIM_EnabledLogicalElement
EnabledState | uint16 | CIM_EnabledLogicalElement
HealthState | uint16 | CIM_ManagedSystemElement
InstallDate | datetime | CIM_ManagedSystemElement
InstanceID | string | CIM_ManagedElement
MaxCurrentEnabledSAPs | uint16 | CIM_RedirectionService
Name | string | CIM_Service
OperatingStatus | uint16 | CIM_ManagedSystemElement
OtherEnabledState | string | CIM_EnabledLogicalElement
OtherRedirectionServiceType | string | CIM_RedirectionService
PrimaryOwnerContact | string | CIM_Service
PrimaryOwnerName | string | CIM_Service
PrimaryStatus | uint16 | CIM_ManagedSystemElement
RequestedState | uint16 | CIM_EnabledLogicalElement
SharingMode | uint16 | CIM_RedirectionService
Started | boolean | CIM_Service
StartMode | string | CIM_Service
Status | string | CIM_ManagedSystemElement
SystemCreationClassName | string | CIM_Service
SystemName | string | CIM_Service
TimeOfLastStateChange | datetime | CIM_EnabledLogicalElement
TransitioningToState | uint16 | CIM_EnabledLogicalElement
AvailableRequestedStates | uint16[] | CIM_EnabledLogicalElement
OperationalStatus | uint16[] | CIM_ManagedSystemElement
StatusDescriptions | string[] | CIM_ManagedSystemElement

## Class Methods

### Local Class Methods

#### CreateRedirectionSAP (uint32)

#### Method Qualifiers (CreateRedirectionSAP)

Name | Data Type | Value
--- | --- | ---

Description

string

This 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.

ValueMap | string | 0, 1, 2, 3, 4, 5, 6, 7..32767, 32768..65535
Values | string | Completed with No Error, Not Supported, Unknown/Unspecified Error, Busy, Invalid Reference, Invalid Parameter, Access Denied, DMTF Reserved, Vendor Specified

#### Method Parameters (CreateRedirectionSAP)

Name | Type | Qualifiers
--- | --- | ---
Name | Data Type | Value
CreateDevices | boolean
Description | string | CreateDevices 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.
IN | boolean | true
NewRemoteServiceAccessPoint | string
Description | string | When 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.
EmbeddedInstance | string | CIM_RemoteServiceAccessPoint
IN | boolean | true
NewUSBRedirectionSAP | string
Description | string | A string-valued embedded instance of CIM_USBRedirectionSAP describing the new SAP to be created.
EmbeddedInstance | string | CIM_USBRedirectionSAP
IN | boolean | true
NewSAPRequestedStatesSupported | uint16[]
Description | string | an 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.
IN | boolean | true
ModelCorrespondence | string | CIM_USBRedirectionCapabilities.RequestedStatesSupportedForCreatedSAP
NewUSBDevices | string[]
ArrayType | string | Indexed

Description

string

The 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.

EmbeddedInstance | string | CIM_USBDevice
IN | boolean | true
ModelCorrespondence | string | CIM_USBRedirectionService.CreateRedirectionSAP.RedirectedLogicalDevices
RedirectedLogicalDevices | CIM_LogicalDevice[]
ArrayType | string | Indexed
Description | string | RedirectedLogicalDevices 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.
IN | boolean | true
ModelCorrespondence | string | CIM_USBRedirectionService.CreateRedirectionSAP.NewUSBDevices
USBDevices | CIM_USBDevice[]
Description | string | Array of existing devices to redirect via the redirection session. These will be associated with the new CIM_USBRedirectionSAP by a CIM_SAPAvailableForElement association.
IN | boolean | true
Job | REF CIM_ConcreteJob
Description | string | Reference to the job spawned if the operation continues after the method returns. (May be null if the task is completed).
IN | boolean | false
OUT | boolean | true
SAP | REF CIM_USBRedirectionSAP
Description | string | A reference to the instances of CIM_USBRedirectionSAP created by the method. This parameter is not returned when the method is run as a Job
IN | boolean | false
OUT | boolean | true

#### DeleteRedirectionSAP (uint32)

#### Method Qualifiers (DeleteRedirectionSAP)

Name | Data Type | Value
--- | --- | ---
Description | string | This 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.
ValueMap | string | 0, 1, 2, 3, 4, 5, 6, 7..32767, 32768..65535
Values | string | Completed with No Error, Not Supported, Unknown/Unspecified Error, Busy, Invalid Reference, Invalid Parameter, Access Denied, DMTF Reserved, Vendor Specified

#### Method Parameters (DeleteRedirectionSAP)

Name | Type | Qualifiers
--- | --- | ---
Name | Data Type | Value
DeleteUSBDevices | boolean
Description | string | Indicates whether the USBDevices associated to the SAP shall also be deleted by this method.
IN | boolean | true
Job | REF CIM_ConcreteJob
Description | string | Reference to the job spawned if the operation continues after the method returns. (May be null if the task is completed).
IN | boolean | false
OUT | boolean | true
SAP | REF CIM_USBRedirectionSAP
Description | string | A reference to the instance of CIM_USBRedirectionSAP the method shall delete.
IN | boolean | true

#### CreateUSBDevice (uint32)

#### Method Qualifiers (CreateUSBDevice)

Name | Data Type | Value
--- | --- | ---

Description

string

This 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.

ValueMap | string | 0, 1, 2, 3, 4, 5, 6, 7..32767, 32768..65535
Values | string | Completed with No Error, Not Supported, Unknown/Unspecified Error, Busy, Invalid Reference, Invalid Parameter, Access Denied, DMTF Reserved, Vendor Specified

#### Method Parameters (CreateUSBDevice)

Name | Type | Qualifiers
--- | --- | ---
Name | Data Type | Value
NewUSBDevice | string
Description | string | The 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.
EmbeddedInstance | string | CIM_USBDevice
IN | boolean | true
ModelCorrespondence | string | CIM_USBRedirectionService.CreateUSBDevice.RedirectedLogicalDevice
Job | REF CIM_ConcreteJob
Description | string | Reference to the job spawned if the operation continues after the method returns. (May be null if the task is completed).
IN | boolean | false
OUT | boolean | true
RedirectedLogicalDevice | REF CIM_LogicalDevice
Description | string | If 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.
IN | boolean | true
USBDevice | REF CIM_USBDevice
Description | string | A reference to the instance of CIM_USBDevice created by the method. This parameter is not returned when the method is run as a Job
IN | boolean | false
OUT | boolean | true

### Inherited Class Methods

Name | Return Type | Class Origin
--- | --- | ---
RequestStateChange | uint32 | CIM_EnabledLogicalElement
StartService | uint32 | CIM_Service
StopService | uint32 | CIM_Service