2026/06/29 - Amazon Elastic VMware Service - 11 updated api methods
Changes Amazon EVS introduces a VMware Cloud Foundation (VCF) self-deployed mode, along with new connectors to VCF components such as the Operations and SDDC managers to monitor coverage and usage.
{'vcfVersion': {'SELF_DEPLOYED'}}
Response {'environment': {'checks': {'id': 'string',
'type': {'CONNECTOR_HEALTH',
'OPERATIONS_MANAGER_REACHABILITY',
'SDDC_MANAGER_HOST_COUNT',
'SDDC_MANAGER_KEY_COVERAGE',
'SDDC_MANAGER_KEY_REUSE',
'SDDC_MANAGER_REACHABILITY'}},
'vcfVersion': {'SELF_DEPLOYED'}}}
Creates an Amazon EVS environment that runs VCF software, such as SDDC Manager, NSX Manager, and vCenter Server.
When you specify any other VCF version, Amazon EVS installs and configures VCF for you. For more information, see Self-deployed mode in the Amazon EVS User Guide.
See also: AWS API Documentation
Request Syntax
client.create_environment(
clientToken='string',
environmentName='string',
kmsKeyId='string',
tags={
'string': 'string'
},
serviceAccessSecurityGroups={
'securityGroups': [
'string',
]
},
vpcId='string',
serviceAccessSubnetId='string',
vcfVersion='VCF-5.2.1'|'VCF-5.2.2'|'SELF_DEPLOYED',
termsAccepted=True|False,
initialVlans={
'vmkManagement': {
'cidr': 'string'
},
'vmManagement': {
'cidr': 'string'
},
'vMotion': {
'cidr': 'string'
},
'vSan': {
'cidr': 'string'
},
'vTep': {
'cidr': 'string'
},
'edgeVTep': {
'cidr': 'string'
},
'nsxUplink': {
'cidr': 'string'
},
'hcx': {
'cidr': 'string'
},
'expansionVlan1': {
'cidr': 'string'
},
'expansionVlan2': {
'cidr': 'string'
},
'isHcxPublic': True|False,
'hcxNetworkAclId': 'string'
},
connectivityInfo={
'privateRouteServerPeerings': [
'string',
]
},
licenseInfo=[
{
'solutionKey': 'string',
'vsanKey': 'string'
},
],
hosts=[
{
'hostName': 'string',
'keyName': 'string',
'instanceType': 'i4i.metal'|'i7i.metal-24xl',
'placementGroupId': 'string',
'dedicatedHostId': 'string'
},
],
vcfHostnames={
'vCenter': 'string',
'nsx': 'string',
'nsxManager1': 'string',
'nsxManager2': 'string',
'nsxManager3': 'string',
'nsxEdge1': 'string',
'nsxEdge2': 'string',
'sddcManager': 'string',
'cloudBuilder': 'string'
},
siteId='string'
)
string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the environment creation request. If you do not specify a client token, a randomly generated token is used for the request to ensure idempotency.
This field is autopopulated if not provided.
string
The name to give to your environment. The name can contain only alphanumeric characters (case-sensitive), hyphens, and underscores. It must start with an alphanumeric character, and can't be longer than 100 characters. The name must be unique within the Amazon Web Services Region and Amazon Web Services account that you're creating the environment in.
string
A unique ID for the customer-managed KMS key that is used to encrypt the VCF credential pairs for SDDC Manager, NSX Manager, and vCenter appliances. These credentials are stored in Amazon Web Services Secrets Manager.
dict
Metadata that assists with categorization and organization. Each tag consists of a key and an optional value. You define both. Tags don't propagate to any other cluster or Amazon Web Services resources.
(string) --
(string) --
dict
The security group that controls communication between the Amazon EVS control plane and VPC. The default security group is used if a custom security group isn't specified.
The security group should allow access to the following.
TCP/UDP access to the DNS servers
HTTPS/SSH access to the host management VLAN subnet
HTTPS/SSH access to the Management VM VLAN subnet
You should avoid modifying the security group rules after deployment, as this can break the persistent connection between the Amazon EVS control plane and VPC. This can cause future environment actions like adding or removing hosts to fail.
securityGroups (list) --
The security groups that allow service access.
(string) --
string
[REQUIRED]
A unique ID for the VPC that the environment is deployed inside.
Amazon EVS requires that all VPC subnets exist in a single Availability Zone in a Region where the service is available.
The VPC that you specify must have a valid DHCP option set with domain name, at least two DNS servers, and an NTP server. These settings are used to configure your VCF appliances and hosts. The VPC cannot be used with any other deployed Amazon EVS environment. Amazon EVS does not provide multi-VPC support for environments at this time.
Amazon EVS does not support the following Amazon Web Services networking options for NSX overlay connectivity: cross-Region VPC peering, Amazon S3 gateway endpoints, or Amazon Web Services Direct Connect virtual private gateway associations.
string
[REQUIRED]
The subnet that is used to establish connectivity between the Amazon EVS control plane and VPC. The Amazon EVS control plane uses this subnet to interface with your environment. This includes validating DNS records and enabling Amazon EVS Connectors.
string
[REQUIRED]
The VCF version to use for the environment.
SELF_DEPLOYED: You install VCF yourself. The licenseInfo, hosts, vcfHostnames, siteId, and connectivityInfo parameters are not supported.
Any other valid value: Amazon EVS installs and configures VCF for you in the version you specify.
boolean
[REQUIRED]
Confirmation that the customer has purchased and will continue to maintain the required number of VCF software licenses to cover all physical processor cores in the Amazon EVS environment. Information about your VCF software in Amazon EVS will be shared with Broadcom to verify license compliance. Amazon EVS does not validate license keys. To validate license keys, visit the Broadcom support portal.
dict
[REQUIRED]
The initial VLAN subnets for the Amazon EVS environment.
vmkManagement (dict) -- [REQUIRED]
The host VMkernel management VLAN subnet. This VLAN subnet carries traffic for managing ESX hosts and communicating with VMware vCenter Server.
cidr (string) -- [REQUIRED]
The CIDR block that you provide to create an Amazon EVS VLAN subnet. Amazon EVS VLAN subnets have a minimum CIDR block size of /28 and a maximum size of /24. Amazon EVS VLAN subnet CIDR blocks must not overlap with other subnets in the VPC.
vmManagement (dict) -- [REQUIRED]
The VM management VLAN subnet. This VLAN subnet carries traffic for vSphere virtual machines.
cidr (string) -- [REQUIRED]
The CIDR block that you provide to create an Amazon EVS VLAN subnet. Amazon EVS VLAN subnets have a minimum CIDR block size of /28 and a maximum size of /24. Amazon EVS VLAN subnet CIDR blocks must not overlap with other subnets in the VPC.
vMotion (dict) -- [REQUIRED]
The vMotion VLAN subnet. This VLAN subnet carries traffic for vSphere vMotion.
cidr (string) -- [REQUIRED]
The CIDR block that you provide to create an Amazon EVS VLAN subnet. Amazon EVS VLAN subnets have a minimum CIDR block size of /28 and a maximum size of /24. Amazon EVS VLAN subnet CIDR blocks must not overlap with other subnets in the VPC.
vSan (dict) -- [REQUIRED]
The vSAN VLAN subnet. This VLAN subnet carries the communication between ESX hosts to implement a vSAN shared storage pool.
cidr (string) -- [REQUIRED]
The CIDR block that you provide to create an Amazon EVS VLAN subnet. Amazon EVS VLAN subnets have a minimum CIDR block size of /28 and a maximum size of /24. Amazon EVS VLAN subnet CIDR blocks must not overlap with other subnets in the VPC.
vTep (dict) -- [REQUIRED]
The VTEP VLAN subnet. This VLAN subnet handles internal network traffic between virtual machines within a VCF instance.
cidr (string) -- [REQUIRED]
The CIDR block that you provide to create an Amazon EVS VLAN subnet. Amazon EVS VLAN subnets have a minimum CIDR block size of /28 and a maximum size of /24. Amazon EVS VLAN subnet CIDR blocks must not overlap with other subnets in the VPC.
edgeVTep (dict) -- [REQUIRED]
The edge VTEP VLAN subnet. This VLAN subnet manages traffic flowing between the internal network and external networks, including internet access and other site connections.
cidr (string) -- [REQUIRED]
The CIDR block that you provide to create an Amazon EVS VLAN subnet. Amazon EVS VLAN subnets have a minimum CIDR block size of /28 and a maximum size of /24. Amazon EVS VLAN subnet CIDR blocks must not overlap with other subnets in the VPC.
nsxUplink (dict) -- [REQUIRED]
The NSX uplink VLAN subnet. This VLAN subnet allows connectivity to the NSX overlay network.
cidr (string) -- [REQUIRED]
The CIDR block that you provide to create an Amazon EVS VLAN subnet. Amazon EVS VLAN subnets have a minimum CIDR block size of /28 and a maximum size of /24. Amazon EVS VLAN subnet CIDR blocks must not overlap with other subnets in the VPC.
hcx (dict) -- [REQUIRED]
The HCX VLAN subnet. This VLAN subnet allows the HCX Interconnnect (IX) and HCX Network Extension (NE) to reach their peers and enable HCX Service Mesh creation.
If you plan to use a public HCX VLAN subnet, the following requirements must be met:
Must have a /28 netmask and be allocated from the IPAM public pool. Required for HCX internet access configuration.
The HCX public VLAN CIDR block must be added to the VPC as a secondary CIDR block.
Must have at least two Elastic IP addresses to be allocated from the public IPAM pool for HCX components.
cidr (string) -- [REQUIRED]
The CIDR block that you provide to create an Amazon EVS VLAN subnet. Amazon EVS VLAN subnets have a minimum CIDR block size of /28 and a maximum size of /24. Amazon EVS VLAN subnet CIDR blocks must not overlap with other subnets in the VPC.
expansionVlan1 (dict) -- [REQUIRED]
An additional VLAN subnet that can be used to extend VCF capabilities once configured. For example, you can configure an expansion VLAN subnet to use NSX Federation for centralized management and synchronization of multiple NSX deployments across different locations.
cidr (string) -- [REQUIRED]
The CIDR block that you provide to create an Amazon EVS VLAN subnet. Amazon EVS VLAN subnets have a minimum CIDR block size of /28 and a maximum size of /24. Amazon EVS VLAN subnet CIDR blocks must not overlap with other subnets in the VPC.
expansionVlan2 (dict) -- [REQUIRED]
An additional VLAN subnet that can be used to extend VCF capabilities once configured. For example, you can configure an expansion VLAN subnet to use NSX Federation for centralized management and synchronization of multiple NSX deployments across different locations.
cidr (string) -- [REQUIRED]
The CIDR block that you provide to create an Amazon EVS VLAN subnet. Amazon EVS VLAN subnets have a minimum CIDR block size of /28 and a maximum size of /24. Amazon EVS VLAN subnet CIDR blocks must not overlap with other subnets in the VPC.
isHcxPublic (boolean) --
Determines if the HCX VLAN that Amazon EVS provisions is public or private.
hcxNetworkAclId (string) --
A unique ID for a network access control list that the HCX VLAN uses. Required when isHcxPublic is set to true.
dict
The connectivity configuration for the environment. Amazon EVS requires that you specify two route server peer IDs. During environment creation, the route server endpoints peer with the NSX edges over the NSX uplink subnet, providing BGP-based dynamic routing for overlay networks.
privateRouteServerPeerings (list) -- [REQUIRED]
The unique IDs for private route server peers.
(string) --
list
The license information that Amazon EVS requires to create an environment. Amazon EVS requires two license keys: a VCF solution key and a vSAN license key. The VCF solution key must meet minimum core requirements, and the vSAN license key must meet minimum capacity requirements for your selected instance type.
For information about minimum license requirements, see the VCF subscriptions section in the Amazon EVS User Guide.
VCF licenses can be used for only one Amazon EVS environment. Amazon EVS does not support reuse of VCF licenses for multiple environments.
VCF license information can be retrieved from the Broadcom portal.
(dict) --
The license information that Amazon EVS requires to create an environment. Amazon EVS requires two license keys: a VCF solution key and a vSAN license key.
solutionKey (string) -- [REQUIRED]
The VCF solution key. This license unlocks VMware VCF product features, including vSphere, NSX, SDDC Manager, and vCenter Server. The VCF solution key must meet the instance-type-specific minimum core requirements.
vsanKey (string) -- [REQUIRED]
The VSAN license key. This license unlocks vSAN features. The vSAN license key must meet the instance-type-specific minimum capacity requirements.
list
The ESX hosts to add to the environment. For each host, provide the desired hostname, EC2 SSH keypair name, and EC2 instance type. Optionally, provide a partition or cluster placement group, or use Amazon EC2 Dedicated Hosts.
(dict) --
An object that represents a host.
hostName (string) -- [REQUIRED]
The DNS hostname of the host. DNS hostnames for hosts must be unique across Amazon EVS environments and within VCF.
keyName (string) -- [REQUIRED]
The name of the SSH key that is used to access the host.
instanceType (string) -- [REQUIRED]
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.
dict
The DNS hostnames for the virtual machines that host the VCF management appliances. Provide hostnames for vCenter, NSX Manager, SDDC Manager, and Cloud Builder.
vCenter (string) -- [REQUIRED]
The VMware vCenter hostname.
nsx (string) -- [REQUIRED]
The VMware NSX Virtual IP (VIP) hostname.
nsxManager1 (string) -- [REQUIRED]
The hostname for the first VMware NSX Manager virtual machine (VM).
nsxManager2 (string) -- [REQUIRED]
The hostname for the second VMware NSX Manager virtual machine (VM).
nsxManager3 (string) -- [REQUIRED]
The hostname for the third VMware NSX Manager virtual machine (VM).
nsxEdge1 (string) -- [REQUIRED]
The hostname for the first NSX Edge node.
nsxEdge2 (string) -- [REQUIRED]
The hostname for the second NSX Edge node.
sddcManager (string) -- [REQUIRED]
The hostname for SDDC Manager.
cloudBuilder (string) -- [REQUIRED]
The hostname for VMware Cloud Builder.
string
The Broadcom Site ID that is allocated to you as part of your electronic software delivery. This ID allows customer access to the Broadcom portal, and is provided to you by Broadcom at the close of your software contract or contract renewal. Amazon EVS uses the Broadcom Site ID that you provide to meet Broadcom VCF license usage reporting requirements for Amazon EVS.
dict
Response Syntax
{
'environment': {
'environmentId': 'string',
'environmentState': 'CREATING'|'CREATED'|'DELETING'|'DELETED'|'CREATE_FAILED',
'stateDetails': 'string',
'createdAt': datetime(2015, 1, 1),
'modifiedAt': datetime(2015, 1, 1),
'environmentArn': 'string',
'environmentName': 'string',
'vpcId': 'string',
'serviceAccessSubnetId': 'string',
'vcfVersion': 'VCF-5.2.1'|'VCF-5.2.2'|'SELF_DEPLOYED',
'termsAccepted': True|False,
'licenseInfo': [
{
'solutionKey': 'string',
'vsanKey': 'string'
},
],
'siteId': 'string',
'environmentStatus': 'PASSED'|'FAILED'|'UNKNOWN',
'checks': [
{
'type': 'KEY_REUSE'|'KEY_COVERAGE'|'REACHABILITY'|'HOST_COUNT'|'VCENTER_REACHABILITY'|'VCENTER_VM_SYNC'|'VCENTER_VM_EVENT'|'OPERATIONS_MANAGER_REACHABILITY'|'SDDC_MANAGER_REACHABILITY'|'SDDC_MANAGER_HOST_COUNT'|'SDDC_MANAGER_KEY_COVERAGE'|'SDDC_MANAGER_KEY_REUSE'|'CONNECTOR_HEALTH',
'id': 'string',
'result': 'PASSED'|'FAILED'|'UNKNOWN',
'impairedSince': datetime(2015, 1, 1)
},
],
'connectivityInfo': {
'privateRouteServerPeerings': [
'string',
]
},
'vcfHostnames': {
'vCenter': 'string',
'nsx': 'string',
'nsxManager1': 'string',
'nsxManager2': 'string',
'nsxManager3': 'string',
'nsxEdge1': 'string',
'nsxEdge2': 'string',
'sddcManager': 'string',
'cloudBuilder': 'string'
},
'kmsKeyId': 'string',
'serviceAccessSecurityGroups': {
'securityGroups': [
'string',
]
},
'credentials': [
{
'secretArn': 'string'
},
]
}
}
Response Structure
(dict) --
environment (dict) --
A description of the created environment.
environmentId (string) --
The unique ID for the environment.
environmentState (string) --
The state of an environment.
stateDetails (string) --
A detailed description of the environmentState of an environment.
createdAt (datetime) --
The date and time that the environment was created.
modifiedAt (datetime) --
The date and time that the environment was modified.
environmentArn (string) --
The Amazon Resource Name (ARN) that is associated with the environment.
environmentName (string) --
The name of the environment.
vpcId (string) --
The VPC associated with the environment.
serviceAccessSubnetId (string) --
The subnet that is used to establish connectivity between the Amazon EVS control plane and VPC. Amazon EVS uses this subnet to perform validations and create the environment.
vcfVersion (string) --
The VCF version of the environment.
termsAccepted (boolean) --
Customer confirmation that the customer has purchased and will continue to maintain the required number of VCF software licenses to cover all physical processor cores in the Amazon EVS environment. Information about your VCF software in Amazon EVS will be shared with Broadcom to verify license compliance. Amazon EVS does not validate license keys. To validate license keys, visit the Broadcom support portal.
licenseInfo (list) --
The license information that Amazon EVS requires to create an environment. Amazon EVS requires two license keys: a VCF solution key and a vSAN license key. The VCF solution key must meet minimum core requirements, and the vSAN license key must meet minimum capacity requirements for your selected instance type.
For information about minimum license requirements, see the VCF subscriptions section in the Amazon EVS User Guide.
(dict) --
The license information that Amazon EVS requires to create an environment. Amazon EVS requires two license keys: a VCF solution key and a vSAN license key.
solutionKey (string) --
The VCF solution key. This license unlocks VMware VCF product features, including vSphere, NSX, SDDC Manager, and vCenter Server. The VCF solution key must meet the instance-type-specific minimum core requirements.
vsanKey (string) --
The VSAN license key. This license unlocks vSAN features. The vSAN license key must meet the instance-type-specific minimum capacity requirements.
siteId (string) --
The Broadcom Site ID that is associated with your Amazon EVS environment. Amazon EVS uses the Broadcom Site ID that you provide to meet Broadcom VCF license usage reporting requirements for Amazon EVS.
environmentStatus (string) --
Reports impaired functionality that stems from issues internal to the environment, such as impaired reachability.
checks (list) --
A check on the environment to identify connector health.
(dict) --
A check on the environment to identify environment health and validate VMware VCF licensing compliance.
type (string) --
The check type. Amazon EVS performs the following checks:
KEY_REUSE: Verifies that the VCF license key is not used by another Amazon EVS environment.
KEY_COVERAGE: Verifies that the VCF license key allocates sufficient vCPU cores for all deployed hosts.
REACHABILITY: Verifies that the Amazon EVS control plane has a persistent connection to SDDC Manager.
HOST_COUNT: Verifies that the environment meets the minimum host count.
VCENTER_REACHABILITY: Verifies vCenter Server reachability through the vCenter connector.
VCENTER_VM_SYNC: Verifies that the vCenter connector can synchronize VM inventory from vCenter Server.
VCENTER_VM_EVENT: Verifies that the vCenter connector can receive VM lifecycle events from vCenter Server.
OPERATIONS_MANAGER_REACHABILITY: Verifies Operations Manager reachability through the Operations Manager connector.
SDDC_MANAGER_REACHABILITY: Verifies SDDC Manager reachability through the SDDC Manager connector.
SDDC_MANAGER_HOST_COUNT: Verifies that the host count reported by SDDC Manager meets Amazon EVS minimum requirements.
SDDC_MANAGER_KEY_COVERAGE: Verifies that the VCF license key configured in SDDC Manager covers all deployed hosts.
SDDC_MANAGER_KEY_REUSE: Verifies that the VCF license key configured in SDDC Manager is not used by another Amazon EVS environment.
CONNECTOR_HEALTH: Aggregate health across all connectors in the environment.
id (string) --
A unique ID for the check.
result (string) --
The check result.
impairedSince (datetime) --
The time when environment health began to be impaired.
connectivityInfo (dict) --
The connectivity configuration for the environment. Amazon EVS requires that you specify two route server peer IDs. During environment creation, the route server endpoints peer with the NSX uplink VLAN for connectivity to the NSX overlay network.
privateRouteServerPeerings (list) --
The unique IDs for private route server peers.
(string) --
vcfHostnames (dict) --
The DNS hostnames to be used by the VCF management appliances in your environment.
For environment creation to be successful, each hostname entry must resolve to a domain name that you've registered in your DNS service of choice and configured in the DHCP option set of your VPC. DNS hostnames cannot be changed after environment creation has started.
vCenter (string) --
The VMware vCenter hostname.
nsx (string) --
The VMware NSX Virtual IP (VIP) hostname.
nsxManager1 (string) --
The hostname for the first VMware NSX Manager virtual machine (VM).
nsxManager2 (string) --
The hostname for the second VMware NSX Manager virtual machine (VM).
nsxManager3 (string) --
The hostname for the third VMware NSX Manager virtual machine (VM).
nsxEdge1 (string) --
The hostname for the first NSX Edge node.
nsxEdge2 (string) --
The hostname for the second NSX Edge node.
sddcManager (string) --
The hostname for SDDC Manager.
cloudBuilder (string) --
The hostname for VMware Cloud Builder.
kmsKeyId (string) --
The Amazon Web Services KMS key ID that Amazon Web Services Secrets Manager uses to encrypt secrets that are associated with the environment. These secrets contain the VCF credentials that are needed to install vCenter Server, NSX, and SDDC Manager.
By default, Amazon EVS use the Amazon Web Services Secrets Manager managed key aws/secretsmanager. You can also specify a customer managed key.
serviceAccessSecurityGroups (dict) --
The security groups that allow traffic between the Amazon EVS control plane and your VPC for service access. If a security group is not specified, Amazon EVS uses the default security group in your account for service access.
securityGroups (list) --
The security groups that allow service access.
(string) --
credentials (list) --
The VCF credentials that are stored as Amazon EVS managed secrets in Amazon Web Services Secrets Manager.
Amazon EVS stores credentials that are needed to install vCenter Server, NSX, and SDDC Manager.
(dict) --
A managed secret that contains the credentials for installing vCenter Server, NSX, and SDDC Manager. During environment creation, the Amazon EVS control plane uses Amazon Web Services Secrets Manager to create, encrypt, validate, and store secrets. If you choose to delete your environment, Amazon EVS also deletes the secrets that are associated with your environment. Amazon EVS does not provide managed rotation of secrets. We recommend that you rotate secrets regularly to ensure that secrets are not long-lived.
secretArn (string) --
The Amazon Resource Name (ARN) of the secret.
{'type': {'OPERATIONS_MANAGER', 'SDDC_MANAGER'}}
Response {'connector': {'checks': {'type': {'CONNECTOR_HEALTH',
'OPERATIONS_MANAGER_REACHABILITY',
'SDDC_MANAGER_HOST_COUNT',
'SDDC_MANAGER_KEY_COVERAGE',
'SDDC_MANAGER_KEY_REUSE',
'SDDC_MANAGER_REACHABILITY'}},
'type': {'OPERATIONS_MANAGER', 'SDDC_MANAGER'}}}
Creates a connector for an Amazon EVS environment. A connector allows the Amazon EVS control plane to interface with VCF appliances using a fully qualified domain name.
You can create only one connector of each type per environment. For environments where Amazon EVS installs VCF, the SDDC_MANAGER connector is created automatically.
See also: AWS API Documentation
Request Syntax
client.create_environment_connector(
clientToken='string',
environmentId='string',
type='OPERATIONS_MANAGER'|'SDDC_MANAGER'|'VCENTER',
applianceFqdn='string',
secretIdentifier='string'
)
string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the connector creation request. If you do not specify a client token, a randomly generated token is used for the request to ensure idempotency.
This field is autopopulated if not provided.
string
[REQUIRED]
A unique ID for the environment to create the connector in.
string
[REQUIRED]
The type of connector to create.
OPERATIONS_MANAGER: Connector to an Operations Manager appliance. Required for VCF 9x environments.
SDDC_MANAGER: Connector to an SDDC Manager appliance. Required for VCF 5.x environments.
VCENTER: Connector to a vCenter Server appliance. Required for features that depend on vCenter, such as Windows Server license-included.
string
[REQUIRED]
The fully qualified domain name (FQDN) of the VCF appliance that the connector targets.
string
[REQUIRED]
The ARN or name of the Amazon Web Services Secrets Manager secret that stores the credentials for the VCF appliance. SDDC_MANAGER requires an apiKey field; OPERATIONS_MANAGER and VCENTER require username and password fields.
dict
Response Syntax
{
'connector': {
'environmentId': 'string',
'connectorId': 'string',
'type': 'OPERATIONS_MANAGER'|'SDDC_MANAGER'|'VCENTER',
'applianceFqdn': 'string',
'secretArn': 'string',
'state': 'CREATING'|'CREATE_FAILED'|'ACTIVE'|'UPDATING'|'UPDATE_FAILED'|'DELETING'|'DELETED',
'stateDetails': 'string',
'status': 'PASSED'|'FAILED'|'UNKNOWN',
'checks': [
{
'type': 'KEY_REUSE'|'KEY_COVERAGE'|'REACHABILITY'|'HOST_COUNT'|'VCENTER_REACHABILITY'|'VCENTER_VM_SYNC'|'VCENTER_VM_EVENT'|'OPERATIONS_MANAGER_REACHABILITY'|'SDDC_MANAGER_REACHABILITY'|'SDDC_MANAGER_HOST_COUNT'|'SDDC_MANAGER_KEY_COVERAGE'|'SDDC_MANAGER_KEY_REUSE'|'CONNECTOR_HEALTH',
'result': 'PASSED'|'FAILED'|'UNKNOWN',
'lastCheckAttempt': datetime(2015, 1, 1),
'impairedSince': datetime(2015, 1, 1)
},
],
'createdAt': datetime(2015, 1, 1),
'modifiedAt': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
connector (dict) --
A description of the created connector.
environmentId (string) --
The unique ID of the environment that the connector belongs to.
connectorId (string) --
The unique ID of the connector.
type (string) --
The type of the connector.
applianceFqdn (string) --
The fully qualified domain name (FQDN) of the VCF appliance that the connector connects to.
secretArn (string) --
The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that stores the credentials for the VCF appliance.
state (string) --
The state of the connector.
stateDetails (string) --
A detailed description of the connector state.
status (string) --
The status of the connector.
checks (list) --
A list of checks that are run on the connector.
(dict) --
A check on a connector to identify connectivity health.
type (string) --
The check type.
result (string) --
The check result.
lastCheckAttempt (datetime) --
The date and time of the last check attempt.
impairedSince (datetime) --
The time when connector health began to be impaired.
createdAt (datetime) --
The date and time that the connector was created.
modifiedAt (datetime) --
The date and time that the connector was modified.
{'environmentSummary': {'vcfVersion': {'SELF_DEPLOYED'}}}
Creates an ESX host and adds it to an Amazon EVS environment.
This action can only be used after the Amazon EVS environment is deployed.
You can use the dedicatedHostId parameter to specify an Amazon EC2 Dedicated Host for ESX host creation.
You can use the placementGroupId parameter to specify a cluster or partition placement group to launch EC2 instances into.
See also: AWS API Documentation
Request Syntax
client.create_environment_host(
clientToken='string',
environmentId='string',
host={
'hostName': 'string',
'keyName': 'string',
'instanceType': 'i4i.metal'|'i7i.metal-24xl',
'placementGroupId': 'string',
'dedicatedHostId': 'string'
},
esxVersion='string'
)
string
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.
This field is autopopulated if not provided.
string
[REQUIRED]
A unique ID for the environment that the host is added to.
dict
[REQUIRED]
The host that is created and added to the environment.
hostName (string) -- [REQUIRED]
The DNS hostname of the host. DNS hostnames for hosts must be unique across Amazon EVS environments and within VCF.
keyName (string) -- [REQUIRED]
The name of the SSH key that is used to access the host.
instanceType (string) -- [REQUIRED]
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.
string
The ESX version to use for the host.
dict
Response Syntax
{
'environmentSummary': {
'environmentId': 'string',
'environmentName': 'string',
'vcfVersion': 'VCF-5.2.1'|'VCF-5.2.2'|'SELF_DEPLOYED',
'environmentStatus': 'PASSED'|'FAILED'|'UNKNOWN',
'environmentState': 'CREATING'|'CREATED'|'DELETING'|'DELETED'|'CREATE_FAILED',
'createdAt': datetime(2015, 1, 1),
'modifiedAt': datetime(2015, 1, 1),
'environmentArn': 'string'
},
'host': {
'hostName': 'string',
'ipAddress': 'string',
'keyName': 'string',
'instanceType': 'i4i.metal'|'i7i.metal-24xl',
'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) --
environmentSummary (dict) --
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 (datetime) --
The date and time that the environment was created.
modifiedAt (datetime) --
The date and time that the environment was modified.
environmentArn (string) --
The Amazon Resource Name (ARN) that is associated with the environment.
host (dict) --
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.
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.
{'environment': {'checks': {'id': 'string',
'type': {'CONNECTOR_HEALTH',
'OPERATIONS_MANAGER_REACHABILITY',
'SDDC_MANAGER_HOST_COUNT',
'SDDC_MANAGER_KEY_COVERAGE',
'SDDC_MANAGER_KEY_REUSE',
'SDDC_MANAGER_REACHABILITY'}},
'vcfVersion': {'SELF_DEPLOYED'}}}
Deletes an Amazon EVS environment.
Amazon EVS environments will only be enabled for deletion once the hosts are deleted. You can delete hosts using the DeleteEnvironmentHost action.
Environment deletion also deletes the associated Amazon EVS VLAN subnets and Amazon Web Services Secrets Manager secrets that Amazon EVS created. Amazon Web Services resources that you create are not deleted. These resources may continue to incur costs.
See also: AWS API Documentation
Request Syntax
client.delete_environment(
clientToken='string',
environmentId='string'
)
string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the environment deletion request. If you do not specify a client token, a randomly generated token is used for the request to ensure idempotency.
This field is autopopulated if not provided.
string
[REQUIRED]
A unique ID associated with the environment to be deleted.
dict
Response Syntax
{
'environment': {
'environmentId': 'string',
'environmentState': 'CREATING'|'CREATED'|'DELETING'|'DELETED'|'CREATE_FAILED',
'stateDetails': 'string',
'createdAt': datetime(2015, 1, 1),
'modifiedAt': datetime(2015, 1, 1),
'environmentArn': 'string',
'environmentName': 'string',
'vpcId': 'string',
'serviceAccessSubnetId': 'string',
'vcfVersion': 'VCF-5.2.1'|'VCF-5.2.2'|'SELF_DEPLOYED',
'termsAccepted': True|False,
'licenseInfo': [
{
'solutionKey': 'string',
'vsanKey': 'string'
},
],
'siteId': 'string',
'environmentStatus': 'PASSED'|'FAILED'|'UNKNOWN',
'checks': [
{
'type': 'KEY_REUSE'|'KEY_COVERAGE'|'REACHABILITY'|'HOST_COUNT'|'VCENTER_REACHABILITY'|'VCENTER_VM_SYNC'|'VCENTER_VM_EVENT'|'OPERATIONS_MANAGER_REACHABILITY'|'SDDC_MANAGER_REACHABILITY'|'SDDC_MANAGER_HOST_COUNT'|'SDDC_MANAGER_KEY_COVERAGE'|'SDDC_MANAGER_KEY_REUSE'|'CONNECTOR_HEALTH',
'id': 'string',
'result': 'PASSED'|'FAILED'|'UNKNOWN',
'impairedSince': datetime(2015, 1, 1)
},
],
'connectivityInfo': {
'privateRouteServerPeerings': [
'string',
]
},
'vcfHostnames': {
'vCenter': 'string',
'nsx': 'string',
'nsxManager1': 'string',
'nsxManager2': 'string',
'nsxManager3': 'string',
'nsxEdge1': 'string',
'nsxEdge2': 'string',
'sddcManager': 'string',
'cloudBuilder': 'string'
},
'kmsKeyId': 'string',
'serviceAccessSecurityGroups': {
'securityGroups': [
'string',
]
},
'credentials': [
{
'secretArn': 'string'
},
]
}
}
Response Structure
(dict) --
environment (dict) --
A description of the deleted environment.
environmentId (string) --
The unique ID for the environment.
environmentState (string) --
The state of an environment.
stateDetails (string) --
A detailed description of the environmentState of an environment.
createdAt (datetime) --
The date and time that the environment was created.
modifiedAt (datetime) --
The date and time that the environment was modified.
environmentArn (string) --
The Amazon Resource Name (ARN) that is associated with the environment.
environmentName (string) --
The name of the environment.
vpcId (string) --
The VPC associated with the environment.
serviceAccessSubnetId (string) --
The subnet that is used to establish connectivity between the Amazon EVS control plane and VPC. Amazon EVS uses this subnet to perform validations and create the environment.
vcfVersion (string) --
The VCF version of the environment.
termsAccepted (boolean) --
Customer confirmation that the customer has purchased and will continue to maintain the required number of VCF software licenses to cover all physical processor cores in the Amazon EVS environment. Information about your VCF software in Amazon EVS will be shared with Broadcom to verify license compliance. Amazon EVS does not validate license keys. To validate license keys, visit the Broadcom support portal.
licenseInfo (list) --
The license information that Amazon EVS requires to create an environment. Amazon EVS requires two license keys: a VCF solution key and a vSAN license key. The VCF solution key must meet minimum core requirements, and the vSAN license key must meet minimum capacity requirements for your selected instance type.
For information about minimum license requirements, see the VCF subscriptions section in the Amazon EVS User Guide.
(dict) --
The license information that Amazon EVS requires to create an environment. Amazon EVS requires two license keys: a VCF solution key and a vSAN license key.
solutionKey (string) --
The VCF solution key. This license unlocks VMware VCF product features, including vSphere, NSX, SDDC Manager, and vCenter Server. The VCF solution key must meet the instance-type-specific minimum core requirements.
vsanKey (string) --
The VSAN license key. This license unlocks vSAN features. The vSAN license key must meet the instance-type-specific minimum capacity requirements.
siteId (string) --
The Broadcom Site ID that is associated with your Amazon EVS environment. Amazon EVS uses the Broadcom Site ID that you provide to meet Broadcom VCF license usage reporting requirements for Amazon EVS.
environmentStatus (string) --
Reports impaired functionality that stems from issues internal to the environment, such as impaired reachability.
checks (list) --
A check on the environment to identify connector health.
(dict) --
A check on the environment to identify environment health and validate VMware VCF licensing compliance.
type (string) --
The check type. Amazon EVS performs the following checks:
KEY_REUSE: Verifies that the VCF license key is not used by another Amazon EVS environment.
KEY_COVERAGE: Verifies that the VCF license key allocates sufficient vCPU cores for all deployed hosts.
REACHABILITY: Verifies that the Amazon EVS control plane has a persistent connection to SDDC Manager.
HOST_COUNT: Verifies that the environment meets the minimum host count.
VCENTER_REACHABILITY: Verifies vCenter Server reachability through the vCenter connector.
VCENTER_VM_SYNC: Verifies that the vCenter connector can synchronize VM inventory from vCenter Server.
VCENTER_VM_EVENT: Verifies that the vCenter connector can receive VM lifecycle events from vCenter Server.
OPERATIONS_MANAGER_REACHABILITY: Verifies Operations Manager reachability through the Operations Manager connector.
SDDC_MANAGER_REACHABILITY: Verifies SDDC Manager reachability through the SDDC Manager connector.
SDDC_MANAGER_HOST_COUNT: Verifies that the host count reported by SDDC Manager meets Amazon EVS minimum requirements.
SDDC_MANAGER_KEY_COVERAGE: Verifies that the VCF license key configured in SDDC Manager covers all deployed hosts.
SDDC_MANAGER_KEY_REUSE: Verifies that the VCF license key configured in SDDC Manager is not used by another Amazon EVS environment.
CONNECTOR_HEALTH: Aggregate health across all connectors in the environment.
id (string) --
A unique ID for the check.
result (string) --
The check result.
impairedSince (datetime) --
The time when environment health began to be impaired.
connectivityInfo (dict) --
The connectivity configuration for the environment. Amazon EVS requires that you specify two route server peer IDs. During environment creation, the route server endpoints peer with the NSX uplink VLAN for connectivity to the NSX overlay network.
privateRouteServerPeerings (list) --
The unique IDs for private route server peers.
(string) --
vcfHostnames (dict) --
The DNS hostnames to be used by the VCF management appliances in your environment.
For environment creation to be successful, each hostname entry must resolve to a domain name that you've registered in your DNS service of choice and configured in the DHCP option set of your VPC. DNS hostnames cannot be changed after environment creation has started.
vCenter (string) --
The VMware vCenter hostname.
nsx (string) --
The VMware NSX Virtual IP (VIP) hostname.
nsxManager1 (string) --
The hostname for the first VMware NSX Manager virtual machine (VM).
nsxManager2 (string) --
The hostname for the second VMware NSX Manager virtual machine (VM).
nsxManager3 (string) --
The hostname for the third VMware NSX Manager virtual machine (VM).
nsxEdge1 (string) --
The hostname for the first NSX Edge node.
nsxEdge2 (string) --
The hostname for the second NSX Edge node.
sddcManager (string) --
The hostname for SDDC Manager.
cloudBuilder (string) --
The hostname for VMware Cloud Builder.
kmsKeyId (string) --
The Amazon Web Services KMS key ID that Amazon Web Services Secrets Manager uses to encrypt secrets that are associated with the environment. These secrets contain the VCF credentials that are needed to install vCenter Server, NSX, and SDDC Manager.
By default, Amazon EVS use the Amazon Web Services Secrets Manager managed key aws/secretsmanager. You can also specify a customer managed key.
serviceAccessSecurityGroups (dict) --
The security groups that allow traffic between the Amazon EVS control plane and your VPC for service access. If a security group is not specified, Amazon EVS uses the default security group in your account for service access.
securityGroups (list) --
The security groups that allow service access.
(string) --
credentials (list) --
The VCF credentials that are stored as Amazon EVS managed secrets in Amazon Web Services Secrets Manager.
Amazon EVS stores credentials that are needed to install vCenter Server, NSX, and SDDC Manager.
(dict) --
A managed secret that contains the credentials for installing vCenter Server, NSX, and SDDC Manager. During environment creation, the Amazon EVS control plane uses Amazon Web Services Secrets Manager to create, encrypt, validate, and store secrets. If you choose to delete your environment, Amazon EVS also deletes the secrets that are associated with your environment. Amazon EVS does not provide managed rotation of secrets. We recommend that you rotate secrets regularly to ensure that secrets are not long-lived.
secretArn (string) --
The Amazon Resource Name (ARN) of the secret.
{'connector': {'checks': {'type': {'CONNECTOR_HEALTH',
'OPERATIONS_MANAGER_REACHABILITY',
'SDDC_MANAGER_HOST_COUNT',
'SDDC_MANAGER_KEY_COVERAGE',
'SDDC_MANAGER_KEY_REUSE',
'SDDC_MANAGER_REACHABILITY'}},
'type': {'OPERATIONS_MANAGER', 'SDDC_MANAGER'}},
'environmentSummary': {'vcfVersion': {'SELF_DEPLOYED'}}}
Deletes a connector from an Amazon EVS environment.
See also: AWS API Documentation
Request Syntax
client.delete_environment_connector(
clientToken='string',
environmentId='string',
connectorId='string'
)
string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the connector deletion request. If you do not specify a client token, a randomly generated token is used for the request to ensure idempotency.
This field is autopopulated if not provided.
string
[REQUIRED]
A unique ID for the environment that the connector belongs to.
string
[REQUIRED]
A unique ID for the connector to be deleted.
dict
Response Syntax
{
'connector': {
'environmentId': 'string',
'connectorId': 'string',
'type': 'OPERATIONS_MANAGER'|'SDDC_MANAGER'|'VCENTER',
'applianceFqdn': 'string',
'secretArn': 'string',
'state': 'CREATING'|'CREATE_FAILED'|'ACTIVE'|'UPDATING'|'UPDATE_FAILED'|'DELETING'|'DELETED',
'stateDetails': 'string',
'status': 'PASSED'|'FAILED'|'UNKNOWN',
'checks': [
{
'type': 'KEY_REUSE'|'KEY_COVERAGE'|'REACHABILITY'|'HOST_COUNT'|'VCENTER_REACHABILITY'|'VCENTER_VM_SYNC'|'VCENTER_VM_EVENT'|'OPERATIONS_MANAGER_REACHABILITY'|'SDDC_MANAGER_REACHABILITY'|'SDDC_MANAGER_HOST_COUNT'|'SDDC_MANAGER_KEY_COVERAGE'|'SDDC_MANAGER_KEY_REUSE'|'CONNECTOR_HEALTH',
'result': 'PASSED'|'FAILED'|'UNKNOWN',
'lastCheckAttempt': datetime(2015, 1, 1),
'impairedSince': datetime(2015, 1, 1)
},
],
'createdAt': datetime(2015, 1, 1),
'modifiedAt': datetime(2015, 1, 1)
},
'environmentSummary': {
'environmentId': 'string',
'environmentName': 'string',
'vcfVersion': 'VCF-5.2.1'|'VCF-5.2.2'|'SELF_DEPLOYED',
'environmentStatus': 'PASSED'|'FAILED'|'UNKNOWN',
'environmentState': 'CREATING'|'CREATED'|'DELETING'|'DELETED'|'CREATE_FAILED',
'createdAt': datetime(2015, 1, 1),
'modifiedAt': datetime(2015, 1, 1),
'environmentArn': 'string'
}
}
Response Structure
(dict) --
connector (dict) --
A description of the deleted connector.
environmentId (string) --
The unique ID of the environment that the connector belongs to.
connectorId (string) --
The unique ID of the connector.
type (string) --
The type of the connector.
applianceFqdn (string) --
The fully qualified domain name (FQDN) of the VCF appliance that the connector connects to.
secretArn (string) --
The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that stores the credentials for the VCF appliance.
state (string) --
The state of the connector.
stateDetails (string) --
A detailed description of the connector state.
status (string) --
The status of the connector.
checks (list) --
A list of checks that are run on the connector.
(dict) --
A check on a connector to identify connectivity health.
type (string) --
The check type.
result (string) --
The check result.
lastCheckAttempt (datetime) --
The date and time of the last check attempt.
impairedSince (datetime) --
The time when connector health began to be impaired.
createdAt (datetime) --
The date and time that the connector was created.
modifiedAt (datetime) --
The date and time that the connector was modified.
environmentSummary (dict) --
A summary of the environment that the connector was deleted from.
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 (datetime) --
The date and time that the environment was created.
modifiedAt (datetime) --
The date and time that the environment was modified.
environmentArn (string) --
The Amazon Resource Name (ARN) that is associated with the environment.
{'environmentSummary': {'vcfVersion': {'SELF_DEPLOYED'}}}
Deletes a host from an Amazon EVS environment.
See also: AWS API Documentation
Request Syntax
client.delete_environment_host(
clientToken='string',
environmentId='string',
hostName='string'
)
string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the host deletion request. If you do not specify a client token, a randomly generated token is used for the request to ensure idempotency.
This field is autopopulated if not provided.
string
[REQUIRED]
A unique ID for the host's environment.
string
[REQUIRED]
The DNS hostname associated with the host to be deleted.
dict
Response Syntax
{
'environmentSummary': {
'environmentId': 'string',
'environmentName': 'string',
'vcfVersion': 'VCF-5.2.1'|'VCF-5.2.2'|'SELF_DEPLOYED',
'environmentStatus': 'PASSED'|'FAILED'|'UNKNOWN',
'environmentState': 'CREATING'|'CREATED'|'DELETING'|'DELETED'|'CREATE_FAILED',
'createdAt': datetime(2015, 1, 1),
'modifiedAt': datetime(2015, 1, 1),
'environmentArn': 'string'
},
'host': {
'hostName': 'string',
'ipAddress': 'string',
'keyName': 'string',
'instanceType': 'i4i.metal'|'i7i.metal-24xl',
'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) --
environmentSummary (dict) --
A summary of the environment that the host was deleted from.
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 (datetime) --
The date and time that the environment was created.
modifiedAt (datetime) --
The date and time that the environment was modified.
environmentArn (string) --
The Amazon Resource Name (ARN) that is associated with the environment.
host (dict) --
A description of the deleted 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.
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.
{'environment': {'checks': {'id': 'string',
'type': {'CONNECTOR_HEALTH',
'OPERATIONS_MANAGER_REACHABILITY',
'SDDC_MANAGER_HOST_COUNT',
'SDDC_MANAGER_KEY_COVERAGE',
'SDDC_MANAGER_KEY_REUSE',
'SDDC_MANAGER_REACHABILITY'}},
'vcfVersion': {'SELF_DEPLOYED'}}}
Returns a description of the specified environment.
See also: AWS API Documentation
Request Syntax
client.get_environment(
environmentId='string'
)
string
[REQUIRED]
A unique ID for the environment.
dict
Response Syntax
{
'environment': {
'environmentId': 'string',
'environmentState': 'CREATING'|'CREATED'|'DELETING'|'DELETED'|'CREATE_FAILED',
'stateDetails': 'string',
'createdAt': datetime(2015, 1, 1),
'modifiedAt': datetime(2015, 1, 1),
'environmentArn': 'string',
'environmentName': 'string',
'vpcId': 'string',
'serviceAccessSubnetId': 'string',
'vcfVersion': 'VCF-5.2.1'|'VCF-5.2.2'|'SELF_DEPLOYED',
'termsAccepted': True|False,
'licenseInfo': [
{
'solutionKey': 'string',
'vsanKey': 'string'
},
],
'siteId': 'string',
'environmentStatus': 'PASSED'|'FAILED'|'UNKNOWN',
'checks': [
{
'type': 'KEY_REUSE'|'KEY_COVERAGE'|'REACHABILITY'|'HOST_COUNT'|'VCENTER_REACHABILITY'|'VCENTER_VM_SYNC'|'VCENTER_VM_EVENT'|'OPERATIONS_MANAGER_REACHABILITY'|'SDDC_MANAGER_REACHABILITY'|'SDDC_MANAGER_HOST_COUNT'|'SDDC_MANAGER_KEY_COVERAGE'|'SDDC_MANAGER_KEY_REUSE'|'CONNECTOR_HEALTH',
'id': 'string',
'result': 'PASSED'|'FAILED'|'UNKNOWN',
'impairedSince': datetime(2015, 1, 1)
},
],
'connectivityInfo': {
'privateRouteServerPeerings': [
'string',
]
},
'vcfHostnames': {
'vCenter': 'string',
'nsx': 'string',
'nsxManager1': 'string',
'nsxManager2': 'string',
'nsxManager3': 'string',
'nsxEdge1': 'string',
'nsxEdge2': 'string',
'sddcManager': 'string',
'cloudBuilder': 'string'
},
'kmsKeyId': 'string',
'serviceAccessSecurityGroups': {
'securityGroups': [
'string',
]
},
'credentials': [
{
'secretArn': 'string'
},
]
}
}
Response Structure
(dict) --
environment (dict) --
A description of the requested environment.
environmentId (string) --
The unique ID for the environment.
environmentState (string) --
The state of an environment.
stateDetails (string) --
A detailed description of the environmentState of an environment.
createdAt (datetime) --
The date and time that the environment was created.
modifiedAt (datetime) --
The date and time that the environment was modified.
environmentArn (string) --
The Amazon Resource Name (ARN) that is associated with the environment.
environmentName (string) --
The name of the environment.
vpcId (string) --
The VPC associated with the environment.
serviceAccessSubnetId (string) --
The subnet that is used to establish connectivity between the Amazon EVS control plane and VPC. Amazon EVS uses this subnet to perform validations and create the environment.
vcfVersion (string) --
The VCF version of the environment.
termsAccepted (boolean) --
Customer confirmation that the customer has purchased and will continue to maintain the required number of VCF software licenses to cover all physical processor cores in the Amazon EVS environment. Information about your VCF software in Amazon EVS will be shared with Broadcom to verify license compliance. Amazon EVS does not validate license keys. To validate license keys, visit the Broadcom support portal.
licenseInfo (list) --
The license information that Amazon EVS requires to create an environment. Amazon EVS requires two license keys: a VCF solution key and a vSAN license key. The VCF solution key must meet minimum core requirements, and the vSAN license key must meet minimum capacity requirements for your selected instance type.
For information about minimum license requirements, see the VCF subscriptions section in the Amazon EVS User Guide.
(dict) --
The license information that Amazon EVS requires to create an environment. Amazon EVS requires two license keys: a VCF solution key and a vSAN license key.
solutionKey (string) --
The VCF solution key. This license unlocks VMware VCF product features, including vSphere, NSX, SDDC Manager, and vCenter Server. The VCF solution key must meet the instance-type-specific minimum core requirements.
vsanKey (string) --
The VSAN license key. This license unlocks vSAN features. The vSAN license key must meet the instance-type-specific minimum capacity requirements.
siteId (string) --
The Broadcom Site ID that is associated with your Amazon EVS environment. Amazon EVS uses the Broadcom Site ID that you provide to meet Broadcom VCF license usage reporting requirements for Amazon EVS.
environmentStatus (string) --
Reports impaired functionality that stems from issues internal to the environment, such as impaired reachability.
checks (list) --
A check on the environment to identify connector health.
(dict) --
A check on the environment to identify environment health and validate VMware VCF licensing compliance.
type (string) --
The check type. Amazon EVS performs the following checks:
KEY_REUSE: Verifies that the VCF license key is not used by another Amazon EVS environment.
KEY_COVERAGE: Verifies that the VCF license key allocates sufficient vCPU cores for all deployed hosts.
REACHABILITY: Verifies that the Amazon EVS control plane has a persistent connection to SDDC Manager.
HOST_COUNT: Verifies that the environment meets the minimum host count.
VCENTER_REACHABILITY: Verifies vCenter Server reachability through the vCenter connector.
VCENTER_VM_SYNC: Verifies that the vCenter connector can synchronize VM inventory from vCenter Server.
VCENTER_VM_EVENT: Verifies that the vCenter connector can receive VM lifecycle events from vCenter Server.
OPERATIONS_MANAGER_REACHABILITY: Verifies Operations Manager reachability through the Operations Manager connector.
SDDC_MANAGER_REACHABILITY: Verifies SDDC Manager reachability through the SDDC Manager connector.
SDDC_MANAGER_HOST_COUNT: Verifies that the host count reported by SDDC Manager meets Amazon EVS minimum requirements.
SDDC_MANAGER_KEY_COVERAGE: Verifies that the VCF license key configured in SDDC Manager covers all deployed hosts.
SDDC_MANAGER_KEY_REUSE: Verifies that the VCF license key configured in SDDC Manager is not used by another Amazon EVS environment.
CONNECTOR_HEALTH: Aggregate health across all connectors in the environment.
id (string) --
A unique ID for the check.
result (string) --
The check result.
impairedSince (datetime) --
The time when environment health began to be impaired.
connectivityInfo (dict) --
The connectivity configuration for the environment. Amazon EVS requires that you specify two route server peer IDs. During environment creation, the route server endpoints peer with the NSX uplink VLAN for connectivity to the NSX overlay network.
privateRouteServerPeerings (list) --
The unique IDs for private route server peers.
(string) --
vcfHostnames (dict) --
The DNS hostnames to be used by the VCF management appliances in your environment.
For environment creation to be successful, each hostname entry must resolve to a domain name that you've registered in your DNS service of choice and configured in the DHCP option set of your VPC. DNS hostnames cannot be changed after environment creation has started.
vCenter (string) --
The VMware vCenter hostname.
nsx (string) --
The VMware NSX Virtual IP (VIP) hostname.
nsxManager1 (string) --
The hostname for the first VMware NSX Manager virtual machine (VM).
nsxManager2 (string) --
The hostname for the second VMware NSX Manager virtual machine (VM).
nsxManager3 (string) --
The hostname for the third VMware NSX Manager virtual machine (VM).
nsxEdge1 (string) --
The hostname for the first NSX Edge node.
nsxEdge2 (string) --
The hostname for the second NSX Edge node.
sddcManager (string) --
The hostname for SDDC Manager.
cloudBuilder (string) --
The hostname for VMware Cloud Builder.
kmsKeyId (string) --
The Amazon Web Services KMS key ID that Amazon Web Services Secrets Manager uses to encrypt secrets that are associated with the environment. These secrets contain the VCF credentials that are needed to install vCenter Server, NSX, and SDDC Manager.
By default, Amazon EVS use the Amazon Web Services Secrets Manager managed key aws/secretsmanager. You can also specify a customer managed key.
serviceAccessSecurityGroups (dict) --
The security groups that allow traffic between the Amazon EVS control plane and your VPC for service access. If a security group is not specified, Amazon EVS uses the default security group in your account for service access.
securityGroups (list) --
The security groups that allow service access.
(string) --
credentials (list) --
The VCF credentials that are stored as Amazon EVS managed secrets in Amazon Web Services Secrets Manager.
Amazon EVS stores credentials that are needed to install vCenter Server, NSX, and SDDC Manager.
(dict) --
A managed secret that contains the credentials for installing vCenter Server, NSX, and SDDC Manager. During environment creation, the Amazon EVS control plane uses Amazon Web Services Secrets Manager to create, encrypt, validate, and store secrets. If you choose to delete your environment, Amazon EVS also deletes the secrets that are associated with your environment. Amazon EVS does not provide managed rotation of secrets. We recommend that you rotate secrets regularly to ensure that secrets are not long-lived.
secretArn (string) --
The Amazon Resource Name (ARN) of the secret.
{'vcfVersions': {'vcfVersion': {'SELF_DEPLOYED'}}}
Returns information about VCF versions, ESX versions and EC2 instance types provided by Amazon EVS. For each VCF version, the response also includes the default ESX version and provided EC2 instance types.
See also: AWS API Documentation
Request Syntax
client.get_versions()
dict
Response Syntax
{
'vcfVersions': [
{
'vcfVersion': 'VCF-5.2.1'|'VCF-5.2.2'|'SELF_DEPLOYED',
'status': 'string',
'defaultEsxVersion': 'string',
'instanceTypes': [
'i4i.metal'|'i7i.metal-24xl',
]
},
],
'instanceTypeEsxVersions': [
{
'instanceType': 'i4i.metal'|'i7i.metal-24xl',
'esxVersions': [
'string',
]
},
]
}
Response Structure
(dict) --
vcfVersions (list) --
A list of VCF versions with their availability status, default ESX version, and instance types.
(dict) --
Information about a VCF versions provided by Amazon EVS, including its status, default ESX version, and EC2 instance types.
vcfVersion (string) --
The VCF version number.
status (string) --
The status for this VCF version. Valid values are:
AVAILABLE - This VCF version is available to you.
RESTRICTED - This VCF version has limited availability.
defaultEsxVersion (string) --
The default ESX version for this VCF version. It is based on Broadcom's Bill Of Materials (BOM).
instanceTypes (list) --
EC2 instance types provided by Amazon EVS for this VCF version for creating environments.
(string) --
instanceTypeEsxVersions (list) --
A list of EC2 instance types and their available ESX versions.
(dict) --
Information about ESX versions offered for each EC2 instance type.
instanceType (string) --
The EC2 instance type.
esxVersions (list) --
The list of ESX versions offered for this instance type.
(string) --
{'connectors': {'checks': {'type': {'CONNECTOR_HEALTH',
'OPERATIONS_MANAGER_REACHABILITY',
'SDDC_MANAGER_HOST_COUNT',
'SDDC_MANAGER_KEY_COVERAGE',
'SDDC_MANAGER_KEY_REUSE',
'SDDC_MANAGER_REACHABILITY'}},
'type': {'OPERATIONS_MANAGER', 'SDDC_MANAGER'}}}
Lists the connectors within an environment. Returns the status of each connector and its applicable checks, among other connector details.
See also: AWS API Documentation
Request Syntax
client.list_environment_connectors(
nextToken='string',
maxResults=123,
environmentId='string'
)
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.
integer
The maximum number of results to return. If you specify MaxResults in the request, the response includes information up to the limit specified.
string
[REQUIRED]
A unique ID for the environment.
dict
Response Syntax
{
'nextToken': 'string',
'connectors': [
{
'environmentId': 'string',
'connectorId': 'string',
'type': 'OPERATIONS_MANAGER'|'SDDC_MANAGER'|'VCENTER',
'applianceFqdn': 'string',
'secretArn': 'string',
'state': 'CREATING'|'CREATE_FAILED'|'ACTIVE'|'UPDATING'|'UPDATE_FAILED'|'DELETING'|'DELETED',
'stateDetails': 'string',
'status': 'PASSED'|'FAILED'|'UNKNOWN',
'checks': [
{
'type': 'KEY_REUSE'|'KEY_COVERAGE'|'REACHABILITY'|'HOST_COUNT'|'VCENTER_REACHABILITY'|'VCENTER_VM_SYNC'|'VCENTER_VM_EVENT'|'OPERATIONS_MANAGER_REACHABILITY'|'SDDC_MANAGER_REACHABILITY'|'SDDC_MANAGER_HOST_COUNT'|'SDDC_MANAGER_KEY_COVERAGE'|'SDDC_MANAGER_KEY_REUSE'|'CONNECTOR_HEALTH',
'result': 'PASSED'|'FAILED'|'UNKNOWN',
'lastCheckAttempt': datetime(2015, 1, 1),
'impairedSince': datetime(2015, 1, 1)
},
],
'createdAt': datetime(2015, 1, 1),
'modifiedAt': datetime(2015, 1, 1)
},
]
}
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.
connectors (list) --
A list of connectors in the environment.
(dict) --
An object that represents a connector for an Amazon EVS environment. A connector establishes a connection to the given appliance type using the credentials stored in Amazon Web Services Secrets Manager.
environmentId (string) --
The unique ID of the environment that the connector belongs to.
connectorId (string) --
The unique ID of the connector.
type (string) --
The type of the connector.
applianceFqdn (string) --
The fully qualified domain name (FQDN) of the VCF appliance that the connector connects to.
secretArn (string) --
The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that stores the credentials for the VCF appliance.
state (string) --
The state of the connector.
stateDetails (string) --
A detailed description of the connector state.
status (string) --
The status of the connector.
checks (list) --
A list of checks that are run on the connector.
(dict) --
A check on a connector to identify connectivity health.
type (string) --
The check type.
result (string) --
The check result.
lastCheckAttempt (datetime) --
The date and time of the last check attempt.
impairedSince (datetime) --
The time when connector health began to be impaired.
createdAt (datetime) --
The date and time that the connector was created.
modifiedAt (datetime) --
The date and time that the connector was modified.
{'environmentSummaries': {'vcfVersion': {'SELF_DEPLOYED'}}}
Lists the Amazon EVS environments in your Amazon Web Services account in the specified Amazon Web Services Region.
See also: AWS API Documentation
Request Syntax
client.list_environments(
nextToken='string',
maxResults=123,
state=[
'CREATING'|'CREATED'|'DELETING'|'DELETED'|'CREATE_FAILED',
]
)
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.
integer
The maximum number of results to return. If you specify MaxResults in the request, the response includes information up to the limit specified.
list
The state of an environment. Used to filter response results to return only environments with the specified environmentState.
(string) --
dict
Response Syntax
{
'nextToken': 'string',
'environmentSummaries': [
{
'environmentId': 'string',
'environmentName': 'string',
'vcfVersion': 'VCF-5.2.1'|'VCF-5.2.2'|'SELF_DEPLOYED',
'environmentStatus': 'PASSED'|'FAILED'|'UNKNOWN',
'environmentState': 'CREATING'|'CREATED'|'DELETING'|'DELETED'|'CREATE_FAILED',
'createdAt': datetime(2015, 1, 1),
'modifiedAt': datetime(2015, 1, 1),
'environmentArn': '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.
environmentSummaries (list) --
A list of environments with summarized environment details.
(dict) --
A list of environments with summarized environment details.
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 (datetime) --
The date and time that the environment was created.
modifiedAt (datetime) --
The date and time that the environment was modified.
environmentArn (string) --
The Amazon Resource Name (ARN) that is associated with the environment.
{'connector': {'checks': {'type': {'CONNECTOR_HEALTH',
'OPERATIONS_MANAGER_REACHABILITY',
'SDDC_MANAGER_HOST_COUNT',
'SDDC_MANAGER_KEY_COVERAGE',
'SDDC_MANAGER_KEY_REUSE',
'SDDC_MANAGER_REACHABILITY'}},
'type': {'OPERATIONS_MANAGER', 'SDDC_MANAGER'}}}
Updates a connector for an Amazon EVS environment. You can update the Amazon Web Services Secrets Manager secret ARN or the appliance FQDN to reconfigure the connector metadata.
See also: AWS API Documentation
Request Syntax
client.update_environment_connector(
clientToken='string',
environmentId='string',
connectorId='string',
applianceFqdn='string',
secretIdentifier='string'
)
string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the connector update request. If you do not specify a client token, a randomly generated token is used for the request to ensure idempotency.
This field is autopopulated if not provided.
string
[REQUIRED]
A unique ID for the environment that the connector belongs to.
string
[REQUIRED]
A unique ID for the connector to update.
string
The new fully qualified domain name (FQDN) of the VCF appliance that the connector connects to.
string
The new ARN or name of the Amazon Web Services Secrets Manager secret that stores the credentials for the VCF appliance.
dict
Response Syntax
{
'connector': {
'environmentId': 'string',
'connectorId': 'string',
'type': 'OPERATIONS_MANAGER'|'SDDC_MANAGER'|'VCENTER',
'applianceFqdn': 'string',
'secretArn': 'string',
'state': 'CREATING'|'CREATE_FAILED'|'ACTIVE'|'UPDATING'|'UPDATE_FAILED'|'DELETING'|'DELETED',
'stateDetails': 'string',
'status': 'PASSED'|'FAILED'|'UNKNOWN',
'checks': [
{
'type': 'KEY_REUSE'|'KEY_COVERAGE'|'REACHABILITY'|'HOST_COUNT'|'VCENTER_REACHABILITY'|'VCENTER_VM_SYNC'|'VCENTER_VM_EVENT'|'OPERATIONS_MANAGER_REACHABILITY'|'SDDC_MANAGER_REACHABILITY'|'SDDC_MANAGER_HOST_COUNT'|'SDDC_MANAGER_KEY_COVERAGE'|'SDDC_MANAGER_KEY_REUSE'|'CONNECTOR_HEALTH',
'result': 'PASSED'|'FAILED'|'UNKNOWN',
'lastCheckAttempt': datetime(2015, 1, 1),
'impairedSince': datetime(2015, 1, 1)
},
],
'createdAt': datetime(2015, 1, 1),
'modifiedAt': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
connector (dict) --
A description of the updated connector.
environmentId (string) --
The unique ID of the environment that the connector belongs to.
connectorId (string) --
The unique ID of the connector.
type (string) --
The type of the connector.
applianceFqdn (string) --
The fully qualified domain name (FQDN) of the VCF appliance that the connector connects to.
secretArn (string) --
The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that stores the credentials for the VCF appliance.
state (string) --
The state of the connector.
stateDetails (string) --
A detailed description of the connector state.
status (string) --
The status of the connector.
checks (list) --
A list of checks that are run on the connector.
(dict) --
A check on a connector to identify connectivity health.
type (string) --
The check type.
result (string) --
The check result.
lastCheckAttempt (datetime) --
The date and time of the last check attempt.
impairedSince (datetime) --
The time when connector health began to be impaired.
createdAt (datetime) --
The date and time that the connector was created.
modifiedAt (datetime) --
The date and time that the connector was modified.