[ aws . evs ]

create-environment-host

Description

Creates an ESXi host and adds it to an Amazon EVS environment. Amazon EVS supports 4-16 hosts per environment.

This action can only be used after the Amazon EVS environment is deployed. All Amazon EVS hosts are created with the latest AMI release version for the respective VCF version of the environment.

You can use the dedicatedHostId parameter to specify an Amazon EC2 Dedicated Host for ESXi host creation.

You can use the placementGroupId parameter to specify a cluster or partition placement group to launch EC2 instances into.

Note

You cannot use the dedicatedHostId and placementGroupId parameters together in the same CreateEnvironmentHost action. This results in a ValidationException response.

Note

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

See also: AWS API Documentation

Synopsis

  create-environment-host
[--client-token <value>]
--environment-id <value>
--host <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options

--client-token (string)

Note

This parameter is not used in Amazon EVS currently. If you supply input for this parameter, it will have no effect.

A unique, case-sensitive identifier that you provide to ensure the idempotency of the host creation request. If you do not specify a client token, a randomly generated token is used for the request to ensure idempotency.

--environment-id (string)

A unique ID for the environment that the host is added to.

--host (structure)

The host that is created and added to the environment.

hostName -> (string)

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

keyName -> (string)

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

instanceType -> (string)

The EC2 instance type that represents the host.

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.

Shorthand Syntax:

hostName=string,keyName=string,instanceType=string,placementGroupId=string,dedicatedHostId=string

JSON Syntax:

{
  "hostName": "string",
  "keyName": "string",
  "instanceType": "i4i.metal",
  "placementGroupId": "string",
  "dedicatedHostId": "string"
}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

• json
• text
• table
• yaml
• yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on
• off
• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

• base64
• raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output

environmentSummary -> (structure)

A summary of the environment that the host is created in.

environmentId -> (string)

A unique ID for the environment.

environmentName -> (string)

The name of the environment.

vcfVersion -> (string)

The VCF version of the environment.

environmentStatus -> (string)

Reports impaired functionality that stems from issues internal to the environment, such as impaired reachability.

environmentState -> (string)

The state of an environment.

createdAt -> (timestamp)

The date and time that the environment was created.

modifiedAt -> (timestamp)

The date and time that the environment was modified.

environmentArn -> (string)

The Amazon Resource Name (ARN) that is associated with the environment.

host -> (structure)

A description of the created host.

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 -> (timestamp)

The date and time that the host was created.

modifiedAt -> (timestamp)

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.

(structure)

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.