describe_vcenter_clients

mgn.Client.describe_vcenter_clients(**kwargs)

Returns a list of the installed vCenter clients.

See also: AWS API Documentation

Request Syntax

response = client.describe_vcenter_clients(
    maxResults=123,
    nextToken='string'
)
Parameters
  • maxResults (integer) -- Maximum results to be returned in DescribeVcenterClients.
  • nextToken (string) -- Next pagination token to be provided for DescribeVcenterClients.
Return type

dict

Returns

Response Syntax

{
    'items': [
        {
            'arn': 'string',
            'datacenterName': 'string',
            'hostname': 'string',
            'lastSeenDatetime': 'string',
            'sourceServerTags': {
                'string': 'string'
            },
            'tags': {
                'string': 'string'
            },
            'vcenterClientID': 'string',
            'vcenterUUID': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • items (list) --

      List of items returned by DescribeVcenterClients.

      • (dict) --

        vCenter client.

        • arn (string) --

          Arn of vCenter client.

        • datacenterName (string) --

          Datacenter name of vCenter client.

        • hostname (string) --

          Hostname of vCenter client .

        • lastSeenDatetime (string) --

          Last seen time of vCenter client.

        • sourceServerTags (dict) --

          Tags for Source Server of vCenter client.

          • (string) --
            • (string) --
        • tags (dict) --

          Tags for vCenter client.

          • (string) --
            • (string) --
        • vcenterClientID (string) --

          ID of vCenter client.

        • vcenterUUID (string) --

          Vcenter UUID of vCenter client.

    • nextToken (string) --

      Next pagination token returned from DescribeVcenterClients.

Exceptions

  • mgn.Client.exceptions.UninitializedAccountException
  • mgn.Client.exceptions.ResourceNotFoundException
  • mgn.Client.exceptions.ValidationException