SMS / Client / get_servers

get_servers#

SMS.Client.get_servers(**kwargs)#

Describes the servers in your server catalog.

Before you can describe your servers, you must import them using ImportServerCatalog.

See also: AWS API Documentation

Request Syntax

response = client.get_servers(
    nextToken='string',
    maxResults=123,
    vmServerAddressList=[
        {
            'vmManagerId': 'string',
            'vmId': 'string'
        },
    ]
)
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.

  • vmServerAddressList (list) –

    The server addresses.

    • (dict) –

      Represents a VM server location.

      • vmManagerId (string) –

        The ID of the VM manager.

      • vmId (string) –

        The ID of the VM.

Return type:

dict

Returns:

Response Syntax

{
    'lastModifiedOn': datetime(2015, 1, 1),
    'serverCatalogStatus': 'NOT_IMPORTED'|'IMPORTING'|'AVAILABLE'|'DELETED'|'EXPIRED',
    'serverList': [
        {
            'serverId': 'string',
            'serverType': 'VIRTUAL_MACHINE',
            'vmServer': {
                'vmServerAddress': {
                    'vmManagerId': 'string',
                    'vmId': 'string'
                },
                'vmName': 'string',
                'vmManagerName': 'string',
                'vmManagerType': 'VSPHERE'|'SCVMM'|'HYPERV-MANAGER',
                'vmPath': 'string'
            },
            'replicationJobId': 'string',
            'replicationJobTerminated': True|False
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • lastModifiedOn (datetime) –

      The time when the server was last modified.

    • serverCatalogStatus (string) –

      The status of the server catalog.

    • serverList (list) –

      Information about the servers.

      • (dict) –

        Represents a server.

        • serverId (string) –

          The ID of the server.

        • serverType (string) –

          The type of server.

        • vmServer (dict) –

          Information about the VM server.

          • vmServerAddress (dict) –

            The VM server location.

            • vmManagerId (string) –

              The ID of the VM manager.

            • vmId (string) –

              The ID of the VM.

          • vmName (string) –

            The name of the VM.

          • vmManagerName (string) –

            The name of the VM manager.

          • vmManagerType (string) –

            The type of VM management product.

          • vmPath (string) –

            The VM folder path in the vCenter Server virtual machine inventory tree.

        • replicationJobId (string) –

          The ID of the replication job.

        • replicationJobTerminated (boolean) –

          Indicates whether the replication job is deleted or failed.

    • 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