EVS / Client / list_environment_hosts

list_environment_hosts

EVS.Client.list_environment_hosts(**kwargs)

List the hosts within an environment.

See also: AWS API Documentation

Request Syntax

response = client.list_environment_hosts(
    nextToken='string',
    maxResults=123,
    environmentId='string'
)
Parameters:

  • nextToken (string) – A unique pagination token for each page. If nextToken is returned, there are more results available. Make the call again using the returned token with all other arguments unchanged to retrieve the next page. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

  • maxResults (integer) – The maximum number of results to return. If you specify MaxResults in the request, the response includes information up to the limit specified.

  • environmentId (string) –

    [REQUIRED]

    A unique ID for the environment.

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    'environmentHosts': [
        {
            'hostName': 'string',
            'ipAddress': 'string',
            'keyName': 'string',
            'instanceType': 'i4i.metal',
            'placementGroupId': 'string',
            'dedicatedHostId': 'string',
            'createdAt': datetime(2015, 1, 1),
            'modifiedAt': datetime(2015, 1, 1),
            'hostState': 'CREATING'|'CREATED'|'UPDATING'|'DELETING'|'DELETED'|'CREATE_FAILED'|'UPDATE_FAILED',
            'stateDetails': 'string',
            'ec2InstanceId': 'string',
            'networkInterfaces': [
                {
                    'networkInterfaceId': 'string'
                },
            ]
        },
    ]
}

Response Structure

  • (dict) –

    • nextToken (string) –

      A unique pagination token for next page results. Make the call again using this token to retrieve the next page.

    • environmentHosts (list) –

      A list of hosts in the environment.

      • (dict) –

        An ESXi host that runs on an Amazon EC2 bare metal instance. Four hosts are created in an Amazon EVS environment during environment creation. You can add hosts to an environment using the CreateEnvironmentHost operation. Amazon EVS supports 4-16 hosts per environment.

        • hostName (string) –

          The DNS hostname of the host. DNS hostnames for hosts must be unique across Amazon EVS environments and within VCF.

        • ipAddress (string) –

          The IP address of the host.

        • keyName (string) –

          The name of the SSH key that is used to access the host.

        • instanceType (string) –

          The EC2 instance type of the host.

          Note

          EC2 instances created through Amazon EVS do not support associating an IAM instance profile.

        • placementGroupId (string) –

          The unique ID of the placement group where the host is placed.

        • dedicatedHostId (string) –

          The unique ID of the Amazon EC2 Dedicated Host.

        • createdAt (datetime) –

          The date and time that the host was created.

        • modifiedAt (datetime) –

          The date and time that the host was modified.

        • hostState (string) –

          The state of the host.

        • stateDetails (string) –

          A detailed description of the hostState of a host.

        • ec2InstanceId (string) –

          The unique ID of the EC2 instance that represents the host.

        • networkInterfaces (list) –

          The elastic network interfaces that are attached to the host.

          • (dict) –

            An elastic network interface (ENI) that connects hosts to the VLAN subnets. Amazon EVS provisions two identically configured ENIs in the VMkernel management subnet during host creation. One ENI is active, and the other is in standby mode for automatic switchover during a failure scenario.

            • networkInterfaceId (string) –

              The unique ID of the elastic network interface.

Exceptions