User Input

The NSX Migration for VMware Cloud Director supports only VMware Cloud Director and NSX-T integrated authentication mechanisms. There are two example inputs YAML files with the NSX Migration for VMware Cloud Director:

  • userInput.yml: for precheck, migration, cleanup, and rollback
  • v2tAssessmentInput.yml: for assessment

This section provides information about each editable field within the input YAML files:

  1. Create the userInput.yml file with keys in the sampleUserInput.yml file and create the v2tAssessmentInput.yml file with keys in the samplev2tAssessmentInput.yml.
  2. Fill the data in the userInput.yml and v2tAssessmentInput.yml files as provided in the sampleUserInput.yml and samplev2tAssessmentInput.yml examples.

Global Fields in the userInput.yml file

Key Option Description Type Example
ipAddress Mandatory The IP address or FQDN of VMware Cloud Director. String 10.10.20.1 or vcdcell01.vmware.com
username Mandatory VMware Cloud Director system administrator login name. String administrator
verify Mandatory If set to True the tool validates the certificate. Boolean True,False
OrgName Mandatory Short name of the organization containing organization VDC to be migrated. String Acme
ImportedNetworkTransportZone Optional NSX-T VLAN transport zoneused for segment creation for imported networks. String Direct-TZ
DummyExternalNetwork Optional [Mandatory] if one or more edge gateways are present. Name of the dummy external network which will be temporarily attached to source edge gateway during network disconnection. String Dummy-ext-net
CloneOverlayIds Optional Flag to enable cloning of the overlay IDs (VNIs) of org vdc networks. Boolean True,False
EdgeClusterName Mandatory: If Routed or Isolated Organization VDC networks present. Optional: If only Direct Organization VDC networks are present. List of dedicated NSX-T Edge Clusters to be used for bridging. List * Bridge-edge-cluster1 * Bridge-edge-cluster2
NSX-T ipAddress Mandatory IP address or FQDN of NSX-T Data Center that is used for integration with VMware Cloud Director. String 10.196.235.14
NSX-T username Mandatory NSX-T administrator login name. String admin
NSX-T verify Mandatory Certificate validation enabled. Boolean True,False
NSX-V ipAddress Optional IP address or FQDN of NSX-V Manager. String 10.196.235.7
NSX-V username Optional NSX-V administrator login name. String admin
NSX-V verify Optional Certificate validation enabled. Boolean True,False
vCenter ipAddress Mandatory IP address or FQDN of vCenter server. String cpsbu-tpm-vcsa.eng.vmware.com
vCenter username Mandatory User name of vCenter Server. String administrator@vsphere.local
VCenter verify Mandatory Certificate validation enabled. Boolean True,False
CertificatePath Optional Signing CA or self- signed certificate path for certificates validation. String /root/vcdNSXMigrator/caCert.pem
MaxThreadCount Optional Number of threads to be used for parallel processing. Integer 75
TimeoutForVappMigration Optional Time out to be used for the vApp migration task in seconds Integer 3600

Organization VDC Specific Fields in the userInput.yml file

Key Option Description Type Example
OrgVDCName Mandatory Name of the source organization VDC. String Acme-1-vdc
NSXTProviderVDCName Mandatory Name of the target Provider VDC backed by NSX-T. String t-pVDC
Tier0Gateways Optional [Mandatory if one or more edge gateways are present] One-to-one map of edge gateway name to T0 gateway name. default key will be used to map all unlisted target NSX-T edge gateway to the default value. Dictionary EdgeGateway1: tpm-externalnetwork-1
EdgeGateway2: tpm-externalnetwork-2
default: tpm-externalnetwork-3
NSXTNetworkPoolName Optional Name of the NSX-T backed network pool to be used in the target Org VDC (optional and needed only if multiple Geneve network pools exist) String 2nd-t-network-pool
NoSnatDestinationSubnet Optional Prefixes that should be routed but not SNATed (used when internet and routed external networking is used at the same time). String 10.100.0.0/16
NSXVProviderVDCName Mandatory Name of the source Provider VDC backed by NSX-V. String v-pvdc
ServiceEngineGroupName Optional NSX ALB service engine group name to be used for load balancer configuration. String Tenant1
LoadBalancerVIPSubnet Optional Network subnet to be used for Virtual IP configuration of load balancer virtual service. This should be an internal non- overlapping subnet. DNAT rule will be automatically created to match the (external) source VIP IP address. String 192.168.255.128/28
EdgeGatewayDeploymentEdgeCluster Optional Name of the edge cluster to use for the edge gateway (Tier-1) deployment. String Edge-cluster1
AdvertiseRoutedNetworks Optional Option to advertise all the routed networks in NSX-T edge gateways. Dictionary EdgeGateway1: True
EdgeGateway2: True
default: False
LeagacyDirectNetworks Optional Option to use legacy mechanism for service direct network migration (Default: False) Boolean True,False
NonDistributedNetworks Optional Option to enable non distributed routing on all routed (via internal interface) Org VDC networks (Default: False) Boolean True,False

Fields in the v2tAssessmentInput.yml file

Key Option Description Type Example
ipAddress Mandatory IP address or FQDN of VMware Cloud Director. String 10.10.20.1 or vcdcell01.vmware.com
username Mandatory Enter the User name. String administrator
verify Mandatory If set to True the tool validates the certificate. Boolean True,False
OrgVDC Optional List of NSX-V backed organization VDC(s) to be assessed. If you need to specify organization of the org vdc (in case the Org VDC name is not unique), use the following naming convention : List test-vdc-1: Acme-27
test-vdc-1
test-vdc-2
Organization Optional List of organizations to be evaluated. List Acme-27

Note * In the `v2tAssessmentInput.yml` file, if both **OrgVDC** and Organization values are provided, then only the listed OrgVDCs will be validated (and the provided Organization value will be ignored). * If both the sections i.e., Organization and OrgVDC are left blank, then all the existing NSX Data Center for vSphere backed organization VDCs for the provided VMware Cloud Director will be evaluated.

check-circle-line exclamation-circle-line close-line
Scroll to top icon