AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Amazon Elastic VMware Service CreateEnvironment API operation.

Syntax

New-EVSEnvironment
-EnvironmentName <String>
-EdgeVTep_Cidr <String>
-ExpansionVlan1_Cidr <String>
-ExpansionVlan2_Cidr <String>
-Hcx_Cidr <String>
-NsxUplink_Cidr <String>
-VmkManagement_Cidr <String>
-VmManagement_Cidr <String>
-VMotion_Cidr <String>
-VSan_Cidr <String>
-VTep_Cidr <String>
-VcfHostnames_CloudBuilder <String>
-Hosts <HostInfoForCreate[]>
-KmsKeyId <String>
-LicenseInfo <LicenseInfo[]>
-VcfHostnames_Nsx <String>
-VcfHostnames_NsxEdge1 <String>
-VcfHostnames_NsxEdge2 <String>
-VcfHostnames_NsxManager1 <String>
-VcfHostnames_NsxManager2 <String>
-VcfHostnames_NsxManager3 <String>
-ConnectivityInfo_PrivateRouteServerPeering <String[]>
-VcfHostnames_SddcManager <String>
-ServiceAccessSecurityGroups_SecurityGroup <String[]>
-ServiceAccessSubnetId <String>
-SiteId <String>
-Tag <Hashtable>
-TermsAccepted <Boolean>
-VcfHostnames_VCenter <String>
-VcfVersion <VcfVersion>
-VpcId <String>
-ClientToken <String>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonEvsConfig>

Description

Creates an Amazon EVS environment that runs VCF software, such as SDDC Manager, NSX Manager, and vCenter Server. During environment creation, Amazon EVS performs validations on DNS settings, provisions VLAN subnets and hosts, and deploys the supplied version of VCF. It can take several hours to create an environment. After the deployment completes, you can configure VCF in the vSphere user interface according to your needs. You cannot use the dedicatedHostId and placementGroupId parameters together in the same CreateEnvironment action. This results in a ValidationException response.

Parameters

-ClientConfig <AmazonEvsConfig>
Amazon.PowerShell.Cmdlets.EVS.AmazonEvsClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientToken <String>
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 environment creation request. If you do not specify a client token, a randomly generated token is used for the request to ensure idempotency.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConnectivityInfo_PrivateRouteServerPeering <String[]>
The unique IDs for private route server peers. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesConnectivityInfo_PrivateRouteServerPeerings
-EdgeVTep_Cidr <String>
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.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInitialVlans_EdgeVTep_Cidr
-EnvironmentName <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.
Required?False
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-ExpansionVlan1_Cidr <String>
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.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInitialVlans_ExpansionVlan1_Cidr
-ExpansionVlan2_Cidr <String>
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.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInitialVlans_ExpansionVlan2_Cidr
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Hcx_Cidr <String>
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.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInitialVlans_Hcx_Cidr
-Hosts <HostInfoForCreate[]>
The ESXi hosts to add to the environment. Amazon EVS requires that you provide details for a minimum of 4 hosts during environment creation.For each host, you must provide the desired hostname, EC2 SSH keypair name, and EC2 instance type. Optionally, you can also provide a partition or cluster placement group to use, or use Amazon EC2 Dedicated Hosts. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-KmsKeyId <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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-LicenseInfo <LicenseInfo[]>
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 cover a minimum of 256 cores. The vSAN license key must provide at least 110 TiB of vSAN capacity.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. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-NsxUplink_Cidr <String>
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.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInitialVlans_NsxUplink_Cidr
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'Environment'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Evs.Model.CreateEnvironmentResponse). Specifying the name of a property of type Amazon.Evs.Model.CreateEnvironmentResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ServiceAccessSecurityGroups_SecurityGroup <String[]>
The security groups that allow service access. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesServiceAccessSecurityGroups_SecurityGroups
-ServiceAccessSubnetId <String>
The subnet that is used to establish connectivity between the Amazon EVS control plane and VPC. Amazon EVS uses this subnet to validate mandatory DNS records for your VCF appliances and hosts and create the environment.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-SiteId <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.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Tag <Hashtable>
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. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTags
-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.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-VcfHostnames_CloudBuilder <String>
The hostname for VMware Cloud Builder.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-VcfHostnames_Nsx <String>
The VMware NSX hostname.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-VcfHostnames_NsxEdge1 <String>
The hostname for the first NSX Edge node.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-VcfHostnames_NsxEdge2 <String>
The hostname for the second NSX Edge node.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-VcfHostnames_NsxManager1 <String>
The hostname for the first VMware NSX Manager virtual machine (VM).
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-VcfHostnames_NsxManager2 <String>
The hostname for the second VMware NSX Manager virtual machine (VM).
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-VcfHostnames_NsxManager3 <String>
The hostname for the third VMware NSX Manager virtual machine (VM).
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-VcfHostnames_SddcManager <String>
The hostname for SDDC Manager.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-VcfHostnames_VCenter <String>
The VMware vCenter hostname.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-VcfVersion <VcfVersion>
The VCF version to use for the environment. Amazon EVS only supports VCF version 5.2.1 at this time.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-VmkManagement_Cidr <String>
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.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInitialVlans_VmkManagement_Cidr
-VmManagement_Cidr <String>
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.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInitialVlans_VmManagement_Cidr
-VMotion_Cidr <String>
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.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInitialVlans_VMotion_Cidr
-VpcId <String>
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.Ensure that you specify a VPC that is adequately sized to accommodate the {evws} subnets.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-VSan_Cidr <String>
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.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInitialVlans_VSan_Cidr
-VTep_Cidr <String>
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.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInitialVlans_VTep_Cidr

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

Amazon.Evs.Model.Environment or Amazon.Evs.Model.CreateEnvironmentResponse
This cmdlet returns an Amazon.Evs.Model.Environment object. The service call response (type Amazon.Evs.Model.CreateEnvironmentResponse) can be returned by specifying '-Select *'.
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z