SMS / Client / get_connectors

get_connectors#

SMS.Client.get_connectors(**kwargs)#

Describes the connectors registered with the Server Migration Service.

Request Syntax

response = client.get_connectors(
    nextToken='string',
    maxResults=123
)

Parameters:

nextToken (string) – The token for the next set of results.
maxResults (integer) – The maximum number of results to return in a single call. The default value is 50. To retrieve the remaining results, make another call with the returned NextToken value.

Return type:

dict

Returns:

Response Syntax

{
    'connectorList': [
        {
            'connectorId': 'string',
            'version': 'string',
            'status': 'HEALTHY'|'UNHEALTHY',
            'capabilityList': [
                'VSPHERE'|'SCVMM'|'HYPERV-MANAGER'|'SNAPSHOT_BATCHING'|'SMS_OPTIMIZED',
            ],
            'vmManagerName': 'string',
            'vmManagerType': 'VSPHERE'|'SCVMM'|'HYPERV-MANAGER',
            'vmManagerId': 'string',
            'ipAddress': 'string',
            'macAddress': 'string',
            'associatedOn': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –
- connectorList (list) –
  
  Information about the registered connectors.
  - (dict) –
    
    Represents a connector.
    - connectorId (string) –
      
      The ID of the connector.
    - version (string) –
      
      The connector version.
    - status (string) –
      
      The status of the connector.
    - capabilityList (list) –
      
      The capabilities of the connector.
      - (string) –
    - vmManagerName (string) –
      
      The name of the VM manager.
    - vmManagerType (string) –
      
      The VM management product.
    - vmManagerId (string) –
      
      The ID of the VM manager.
    - ipAddress (string) –
      
      The IP address of the connector.
    - macAddress (string) –
      
      The MAC address of the connector.
    - associatedOn (datetime) –
      
      The time the connector was associated.
- nextToken (string) –
  
  The token required to retrieve the next set of results. This value is null when there are no more results to return.

Exceptions

SMS.Client.exceptions.UnauthorizedOperationException