GetServers¶

class SMS.Paginator.GetServers¶

paginator = client.get_paginator('get_servers')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from SMS.Client.get_servers().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    vmServerAddressList=[
        {
            'vmManagerId': 'string',
            'vmId': 'string'
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters

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.
PaginationConfig (dict) --
A dictionary that provides parameters to control pagination.
- MaxItems (integer) --
  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
- PageSize (integer) --
  The size of each page.
- StartingToken (string) --
  A token to specify where to start paginating. This is the NextToken from a previous response.

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) --
  
  A token to resume pagination.

Table Of Contents

GetServers¶