1. Overview

VMware Cloud Foundation API Reference Guide

1.1. Contact information

Contact : http://www.vmware.com/

1.2. License information

License : VMware Cloud Foundation
Terms of service : http://www.vmware.com/

1.3. URI scheme

Host : sddc-manager.sfo01.rainpole.local
BasePath : /
Schemes : HTTPS

1.4. Tags

  • BackupRestore : APIs for managing Backups and Restore

  • Bundles : APIs for managing Bundles

  • CEIP : APIs for managing CEIP status

  • Certificates : APIs for managing Certificates

  • Clusters : APIs for managing Clusters

  • Credentials : APIs for managing Credentials

  • DepotSettings : APIs for managing Depot Settings

  • Domains : APIs for managing Domains

  • Federation : Federation Rest Controller

  • HorizonManager : Horizon V 1 Controller

  • Hosts : APIs for managing Hosts

  • License Keys : APIs for managing License Keys

  • Members : Member Rest Controller

  • MembershipToken : Membership Token Rest Controller

  • NSX-T Clusters : APIs for managing NSX-T Clusters

  • Network Pools : APIs for managing Network Pools

  • NsxManagers : APIs for NsxManagers

  • PKS : APIs for managing PKS

  • PSCs : APIs for managing PSCs

  • Progress : Request Progress Rest Controller

  • SDDC : APIs for managing SDDC

  • SddcManagers : APIs for managing Sddc Managers

  • System : APIs for managing CEIP status

  • SystemPrechecks : APIs for managing System Prechecks

  • Tasks : APIs for managing Tasks

  • Upgradables : APIs for managing Upgradables

  • Upgrades : APIs for managing Upgrades

  • VcfServices : APIs for managing VCF Services

  • vCenters : APIs for vCenters

  • vRLI : APIs for managing vRealize Log Insight

  • vROPs : APIs for managing vRealize Operations

  • vRSLCM : APIs for managing vRealize Suite Lifecycle Manager

1.5. API Versioning

  • API versioning is at the granularity of each resource.

  • API versioning is similar to URI versioning so that it is explicit i.e all APIs have the "/<version>/" prefix.

  • API version is independent of the product version and will evolve independently.

Tip
 Reference APIs using the full path i.e "/v1/hosts" so that any future changes can be localized to a small scope in the automation code. This ensures that when the API version is incremented, you only need to update the references to the old APIs (which are now marked as deprecated) with the new APIs
Note

  • An illustration of API versioning is shown in the table below.

  • The illustration assumes that the product version is incremented from N to N+1, N+2 and so on.

  • The API version is only incremented when there are backward incompatible changes.

  • The older version of the APIs are deprecated when the version is incremented.
Product Version APIs

Product Version N

  • /v1/hosts

  • /v1/domains

  • /v1/clusters

Product Version N+1

  • /v1/hosts

  • /v1/domains (Deprecated)

  • /v2/domains

  • /v1/clusters

Product Version N+2

  • /v1/hosts (Deprecated)

  • /v2/hosts

  • /v1/domains (Deprecated)

  • /v2/domains

  • /v1/clusters

Product Version N+3

  • /v1/hosts (Deprecated)

  • /v2/hosts (Deprecated)

  • /v3/hosts

  • /v1/domains (Deprecated)

  • /v2/domains

  • /v1/clusters

1.6. Security

1.6.1. Overview

  • All APIs are secured and need a username and password for invocation

  • The username and password are sent using Basic Authentication scheme

  • To invoke the APIs, SDDC Manager "admin" and its password is required.

Tip
 For security reasons, you should periodically update the password for this account.

  • To use more secured APIs like Get the Credentials, Update or rotate passwords for a list of resources, Retry a failed credentials task for a given ID, dual authentication is required. A privileged user has to be created in management domain vCenter and associated to group "Sddc_Secured_Access". Along with "admin" account, Privileged user credentials has to be passed in request headers("privileged-username" and "privileged-password") of secured APIs in plain text. Please refer VMware Cloud Foundation Operations and Administration Guide for setting up privileged user.

  • Please note, using [email protected] user as privileged user is not allowed.

  • If you write a script that invokes the APIs, the script should either prompt the user to enter the password for the "admin" account or should accept the password as a command line option. TAs a best practice, you should not encode the password for the account in the script code itself.

  • Script should also accept privileged user credentials if the script is invoking any secured APIs defined above.

1.6.2. Changing the "admin" account password

You can follow the below steps to change the password for the "admin" account

  • SSH in to the SDDC Manager VM, login as "vcf" user.

  • Enter su to switch to the "root" user.

  • Enter the following command:

/opt/vmware/vcf/commonsvcs/scripts/auth/set-basicauth-password.sh admin <password>

  • For <password>, enter the new password to associate with the admin account.

Password requirements:

  • Length: 8-12 characters

  • Must include: mix of upper-case and lower-case letters a number a special character such as @ ! # $ % ^ or ?

  • Cannot include: * { } [ ] ( ) / \ ' " ` ~ , ; : . < >

2. Usecases

2.1. SDDCs

2.1.1. Create a SDDC

The Create a Domain workflow automatically:

  • Configures networking on each host.

  • Configures vSAN or NFS storage on the hosts.

  • Deploys and configures the management stack - vCenter, PSC and NSX

  • Deploys and configures the vRealize stack - vRealize Lifecycle Manager, vRealize LogInsight, vRealize Operations Manager, vRealize Automation, vRealize Business

  • Deploys and configures Site Recovery Manager and vSphere Replication for Disaster recovery purposes

  • Deploys and configures SDDC Manager which provides the ability to perform Day 2 operations

Prerequisites
Note
 The username and password for Basic Authentication scheme using the Cloud Builder "admin" account.
The host in example requests is Cloud Builder address e.g. "sfo01cb01.sfo01.rainpole.local" not the SDDC Manager one.

  1. The following data is required

    • ID of the SDDC instance

    • List of host details

Tip
 Refer to: SddcHostSpec.

  • vCenter details

Tip
 Refer to: SddcVcenterSpec.

  • Cluster details

Tip
 Refer to: SddcClusterSpec.

  • List of Distributed Virtual Switches' details

Tip
 Refer to: DvsSpec.

  • List of networks' details

Tip
 Refer to: SddcNetworkSpec.

  • DNS details

Tip
 Refer to: DnsSpec.

  • List of NTP servers

  1. The following data is optional

    • Name of the task to execute

    • vSAN details

Tip
 Refer to: VsanSpec.

  • NSX details

Tip
 Refer to: NsxSpec.

  • SDDC Manager details

Tip
 Refer to: SddcManagerSpec.

  • List of PSC’s details

Tip
 Refer to: PscSpec.

  • vRealize LogInsight details

Tip
 Refer to: SddcVrliDeploymentSpec.

  • VxManager details

Tip
 Refer to: VxManagerSpec.

  • Name of network pool associated with the management domain

  • List of names of the components to be excluded

  • Version of the Distributed Virtual Switch

  • Boolean to identify if Customer Experience Improvement Program is to be enabled

  • PSC loadbalancer hostname

Note
 The hostname must not include the domain. Instead the subDomain property from the DNS spec will be used to for the fully-qualified domain name.

  • PSC loadbalancer IP address

Note
 This address must be from the management network address range.

  • Active Directory details

Tip
 Refer to: AdSpec.

  • Name of the NFS datastore

  • Site Recovery Manager details

Tip
 Refer to: SrmSpec.

  • vSphere Replication details

Tip
 Refer to: VsphereReplicationSpec.

  • vRealize Automation details

Tip
 Refer to: SddcVraDeploymentSpec.

  • Remote Site details

Tip
 Refer to: RemoteSiteSpec.

  • vRealize Operation Manager details

Tip
 Refer to: SddcVropsDeploymentSpec.

  • vRealize Business details

Tip
 Refer to: SddcVrbDeploymentSpec.

  • SMTP details

Tip
 Refer to: SmtpSpec.

  • Passphrase for the certificates to be used for PSC, vCenter, NSX, vRealize Automation and vRealize Operation Manager

  • License for the ESXi hosts

  • vRealize Lifecycle Manager details

Tip
 Refer to: SddcVrslcmDeploymentSpec.

  • vSphere deployment endpoint details

Tip
 Refer to: VsphereDeploymentEndpointSpec.

  • VxRail environment details

Tip
 Refer to: VxRailSpec.

  • UMDS details

Tip
 Refer to: UmdsSpec.

  • Boolean to identify if ESXi thumbprint validation is to be skipped

  • Modules with self-signed certificates

Note
 Leave it empty if no self-signed certificate, add ALL or comma separated list of components otherwise. Initial valid values: ALL, VRA, SRM, NSX, VR, PSC, VC, VROPS, VRSLCM, LI, VRB.

  • Boolean to identify if vSAN should be cleaned up

Note
 Should be true only if this is the very first run
Steps

  1. Validate the input specification.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/sddcs/validations' -i -u 'admin:VMwareInfra@1' -X POST \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json' \
    -d '{
  "skipEsxThumbprintValidation" : true,
  "managementPoolName" : "bringup-networkpool",
  "sddcManagerSpec" : {
    "secondUserCredentials" : {
      "username" : "vcf",
      "password" : "VMware123!"
    },
    "ipAddress" : "10.0.0.4",
    "netmask" : "255.255.255.0",
    "hostname" : "sddc-manager",
    "rootUserCredentials" : {
      "username" : "root",
      "password" : "VMware123!"
    },
    "restApiCredentials" : {
      "username" : "admin",
      "password" : "VMware123!"
    }
  },
  "sddcId" : "sddcId-public-api-05",
  "esxLicense" : "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
  "taskName" : "workflowconfig/workflowspec-ems.json",
  "ntpServers" : [ "10.0.0.250" ],
  "dnsSpec" : {
    "subdomain" : "vrack.vsphere.local",
    "domain" : "vsphere.local",
    "nameserver" : "10.0.0.250",
    "secondaryNameserver" : "10.0.0.250"
  },
  "networkSpecs" : [ {
    "subnet" : "10.0.0.0/22",
    "vlanId" : "0",
    "mtu" : "1500",
    "networkType" : "MANAGEMENT",
    "gateway" : "10.0.0.250"
  }, {
    "subnet" : "10.0.4.0/24",
    "includeIpAddressRanges" : [ {
      "startIpAddress" : "10.0.4.7",
      "endIpAddress" : "10.0.4.48"
    }, {
      "startIpAddress" : "10.0.4.3",
      "endIpAddress" : "10.0.4.6"
    } ],
    "includeIpAddress" : [ "10.0.4.50", "10.0.4.49" ],
    "vlanId" : "0",
    "mtu" : "8940",
    "networkType" : "VSAN",
    "gateway" : "10.0.4.253"
  }, {
    "subnet" : "10.0.8.0/24",
    "includeIpAddressRanges" : [ {
      "startIpAddress" : "10.0.8.3",
      "endIpAddress" : "10.0.8.50"
    } ],
    "vlanId" : "0",
    "mtu" : "8940",
    "networkType" : "VMOTION",
    "gateway" : "10.0.8.253"
  } ],
  "nsxSpec" : {
    "nsxId" : "sfo01m01nsx01",
    "nsxManagerIp" : "10.0.0.9",
    "nsxManagerHostname" : "nsxManager",
    "nsxSegmentRangeBegin" : "5000",
    "nsxSegmentRangeEnd" : "5200",
    "multicastRangeBegin" : "239.1.0.0",
    "multicastRangeEnd" : "239.1.255.255",
    "license" : "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
    "adminNsxManagerPassword" : "VMware1!",
    "privilegedNsxManagerPassword" : "VMware123!",
    "adminNsxControllerPassword" : "VMware1234567!",
    "nsxVxlanSpec" : {
      "vxlanCluster" : "SDDC-Cluster1",
      "vxlanDvs" : "SDDC-Dswitch-Private",
      "vxlanVlanId" : "0",
      "vxlanMtu" : "8940",
      "vtepVmknicCount" : 2
    },
    "controllerIPPoolSpec" : {
      "poolName" : "sfo01-mgmt01-nsxc01",
      "startIp" : "10.0.0.40",
      "endIp" : "10.0.0.42",
      "prefix" : "22",
      "defaultGateway" : "10.0.0.250"
    }
  },
  "vsanSpec" : {
    "vsanName" : "vsan-1",
    "licenseFile" : "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
    "datastoreName" : "sfo01-m01-vsan"
  },
  "dvsSpecs" : [ {
    "mtu" : 8940,
    "niocSpec" : [ {
      "trafficType" : "VSAN",
      "value" : "HIGH"
    }, {
      "trafficType" : "VMOTION",
      "value" : "LOW"
    }, {
      "trafficType" : "VDP",
      "value" : "LOW"
    }, {
      "trafficType" : "VIRTUALMACHINE",
      "value" : "HIGH"
    }, {
      "trafficType" : "MANAGEMENT",
      "value" : "NORMAL"
    }, {
      "trafficType" : "NFS",
      "value" : "LOW"
    }, {
      "trafficType" : "HBR",
      "value" : "LOW"
    }, {
      "trafficType" : "FAULTTOLERANCE",
      "value" : "LOW"
    }, {
      "trafficType" : "ISCSI",
      "value" : "LOW"
    } ],
    "dvsName" : "SDDC-Dswitch-Private",
    "vmnics" : [ "vmnic0", "vmnic1" ],
    "networks" : [ "MANAGEMENT", "VSAN", "VMOTION" ]
  } ],
  "clusterSpec" : {
    "clusterName" : "SDDC-Cluster1",
    "clusterEvcMode" : "",
    "resourcePoolSpecs" : [ {
      "cpuSharesLevel" : "high",
      "cpuSharesValue" : 0,
      "name" : "Mgmt-ResourcePool",
      "memorySharesValue" : 0,
      "cpuReservationPercentage" : 0,
      "memoryLimit" : -1,
      "memoryReservationPercentage" : 0,
      "cpuReservationExpandable" : true,
      "memoryReservationExpandable" : true,
      "memorySharesLevel" : "normal",
      "cpuLimit" : -1,
      "type" : "management"
    }, {
      "cpuSharesLevel" : "high",
      "cpuSharesValue" : 0,
      "name" : "Network-ResourcePool",
      "memorySharesValue" : 0,
      "cpuReservationPercentage" : 0,
      "memoryLimit" : -1,
      "memoryReservationPercentage" : 0,
      "cpuReservationExpandable" : true,
      "memoryReservationExpandable" : true,
      "memorySharesLevel" : "normal",
      "cpuLimit" : -1,
      "type" : "network"
    }, {
      "cpuSharesLevel" : "normal",
      "cpuSharesValue" : 0,
      "name" : "Compute-ResourcePool",
      "memorySharesValue" : 0,
      "cpuReservationPercentage" : 0,
      "memoryLimit" : -1,
      "memoryReservationPercentage" : 0,
      "cpuReservationExpandable" : true,
      "memoryReservationExpandable" : true,
      "memorySharesLevel" : "normal",
      "cpuLimit" : -1,
      "type" : "compute"
    }, {
      "name" : "User-RP",
      "type" : "compute",
      "cpuReservationPercentage" : 0,
      "cpuLimit" : -1,
      "cpuReservationExpandable" : true,
      "cpuSharesLevel" : "normal",
      "cpuSharesValue" : 0,
      "memoryReservationPercentage" : 0,
      "memoryLimit" : -1,
      "memoryReservationExpandable" : true,
      "memorySharesLevel" : "normal",
      "memorySharesValue" : 0
    } ]
  },
  "pscSpecs" : [ {
    "pscId" : "psc-1",
    "rootPscPassword" : "VMware123!",
    "automationUserSsoPassword" : "VMware123!",
    "automationUserSsoUsername" : "automationuser",
    "pscIp" : "10.0.0.5",
    "pscHostName" : "psc-1",
    "pscSsoSpec" : {
      "ssoSiteName" : "vmwvcf2",
      "ssoDomain" : "vsphere.local",
      "isJoinSsoDomain" : false
    },
    "adminUserSsoPassword" : "VMware123!"
  }, {
    "pscId" : "psc-2",
    "rootPscPassword" : "VMware123!",
    "automationUserSsoPassword" : "VMware123!",
    "automationUserSsoUsername" : "automationuser",
    "pscIp" : "10.0.0.7",
    "pscHostName" : "psc-2",
    "pscSsoSpec" : {
      "replicationPartner" : "psc-1",
      "ssoSiteName" : "vmwvcf2",
      "ssoDomainPassword" : "VMware123!",
      "ssoDomain" : "vsphere.local",
      "isJoinSsoDomain" : false
    },
    "adminUserSsoPassword" : "VMware123!"
  } ],
  "vcenterSpec" : {
    "vcenterIp" : "10.0.0.6",
    "vcenterHostname" : "vcenter-1",
    "licenseFile" : "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
    "rootVcenterPassword" : "VMware1!",
    "vmSize" : "tiny"
  },
  "hostSpecs" : [ {
    "credentials" : {
      "username" : "root",
      "password" : "EvoSddc!2016"
    },
    "ipAddressPrivate" : {
      "subnet" : "255.255.252.0",
      "cidr" : "",
      "ipAddress" : "10.0.0.100",
      "gateway" : "10.0.0.250"
    },
    "hostname" : "esxi-1",
    "vSwitch" : "vSwitch0",
    "serverId" : "host-0",
    "association" : "SDDC-Datacenter"
  }, {
    "credentials" : {
      "username" : "root",
      "password" : "EvoSddc!2016"
    },
    "ipAddressPrivate" : {
      "subnet" : "255.255.252.0",
      "cidr" : "",
      "ipAddress" : "10.0.0.101",
      "gateway" : "10.0.0.250"
    },
    "hostname" : "esxi-2",
    "vSwitch" : "vSwitch0",
    "serverId" : "host-1",
    "association" : "SDDC-Datacenter"
  }, {
    "credentials" : {
      "username" : "root",
      "password" : "EvoSddc!2016"
    },
    "ipAddressPrivate" : {
      "subnet" : "255.255.255.0",
      "cidr" : "",
      "ipAddress" : "10.0.0.102",
      "gateway" : "10.0.0.250"
    },
    "hostname" : "esxi-3",
    "vSwitch" : "vSwitch0",
    "serverId" : "host-2",
    "association" : "SDDC-Datacenter"
  }, {
    "credentials" : {
      "username" : "root",
      "password" : "EvoSddc!2016"
    },
    "ipAddressPrivate" : {
      "subnet" : "255.255.255.0",
      "cidr" : "",
      "ipAddress" : "10.0.0.103",
      "gateway" : "10.0.0.250"
    },
    "hostname" : "esxi-4",
    "vSwitch" : "vSwitch0",
    "serverId" : "host-3",
    "association" : "SDDC-Datacenter"
  } ],
  "vrliDeploymentSpec" : {
    "adminPassword" : "VMware1234!",
    "sshPassword" : "VMware12345!",
    "vmSize" : "small",
    "loadBalancerHostname" : "load-balancer",
    "loadBalancerIpAddress" : "10.0.0.15",
    "vrliNodeSpecs" : [ {
      "ipAddress" : "10.0.0.16",
      "hostname" : "loginsight-node-1"
    }, {
      "ipAddress" : "10.0.0.17",
      "hostname" : "loginsight-node-2"
    }, {
      "ipAddress" : "10.0.0.18",
      "hostname" : "loginsight-node-3"
    } ]
  }
}'

HTTP Request

POST /v1/sddcs/validations HTTP/1.1
Accept: application/json
Host: sddc-manager.sfo01.rainpole.local
Content-Length: 8293
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==
Content-Type: application/json

{
  "skipEsxThumbprintValidation" : true,
  "managementPoolName" : "bringup-networkpool",
  "sddcManagerSpec" : {
    "secondUserCredentials" : {
      "username" : "vcf",
      "password" : "VMware123!"
    },
    "ipAddress" : "10.0.0.4",
    "netmask" : "255.255.255.0",
    "hostname" : "sddc-manager",
    "rootUserCredentials" : {
      "username" : "root",
      "password" : "VMware123!"
    },
    "restApiCredentials" : {
      "username" : "admin",
      "password" : "VMware123!"
    }
  },
  "sddcId" : "sddcId-public-api-05",
  "esxLicense" : "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
  "taskName" : "workflowconfig/workflowspec-ems.json",
  "ntpServers" : [ "10.0.0.250" ],
  "dnsSpec" : {
    "subdomain" : "vrack.vsphere.local",
    "domain" : "vsphere.local",
    "nameserver" : "10.0.0.250",
    "secondaryNameserver" : "10.0.0.250"
  },
  "networkSpecs" : [ {
    "subnet" : "10.0.0.0/22",
    "vlanId" : "0",
    "mtu" : "1500",
    "networkType" : "MANAGEMENT",
    "gateway" : "10.0.0.250"
  }, {
    "subnet" : "10.0.4.0/24",
    "includeIpAddressRanges" : [ {
      "startIpAddress" : "10.0.4.7",
      "endIpAddress" : "10.0.4.48"
    }, {
      "startIpAddress" : "10.0.4.3",
      "endIpAddress" : "10.0.4.6"
    } ],
    "includeIpAddress" : [ "10.0.4.50", "10.0.4.49" ],
    "vlanId" : "0",
    "mtu" : "8940",
    "networkType" : "VSAN",
    "gateway" : "10.0.4.253"
  }, {
    "subnet" : "10.0.8.0/24",
    "includeIpAddressRanges" : [ {
      "startIpAddress" : "10.0.8.3",
      "endIpAddress" : "10.0.8.50"
    } ],
    "vlanId" : "0",
    "mtu" : "8940",
    "networkType" : "VMOTION",
    "gateway" : "10.0.8.253"
  } ],
  "nsxSpec" : {
    "nsxId" : "sfo01m01nsx01",
    "nsxManagerIp" : "10.0.0.9",
    "nsxManagerHostname" : "nsxManager",
    "nsxSegmentRangeBegin" : "5000",
    "nsxSegmentRangeEnd" : "5200",
    "multicastRangeBegin" : "239.1.0.0",
    "multicastRangeEnd" : "239.1.255.255",
    "license" : "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
    "adminNsxManagerPassword" : "VMware1!",
    "privilegedNsxManagerPassword" : "VMware123!",
    "adminNsxControllerPassword" : "VMware1234567!",
    "nsxVxlanSpec" : {
      "vxlanCluster" : "SDDC-Cluster1",
      "vxlanDvs" : "SDDC-Dswitch-Private",
      "vxlanVlanId" : "0",
      "vxlanMtu" : "8940",
      "vtepVmknicCount" : 2
    },
    "controllerIPPoolSpec" : {
      "poolName" : "sfo01-mgmt01-nsxc01",
      "startIp" : "10.0.0.40",
      "endIp" : "10.0.0.42",
      "prefix" : "22",
      "defaultGateway" : "10.0.0.250"
    }
  },
  "vsanSpec" : {
    "vsanName" : "vsan-1",
    "licenseFile" : "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
    "datastoreName" : "sfo01-m01-vsan"
  },
  "dvsSpecs" : [ {
    "mtu" : 8940,
    "niocSpec" : [ {
      "trafficType" : "VSAN",
      "value" : "HIGH"
    }, {
      "trafficType" : "VMOTION",
      "value" : "LOW"
    }, {
      "trafficType" : "VDP",
      "value" : "LOW"
    }, {
      "trafficType" : "VIRTUALMACHINE",
      "value" : "HIGH"
    }, {
      "trafficType" : "MANAGEMENT",
      "value" : "NORMAL"
    }, {
      "trafficType" : "NFS",
      "value" : "LOW"
    }, {
      "trafficType" : "HBR",
      "value" : "LOW"
    }, {
      "trafficType" : "FAULTTOLERANCE",
      "value" : "LOW"
    }, {
      "trafficType" : "ISCSI",
      "value" : "LOW"
    } ],
    "dvsName" : "SDDC-Dswitch-Private",
    "vmnics" : [ "vmnic0", "vmnic1" ],
    "networks" : [ "MANAGEMENT", "VSAN", "VMOTION" ]
  } ],
  "clusterSpec" : {
    "clusterName" : "SDDC-Cluster1",
    "clusterEvcMode" : "",
    "resourcePoolSpecs" : [ {
      "cpuSharesLevel" : "high",
      "cpuSharesValue" : 0,
      "name" : "Mgmt-ResourcePool",
      "memorySharesValue" : 0,
      "cpuReservationPercentage" : 0,
      "memoryLimit" : -1,
      "memoryReservationPercentage" : 0,
      "cpuReservationExpandable" : true,
      "memoryReservationExpandable" : true,
      "memorySharesLevel" : "normal",
      "cpuLimit" : -1,
      "type" : "management"
    }, {
      "cpuSharesLevel" : "high",
      "cpuSharesValue" : 0,
      "name" : "Network-ResourcePool",
      "memorySharesValue" : 0,
      "cpuReservationPercentage" : 0,
      "memoryLimit" : -1,
      "memoryReservationPercentage" : 0,
      "cpuReservationExpandable" : true,
      "memoryReservationExpandable" : true,
      "memorySharesLevel" : "normal",
      "cpuLimit" : -1,
      "type" : "network"
    }, {
      "cpuSharesLevel" : "normal",
      "cpuSharesValue" : 0,
      "name" : "Compute-ResourcePool",
      "memorySharesValue" : 0,
      "cpuReservationPercentage" : 0,
      "memoryLimit" : -1,
      "memoryReservationPercentage" : 0,
      "cpuReservationExpandable" : true,
      "memoryReservationExpandable" : true,
      "memorySharesLevel" : "normal",
      "cpuLimit" : -1,
      "type" : "compute"
    }, {
      "name" : "User-RP",
      "type" : "compute",
      "cpuReservationPercentage" : 0,
      "cpuLimit" : -1,
      "cpuReservationExpandable" : true,
      "cpuSharesLevel" : "normal",
      "cpuSharesValue" : 0,
      "memoryReservationPercentage" : 0,
      "memoryLimit" : -1,
      "memoryReservationExpandable" : true,
      "memorySharesLevel" : "normal",
      "memorySharesValue" : 0
    } ]
  },
  "pscSpecs" : [ {
    "pscId" : "psc-1",
    "rootPscPassword" : "VMware123!",
    "automationUserSsoPassword" : "VMware123!",
    "automationUserSsoUsername" : "automationuser",
    "pscIp" : "10.0.0.5",
    "pscHostName" : "psc-1",
    "pscSsoSpec" : {
      "ssoSiteName" : "vmwvcf2",
      "ssoDomain" : "vsphere.local",
      "isJoinSsoDomain" : false
    },
    "adminUserSsoPassword" : "VMware123!"
  }, {
    "pscId" : "psc-2",
    "rootPscPassword" : "VMware123!",
    "automationUserSsoPassword" : "VMware123!",
    "automationUserSsoUsername" : "automationuser",
    "pscIp" : "10.0.0.7",
    "pscHostName" : "psc-2",
    "pscSsoSpec" : {
      "replicationPartner" : "psc-1",
      "ssoSiteName" : "vmwvcf2",
      "ssoDomainPassword" : "VMware123!",
      "ssoDomain" : "vsphere.local",
      "isJoinSsoDomain" : false
    },
    "adminUserSsoPassword" : "VMware123!"
  } ],
  "vcenterSpec" : {
    "vcenterIp" : "10.0.0.6",
    "vcenterHostname" : "vcenter-1",
    "licenseFile" : "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
    "rootVcenterPassword" : "VMware1!",
    "vmSize" : "tiny"
  },
  "hostSpecs" : [ {
    "credentials" : {
      "username" : "root",
      "password" : "EvoSddc!2016"
    },
    "ipAddressPrivate" : {
      "subnet" : "255.255.252.0",
      "cidr" : "",
      "ipAddress" : "10.0.0.100",
      "gateway" : "10.0.0.250"
    },
    "hostname" : "esxi-1",
    "vSwitch" : "vSwitch0",
    "serverId" : "host-0",
    "association" : "SDDC-Datacenter"
  }, {
    "credentials" : {
      "username" : "root",
      "password" : "EvoSddc!2016"
    },
    "ipAddressPrivate" : {
      "subnet" : "255.255.252.0",
      "cidr" : "",
      "ipAddress" : "10.0.0.101",
      "gateway" : "10.0.0.250"
    },
    "hostname" : "esxi-2",
    "vSwitch" : "vSwitch0",
    "serverId" : "host-1",
    "association" : "SDDC-Datacenter"
  }, {
    "credentials" : {
      "username" : "root",
      "password" : "EvoSddc!2016"
    },
    "ipAddressPrivate" : {
      "subnet" : "255.255.255.0",
      "cidr" : "",
      "ipAddress" : "10.0.0.102",
      "gateway" : "10.0.0.250"
    },
    "hostname" : "esxi-3",
    "vSwitch" : "vSwitch0",
    "serverId" : "host-2",
    "association" : "SDDC-Datacenter"
  }, {
    "credentials" : {
      "username" : "root",
      "password" : "EvoSddc!2016"
    },
    "ipAddressPrivate" : {
      "subnet" : "255.255.255.0",
      "cidr" : "",
      "ipAddress" : "10.0.0.103",
      "gateway" : "10.0.0.250"
    },
    "hostname" : "esxi-4",
    "vSwitch" : "vSwitch0",
    "serverId" : "host-3",
    "association" : "SDDC-Datacenter"
  } ],
  "vrliDeploymentSpec" : {
    "adminPassword" : "VMware1234!",
    "sshPassword" : "VMware12345!",
    "vmSize" : "small",
    "loadBalancerHostname" : "load-balancer",
    "loadBalancerIpAddress" : "10.0.0.15",
    "vrliNodeSpecs" : [ {
      "ipAddress" : "10.0.0.16",
      "hostname" : "loginsight-node-1"
    }, {
      "ipAddress" : "10.0.0.17",
      "hostname" : "loginsight-node-2"
    }, {
      "ipAddress" : "10.0.0.18",
      "hostname" : "loginsight-node-3"
    } ]
  }
}

HTTP Response

HTTP/1.1 202 Accepted
Content-Length: 1753
Content-Type: application/json;charset=UTF-8

{
  "id" : "26c27804-f837-4e4f-b50f-1625af792f0f",
  "executionStatus" : "COMPLETED",
  "validationChecks" : [ {
    "description" : "JSON Spec Validations",
    "resultStatus" : "SUCCEEDED",
    "errorResponse" : {
      "message" : ""
    }
  }, {
    "description" : "Password Validation",
    "resultStatus" : "SUCCEEDED",
    "errorResponse" : {
      "message" : ""
    }
  }, {
    "description" : "Cloud Builder Readiness",
    "resultStatus" : "SUCCEEDED",
    "errorResponse" : {
      "message" : ""
    }
  }, {
    "description" : "vSAN Disk Availability (Hybrid)",
    "resultStatus" : "SUCCEEDED",
    "errorResponse" : {
      "message" : ""
    }
  }, {
    "description" : "Network Ip Pools",
    "resultStatus" : "SUCCEEDED",
    "errorResponse" : {
      "message" : ""
    }
  }, {
    "description" : "ESXi Host Version",
    "resultStatus" : "SUCCEEDED",
    "errorResponse" : {
      "message" : ""
    }
  }, {
    "description" : "License Key Format",
    "resultStatus" : "SUCCEEDED",
    "errorResponse" : {
      "message" : ""
    }
  }, {
    "description" : "ESXi Host Readiness",
    "resultStatus" : "SUCCEEDED",
    "errorResponse" : {
      "message" : ""
    }
  }, {
    "description" : "Time Synchronization",
    "resultStatus" : "SUCCEEDED",
    "errorResponse" : {
      "message" : ""
    }
  }, {
    "description" : "Host and IP DNS records",
    "resultStatus" : "SUCCEEDED",
    "errorResponse" : {
      "message" : ""
    }
  }, {
    "description" : "Network Configuration",
    "resultStatus" : "SUCCEEDED",
    "errorResponse" : {
      "message" : ""
    }
  }, {
    "description" : "Network Connectivity",
    "resultStatus" : "SUCCEEDED",
    "errorResponse" : {
      "message" : ""
    }
  } ]
}

  1. Poll the task until "status" is not "IN_PROGRESS" using the "id" from the previous response.

  2. In case of no errors in the input specification, the "executionStatus" is "COMPLETED" and "resultStatus" is "SUCCEEDED".

  3. In case of errors in the input specification, the "executionStatus" is "COMPLETED" and "resultStatus" is "FAILED".

    Note
    		 Make changes to the input specification and re-validate using a new API invocation.

  4. Trigger the task using the valid input specification.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/sddcs/' -i -u 'admin:VMwareInfra@1' -X POST \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json' \
    -d '{
  "skipEsxThumbprintValidation" : true,
  "managementPoolName" : "bringup-networkpool",
  "sddcManagerSpec" : {
    "secondUserCredentials" : {
      "username" : "vcf",
      "password" : "VMware123!"
    },
    "ipAddress" : "10.0.0.4",
    "netmask" : "255.255.255.0",
    "hostname" : "sddc-manager",
    "rootUserCredentials" : {
      "username" : "root",
      "password" : "VMware123!"
    },
    "restApiCredentials" : {
      "username" : "admin",
      "password" : "VMware123!"
    }
  },
  "sddcId" : "sddcId-public-api-05",
  "esxLicense" : "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
  "taskName" : "workflowconfig/workflowspec-ems.json",
  "ntpServers" : [ "10.0.0.250" ],
  "dnsSpec" : {
    "subdomain" : "vrack.vsphere.local",
    "domain" : "vsphere.local",
    "nameserver" : "10.0.0.250",
    "secondaryNameserver" : "10.0.0.250"
  },
  "networkSpecs" : [ {
    "subnet" : "10.0.0.0/22",
    "vlanId" : "0",
    "mtu" : "1500",
    "networkType" : "MANAGEMENT",
    "gateway" : "10.0.0.250"
  }, {
    "subnet" : "10.0.4.0/24",
    "includeIpAddressRanges" : [ {
      "startIpAddress" : "10.0.4.7",
      "endIpAddress" : "10.0.4.48"
    }, {
      "startIpAddress" : "10.0.4.3",
      "endIpAddress" : "10.0.4.6"
    } ],
    "includeIpAddress" : [ "10.0.4.50", "10.0.4.49" ],
    "vlanId" : "0",
    "mtu" : "8940",
    "networkType" : "VSAN",
    "gateway" : "10.0.4.253"
  }, {
    "subnet" : "10.0.8.0/24",
    "includeIpAddressRanges" : [ {
      "startIpAddress" : "10.0.8.3",
      "endIpAddress" : "10.0.8.50"
    } ],
    "vlanId" : "0",
    "mtu" : "8940",
    "networkType" : "VMOTION",
    "gateway" : "10.0.8.253"
  } ],
  "nsxSpec" : {
    "nsxId" : "sfo01m01nsx01",
    "nsxManagerIp" : "10.0.0.9",
    "nsxManagerHostname" : "nsxManager",
    "nsxSegmentRangeBegin" : "5000",
    "nsxSegmentRangeEnd" : "5200",
    "multicastRangeBegin" : "239.1.0.0",
    "multicastRangeEnd" : "239.1.255.255",
    "license" : "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
    "adminNsxManagerPassword" : "VMware1!",
    "privilegedNsxManagerPassword" : "VMware123!",
    "adminNsxControllerPassword" : "VMware1234567!",
    "nsxVxlanSpec" : {
      "vxlanCluster" : "SDDC-Cluster1",
      "vxlanDvs" : "SDDC-Dswitch-Private",
      "vxlanVlanId" : "0",
      "vxlanMtu" : "8940",
      "vtepVmknicCount" : 2
    },
    "controllerIPPoolSpec" : {
      "poolName" : "sfo01-mgmt01-nsxc01",
      "startIp" : "10.0.0.40",
      "endIp" : "10.0.0.42",
      "prefix" : "22",
      "defaultGateway" : "10.0.0.250"
    }
  },
  "vsanSpec" : {
    "vsanName" : "vsan-1",
    "licenseFile" : "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
    "datastoreName" : "sfo01-m01-vsan"
  },
  "dvsSpecs" : [ {
    "mtu" : 8940,
    "niocSpec" : [ {
      "trafficType" : "VSAN",
      "value" : "HIGH"
    }, {
      "trafficType" : "VMOTION",
      "value" : "LOW"
    }, {
      "trafficType" : "VDP",
      "value" : "LOW"
    }, {
      "trafficType" : "VIRTUALMACHINE",
      "value" : "HIGH"
    }, {
      "trafficType" : "MANAGEMENT",
      "value" : "NORMAL"
    }, {
      "trafficType" : "NFS",
      "value" : "LOW"
    }, {
      "trafficType" : "HBR",
      "value" : "LOW"
    }, {
      "trafficType" : "FAULTTOLERANCE",
      "value" : "LOW"
    }, {
      "trafficType" : "ISCSI",
      "value" : "LOW"
    } ],
    "dvsName" : "SDDC-Dswitch-Private",
    "vmnics" : [ "vmnic0", "vmnic1" ],
    "networks" : [ "MANAGEMENT", "VSAN", "VMOTION" ]
  } ],
  "clusterSpec" : {
    "clusterName" : "SDDC-Cluster1",
    "clusterEvcMode" : "",
    "resourcePoolSpecs" : [ {
      "cpuSharesLevel" : "high",
      "cpuSharesValue" : 0,
      "name" : "Mgmt-ResourcePool",
      "memorySharesValue" : 0,
      "cpuReservationPercentage" : 0,
      "memoryLimit" : -1,
      "memoryReservationPercentage" : 0,
      "cpuReservationExpandable" : true,
      "memoryReservationExpandable" : true,
      "memorySharesLevel" : "normal",
      "cpuLimit" : -1,
      "type" : "management"
    }, {
      "cpuSharesLevel" : "high",
      "cpuSharesValue" : 0,
      "name" : "Network-ResourcePool",
      "memorySharesValue" : 0,
      "cpuReservationPercentage" : 0,
      "memoryLimit" : -1,
      "memoryReservationPercentage" : 0,
      "cpuReservationExpandable" : true,
      "memoryReservationExpandable" : true,
      "memorySharesLevel" : "normal",
      "cpuLimit" : -1,
      "type" : "network"
    }, {
      "cpuSharesLevel" : "normal",
      "cpuSharesValue" : 0,
      "name" : "Compute-ResourcePool",
      "memorySharesValue" : 0,
      "cpuReservationPercentage" : 0,
      "memoryLimit" : -1,
      "memoryReservationPercentage" : 0,
      "cpuReservationExpandable" : true,
      "memoryReservationExpandable" : true,
      "memorySharesLevel" : "normal",
      "cpuLimit" : -1,
      "type" : "compute"
    }, {
      "name" : "User-RP",
      "type" : "compute",
      "cpuReservationPercentage" : 0,
      "cpuLimit" : -1,
      "cpuReservationExpandable" : true,
      "cpuSharesLevel" : "normal",
      "cpuSharesValue" : 0,
      "memoryReservationPercentage" : 0,
      "memoryLimit" : -1,
      "memoryReservationExpandable" : true,
      "memorySharesLevel" : "normal",
      "memorySharesValue" : 0
    } ]
  },
  "pscSpecs" : [ {
    "pscId" : "psc-1",
    "rootPscPassword" : "VMware123!",
    "automationUserSsoPassword" : "VMware123!",
    "automationUserSsoUsername" : "automationuser",
    "pscIp" : "10.0.0.5",
    "pscHostName" : "psc-1",
    "pscSsoSpec" : {
      "ssoSiteName" : "vmwvcf2",
      "ssoDomain" : "vsphere.local",
      "isJoinSsoDomain" : false
    },
    "adminUserSsoPassword" : "VMware123!"
  }, {
    "pscId" : "psc-2",
    "rootPscPassword" : "VMware123!",
    "automationUserSsoPassword" : "VMware123!",
    "automationUserSsoUsername" : "automationuser",
    "pscIp" : "10.0.0.7",
    "pscHostName" : "psc-2",
    "pscSsoSpec" : {
      "replicationPartner" : "psc-1",
      "ssoSiteName" : "vmwvcf2",
      "ssoDomainPassword" : "VMware123!",
      "ssoDomain" : "vsphere.local",
      "isJoinSsoDomain" : false
    },
    "adminUserSsoPassword" : "VMware123!"
  } ],
  "vcenterSpec" : {
    "vcenterIp" : "10.0.0.6",
    "vcenterHostname" : "vcenter-1",
    "licenseFile" : "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
    "rootVcenterPassword" : "VMware1!",
    "vmSize" : "tiny"
  },
  "hostSpecs" : [ {
    "credentials" : {
      "username" : "root",
      "password" : "EvoSddc!2016"
    },
    "ipAddressPrivate" : {
      "subnet" : "255.255.252.0",
      "cidr" : "",
      "ipAddress" : "10.0.0.100",
      "gateway" : "10.0.0.250"
    },
    "hostname" : "esxi-1",
    "vSwitch" : "vSwitch0",
    "serverId" : "host-0",
    "association" : "SDDC-Datacenter"
  }, {
    "credentials" : {
      "username" : "root",
      "password" : "EvoSddc!2016"
    },
    "ipAddressPrivate" : {
      "subnet" : "255.255.252.0",
      "cidr" : "",
      "ipAddress" : "10.0.0.101",
      "gateway" : "10.0.0.250"
    },
    "hostname" : "esxi-2",
    "vSwitch" : "vSwitch0",
    "serverId" : "host-1",
    "association" : "SDDC-Datacenter"
  }, {
    "credentials" : {
      "username" : "root",
      "password" : "EvoSddc!2016"
    },
    "ipAddressPrivate" : {
      "subnet" : "255.255.255.0",
      "cidr" : "",
      "ipAddress" : "10.0.0.102",
      "gateway" : "10.0.0.250"
    },
    "hostname" : "esxi-3",
    "vSwitch" : "vSwitch0",
    "serverId" : "host-2",
    "association" : "SDDC-Datacenter"
  }, {
    "credentials" : {
      "username" : "root",
      "password" : "EvoSddc!2016"
    },
    "ipAddressPrivate" : {
      "subnet" : "255.255.255.0",
      "cidr" : "",
      "ipAddress" : "10.0.0.103",
      "gateway" : "10.0.0.250"
    },
    "hostname" : "esxi-4",
    "vSwitch" : "vSwitch0",
    "serverId" : "host-3",
    "association" : "SDDC-Datacenter"
  } ],
  "vrliDeploymentSpec" : {
    "adminPassword" : "VMware1234!",
    "sshPassword" : "VMware12345!",
    "vmSize" : "small",
    "loadBalancerHostname" : "load-balancer",
    "loadBalancerIpAddress" : "10.0.0.15",
    "vrliNodeSpecs" : [ {
      "ipAddress" : "10.0.0.16",
      "hostname" : "loginsight-node-1"
    }, {
      "ipAddress" : "10.0.0.17",
      "hostname" : "loginsight-node-2"
    }, {
      "ipAddress" : "10.0.0.18",
      "hostname" : "loginsight-node-3"
    } ]
  }
}'

HTTP Request

POST /v1/sddcs/ HTTP/1.1
Accept: application/json
Host: sddc-manager.sfo01.rainpole.local
Content-Length: 8293
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==
Content-Type: application/json

{
  "skipEsxThumbprintValidation" : true,
  "managementPoolName" : "bringup-networkpool",
  "sddcManagerSpec" : {
    "secondUserCredentials" : {
      "username" : "vcf",
      "password" : "VMware123!"
    },
    "ipAddress" : "10.0.0.4",
    "netmask" : "255.255.255.0",
    "hostname" : "sddc-manager",
    "rootUserCredentials" : {
      "username" : "root",
      "password" : "VMware123!"
    },
    "restApiCredentials" : {
      "username" : "admin",
      "password" : "VMware123!"
    }
  },
  "sddcId" : "sddcId-public-api-05",
  "esxLicense" : "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
  "taskName" : "workflowconfig/workflowspec-ems.json",
  "ntpServers" : [ "10.0.0.250" ],
  "dnsSpec" : {
    "subdomain" : "vrack.vsphere.local",
    "domain" : "vsphere.local",
    "nameserver" : "10.0.0.250",
    "secondaryNameserver" : "10.0.0.250"
  },
  "networkSpecs" : [ {
    "subnet" : "10.0.0.0/22",
    "vlanId" : "0",
    "mtu" : "1500",
    "networkType" : "MANAGEMENT",
    "gateway" : "10.0.0.250"
  }, {
    "subnet" : "10.0.4.0/24",
    "includeIpAddressRanges" : [ {
      "startIpAddress" : "10.0.4.7",
      "endIpAddress" : "10.0.4.48"
    }, {
      "startIpAddress" : "10.0.4.3",
      "endIpAddress" : "10.0.4.6"
    } ],
    "includeIpAddress" : [ "10.0.4.50", "10.0.4.49" ],
    "vlanId" : "0",
    "mtu" : "8940",
    "networkType" : "VSAN",
    "gateway" : "10.0.4.253"
  }, {
    "subnet" : "10.0.8.0/24",
    "includeIpAddressRanges" : [ {
      "startIpAddress" : "10.0.8.3",
      "endIpAddress" : "10.0.8.50"
    } ],
    "vlanId" : "0",
    "mtu" : "8940",
    "networkType" : "VMOTION",
    "gateway" : "10.0.8.253"
  } ],
  "nsxSpec" : {
    "nsxId" : "sfo01m01nsx01",
    "nsxManagerIp" : "10.0.0.9",
    "nsxManagerHostname" : "nsxManager",
    "nsxSegmentRangeBegin" : "5000",
    "nsxSegmentRangeEnd" : "5200",
    "multicastRangeBegin" : "239.1.0.0",
    "multicastRangeEnd" : "239.1.255.255",
    "license" : "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
    "adminNsxManagerPassword" : "VMware1!",
    "privilegedNsxManagerPassword" : "VMware123!",
    "adminNsxControllerPassword" : "VMware1234567!",
    "nsxVxlanSpec" : {
      "vxlanCluster" : "SDDC-Cluster1",
      "vxlanDvs" : "SDDC-Dswitch-Private",
      "vxlanVlanId" : "0",
      "vxlanMtu" : "8940",
      "vtepVmknicCount" : 2
    },
    "controllerIPPoolSpec" : {
      "poolName" : "sfo01-mgmt01-nsxc01",
      "startIp" : "10.0.0.40",
      "endIp" : "10.0.0.42",
      "prefix" : "22",
      "defaultGateway" : "10.0.0.250"
    }
  },
  "vsanSpec" : {
    "vsanName" : "vsan-1",
    "licenseFile" : "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
    "datastoreName" : "sfo01-m01-vsan"
  },
  "dvsSpecs" : [ {
    "mtu" : 8940,
    "niocSpec" : [ {
      "trafficType" : "VSAN",
      "value" : "HIGH"
    }, {
      "trafficType" : "VMOTION",
      "value" : "LOW"
    }, {
      "trafficType" : "VDP",
      "value" : "LOW"
    }, {
      "trafficType" : "VIRTUALMACHINE",
      "value" : "HIGH"
    }, {
      "trafficType" : "MANAGEMENT",
      "value" : "NORMAL"
    }, {
      "trafficType" : "NFS",
      "value" : "LOW"
    }, {
      "trafficType" : "HBR",
      "value" : "LOW"
    }, {
      "trafficType" : "FAULTTOLERANCE",
      "value" : "LOW"
    }, {
      "trafficType" : "ISCSI",
      "value" : "LOW"
    } ],
    "dvsName" : "SDDC-Dswitch-Private",
    "vmnics" : [ "vmnic0", "vmnic1" ],
    "networks" : [ "MANAGEMENT", "VSAN", "VMOTION" ]
  } ],
  "clusterSpec" : {
    "clusterName" : "SDDC-Cluster1",
    "clusterEvcMode" : "",
    "resourcePoolSpecs" : [ {
      "cpuSharesLevel" : "high",
      "cpuSharesValue" : 0,
      "name" : "Mgmt-ResourcePool",
      "memorySharesValue" : 0,
      "cpuReservationPercentage" : 0,
      "memoryLimit" : -1,
      "memoryReservationPercentage" : 0,
      "cpuReservationExpandable" : true,
      "memoryReservationExpandable" : true,
      "memorySharesLevel" : "normal",
      "cpuLimit" : -1,
      "type" : "management"
    }, {
      "cpuSharesLevel" : "high",
      "cpuSharesValue" : 0,
      "name" : "Network-ResourcePool",
      "memorySharesValue" : 0,
      "cpuReservationPercentage" : 0,
      "memoryLimit" : -1,
      "memoryReservationPercentage" : 0,
      "cpuReservationExpandable" : true,
      "memoryReservationExpandable" : true,
      "memorySharesLevel" : "normal",
      "cpuLimit" : -1,
      "type" : "network"
    }, {
      "cpuSharesLevel" : "normal",
      "cpuSharesValue" : 0,
      "name" : "Compute-ResourcePool",
      "memorySharesValue" : 0,
      "cpuReservationPercentage" : 0,
      "memoryLimit" : -1,
      "memoryReservationPercentage" : 0,
      "cpuReservationExpandable" : true,
      "memoryReservationExpandable" : true,
      "memorySharesLevel" : "normal",
      "cpuLimit" : -1,
      "type" : "compute"
    }, {
      "name" : "User-RP",
      "type" : "compute",
      "cpuReservationPercentage" : 0,
      "cpuLimit" : -1,
      "cpuReservationExpandable" : true,
      "cpuSharesLevel" : "normal",
      "cpuSharesValue" : 0,
      "memoryReservationPercentage" : 0,
      "memoryLimit" : -1,
      "memoryReservationExpandable" : true,
      "memorySharesLevel" : "normal",
      "memorySharesValue" : 0
    } ]
  },
  "pscSpecs" : [ {
    "pscId" : "psc-1",
    "rootPscPassword" : "VMware123!",
    "automationUserSsoPassword" : "VMware123!",
    "automationUserSsoUsername" : "automationuser",
    "pscIp" : "10.0.0.5",
    "pscHostName" : "psc-1",
    "pscSsoSpec" : {
      "ssoSiteName" : "vmwvcf2",
      "ssoDomain" : "vsphere.local",
      "isJoinSsoDomain" : false
    },
    "adminUserSsoPassword" : "VMware123!"
  }, {
    "pscId" : "psc-2",
    "rootPscPassword" : "VMware123!",
    "automationUserSsoPassword" : "VMware123!",
    "automationUserSsoUsername" : "automationuser",
    "pscIp" : "10.0.0.7",
    "pscHostName" : "psc-2",
    "pscSsoSpec" : {
      "replicationPartner" : "psc-1",
      "ssoSiteName" : "vmwvcf2",
      "ssoDomainPassword" : "VMware123!",
      "ssoDomain" : "vsphere.local",
      "isJoinSsoDomain" : false
    },
    "adminUserSsoPassword" : "VMware123!"
  } ],
  "vcenterSpec" : {
    "vcenterIp" : "10.0.0.6",
    "vcenterHostname" : "vcenter-1",
    "licenseFile" : "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
    "rootVcenterPassword" : "VMware1!",
    "vmSize" : "tiny"
  },
  "hostSpecs" : [ {
    "credentials" : {
      "username" : "root",
      "password" : "EvoSddc!2016"
    },
    "ipAddressPrivate" : {
      "subnet" : "255.255.252.0",
      "cidr" : "",
      "ipAddress" : "10.0.0.100",
      "gateway" : "10.0.0.250"
    },
    "hostname" : "esxi-1",
    "vSwitch" : "vSwitch0",
    "serverId" : "host-0",
    "association" : "SDDC-Datacenter"
  }, {
    "credentials" : {
      "username" : "root",
      "password" : "EvoSddc!2016"
    },
    "ipAddressPrivate" : {
      "subnet" : "255.255.252.0",
      "cidr" : "",
      "ipAddress" : "10.0.0.101",
      "gateway" : "10.0.0.250"
    },
    "hostname" : "esxi-2",
    "vSwitch" : "vSwitch0",
    "serverId" : "host-1",
    "association" : "SDDC-Datacenter"
  }, {
    "credentials" : {
      "username" : "root",
      "password" : "EvoSddc!2016"
    },
    "ipAddressPrivate" : {
      "subnet" : "255.255.255.0",
      "cidr" : "",
      "ipAddress" : "10.0.0.102",
      "gateway" : "10.0.0.250"
    },
    "hostname" : "esxi-3",
    "vSwitch" : "vSwitch0",
    "serverId" : "host-2",
    "association" : "SDDC-Datacenter"
  }, {
    "credentials" : {
      "username" : "root",
      "password" : "EvoSddc!2016"
    },
    "ipAddressPrivate" : {
      "subnet" : "255.255.255.0",
      "cidr" : "",
      "ipAddress" : "10.0.0.103",
      "gateway" : "10.0.0.250"
    },
    "hostname" : "esxi-4",
    "vSwitch" : "vSwitch0",
    "serverId" : "host-3",
    "association" : "SDDC-Datacenter"
  } ],
  "vrliDeploymentSpec" : {
    "adminPassword" : "VMware1234!",
    "sshPassword" : "VMware12345!",
    "vmSize" : "small",
    "loadBalancerHostname" : "load-balancer",
    "loadBalancerIpAddress" : "10.0.0.15",
    "vrliNodeSpecs" : [ {
      "ipAddress" : "10.0.0.16",
      "hostname" : "loginsight-node-1"
    }, {
      "ipAddress" : "10.0.0.17",
      "hostname" : "loginsight-node-2"
    }, {
      "ipAddress" : "10.0.0.18",
      "hostname" : "loginsight-node-3"
    } ]
  }
}

HTTP Response

HTTP/1.1 202 Accepted
Location: /v1/sddcs/b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a
Content-Length: 100905
Content-Type: application/json;charset=UTF-8

{
  "id" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
  "name" : "Bringup-Ems",
  "status" : "IN_PROGRESS",
  "creationTimestamp" : "2019-08-28T08:38:37.568Z",
  "sddcSubTasks" : [ {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "GenerateEsxiForVsanDedupInput",
    "processingStateDescription" : "Generate ESXi Host vSAN Deduplication Input Data",
    "name" : "Generate ESXi Host vSAN Deduplication Input Data",
    "description" : "Generate ESXi Host vSAN Deduplication Input Data",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateEsxiForVsanDedupInput.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateEsxiForVsanDedupInput.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.568Z",
    "updateTimestamp" : "2019-08-28T08:38:37.568Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "GenerateEsxiInput",
    "processingStateDescription" : "Generate ESXi Host Input Data",
    "name" : "Generate ESXi Host Input Data",
    "description" : "Generate ESXi Host Input Data",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateEsxiInput.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateEsxiInput.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.216Z",
    "updateTimestamp" : "2019-08-28T08:38:37.216Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_InitialEnvironmentSetup_VspherePlugin_PrepareEsxiForVsanDedupAction_2",
    "processingStateDescription" : "Prepare ESXi Hosts for vSAN with Deduplication",
    "name" : "Prepare ESXi Hosts for vSAN with Deduplication Action",
    "description" : "Prepare ESXi Hosts for vSAN with Deduplication",
    "localizableNamePack" : {
      "component" : "com.vmware.vcf.common.fsm.plugins.action.VspherePlugin",
      "messageKey" : "PrepareEsxiForVsanDedupAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.vcf.common.fsm.plugins.action.VspherePlugin",
      "messageKey" : "PrepareEsxiForVsanDedupAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.220Z",
    "updateTimestamp" : "2019-08-28T08:38:37.220Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_InitialEnvironmentSetup_VspherePlugin_EnableVsanDedupOnFirstHostAction_3",
    "processingStateDescription" : "Enable vSAN Deduplication for the First Host",
    "name" : "Enable vSAN Deduplication for the First Host Action",
    "description" : "Enable vSAN Deduplication for the First Host",
    "localizableNamePack" : {
      "component" : "com.vmware.vcf.common.fsm.plugins.action.VspherePlugin",
      "messageKey" : "EnableVsanDedupOnFirstHostAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.vcf.common.fsm.plugins.action.VspherePlugin",
      "messageKey" : "EnableVsanDedupOnFirstHostAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.224Z",
    "updateTimestamp" : "2019-08-28T08:38:37.224Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_InitialEnvironmentSetup_HostPlugin_CreateVmPortGroupAction_4",
    "processingStateDescription" : "Create 'VM Network' Portgroup on ESXi Hosts",
    "name" : "Create 'VM Network' Portgroup on ESXi Hosts",
    "description" : "Create 'VM Network' Portgroup on ESXi Hosts",
    "localizableNamePack" : {
      "component" : "com.vmware.vcf.common.fsm.plugins.action.HostPlugin",
      "messageKey" : "CreateVmPortGroupAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.vcf.common.fsm.plugins.action.HostPlugin",
      "messageKey" : "CreateVmPortGroupAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.227Z",
    "updateTimestamp" : "2019-08-28T08:38:37.227Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_InitialEnvironmentSetup_HostPlugin_ReconfigureHostDnsAction_5",
    "processingStateDescription" : "Configure ESXi Host DNS",
    "name" : "Configure ESXi Host DNS",
    "description" : "Configure ESXi Host DNS",
    "localizableNamePack" : {
      "component" : "com.vmware.vcf.common.fsm.plugins.action.HostPlugin",
      "messageKey" : "ReconfigureHostDnsAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.vcf.common.fsm.plugins.action.HostPlugin",
      "messageKey" : "ReconfigureHostDnsAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.231Z",
    "updateTimestamp" : "2019-08-28T08:38:37.231Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_InitialEnvironmentSetup_com.vmware.evo.sddc.bringup.plugin.spi.VspherePlugin_DetermineSoftwareVersionAction_6",
    "processingStateDescription" : "Determine Software Version on ESXi Hosts",
    "name" : "Determine Software Version on ESXi Hosts",
    "description" : "Determine Software Version on ESXi Hosts",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "DetermineSoftwareVersionAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "DetermineSoftwareVersionAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.234Z",
    "updateTimestamp" : "2019-08-28T08:38:37.234Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "PSCDeploymentInputGeneration",
    "processingStateDescription" : "Generate Platform Services Controller Deployment Input Data",
    "name" : "Generate Platform Services Controller Deployment Input Data",
    "description" : "Generate Platform Services Controller Deployment Input Data",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "PSCDeploymentInputGeneration.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "PSCDeploymentInputGeneration.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.238Z",
    "updateTimestamp" : "2019-08-28T08:38:37.238Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_PSCDeployment_PscPlugin_DeployPsc1Action_1",
    "processingStateDescription" : "Deploy Platform Service Controller",
    "name" : "Deploy Platform Service Controller",
    "description" : "Deploy Platform Service Controller",
    "localizableNamePack" : {
      "component" : "com.vmware.vcf.common.fsm.plugins.action.plugins.PscPlugin",
      "messageKey" : "DeployPsc1Action.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.vcf.common.fsm.plugins.action.plugins.PscPlugin",
      "messageKey" : "DeployPsc1Action.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.243Z",
    "updateTimestamp" : "2019-08-28T08:38:37.243Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_PSCDeployment_PscPlugin_CreateUserGroupsAction_2",
    "processingStateDescription" : "Create Admin User Groups in vsphere.local Domain",
    "name" : "Create Admin User Groups in vsphere.local Domain",
    "description" : "Create Admin User Groups in vsphere.local Domain",
    "localizableNamePack" : {
      "component" : "com.vmware.vcf.common.fsm.plugins.action.plugins.PscPlugin",
      "messageKey" : "CreateUserGroupsAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.vcf.common.fsm.plugins.action.plugins.PscPlugin",
      "messageKey" : "CreateUserGroupsAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.248Z",
    "updateTimestamp" : "2019-08-28T08:38:37.248Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_GenerateLicenseRenameInput_ProxyContractPlugin_ProxyContractAction_0",
    "processingStateDescription" : "Automation Helper Action",
    "name" : "ProxyContractAction",
    "description" : "Automation Helper Action",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.orchestrator.core.recipes.spel.ProxyContractPlugin",
      "messageKey" : "ProxyContractAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.orchestrator.core.recipes.spel.ProxyContractPlugin",
      "messageKey" : "ProxyContractAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.253Z",
    "updateTimestamp" : "2019-08-28T08:38:37.253Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "GenerateLicenseRenameInput",
    "processingStateDescription" : "Generate license rename input",
    "name" : "Generate vCenter License Rename Input Data",
    "description" : "Generate license rename input",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.input.generation.recipes.GenerateLicenseRenameInput",
      "messageKey" : "GenerateLicenseRenameInput.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.input.generation.recipes.GenerateLicenseRenameInput",
      "messageKey" : "GenerateLicenseRenameInput.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.258Z",
    "updateTimestamp" : "2019-08-28T08:38:37.258Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "GenerateVcDeploymentInput",
    "processingStateDescription" : "Generate Vc Deployment Input",
    "name" : "Generate vCenter Server Deployment Input Data",
    "description" : "Generate Vc Deployment Input",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateVcDeploymentInput.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateVcDeploymentInput.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.264Z",
    "updateTimestamp" : "2019-08-28T08:38:37.264Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_VCDeployment_VcPlugin_DeployVcAction_3",
    "processingStateDescription" : "Deploy vCenter Server",
    "name" : "Deploy vCenter Server",
    "description" : "Deploy vCenter Server",
    "localizableNamePack" : {
      "component" : "com.vmware.vcf.common.fsm.plugins.action.plugins.VcPlugin",
      "messageKey" : "DeployVcAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.vcf.common.fsm.plugins.action.plugins.VcPlugin",
      "messageKey" : "DeployVcAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.269Z",
    "updateTimestamp" : "2019-08-28T08:38:37.269Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_VCDeployment_VcPlugin_ApplyVcLicenseAction_4",
    "processingStateDescription" : "Apply vCenter Server, vSphere, and vSAN Licenses",
    "name" : "Apply vCenter Server, vSphere, and vSAN Licenses",
    "description" : "Apply vCenter Server, vSphere, and vSAN Licenses",
    "localizableNamePack" : {
      "component" : "workflowconfig.ems_recipes.VCDeployment",
      "messageKey" : "ApplyVcLicenseAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "workflowconfig.ems_recipes.VCDeployment",
      "messageKey" : "ApplyVcLicenseAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.272Z",
    "updateTimestamp" : "2019-08-28T08:38:37.272Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_VCDeployment_LicensePlugin_RenameLicense_5",
    "processingStateDescription" : "Rename the Applied vCenter License in vCenter Server",
    "name" : "Rename the Applied vCenter License in vCenter Server",
    "description" : "Rename the Applied vCenter License in vCenter Server",
    "localizableNamePack" : {
      "component" : "workflowconfig.ems_recipes.VCDeployment",
      "messageKey" : "RenameLicense.name"
    },
    "localizableDescriptionPack" : {
      "component" : "workflowconfig.ems_recipes.VCDeployment",
      "messageKey" : "RenameLicense.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.276Z",
    "updateTimestamp" : "2019-08-28T08:38:37.276Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ManagementClusterConfiguration",
    "processingStateDescription" : "Create Vsphere Cluster",
    "name" : "Create vSphere Cluster",
    "description" : "Create Vsphere Cluster",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "CreateCluster.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "CreateCluster.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.281Z",
    "updateTimestamp" : "2019-08-28T08:38:37.281Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ManagementClusterConfiguration",
    "processingStateDescription" : "Create Vsphere Cluster",
    "name" : "Enable vSphere DRS",
    "description" : "Create Vsphere Cluster",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "EnableClusterDrs.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "EnableClusterDrs.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.281Z",
    "updateTimestamp" : "2019-08-28T08:38:37.281Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ManagementClusterConfiguration",
    "processingStateDescription" : "Create Vsphere Cluster",
    "name" : "Apply vSAN Dormant License File (DLF)",
    "description" : "Create Vsphere Cluster",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "ApplyVsanDlf.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "ApplyVsanDlf.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.281Z",
    "updateTimestamp" : "2019-08-28T08:38:37.281Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ManagementClusterConfiguration",
    "processingStateDescription" : "Create Vsphere Cluster",
    "name" : "Apply vSAN License",
    "description" : "Create Vsphere Cluster",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "ApplyVsanLicense.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "ApplyVsanLicense.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.281Z",
    "updateTimestamp" : "2019-08-28T08:38:37.281Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ManagementClusterConfiguration",
    "processingStateDescription" : "Create Vsphere Cluster",
    "name" : "Generate vSAN License Rename Input Data",
    "description" : "Create Vsphere Cluster",
    "localizableNamePack" : {
      "component" : "workflowconfig.ems_recipes.ManagementClusterConfiguration",
      "messageKey" : "GenerateVSANLicenseRenameInputId.name"
    },
    "localizableDescriptionPack" : {
      "component" : "workflowconfig.ems_recipes.ManagementClusterConfiguration",
      "messageKey" : "GenerateVSANLicenseRenameInputId.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.281Z",
    "updateTimestamp" : "2019-08-28T08:38:37.281Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ManagementClusterConfiguration",
    "processingStateDescription" : "Create Vsphere Cluster",
    "name" : "Rename the Applied VSAN License in vCenter Server",
    "description" : "Create Vsphere Cluster",
    "localizableNamePack" : {
      "component" : "workflowconfig.ems_recipes.ManagementClusterConfiguration",
      "messageKey" : "RenameVSANLicenseId.name"
    },
    "localizableDescriptionPack" : {
      "component" : "workflowconfig.ems_recipes.ManagementClusterConfiguration",
      "messageKey" : "RenameVSANLicenseId.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.281Z",
    "updateTimestamp" : "2019-08-28T08:38:37.281Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ManagementClusterConfiguration",
    "processingStateDescription" : "Create Vsphere Cluster",
    "name" : "Assign Administrator Privileges to SDDCAdmins Group",
    "description" : "Create Vsphere Cluster",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "AuthorizeSddcAdminGroup.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "AuthorizeSddcAdminGroup.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.281Z",
    "updateTimestamp" : "2019-08-28T08:38:37.281Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ManagementClusterConfiguration",
    "processingStateDescription" : "Create Vsphere Cluster",
    "name" : "Create vSphere Distributed Switch",
    "description" : "Create Vsphere Cluster",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "CreateDvs.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "CreateDvs.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.281Z",
    "updateTimestamp" : "2019-08-28T08:38:37.281Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ManagementClusterConfiguration",
    "processingStateDescription" : "Create Vsphere Cluster",
    "name" : "Add ESXi Host to vSphere Cluster",
    "description" : "Create Vsphere Cluster",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "AddHostToCluster.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "AddHostToCluster.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.281Z",
    "updateTimestamp" : "2019-08-28T08:38:37.281Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ManagementClusterConfiguration",
    "processingStateDescription" : "Create Vsphere Cluster",
    "name" : "Enable/Disable EVC Mode on vSphere Cluster",
    "description" : "Create Vsphere Cluster",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "EnableEvc.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "EnableEvc.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.281Z",
    "updateTimestamp" : "2019-08-28T08:38:37.281Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ManagementClusterConfiguration",
    "processingStateDescription" : "Create Vsphere Cluster",
    "name" : "Add ESXi Hosts to vSphere Distributed Switch",
    "description" : "Create Vsphere Cluster",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "AddHostToDvswitch.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "AddHostToDvswitch.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.281Z",
    "updateTimestamp" : "2019-08-28T08:38:37.281Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ManagementClusterConfiguration",
    "processingStateDescription" : "Create Vsphere Cluster",
    "name" : "Create VM Folders",
    "description" : "Create Vsphere Cluster",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "CreateVmFolders.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "CreateVmFolders.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.281Z",
    "updateTimestamp" : "2019-08-28T08:38:37.281Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ManagementClusterConfiguration",
    "processingStateDescription" : "Create Vsphere Cluster",
    "name" : "Create Network Folders",
    "description" : "Create Vsphere Cluster",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "CreateNetworkFolders.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "CreateNetworkFolders.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.281Z",
    "updateTimestamp" : "2019-08-28T08:38:37.281Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ManagementClusterConfiguration",
    "processingStateDescription" : "Create Vsphere Cluster",
    "name" : "Create vMotion vmknics",
    "description" : "Create Vsphere Cluster",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "CreateVmotionVmknics.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "CreateVmotionVmknics.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.281Z",
    "updateTimestamp" : "2019-08-28T08:38:37.281Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ManagementClusterConfiguration",
    "processingStateDescription" : "Create Vsphere Cluster",
    "name" : "Create vSAN vmknics",
    "description" : "Create Vsphere Cluster",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "CreateVsanVmknics.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "CreateVsanVmknics.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.281Z",
    "updateTimestamp" : "2019-08-28T08:38:37.281Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ManagementClusterConfiguration",
    "processingStateDescription" : "Create Vsphere Cluster",
    "name" : "Configure VLANs on vSphere Distributed Switch Portgroups",
    "description" : "Create Vsphere Cluster",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "TagVlanIdsOnPortgroups.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "TagVlanIdsOnPortgroups.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.281Z",
    "updateTimestamp" : "2019-08-28T08:38:37.281Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ManagementClusterConfiguration",
    "processingStateDescription" : "Create Vsphere Cluster",
    "name" : "Migrate VMs to vSphere Distributed Switch",
    "description" : "Create Vsphere Cluster",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "MigrateVmsToPortgroups.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "MigrateVmsToPortgroups.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.281Z",
    "updateTimestamp" : "2019-08-28T08:38:37.281Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ManagementClusterConfiguration",
    "processingStateDescription" : "Create Vsphere Cluster",
    "name" : "Migrate ESXi Host vmknics to vSphere Distributed Switch",
    "description" : "Create Vsphere Cluster",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "MigrateHostVmknicsToPortgroups.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "MigrateHostVmknicsToPortgroups.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.281Z",
    "updateTimestamp" : "2019-08-28T08:38:37.281Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ManagementClusterConfiguration",
    "processingStateDescription" : "Create Vsphere Cluster",
    "name" : "Detach ESXi Host vmnics from vSphere Standard Switch",
    "description" : "Create Vsphere Cluster",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "DetachVmnicFromVswitch.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "DetachVmnicFromVswitch.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.281Z",
    "updateTimestamp" : "2019-08-28T08:38:37.281Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ManagementClusterConfiguration",
    "processingStateDescription" : "Create Vsphere Cluster",
    "name" : "Attach ESXi Host vmnics to vSphere Distributed Switch",
    "description" : "Create Vsphere Cluster",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "AttachVmnicToDvs.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "AttachVmnicToDvs.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.281Z",
    "updateTimestamp" : "2019-08-28T08:38:37.281Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ManagementClusterConfiguration",
    "processingStateDescription" : "Create Vsphere Cluster",
    "name" : "Remove vSphere Standard Switch",
    "description" : "Create Vsphere Cluster",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "RemoveVswitch.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "RemoveVswitch.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.281Z",
    "updateTimestamp" : "2019-08-28T08:38:37.281Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ManagementClusterConfiguration",
    "processingStateDescription" : "Create Vsphere Cluster",
    "name" : "Update vSAN Hardware Compatability List (HCL) Database",
    "description" : "Create Vsphere Cluster",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "UpdateVsanHcl.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "UpdateVsanHcl.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.281Z",
    "updateTimestamp" : "2019-08-28T08:38:37.281Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ManagementClusterConfiguration",
    "processingStateDescription" : "Create Vsphere Cluster",
    "name" : "Enable vSAN",
    "description" : "Create Vsphere Cluster",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "EnableVsan.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "EnableVsan.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.281Z",
    "updateTimestamp" : "2019-08-28T08:38:37.281Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ManagementClusterConfiguration",
    "processingStateDescription" : "Create Vsphere Cluster",
    "name" : "Enable vSAN Deduplication on Cluster",
    "description" : "Create Vsphere Cluster",
    "localizableNamePack" : {
      "component" : "com.vmware.vcf.common.fsm.plugins.action.VspherePlugin",
      "messageKey" : "EnableVsanDedupOnClusterAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.vcf.common.fsm.plugins.action.VspherePlugin",
      "messageKey" : "EnableVsanDedupOnClusterAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.281Z",
    "updateTimestamp" : "2019-08-28T08:38:37.281Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ManagementClusterConfiguration",
    "processingStateDescription" : "Create Vsphere Cluster",
    "name" : "Enable vSAN Storage Policies",
    "description" : "Create Vsphere Cluster",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "EnableVsanPolicies.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "EnableVsanPolicies.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.281Z",
    "updateTimestamp" : "2019-08-28T08:38:37.281Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ManagementClusterConfiguration",
    "processingStateDescription" : "Create Vsphere Cluster",
    "name" : "Create vSAN Disk Groups",
    "description" : "Create Vsphere Cluster",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "VsanClaimDisks.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "VsanClaimDisks.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.281Z",
    "updateTimestamp" : "2019-08-28T08:38:37.281Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ManagementClusterConfiguration",
    "processingStateDescription" : "Create Vsphere Cluster",
    "name" : "Create Resource Pools in vCenter Server",
    "description" : "Create Vsphere Cluster",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "CreateResourcePool.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "CreateResourcePool.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.281Z",
    "updateTimestamp" : "2019-08-28T08:38:37.281Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ApplyEsxLicense",
    "processingStateDescription" : "Apply ESXi Host License Key",
    "name" : "Apply ESXi Host License Key",
    "description" : "Apply ESXi Host License Key",
    "localizableNamePack" : {
      "component" : "workflowconfig.ems_recipes.ApplyEsxLicense",
      "messageKey" : "ApplyEsxiLicenseInVcAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "workflowconfig.ems_recipes.ApplyEsxLicense",
      "messageKey" : "ApplyEsxiLicenseInVcAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.321Z",
    "updateTimestamp" : "2019-08-28T08:38:37.321Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ApplyEsxLicense",
    "processingStateDescription" : "Apply ESXi Host License Key",
    "name" : "Generate ESXi License Rename Input Data",
    "description" : "Apply ESXi Host License Key",
    "localizableNamePack" : {
      "component" : "workflowconfig.ems_recipes.ApplyEsxLicense",
      "messageKey" : "GenerateLicenseRenameInput.name"
    },
    "localizableDescriptionPack" : {
      "component" : "workflowconfig.ems_recipes.ApplyEsxLicense",
      "messageKey" : "GenerateLicenseRenameInput.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.321Z",
    "updateTimestamp" : "2019-08-28T08:38:37.321Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ApplyEsxLicense",
    "processingStateDescription" : "Apply ESXi Host License Key",
    "name" : "Rename the Applied ESXi License in vCenter Server",
    "description" : "Apply ESXi Host License Key",
    "localizableNamePack" : {
      "component" : "workflowconfig.ems_recipes.ApplyEsxLicense",
      "messageKey" : "RenameLicense.name"
    },
    "localizableDescriptionPack" : {
      "component" : "workflowconfig.ems_recipes.ApplyEsxLicense",
      "messageKey" : "RenameLicense.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.321Z",
    "updateTimestamp" : "2019-08-28T08:38:37.321Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "NSXvConfiguration",
    "processingStateDescription" : "Deploy and Configure NSX for vSphere",
    "name" : "Deploy NSX Manager",
    "description" : "Deploy and Configure NSX for vSphere",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
      "messageKey" : "DeployNsxManager.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
      "messageKey" : "DeployNsxManager.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.328Z",
    "updateTimestamp" : "2019-08-28T08:38:37.328Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "NSXvConfiguration",
    "processingStateDescription" : "Deploy and Configure NSX for vSphere",
    "name" : "Generate and Install VMCA Certificate on NSX Manager",
    "description" : "Deploy and Configure NSX for vSphere",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
      "messageKey" : "UploadNsxManagerVmcaCert.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
      "messageKey" : "UploadNsxManagerVmcaCert.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.328Z",
    "updateTimestamp" : "2019-08-28T08:38:37.328Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "NSXvConfiguration",
    "processingStateDescription" : "Deploy and Configure NSX for vSphere",
    "name" : "Update NSX Manager TLS Settings",
    "description" : "Deploy and Configure NSX for vSphere",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
      "messageKey" : "UpdateNsxManagerTLSSettings.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
      "messageKey" : "UpdateNsxManagerTLSSettings.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.328Z",
    "updateTimestamp" : "2019-08-28T08:38:37.328Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "NSXvConfiguration",
    "processingStateDescription" : "Deploy and Configure NSX for vSphere",
    "name" : "Register NSX Manager with vCenter Server",
    "description" : "Deploy and Configure NSX for vSphere",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.action64.NsxServicePluginActionPlugin64",
      "messageKey" : "RegisterVcNsx.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.action64.NsxServicePluginActionPlugin64",
      "messageKey" : "RegisterVcNsx.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.328Z",
    "updateTimestamp" : "2019-08-28T08:38:37.328Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "NSXvConfiguration",
    "processingStateDescription" : "Deploy and Configure NSX for vSphere",
    "name" : "Apply NSX Dormant License File (DLF)",
    "description" : "Deploy and Configure NSX for vSphere",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
      "messageKey" : "UploadNsxDlf.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
      "messageKey" : "UploadNsxDlf.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.328Z",
    "updateTimestamp" : "2019-08-28T08:38:37.328Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "NSXvConfiguration",
    "processingStateDescription" : "Deploy and Configure NSX for vSphere",
    "name" : "Apply NSX License",
    "description" : "Deploy and Configure NSX for vSphere",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
      "messageKey" : "ApplyNsxLicense.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
      "messageKey" : "ApplyNsxLicense.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.328Z",
    "updateTimestamp" : "2019-08-28T08:38:37.328Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "NSXvConfiguration",
    "processingStateDescription" : "Deploy and Configure NSX for vSphere",
    "name" : "Generate NSX License Rename Input Data",
    "description" : "Deploy and Configure NSX for vSphere",
    "localizableNamePack" : {
      "component" : "workflowconfig.ems_recipes.NSXvConfiguration",
      "messageKey" : "GenerateLicenseRenameInputId.name"
    },
    "localizableDescriptionPack" : {
      "component" : "workflowconfig.ems_recipes.NSXvConfiguration",
      "messageKey" : "GenerateLicenseRenameInputId.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.328Z",
    "updateTimestamp" : "2019-08-28T08:38:37.328Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "NSXvConfiguration",
    "processingStateDescription" : "Deploy and Configure NSX for vSphere",
    "name" : "Rename the Applied NSX License in vCenter Server",
    "description" : "Deploy and Configure NSX for vSphere",
    "localizableNamePack" : {
      "component" : "workflowconfig.ems_recipes.NSXvConfiguration",
      "messageKey" : "RenameLicenseId.name"
    },
    "localizableDescriptionPack" : {
      "component" : "workflowconfig.ems_recipes.NSXvConfiguration",
      "messageKey" : "RenameLicenseId.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.328Z",
    "updateTimestamp" : "2019-08-28T08:38:37.328Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "NSXvConfiguration",
    "processingStateDescription" : "Deploy and Configure NSX for vSphere",
    "name" : "Generate NSX Manager Input Data",
    "description" : "Deploy and Configure NSX for vSphere",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.vvd.plugin.VvdPlugin",
      "messageKey" : "GenerateNsxInput.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.vvd.plugin.VvdPlugin",
      "messageKey" : "GenerateNsxInput.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.328Z",
    "updateTimestamp" : "2019-08-28T08:38:37.328Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "NSXvConfiguration",
    "processingStateDescription" : "Deploy and Configure NSX for vSphere",
    "name" : "Configure DNS on the NSX Controller Cluster",
    "description" : "Deploy and Configure NSX for vSphere",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.common.nsx.NsxManagerPlugin",
      "messageKey" : "ConfigureControllerDns.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.common.nsx.NsxManagerPlugin",
      "messageKey" : "ConfigureControllerDns.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.328Z",
    "updateTimestamp" : "2019-08-28T08:38:37.328Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "NSXvConfiguration",
    "processingStateDescription" : "Deploy and Configure NSX for vSphere",
    "name" : "Configure NTP on the NSX Controller Cluster",
    "description" : "Deploy and Configure NSX for vSphere",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.common.nsx.NsxManagerPlugin",
      "messageKey" : "ConfigureControllerNtp.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.common.nsx.NsxManagerPlugin",
      "messageKey" : "ConfigureControllerNtp.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.328Z",
    "updateTimestamp" : "2019-08-28T08:38:37.328Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "NSXvConfiguration",
    "processingStateDescription" : "Deploy and Configure NSX for vSphere",
    "name" : "Create NSX Controller Cluster",
    "description" : "Deploy and Configure NSX for vSphere",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
      "messageKey" : "DeployNsxController.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
      "messageKey" : "DeployNsxController.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.328Z",
    "updateTimestamp" : "2019-08-28T08:38:37.328Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "NSXvConfiguration",
    "processingStateDescription" : "Deploy and Configure NSX for vSphere",
    "name" : "Configure VXLAN Transport",
    "description" : "Deploy and Configure NSX for vSphere",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
      "messageKey" : "CreateVxlan.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
      "messageKey" : "CreateVxlan.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.328Z",
    "updateTimestamp" : "2019-08-28T08:38:37.328Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "NSXvConfiguration",
    "processingStateDescription" : "Deploy and Configure NSX for vSphere",
    "name" : "Resolve NSX Cluster Issues",
    "description" : "Deploy and Configure NSX for vSphere",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
      "messageKey" : "ResolveNsxClusterIssues.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
      "messageKey" : "ResolveNsxClusterIssues.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.328Z",
    "updateTimestamp" : "2019-08-28T08:38:37.328Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "NSXvConfiguration",
    "processingStateDescription" : "Deploy and Configure NSX for vSphere",
    "name" : "Set Universal Sync Role on NSX Manager",
    "description" : "Deploy and Configure NSX for vSphere",
    "localizableNamePack" : {
      "component" : "com.vmware.vcf.common.fsm.plugins.action.nsx.NsxPlugin",
      "messageKey" : "SetNsxRoleAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.vcf.common.fsm.plugins.action.nsx.NsxPlugin",
      "messageKey" : "SetNsxRoleAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.328Z",
    "updateTimestamp" : "2019-08-28T08:38:37.328Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "NSXvConfiguration",
    "processingStateDescription" : "Deploy and Configure NSX for vSphere",
    "name" : "Create NSX Segment Range",
    "description" : "Deploy and Configure NSX for vSphere",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
      "messageKey" : "CreateNsxSegmentRange.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
      "messageKey" : "CreateNsxSegmentRange.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.328Z",
    "updateTimestamp" : "2019-08-28T08:38:37.328Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "NSXvConfiguration",
    "processingStateDescription" : "Deploy and Configure NSX for vSphere",
    "name" : "Create NSX Multicast Range",
    "description" : "Deploy and Configure NSX for vSphere",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.plugin.ConfigureNsxPlugin",
      "messageKey" : "CreateMulticastRange.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.plugin.ConfigureNsxPlugin",
      "messageKey" : "CreateMulticastRange.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.328Z",
    "updateTimestamp" : "2019-08-28T08:38:37.328Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "NSXvConfiguration",
    "processingStateDescription" : "Deploy and Configure NSX for vSphere",
    "name" : "Create NSX Transport Zone",
    "description" : "Deploy and Configure NSX for vSphere",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
      "messageKey" : "CreateNsxTransportZone.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
      "messageKey" : "CreateNsxTransportZone.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.328Z",
    "updateTimestamp" : "2019-08-28T08:38:37.328Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "NSXvConfiguration",
    "processingStateDescription" : "Deploy and Configure NSX for vSphere",
    "name" : "Configure SSO on NSX Manager",
    "description" : "Deploy and Configure NSX for vSphere",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
      "messageKey" : "ConfigureSsoOnNSX.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
      "messageKey" : "ConfigureSsoOnNSX.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.328Z",
    "updateTimestamp" : "2019-08-28T08:38:37.328Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "GenerateLogInsightInput",
    "processingStateDescription" : "Generate vRealize Log Insight Input Data",
    "name" : "Generate vRealize Log Insight Input Data",
    "description" : "Generate vRealize Log Insight Input Data",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateLogInsightInput.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateLogInsightInput.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.359Z",
    "updateTimestamp" : "2019-08-28T08:38:37.359Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_LogInsightDeployment_DeployLogInsightPlugin_DeployLogInsightAction_1",
    "processingStateDescription" : "Deploy vRealize Log Insight",
    "name" : "Deploy vRealize Log Insight",
    "description" : "Deploy vRealize Log Insight",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.common.fsmplugins.loginsight.plugin.DeployLogInsightPlugin",
      "messageKey" : "DeployLogInsightAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.common.fsmplugins.loginsight.plugin.DeployLogInsightPlugin",
      "messageKey" : "DeployLogInsightAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.364Z",
    "updateTimestamp" : "2019-08-28T08:38:37.364Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_LogInsightDeployment_ConfigureLogInsightPlugin_AddLogInsightLicenseAction_2",
    "processingStateDescription" : "Apply vRealize Log Insight License",
    "name" : "Apply vRealize Log Insight License Action",
    "description" : "Apply vRealize Log Insight License",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.common.fsmplugins.loginsight.plugin.ConfigureLogInsightPlugin",
      "messageKey" : "AddLogInsightLicenseAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.common.fsmplugins.loginsight.plugin.ConfigureLogInsightPlugin",
      "messageKey" : "AddLogInsightLicenseAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.368Z",
    "updateTimestamp" : "2019-08-28T08:38:37.368Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_LogInsightDeployment_ConfigureLogInsightPlugin_BootstrapLogInsightClusterAction_3",
    "processingStateDescription" : "Bootstrap vRealize Log Insight Cluster",
    "name" : "Bootstrap vRealize Log Insight Cluster Action",
    "description" : "Bootstrap vRealize Log Insight Cluster",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.common.fsmplugins.loginsight.plugin.ConfigureLogInsightPlugin",
      "messageKey" : "BootstrapLogInsightClusterAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.common.fsmplugins.loginsight.plugin.ConfigureLogInsightPlugin",
      "messageKey" : "BootstrapLogInsightClusterAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.372Z",
    "updateTimestamp" : "2019-08-28T08:38:37.372Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_LogInsightDeployment_ConfigureLogInsightPlugin_GenerateLogInsightCertificateAction_4",
    "processingStateDescription" : "Generate and Install VMCA Certificate for vRealize Log Insight",
    "name" : "Generate and Install VMCA Certificate for vRealize Log Insight",
    "description" : "Generate and Install VMCA Certificate for vRealize Log Insight",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.common.fsmplugins.loginsight.plugin.ConfigureLogInsightPlugin",
      "messageKey" : "GenerateLogInsightCertificateAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.common.fsmplugins.loginsight.plugin.ConfigureLogInsightPlugin",
      "messageKey" : "GenerateLogInsightCertificateAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.377Z",
    "updateTimestamp" : "2019-08-28T08:38:37.377Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_LogInsightDeployment_ConfigureLogInsightPlugin_DisableTlsOnLogInsightAction_5",
    "processingStateDescription" : "Disable TLS 1.0 on vRealize Log Insight Nodes",
    "name" : "Disable TLS 1.0 on vRealize Log Insight Nodes Action",
    "description" : "Disable TLS 1.0 on vRealize Log Insight Nodes",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.common.fsmplugins.loginsight.plugin.ConfigureLogInsightPlugin",
      "messageKey" : "DisableTlsOnLogInsightAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.common.fsmplugins.loginsight.plugin.ConfigureLogInsightPlugin",
      "messageKey" : "DisableTlsOnLogInsightAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.381Z",
    "updateTimestamp" : "2019-08-28T08:38:37.381Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_LogInsightDeployment_ConfigureLogInsightPlugin_InstallContentPacksInLogInsightAction_6",
    "processingStateDescription" : "Install vRealize Log Insight Content Packs",
    "name" : "Install vRealize Log Insight Content Packs Action",
    "description" : "Install vRealize Log Insight Content Packs",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.common.fsmplugins.loginsight.plugin.ConfigureLogInsightPlugin",
      "messageKey" : "InstallContentPacksInLogInsightAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.common.fsmplugins.loginsight.plugin.ConfigureLogInsightPlugin",
      "messageKey" : "InstallContentPacksInLogInsightAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.385Z",
    "updateTimestamp" : "2019-08-28T08:38:37.385Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "GenerateNsxvLogInsightIntegrationInput",
    "processingStateDescription" : "Generate NsxvLogInsightIntegration input",
    "name" : "Generate NSX for vSphere Integration with vRealize Log Insight Input Data",
    "description" : "Generate NsxvLogInsightIntegration input",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateNsxvLogInsightIntegrationInput.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateNsxvLogInsightIntegrationInput.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.389Z",
    "updateTimestamp" : "2019-08-28T08:38:37.389Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_NsxvLogInsightIntegration_ConfigureSyslogInNsxPlugin_ConfigureSyslogInNsxManagerAction_1",
    "processingStateDescription" : "Configure Syslog Settings for NSX Manager",
    "name" : "Configure Syslog Settings for NSX Manager",
    "description" : "Configure Syslog Settings for NSX Manager",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.common.fsmplugins.loginsight.plugin.ConfigureSyslogInNsxPlugin",
      "messageKey" : "ConfigureSyslogInNsxManagerAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.common.fsmplugins.loginsight.plugin.ConfigureSyslogInNsxPlugin",
      "messageKey" : "ConfigureSyslogInNsxManagerAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.392Z",
    "updateTimestamp" : "2019-08-28T08:38:37.392Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_NsxvLogInsightIntegration_ConfigureSyslogInNsxPlugin_ConfigureSyslogInNsxControllerAction_2",
    "processingStateDescription" : "Configure Syslog Settings for NSX Controllers",
    "name" : "Configure Syslog Settings for NSX Controllers",
    "description" : "Configure Syslog Settings for NSX Controllers",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.common.fsmplugins.loginsight.plugin.ConfigureSyslogInNsxPlugin",
      "messageKey" : "ConfigureSyslogInNsxControllerAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.common.fsmplugins.loginsight.plugin.ConfigureSyslogInNsxPlugin",
      "messageKey" : "ConfigureSyslogInNsxControllerAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.396Z",
    "updateTimestamp" : "2019-08-28T08:38:37.396Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "GenerateSddcManagerInput",
    "processingStateDescription" : "Generate SDDC Manager Input Data",
    "name" : "Generate SDDC Manager Input Data",
    "description" : "Generate SDDC Manager Input Data",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateSddcManagerInput.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateSddcManagerInput.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.399Z",
    "updateTimestamp" : "2019-08-28T08:38:37.399Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_SDDCManagerConfiguration_SddcManagerContractPlugin_DeploySddcManagerOnClusterAction_1",
    "processingStateDescription" : "Deploy SDDC Manager",
    "name" : "Deploy SDDC Manager",
    "description" : "Deploy SDDC Manager",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.sddcmanager.SddcManagerContractPlugin",
      "messageKey" : "DeploySddcManagerOnClusterAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.sddcmanager.SddcManagerContractPlugin",
      "messageKey" : "DeploySddcManagerOnClusterAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.405Z",
    "updateTimestamp" : "2019-08-28T08:38:37.405Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_SDDCManagerConfiguration_SddcManagerContractPlugin_ConfigureLCMRepoOnSddcManagerAction_2",
    "processingStateDescription" : "Configure Lifecycle Management Repository on SDDC Manager",
    "name" : "Configure Lifecycle Management Repository on SDDC Manager",
    "description" : "Configure Lifecycle Management Repository on SDDC Manager",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.sddcmanager.SddcManagerContractPlugin",
      "messageKey" : "ConfigureLCMRepoOnSddcManagerAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.sddcmanager.SddcManagerContractPlugin",
      "messageKey" : "ConfigureLCMRepoOnSddcManagerAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.410Z",
    "updateTimestamp" : "2019-08-28T08:38:37.410Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_SDDCManagerConfiguration_HostPlugin_CreateNFSDatastoreOnHostsAction_3",
    "processingStateDescription" : "Mount Repository NFS Datastore on ESXi Hosts",
    "name" : "Mount Repository NFS Datastore on ESXi Hosts",
    "description" : "Mount Repository NFS Datastore on ESXi Hosts",
    "localizableNamePack" : {
      "component" : "com.vmware.vcf.common.fsm.plugins.action.HostPlugin",
      "messageKey" : "CreateNFSDatastoreOnHostsAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.vcf.common.fsm.plugins.action.HostPlugin",
      "messageKey" : "CreateNFSDatastoreOnHostsAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.414Z",
    "updateTimestamp" : "2019-08-28T08:38:37.414Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_SDDCManagerConfiguration_SddcManagerContractPlugin_ConfigureBaseImageRepoAction_4",
    "processingStateDescription" : "Configure Base Install Image Repository on SDDC Manager",
    "name" : "Configure Base Install Image Repository on SDDC Manager",
    "description" : "Configure Base Install Image Repository on SDDC Manager",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.sddcmanager.SddcManagerContractPlugin",
      "messageKey" : "ConfigureBaseImageRepoAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.sddcmanager.SddcManagerContractPlugin",
      "messageKey" : "ConfigureBaseImageRepoAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.417Z",
    "updateTimestamp" : "2019-08-28T08:38:37.417Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_SDDCManagerConfiguration_SddcManagerContractPlugin_InstallVmcaRootCertOnSddcManagerAction_5",
    "processingStateDescription" : "Install VMCA Root Certificate on SDDC Manager",
    "name" : "Install VMCA Root Certificate on SDDC Manager",
    "description" : "Install VMCA Root Certificate on SDDC Manager",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.sddcmanager.SddcManagerContractPlugin",
      "messageKey" : "InstallVmcaRootCertOnSddcManagerAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.sddcmanager.SddcManagerContractPlugin",
      "messageKey" : "InstallVmcaRootCertOnSddcManagerAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.421Z",
    "updateTimestamp" : "2019-08-28T08:38:37.421Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_SDDCManagerConfiguration_SddcManagerContractPlugin_InstallSddcManagerVmcaCertificateAction_6",
    "processingStateDescription" : "Generate and Install VMCA Certificate on SDDC Manager",
    "name" : "Generate and Install VMCA Certificate on SDDC Manager",
    "description" : "Generate and Install VMCA Certificate on SDDC Manager",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.sddcmanager.SddcManagerContractPlugin",
      "messageKey" : "InstallSddcManagerVmcaCertificateAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.sddcmanager.SddcManagerContractPlugin",
      "messageKey" : "InstallSddcManagerVmcaCertificateAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.425Z",
    "updateTimestamp" : "2019-08-28T08:38:37.425Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "GenerateInventoryForSddcManagerConfiguration",
    "processingStateDescription" : "Generate Inventory Data For SDDC Manager Configuration",
    "name" : "Generate Inventory data For SDDC Manager Configuration",
    "description" : "Generate Inventory Data For SDDC Manager Configuration",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateInventoryForSddcManagerConfiguration.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateInventoryForSddcManagerConfiguration.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.429Z",
    "updateTimestamp" : "2019-08-28T08:38:37.429Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_SDDCManagerPostInventory_SddcManagerContractPlugin_PostInventoryAndCredentialsAction_1",
    "processingStateDescription" : "Update SDDC Manager Inventory with Credential Details",
    "name" : "Update SDDC Manager Inventory with Credential Details",
    "description" : "Update SDDC Manager Inventory with Credential Details",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.sddcmanager.SddcManagerContractPlugin",
      "messageKey" : "PostInventoryAndCredentialsAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.sddcmanager.SddcManagerContractPlugin",
      "messageKey" : "PostInventoryAndCredentialsAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.433Z",
    "updateTimestamp" : "2019-08-28T08:38:37.433Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_SDDCManagerPostInventory_SddcManagerContractPlugin_PostNetworkPoolInventoryAction_2",
    "processingStateDescription" : "Update SDDC Manager Inventory with Network Pool Details",
    "name" : "Update SDDC Manager Inventory with Network Pool Details",
    "description" : "Update SDDC Manager Inventory with Network Pool Details",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.sddcmanager.SddcManagerContractPlugin",
      "messageKey" : "PostNetworkPoolInventoryAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.sddcmanager.SddcManagerContractPlugin",
      "messageKey" : "PostNetworkPoolInventoryAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.437Z",
    "updateTimestamp" : "2019-08-28T08:38:37.437Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_SDDCManagerPostInventory_SddcManagerContractPlugin_PostSddcLicenseInventoryAction_3",
    "processingStateDescription" : "Update SDDC Manager Inventory with License Details",
    "name" : "Update SDDC Manager Inventory with License Details",
    "description" : "Update SDDC Manager Inventory with License Details",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.sddcmanager.SddcManagerContractPlugin",
      "messageKey" : "PostSddcLicenseInventoryAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.sddcmanager.SddcManagerContractPlugin",
      "messageKey" : "PostSddcLicenseInventoryAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.441Z",
    "updateTimestamp" : "2019-08-28T08:38:37.441Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_SddcManagerKnownHostsConfiguration_ProxyContractPlugin_ProxyContractAction_17",
    "processingStateDescription" : "Automation Helper Action",
    "name" : "ProxyContractAction",
    "description" : "Automation Helper Action",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.orchestrator.core.recipes.spel.ProxyContractPlugin",
      "messageKey" : "ProxyContractAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.orchestrator.core.recipes.spel.ProxyContractPlugin",
      "messageKey" : "ProxyContractAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.444Z",
    "updateTimestamp" : "2019-08-28T08:38:37.444Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "GenerateSddcManagerInput",
    "processingStateDescription" : "Generate SDDC Manager Input Data",
    "name" : "Generate SDDC Manager Input Data",
    "description" : "Generate SDDC Manager Input Data",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateSddcManagerInput.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateSddcManagerInput.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.447Z",
    "updateTimestamp" : "2019-08-28T08:38:37.447Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "GenerateVsphereMachineSshEntities",
    "processingStateDescription" : "Generate ESXi Host SSH Key Input Data",
    "name" : "Generate ESXi Host SSH Key Input Data",
    "description" : "Generate ESXi Host SSH Key Input Data",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateVsphereMachineSshEntities.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateVsphereMachineSshEntities.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.453Z",
    "updateTimestamp" : "2019-08-28T08:38:37.453Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_SddcManagerKnownHostsConfiguration_VsphereContractPlugin_RotateMachineSshKeys_2",
    "processingStateDescription" : "Rotate ESXi Host SSH Keys",
    "name" : "Rotate ESXi Host SSH Keys",
    "description" : "Rotate ESXi Host SSH Keys",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.vsphere.contract.VsphereContractPlugin",
      "messageKey" : "RotateMachineSshKeys.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.vsphere.contract.VsphereContractPlugin",
      "messageKey" : "RotateMachineSshKeys.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.456Z",
    "updateTimestamp" : "2019-08-28T08:38:37.456Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_SddcManagerKnownHostsConfiguration_SddcManagerContractPlugin_UpdateKnownHostsOnSddcManager_3",
    "processingStateDescription" : "Update Known Hosts in SDDC Manager",
    "name" : "Update Known Hosts in SDDC Manager",
    "description" : "Update Known Hosts in SDDC Manager",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.sddcmanager.SddcManagerContractPlugin",
      "messageKey" : "UpdateKnownHostsOnSddcManager.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.sddcmanager.SddcManagerContractPlugin",
      "messageKey" : "UpdateKnownHostsOnSddcManager.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.459Z",
    "updateTimestamp" : "2019-08-28T08:38:37.459Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "GenerateVsphereInput",
    "processingStateDescription" : "Generate vSphere Input Data",
    "name" : "Generate vSphere Input Data",
    "description" : "Generate vSphere Input Data",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateVsphereInput.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateVsphereInput.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.462Z",
    "updateTimestamp" : "2019-08-28T08:38:37.462Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "GenerateSddcManagerInput",
    "processingStateDescription" : "Generate SDDC Manager Input Data",
    "name" : "Generate SDDC Manager Input Data",
    "description" : "Generate SDDC Manager Input Data",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateSddcManagerInput.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateSddcManagerInput.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.465Z",
    "updateTimestamp" : "2019-08-28T08:38:37.465Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_VcenterMessagesConfigurations_VsphereContractPlugin_PrepareVcenterMessages_2",
    "processingStateDescription" : "Generate Configure vCenter Login Message and Message of the Day Input Data",
    "name" : "Generate Configure vCenter Login Message and Message of the Day Input Data",
    "description" : "Generate Configure vCenter Login Message and Message of the Day Input Data",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.vsphere.contract.VsphereContractPlugin",
      "messageKey" : "PrepareVcenterMessages.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.vsphere.contract.VsphereContractPlugin",
      "messageKey" : "PrepareVcenterMessages.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.471Z",
    "updateTimestamp" : "2019-08-28T08:38:37.471Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_VcenterMessagesConfigurations_VsphereContractPlugin_ConfigureVcenterMessages_3",
    "processingStateDescription" : "Configure vCenter Login Message and Message of the Day",
    "name" : "Configure vCenter Login Message and Message of the Day",
    "description" : "Configure vCenter Login Message and Message of the Day",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.vsphere.contract.VsphereContractPlugin",
      "messageKey" : "ConfigureVcenterMessages.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.vsphere.contract.VsphereContractPlugin",
      "messageKey" : "ConfigureVcenterMessages.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.474Z",
    "updateTimestamp" : "2019-08-28T08:38:37.474Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "GenerateClusterConfigurationInput",
    "processingStateDescription" : "Generate Cluster Configuration Input Data",
    "name" : "Generate Post Cluster Configuration Input Data",
    "description" : "Generate Cluster Configuration Input Data",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateClusterConfigurationInput.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateClusterConfigurationInput.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.477Z",
    "updateTimestamp" : "2019-08-28T08:38:37.477Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "GenerateConfigureDeploymentDetailsActionInput",
    "processingStateDescription" : "Generate Configure Deployment Details Action Input Data",
    "name" : "Generate Configure Deployment Details Action Input Data",
    "description" : "Generate Configure Deployment Details Action Input Data",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateConfigureDeploymentDetailsActionInput.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateConfigureDeploymentDetailsActionInput.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.483Z",
    "updateTimestamp" : "2019-08-28T08:38:37.483Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_PostClusterConfiguration_VspherePlugin_MigrateVmsToFoldersAction_2",
    "processingStateDescription" : "Move VMs to VM Folders",
    "name" : "Move VMs to VM Folders",
    "description" : "Move VMs to VM Folders",
    "localizableNamePack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "MigrateVmsToFoldersAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "MigrateVmsToFoldersAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.486Z",
    "updateTimestamp" : "2019-08-28T08:38:37.486Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_PostClusterConfiguration_VspherePlugin_MigrateDvsToFolderAction_3",
    "processingStateDescription" : "Move vSphere Distributed Switch to Network Folder",
    "name" : "Move vSphere Distributed Switch to Network Folder",
    "description" : "Move vSphere Distributed Switch to Network Folder",
    "localizableNamePack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "MigrateDvsToFolderAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "MigrateDvsToFolderAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.489Z",
    "updateTimestamp" : "2019-08-28T08:38:37.489Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_PostClusterConfiguration_VspherePlugin_DisableVsanForceProvisionAction_4",
    "processingStateDescription" : "Disable vSAN Force Provisioning",
    "name" : "Disable vSAN Force Provisioning",
    "description" : "Disable vSAN Force Provisioning",
    "localizableNamePack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "DisableVsanForceProvisionAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "DisableVsanForceProvisionAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.492Z",
    "updateTimestamp" : "2019-08-28T08:38:37.492Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_PostClusterConfiguration_VspherePlugin_EnableVsanPoliciesAction_5",
    "processingStateDescription" : "Enable vSAN Storage Policies",
    "name" : "Enable vSAN Storage Policies",
    "description" : "Enable vSAN Storage Policies",
    "localizableNamePack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "EnableVsanPoliciesAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "EnableVsanPoliciesAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.496Z",
    "updateTimestamp" : "2019-08-28T08:38:37.496Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_PostClusterConfiguration_VspherePlugin_RelocateAllVmsToResourcePoolAction_6",
    "processingStateDescription" : "Move VMs to Resource Pools",
    "name" : "Move VMs to Resource Pools",
    "description" : "Move VMs to Resource Pools",
    "localizableNamePack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "RelocateAllVmsToResourcePoolAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "RelocateAllVmsToResourcePoolAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.499Z",
    "updateTimestamp" : "2019-08-28T08:38:37.499Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_PostClusterConfiguration_VspherePlugin_AdjustResourcePoolReservationAction_7",
    "processingStateDescription" : "Set Reservations on Resource Pools",
    "name" : "Set Reservations on Resource Pools",
    "description" : "Set Reservations on Resource Pools",
    "localizableNamePack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "AdjustResourcePoolReservationAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "AdjustResourcePoolReservationAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.502Z",
    "updateTimestamp" : "2019-08-28T08:38:37.502Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_PostClusterConfiguration_VcPlugin_EnableClusterHaAction_8",
    "processingStateDescription" : "Enable vSphere High Availability",
    "name" : "Enable vSphere High Availability",
    "description" : "Enable vSphere High Availability",
    "localizableNamePack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "EnableClusterHaAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "EnableClusterHaAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.505Z",
    "updateTimestamp" : "2019-08-28T08:38:37.505Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_PostClusterConfiguration_VcPlugin_CreateVmAntiAffinityRuleAction_9",
    "processingStateDescription" : "Create VM Anti-Affinity Rules",
    "name" : "Create VM Anti-Affinity Rules",
    "description" : "Create VM Anti-Affinity Rules",
    "localizableNamePack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "CreateVmAntiAffinityRuleAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "CreateVmAntiAffinityRuleAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.508Z",
    "updateTimestamp" : "2019-08-28T08:38:37.508Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_PostClusterConfiguration_CreatePscVcVmGroupsPlugin_CreatePscVcVmGroupsContractAction_10",
    "processingStateDescription" : "Create VM Groups",
    "name" : "Create VM Groups",
    "description" : "Create VM Groups",
    "localizableNamePack" : {
      "component" : "com.vmware.vcf.common.fsm.plugins.action.CreatePscVcVmGroupsPlugin",
      "messageKey" : "CreatePscVcVmGroupsContractAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.vcf.common.fsm.plugins.action.CreatePscVcVmGroupsPlugin",
      "messageKey" : "CreatePscVcVmGroupsContractAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.511Z",
    "updateTimestamp" : "2019-08-28T08:38:37.511Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_PostClusterConfiguration_VspherePlugin_CreateClusterVmsToVmsRuleContractAction_11",
    "processingStateDescription" : "Create VM-VM Startup Order Rule",
    "name" : "Create VM-VM Startup Order Rule",
    "description" : "Create VM-VM Startup Order Rule",
    "localizableNamePack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "CreateClusterVmsToVmsRuleContractAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "CreateClusterVmsToVmsRuleContractAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.514Z",
    "updateTimestamp" : "2019-08-28T08:38:37.514Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_PostClusterConfiguration_ClusterVmHostPlugin_CreateClusterHostGroupContractAction_12",
    "processingStateDescription" : "Create vCenter VM/Host RuleNsxServiceImpl.java",
    "name" : "Create vCenter VM/Host Rule",
    "description" : "Create vCenter VM/Host RuleNsxServiceImpl.java",
    "localizableNamePack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "CreateClusterHostGroupContractAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "CreateClusterHostGroupContractAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.517Z",
    "updateTimestamp" : "2019-08-28T08:38:37.517Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_PostClusterConfiguration_ClusterVmHostPlugin_CreateClusterVmHostRuleContractAction_13",
    "processingStateDescription" : "Create Platform Services Controller VM/Host Rule",
    "name" : "Create Platform Services Controller VM/Host Rule",
    "description" : "Create Platform Services Controller VM/Host Rule",
    "localizableNamePack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "CreatePSCVMHostRuleActionId.name"
    },
    "localizableDescriptionPack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "CreatePSCVMHostRuleActionId.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.520Z",
    "updateTimestamp" : "2019-08-28T08:38:37.520Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_PostClusterConfiguration_ClusterVmHostPlugin_CreateClusterVmHostRuleContractAction_14",
    "processingStateDescription" : "Create Cluster Rule",
    "name" : "Create Cluster Rule",
    "description" : "Create Cluster Rule",
    "localizableNamePack" : {
      "component" : "com.vmware.vcf.common.fsm.plugins.action.ClusterVmHostPlugin",
      "messageKey" : "CreateClusterVmHostRuleContractAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.vcf.common.fsm.plugins.action.ClusterVmHostPlugin",
      "messageKey" : "CreateClusterVmHostRuleContractAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.523Z",
    "updateTimestamp" : "2019-08-28T08:38:37.523Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_PostClusterConfiguration_VcPlugin_ConfigureEsxAdvancedOptionsAction_15",
    "processingStateDescription" : "Configure ESXi Advanced Options",
    "name" : "Configure ESXi Advanced Options",
    "description" : "Configure ESXi Advanced Options",
    "localizableNamePack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "ConfigureEsxAdvancedOptionsAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "ConfigureEsxAdvancedOptionsAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.526Z",
    "updateTimestamp" : "2019-08-28T08:38:37.526Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_PostClusterConfiguration_VspherePlugin_ReconfigureHAOnClusterAction_16",
    "processingStateDescription" : "Reconfigure vSphere High Availability",
    "name" : "Reconfigure vSphere High Availability",
    "description" : "Reconfigure vSphere High Availability",
    "localizableNamePack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "ReconfigureHAOnClusterAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "ReconfigureHAOnClusterAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.529Z",
    "updateTimestamp" : "2019-08-28T08:38:37.529Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_PostClusterConfiguration_VspherePlugin_ClearVsanAlarmsOnClusterAction_17",
    "processingStateDescription" : "Clear Alarms on vSAN",
    "name" : "Clear Alarms on vSAN",
    "description" : "Clear Alarms on vSAN",
    "localizableNamePack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "ClearVsanAlarmsOnClusterAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "ClearVsanAlarmsOnClusterAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.532Z",
    "updateTimestamp" : "2019-08-28T08:38:37.532Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_PostClusterConfiguration_VspherePlugin_ClearRedAlarmsOnHostAction_18",
    "processingStateDescription" : "Clear Alerts on Hosts",
    "name" : "Clear Alerts on Hosts",
    "description" : "Clear Alerts on Hosts",
    "localizableNamePack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "ClearRedAlarmsOnHostAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "ClearRedAlarmsOnHostAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.535Z",
    "updateTimestamp" : "2019-08-28T08:38:37.535Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_PostClusterConfiguration_VspherePlugin_ConfigureDeploymentDetailsContractAction_19",
    "processingStateDescription" : "Set SDDC Deployment Details on the Management vCenter Server",
    "name" : "Set SDDC Deployment Details on the Management vCenter Server",
    "description" : "Set SDDC Deployment Details on the Management vCenter Server",
    "localizableNamePack" : {
      "component" : "com.vmware.vcf.common.fsm.plugins.action.VspherePlugin",
      "messageKey" : "ConfigureDeploymentDetailsContractAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.vcf.common.fsm.plugins.action.VspherePlugin",
      "messageKey" : "ConfigureDeploymentDetailsContractAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.539Z",
    "updateTimestamp" : "2019-08-28T08:38:37.539Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "GenerateVsphereInput",
    "processingStateDescription" : "Generate vSphere Input Data",
    "name" : "Generate vSphere Input Data",
    "description" : "Generate vSphere Input Data",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateVsphereInput.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateVsphereInput.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.542Z",
    "updateTimestamp" : "2019-08-28T08:38:37.542Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_DisableBashShellOnVcAndPsc_VsphereContractPlugin_DisableBashShell_1",
    "processingStateDescription" : "Disable Bash Shell on vCenter Server",
    "name" : "Disable Bash Shell on vCenter Server",
    "description" : "Disable Bash Shell on vCenter Server",
    "localizableNamePack" : {
      "component" : "workflowconfig.common_recipes.DisableBashShellOnVcAndPsc",
      "messageKey" : "DisableBashShellOnVCenterId.name"
    },
    "localizableDescriptionPack" : {
      "component" : "workflowconfig.common_recipes.DisableBashShellOnVcAndPsc",
      "messageKey" : "DisableBashShellOnVCenterId.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.545Z",
    "updateTimestamp" : "2019-08-28T08:38:37.545Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_DisableBashShellOnVcAndPsc_VsphereContractPlugin_DisableBashShell_2",
    "processingStateDescription" : "Disable Bash Shell on Platform Services Controllers",
    "name" : "Disable Bash Shell on Platform Services Controllers",
    "description" : "Disable Bash Shell on Platform Services Controllers",
    "localizableNamePack" : {
      "component" : "workflowconfig.common_recipes.DisableBashShellOnVcAndPsc",
      "messageKey" : "DisableBashShellOnPSCsId.name"
    },
    "localizableDescriptionPack" : {
      "component" : "workflowconfig.common_recipes.DisableBashShellOnVcAndPsc",
      "messageKey" : "DisableBashShellOnPSCsId.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.548Z",
    "updateTimestamp" : "2019-08-28T08:38:37.548Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "NSXvConfigurationForSDDCManager",
    "processingStateDescription" : "Configure NSX for vSphere",
    "name" : "Add VMs to NSX Distributed Firewall Exclusion List",
    "description" : "Configure NSX for vSphere",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
      "messageKey" : "AddVmsIntoDfwExclusionList.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
      "messageKey" : "AddVmsIntoDfwExclusionList.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.551Z",
    "updateTimestamp" : "2019-08-28T08:38:37.551Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "NSXBackupConfiguration",
    "processingStateDescription" : "Configure Backup on NSX for vSphere",
    "name" : "Configure NSX Manager Backups",
    "description" : "Configure Backup on NSX for vSphere",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.plugin.spi.LcmPlugin",
      "messageKey" : "ConfigureBackupForNSX.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.plugin.spi.LcmPlugin",
      "messageKey" : "ConfigureBackupForNSX.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.554Z",
    "updateTimestamp" : "2019-08-28T08:38:37.554Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "GenerateLogInsightInput",
    "processingStateDescription" : "Generate vRealize Log Insight Input Data",
    "name" : "Generate vRealize Log Insight Input Data",
    "description" : "Generate vRealize Log Insight Input Data",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateLogInsightInput.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateLogInsightInput.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.557Z",
    "updateTimestamp" : "2019-08-28T08:38:37.557Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_LogInsightConfiguration_ConfigureLogInsightAgentPlugin_ConfigureSddcManagerInLogInsightAction_1",
    "processingStateDescription" : "Configure Syslog Settings for SDDC Manager",
    "name" : "Configure Syslog Settings for SDDC Manager",
    "description" : "Configure Syslog Settings for SDDC Manager",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.common.fsmplugins.loginsight.plugin.ConfigureLogInsightAgentPlugin",
      "messageKey" : "ConfigureSddcManagerInLogInsightAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.common.fsmplugins.loginsight.plugin.ConfigureLogInsightAgentPlugin",
      "messageKey" : "ConfigureSddcManagerInLogInsightAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.561Z",
    "updateTimestamp" : "2019-08-28T08:38:37.561Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_LogInsightConfiguration_ConfigureLogInsightAgentPlugin_ConfigureVCenterInLogInsightWithSyslogAction_2",
    "processingStateDescription" : "Configure Syslog Settings for vCenter Server",
    "name" : "Configure Syslog Settings for vCenter Server",
    "description" : "Configure Syslog Settings for vCenter Server",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.common.fsmplugins.loginsight.plugin.ConfigureLogInsightAgentPlugin",
      "messageKey" : "ConfigureVCenterInLogInsightWithSyslogAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.common.fsmplugins.loginsight.plugin.ConfigureLogInsightAgentPlugin",
      "messageKey" : "ConfigureVCenterInLogInsightWithSyslogAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.565Z",
    "updateTimestamp" : "2019-08-28T08:38:37.565Z"
  } ]
}

  1. Poll the task until "status" is not "IN_PROGRESS" using the "id" from the previous response.

Tip
 Refer to: Get a Task.

  • If the "status" is "SUCCESSFUL", the task is completed successfully.

  • If the "status" is "FAILED", the task can be re-executed.

Tip
 Refer to: Retry a Task.
Related APIs

Retrieve all SDDCs
Retrieve a SDDC
Retry failed SDDC creation

2.1.2. Get the SDDCS

Prerequisites
Note
 The username and password for Basic Authentication scheme using the Cloud Builder "admin" account.
The host in example requests is Cloud Builder address e.g. "sfo01cb01.sfo01.rainpole.local" not the SDDC Manager one.
Steps

  1. Invoke the API.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/sddcs/' -i -u 'admin:VMwareInfra@1' -X GET

HTTP Request

GET /v1/sddcs/ HTTP/1.1
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==

HTTP Response

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 105122

{
  "elements" : [ {
    "id" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "name" : "Bringup-Ems",
    "status" : "IN_PROGRESS",
    "creationTimestamp" : "2019-08-28T08:38:37.568Z",
    "sddcSubTasks" : [ {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "GenerateEsxiForVsanDedupInput",
      "processingStateDescription" : "Generate ESXi Host vSAN Deduplication Input Data",
      "name" : "Generate ESXi Host vSAN Deduplication Input Data",
      "description" : "Generate ESXi Host vSAN Deduplication Input Data",
      "localizableNamePack" : {
        "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
        "messageKey" : "GenerateEsxiForVsanDedupInput.name"
      },
      "localizableDescriptionPack" : {
        "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
        "messageKey" : "GenerateEsxiForVsanDedupInput.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.568Z",
      "updateTimestamp" : "2019-08-28T08:38:37.568Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "GenerateEsxiInput",
      "processingStateDescription" : "Generate ESXi Host Input Data",
      "name" : "Generate ESXi Host Input Data",
      "description" : "Generate ESXi Host Input Data",
      "localizableNamePack" : {
        "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
        "messageKey" : "GenerateEsxiInput.name"
      },
      "localizableDescriptionPack" : {
        "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
        "messageKey" : "GenerateEsxiInput.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.216Z",
      "updateTimestamp" : "2019-08-28T08:38:37.216Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "_InitialEnvironmentSetup_VspherePlugin_PrepareEsxiForVsanDedupAction_2",
      "processingStateDescription" : "Prepare ESXi Hosts for vSAN with Deduplication",
      "name" : "Prepare ESXi Hosts for vSAN with Deduplication Action",
      "description" : "Prepare ESXi Hosts for vSAN with Deduplication",
      "localizableNamePack" : {
        "component" : "com.vmware.vcf.common.fsm.plugins.action.VspherePlugin",
        "messageKey" : "PrepareEsxiForVsanDedupAction.name"
      },
      "localizableDescriptionPack" : {
        "component" : "com.vmware.vcf.common.fsm.plugins.action.VspherePlugin",
        "messageKey" : "PrepareEsxiForVsanDedupAction.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.220Z",
      "updateTimestamp" : "2019-08-28T08:38:37.220Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "_InitialEnvironmentSetup_VspherePlugin_EnableVsanDedupOnFirstHostAction_3",
      "processingStateDescription" : "Enable vSAN Deduplication for the First Host",
      "name" : "Enable vSAN Deduplication for the First Host Action",
      "description" : "Enable vSAN Deduplication for the First Host",
      "localizableNamePack" : {
        "component" : "com.vmware.vcf.common.fsm.plugins.action.VspherePlugin",
        "messageKey" : "EnableVsanDedupOnFirstHostAction.name"
      },
      "localizableDescriptionPack" : {
        "component" : "com.vmware.vcf.common.fsm.plugins.action.VspherePlugin",
        "messageKey" : "EnableVsanDedupOnFirstHostAction.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.224Z",
      "updateTimestamp" : "2019-08-28T08:38:37.224Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "_InitialEnvironmentSetup_HostPlugin_CreateVmPortGroupAction_4",
      "processingStateDescription" : "Create 'VM Network' Portgroup on ESXi Hosts",
      "name" : "Create 'VM Network' Portgroup on ESXi Hosts",
      "description" : "Create 'VM Network' Portgroup on ESXi Hosts",
      "localizableNamePack" : {
        "component" : "com.vmware.vcf.common.fsm.plugins.action.HostPlugin",
        "messageKey" : "CreateVmPortGroupAction.name"
      },
      "localizableDescriptionPack" : {
        "component" : "com.vmware.vcf.common.fsm.plugins.action.HostPlugin",
        "messageKey" : "CreateVmPortGroupAction.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.227Z",
      "updateTimestamp" : "2019-08-28T08:38:37.227Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "_InitialEnvironmentSetup_HostPlugin_ReconfigureHostDnsAction_5",
      "processingStateDescription" : "Configure ESXi Host DNS",
      "name" : "Configure ESXi Host DNS",
      "description" : "Configure ESXi Host DNS",
      "localizableNamePack" : {
        "component" : "com.vmware.vcf.common.fsm.plugins.action.HostPlugin",
        "messageKey" : "ReconfigureHostDnsAction.name"
      },
      "localizableDescriptionPack" : {
        "component" : "com.vmware.vcf.common.fsm.plugins.action.HostPlugin",
        "messageKey" : "ReconfigureHostDnsAction.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.231Z",
      "updateTimestamp" : "2019-08-28T08:38:37.231Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "_InitialEnvironmentSetup_com.vmware.evo.sddc.bringup.plugin.spi.VspherePlugin_DetermineSoftwareVersionAction_6",
      "processingStateDescription" : "Determine Software Version on ESXi Hosts",
      "name" : "Determine Software Version on ESXi Hosts",
      "description" : "Determine Software Version on ESXi Hosts",
      "localizableNamePack" : {
        "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
        "messageKey" : "DetermineSoftwareVersionAction.name"
      },
      "localizableDescriptionPack" : {
        "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
        "messageKey" : "DetermineSoftwareVersionAction.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.234Z",
      "updateTimestamp" : "2019-08-28T08:38:37.234Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "PSCDeploymentInputGeneration",
      "processingStateDescription" : "Generate Platform Services Controller Deployment Input Data",
      "name" : "Generate Platform Services Controller Deployment Input Data",
      "description" : "Generate Platform Services Controller Deployment Input Data",
      "localizableNamePack" : {
        "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
        "messageKey" : "PSCDeploymentInputGeneration.name"
      },
      "localizableDescriptionPack" : {
        "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
        "messageKey" : "PSCDeploymentInputGeneration.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.238Z",
      "updateTimestamp" : "2019-08-28T08:38:37.238Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "_PSCDeployment_PscPlugin_DeployPsc1Action_1",
      "processingStateDescription" : "Deploy Platform Service Controller",
      "name" : "Deploy Platform Service Controller",
      "description" : "Deploy Platform Service Controller",
      "localizableNamePack" : {
        "component" : "com.vmware.vcf.common.fsm.plugins.action.plugins.PscPlugin",
        "messageKey" : "DeployPsc1Action.name"
      },
      "localizableDescriptionPack" : {
        "component" : "com.vmware.vcf.common.fsm.plugins.action.plugins.PscPlugin",
        "messageKey" : "DeployPsc1Action.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.243Z",
      "updateTimestamp" : "2019-08-28T08:38:37.243Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "_PSCDeployment_PscPlugin_CreateUserGroupsAction_2",
      "processingStateDescription" : "Create Admin User Groups in vsphere.local Domain",
      "name" : "Create Admin User Groups in vsphere.local Domain",
      "description" : "Create Admin User Groups in vsphere.local Domain",
      "localizableNamePack" : {
        "component" : "com.vmware.vcf.common.fsm.plugins.action.plugins.PscPlugin",
        "messageKey" : "CreateUserGroupsAction.name"
      },
      "localizableDescriptionPack" : {
        "component" : "com.vmware.vcf.common.fsm.plugins.action.plugins.PscPlugin",
        "messageKey" : "CreateUserGroupsAction.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.248Z",
      "updateTimestamp" : "2019-08-28T08:38:37.248Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "_GenerateLicenseRenameInput_ProxyContractPlugin_ProxyContractAction_0",
      "processingStateDescription" : "Automation Helper Action",
      "name" : "ProxyContractAction",
      "description" : "Automation Helper Action",
      "localizableNamePack" : {
        "component" : "com.vmware.evo.sddc.orchestrator.core.recipes.spel.ProxyContractPlugin",
        "messageKey" : "ProxyContractAction.name"
      },
      "localizableDescriptionPack" : {
        "component" : "com.vmware.evo.sddc.orchestrator.core.recipes.spel.ProxyContractPlugin",
        "messageKey" : "ProxyContractAction.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.253Z",
      "updateTimestamp" : "2019-08-28T08:38:37.253Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "GenerateLicenseRenameInput",
      "processingStateDescription" : "Generate license rename input",
      "name" : "Generate vCenter License Rename Input Data",
      "description" : "Generate license rename input",
      "localizableNamePack" : {
        "component" : "com.vmware.evo.sddc.input.generation.recipes.GenerateLicenseRenameInput",
        "messageKey" : "GenerateLicenseRenameInput.name"
      },
      "localizableDescriptionPack" : {
        "component" : "com.vmware.evo.sddc.input.generation.recipes.GenerateLicenseRenameInput",
        "messageKey" : "GenerateLicenseRenameInput.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.258Z",
      "updateTimestamp" : "2019-08-28T08:38:37.258Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "GenerateVcDeploymentInput",
      "processingStateDescription" : "Generate Vc Deployment Input",
      "name" : "Generate vCenter Server Deployment Input Data",
      "description" : "Generate Vc Deployment Input",
      "localizableNamePack" : {
        "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
        "messageKey" : "GenerateVcDeploymentInput.name"
      },
      "localizableDescriptionPack" : {
        "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
        "messageKey" : "GenerateVcDeploymentInput.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.264Z",
      "updateTimestamp" : "2019-08-28T08:38:37.264Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "_VCDeployment_VcPlugin_DeployVcAction_3",
      "processingStateDescription" : "Deploy vCenter Server",
      "name" : "Deploy vCenter Server",
      "description" : "Deploy vCenter Server",
      "localizableNamePack" : {
        "component" : "com.vmware.vcf.common.fsm.plugins.action.plugins.VcPlugin",
        "messageKey" : "DeployVcAction.name"
      },
      "localizableDescriptionPack" : {
        "component" : "com.vmware.vcf.common.fsm.plugins.action.plugins.VcPlugin",
        "messageKey" : "DeployVcAction.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.269Z",
      "updateTimestamp" : "2019-08-28T08:38:37.269Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "_VCDeployment_VcPlugin_ApplyVcLicenseAction_4",
      "processingStateDescription" : "Apply vCenter Server, vSphere, and vSAN Licenses",
      "name" : "Apply vCenter Server, vSphere, and vSAN Licenses",
      "description" : "Apply vCenter Server, vSphere, and vSAN Licenses",
      "localizableNamePack" : {
        "component" : "workflowconfig.ems_recipes.VCDeployment",
        "messageKey" : "ApplyVcLicenseAction.name"
      },
      "localizableDescriptionPack" : {
        "component" : "workflowconfig.ems_recipes.VCDeployment",
        "messageKey" : "ApplyVcLicenseAction.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.272Z",
      "updateTimestamp" : "2019-08-28T08:38:37.272Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "_VCDeployment_LicensePlugin_RenameLicense_5",
      "processingStateDescription" : "Rename the Applied vCenter License in vCenter Server",
      "name" : "Rename the Applied vCenter License in vCenter Server",
      "description" : "Rename the Applied vCenter License in vCenter Server",
      "localizableNamePack" : {
        "component" : "workflowconfig.ems_recipes.VCDeployment",
        "messageKey" : "RenameLicense.name"
      },
      "localizableDescriptionPack" : {
        "component" : "workflowconfig.ems_recipes.VCDeployment",
        "messageKey" : "RenameLicense.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.276Z",
      "updateTimestamp" : "2019-08-28T08:38:37.276Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "ManagementClusterConfiguration",
      "processingStateDescription" : "Create Vsphere Cluster",
      "name" : "Create vSphere Cluster",
      "description" : "Create Vsphere Cluster",
      "localizableNamePack" : {
        "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
        "messageKey" : "CreateCluster.name"
      },
      "localizableDescriptionPack" : {
        "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
        "messageKey" : "CreateCluster.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.281Z",
      "updateTimestamp" : "2019-08-28T08:38:37.281Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "ManagementClusterConfiguration",
      "processingStateDescription" : "Create Vsphere Cluster",
      "name" : "Enable vSphere DRS",
      "description" : "Create Vsphere Cluster",
      "localizableNamePack" : {
        "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
        "messageKey" : "EnableClusterDrs.name"
      },
      "localizableDescriptionPack" : {
        "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
        "messageKey" : "EnableClusterDrs.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.281Z",
      "updateTimestamp" : "2019-08-28T08:38:37.281Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "ManagementClusterConfiguration",
      "processingStateDescription" : "Create Vsphere Cluster",
      "name" : "Apply vSAN Dormant License File (DLF)",
      "description" : "Create Vsphere Cluster",
      "localizableNamePack" : {
        "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
        "messageKey" : "ApplyVsanDlf.name"
      },
      "localizableDescriptionPack" : {
        "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
        "messageKey" : "ApplyVsanDlf.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.281Z",
      "updateTimestamp" : "2019-08-28T08:38:37.281Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "ManagementClusterConfiguration",
      "processingStateDescription" : "Create Vsphere Cluster",
      "name" : "Apply vSAN License",
      "description" : "Create Vsphere Cluster",
      "localizableNamePack" : {
        "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
        "messageKey" : "ApplyVsanLicense.name"
      },
      "localizableDescriptionPack" : {
        "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
        "messageKey" : "ApplyVsanLicense.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.281Z",
      "updateTimestamp" : "2019-08-28T08:38:37.281Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "ManagementClusterConfiguration",
      "processingStateDescription" : "Create Vsphere Cluster",
      "name" : "Generate vSAN License Rename Input Data",
      "description" : "Create Vsphere Cluster",
      "localizableNamePack" : {
        "component" : "workflowconfig.ems_recipes.ManagementClusterConfiguration",
        "messageKey" : "GenerateVSANLicenseRenameInputId.name"
      },
      "localizableDescriptionPack" : {
        "component" : "workflowconfig.ems_recipes.ManagementClusterConfiguration",
        "messageKey" : "GenerateVSANLicenseRenameInputId.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.281Z",
      "updateTimestamp" : "2019-08-28T08:38:37.281Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "ManagementClusterConfiguration",
      "processingStateDescription" : "Create Vsphere Cluster",
      "name" : "Rename the Applied VSAN License in vCenter Server",
      "description" : "Create Vsphere Cluster",
      "localizableNamePack" : {
        "component" : "workflowconfig.ems_recipes.ManagementClusterConfiguration",
        "messageKey" : "RenameVSANLicenseId.name"
      },
      "localizableDescriptionPack" : {
        "component" : "workflowconfig.ems_recipes.ManagementClusterConfiguration",
        "messageKey" : "RenameVSANLicenseId.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.281Z",
      "updateTimestamp" : "2019-08-28T08:38:37.281Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "ManagementClusterConfiguration",
      "processingStateDescription" : "Create Vsphere Cluster",
      "name" : "Assign Administrator Privileges to SDDCAdmins Group",
      "description" : "Create Vsphere Cluster",
      "localizableNamePack" : {
        "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
        "messageKey" : "AuthorizeSddcAdminGroup.name"
      },
      "localizableDescriptionPack" : {
        "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
        "messageKey" : "AuthorizeSddcAdminGroup.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.281Z",
      "updateTimestamp" : "2019-08-28T08:38:37.281Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "ManagementClusterConfiguration",
      "processingStateDescription" : "Create Vsphere Cluster",
      "name" : "Create vSphere Distributed Switch",
      "description" : "Create Vsphere Cluster",
      "localizableNamePack" : {
        "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
        "messageKey" : "CreateDvs.name"
      },
      "localizableDescriptionPack" : {
        "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
        "messageKey" : "CreateDvs.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.281Z",
      "updateTimestamp" : "2019-08-28T08:38:37.281Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "ManagementClusterConfiguration",
      "processingStateDescription" : "Create Vsphere Cluster",
      "name" : "Add ESXi Host to vSphere Cluster",
      "description" : "Create Vsphere Cluster",
      "localizableNamePack" : {
        "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
        "messageKey" : "AddHostToCluster.name"
      },
      "localizableDescriptionPack" : {
        "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
        "messageKey" : "AddHostToCluster.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.281Z",
      "updateTimestamp" : "2019-08-28T08:38:37.281Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "ManagementClusterConfiguration",
      "processingStateDescription" : "Create Vsphere Cluster",
      "name" : "Enable/Disable EVC Mode on vSphere Cluster",
      "description" : "Create Vsphere Cluster",
      "localizableNamePack" : {
        "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
        "messageKey" : "EnableEvc.name"
      },
      "localizableDescriptionPack" : {
        "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
        "messageKey" : "EnableEvc.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.281Z",
      "updateTimestamp" : "2019-08-28T08:38:37.281Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "ManagementClusterConfiguration",
      "processingStateDescription" : "Create Vsphere Cluster",
      "name" : "Add ESXi Hosts to vSphere Distributed Switch",
      "description" : "Create Vsphere Cluster",
      "localizableNamePack" : {
        "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
        "messageKey" : "AddHostToDvswitch.name"
      },
      "localizableDescriptionPack" : {
        "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
        "messageKey" : "AddHostToDvswitch.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.281Z",
      "updateTimestamp" : "2019-08-28T08:38:37.281Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "ManagementClusterConfiguration",
      "processingStateDescription" : "Create Vsphere Cluster",
      "name" : "Create VM Folders",
      "description" : "Create Vsphere Cluster",
      "localizableNamePack" : {
        "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
        "messageKey" : "CreateVmFolders.name"
      },
      "localizableDescriptionPack" : {
        "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
        "messageKey" : "CreateVmFolders.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.281Z",
      "updateTimestamp" : "2019-08-28T08:38:37.281Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "ManagementClusterConfiguration",
      "processingStateDescription" : "Create Vsphere Cluster",
      "name" : "Create Network Folders",
      "description" : "Create Vsphere Cluster",
      "localizableNamePack" : {
        "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
        "messageKey" : "CreateNetworkFolders.name"
      },
      "localizableDescriptionPack" : {
        "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
        "messageKey" : "CreateNetworkFolders.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.281Z",
      "updateTimestamp" : "2019-08-28T08:38:37.281Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "ManagementClusterConfiguration",
      "processingStateDescription" : "Create Vsphere Cluster",
      "name" : "Create vMotion vmknics",
      "description" : "Create Vsphere Cluster",
      "localizableNamePack" : {
        "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
        "messageKey" : "CreateVmotionVmknics.name"
      },
      "localizableDescriptionPack" : {
        "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
        "messageKey" : "CreateVmotionVmknics.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.281Z",
      "updateTimestamp" : "2019-08-28T08:38:37.281Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "ManagementClusterConfiguration",
      "processingStateDescription" : "Create Vsphere Cluster",
      "name" : "Create vSAN vmknics",
      "description" : "Create Vsphere Cluster",
      "localizableNamePack" : {
        "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
        "messageKey" : "CreateVsanVmknics.name"
      },
      "localizableDescriptionPack" : {
        "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
        "messageKey" : "CreateVsanVmknics.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.281Z",
      "updateTimestamp" : "2019-08-28T08:38:37.281Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "ManagementClusterConfiguration",
      "processingStateDescription" : "Create Vsphere Cluster",
      "name" : "Configure VLANs on vSphere Distributed Switch Portgroups",
      "description" : "Create Vsphere Cluster",
      "localizableNamePack" : {
        "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
        "messageKey" : "TagVlanIdsOnPortgroups.name"
      },
      "localizableDescriptionPack" : {
        "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
        "messageKey" : "TagVlanIdsOnPortgroups.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.281Z",
      "updateTimestamp" : "2019-08-28T08:38:37.281Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "ManagementClusterConfiguration",
      "processingStateDescription" : "Create Vsphere Cluster",
      "name" : "Migrate VMs to vSphere Distributed Switch",
      "description" : "Create Vsphere Cluster",
      "localizableNamePack" : {
        "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
        "messageKey" : "MigrateVmsToPortgroups.name"
      },
      "localizableDescriptionPack" : {
        "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
        "messageKey" : "MigrateVmsToPortgroups.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.281Z",
      "updateTimestamp" : "2019-08-28T08:38:37.281Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "ManagementClusterConfiguration",
      "processingStateDescription" : "Create Vsphere Cluster",
      "name" : "Migrate ESXi Host vmknics to vSphere Distributed Switch",
      "description" : "Create Vsphere Cluster",
      "localizableNamePack" : {
        "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
        "messageKey" : "MigrateHostVmknicsToPortgroups.name"
      },
      "localizableDescriptionPack" : {
        "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
        "messageKey" : "MigrateHostVmknicsToPortgroups.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.281Z",
      "updateTimestamp" : "2019-08-28T08:38:37.281Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "ManagementClusterConfiguration",
      "processingStateDescription" : "Create Vsphere Cluster",
      "name" : "Detach ESXi Host vmnics from vSphere Standard Switch",
      "description" : "Create Vsphere Cluster",
      "localizableNamePack" : {
        "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
        "messageKey" : "DetachVmnicFromVswitch.name"
      },
      "localizableDescriptionPack" : {
        "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
        "messageKey" : "DetachVmnicFromVswitch.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.281Z",
      "updateTimestamp" : "2019-08-28T08:38:37.281Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "ManagementClusterConfiguration",
      "processingStateDescription" : "Create Vsphere Cluster",
      "name" : "Attach ESXi Host vmnics to vSphere Distributed Switch",
      "description" : "Create Vsphere Cluster",
      "localizableNamePack" : {
        "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
        "messageKey" : "AttachVmnicToDvs.name"
      },
      "localizableDescriptionPack" : {
        "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
        "messageKey" : "AttachVmnicToDvs.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.281Z",
      "updateTimestamp" : "2019-08-28T08:38:37.281Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "ManagementClusterConfiguration",
      "processingStateDescription" : "Create Vsphere Cluster",
      "name" : "Remove vSphere Standard Switch",
      "description" : "Create Vsphere Cluster",
      "localizableNamePack" : {
        "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
        "messageKey" : "RemoveVswitch.name"
      },
      "localizableDescriptionPack" : {
        "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
        "messageKey" : "RemoveVswitch.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.281Z",
      "updateTimestamp" : "2019-08-28T08:38:37.281Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "ManagementClusterConfiguration",
      "processingStateDescription" : "Create Vsphere Cluster",
      "name" : "Update vSAN Hardware Compatability List (HCL) Database",
      "description" : "Create Vsphere Cluster",
      "localizableNamePack" : {
        "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
        "messageKey" : "UpdateVsanHcl.name"
      },
      "localizableDescriptionPack" : {
        "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
        "messageKey" : "UpdateVsanHcl.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.281Z",
      "updateTimestamp" : "2019-08-28T08:38:37.281Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "ManagementClusterConfiguration",
      "processingStateDescription" : "Create Vsphere Cluster",
      "name" : "Enable vSAN",
      "description" : "Create Vsphere Cluster",
      "localizableNamePack" : {
        "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
        "messageKey" : "EnableVsan.name"
      },
      "localizableDescriptionPack" : {
        "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
        "messageKey" : "EnableVsan.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.281Z",
      "updateTimestamp" : "2019-08-28T08:38:37.281Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "ManagementClusterConfiguration",
      "processingStateDescription" : "Create Vsphere Cluster",
      "name" : "Enable vSAN Deduplication on Cluster",
      "description" : "Create Vsphere Cluster",
      "localizableNamePack" : {
        "component" : "com.vmware.vcf.common.fsm.plugins.action.VspherePlugin",
        "messageKey" : "EnableVsanDedupOnClusterAction.name"
      },
      "localizableDescriptionPack" : {
        "component" : "com.vmware.vcf.common.fsm.plugins.action.VspherePlugin",
        "messageKey" : "EnableVsanDedupOnClusterAction.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.281Z",
      "updateTimestamp" : "2019-08-28T08:38:37.281Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "ManagementClusterConfiguration",
      "processingStateDescription" : "Create Vsphere Cluster",
      "name" : "Enable vSAN Storage Policies",
      "description" : "Create Vsphere Cluster",
      "localizableNamePack" : {
        "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
        "messageKey" : "EnableVsanPolicies.name"
      },
      "localizableDescriptionPack" : {
        "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
        "messageKey" : "EnableVsanPolicies.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.281Z",
      "updateTimestamp" : "2019-08-28T08:38:37.281Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "ManagementClusterConfiguration",
      "processingStateDescription" : "Create Vsphere Cluster",
      "name" : "Create vSAN Disk Groups",
      "description" : "Create Vsphere Cluster",
      "localizableNamePack" : {
        "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
        "messageKey" : "VsanClaimDisks.name"
      },
      "localizableDescriptionPack" : {
        "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
        "messageKey" : "VsanClaimDisks.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.281Z",
      "updateTimestamp" : "2019-08-28T08:38:37.281Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "ManagementClusterConfiguration",
      "processingStateDescription" : "Create Vsphere Cluster",
      "name" : "Create Resource Pools in vCenter Server",
      "description" : "Create Vsphere Cluster",
      "localizableNamePack" : {
        "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
        "messageKey" : "CreateResourcePool.name"
      },
      "localizableDescriptionPack" : {
        "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
        "messageKey" : "CreateResourcePool.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.281Z",
      "updateTimestamp" : "2019-08-28T08:38:37.281Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "ApplyEsxLicense",
      "processingStateDescription" : "Apply ESXi Host License Key",
      "name" : "Apply ESXi Host License Key",
      "description" : "Apply ESXi Host License Key",
      "localizableNamePack" : {
        "component" : "workflowconfig.ems_recipes.ApplyEsxLicense",
        "messageKey" : "ApplyEsxiLicenseInVcAction.name"
      },
      "localizableDescriptionPack" : {
        "component" : "workflowconfig.ems_recipes.ApplyEsxLicense",
        "messageKey" : "ApplyEsxiLicenseInVcAction.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.321Z",
      "updateTimestamp" : "2019-08-28T08:38:37.321Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "ApplyEsxLicense",
      "processingStateDescription" : "Apply ESXi Host License Key",
      "name" : "Generate ESXi License Rename Input Data",
      "description" : "Apply ESXi Host License Key",
      "localizableNamePack" : {
        "component" : "workflowconfig.ems_recipes.ApplyEsxLicense",
        "messageKey" : "GenerateLicenseRenameInput.name"
      },
      "localizableDescriptionPack" : {
        "component" : "workflowconfig.ems_recipes.ApplyEsxLicense",
        "messageKey" : "GenerateLicenseRenameInput.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.321Z",
      "updateTimestamp" : "2019-08-28T08:38:37.321Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "ApplyEsxLicense",
      "processingStateDescription" : "Apply ESXi Host License Key",
      "name" : "Rename the Applied ESXi License in vCenter Server",
      "description" : "Apply ESXi Host License Key",
      "localizableNamePack" : {
        "component" : "workflowconfig.ems_recipes.ApplyEsxLicense",
        "messageKey" : "RenameLicense.name"
      },
      "localizableDescriptionPack" : {
        "component" : "workflowconfig.ems_recipes.ApplyEsxLicense",
        "messageKey" : "RenameLicense.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.321Z",
      "updateTimestamp" : "2019-08-28T08:38:37.321Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "NSXvConfiguration",
      "processingStateDescription" : "Deploy and Configure NSX for vSphere",
      "name" : "Deploy NSX Manager",
      "description" : "Deploy and Configure NSX for vSphere",
      "localizableNamePack" : {
        "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
        "messageKey" : "DeployNsxManager.name"
      },
      "localizableDescriptionPack" : {
        "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
        "messageKey" : "DeployNsxManager.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.328Z",
      "updateTimestamp" : "2019-08-28T08:38:37.328Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "NSXvConfiguration",
      "processingStateDescription" : "Deploy and Configure NSX for vSphere",
      "name" : "Generate and Install VMCA Certificate on NSX Manager",
      "description" : "Deploy and Configure NSX for vSphere",
      "localizableNamePack" : {
        "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
        "messageKey" : "UploadNsxManagerVmcaCert.name"
      },
      "localizableDescriptionPack" : {
        "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
        "messageKey" : "UploadNsxManagerVmcaCert.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.328Z",
      "updateTimestamp" : "2019-08-28T08:38:37.328Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "NSXvConfiguration",
      "processingStateDescription" : "Deploy and Configure NSX for vSphere",
      "name" : "Update NSX Manager TLS Settings",
      "description" : "Deploy and Configure NSX for vSphere",
      "localizableNamePack" : {
        "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
        "messageKey" : "UpdateNsxManagerTLSSettings.name"
      },
      "localizableDescriptionPack" : {
        "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
        "messageKey" : "UpdateNsxManagerTLSSettings.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.328Z",
      "updateTimestamp" : "2019-08-28T08:38:37.328Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "NSXvConfiguration",
      "processingStateDescription" : "Deploy and Configure NSX for vSphere",
      "name" : "Register NSX Manager with vCenter Server",
      "description" : "Deploy and Configure NSX for vSphere",
      "localizableNamePack" : {
        "component" : "com.vmware.evo.sddc.bringup.nsx.action64.NsxServicePluginActionPlugin64",
        "messageKey" : "RegisterVcNsx.name"
      },
      "localizableDescriptionPack" : {
        "component" : "com.vmware.evo.sddc.bringup.nsx.action64.NsxServicePluginActionPlugin64",
        "messageKey" : "RegisterVcNsx.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.328Z",
      "updateTimestamp" : "2019-08-28T08:38:37.328Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "NSXvConfiguration",
      "processingStateDescription" : "Deploy and Configure NSX for vSphere",
      "name" : "Apply NSX Dormant License File (DLF)",
      "description" : "Deploy and Configure NSX for vSphere",
      "localizableNamePack" : {
        "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
        "messageKey" : "UploadNsxDlf.name"
      },
      "localizableDescriptionPack" : {
        "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
        "messageKey" : "UploadNsxDlf.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.328Z",
      "updateTimestamp" : "2019-08-28T08:38:37.328Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "NSXvConfiguration",
      "processingStateDescription" : "Deploy and Configure NSX for vSphere",
      "name" : "Apply NSX License",
      "description" : "Deploy and Configure NSX for vSphere",
      "localizableNamePack" : {
        "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
        "messageKey" : "ApplyNsxLicense.name"
      },
      "localizableDescriptionPack" : {
        "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
        "messageKey" : "ApplyNsxLicense.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.328Z",
      "updateTimestamp" : "2019-08-28T08:38:37.328Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "NSXvConfiguration",
      "processingStateDescription" : "Deploy and Configure NSX for vSphere",
      "name" : "Generate NSX License Rename Input Data",
      "description" : "Deploy and Configure NSX for vSphere",
      "localizableNamePack" : {
        "component" : "workflowconfig.ems_recipes.NSXvConfiguration",
        "messageKey" : "GenerateLicenseRenameInputId.name"
      },
      "localizableDescriptionPack" : {
        "component" : "workflowconfig.ems_recipes.NSXvConfiguration",
        "messageKey" : "GenerateLicenseRenameInputId.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.328Z",
      "updateTimestamp" : "2019-08-28T08:38:37.328Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "NSXvConfiguration",
      "processingStateDescription" : "Deploy and Configure NSX for vSphere",
      "name" : "Rename the Applied NSX License in vCenter Server",
      "description" : "Deploy and Configure NSX for vSphere",
      "localizableNamePack" : {
        "component" : "workflowconfig.ems_recipes.NSXvConfiguration",
        "messageKey" : "RenameLicenseId.name"
      },
      "localizableDescriptionPack" : {
        "component" : "workflowconfig.ems_recipes.NSXvConfiguration",
        "messageKey" : "RenameLicenseId.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.328Z",
      "updateTimestamp" : "2019-08-28T08:38:37.328Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "NSXvConfiguration",
      "processingStateDescription" : "Deploy and Configure NSX for vSphere",
      "name" : "Generate NSX Manager Input Data",
      "description" : "Deploy and Configure NSX for vSphere",
      "localizableNamePack" : {
        "component" : "com.vmware.evo.sddc.vvd.plugin.VvdPlugin",
        "messageKey" : "GenerateNsxInput.name"
      },
      "localizableDescriptionPack" : {
        "component" : "com.vmware.evo.sddc.vvd.plugin.VvdPlugin",
        "messageKey" : "GenerateNsxInput.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.328Z",
      "updateTimestamp" : "2019-08-28T08:38:37.328Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "NSXvConfiguration",
      "processingStateDescription" : "Deploy and Configure NSX for vSphere",
      "name" : "Configure DNS on the NSX Controller Cluster",
      "description" : "Deploy and Configure NSX for vSphere",
      "localizableNamePack" : {
        "component" : "com.vmware.evo.sddc.common.nsx.NsxManagerPlugin",
        "messageKey" : "ConfigureControllerDns.name"
      },
      "localizableDescriptionPack" : {
        "component" : "com.vmware.evo.sddc.common.nsx.NsxManagerPlugin",
        "messageKey" : "ConfigureControllerDns.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.328Z",
      "updateTimestamp" : "2019-08-28T08:38:37.328Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "NSXvConfiguration",
      "processingStateDescription" : "Deploy and Configure NSX for vSphere",
      "name" : "Configure NTP on the NSX Controller Cluster",
      "description" : "Deploy and Configure NSX for vSphere",
      "localizableNamePack" : {
        "component" : "com.vmware.evo.sddc.common.nsx.NsxManagerPlugin",
        "messageKey" : "ConfigureControllerNtp.name"
      },
      "localizableDescriptionPack" : {
        "component" : "com.vmware.evo.sddc.common.nsx.NsxManagerPlugin",
        "messageKey" : "ConfigureControllerNtp.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.328Z",
      "updateTimestamp" : "2019-08-28T08:38:37.328Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "NSXvConfiguration",
      "processingStateDescription" : "Deploy and Configure NSX for vSphere",
      "name" : "Create NSX Controller Cluster",
      "description" : "Deploy and Configure NSX for vSphere",
      "localizableNamePack" : {
        "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
        "messageKey" : "DeployNsxController.name"
      },
      "localizableDescriptionPack" : {
        "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
        "messageKey" : "DeployNsxController.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.328Z",
      "updateTimestamp" : "2019-08-28T08:38:37.328Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "NSXvConfiguration",
      "processingStateDescription" : "Deploy and Configure NSX for vSphere",
      "name" : "Configure VXLAN Transport",
      "description" : "Deploy and Configure NSX for vSphere",
      "localizableNamePack" : {
        "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
        "messageKey" : "CreateVxlan.name"
      },
      "localizableDescriptionPack" : {
        "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
        "messageKey" : "CreateVxlan.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.328Z",
      "updateTimestamp" : "2019-08-28T08:38:37.328Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "NSXvConfiguration",
      "processingStateDescription" : "Deploy and Configure NSX for vSphere",
      "name" : "Resolve NSX Cluster Issues",
      "description" : "Deploy and Configure NSX for vSphere",
      "localizableNamePack" : {
        "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
        "messageKey" : "ResolveNsxClusterIssues.name"
      },
      "localizableDescriptionPack" : {
        "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
        "messageKey" : "ResolveNsxClusterIssues.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.328Z",
      "updateTimestamp" : "2019-08-28T08:38:37.328Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "NSXvConfiguration",
      "processingStateDescription" : "Deploy and Configure NSX for vSphere",
      "name" : "Set Universal Sync Role on NSX Manager",
      "description" : "Deploy and Configure NSX for vSphere",
      "localizableNamePack" : {
        "component" : "com.vmware.vcf.common.fsm.plugins.action.nsx.NsxPlugin",
        "messageKey" : "SetNsxRoleAction.name"
      },
      "localizableDescriptionPack" : {
        "component" : "com.vmware.vcf.common.fsm.plugins.action.nsx.NsxPlugin",
        "messageKey" : "SetNsxRoleAction.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.328Z",
      "updateTimestamp" : "2019-08-28T08:38:37.328Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "NSXvConfiguration",
      "processingStateDescription" : "Deploy and Configure NSX for vSphere",
      "name" : "Create NSX Segment Range",
      "description" : "Deploy and Configure NSX for vSphere",
      "localizableNamePack" : {
        "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
        "messageKey" : "CreateNsxSegmentRange.name"
      },
      "localizableDescriptionPack" : {
        "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
        "messageKey" : "CreateNsxSegmentRange.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.328Z",
      "updateTimestamp" : "2019-08-28T08:38:37.328Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "NSXvConfiguration",
      "processingStateDescription" : "Deploy and Configure NSX for vSphere",
      "name" : "Create NSX Multicast Range",
      "description" : "Deploy and Configure NSX for vSphere",
      "localizableNamePack" : {
        "component" : "com.vmware.evo.sddc.bringup.nsx.plugin.ConfigureNsxPlugin",
        "messageKey" : "CreateMulticastRange.name"
      },
      "localizableDescriptionPack" : {
        "component" : "com.vmware.evo.sddc.bringup.nsx.plugin.ConfigureNsxPlugin",
        "messageKey" : "CreateMulticastRange.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.328Z",
      "updateTimestamp" : "2019-08-28T08:38:37.328Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "NSXvConfiguration",
      "processingStateDescription" : "Deploy and Configure NSX for vSphere",
      "name" : "Create NSX Transport Zone",
      "description" : "Deploy and Configure NSX for vSphere",
      "localizableNamePack" : {
        "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
        "messageKey" : "CreateNsxTransportZone.name"
      },
      "localizableDescriptionPack" : {
        "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
        "messageKey" : "CreateNsxTransportZone.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.328Z",
      "updateTimestamp" : "2019-08-28T08:38:37.328Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "NSXvConfiguration",
      "processingStateDescription" : "Deploy and Configure NSX for vSphere",
      "name" : "Configure SSO on NSX Manager",
      "description" : "Deploy and Configure NSX for vSphere",
      "localizableNamePack" : {
        "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
        "messageKey" : "ConfigureSsoOnNSX.name"
      },
      "localizableDescriptionPack" : {
        "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
        "messageKey" : "ConfigureSsoOnNSX.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.328Z",
      "updateTimestamp" : "2019-08-28T08:38:37.328Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "GenerateLogInsightInput",
      "processingStateDescription" : "Generate vRealize Log Insight Input Data",
      "name" : "Generate vRealize Log Insight Input Data",
      "description" : "Generate vRealize Log Insight Input Data",
      "localizableNamePack" : {
        "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
        "messageKey" : "GenerateLogInsightInput.name"
      },
      "localizableDescriptionPack" : {
        "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
        "messageKey" : "GenerateLogInsightInput.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.359Z",
      "updateTimestamp" : "2019-08-28T08:38:37.359Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "_LogInsightDeployment_DeployLogInsightPlugin_DeployLogInsightAction_1",
      "processingStateDescription" : "Deploy vRealize Log Insight",
      "name" : "Deploy vRealize Log Insight",
      "description" : "Deploy vRealize Log Insight",
      "localizableNamePack" : {
        "component" : "com.vmware.evo.sddc.common.fsmplugins.loginsight.plugin.DeployLogInsightPlugin",
        "messageKey" : "DeployLogInsightAction.name"
      },
      "localizableDescriptionPack" : {
        "component" : "com.vmware.evo.sddc.common.fsmplugins.loginsight.plugin.DeployLogInsightPlugin",
        "messageKey" : "DeployLogInsightAction.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.364Z",
      "updateTimestamp" : "2019-08-28T08:38:37.364Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "_LogInsightDeployment_ConfigureLogInsightPlugin_AddLogInsightLicenseAction_2",
      "processingStateDescription" : "Apply vRealize Log Insight License",
      "name" : "Apply vRealize Log Insight License Action",
      "description" : "Apply vRealize Log Insight License",
      "localizableNamePack" : {
        "component" : "com.vmware.evo.sddc.common.fsmplugins.loginsight.plugin.ConfigureLogInsightPlugin",
        "messageKey" : "AddLogInsightLicenseAction.name"
      },
      "localizableDescriptionPack" : {
        "component" : "com.vmware.evo.sddc.common.fsmplugins.loginsight.plugin.ConfigureLogInsightPlugin",
        "messageKey" : "AddLogInsightLicenseAction.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.368Z",
      "updateTimestamp" : "2019-08-28T08:38:37.368Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "_LogInsightDeployment_ConfigureLogInsightPlugin_BootstrapLogInsightClusterAction_3",
      "processingStateDescription" : "Bootstrap vRealize Log Insight Cluster",
      "name" : "Bootstrap vRealize Log Insight Cluster Action",
      "description" : "Bootstrap vRealize Log Insight Cluster",
      "localizableNamePack" : {
        "component" : "com.vmware.evo.sddc.common.fsmplugins.loginsight.plugin.ConfigureLogInsightPlugin",
        "messageKey" : "BootstrapLogInsightClusterAction.name"
      },
      "localizableDescriptionPack" : {
        "component" : "com.vmware.evo.sddc.common.fsmplugins.loginsight.plugin.ConfigureLogInsightPlugin",
        "messageKey" : "BootstrapLogInsightClusterAction.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.372Z",
      "updateTimestamp" : "2019-08-28T08:38:37.372Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "_LogInsightDeployment_ConfigureLogInsightPlugin_GenerateLogInsightCertificateAction_4",
      "processingStateDescription" : "Generate and Install VMCA Certificate for vRealize Log Insight",
      "name" : "Generate and Install VMCA Certificate for vRealize Log Insight",
      "description" : "Generate and Install VMCA Certificate for vRealize Log Insight",
      "localizableNamePack" : {
        "component" : "com.vmware.evo.sddc.common.fsmplugins.loginsight.plugin.ConfigureLogInsightPlugin",
        "messageKey" : "GenerateLogInsightCertificateAction.name"
      },
      "localizableDescriptionPack" : {
        "component" : "com.vmware.evo.sddc.common.fsmplugins.loginsight.plugin.ConfigureLogInsightPlugin",
        "messageKey" : "GenerateLogInsightCertificateAction.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.377Z",
      "updateTimestamp" : "2019-08-28T08:38:37.377Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "_LogInsightDeployment_ConfigureLogInsightPlugin_DisableTlsOnLogInsightAction_5",
      "processingStateDescription" : "Disable TLS 1.0 on vRealize Log Insight Nodes",
      "name" : "Disable TLS 1.0 on vRealize Log Insight Nodes Action",
      "description" : "Disable TLS 1.0 on vRealize Log Insight Nodes",
      "localizableNamePack" : {
        "component" : "com.vmware.evo.sddc.common.fsmplugins.loginsight.plugin.ConfigureLogInsightPlugin",
        "messageKey" : "DisableTlsOnLogInsightAction.name"
      },
      "localizableDescriptionPack" : {
        "component" : "com.vmware.evo.sddc.common.fsmplugins.loginsight.plugin.ConfigureLogInsightPlugin",
        "messageKey" : "DisableTlsOnLogInsightAction.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.381Z",
      "updateTimestamp" : "2019-08-28T08:38:37.381Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "_LogInsightDeployment_ConfigureLogInsightPlugin_InstallContentPacksInLogInsightAction_6",
      "processingStateDescription" : "Install vRealize Log Insight Content Packs",
      "name" : "Install vRealize Log Insight Content Packs Action",
      "description" : "Install vRealize Log Insight Content Packs",
      "localizableNamePack" : {
        "component" : "com.vmware.evo.sddc.common.fsmplugins.loginsight.plugin.ConfigureLogInsightPlugin",
        "messageKey" : "InstallContentPacksInLogInsightAction.name"
      },
      "localizableDescriptionPack" : {
        "component" : "com.vmware.evo.sddc.common.fsmplugins.loginsight.plugin.ConfigureLogInsightPlugin",
        "messageKey" : "InstallContentPacksInLogInsightAction.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.385Z",
      "updateTimestamp" : "2019-08-28T08:38:37.385Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "GenerateNsxvLogInsightIntegrationInput",
      "processingStateDescription" : "Generate NsxvLogInsightIntegration input",
      "name" : "Generate NSX for vSphere Integration with vRealize Log Insight Input Data",
      "description" : "Generate NsxvLogInsightIntegration input",
      "localizableNamePack" : {
        "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
        "messageKey" : "GenerateNsxvLogInsightIntegrationInput.name"
      },
      "localizableDescriptionPack" : {
        "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
        "messageKey" : "GenerateNsxvLogInsightIntegrationInput.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.389Z",
      "updateTimestamp" : "2019-08-28T08:38:37.389Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "_NsxvLogInsightIntegration_ConfigureSyslogInNsxPlugin_ConfigureSyslogInNsxManagerAction_1",
      "processingStateDescription" : "Configure Syslog Settings for NSX Manager",
      "name" : "Configure Syslog Settings for NSX Manager",
      "description" : "Configure Syslog Settings for NSX Manager",
      "localizableNamePack" : {
        "component" : "com.vmware.evo.sddc.common.fsmplugins.loginsight.plugin.ConfigureSyslogInNsxPlugin",
        "messageKey" : "ConfigureSyslogInNsxManagerAction.name"
      },
      "localizableDescriptionPack" : {
        "component" : "com.vmware.evo.sddc.common.fsmplugins.loginsight.plugin.ConfigureSyslogInNsxPlugin",
        "messageKey" : "ConfigureSyslogInNsxManagerAction.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.392Z",
      "updateTimestamp" : "2019-08-28T08:38:37.392Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "_NsxvLogInsightIntegration_ConfigureSyslogInNsxPlugin_ConfigureSyslogInNsxControllerAction_2",
      "processingStateDescription" : "Configure Syslog Settings for NSX Controllers",
      "name" : "Configure Syslog Settings for NSX Controllers",
      "description" : "Configure Syslog Settings for NSX Controllers",
      "localizableNamePack" : {
        "component" : "com.vmware.evo.sddc.common.fsmplugins.loginsight.plugin.ConfigureSyslogInNsxPlugin",
        "messageKey" : "ConfigureSyslogInNsxControllerAction.name"
      },
      "localizableDescriptionPack" : {
        "component" : "com.vmware.evo.sddc.common.fsmplugins.loginsight.plugin.ConfigureSyslogInNsxPlugin",
        "messageKey" : "ConfigureSyslogInNsxControllerAction.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.396Z",
      "updateTimestamp" : "2019-08-28T08:38:37.396Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "GenerateSddcManagerInput",
      "processingStateDescription" : "Generate SDDC Manager Input Data",
      "name" : "Generate SDDC Manager Input Data",
      "description" : "Generate SDDC Manager Input Data",
      "localizableNamePack" : {
        "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
        "messageKey" : "GenerateSddcManagerInput.name"
      },
      "localizableDescriptionPack" : {
        "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
        "messageKey" : "GenerateSddcManagerInput.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.399Z",
      "updateTimestamp" : "2019-08-28T08:38:37.399Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "_SDDCManagerConfiguration_SddcManagerContractPlugin_DeploySddcManagerOnClusterAction_1",
      "processingStateDescription" : "Deploy SDDC Manager",
      "name" : "Deploy SDDC Manager",
      "description" : "Deploy SDDC Manager",
      "localizableNamePack" : {
        "component" : "com.vmware.evo.sddc.sddcmanager.SddcManagerContractPlugin",
        "messageKey" : "DeploySddcManagerOnClusterAction.name"
      },
      "localizableDescriptionPack" : {
        "component" : "com.vmware.evo.sddc.sddcmanager.SddcManagerContractPlugin",
        "messageKey" : "DeploySddcManagerOnClusterAction.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.405Z",
      "updateTimestamp" : "2019-08-28T08:38:37.405Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "_SDDCManagerConfiguration_SddcManagerContractPlugin_ConfigureLCMRepoOnSddcManagerAction_2",
      "processingStateDescription" : "Configure Lifecycle Management Repository on SDDC Manager",
      "name" : "Configure Lifecycle Management Repository on SDDC Manager",
      "description" : "Configure Lifecycle Management Repository on SDDC Manager",
      "localizableNamePack" : {
        "component" : "com.vmware.evo.sddc.sddcmanager.SddcManagerContractPlugin",
        "messageKey" : "ConfigureLCMRepoOnSddcManagerAction.name"
      },
      "localizableDescriptionPack" : {
        "component" : "com.vmware.evo.sddc.sddcmanager.SddcManagerContractPlugin",
        "messageKey" : "ConfigureLCMRepoOnSddcManagerAction.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.410Z",
      "updateTimestamp" : "2019-08-28T08:38:37.410Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "_SDDCManagerConfiguration_HostPlugin_CreateNFSDatastoreOnHostsAction_3",
      "processingStateDescription" : "Mount Repository NFS Datastore on ESXi Hosts",
      "name" : "Mount Repository NFS Datastore on ESXi Hosts",
      "description" : "Mount Repository NFS Datastore on ESXi Hosts",
      "localizableNamePack" : {
        "component" : "com.vmware.vcf.common.fsm.plugins.action.HostPlugin",
        "messageKey" : "CreateNFSDatastoreOnHostsAction.name"
      },
      "localizableDescriptionPack" : {
        "component" : "com.vmware.vcf.common.fsm.plugins.action.HostPlugin",
        "messageKey" : "CreateNFSDatastoreOnHostsAction.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.414Z",
      "updateTimestamp" : "2019-08-28T08:38:37.414Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "_SDDCManagerConfiguration_SddcManagerContractPlugin_ConfigureBaseImageRepoAction_4",
      "processingStateDescription" : "Configure Base Install Image Repository on SDDC Manager",
      "name" : "Configure Base Install Image Repository on SDDC Manager",
      "description" : "Configure Base Install Image Repository on SDDC Manager",
      "localizableNamePack" : {
        "component" : "com.vmware.evo.sddc.sddcmanager.SddcManagerContractPlugin",
        "messageKey" : "ConfigureBaseImageRepoAction.name"
      },
      "localizableDescriptionPack" : {
        "component" : "com.vmware.evo.sddc.sddcmanager.SddcManagerContractPlugin",
        "messageKey" : "ConfigureBaseImageRepoAction.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.417Z",
      "updateTimestamp" : "2019-08-28T08:38:37.417Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "_SDDCManagerConfiguration_SddcManagerContractPlugin_InstallVmcaRootCertOnSddcManagerAction_5",
      "processingStateDescription" : "Install VMCA Root Certificate on SDDC Manager",
      "name" : "Install VMCA Root Certificate on SDDC Manager",
      "description" : "Install VMCA Root Certificate on SDDC Manager",
      "localizableNamePack" : {
        "component" : "com.vmware.evo.sddc.sddcmanager.SddcManagerContractPlugin",
        "messageKey" : "InstallVmcaRootCertOnSddcManagerAction.name"
      },
      "localizableDescriptionPack" : {
        "component" : "com.vmware.evo.sddc.sddcmanager.SddcManagerContractPlugin",
        "messageKey" : "InstallVmcaRootCertOnSddcManagerAction.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.421Z",
      "updateTimestamp" : "2019-08-28T08:38:37.421Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "_SDDCManagerConfiguration_SddcManagerContractPlugin_InstallSddcManagerVmcaCertificateAction_6",
      "processingStateDescription" : "Generate and Install VMCA Certificate on SDDC Manager",
      "name" : "Generate and Install VMCA Certificate on SDDC Manager",
      "description" : "Generate and Install VMCA Certificate on SDDC Manager",
      "localizableNamePack" : {
        "component" : "com.vmware.evo.sddc.sddcmanager.SddcManagerContractPlugin",
        "messageKey" : "InstallSddcManagerVmcaCertificateAction.name"
      },
      "localizableDescriptionPack" : {
        "component" : "com.vmware.evo.sddc.sddcmanager.SddcManagerContractPlugin",
        "messageKey" : "InstallSddcManagerVmcaCertificateAction.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.425Z",
      "updateTimestamp" : "2019-08-28T08:38:37.425Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "GenerateInventoryForSddcManagerConfiguration",
      "processingStateDescription" : "Generate Inventory Data For SDDC Manager Configuration",
      "name" : "Generate Inventory data For SDDC Manager Configuration",
      "description" : "Generate Inventory Data For SDDC Manager Configuration",
      "localizableNamePack" : {
        "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
        "messageKey" : "GenerateInventoryForSddcManagerConfiguration.name"
      },
      "localizableDescriptionPack" : {
        "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
        "messageKey" : "GenerateInventoryForSddcManagerConfiguration.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.429Z",
      "updateTimestamp" : "2019-08-28T08:38:37.429Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "_SDDCManagerPostInventory_SddcManagerContractPlugin_PostInventoryAndCredentialsAction_1",
      "processingStateDescription" : "Update SDDC Manager Inventory with Credential Details",
      "name" : "Update SDDC Manager Inventory with Credential Details",
      "description" : "Update SDDC Manager Inventory with Credential Details",
      "localizableNamePack" : {
        "component" : "com.vmware.evo.sddc.sddcmanager.SddcManagerContractPlugin",
        "messageKey" : "PostInventoryAndCredentialsAction.name"
      },
      "localizableDescriptionPack" : {
        "component" : "com.vmware.evo.sddc.sddcmanager.SddcManagerContractPlugin",
        "messageKey" : "PostInventoryAndCredentialsAction.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.433Z",
      "updateTimestamp" : "2019-08-28T08:38:37.433Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "_SDDCManagerPostInventory_SddcManagerContractPlugin_PostNetworkPoolInventoryAction_2",
      "processingStateDescription" : "Update SDDC Manager Inventory with Network Pool Details",
      "name" : "Update SDDC Manager Inventory with Network Pool Details",
      "description" : "Update SDDC Manager Inventory with Network Pool Details",
      "localizableNamePack" : {
        "component" : "com.vmware.evo.sddc.sddcmanager.SddcManagerContractPlugin",
        "messageKey" : "PostNetworkPoolInventoryAction.name"
      },
      "localizableDescriptionPack" : {
        "component" : "com.vmware.evo.sddc.sddcmanager.SddcManagerContractPlugin",
        "messageKey" : "PostNetworkPoolInventoryAction.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.437Z",
      "updateTimestamp" : "2019-08-28T08:38:37.437Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "_SDDCManagerPostInventory_SddcManagerContractPlugin_PostSddcLicenseInventoryAction_3",
      "processingStateDescription" : "Update SDDC Manager Inventory with License Details",
      "name" : "Update SDDC Manager Inventory with License Details",
      "description" : "Update SDDC Manager Inventory with License Details",
      "localizableNamePack" : {
        "component" : "com.vmware.evo.sddc.sddcmanager.SddcManagerContractPlugin",
        "messageKey" : "PostSddcLicenseInventoryAction.name"
      },
      "localizableDescriptionPack" : {
        "component" : "com.vmware.evo.sddc.sddcmanager.SddcManagerContractPlugin",
        "messageKey" : "PostSddcLicenseInventoryAction.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.441Z",
      "updateTimestamp" : "2019-08-28T08:38:37.441Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "_SddcManagerKnownHostsConfiguration_ProxyContractPlugin_ProxyContractAction_17",
      "processingStateDescription" : "Automation Helper Action",
      "name" : "ProxyContractAction",
      "description" : "Automation Helper Action",
      "localizableNamePack" : {
        "component" : "com.vmware.evo.sddc.orchestrator.core.recipes.spel.ProxyContractPlugin",
        "messageKey" : "ProxyContractAction.name"
      },
      "localizableDescriptionPack" : {
        "component" : "com.vmware.evo.sddc.orchestrator.core.recipes.spel.ProxyContractPlugin",
        "messageKey" : "ProxyContractAction.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.444Z",
      "updateTimestamp" : "2019-08-28T08:38:37.444Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "GenerateSddcManagerInput",
      "processingStateDescription" : "Generate SDDC Manager Input Data",
      "name" : "Generate SDDC Manager Input Data",
      "description" : "Generate SDDC Manager Input Data",
      "localizableNamePack" : {
        "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
        "messageKey" : "GenerateSddcManagerInput.name"
      },
      "localizableDescriptionPack" : {
        "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
        "messageKey" : "GenerateSddcManagerInput.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.447Z",
      "updateTimestamp" : "2019-08-28T08:38:37.447Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "GenerateVsphereMachineSshEntities",
      "processingStateDescription" : "Generate ESXi Host SSH Key Input Data",
      "name" : "Generate ESXi Host SSH Key Input Data",
      "description" : "Generate ESXi Host SSH Key Input Data",
      "localizableNamePack" : {
        "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
        "messageKey" : "GenerateVsphereMachineSshEntities.name"
      },
      "localizableDescriptionPack" : {
        "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
        "messageKey" : "GenerateVsphereMachineSshEntities.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.453Z",
      "updateTimestamp" : "2019-08-28T08:38:37.453Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "_SddcManagerKnownHostsConfiguration_VsphereContractPlugin_RotateMachineSshKeys_2",
      "processingStateDescription" : "Rotate ESXi Host SSH Keys",
      "name" : "Rotate ESXi Host SSH Keys",
      "description" : "Rotate ESXi Host SSH Keys",
      "localizableNamePack" : {
        "component" : "com.vmware.evo.sddc.vsphere.contract.VsphereContractPlugin",
        "messageKey" : "RotateMachineSshKeys.name"
      },
      "localizableDescriptionPack" : {
        "component" : "com.vmware.evo.sddc.vsphere.contract.VsphereContractPlugin",
        "messageKey" : "RotateMachineSshKeys.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.456Z",
      "updateTimestamp" : "2019-08-28T08:38:37.456Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "_SddcManagerKnownHostsConfiguration_SddcManagerContractPlugin_UpdateKnownHostsOnSddcManager_3",
      "processingStateDescription" : "Update Known Hosts in SDDC Manager",
      "name" : "Update Known Hosts in SDDC Manager",
      "description" : "Update Known Hosts in SDDC Manager",
      "localizableNamePack" : {
        "component" : "com.vmware.evo.sddc.sddcmanager.SddcManagerContractPlugin",
        "messageKey" : "UpdateKnownHostsOnSddcManager.name"
      },
      "localizableDescriptionPack" : {
        "component" : "com.vmware.evo.sddc.sddcmanager.SddcManagerContractPlugin",
        "messageKey" : "UpdateKnownHostsOnSddcManager.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.459Z",
      "updateTimestamp" : "2019-08-28T08:38:37.459Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "GenerateVsphereInput",
      "processingStateDescription" : "Generate vSphere Input Data",
      "name" : "Generate vSphere Input Data",
      "description" : "Generate vSphere Input Data",
      "localizableNamePack" : {
        "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
        "messageKey" : "GenerateVsphereInput.name"
      },
      "localizableDescriptionPack" : {
        "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
        "messageKey" : "GenerateVsphereInput.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.462Z",
      "updateTimestamp" : "2019-08-28T08:38:37.462Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "GenerateSddcManagerInput",
      "processingStateDescription" : "Generate SDDC Manager Input Data",
      "name" : "Generate SDDC Manager Input Data",
      "description" : "Generate SDDC Manager Input Data",
      "localizableNamePack" : {
        "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
        "messageKey" : "GenerateSddcManagerInput.name"
      },
      "localizableDescriptionPack" : {
        "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
        "messageKey" : "GenerateSddcManagerInput.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.465Z",
      "updateTimestamp" : "2019-08-28T08:38:37.465Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "_VcenterMessagesConfigurations_VsphereContractPlugin_PrepareVcenterMessages_2",
      "processingStateDescription" : "Generate Configure vCenter Login Message and Message of the Day Input Data",
      "name" : "Generate Configure vCenter Login Message and Message of the Day Input Data",
      "description" : "Generate Configure vCenter Login Message and Message of the Day Input Data",
      "localizableNamePack" : {
        "component" : "com.vmware.evo.sddc.vsphere.contract.VsphereContractPlugin",
        "messageKey" : "PrepareVcenterMessages.name"
      },
      "localizableDescriptionPack" : {
        "component" : "com.vmware.evo.sddc.vsphere.contract.VsphereContractPlugin",
        "messageKey" : "PrepareVcenterMessages.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.471Z",
      "updateTimestamp" : "2019-08-28T08:38:37.471Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "_VcenterMessagesConfigurations_VsphereContractPlugin_ConfigureVcenterMessages_3",
      "processingStateDescription" : "Configure vCenter Login Message and Message of the Day",
      "name" : "Configure vCenter Login Message and Message of the Day",
      "description" : "Configure vCenter Login Message and Message of the Day",
      "localizableNamePack" : {
        "component" : "com.vmware.evo.sddc.vsphere.contract.VsphereContractPlugin",
        "messageKey" : "ConfigureVcenterMessages.name"
      },
      "localizableDescriptionPack" : {
        "component" : "com.vmware.evo.sddc.vsphere.contract.VsphereContractPlugin",
        "messageKey" : "ConfigureVcenterMessages.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.474Z",
      "updateTimestamp" : "2019-08-28T08:38:37.474Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "GenerateClusterConfigurationInput",
      "processingStateDescription" : "Generate Cluster Configuration Input Data",
      "name" : "Generate Post Cluster Configuration Input Data",
      "description" : "Generate Cluster Configuration Input Data",
      "localizableNamePack" : {
        "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
        "messageKey" : "GenerateClusterConfigurationInput.name"
      },
      "localizableDescriptionPack" : {
        "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
        "messageKey" : "GenerateClusterConfigurationInput.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.477Z",
      "updateTimestamp" : "2019-08-28T08:38:37.477Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "GenerateConfigureDeploymentDetailsActionInput",
      "processingStateDescription" : "Generate Configure Deployment Details Action Input Data",
      "name" : "Generate Configure Deployment Details Action Input Data",
      "description" : "Generate Configure Deployment Details Action Input Data",
      "localizableNamePack" : {
        "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
        "messageKey" : "GenerateConfigureDeploymentDetailsActionInput.name"
      },
      "localizableDescriptionPack" : {
        "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
        "messageKey" : "GenerateConfigureDeploymentDetailsActionInput.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.483Z",
      "updateTimestamp" : "2019-08-28T08:38:37.483Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "_PostClusterConfiguration_VspherePlugin_MigrateVmsToFoldersAction_2",
      "processingStateDescription" : "Move VMs to VM Folders",
      "name" : "Move VMs to VM Folders",
      "description" : "Move VMs to VM Folders",
      "localizableNamePack" : {
        "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
        "messageKey" : "MigrateVmsToFoldersAction.name"
      },
      "localizableDescriptionPack" : {
        "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
        "messageKey" : "MigrateVmsToFoldersAction.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.486Z",
      "updateTimestamp" : "2019-08-28T08:38:37.486Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "_PostClusterConfiguration_VspherePlugin_MigrateDvsToFolderAction_3",
      "processingStateDescription" : "Move vSphere Distributed Switch to Network Folder",
      "name" : "Move vSphere Distributed Switch to Network Folder",
      "description" : "Move vSphere Distributed Switch to Network Folder",
      "localizableNamePack" : {
        "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
        "messageKey" : "MigrateDvsToFolderAction.name"
      },
      "localizableDescriptionPack" : {
        "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
        "messageKey" : "MigrateDvsToFolderAction.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.489Z",
      "updateTimestamp" : "2019-08-28T08:38:37.489Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "_PostClusterConfiguration_VspherePlugin_DisableVsanForceProvisionAction_4",
      "processingStateDescription" : "Disable vSAN Force Provisioning",
      "name" : "Disable vSAN Force Provisioning",
      "description" : "Disable vSAN Force Provisioning",
      "localizableNamePack" : {
        "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
        "messageKey" : "DisableVsanForceProvisionAction.name"
      },
      "localizableDescriptionPack" : {
        "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
        "messageKey" : "DisableVsanForceProvisionAction.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.492Z",
      "updateTimestamp" : "2019-08-28T08:38:37.492Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "_PostClusterConfiguration_VspherePlugin_EnableVsanPoliciesAction_5",
      "processingStateDescription" : "Enable vSAN Storage Policies",
      "name" : "Enable vSAN Storage Policies",
      "description" : "Enable vSAN Storage Policies",
      "localizableNamePack" : {
        "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
        "messageKey" : "EnableVsanPoliciesAction.name"
      },
      "localizableDescriptionPack" : {
        "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
        "messageKey" : "EnableVsanPoliciesAction.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.496Z",
      "updateTimestamp" : "2019-08-28T08:38:37.496Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "_PostClusterConfiguration_VspherePlugin_RelocateAllVmsToResourcePoolAction_6",
      "processingStateDescription" : "Move VMs to Resource Pools",
      "name" : "Move VMs to Resource Pools",
      "description" : "Move VMs to Resource Pools",
      "localizableNamePack" : {
        "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
        "messageKey" : "RelocateAllVmsToResourcePoolAction.name"
      },
      "localizableDescriptionPack" : {
        "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
        "messageKey" : "RelocateAllVmsToResourcePoolAction.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.499Z",
      "updateTimestamp" : "2019-08-28T08:38:37.499Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "_PostClusterConfiguration_VspherePlugin_AdjustResourcePoolReservationAction_7",
      "processingStateDescription" : "Set Reservations on Resource Pools",
      "name" : "Set Reservations on Resource Pools",
      "description" : "Set Reservations on Resource Pools",
      "localizableNamePack" : {
        "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
        "messageKey" : "AdjustResourcePoolReservationAction.name"
      },
      "localizableDescriptionPack" : {
        "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
        "messageKey" : "AdjustResourcePoolReservationAction.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.502Z",
      "updateTimestamp" : "2019-08-28T08:38:37.502Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "_PostClusterConfiguration_VcPlugin_EnableClusterHaAction_8",
      "processingStateDescription" : "Enable vSphere High Availability",
      "name" : "Enable vSphere High Availability",
      "description" : "Enable vSphere High Availability",
      "localizableNamePack" : {
        "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
        "messageKey" : "EnableClusterHaAction.name"
      },
      "localizableDescriptionPack" : {
        "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
        "messageKey" : "EnableClusterHaAction.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.505Z",
      "updateTimestamp" : "2019-08-28T08:38:37.505Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "_PostClusterConfiguration_VcPlugin_CreateVmAntiAffinityRuleAction_9",
      "processingStateDescription" : "Create VM Anti-Affinity Rules",
      "name" : "Create VM Anti-Affinity Rules",
      "description" : "Create VM Anti-Affinity Rules",
      "localizableNamePack" : {
        "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
        "messageKey" : "CreateVmAntiAffinityRuleAction.name"
      },
      "localizableDescriptionPack" : {
        "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
        "messageKey" : "CreateVmAntiAffinityRuleAction.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.508Z",
      "updateTimestamp" : "2019-08-28T08:38:37.508Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "_PostClusterConfiguration_CreatePscVcVmGroupsPlugin_CreatePscVcVmGroupsContractAction_10",
      "processingStateDescription" : "Create VM Groups",
      "name" : "Create VM Groups",
      "description" : "Create VM Groups",
      "localizableNamePack" : {
        "component" : "com.vmware.vcf.common.fsm.plugins.action.CreatePscVcVmGroupsPlugin",
        "messageKey" : "CreatePscVcVmGroupsContractAction.name"
      },
      "localizableDescriptionPack" : {
        "component" : "com.vmware.vcf.common.fsm.plugins.action.CreatePscVcVmGroupsPlugin",
        "messageKey" : "CreatePscVcVmGroupsContractAction.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.511Z",
      "updateTimestamp" : "2019-08-28T08:38:37.511Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "_PostClusterConfiguration_VspherePlugin_CreateClusterVmsToVmsRuleContractAction_11",
      "processingStateDescription" : "Create VM-VM Startup Order Rule",
      "name" : "Create VM-VM Startup Order Rule",
      "description" : "Create VM-VM Startup Order Rule",
      "localizableNamePack" : {
        "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
        "messageKey" : "CreateClusterVmsToVmsRuleContractAction.name"
      },
      "localizableDescriptionPack" : {
        "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
        "messageKey" : "CreateClusterVmsToVmsRuleContractAction.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.514Z",
      "updateTimestamp" : "2019-08-28T08:38:37.514Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "_PostClusterConfiguration_ClusterVmHostPlugin_CreateClusterHostGroupContractAction_12",
      "processingStateDescription" : "Create vCenter VM/Host RuleNsxServiceImpl.java",
      "name" : "Create vCenter VM/Host Rule",
      "description" : "Create vCenter VM/Host RuleNsxServiceImpl.java",
      "localizableNamePack" : {
        "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
        "messageKey" : "CreateClusterHostGroupContractAction.name"
      },
      "localizableDescriptionPack" : {
        "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
        "messageKey" : "CreateClusterHostGroupContractAction.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.517Z",
      "updateTimestamp" : "2019-08-28T08:38:37.517Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "_PostClusterConfiguration_ClusterVmHostPlugin_CreateClusterVmHostRuleContractAction_13",
      "processingStateDescription" : "Create Platform Services Controller VM/Host Rule",
      "name" : "Create Platform Services Controller VM/Host Rule",
      "description" : "Create Platform Services Controller VM/Host Rule",
      "localizableNamePack" : {
        "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
        "messageKey" : "CreatePSCVMHostRuleActionId.name"
      },
      "localizableDescriptionPack" : {
        "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
        "messageKey" : "CreatePSCVMHostRuleActionId.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.520Z",
      "updateTimestamp" : "2019-08-28T08:38:37.520Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "_PostClusterConfiguration_ClusterVmHostPlugin_CreateClusterVmHostRuleContractAction_14",
      "processingStateDescription" : "Create Cluster Rule",
      "name" : "Create Cluster Rule",
      "description" : "Create Cluster Rule",
      "localizableNamePack" : {
        "component" : "com.vmware.vcf.common.fsm.plugins.action.ClusterVmHostPlugin",
        "messageKey" : "CreateClusterVmHostRuleContractAction.name"
      },
      "localizableDescriptionPack" : {
        "component" : "com.vmware.vcf.common.fsm.plugins.action.ClusterVmHostPlugin",
        "messageKey" : "CreateClusterVmHostRuleContractAction.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.523Z",
      "updateTimestamp" : "2019-08-28T08:38:37.523Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "_PostClusterConfiguration_VcPlugin_ConfigureEsxAdvancedOptionsAction_15",
      "processingStateDescription" : "Configure ESXi Advanced Options",
      "name" : "Configure ESXi Advanced Options",
      "description" : "Configure ESXi Advanced Options",
      "localizableNamePack" : {
        "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
        "messageKey" : "ConfigureEsxAdvancedOptionsAction.name"
      },
      "localizableDescriptionPack" : {
        "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
        "messageKey" : "ConfigureEsxAdvancedOptionsAction.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.526Z",
      "updateTimestamp" : "2019-08-28T08:38:37.526Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "_PostClusterConfiguration_VspherePlugin_ReconfigureHAOnClusterAction_16",
      "processingStateDescription" : "Reconfigure vSphere High Availability",
      "name" : "Reconfigure vSphere High Availability",
      "description" : "Reconfigure vSphere High Availability",
      "localizableNamePack" : {
        "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
        "messageKey" : "ReconfigureHAOnClusterAction.name"
      },
      "localizableDescriptionPack" : {
        "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
        "messageKey" : "ReconfigureHAOnClusterAction.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.529Z",
      "updateTimestamp" : "2019-08-28T08:38:37.529Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "_PostClusterConfiguration_VspherePlugin_ClearVsanAlarmsOnClusterAction_17",
      "processingStateDescription" : "Clear Alarms on vSAN",
      "name" : "Clear Alarms on vSAN",
      "description" : "Clear Alarms on vSAN",
      "localizableNamePack" : {
        "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
        "messageKey" : "ClearVsanAlarmsOnClusterAction.name"
      },
      "localizableDescriptionPack" : {
        "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
        "messageKey" : "ClearVsanAlarmsOnClusterAction.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.532Z",
      "updateTimestamp" : "2019-08-28T08:38:37.532Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "_PostClusterConfiguration_VspherePlugin_ClearRedAlarmsOnHostAction_18",
      "processingStateDescription" : "Clear Alerts on Hosts",
      "name" : "Clear Alerts on Hosts",
      "description" : "Clear Alerts on Hosts",
      "localizableNamePack" : {
        "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
        "messageKey" : "ClearRedAlarmsOnHostAction.name"
      },
      "localizableDescriptionPack" : {
        "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
        "messageKey" : "ClearRedAlarmsOnHostAction.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.535Z",
      "updateTimestamp" : "2019-08-28T08:38:37.535Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "_PostClusterConfiguration_VspherePlugin_ConfigureDeploymentDetailsContractAction_19",
      "processingStateDescription" : "Set SDDC Deployment Details on the Management vCenter Server",
      "name" : "Set SDDC Deployment Details on the Management vCenter Server",
      "description" : "Set SDDC Deployment Details on the Management vCenter Server",
      "localizableNamePack" : {
        "component" : "com.vmware.vcf.common.fsm.plugins.action.VspherePlugin",
        "messageKey" : "ConfigureDeploymentDetailsContractAction.name"
      },
      "localizableDescriptionPack" : {
        "component" : "com.vmware.vcf.common.fsm.plugins.action.VspherePlugin",
        "messageKey" : "ConfigureDeploymentDetailsContractAction.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.539Z",
      "updateTimestamp" : "2019-08-28T08:38:37.539Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "GenerateVsphereInput",
      "processingStateDescription" : "Generate vSphere Input Data",
      "name" : "Generate vSphere Input Data",
      "description" : "Generate vSphere Input Data",
      "localizableNamePack" : {
        "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
        "messageKey" : "GenerateVsphereInput.name"
      },
      "localizableDescriptionPack" : {
        "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
        "messageKey" : "GenerateVsphereInput.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.542Z",
      "updateTimestamp" : "2019-08-28T08:38:37.542Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "_DisableBashShellOnVcAndPsc_VsphereContractPlugin_DisableBashShell_1",
      "processingStateDescription" : "Disable Bash Shell on vCenter Server",
      "name" : "Disable Bash Shell on vCenter Server",
      "description" : "Disable Bash Shell on vCenter Server",
      "localizableNamePack" : {
        "component" : "workflowconfig.common_recipes.DisableBashShellOnVcAndPsc",
        "messageKey" : "DisableBashShellOnVCenterId.name"
      },
      "localizableDescriptionPack" : {
        "component" : "workflowconfig.common_recipes.DisableBashShellOnVcAndPsc",
        "messageKey" : "DisableBashShellOnVCenterId.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.545Z",
      "updateTimestamp" : "2019-08-28T08:38:37.545Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "_DisableBashShellOnVcAndPsc_VsphereContractPlugin_DisableBashShell_2",
      "processingStateDescription" : "Disable Bash Shell on Platform Services Controllers",
      "name" : "Disable Bash Shell on Platform Services Controllers",
      "description" : "Disable Bash Shell on Platform Services Controllers",
      "localizableNamePack" : {
        "component" : "workflowconfig.common_recipes.DisableBashShellOnVcAndPsc",
        "messageKey" : "DisableBashShellOnPSCsId.name"
      },
      "localizableDescriptionPack" : {
        "component" : "workflowconfig.common_recipes.DisableBashShellOnVcAndPsc",
        "messageKey" : "DisableBashShellOnPSCsId.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.548Z",
      "updateTimestamp" : "2019-08-28T08:38:37.548Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "NSXvConfigurationForSDDCManager",
      "processingStateDescription" : "Configure NSX for vSphere",
      "name" : "Add VMs to NSX Distributed Firewall Exclusion List",
      "description" : "Configure NSX for vSphere",
      "localizableNamePack" : {
        "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
        "messageKey" : "AddVmsIntoDfwExclusionList.name"
      },
      "localizableDescriptionPack" : {
        "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
        "messageKey" : "AddVmsIntoDfwExclusionList.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.551Z",
      "updateTimestamp" : "2019-08-28T08:38:37.551Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "NSXBackupConfiguration",
      "processingStateDescription" : "Configure Backup on NSX for vSphere",
      "name" : "Configure NSX Manager Backups",
      "description" : "Configure Backup on NSX for vSphere",
      "localizableNamePack" : {
        "component" : "com.vmware.evo.sddc.bringup.plugin.spi.LcmPlugin",
        "messageKey" : "ConfigureBackupForNSX.name"
      },
      "localizableDescriptionPack" : {
        "component" : "com.vmware.evo.sddc.bringup.plugin.spi.LcmPlugin",
        "messageKey" : "ConfigureBackupForNSX.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.554Z",
      "updateTimestamp" : "2019-08-28T08:38:37.554Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "GenerateLogInsightInput",
      "processingStateDescription" : "Generate vRealize Log Insight Input Data",
      "name" : "Generate vRealize Log Insight Input Data",
      "description" : "Generate vRealize Log Insight Input Data",
      "localizableNamePack" : {
        "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
        "messageKey" : "GenerateLogInsightInput.name"
      },
      "localizableDescriptionPack" : {
        "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
        "messageKey" : "GenerateLogInsightInput.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.557Z",
      "updateTimestamp" : "2019-08-28T08:38:37.557Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "_LogInsightConfiguration_ConfigureLogInsightAgentPlugin_ConfigureSddcManagerInLogInsightAction_1",
      "processingStateDescription" : "Configure Syslog Settings for SDDC Manager",
      "name" : "Configure Syslog Settings for SDDC Manager",
      "description" : "Configure Syslog Settings for SDDC Manager",
      "localizableNamePack" : {
        "component" : "com.vmware.evo.sddc.common.fsmplugins.loginsight.plugin.ConfigureLogInsightAgentPlugin",
        "messageKey" : "ConfigureSddcManagerInLogInsightAction.name"
      },
      "localizableDescriptionPack" : {
        "component" : "com.vmware.evo.sddc.common.fsmplugins.loginsight.plugin.ConfigureLogInsightAgentPlugin",
        "messageKey" : "ConfigureSddcManagerInLogInsightAction.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.561Z",
      "updateTimestamp" : "2019-08-28T08:38:37.561Z"
    }, {
      "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
      "processingStateName" : "_LogInsightConfiguration_ConfigureLogInsightAgentPlugin_ConfigureVCenterInLogInsightWithSyslogAction_2",
      "processingStateDescription" : "Configure Syslog Settings for vCenter Server",
      "name" : "Configure Syslog Settings for vCenter Server",
      "description" : "Configure Syslog Settings for vCenter Server",
      "localizableNamePack" : {
        "component" : "com.vmware.evo.sddc.common.fsmplugins.loginsight.plugin.ConfigureLogInsightAgentPlugin",
        "messageKey" : "ConfigureVCenterInLogInsightWithSyslogAction.name"
      },
      "localizableDescriptionPack" : {
        "component" : "com.vmware.evo.sddc.common.fsmplugins.loginsight.plugin.ConfigureLogInsightAgentPlugin",
        "messageKey" : "ConfigureVCenterInLogInsightWithSyslogAction.desc"
      },
      "status" : "INITIALIZED",
      "creationTimestamp" : "2019-08-28T08:38:37.565Z",
      "updateTimestamp" : "2019-08-28T08:38:37.565Z"
    } ]
  } ]
}
Related APIs

Retrieve all SDDCs
Retrieve a SDDC

2.1.3. Get a SDDC

Prerequisites
Note
 The username and password for Basic Authentication scheme using the Cloud Builder "admin" account.
The host in example requests is Cloud Builder address e.g. "sfo01cb01.sfo01.rainpole.local" not the SDDC Manager one.

  1. The following data is required

    • ID of the SDDC

Steps

  1. Invoke the API.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/sddcs/b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a' -i -u 'admin:VMwareInfra@1' -X GET \
    -H 'Accept: application/json'

HTTP Request

GET /v1/sddcs/b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a HTTP/1.1
Accept: application/json
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==

HTTP Response

HTTP/1.1 200 OK
Content-Length: 100905
Content-Type: application/json;charset=UTF-8

{
  "id" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
  "name" : "Bringup-Ems",
  "status" : "IN_PROGRESS",
  "creationTimestamp" : "2019-08-28T08:38:37.568Z",
  "sddcSubTasks" : [ {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "GenerateEsxiForVsanDedupInput",
    "processingStateDescription" : "Generate ESXi Host vSAN Deduplication Input Data",
    "name" : "Generate ESXi Host vSAN Deduplication Input Data",
    "description" : "Generate ESXi Host vSAN Deduplication Input Data",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateEsxiForVsanDedupInput.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateEsxiForVsanDedupInput.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.568Z",
    "updateTimestamp" : "2019-08-28T08:38:37.568Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "GenerateEsxiInput",
    "processingStateDescription" : "Generate ESXi Host Input Data",
    "name" : "Generate ESXi Host Input Data",
    "description" : "Generate ESXi Host Input Data",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateEsxiInput.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateEsxiInput.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.216Z",
    "updateTimestamp" : "2019-08-28T08:38:37.216Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_InitialEnvironmentSetup_VspherePlugin_PrepareEsxiForVsanDedupAction_2",
    "processingStateDescription" : "Prepare ESXi Hosts for vSAN with Deduplication",
    "name" : "Prepare ESXi Hosts for vSAN with Deduplication Action",
    "description" : "Prepare ESXi Hosts for vSAN with Deduplication",
    "localizableNamePack" : {
      "component" : "com.vmware.vcf.common.fsm.plugins.action.VspherePlugin",
      "messageKey" : "PrepareEsxiForVsanDedupAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.vcf.common.fsm.plugins.action.VspherePlugin",
      "messageKey" : "PrepareEsxiForVsanDedupAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.220Z",
    "updateTimestamp" : "2019-08-28T08:38:37.220Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_InitialEnvironmentSetup_VspherePlugin_EnableVsanDedupOnFirstHostAction_3",
    "processingStateDescription" : "Enable vSAN Deduplication for the First Host",
    "name" : "Enable vSAN Deduplication for the First Host Action",
    "description" : "Enable vSAN Deduplication for the First Host",
    "localizableNamePack" : {
      "component" : "com.vmware.vcf.common.fsm.plugins.action.VspherePlugin",
      "messageKey" : "EnableVsanDedupOnFirstHostAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.vcf.common.fsm.plugins.action.VspherePlugin",
      "messageKey" : "EnableVsanDedupOnFirstHostAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.224Z",
    "updateTimestamp" : "2019-08-28T08:38:37.224Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_InitialEnvironmentSetup_HostPlugin_CreateVmPortGroupAction_4",
    "processingStateDescription" : "Create 'VM Network' Portgroup on ESXi Hosts",
    "name" : "Create 'VM Network' Portgroup on ESXi Hosts",
    "description" : "Create 'VM Network' Portgroup on ESXi Hosts",
    "localizableNamePack" : {
      "component" : "com.vmware.vcf.common.fsm.plugins.action.HostPlugin",
      "messageKey" : "CreateVmPortGroupAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.vcf.common.fsm.plugins.action.HostPlugin",
      "messageKey" : "CreateVmPortGroupAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.227Z",
    "updateTimestamp" : "2019-08-28T08:38:37.227Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_InitialEnvironmentSetup_HostPlugin_ReconfigureHostDnsAction_5",
    "processingStateDescription" : "Configure ESXi Host DNS",
    "name" : "Configure ESXi Host DNS",
    "description" : "Configure ESXi Host DNS",
    "localizableNamePack" : {
      "component" : "com.vmware.vcf.common.fsm.plugins.action.HostPlugin",
      "messageKey" : "ReconfigureHostDnsAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.vcf.common.fsm.plugins.action.HostPlugin",
      "messageKey" : "ReconfigureHostDnsAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.231Z",
    "updateTimestamp" : "2019-08-28T08:38:37.231Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_InitialEnvironmentSetup_com.vmware.evo.sddc.bringup.plugin.spi.VspherePlugin_DetermineSoftwareVersionAction_6",
    "processingStateDescription" : "Determine Software Version on ESXi Hosts",
    "name" : "Determine Software Version on ESXi Hosts",
    "description" : "Determine Software Version on ESXi Hosts",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "DetermineSoftwareVersionAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "DetermineSoftwareVersionAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.234Z",
    "updateTimestamp" : "2019-08-28T08:38:37.234Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "PSCDeploymentInputGeneration",
    "processingStateDescription" : "Generate Platform Services Controller Deployment Input Data",
    "name" : "Generate Platform Services Controller Deployment Input Data",
    "description" : "Generate Platform Services Controller Deployment Input Data",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "PSCDeploymentInputGeneration.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "PSCDeploymentInputGeneration.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.238Z",
    "updateTimestamp" : "2019-08-28T08:38:37.238Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_PSCDeployment_PscPlugin_DeployPsc1Action_1",
    "processingStateDescription" : "Deploy Platform Service Controller",
    "name" : "Deploy Platform Service Controller",
    "description" : "Deploy Platform Service Controller",
    "localizableNamePack" : {
      "component" : "com.vmware.vcf.common.fsm.plugins.action.plugins.PscPlugin",
      "messageKey" : "DeployPsc1Action.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.vcf.common.fsm.plugins.action.plugins.PscPlugin",
      "messageKey" : "DeployPsc1Action.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.243Z",
    "updateTimestamp" : "2019-08-28T08:38:37.243Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_PSCDeployment_PscPlugin_CreateUserGroupsAction_2",
    "processingStateDescription" : "Create Admin User Groups in vsphere.local Domain",
    "name" : "Create Admin User Groups in vsphere.local Domain",
    "description" : "Create Admin User Groups in vsphere.local Domain",
    "localizableNamePack" : {
      "component" : "com.vmware.vcf.common.fsm.plugins.action.plugins.PscPlugin",
      "messageKey" : "CreateUserGroupsAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.vcf.common.fsm.plugins.action.plugins.PscPlugin",
      "messageKey" : "CreateUserGroupsAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.248Z",
    "updateTimestamp" : "2019-08-28T08:38:37.248Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_GenerateLicenseRenameInput_ProxyContractPlugin_ProxyContractAction_0",
    "processingStateDescription" : "Automation Helper Action",
    "name" : "ProxyContractAction",
    "description" : "Automation Helper Action",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.orchestrator.core.recipes.spel.ProxyContractPlugin",
      "messageKey" : "ProxyContractAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.orchestrator.core.recipes.spel.ProxyContractPlugin",
      "messageKey" : "ProxyContractAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.253Z",
    "updateTimestamp" : "2019-08-28T08:38:37.253Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "GenerateLicenseRenameInput",
    "processingStateDescription" : "Generate license rename input",
    "name" : "Generate vCenter License Rename Input Data",
    "description" : "Generate license rename input",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.input.generation.recipes.GenerateLicenseRenameInput",
      "messageKey" : "GenerateLicenseRenameInput.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.input.generation.recipes.GenerateLicenseRenameInput",
      "messageKey" : "GenerateLicenseRenameInput.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.258Z",
    "updateTimestamp" : "2019-08-28T08:38:37.258Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "GenerateVcDeploymentInput",
    "processingStateDescription" : "Generate Vc Deployment Input",
    "name" : "Generate vCenter Server Deployment Input Data",
    "description" : "Generate Vc Deployment Input",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateVcDeploymentInput.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateVcDeploymentInput.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.264Z",
    "updateTimestamp" : "2019-08-28T08:38:37.264Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_VCDeployment_VcPlugin_DeployVcAction_3",
    "processingStateDescription" : "Deploy vCenter Server",
    "name" : "Deploy vCenter Server",
    "description" : "Deploy vCenter Server",
    "localizableNamePack" : {
      "component" : "com.vmware.vcf.common.fsm.plugins.action.plugins.VcPlugin",
      "messageKey" : "DeployVcAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.vcf.common.fsm.plugins.action.plugins.VcPlugin",
      "messageKey" : "DeployVcAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.269Z",
    "updateTimestamp" : "2019-08-28T08:38:37.269Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_VCDeployment_VcPlugin_ApplyVcLicenseAction_4",
    "processingStateDescription" : "Apply vCenter Server, vSphere, and vSAN Licenses",
    "name" : "Apply vCenter Server, vSphere, and vSAN Licenses",
    "description" : "Apply vCenter Server, vSphere, and vSAN Licenses",
    "localizableNamePack" : {
      "component" : "workflowconfig.ems_recipes.VCDeployment",
      "messageKey" : "ApplyVcLicenseAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "workflowconfig.ems_recipes.VCDeployment",
      "messageKey" : "ApplyVcLicenseAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.272Z",
    "updateTimestamp" : "2019-08-28T08:38:37.272Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_VCDeployment_LicensePlugin_RenameLicense_5",
    "processingStateDescription" : "Rename the Applied vCenter License in vCenter Server",
    "name" : "Rename the Applied vCenter License in vCenter Server",
    "description" : "Rename the Applied vCenter License in vCenter Server",
    "localizableNamePack" : {
      "component" : "workflowconfig.ems_recipes.VCDeployment",
      "messageKey" : "RenameLicense.name"
    },
    "localizableDescriptionPack" : {
      "component" : "workflowconfig.ems_recipes.VCDeployment",
      "messageKey" : "RenameLicense.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.276Z",
    "updateTimestamp" : "2019-08-28T08:38:37.276Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ManagementClusterConfiguration",
    "processingStateDescription" : "Create Vsphere Cluster",
    "name" : "Create vSphere Cluster",
    "description" : "Create Vsphere Cluster",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "CreateCluster.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "CreateCluster.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.281Z",
    "updateTimestamp" : "2019-08-28T08:38:37.281Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ManagementClusterConfiguration",
    "processingStateDescription" : "Create Vsphere Cluster",
    "name" : "Enable vSphere DRS",
    "description" : "Create Vsphere Cluster",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "EnableClusterDrs.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "EnableClusterDrs.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.281Z",
    "updateTimestamp" : "2019-08-28T08:38:37.281Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ManagementClusterConfiguration",
    "processingStateDescription" : "Create Vsphere Cluster",
    "name" : "Apply vSAN Dormant License File (DLF)",
    "description" : "Create Vsphere Cluster",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "ApplyVsanDlf.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "ApplyVsanDlf.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.281Z",
    "updateTimestamp" : "2019-08-28T08:38:37.281Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ManagementClusterConfiguration",
    "processingStateDescription" : "Create Vsphere Cluster",
    "name" : "Apply vSAN License",
    "description" : "Create Vsphere Cluster",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "ApplyVsanLicense.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "ApplyVsanLicense.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.281Z",
    "updateTimestamp" : "2019-08-28T08:38:37.281Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ManagementClusterConfiguration",
    "processingStateDescription" : "Create Vsphere Cluster",
    "name" : "Generate vSAN License Rename Input Data",
    "description" : "Create Vsphere Cluster",
    "localizableNamePack" : {
      "component" : "workflowconfig.ems_recipes.ManagementClusterConfiguration",
      "messageKey" : "GenerateVSANLicenseRenameInputId.name"
    },
    "localizableDescriptionPack" : {
      "component" : "workflowconfig.ems_recipes.ManagementClusterConfiguration",
      "messageKey" : "GenerateVSANLicenseRenameInputId.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.281Z",
    "updateTimestamp" : "2019-08-28T08:38:37.281Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ManagementClusterConfiguration",
    "processingStateDescription" : "Create Vsphere Cluster",
    "name" : "Rename the Applied VSAN License in vCenter Server",
    "description" : "Create Vsphere Cluster",
    "localizableNamePack" : {
      "component" : "workflowconfig.ems_recipes.ManagementClusterConfiguration",
      "messageKey" : "RenameVSANLicenseId.name"
    },
    "localizableDescriptionPack" : {
      "component" : "workflowconfig.ems_recipes.ManagementClusterConfiguration",
      "messageKey" : "RenameVSANLicenseId.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.281Z",
    "updateTimestamp" : "2019-08-28T08:38:37.281Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ManagementClusterConfiguration",
    "processingStateDescription" : "Create Vsphere Cluster",
    "name" : "Assign Administrator Privileges to SDDCAdmins Group",
    "description" : "Create Vsphere Cluster",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "AuthorizeSddcAdminGroup.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "AuthorizeSddcAdminGroup.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.281Z",
    "updateTimestamp" : "2019-08-28T08:38:37.281Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ManagementClusterConfiguration",
    "processingStateDescription" : "Create Vsphere Cluster",
    "name" : "Create vSphere Distributed Switch",
    "description" : "Create Vsphere Cluster",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "CreateDvs.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "CreateDvs.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.281Z",
    "updateTimestamp" : "2019-08-28T08:38:37.281Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ManagementClusterConfiguration",
    "processingStateDescription" : "Create Vsphere Cluster",
    "name" : "Add ESXi Host to vSphere Cluster",
    "description" : "Create Vsphere Cluster",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "AddHostToCluster.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "AddHostToCluster.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.281Z",
    "updateTimestamp" : "2019-08-28T08:38:37.281Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ManagementClusterConfiguration",
    "processingStateDescription" : "Create Vsphere Cluster",
    "name" : "Enable/Disable EVC Mode on vSphere Cluster",
    "description" : "Create Vsphere Cluster",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "EnableEvc.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "EnableEvc.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.281Z",
    "updateTimestamp" : "2019-08-28T08:38:37.281Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ManagementClusterConfiguration",
    "processingStateDescription" : "Create Vsphere Cluster",
    "name" : "Add ESXi Hosts to vSphere Distributed Switch",
    "description" : "Create Vsphere Cluster",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "AddHostToDvswitch.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "AddHostToDvswitch.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.281Z",
    "updateTimestamp" : "2019-08-28T08:38:37.281Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ManagementClusterConfiguration",
    "processingStateDescription" : "Create Vsphere Cluster",
    "name" : "Create VM Folders",
    "description" : "Create Vsphere Cluster",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "CreateVmFolders.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "CreateVmFolders.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.281Z",
    "updateTimestamp" : "2019-08-28T08:38:37.281Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ManagementClusterConfiguration",
    "processingStateDescription" : "Create Vsphere Cluster",
    "name" : "Create Network Folders",
    "description" : "Create Vsphere Cluster",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "CreateNetworkFolders.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "CreateNetworkFolders.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.281Z",
    "updateTimestamp" : "2019-08-28T08:38:37.281Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ManagementClusterConfiguration",
    "processingStateDescription" : "Create Vsphere Cluster",
    "name" : "Create vMotion vmknics",
    "description" : "Create Vsphere Cluster",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "CreateVmotionVmknics.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "CreateVmotionVmknics.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.281Z",
    "updateTimestamp" : "2019-08-28T08:38:37.281Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ManagementClusterConfiguration",
    "processingStateDescription" : "Create Vsphere Cluster",
    "name" : "Create vSAN vmknics",
    "description" : "Create Vsphere Cluster",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "CreateVsanVmknics.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "CreateVsanVmknics.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.281Z",
    "updateTimestamp" : "2019-08-28T08:38:37.281Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ManagementClusterConfiguration",
    "processingStateDescription" : "Create Vsphere Cluster",
    "name" : "Configure VLANs on vSphere Distributed Switch Portgroups",
    "description" : "Create Vsphere Cluster",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "TagVlanIdsOnPortgroups.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "TagVlanIdsOnPortgroups.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.281Z",
    "updateTimestamp" : "2019-08-28T08:38:37.281Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ManagementClusterConfiguration",
    "processingStateDescription" : "Create Vsphere Cluster",
    "name" : "Migrate VMs to vSphere Distributed Switch",
    "description" : "Create Vsphere Cluster",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "MigrateVmsToPortgroups.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "MigrateVmsToPortgroups.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.281Z",
    "updateTimestamp" : "2019-08-28T08:38:37.281Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ManagementClusterConfiguration",
    "processingStateDescription" : "Create Vsphere Cluster",
    "name" : "Migrate ESXi Host vmknics to vSphere Distributed Switch",
    "description" : "Create Vsphere Cluster",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "MigrateHostVmknicsToPortgroups.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "MigrateHostVmknicsToPortgroups.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.281Z",
    "updateTimestamp" : "2019-08-28T08:38:37.281Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ManagementClusterConfiguration",
    "processingStateDescription" : "Create Vsphere Cluster",
    "name" : "Detach ESXi Host vmnics from vSphere Standard Switch",
    "description" : "Create Vsphere Cluster",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "DetachVmnicFromVswitch.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "DetachVmnicFromVswitch.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.281Z",
    "updateTimestamp" : "2019-08-28T08:38:37.281Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ManagementClusterConfiguration",
    "processingStateDescription" : "Create Vsphere Cluster",
    "name" : "Attach ESXi Host vmnics to vSphere Distributed Switch",
    "description" : "Create Vsphere Cluster",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "AttachVmnicToDvs.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "AttachVmnicToDvs.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.281Z",
    "updateTimestamp" : "2019-08-28T08:38:37.281Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ManagementClusterConfiguration",
    "processingStateDescription" : "Create Vsphere Cluster",
    "name" : "Remove vSphere Standard Switch",
    "description" : "Create Vsphere Cluster",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "RemoveVswitch.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "RemoveVswitch.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.281Z",
    "updateTimestamp" : "2019-08-28T08:38:37.281Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ManagementClusterConfiguration",
    "processingStateDescription" : "Create Vsphere Cluster",
    "name" : "Update vSAN Hardware Compatability List (HCL) Database",
    "description" : "Create Vsphere Cluster",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "UpdateVsanHcl.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "UpdateVsanHcl.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.281Z",
    "updateTimestamp" : "2019-08-28T08:38:37.281Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ManagementClusterConfiguration",
    "processingStateDescription" : "Create Vsphere Cluster",
    "name" : "Enable vSAN",
    "description" : "Create Vsphere Cluster",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "EnableVsan.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "EnableVsan.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.281Z",
    "updateTimestamp" : "2019-08-28T08:38:37.281Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ManagementClusterConfiguration",
    "processingStateDescription" : "Create Vsphere Cluster",
    "name" : "Enable vSAN Deduplication on Cluster",
    "description" : "Create Vsphere Cluster",
    "localizableNamePack" : {
      "component" : "com.vmware.vcf.common.fsm.plugins.action.VspherePlugin",
      "messageKey" : "EnableVsanDedupOnClusterAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.vcf.common.fsm.plugins.action.VspherePlugin",
      "messageKey" : "EnableVsanDedupOnClusterAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.281Z",
    "updateTimestamp" : "2019-08-28T08:38:37.281Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ManagementClusterConfiguration",
    "processingStateDescription" : "Create Vsphere Cluster",
    "name" : "Enable vSAN Storage Policies",
    "description" : "Create Vsphere Cluster",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "EnableVsanPolicies.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "EnableVsanPolicies.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.281Z",
    "updateTimestamp" : "2019-08-28T08:38:37.281Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ManagementClusterConfiguration",
    "processingStateDescription" : "Create Vsphere Cluster",
    "name" : "Create vSAN Disk Groups",
    "description" : "Create Vsphere Cluster",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "VsanClaimDisks.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "VsanClaimDisks.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.281Z",
    "updateTimestamp" : "2019-08-28T08:38:37.281Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ManagementClusterConfiguration",
    "processingStateDescription" : "Create Vsphere Cluster",
    "name" : "Create Resource Pools in vCenter Server",
    "description" : "Create Vsphere Cluster",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "CreateResourcePool.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "CreateResourcePool.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.281Z",
    "updateTimestamp" : "2019-08-28T08:38:37.281Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ApplyEsxLicense",
    "processingStateDescription" : "Apply ESXi Host License Key",
    "name" : "Apply ESXi Host License Key",
    "description" : "Apply ESXi Host License Key",
    "localizableNamePack" : {
      "component" : "workflowconfig.ems_recipes.ApplyEsxLicense",
      "messageKey" : "ApplyEsxiLicenseInVcAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "workflowconfig.ems_recipes.ApplyEsxLicense",
      "messageKey" : "ApplyEsxiLicenseInVcAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.321Z",
    "updateTimestamp" : "2019-08-28T08:38:37.321Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ApplyEsxLicense",
    "processingStateDescription" : "Apply ESXi Host License Key",
    "name" : "Generate ESXi License Rename Input Data",
    "description" : "Apply ESXi Host License Key",
    "localizableNamePack" : {
      "component" : "workflowconfig.ems_recipes.ApplyEsxLicense",
      "messageKey" : "GenerateLicenseRenameInput.name"
    },
    "localizableDescriptionPack" : {
      "component" : "workflowconfig.ems_recipes.ApplyEsxLicense",
      "messageKey" : "GenerateLicenseRenameInput.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.321Z",
    "updateTimestamp" : "2019-08-28T08:38:37.321Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ApplyEsxLicense",
    "processingStateDescription" : "Apply ESXi Host License Key",
    "name" : "Rename the Applied ESXi License in vCenter Server",
    "description" : "Apply ESXi Host License Key",
    "localizableNamePack" : {
      "component" : "workflowconfig.ems_recipes.ApplyEsxLicense",
      "messageKey" : "RenameLicense.name"
    },
    "localizableDescriptionPack" : {
      "component" : "workflowconfig.ems_recipes.ApplyEsxLicense",
      "messageKey" : "RenameLicense.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.321Z",
    "updateTimestamp" : "2019-08-28T08:38:37.321Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "NSXvConfiguration",
    "processingStateDescription" : "Deploy and Configure NSX for vSphere",
    "name" : "Deploy NSX Manager",
    "description" : "Deploy and Configure NSX for vSphere",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
      "messageKey" : "DeployNsxManager.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
      "messageKey" : "DeployNsxManager.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.328Z",
    "updateTimestamp" : "2019-08-28T08:38:37.328Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "NSXvConfiguration",
    "processingStateDescription" : "Deploy and Configure NSX for vSphere",
    "name" : "Generate and Install VMCA Certificate on NSX Manager",
    "description" : "Deploy and Configure NSX for vSphere",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
      "messageKey" : "UploadNsxManagerVmcaCert.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
      "messageKey" : "UploadNsxManagerVmcaCert.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.328Z",
    "updateTimestamp" : "2019-08-28T08:38:37.328Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "NSXvConfiguration",
    "processingStateDescription" : "Deploy and Configure NSX for vSphere",
    "name" : "Update NSX Manager TLS Settings",
    "description" : "Deploy and Configure NSX for vSphere",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
      "messageKey" : "UpdateNsxManagerTLSSettings.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
      "messageKey" : "UpdateNsxManagerTLSSettings.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.328Z",
    "updateTimestamp" : "2019-08-28T08:38:37.328Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "NSXvConfiguration",
    "processingStateDescription" : "Deploy and Configure NSX for vSphere",
    "name" : "Register NSX Manager with vCenter Server",
    "description" : "Deploy and Configure NSX for vSphere",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.action64.NsxServicePluginActionPlugin64",
      "messageKey" : "RegisterVcNsx.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.action64.NsxServicePluginActionPlugin64",
      "messageKey" : "RegisterVcNsx.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.328Z",
    "updateTimestamp" : "2019-08-28T08:38:37.328Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "NSXvConfiguration",
    "processingStateDescription" : "Deploy and Configure NSX for vSphere",
    "name" : "Apply NSX Dormant License File (DLF)",
    "description" : "Deploy and Configure NSX for vSphere",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
      "messageKey" : "UploadNsxDlf.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
      "messageKey" : "UploadNsxDlf.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.328Z",
    "updateTimestamp" : "2019-08-28T08:38:37.328Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "NSXvConfiguration",
    "processingStateDescription" : "Deploy and Configure NSX for vSphere",
    "name" : "Apply NSX License",
    "description" : "Deploy and Configure NSX for vSphere",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
      "messageKey" : "ApplyNsxLicense.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
      "messageKey" : "ApplyNsxLicense.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.328Z",
    "updateTimestamp" : "2019-08-28T08:38:37.328Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "NSXvConfiguration",
    "processingStateDescription" : "Deploy and Configure NSX for vSphere",
    "name" : "Generate NSX License Rename Input Data",
    "description" : "Deploy and Configure NSX for vSphere",
    "localizableNamePack" : {
      "component" : "workflowconfig.ems_recipes.NSXvConfiguration",
      "messageKey" : "GenerateLicenseRenameInputId.name"
    },
    "localizableDescriptionPack" : {
      "component" : "workflowconfig.ems_recipes.NSXvConfiguration",
      "messageKey" : "GenerateLicenseRenameInputId.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.328Z",
    "updateTimestamp" : "2019-08-28T08:38:37.328Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "NSXvConfiguration",
    "processingStateDescription" : "Deploy and Configure NSX for vSphere",
    "name" : "Rename the Applied NSX License in vCenter Server",
    "description" : "Deploy and Configure NSX for vSphere",
    "localizableNamePack" : {
      "component" : "workflowconfig.ems_recipes.NSXvConfiguration",
      "messageKey" : "RenameLicenseId.name"
    },
    "localizableDescriptionPack" : {
      "component" : "workflowconfig.ems_recipes.NSXvConfiguration",
      "messageKey" : "RenameLicenseId.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.328Z",
    "updateTimestamp" : "2019-08-28T08:38:37.328Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "NSXvConfiguration",
    "processingStateDescription" : "Deploy and Configure NSX for vSphere",
    "name" : "Generate NSX Manager Input Data",
    "description" : "Deploy and Configure NSX for vSphere",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.vvd.plugin.VvdPlugin",
      "messageKey" : "GenerateNsxInput.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.vvd.plugin.VvdPlugin",
      "messageKey" : "GenerateNsxInput.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.328Z",
    "updateTimestamp" : "2019-08-28T08:38:37.328Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "NSXvConfiguration",
    "processingStateDescription" : "Deploy and Configure NSX for vSphere",
    "name" : "Configure DNS on the NSX Controller Cluster",
    "description" : "Deploy and Configure NSX for vSphere",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.common.nsx.NsxManagerPlugin",
      "messageKey" : "ConfigureControllerDns.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.common.nsx.NsxManagerPlugin",
      "messageKey" : "ConfigureControllerDns.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.328Z",
    "updateTimestamp" : "2019-08-28T08:38:37.328Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "NSXvConfiguration",
    "processingStateDescription" : "Deploy and Configure NSX for vSphere",
    "name" : "Configure NTP on the NSX Controller Cluster",
    "description" : "Deploy and Configure NSX for vSphere",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.common.nsx.NsxManagerPlugin",
      "messageKey" : "ConfigureControllerNtp.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.common.nsx.NsxManagerPlugin",
      "messageKey" : "ConfigureControllerNtp.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.328Z",
    "updateTimestamp" : "2019-08-28T08:38:37.328Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "NSXvConfiguration",
    "processingStateDescription" : "Deploy and Configure NSX for vSphere",
    "name" : "Create NSX Controller Cluster",
    "description" : "Deploy and Configure NSX for vSphere",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
      "messageKey" : "DeployNsxController.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
      "messageKey" : "DeployNsxController.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.328Z",
    "updateTimestamp" : "2019-08-28T08:38:37.328Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "NSXvConfiguration",
    "processingStateDescription" : "Deploy and Configure NSX for vSphere",
    "name" : "Configure VXLAN Transport",
    "description" : "Deploy and Configure NSX for vSphere",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
      "messageKey" : "CreateVxlan.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
      "messageKey" : "CreateVxlan.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.328Z",
    "updateTimestamp" : "2019-08-28T08:38:37.328Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "NSXvConfiguration",
    "processingStateDescription" : "Deploy and Configure NSX for vSphere",
    "name" : "Resolve NSX Cluster Issues",
    "description" : "Deploy and Configure NSX for vSphere",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
      "messageKey" : "ResolveNsxClusterIssues.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
      "messageKey" : "ResolveNsxClusterIssues.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.328Z",
    "updateTimestamp" : "2019-08-28T08:38:37.328Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "NSXvConfiguration",
    "processingStateDescription" : "Deploy and Configure NSX for vSphere",
    "name" : "Set Universal Sync Role on NSX Manager",
    "description" : "Deploy and Configure NSX for vSphere",
    "localizableNamePack" : {
      "component" : "com.vmware.vcf.common.fsm.plugins.action.nsx.NsxPlugin",
      "messageKey" : "SetNsxRoleAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.vcf.common.fsm.plugins.action.nsx.NsxPlugin",
      "messageKey" : "SetNsxRoleAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.328Z",
    "updateTimestamp" : "2019-08-28T08:38:37.328Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "NSXvConfiguration",
    "processingStateDescription" : "Deploy and Configure NSX for vSphere",
    "name" : "Create NSX Segment Range",
    "description" : "Deploy and Configure NSX for vSphere",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
      "messageKey" : "CreateNsxSegmentRange.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
      "messageKey" : "CreateNsxSegmentRange.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.328Z",
    "updateTimestamp" : "2019-08-28T08:38:37.328Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "NSXvConfiguration",
    "processingStateDescription" : "Deploy and Configure NSX for vSphere",
    "name" : "Create NSX Multicast Range",
    "description" : "Deploy and Configure NSX for vSphere",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.plugin.ConfigureNsxPlugin",
      "messageKey" : "CreateMulticastRange.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.plugin.ConfigureNsxPlugin",
      "messageKey" : "CreateMulticastRange.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.328Z",
    "updateTimestamp" : "2019-08-28T08:38:37.328Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "NSXvConfiguration",
    "processingStateDescription" : "Deploy and Configure NSX for vSphere",
    "name" : "Create NSX Transport Zone",
    "description" : "Deploy and Configure NSX for vSphere",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
      "messageKey" : "CreateNsxTransportZone.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
      "messageKey" : "CreateNsxTransportZone.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.328Z",
    "updateTimestamp" : "2019-08-28T08:38:37.328Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "NSXvConfiguration",
    "processingStateDescription" : "Deploy and Configure NSX for vSphere",
    "name" : "Configure SSO on NSX Manager",
    "description" : "Deploy and Configure NSX for vSphere",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
      "messageKey" : "ConfigureSsoOnNSX.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
      "messageKey" : "ConfigureSsoOnNSX.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.328Z",
    "updateTimestamp" : "2019-08-28T08:38:37.328Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "GenerateLogInsightInput",
    "processingStateDescription" : "Generate vRealize Log Insight Input Data",
    "name" : "Generate vRealize Log Insight Input Data",
    "description" : "Generate vRealize Log Insight Input Data",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateLogInsightInput.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateLogInsightInput.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.359Z",
    "updateTimestamp" : "2019-08-28T08:38:37.359Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_LogInsightDeployment_DeployLogInsightPlugin_DeployLogInsightAction_1",
    "processingStateDescription" : "Deploy vRealize Log Insight",
    "name" : "Deploy vRealize Log Insight",
    "description" : "Deploy vRealize Log Insight",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.common.fsmplugins.loginsight.plugin.DeployLogInsightPlugin",
      "messageKey" : "DeployLogInsightAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.common.fsmplugins.loginsight.plugin.DeployLogInsightPlugin",
      "messageKey" : "DeployLogInsightAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.364Z",
    "updateTimestamp" : "2019-08-28T08:38:37.364Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_LogInsightDeployment_ConfigureLogInsightPlugin_AddLogInsightLicenseAction_2",
    "processingStateDescription" : "Apply vRealize Log Insight License",
    "name" : "Apply vRealize Log Insight License Action",
    "description" : "Apply vRealize Log Insight License",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.common.fsmplugins.loginsight.plugin.ConfigureLogInsightPlugin",
      "messageKey" : "AddLogInsightLicenseAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.common.fsmplugins.loginsight.plugin.ConfigureLogInsightPlugin",
      "messageKey" : "AddLogInsightLicenseAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.368Z",
    "updateTimestamp" : "2019-08-28T08:38:37.368Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_LogInsightDeployment_ConfigureLogInsightPlugin_BootstrapLogInsightClusterAction_3",
    "processingStateDescription" : "Bootstrap vRealize Log Insight Cluster",
    "name" : "Bootstrap vRealize Log Insight Cluster Action",
    "description" : "Bootstrap vRealize Log Insight Cluster",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.common.fsmplugins.loginsight.plugin.ConfigureLogInsightPlugin",
      "messageKey" : "BootstrapLogInsightClusterAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.common.fsmplugins.loginsight.plugin.ConfigureLogInsightPlugin",
      "messageKey" : "BootstrapLogInsightClusterAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.372Z",
    "updateTimestamp" : "2019-08-28T08:38:37.372Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_LogInsightDeployment_ConfigureLogInsightPlugin_GenerateLogInsightCertificateAction_4",
    "processingStateDescription" : "Generate and Install VMCA Certificate for vRealize Log Insight",
    "name" : "Generate and Install VMCA Certificate for vRealize Log Insight",
    "description" : "Generate and Install VMCA Certificate for vRealize Log Insight",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.common.fsmplugins.loginsight.plugin.ConfigureLogInsightPlugin",
      "messageKey" : "GenerateLogInsightCertificateAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.common.fsmplugins.loginsight.plugin.ConfigureLogInsightPlugin",
      "messageKey" : "GenerateLogInsightCertificateAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.377Z",
    "updateTimestamp" : "2019-08-28T08:38:37.377Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_LogInsightDeployment_ConfigureLogInsightPlugin_DisableTlsOnLogInsightAction_5",
    "processingStateDescription" : "Disable TLS 1.0 on vRealize Log Insight Nodes",
    "name" : "Disable TLS 1.0 on vRealize Log Insight Nodes Action",
    "description" : "Disable TLS 1.0 on vRealize Log Insight Nodes",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.common.fsmplugins.loginsight.plugin.ConfigureLogInsightPlugin",
      "messageKey" : "DisableTlsOnLogInsightAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.common.fsmplugins.loginsight.plugin.ConfigureLogInsightPlugin",
      "messageKey" : "DisableTlsOnLogInsightAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.381Z",
    "updateTimestamp" : "2019-08-28T08:38:37.381Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_LogInsightDeployment_ConfigureLogInsightPlugin_InstallContentPacksInLogInsightAction_6",
    "processingStateDescription" : "Install vRealize Log Insight Content Packs",
    "name" : "Install vRealize Log Insight Content Packs Action",
    "description" : "Install vRealize Log Insight Content Packs",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.common.fsmplugins.loginsight.plugin.ConfigureLogInsightPlugin",
      "messageKey" : "InstallContentPacksInLogInsightAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.common.fsmplugins.loginsight.plugin.ConfigureLogInsightPlugin",
      "messageKey" : "InstallContentPacksInLogInsightAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.385Z",
    "updateTimestamp" : "2019-08-28T08:38:37.385Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "GenerateNsxvLogInsightIntegrationInput",
    "processingStateDescription" : "Generate NsxvLogInsightIntegration input",
    "name" : "Generate NSX for vSphere Integration with vRealize Log Insight Input Data",
    "description" : "Generate NsxvLogInsightIntegration input",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateNsxvLogInsightIntegrationInput.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateNsxvLogInsightIntegrationInput.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.389Z",
    "updateTimestamp" : "2019-08-28T08:38:37.389Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_NsxvLogInsightIntegration_ConfigureSyslogInNsxPlugin_ConfigureSyslogInNsxManagerAction_1",
    "processingStateDescription" : "Configure Syslog Settings for NSX Manager",
    "name" : "Configure Syslog Settings for NSX Manager",
    "description" : "Configure Syslog Settings for NSX Manager",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.common.fsmplugins.loginsight.plugin.ConfigureSyslogInNsxPlugin",
      "messageKey" : "ConfigureSyslogInNsxManagerAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.common.fsmplugins.loginsight.plugin.ConfigureSyslogInNsxPlugin",
      "messageKey" : "ConfigureSyslogInNsxManagerAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.392Z",
    "updateTimestamp" : "2019-08-28T08:38:37.392Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_NsxvLogInsightIntegration_ConfigureSyslogInNsxPlugin_ConfigureSyslogInNsxControllerAction_2",
    "processingStateDescription" : "Configure Syslog Settings for NSX Controllers",
    "name" : "Configure Syslog Settings for NSX Controllers",
    "description" : "Configure Syslog Settings for NSX Controllers",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.common.fsmplugins.loginsight.plugin.ConfigureSyslogInNsxPlugin",
      "messageKey" : "ConfigureSyslogInNsxControllerAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.common.fsmplugins.loginsight.plugin.ConfigureSyslogInNsxPlugin",
      "messageKey" : "ConfigureSyslogInNsxControllerAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.396Z",
    "updateTimestamp" : "2019-08-28T08:38:37.396Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "GenerateSddcManagerInput",
    "processingStateDescription" : "Generate SDDC Manager Input Data",
    "name" : "Generate SDDC Manager Input Data",
    "description" : "Generate SDDC Manager Input Data",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateSddcManagerInput.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateSddcManagerInput.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.399Z",
    "updateTimestamp" : "2019-08-28T08:38:37.399Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_SDDCManagerConfiguration_SddcManagerContractPlugin_DeploySddcManagerOnClusterAction_1",
    "processingStateDescription" : "Deploy SDDC Manager",
    "name" : "Deploy SDDC Manager",
    "description" : "Deploy SDDC Manager",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.sddcmanager.SddcManagerContractPlugin",
      "messageKey" : "DeploySddcManagerOnClusterAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.sddcmanager.SddcManagerContractPlugin",
      "messageKey" : "DeploySddcManagerOnClusterAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.405Z",
    "updateTimestamp" : "2019-08-28T08:38:37.405Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_SDDCManagerConfiguration_SddcManagerContractPlugin_ConfigureLCMRepoOnSddcManagerAction_2",
    "processingStateDescription" : "Configure Lifecycle Management Repository on SDDC Manager",
    "name" : "Configure Lifecycle Management Repository on SDDC Manager",
    "description" : "Configure Lifecycle Management Repository on SDDC Manager",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.sddcmanager.SddcManagerContractPlugin",
      "messageKey" : "ConfigureLCMRepoOnSddcManagerAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.sddcmanager.SddcManagerContractPlugin",
      "messageKey" : "ConfigureLCMRepoOnSddcManagerAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.410Z",
    "updateTimestamp" : "2019-08-28T08:38:37.410Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_SDDCManagerConfiguration_HostPlugin_CreateNFSDatastoreOnHostsAction_3",
    "processingStateDescription" : "Mount Repository NFS Datastore on ESXi Hosts",
    "name" : "Mount Repository NFS Datastore on ESXi Hosts",
    "description" : "Mount Repository NFS Datastore on ESXi Hosts",
    "localizableNamePack" : {
      "component" : "com.vmware.vcf.common.fsm.plugins.action.HostPlugin",
      "messageKey" : "CreateNFSDatastoreOnHostsAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.vcf.common.fsm.plugins.action.HostPlugin",
      "messageKey" : "CreateNFSDatastoreOnHostsAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.414Z",
    "updateTimestamp" : "2019-08-28T08:38:37.414Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_SDDCManagerConfiguration_SddcManagerContractPlugin_ConfigureBaseImageRepoAction_4",
    "processingStateDescription" : "Configure Base Install Image Repository on SDDC Manager",
    "name" : "Configure Base Install Image Repository on SDDC Manager",
    "description" : "Configure Base Install Image Repository on SDDC Manager",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.sddcmanager.SddcManagerContractPlugin",
      "messageKey" : "ConfigureBaseImageRepoAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.sddcmanager.SddcManagerContractPlugin",
      "messageKey" : "ConfigureBaseImageRepoAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.417Z",
    "updateTimestamp" : "2019-08-28T08:38:37.417Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_SDDCManagerConfiguration_SddcManagerContractPlugin_InstallVmcaRootCertOnSddcManagerAction_5",
    "processingStateDescription" : "Install VMCA Root Certificate on SDDC Manager",
    "name" : "Install VMCA Root Certificate on SDDC Manager",
    "description" : "Install VMCA Root Certificate on SDDC Manager",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.sddcmanager.SddcManagerContractPlugin",
      "messageKey" : "InstallVmcaRootCertOnSddcManagerAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.sddcmanager.SddcManagerContractPlugin",
      "messageKey" : "InstallVmcaRootCertOnSddcManagerAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.421Z",
    "updateTimestamp" : "2019-08-28T08:38:37.421Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_SDDCManagerConfiguration_SddcManagerContractPlugin_InstallSddcManagerVmcaCertificateAction_6",
    "processingStateDescription" : "Generate and Install VMCA Certificate on SDDC Manager",
    "name" : "Generate and Install VMCA Certificate on SDDC Manager",
    "description" : "Generate and Install VMCA Certificate on SDDC Manager",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.sddcmanager.SddcManagerContractPlugin",
      "messageKey" : "InstallSddcManagerVmcaCertificateAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.sddcmanager.SddcManagerContractPlugin",
      "messageKey" : "InstallSddcManagerVmcaCertificateAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.425Z",
    "updateTimestamp" : "2019-08-28T08:38:37.425Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "GenerateInventoryForSddcManagerConfiguration",
    "processingStateDescription" : "Generate Inventory Data For SDDC Manager Configuration",
    "name" : "Generate Inventory data For SDDC Manager Configuration",
    "description" : "Generate Inventory Data For SDDC Manager Configuration",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateInventoryForSddcManagerConfiguration.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateInventoryForSddcManagerConfiguration.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.429Z",
    "updateTimestamp" : "2019-08-28T08:38:37.429Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_SDDCManagerPostInventory_SddcManagerContractPlugin_PostInventoryAndCredentialsAction_1",
    "processingStateDescription" : "Update SDDC Manager Inventory with Credential Details",
    "name" : "Update SDDC Manager Inventory with Credential Details",
    "description" : "Update SDDC Manager Inventory with Credential Details",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.sddcmanager.SddcManagerContractPlugin",
      "messageKey" : "PostInventoryAndCredentialsAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.sddcmanager.SddcManagerContractPlugin",
      "messageKey" : "PostInventoryAndCredentialsAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.433Z",
    "updateTimestamp" : "2019-08-28T08:38:37.433Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_SDDCManagerPostInventory_SddcManagerContractPlugin_PostNetworkPoolInventoryAction_2",
    "processingStateDescription" : "Update SDDC Manager Inventory with Network Pool Details",
    "name" : "Update SDDC Manager Inventory with Network Pool Details",
    "description" : "Update SDDC Manager Inventory with Network Pool Details",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.sddcmanager.SddcManagerContractPlugin",
      "messageKey" : "PostNetworkPoolInventoryAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.sddcmanager.SddcManagerContractPlugin",
      "messageKey" : "PostNetworkPoolInventoryAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.437Z",
    "updateTimestamp" : "2019-08-28T08:38:37.437Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_SDDCManagerPostInventory_SddcManagerContractPlugin_PostSddcLicenseInventoryAction_3",
    "processingStateDescription" : "Update SDDC Manager Inventory with License Details",
    "name" : "Update SDDC Manager Inventory with License Details",
    "description" : "Update SDDC Manager Inventory with License Details",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.sddcmanager.SddcManagerContractPlugin",
      "messageKey" : "PostSddcLicenseInventoryAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.sddcmanager.SddcManagerContractPlugin",
      "messageKey" : "PostSddcLicenseInventoryAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.441Z",
    "updateTimestamp" : "2019-08-28T08:38:37.441Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_SddcManagerKnownHostsConfiguration_ProxyContractPlugin_ProxyContractAction_17",
    "processingStateDescription" : "Automation Helper Action",
    "name" : "ProxyContractAction",
    "description" : "Automation Helper Action",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.orchestrator.core.recipes.spel.ProxyContractPlugin",
      "messageKey" : "ProxyContractAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.orchestrator.core.recipes.spel.ProxyContractPlugin",
      "messageKey" : "ProxyContractAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.444Z",
    "updateTimestamp" : "2019-08-28T08:38:37.444Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "GenerateSddcManagerInput",
    "processingStateDescription" : "Generate SDDC Manager Input Data",
    "name" : "Generate SDDC Manager Input Data",
    "description" : "Generate SDDC Manager Input Data",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateSddcManagerInput.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateSddcManagerInput.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.447Z",
    "updateTimestamp" : "2019-08-28T08:38:37.447Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "GenerateVsphereMachineSshEntities",
    "processingStateDescription" : "Generate ESXi Host SSH Key Input Data",
    "name" : "Generate ESXi Host SSH Key Input Data",
    "description" : "Generate ESXi Host SSH Key Input Data",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateVsphereMachineSshEntities.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateVsphereMachineSshEntities.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.453Z",
    "updateTimestamp" : "2019-08-28T08:38:37.453Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_SddcManagerKnownHostsConfiguration_VsphereContractPlugin_RotateMachineSshKeys_2",
    "processingStateDescription" : "Rotate ESXi Host SSH Keys",
    "name" : "Rotate ESXi Host SSH Keys",
    "description" : "Rotate ESXi Host SSH Keys",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.vsphere.contract.VsphereContractPlugin",
      "messageKey" : "RotateMachineSshKeys.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.vsphere.contract.VsphereContractPlugin",
      "messageKey" : "RotateMachineSshKeys.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.456Z",
    "updateTimestamp" : "2019-08-28T08:38:37.456Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_SddcManagerKnownHostsConfiguration_SddcManagerContractPlugin_UpdateKnownHostsOnSddcManager_3",
    "processingStateDescription" : "Update Known Hosts in SDDC Manager",
    "name" : "Update Known Hosts in SDDC Manager",
    "description" : "Update Known Hosts in SDDC Manager",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.sddcmanager.SddcManagerContractPlugin",
      "messageKey" : "UpdateKnownHostsOnSddcManager.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.sddcmanager.SddcManagerContractPlugin",
      "messageKey" : "UpdateKnownHostsOnSddcManager.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.459Z",
    "updateTimestamp" : "2019-08-28T08:38:37.459Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "GenerateVsphereInput",
    "processingStateDescription" : "Generate vSphere Input Data",
    "name" : "Generate vSphere Input Data",
    "description" : "Generate vSphere Input Data",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateVsphereInput.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateVsphereInput.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.462Z",
    "updateTimestamp" : "2019-08-28T08:38:37.462Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "GenerateSddcManagerInput",
    "processingStateDescription" : "Generate SDDC Manager Input Data",
    "name" : "Generate SDDC Manager Input Data",
    "description" : "Generate SDDC Manager Input Data",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateSddcManagerInput.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateSddcManagerInput.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.465Z",
    "updateTimestamp" : "2019-08-28T08:38:37.465Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_VcenterMessagesConfigurations_VsphereContractPlugin_PrepareVcenterMessages_2",
    "processingStateDescription" : "Generate Configure vCenter Login Message and Message of the Day Input Data",
    "name" : "Generate Configure vCenter Login Message and Message of the Day Input Data",
    "description" : "Generate Configure vCenter Login Message and Message of the Day Input Data",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.vsphere.contract.VsphereContractPlugin",
      "messageKey" : "PrepareVcenterMessages.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.vsphere.contract.VsphereContractPlugin",
      "messageKey" : "PrepareVcenterMessages.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.471Z",
    "updateTimestamp" : "2019-08-28T08:38:37.471Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_VcenterMessagesConfigurations_VsphereContractPlugin_ConfigureVcenterMessages_3",
    "processingStateDescription" : "Configure vCenter Login Message and Message of the Day",
    "name" : "Configure vCenter Login Message and Message of the Day",
    "description" : "Configure vCenter Login Message and Message of the Day",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.vsphere.contract.VsphereContractPlugin",
      "messageKey" : "ConfigureVcenterMessages.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.vsphere.contract.VsphereContractPlugin",
      "messageKey" : "ConfigureVcenterMessages.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.474Z",
    "updateTimestamp" : "2019-08-28T08:38:37.474Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "GenerateClusterConfigurationInput",
    "processingStateDescription" : "Generate Cluster Configuration Input Data",
    "name" : "Generate Post Cluster Configuration Input Data",
    "description" : "Generate Cluster Configuration Input Data",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateClusterConfigurationInput.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateClusterConfigurationInput.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.477Z",
    "updateTimestamp" : "2019-08-28T08:38:37.477Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "GenerateConfigureDeploymentDetailsActionInput",
    "processingStateDescription" : "Generate Configure Deployment Details Action Input Data",
    "name" : "Generate Configure Deployment Details Action Input Data",
    "description" : "Generate Configure Deployment Details Action Input Data",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateConfigureDeploymentDetailsActionInput.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateConfigureDeploymentDetailsActionInput.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.483Z",
    "updateTimestamp" : "2019-08-28T08:38:37.483Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_PostClusterConfiguration_VspherePlugin_MigrateVmsToFoldersAction_2",
    "processingStateDescription" : "Move VMs to VM Folders",
    "name" : "Move VMs to VM Folders",
    "description" : "Move VMs to VM Folders",
    "localizableNamePack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "MigrateVmsToFoldersAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "MigrateVmsToFoldersAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.486Z",
    "updateTimestamp" : "2019-08-28T08:38:37.486Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_PostClusterConfiguration_VspherePlugin_MigrateDvsToFolderAction_3",
    "processingStateDescription" : "Move vSphere Distributed Switch to Network Folder",
    "name" : "Move vSphere Distributed Switch to Network Folder",
    "description" : "Move vSphere Distributed Switch to Network Folder",
    "localizableNamePack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "MigrateDvsToFolderAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "MigrateDvsToFolderAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.489Z",
    "updateTimestamp" : "2019-08-28T08:38:37.489Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_PostClusterConfiguration_VspherePlugin_DisableVsanForceProvisionAction_4",
    "processingStateDescription" : "Disable vSAN Force Provisioning",
    "name" : "Disable vSAN Force Provisioning",
    "description" : "Disable vSAN Force Provisioning",
    "localizableNamePack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "DisableVsanForceProvisionAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "DisableVsanForceProvisionAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.492Z",
    "updateTimestamp" : "2019-08-28T08:38:37.492Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_PostClusterConfiguration_VspherePlugin_EnableVsanPoliciesAction_5",
    "processingStateDescription" : "Enable vSAN Storage Policies",
    "name" : "Enable vSAN Storage Policies",
    "description" : "Enable vSAN Storage Policies",
    "localizableNamePack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "EnableVsanPoliciesAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "EnableVsanPoliciesAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.496Z",
    "updateTimestamp" : "2019-08-28T08:38:37.496Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_PostClusterConfiguration_VspherePlugin_RelocateAllVmsToResourcePoolAction_6",
    "processingStateDescription" : "Move VMs to Resource Pools",
    "name" : "Move VMs to Resource Pools",
    "description" : "Move VMs to Resource Pools",
    "localizableNamePack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "RelocateAllVmsToResourcePoolAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "RelocateAllVmsToResourcePoolAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.499Z",
    "updateTimestamp" : "2019-08-28T08:38:37.499Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_PostClusterConfiguration_VspherePlugin_AdjustResourcePoolReservationAction_7",
    "processingStateDescription" : "Set Reservations on Resource Pools",
    "name" : "Set Reservations on Resource Pools",
    "description" : "Set Reservations on Resource Pools",
    "localizableNamePack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "AdjustResourcePoolReservationAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "AdjustResourcePoolReservationAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.502Z",
    "updateTimestamp" : "2019-08-28T08:38:37.502Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_PostClusterConfiguration_VcPlugin_EnableClusterHaAction_8",
    "processingStateDescription" : "Enable vSphere High Availability",
    "name" : "Enable vSphere High Availability",
    "description" : "Enable vSphere High Availability",
    "localizableNamePack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "EnableClusterHaAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "EnableClusterHaAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.505Z",
    "updateTimestamp" : "2019-08-28T08:38:37.505Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_PostClusterConfiguration_VcPlugin_CreateVmAntiAffinityRuleAction_9",
    "processingStateDescription" : "Create VM Anti-Affinity Rules",
    "name" : "Create VM Anti-Affinity Rules",
    "description" : "Create VM Anti-Affinity Rules",
    "localizableNamePack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "CreateVmAntiAffinityRuleAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "CreateVmAntiAffinityRuleAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.508Z",
    "updateTimestamp" : "2019-08-28T08:38:37.508Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_PostClusterConfiguration_CreatePscVcVmGroupsPlugin_CreatePscVcVmGroupsContractAction_10",
    "processingStateDescription" : "Create VM Groups",
    "name" : "Create VM Groups",
    "description" : "Create VM Groups",
    "localizableNamePack" : {
      "component" : "com.vmware.vcf.common.fsm.plugins.action.CreatePscVcVmGroupsPlugin",
      "messageKey" : "CreatePscVcVmGroupsContractAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.vcf.common.fsm.plugins.action.CreatePscVcVmGroupsPlugin",
      "messageKey" : "CreatePscVcVmGroupsContractAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.511Z",
    "updateTimestamp" : "2019-08-28T08:38:37.511Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_PostClusterConfiguration_VspherePlugin_CreateClusterVmsToVmsRuleContractAction_11",
    "processingStateDescription" : "Create VM-VM Startup Order Rule",
    "name" : "Create VM-VM Startup Order Rule",
    "description" : "Create VM-VM Startup Order Rule",
    "localizableNamePack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "CreateClusterVmsToVmsRuleContractAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "CreateClusterVmsToVmsRuleContractAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.514Z",
    "updateTimestamp" : "2019-08-28T08:38:37.514Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_PostClusterConfiguration_ClusterVmHostPlugin_CreateClusterHostGroupContractAction_12",
    "processingStateDescription" : "Create vCenter VM/Host RuleNsxServiceImpl.java",
    "name" : "Create vCenter VM/Host Rule",
    "description" : "Create vCenter VM/Host RuleNsxServiceImpl.java",
    "localizableNamePack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "CreateClusterHostGroupContractAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "CreateClusterHostGroupContractAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.517Z",
    "updateTimestamp" : "2019-08-28T08:38:37.517Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_PostClusterConfiguration_ClusterVmHostPlugin_CreateClusterVmHostRuleContractAction_13",
    "processingStateDescription" : "Create Platform Services Controller VM/Host Rule",
    "name" : "Create Platform Services Controller VM/Host Rule",
    "description" : "Create Platform Services Controller VM/Host Rule",
    "localizableNamePack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "CreatePSCVMHostRuleActionId.name"
    },
    "localizableDescriptionPack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "CreatePSCVMHostRuleActionId.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.520Z",
    "updateTimestamp" : "2019-08-28T08:38:37.520Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_PostClusterConfiguration_ClusterVmHostPlugin_CreateClusterVmHostRuleContractAction_14",
    "processingStateDescription" : "Create Cluster Rule",
    "name" : "Create Cluster Rule",
    "description" : "Create Cluster Rule",
    "localizableNamePack" : {
      "component" : "com.vmware.vcf.common.fsm.plugins.action.ClusterVmHostPlugin",
      "messageKey" : "CreateClusterVmHostRuleContractAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.vcf.common.fsm.plugins.action.ClusterVmHostPlugin",
      "messageKey" : "CreateClusterVmHostRuleContractAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.523Z",
    "updateTimestamp" : "2019-08-28T08:38:37.523Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_PostClusterConfiguration_VcPlugin_ConfigureEsxAdvancedOptionsAction_15",
    "processingStateDescription" : "Configure ESXi Advanced Options",
    "name" : "Configure ESXi Advanced Options",
    "description" : "Configure ESXi Advanced Options",
    "localizableNamePack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "ConfigureEsxAdvancedOptionsAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "ConfigureEsxAdvancedOptionsAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.526Z",
    "updateTimestamp" : "2019-08-28T08:38:37.526Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_PostClusterConfiguration_VspherePlugin_ReconfigureHAOnClusterAction_16",
    "processingStateDescription" : "Reconfigure vSphere High Availability",
    "name" : "Reconfigure vSphere High Availability",
    "description" : "Reconfigure vSphere High Availability",
    "localizableNamePack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "ReconfigureHAOnClusterAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "ReconfigureHAOnClusterAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.529Z",
    "updateTimestamp" : "2019-08-28T08:38:37.529Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_PostClusterConfiguration_VspherePlugin_ClearVsanAlarmsOnClusterAction_17",
    "processingStateDescription" : "Clear Alarms on vSAN",
    "name" : "Clear Alarms on vSAN",
    "description" : "Clear Alarms on vSAN",
    "localizableNamePack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "ClearVsanAlarmsOnClusterAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "ClearVsanAlarmsOnClusterAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.532Z",
    "updateTimestamp" : "2019-08-28T08:38:37.532Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_PostClusterConfiguration_VspherePlugin_ClearRedAlarmsOnHostAction_18",
    "processingStateDescription" : "Clear Alerts on Hosts",
    "name" : "Clear Alerts on Hosts",
    "description" : "Clear Alerts on Hosts",
    "localizableNamePack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "ClearRedAlarmsOnHostAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "ClearRedAlarmsOnHostAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.535Z",
    "updateTimestamp" : "2019-08-28T08:38:37.535Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_PostClusterConfiguration_VspherePlugin_ConfigureDeploymentDetailsContractAction_19",
    "processingStateDescription" : "Set SDDC Deployment Details on the Management vCenter Server",
    "name" : "Set SDDC Deployment Details on the Management vCenter Server",
    "description" : "Set SDDC Deployment Details on the Management vCenter Server",
    "localizableNamePack" : {
      "component" : "com.vmware.vcf.common.fsm.plugins.action.VspherePlugin",
      "messageKey" : "ConfigureDeploymentDetailsContractAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.vcf.common.fsm.plugins.action.VspherePlugin",
      "messageKey" : "ConfigureDeploymentDetailsContractAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.539Z",
    "updateTimestamp" : "2019-08-28T08:38:37.539Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "GenerateVsphereInput",
    "processingStateDescription" : "Generate vSphere Input Data",
    "name" : "Generate vSphere Input Data",
    "description" : "Generate vSphere Input Data",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateVsphereInput.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateVsphereInput.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.542Z",
    "updateTimestamp" : "2019-08-28T08:38:37.542Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_DisableBashShellOnVcAndPsc_VsphereContractPlugin_DisableBashShell_1",
    "processingStateDescription" : "Disable Bash Shell on vCenter Server",
    "name" : "Disable Bash Shell on vCenter Server",
    "description" : "Disable Bash Shell on vCenter Server",
    "localizableNamePack" : {
      "component" : "workflowconfig.common_recipes.DisableBashShellOnVcAndPsc",
      "messageKey" : "DisableBashShellOnVCenterId.name"
    },
    "localizableDescriptionPack" : {
      "component" : "workflowconfig.common_recipes.DisableBashShellOnVcAndPsc",
      "messageKey" : "DisableBashShellOnVCenterId.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.545Z",
    "updateTimestamp" : "2019-08-28T08:38:37.545Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_DisableBashShellOnVcAndPsc_VsphereContractPlugin_DisableBashShell_2",
    "processingStateDescription" : "Disable Bash Shell on Platform Services Controllers",
    "name" : "Disable Bash Shell on Platform Services Controllers",
    "description" : "Disable Bash Shell on Platform Services Controllers",
    "localizableNamePack" : {
      "component" : "workflowconfig.common_recipes.DisableBashShellOnVcAndPsc",
      "messageKey" : "DisableBashShellOnPSCsId.name"
    },
    "localizableDescriptionPack" : {
      "component" : "workflowconfig.common_recipes.DisableBashShellOnVcAndPsc",
      "messageKey" : "DisableBashShellOnPSCsId.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.548Z",
    "updateTimestamp" : "2019-08-28T08:38:37.548Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "NSXvConfigurationForSDDCManager",
    "processingStateDescription" : "Configure NSX for vSphere",
    "name" : "Add VMs to NSX Distributed Firewall Exclusion List",
    "description" : "Configure NSX for vSphere",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
      "messageKey" : "AddVmsIntoDfwExclusionList.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
      "messageKey" : "AddVmsIntoDfwExclusionList.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.551Z",
    "updateTimestamp" : "2019-08-28T08:38:37.551Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "NSXBackupConfiguration",
    "processingStateDescription" : "Configure Backup on NSX for vSphere",
    "name" : "Configure NSX Manager Backups",
    "description" : "Configure Backup on NSX for vSphere",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.plugin.spi.LcmPlugin",
      "messageKey" : "ConfigureBackupForNSX.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.plugin.spi.LcmPlugin",
      "messageKey" : "ConfigureBackupForNSX.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.554Z",
    "updateTimestamp" : "2019-08-28T08:38:37.554Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "GenerateLogInsightInput",
    "processingStateDescription" : "Generate vRealize Log Insight Input Data",
    "name" : "Generate vRealize Log Insight Input Data",
    "description" : "Generate vRealize Log Insight Input Data",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateLogInsightInput.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateLogInsightInput.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.557Z",
    "updateTimestamp" : "2019-08-28T08:38:37.557Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_LogInsightConfiguration_ConfigureLogInsightAgentPlugin_ConfigureSddcManagerInLogInsightAction_1",
    "processingStateDescription" : "Configure Syslog Settings for SDDC Manager",
    "name" : "Configure Syslog Settings for SDDC Manager",
    "description" : "Configure Syslog Settings for SDDC Manager",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.common.fsmplugins.loginsight.plugin.ConfigureLogInsightAgentPlugin",
      "messageKey" : "ConfigureSddcManagerInLogInsightAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.common.fsmplugins.loginsight.plugin.ConfigureLogInsightAgentPlugin",
      "messageKey" : "ConfigureSddcManagerInLogInsightAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.561Z",
    "updateTimestamp" : "2019-08-28T08:38:37.561Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_LogInsightConfiguration_ConfigureLogInsightAgentPlugin_ConfigureVCenterInLogInsightWithSyslogAction_2",
    "processingStateDescription" : "Configure Syslog Settings for vCenter Server",
    "name" : "Configure Syslog Settings for vCenter Server",
    "description" : "Configure Syslog Settings for vCenter Server",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.common.fsmplugins.loginsight.plugin.ConfigureLogInsightAgentPlugin",
      "messageKey" : "ConfigureVCenterInLogInsightWithSyslogAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.common.fsmplugins.loginsight.plugin.ConfigureLogInsightAgentPlugin",
      "messageKey" : "ConfigureVCenterInLogInsightWithSyslogAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.565Z",
    "updateTimestamp" : "2019-08-28T08:38:37.565Z"
  } ]
}
Related APIs

Retrieve a SDDC
Retrieve all SDDCs

2.1.4. Retry a SDDC creation

Used to retry a failed SDDC creation task/workflow.

Prerequisites
Note
 The username and password for Basic Authentication scheme using the Cloud Builder "admin" account.
The host in example requests is Cloud Builder address e.g. "sfo01cb01.sfo01.rainpole.local" not the SDDC Manager one.

  1. The following data is required

    • ID of the failed task

  2. The following data is optional

    • SDDC deployment details

Tip
 Refer to: SddcSpec.
Note
 If the SDDC creation details are provided retry of the SDDC creation is performed with the updated information.
Steps

  1. Invoke the API without providing SDDC creation details

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/sddcs/b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a' -i -u 'admin:VMwareInfra@1' -X PATCH \
    -H 'Accept: application/json'

HTTP Request

PATCH /v1/sddcs/b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a HTTP/1.1
Accept: application/json
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==

HTTP Response

HTTP/1.1 200 OK
Content-Length: 100905
Content-Type: application/json;charset=UTF-8

{
  "id" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
  "name" : "Bringup-Ems",
  "status" : "IN_PROGRESS",
  "creationTimestamp" : "2019-08-28T08:38:37.568Z",
  "sddcSubTasks" : [ {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "GenerateEsxiForVsanDedupInput",
    "processingStateDescription" : "Generate ESXi Host vSAN Deduplication Input Data",
    "name" : "Generate ESXi Host vSAN Deduplication Input Data",
    "description" : "Generate ESXi Host vSAN Deduplication Input Data",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateEsxiForVsanDedupInput.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateEsxiForVsanDedupInput.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.568Z",
    "updateTimestamp" : "2019-08-28T08:38:37.568Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "GenerateEsxiInput",
    "processingStateDescription" : "Generate ESXi Host Input Data",
    "name" : "Generate ESXi Host Input Data",
    "description" : "Generate ESXi Host Input Data",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateEsxiInput.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateEsxiInput.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.216Z",
    "updateTimestamp" : "2019-08-28T08:38:37.216Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_InitialEnvironmentSetup_VspherePlugin_PrepareEsxiForVsanDedupAction_2",
    "processingStateDescription" : "Prepare ESXi Hosts for vSAN with Deduplication",
    "name" : "Prepare ESXi Hosts for vSAN with Deduplication Action",
    "description" : "Prepare ESXi Hosts for vSAN with Deduplication",
    "localizableNamePack" : {
      "component" : "com.vmware.vcf.common.fsm.plugins.action.VspherePlugin",
      "messageKey" : "PrepareEsxiForVsanDedupAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.vcf.common.fsm.plugins.action.VspherePlugin",
      "messageKey" : "PrepareEsxiForVsanDedupAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.220Z",
    "updateTimestamp" : "2019-08-28T08:38:37.220Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_InitialEnvironmentSetup_VspherePlugin_EnableVsanDedupOnFirstHostAction_3",
    "processingStateDescription" : "Enable vSAN Deduplication for the First Host",
    "name" : "Enable vSAN Deduplication for the First Host Action",
    "description" : "Enable vSAN Deduplication for the First Host",
    "localizableNamePack" : {
      "component" : "com.vmware.vcf.common.fsm.plugins.action.VspherePlugin",
      "messageKey" : "EnableVsanDedupOnFirstHostAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.vcf.common.fsm.plugins.action.VspherePlugin",
      "messageKey" : "EnableVsanDedupOnFirstHostAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.224Z",
    "updateTimestamp" : "2019-08-28T08:38:37.224Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_InitialEnvironmentSetup_HostPlugin_CreateVmPortGroupAction_4",
    "processingStateDescription" : "Create 'VM Network' Portgroup on ESXi Hosts",
    "name" : "Create 'VM Network' Portgroup on ESXi Hosts",
    "description" : "Create 'VM Network' Portgroup on ESXi Hosts",
    "localizableNamePack" : {
      "component" : "com.vmware.vcf.common.fsm.plugins.action.HostPlugin",
      "messageKey" : "CreateVmPortGroupAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.vcf.common.fsm.plugins.action.HostPlugin",
      "messageKey" : "CreateVmPortGroupAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.227Z",
    "updateTimestamp" : "2019-08-28T08:38:37.227Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_InitialEnvironmentSetup_HostPlugin_ReconfigureHostDnsAction_5",
    "processingStateDescription" : "Configure ESXi Host DNS",
    "name" : "Configure ESXi Host DNS",
    "description" : "Configure ESXi Host DNS",
    "localizableNamePack" : {
      "component" : "com.vmware.vcf.common.fsm.plugins.action.HostPlugin",
      "messageKey" : "ReconfigureHostDnsAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.vcf.common.fsm.plugins.action.HostPlugin",
      "messageKey" : "ReconfigureHostDnsAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.231Z",
    "updateTimestamp" : "2019-08-28T08:38:37.231Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_InitialEnvironmentSetup_com.vmware.evo.sddc.bringup.plugin.spi.VspherePlugin_DetermineSoftwareVersionAction_6",
    "processingStateDescription" : "Determine Software Version on ESXi Hosts",
    "name" : "Determine Software Version on ESXi Hosts",
    "description" : "Determine Software Version on ESXi Hosts",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "DetermineSoftwareVersionAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "DetermineSoftwareVersionAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.234Z",
    "updateTimestamp" : "2019-08-28T08:38:37.234Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "PSCDeploymentInputGeneration",
    "processingStateDescription" : "Generate Platform Services Controller Deployment Input Data",
    "name" : "Generate Platform Services Controller Deployment Input Data",
    "description" : "Generate Platform Services Controller Deployment Input Data",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "PSCDeploymentInputGeneration.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "PSCDeploymentInputGeneration.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.238Z",
    "updateTimestamp" : "2019-08-28T08:38:37.238Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_PSCDeployment_PscPlugin_DeployPsc1Action_1",
    "processingStateDescription" : "Deploy Platform Service Controller",
    "name" : "Deploy Platform Service Controller",
    "description" : "Deploy Platform Service Controller",
    "localizableNamePack" : {
      "component" : "com.vmware.vcf.common.fsm.plugins.action.plugins.PscPlugin",
      "messageKey" : "DeployPsc1Action.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.vcf.common.fsm.plugins.action.plugins.PscPlugin",
      "messageKey" : "DeployPsc1Action.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.243Z",
    "updateTimestamp" : "2019-08-28T08:38:37.243Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_PSCDeployment_PscPlugin_CreateUserGroupsAction_2",
    "processingStateDescription" : "Create Admin User Groups in vsphere.local Domain",
    "name" : "Create Admin User Groups in vsphere.local Domain",
    "description" : "Create Admin User Groups in vsphere.local Domain",
    "localizableNamePack" : {
      "component" : "com.vmware.vcf.common.fsm.plugins.action.plugins.PscPlugin",
      "messageKey" : "CreateUserGroupsAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.vcf.common.fsm.plugins.action.plugins.PscPlugin",
      "messageKey" : "CreateUserGroupsAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.248Z",
    "updateTimestamp" : "2019-08-28T08:38:37.248Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_GenerateLicenseRenameInput_ProxyContractPlugin_ProxyContractAction_0",
    "processingStateDescription" : "Automation Helper Action",
    "name" : "ProxyContractAction",
    "description" : "Automation Helper Action",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.orchestrator.core.recipes.spel.ProxyContractPlugin",
      "messageKey" : "ProxyContractAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.orchestrator.core.recipes.spel.ProxyContractPlugin",
      "messageKey" : "ProxyContractAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.253Z",
    "updateTimestamp" : "2019-08-28T08:38:37.253Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "GenerateLicenseRenameInput",
    "processingStateDescription" : "Generate license rename input",
    "name" : "Generate vCenter License Rename Input Data",
    "description" : "Generate license rename input",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.input.generation.recipes.GenerateLicenseRenameInput",
      "messageKey" : "GenerateLicenseRenameInput.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.input.generation.recipes.GenerateLicenseRenameInput",
      "messageKey" : "GenerateLicenseRenameInput.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.258Z",
    "updateTimestamp" : "2019-08-28T08:38:37.258Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "GenerateVcDeploymentInput",
    "processingStateDescription" : "Generate Vc Deployment Input",
    "name" : "Generate vCenter Server Deployment Input Data",
    "description" : "Generate Vc Deployment Input",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateVcDeploymentInput.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateVcDeploymentInput.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.264Z",
    "updateTimestamp" : "2019-08-28T08:38:37.264Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_VCDeployment_VcPlugin_DeployVcAction_3",
    "processingStateDescription" : "Deploy vCenter Server",
    "name" : "Deploy vCenter Server",
    "description" : "Deploy vCenter Server",
    "localizableNamePack" : {
      "component" : "com.vmware.vcf.common.fsm.plugins.action.plugins.VcPlugin",
      "messageKey" : "DeployVcAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.vcf.common.fsm.plugins.action.plugins.VcPlugin",
      "messageKey" : "DeployVcAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.269Z",
    "updateTimestamp" : "2019-08-28T08:38:37.269Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_VCDeployment_VcPlugin_ApplyVcLicenseAction_4",
    "processingStateDescription" : "Apply vCenter Server, vSphere, and vSAN Licenses",
    "name" : "Apply vCenter Server, vSphere, and vSAN Licenses",
    "description" : "Apply vCenter Server, vSphere, and vSAN Licenses",
    "localizableNamePack" : {
      "component" : "workflowconfig.ems_recipes.VCDeployment",
      "messageKey" : "ApplyVcLicenseAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "workflowconfig.ems_recipes.VCDeployment",
      "messageKey" : "ApplyVcLicenseAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.272Z",
    "updateTimestamp" : "2019-08-28T08:38:37.272Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_VCDeployment_LicensePlugin_RenameLicense_5",
    "processingStateDescription" : "Rename the Applied vCenter License in vCenter Server",
    "name" : "Rename the Applied vCenter License in vCenter Server",
    "description" : "Rename the Applied vCenter License in vCenter Server",
    "localizableNamePack" : {
      "component" : "workflowconfig.ems_recipes.VCDeployment",
      "messageKey" : "RenameLicense.name"
    },
    "localizableDescriptionPack" : {
      "component" : "workflowconfig.ems_recipes.VCDeployment",
      "messageKey" : "RenameLicense.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.276Z",
    "updateTimestamp" : "2019-08-28T08:38:37.276Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ManagementClusterConfiguration",
    "processingStateDescription" : "Create Vsphere Cluster",
    "name" : "Create vSphere Cluster",
    "description" : "Create Vsphere Cluster",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "CreateCluster.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "CreateCluster.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.281Z",
    "updateTimestamp" : "2019-08-28T08:38:37.281Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ManagementClusterConfiguration",
    "processingStateDescription" : "Create Vsphere Cluster",
    "name" : "Enable vSphere DRS",
    "description" : "Create Vsphere Cluster",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "EnableClusterDrs.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "EnableClusterDrs.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.281Z",
    "updateTimestamp" : "2019-08-28T08:38:37.281Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ManagementClusterConfiguration",
    "processingStateDescription" : "Create Vsphere Cluster",
    "name" : "Apply vSAN Dormant License File (DLF)",
    "description" : "Create Vsphere Cluster",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "ApplyVsanDlf.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "ApplyVsanDlf.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.281Z",
    "updateTimestamp" : "2019-08-28T08:38:37.281Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ManagementClusterConfiguration",
    "processingStateDescription" : "Create Vsphere Cluster",
    "name" : "Apply vSAN License",
    "description" : "Create Vsphere Cluster",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "ApplyVsanLicense.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "ApplyVsanLicense.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.281Z",
    "updateTimestamp" : "2019-08-28T08:38:37.281Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ManagementClusterConfiguration",
    "processingStateDescription" : "Create Vsphere Cluster",
    "name" : "Generate vSAN License Rename Input Data",
    "description" : "Create Vsphere Cluster",
    "localizableNamePack" : {
      "component" : "workflowconfig.ems_recipes.ManagementClusterConfiguration",
      "messageKey" : "GenerateVSANLicenseRenameInputId.name"
    },
    "localizableDescriptionPack" : {
      "component" : "workflowconfig.ems_recipes.ManagementClusterConfiguration",
      "messageKey" : "GenerateVSANLicenseRenameInputId.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.281Z",
    "updateTimestamp" : "2019-08-28T08:38:37.281Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ManagementClusterConfiguration",
    "processingStateDescription" : "Create Vsphere Cluster",
    "name" : "Rename the Applied VSAN License in vCenter Server",
    "description" : "Create Vsphere Cluster",
    "localizableNamePack" : {
      "component" : "workflowconfig.ems_recipes.ManagementClusterConfiguration",
      "messageKey" : "RenameVSANLicenseId.name"
    },
    "localizableDescriptionPack" : {
      "component" : "workflowconfig.ems_recipes.ManagementClusterConfiguration",
      "messageKey" : "RenameVSANLicenseId.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.281Z",
    "updateTimestamp" : "2019-08-28T08:38:37.281Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ManagementClusterConfiguration",
    "processingStateDescription" : "Create Vsphere Cluster",
    "name" : "Assign Administrator Privileges to SDDCAdmins Group",
    "description" : "Create Vsphere Cluster",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "AuthorizeSddcAdminGroup.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "AuthorizeSddcAdminGroup.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.281Z",
    "updateTimestamp" : "2019-08-28T08:38:37.281Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ManagementClusterConfiguration",
    "processingStateDescription" : "Create Vsphere Cluster",
    "name" : "Create vSphere Distributed Switch",
    "description" : "Create Vsphere Cluster",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "CreateDvs.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "CreateDvs.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.281Z",
    "updateTimestamp" : "2019-08-28T08:38:37.281Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ManagementClusterConfiguration",
    "processingStateDescription" : "Create Vsphere Cluster",
    "name" : "Add ESXi Host to vSphere Cluster",
    "description" : "Create Vsphere Cluster",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "AddHostToCluster.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "AddHostToCluster.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.281Z",
    "updateTimestamp" : "2019-08-28T08:38:37.281Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ManagementClusterConfiguration",
    "processingStateDescription" : "Create Vsphere Cluster",
    "name" : "Enable/Disable EVC Mode on vSphere Cluster",
    "description" : "Create Vsphere Cluster",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "EnableEvc.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "EnableEvc.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.281Z",
    "updateTimestamp" : "2019-08-28T08:38:37.281Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ManagementClusterConfiguration",
    "processingStateDescription" : "Create Vsphere Cluster",
    "name" : "Add ESXi Hosts to vSphere Distributed Switch",
    "description" : "Create Vsphere Cluster",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "AddHostToDvswitch.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "AddHostToDvswitch.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.281Z",
    "updateTimestamp" : "2019-08-28T08:38:37.281Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ManagementClusterConfiguration",
    "processingStateDescription" : "Create Vsphere Cluster",
    "name" : "Create VM Folders",
    "description" : "Create Vsphere Cluster",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "CreateVmFolders.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "CreateVmFolders.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.281Z",
    "updateTimestamp" : "2019-08-28T08:38:37.281Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ManagementClusterConfiguration",
    "processingStateDescription" : "Create Vsphere Cluster",
    "name" : "Create Network Folders",
    "description" : "Create Vsphere Cluster",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "CreateNetworkFolders.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "CreateNetworkFolders.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.281Z",
    "updateTimestamp" : "2019-08-28T08:38:37.281Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ManagementClusterConfiguration",
    "processingStateDescription" : "Create Vsphere Cluster",
    "name" : "Create vMotion vmknics",
    "description" : "Create Vsphere Cluster",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "CreateVmotionVmknics.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "CreateVmotionVmknics.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.281Z",
    "updateTimestamp" : "2019-08-28T08:38:37.281Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ManagementClusterConfiguration",
    "processingStateDescription" : "Create Vsphere Cluster",
    "name" : "Create vSAN vmknics",
    "description" : "Create Vsphere Cluster",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "CreateVsanVmknics.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "CreateVsanVmknics.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.281Z",
    "updateTimestamp" : "2019-08-28T08:38:37.281Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ManagementClusterConfiguration",
    "processingStateDescription" : "Create Vsphere Cluster",
    "name" : "Configure VLANs on vSphere Distributed Switch Portgroups",
    "description" : "Create Vsphere Cluster",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "TagVlanIdsOnPortgroups.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "TagVlanIdsOnPortgroups.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.281Z",
    "updateTimestamp" : "2019-08-28T08:38:37.281Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ManagementClusterConfiguration",
    "processingStateDescription" : "Create Vsphere Cluster",
    "name" : "Migrate VMs to vSphere Distributed Switch",
    "description" : "Create Vsphere Cluster",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "MigrateVmsToPortgroups.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "MigrateVmsToPortgroups.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.281Z",
    "updateTimestamp" : "2019-08-28T08:38:37.281Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ManagementClusterConfiguration",
    "processingStateDescription" : "Create Vsphere Cluster",
    "name" : "Migrate ESXi Host vmknics to vSphere Distributed Switch",
    "description" : "Create Vsphere Cluster",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "MigrateHostVmknicsToPortgroups.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "MigrateHostVmknicsToPortgroups.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.281Z",
    "updateTimestamp" : "2019-08-28T08:38:37.281Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ManagementClusterConfiguration",
    "processingStateDescription" : "Create Vsphere Cluster",
    "name" : "Detach ESXi Host vmnics from vSphere Standard Switch",
    "description" : "Create Vsphere Cluster",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "DetachVmnicFromVswitch.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "DetachVmnicFromVswitch.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.281Z",
    "updateTimestamp" : "2019-08-28T08:38:37.281Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ManagementClusterConfiguration",
    "processingStateDescription" : "Create Vsphere Cluster",
    "name" : "Attach ESXi Host vmnics to vSphere Distributed Switch",
    "description" : "Create Vsphere Cluster",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "AttachVmnicToDvs.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "AttachVmnicToDvs.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.281Z",
    "updateTimestamp" : "2019-08-28T08:38:37.281Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ManagementClusterConfiguration",
    "processingStateDescription" : "Create Vsphere Cluster",
    "name" : "Remove vSphere Standard Switch",
    "description" : "Create Vsphere Cluster",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "RemoveVswitch.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "RemoveVswitch.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.281Z",
    "updateTimestamp" : "2019-08-28T08:38:37.281Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ManagementClusterConfiguration",
    "processingStateDescription" : "Create Vsphere Cluster",
    "name" : "Update vSAN Hardware Compatability List (HCL) Database",
    "description" : "Create Vsphere Cluster",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "UpdateVsanHcl.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "UpdateVsanHcl.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.281Z",
    "updateTimestamp" : "2019-08-28T08:38:37.281Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ManagementClusterConfiguration",
    "processingStateDescription" : "Create Vsphere Cluster",
    "name" : "Enable vSAN",
    "description" : "Create Vsphere Cluster",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "EnableVsan.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "EnableVsan.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.281Z",
    "updateTimestamp" : "2019-08-28T08:38:37.281Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ManagementClusterConfiguration",
    "processingStateDescription" : "Create Vsphere Cluster",
    "name" : "Enable vSAN Deduplication on Cluster",
    "description" : "Create Vsphere Cluster",
    "localizableNamePack" : {
      "component" : "com.vmware.vcf.common.fsm.plugins.action.VspherePlugin",
      "messageKey" : "EnableVsanDedupOnClusterAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.vcf.common.fsm.plugins.action.VspherePlugin",
      "messageKey" : "EnableVsanDedupOnClusterAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.281Z",
    "updateTimestamp" : "2019-08-28T08:38:37.281Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ManagementClusterConfiguration",
    "processingStateDescription" : "Create Vsphere Cluster",
    "name" : "Enable vSAN Storage Policies",
    "description" : "Create Vsphere Cluster",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "EnableVsanPolicies.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "EnableVsanPolicies.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.281Z",
    "updateTimestamp" : "2019-08-28T08:38:37.281Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ManagementClusterConfiguration",
    "processingStateDescription" : "Create Vsphere Cluster",
    "name" : "Create vSAN Disk Groups",
    "description" : "Create Vsphere Cluster",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "VsanClaimDisks.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "VsanClaimDisks.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.281Z",
    "updateTimestamp" : "2019-08-28T08:38:37.281Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ManagementClusterConfiguration",
    "processingStateDescription" : "Create Vsphere Cluster",
    "name" : "Create Resource Pools in vCenter Server",
    "description" : "Create Vsphere Cluster",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "CreateResourcePool.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "CreateResourcePool.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.281Z",
    "updateTimestamp" : "2019-08-28T08:38:37.281Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ApplyEsxLicense",
    "processingStateDescription" : "Apply ESXi Host License Key",
    "name" : "Apply ESXi Host License Key",
    "description" : "Apply ESXi Host License Key",
    "localizableNamePack" : {
      "component" : "workflowconfig.ems_recipes.ApplyEsxLicense",
      "messageKey" : "ApplyEsxiLicenseInVcAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "workflowconfig.ems_recipes.ApplyEsxLicense",
      "messageKey" : "ApplyEsxiLicenseInVcAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.321Z",
    "updateTimestamp" : "2019-08-28T08:38:37.321Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ApplyEsxLicense",
    "processingStateDescription" : "Apply ESXi Host License Key",
    "name" : "Generate ESXi License Rename Input Data",
    "description" : "Apply ESXi Host License Key",
    "localizableNamePack" : {
      "component" : "workflowconfig.ems_recipes.ApplyEsxLicense",
      "messageKey" : "GenerateLicenseRenameInput.name"
    },
    "localizableDescriptionPack" : {
      "component" : "workflowconfig.ems_recipes.ApplyEsxLicense",
      "messageKey" : "GenerateLicenseRenameInput.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.321Z",
    "updateTimestamp" : "2019-08-28T08:38:37.321Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ApplyEsxLicense",
    "processingStateDescription" : "Apply ESXi Host License Key",
    "name" : "Rename the Applied ESXi License in vCenter Server",
    "description" : "Apply ESXi Host License Key",
    "localizableNamePack" : {
      "component" : "workflowconfig.ems_recipes.ApplyEsxLicense",
      "messageKey" : "RenameLicense.name"
    },
    "localizableDescriptionPack" : {
      "component" : "workflowconfig.ems_recipes.ApplyEsxLicense",
      "messageKey" : "RenameLicense.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.321Z",
    "updateTimestamp" : "2019-08-28T08:38:37.321Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "NSXvConfiguration",
    "processingStateDescription" : "Deploy and Configure NSX for vSphere",
    "name" : "Deploy NSX Manager",
    "description" : "Deploy and Configure NSX for vSphere",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
      "messageKey" : "DeployNsxManager.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
      "messageKey" : "DeployNsxManager.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.328Z",
    "updateTimestamp" : "2019-08-28T08:38:37.328Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "NSXvConfiguration",
    "processingStateDescription" : "Deploy and Configure NSX for vSphere",
    "name" : "Generate and Install VMCA Certificate on NSX Manager",
    "description" : "Deploy and Configure NSX for vSphere",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
      "messageKey" : "UploadNsxManagerVmcaCert.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
      "messageKey" : "UploadNsxManagerVmcaCert.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.328Z",
    "updateTimestamp" : "2019-08-28T08:38:37.328Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "NSXvConfiguration",
    "processingStateDescription" : "Deploy and Configure NSX for vSphere",
    "name" : "Update NSX Manager TLS Settings",
    "description" : "Deploy and Configure NSX for vSphere",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
      "messageKey" : "UpdateNsxManagerTLSSettings.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
      "messageKey" : "UpdateNsxManagerTLSSettings.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.328Z",
    "updateTimestamp" : "2019-08-28T08:38:37.328Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "NSXvConfiguration",
    "processingStateDescription" : "Deploy and Configure NSX for vSphere",
    "name" : "Register NSX Manager with vCenter Server",
    "description" : "Deploy and Configure NSX for vSphere",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.action64.NsxServicePluginActionPlugin64",
      "messageKey" : "RegisterVcNsx.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.action64.NsxServicePluginActionPlugin64",
      "messageKey" : "RegisterVcNsx.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.328Z",
    "updateTimestamp" : "2019-08-28T08:38:37.328Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "NSXvConfiguration",
    "processingStateDescription" : "Deploy and Configure NSX for vSphere",
    "name" : "Apply NSX Dormant License File (DLF)",
    "description" : "Deploy and Configure NSX for vSphere",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
      "messageKey" : "UploadNsxDlf.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
      "messageKey" : "UploadNsxDlf.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.328Z",
    "updateTimestamp" : "2019-08-28T08:38:37.328Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "NSXvConfiguration",
    "processingStateDescription" : "Deploy and Configure NSX for vSphere",
    "name" : "Apply NSX License",
    "description" : "Deploy and Configure NSX for vSphere",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
      "messageKey" : "ApplyNsxLicense.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
      "messageKey" : "ApplyNsxLicense.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.328Z",
    "updateTimestamp" : "2019-08-28T08:38:37.328Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "NSXvConfiguration",
    "processingStateDescription" : "Deploy and Configure NSX for vSphere",
    "name" : "Generate NSX License Rename Input Data",
    "description" : "Deploy and Configure NSX for vSphere",
    "localizableNamePack" : {
      "component" : "workflowconfig.ems_recipes.NSXvConfiguration",
      "messageKey" : "GenerateLicenseRenameInputId.name"
    },
    "localizableDescriptionPack" : {
      "component" : "workflowconfig.ems_recipes.NSXvConfiguration",
      "messageKey" : "GenerateLicenseRenameInputId.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.328Z",
    "updateTimestamp" : "2019-08-28T08:38:37.328Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "NSXvConfiguration",
    "processingStateDescription" : "Deploy and Configure NSX for vSphere",
    "name" : "Rename the Applied NSX License in vCenter Server",
    "description" : "Deploy and Configure NSX for vSphere",
    "localizableNamePack" : {
      "component" : "workflowconfig.ems_recipes.NSXvConfiguration",
      "messageKey" : "RenameLicenseId.name"
    },
    "localizableDescriptionPack" : {
      "component" : "workflowconfig.ems_recipes.NSXvConfiguration",
      "messageKey" : "RenameLicenseId.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.328Z",
    "updateTimestamp" : "2019-08-28T08:38:37.328Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "NSXvConfiguration",
    "processingStateDescription" : "Deploy and Configure NSX for vSphere",
    "name" : "Generate NSX Manager Input Data",
    "description" : "Deploy and Configure NSX for vSphere",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.vvd.plugin.VvdPlugin",
      "messageKey" : "GenerateNsxInput.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.vvd.plugin.VvdPlugin",
      "messageKey" : "GenerateNsxInput.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.328Z",
    "updateTimestamp" : "2019-08-28T08:38:37.328Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "NSXvConfiguration",
    "processingStateDescription" : "Deploy and Configure NSX for vSphere",
    "name" : "Configure DNS on the NSX Controller Cluster",
    "description" : "Deploy and Configure NSX for vSphere",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.common.nsx.NsxManagerPlugin",
      "messageKey" : "ConfigureControllerDns.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.common.nsx.NsxManagerPlugin",
      "messageKey" : "ConfigureControllerDns.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.328Z",
    "updateTimestamp" : "2019-08-28T08:38:37.328Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "NSXvConfiguration",
    "processingStateDescription" : "Deploy and Configure NSX for vSphere",
    "name" : "Configure NTP on the NSX Controller Cluster",
    "description" : "Deploy and Configure NSX for vSphere",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.common.nsx.NsxManagerPlugin",
      "messageKey" : "ConfigureControllerNtp.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.common.nsx.NsxManagerPlugin",
      "messageKey" : "ConfigureControllerNtp.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.328Z",
    "updateTimestamp" : "2019-08-28T08:38:37.328Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "NSXvConfiguration",
    "processingStateDescription" : "Deploy and Configure NSX for vSphere",
    "name" : "Create NSX Controller Cluster",
    "description" : "Deploy and Configure NSX for vSphere",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
      "messageKey" : "DeployNsxController.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
      "messageKey" : "DeployNsxController.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.328Z",
    "updateTimestamp" : "2019-08-28T08:38:37.328Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "NSXvConfiguration",
    "processingStateDescription" : "Deploy and Configure NSX for vSphere",
    "name" : "Configure VXLAN Transport",
    "description" : "Deploy and Configure NSX for vSphere",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
      "messageKey" : "CreateVxlan.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
      "messageKey" : "CreateVxlan.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.328Z",
    "updateTimestamp" : "2019-08-28T08:38:37.328Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "NSXvConfiguration",
    "processingStateDescription" : "Deploy and Configure NSX for vSphere",
    "name" : "Resolve NSX Cluster Issues",
    "description" : "Deploy and Configure NSX for vSphere",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
      "messageKey" : "ResolveNsxClusterIssues.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
      "messageKey" : "ResolveNsxClusterIssues.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.328Z",
    "updateTimestamp" : "2019-08-28T08:38:37.328Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "NSXvConfiguration",
    "processingStateDescription" : "Deploy and Configure NSX for vSphere",
    "name" : "Set Universal Sync Role on NSX Manager",
    "description" : "Deploy and Configure NSX for vSphere",
    "localizableNamePack" : {
      "component" : "com.vmware.vcf.common.fsm.plugins.action.nsx.NsxPlugin",
      "messageKey" : "SetNsxRoleAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.vcf.common.fsm.plugins.action.nsx.NsxPlugin",
      "messageKey" : "SetNsxRoleAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.328Z",
    "updateTimestamp" : "2019-08-28T08:38:37.328Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "NSXvConfiguration",
    "processingStateDescription" : "Deploy and Configure NSX for vSphere",
    "name" : "Create NSX Segment Range",
    "description" : "Deploy and Configure NSX for vSphere",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
      "messageKey" : "CreateNsxSegmentRange.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
      "messageKey" : "CreateNsxSegmentRange.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.328Z",
    "updateTimestamp" : "2019-08-28T08:38:37.328Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "NSXvConfiguration",
    "processingStateDescription" : "Deploy and Configure NSX for vSphere",
    "name" : "Create NSX Multicast Range",
    "description" : "Deploy and Configure NSX for vSphere",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.plugin.ConfigureNsxPlugin",
      "messageKey" : "CreateMulticastRange.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.plugin.ConfigureNsxPlugin",
      "messageKey" : "CreateMulticastRange.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.328Z",
    "updateTimestamp" : "2019-08-28T08:38:37.328Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "NSXvConfiguration",
    "processingStateDescription" : "Deploy and Configure NSX for vSphere",
    "name" : "Create NSX Transport Zone",
    "description" : "Deploy and Configure NSX for vSphere",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
      "messageKey" : "CreateNsxTransportZone.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
      "messageKey" : "CreateNsxTransportZone.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.328Z",
    "updateTimestamp" : "2019-08-28T08:38:37.328Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "NSXvConfiguration",
    "processingStateDescription" : "Deploy and Configure NSX for vSphere",
    "name" : "Configure SSO on NSX Manager",
    "description" : "Deploy and Configure NSX for vSphere",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
      "messageKey" : "ConfigureSsoOnNSX.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
      "messageKey" : "ConfigureSsoOnNSX.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.328Z",
    "updateTimestamp" : "2019-08-28T08:38:37.328Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "GenerateLogInsightInput",
    "processingStateDescription" : "Generate vRealize Log Insight Input Data",
    "name" : "Generate vRealize Log Insight Input Data",
    "description" : "Generate vRealize Log Insight Input Data",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateLogInsightInput.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateLogInsightInput.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.359Z",
    "updateTimestamp" : "2019-08-28T08:38:37.359Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_LogInsightDeployment_DeployLogInsightPlugin_DeployLogInsightAction_1",
    "processingStateDescription" : "Deploy vRealize Log Insight",
    "name" : "Deploy vRealize Log Insight",
    "description" : "Deploy vRealize Log Insight",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.common.fsmplugins.loginsight.plugin.DeployLogInsightPlugin",
      "messageKey" : "DeployLogInsightAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.common.fsmplugins.loginsight.plugin.DeployLogInsightPlugin",
      "messageKey" : "DeployLogInsightAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.364Z",
    "updateTimestamp" : "2019-08-28T08:38:37.364Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_LogInsightDeployment_ConfigureLogInsightPlugin_AddLogInsightLicenseAction_2",
    "processingStateDescription" : "Apply vRealize Log Insight License",
    "name" : "Apply vRealize Log Insight License Action",
    "description" : "Apply vRealize Log Insight License",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.common.fsmplugins.loginsight.plugin.ConfigureLogInsightPlugin",
      "messageKey" : "AddLogInsightLicenseAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.common.fsmplugins.loginsight.plugin.ConfigureLogInsightPlugin",
      "messageKey" : "AddLogInsightLicenseAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.368Z",
    "updateTimestamp" : "2019-08-28T08:38:37.368Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_LogInsightDeployment_ConfigureLogInsightPlugin_BootstrapLogInsightClusterAction_3",
    "processingStateDescription" : "Bootstrap vRealize Log Insight Cluster",
    "name" : "Bootstrap vRealize Log Insight Cluster Action",
    "description" : "Bootstrap vRealize Log Insight Cluster",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.common.fsmplugins.loginsight.plugin.ConfigureLogInsightPlugin",
      "messageKey" : "BootstrapLogInsightClusterAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.common.fsmplugins.loginsight.plugin.ConfigureLogInsightPlugin",
      "messageKey" : "BootstrapLogInsightClusterAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.372Z",
    "updateTimestamp" : "2019-08-28T08:38:37.372Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_LogInsightDeployment_ConfigureLogInsightPlugin_GenerateLogInsightCertificateAction_4",
    "processingStateDescription" : "Generate and Install VMCA Certificate for vRealize Log Insight",
    "name" : "Generate and Install VMCA Certificate for vRealize Log Insight",
    "description" : "Generate and Install VMCA Certificate for vRealize Log Insight",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.common.fsmplugins.loginsight.plugin.ConfigureLogInsightPlugin",
      "messageKey" : "GenerateLogInsightCertificateAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.common.fsmplugins.loginsight.plugin.ConfigureLogInsightPlugin",
      "messageKey" : "GenerateLogInsightCertificateAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.377Z",
    "updateTimestamp" : "2019-08-28T08:38:37.377Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_LogInsightDeployment_ConfigureLogInsightPlugin_DisableTlsOnLogInsightAction_5",
    "processingStateDescription" : "Disable TLS 1.0 on vRealize Log Insight Nodes",
    "name" : "Disable TLS 1.0 on vRealize Log Insight Nodes Action",
    "description" : "Disable TLS 1.0 on vRealize Log Insight Nodes",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.common.fsmplugins.loginsight.plugin.ConfigureLogInsightPlugin",
      "messageKey" : "DisableTlsOnLogInsightAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.common.fsmplugins.loginsight.plugin.ConfigureLogInsightPlugin",
      "messageKey" : "DisableTlsOnLogInsightAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.381Z",
    "updateTimestamp" : "2019-08-28T08:38:37.381Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_LogInsightDeployment_ConfigureLogInsightPlugin_InstallContentPacksInLogInsightAction_6",
    "processingStateDescription" : "Install vRealize Log Insight Content Packs",
    "name" : "Install vRealize Log Insight Content Packs Action",
    "description" : "Install vRealize Log Insight Content Packs",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.common.fsmplugins.loginsight.plugin.ConfigureLogInsightPlugin",
      "messageKey" : "InstallContentPacksInLogInsightAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.common.fsmplugins.loginsight.plugin.ConfigureLogInsightPlugin",
      "messageKey" : "InstallContentPacksInLogInsightAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.385Z",
    "updateTimestamp" : "2019-08-28T08:38:37.385Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "GenerateNsxvLogInsightIntegrationInput",
    "processingStateDescription" : "Generate NsxvLogInsightIntegration input",
    "name" : "Generate NSX for vSphere Integration with vRealize Log Insight Input Data",
    "description" : "Generate NsxvLogInsightIntegration input",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateNsxvLogInsightIntegrationInput.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateNsxvLogInsightIntegrationInput.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.389Z",
    "updateTimestamp" : "2019-08-28T08:38:37.389Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_NsxvLogInsightIntegration_ConfigureSyslogInNsxPlugin_ConfigureSyslogInNsxManagerAction_1",
    "processingStateDescription" : "Configure Syslog Settings for NSX Manager",
    "name" : "Configure Syslog Settings for NSX Manager",
    "description" : "Configure Syslog Settings for NSX Manager",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.common.fsmplugins.loginsight.plugin.ConfigureSyslogInNsxPlugin",
      "messageKey" : "ConfigureSyslogInNsxManagerAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.common.fsmplugins.loginsight.plugin.ConfigureSyslogInNsxPlugin",
      "messageKey" : "ConfigureSyslogInNsxManagerAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.392Z",
    "updateTimestamp" : "2019-08-28T08:38:37.392Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_NsxvLogInsightIntegration_ConfigureSyslogInNsxPlugin_ConfigureSyslogInNsxControllerAction_2",
    "processingStateDescription" : "Configure Syslog Settings for NSX Controllers",
    "name" : "Configure Syslog Settings for NSX Controllers",
    "description" : "Configure Syslog Settings for NSX Controllers",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.common.fsmplugins.loginsight.plugin.ConfigureSyslogInNsxPlugin",
      "messageKey" : "ConfigureSyslogInNsxControllerAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.common.fsmplugins.loginsight.plugin.ConfigureSyslogInNsxPlugin",
      "messageKey" : "ConfigureSyslogInNsxControllerAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.396Z",
    "updateTimestamp" : "2019-08-28T08:38:37.396Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "GenerateSddcManagerInput",
    "processingStateDescription" : "Generate SDDC Manager Input Data",
    "name" : "Generate SDDC Manager Input Data",
    "description" : "Generate SDDC Manager Input Data",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateSddcManagerInput.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateSddcManagerInput.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.399Z",
    "updateTimestamp" : "2019-08-28T08:38:37.399Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_SDDCManagerConfiguration_SddcManagerContractPlugin_DeploySddcManagerOnClusterAction_1",
    "processingStateDescription" : "Deploy SDDC Manager",
    "name" : "Deploy SDDC Manager",
    "description" : "Deploy SDDC Manager",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.sddcmanager.SddcManagerContractPlugin",
      "messageKey" : "DeploySddcManagerOnClusterAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.sddcmanager.SddcManagerContractPlugin",
      "messageKey" : "DeploySddcManagerOnClusterAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.405Z",
    "updateTimestamp" : "2019-08-28T08:38:37.405Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_SDDCManagerConfiguration_SddcManagerContractPlugin_ConfigureLCMRepoOnSddcManagerAction_2",
    "processingStateDescription" : "Configure Lifecycle Management Repository on SDDC Manager",
    "name" : "Configure Lifecycle Management Repository on SDDC Manager",
    "description" : "Configure Lifecycle Management Repository on SDDC Manager",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.sddcmanager.SddcManagerContractPlugin",
      "messageKey" : "ConfigureLCMRepoOnSddcManagerAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.sddcmanager.SddcManagerContractPlugin",
      "messageKey" : "ConfigureLCMRepoOnSddcManagerAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.410Z",
    "updateTimestamp" : "2019-08-28T08:38:37.410Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_SDDCManagerConfiguration_HostPlugin_CreateNFSDatastoreOnHostsAction_3",
    "processingStateDescription" : "Mount Repository NFS Datastore on ESXi Hosts",
    "name" : "Mount Repository NFS Datastore on ESXi Hosts",
    "description" : "Mount Repository NFS Datastore on ESXi Hosts",
    "localizableNamePack" : {
      "component" : "com.vmware.vcf.common.fsm.plugins.action.HostPlugin",
      "messageKey" : "CreateNFSDatastoreOnHostsAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.vcf.common.fsm.plugins.action.HostPlugin",
      "messageKey" : "CreateNFSDatastoreOnHostsAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.414Z",
    "updateTimestamp" : "2019-08-28T08:38:37.414Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_SDDCManagerConfiguration_SddcManagerContractPlugin_ConfigureBaseImageRepoAction_4",
    "processingStateDescription" : "Configure Base Install Image Repository on SDDC Manager",
    "name" : "Configure Base Install Image Repository on SDDC Manager",
    "description" : "Configure Base Install Image Repository on SDDC Manager",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.sddcmanager.SddcManagerContractPlugin",
      "messageKey" : "ConfigureBaseImageRepoAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.sddcmanager.SddcManagerContractPlugin",
      "messageKey" : "ConfigureBaseImageRepoAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.417Z",
    "updateTimestamp" : "2019-08-28T08:38:37.417Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_SDDCManagerConfiguration_SddcManagerContractPlugin_InstallVmcaRootCertOnSddcManagerAction_5",
    "processingStateDescription" : "Install VMCA Root Certificate on SDDC Manager",
    "name" : "Install VMCA Root Certificate on SDDC Manager",
    "description" : "Install VMCA Root Certificate on SDDC Manager",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.sddcmanager.SddcManagerContractPlugin",
      "messageKey" : "InstallVmcaRootCertOnSddcManagerAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.sddcmanager.SddcManagerContractPlugin",
      "messageKey" : "InstallVmcaRootCertOnSddcManagerAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.421Z",
    "updateTimestamp" : "2019-08-28T08:38:37.421Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_SDDCManagerConfiguration_SddcManagerContractPlugin_InstallSddcManagerVmcaCertificateAction_6",
    "processingStateDescription" : "Generate and Install VMCA Certificate on SDDC Manager",
    "name" : "Generate and Install VMCA Certificate on SDDC Manager",
    "description" : "Generate and Install VMCA Certificate on SDDC Manager",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.sddcmanager.SddcManagerContractPlugin",
      "messageKey" : "InstallSddcManagerVmcaCertificateAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.sddcmanager.SddcManagerContractPlugin",
      "messageKey" : "InstallSddcManagerVmcaCertificateAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.425Z",
    "updateTimestamp" : "2019-08-28T08:38:37.425Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "GenerateInventoryForSddcManagerConfiguration",
    "processingStateDescription" : "Generate Inventory Data For SDDC Manager Configuration",
    "name" : "Generate Inventory data For SDDC Manager Configuration",
    "description" : "Generate Inventory Data For SDDC Manager Configuration",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateInventoryForSddcManagerConfiguration.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateInventoryForSddcManagerConfiguration.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.429Z",
    "updateTimestamp" : "2019-08-28T08:38:37.429Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_SDDCManagerPostInventory_SddcManagerContractPlugin_PostInventoryAndCredentialsAction_1",
    "processingStateDescription" : "Update SDDC Manager Inventory with Credential Details",
    "name" : "Update SDDC Manager Inventory with Credential Details",
    "description" : "Update SDDC Manager Inventory with Credential Details",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.sddcmanager.SddcManagerContractPlugin",
      "messageKey" : "PostInventoryAndCredentialsAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.sddcmanager.SddcManagerContractPlugin",
      "messageKey" : "PostInventoryAndCredentialsAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.433Z",
    "updateTimestamp" : "2019-08-28T08:38:37.433Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_SDDCManagerPostInventory_SddcManagerContractPlugin_PostNetworkPoolInventoryAction_2",
    "processingStateDescription" : "Update SDDC Manager Inventory with Network Pool Details",
    "name" : "Update SDDC Manager Inventory with Network Pool Details",
    "description" : "Update SDDC Manager Inventory with Network Pool Details",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.sddcmanager.SddcManagerContractPlugin",
      "messageKey" : "PostNetworkPoolInventoryAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.sddcmanager.SddcManagerContractPlugin",
      "messageKey" : "PostNetworkPoolInventoryAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.437Z",
    "updateTimestamp" : "2019-08-28T08:38:37.437Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_SDDCManagerPostInventory_SddcManagerContractPlugin_PostSddcLicenseInventoryAction_3",
    "processingStateDescription" : "Update SDDC Manager Inventory with License Details",
    "name" : "Update SDDC Manager Inventory with License Details",
    "description" : "Update SDDC Manager Inventory with License Details",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.sddcmanager.SddcManagerContractPlugin",
      "messageKey" : "PostSddcLicenseInventoryAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.sddcmanager.SddcManagerContractPlugin",
      "messageKey" : "PostSddcLicenseInventoryAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.441Z",
    "updateTimestamp" : "2019-08-28T08:38:37.441Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_SddcManagerKnownHostsConfiguration_ProxyContractPlugin_ProxyContractAction_17",
    "processingStateDescription" : "Automation Helper Action",
    "name" : "ProxyContractAction",
    "description" : "Automation Helper Action",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.orchestrator.core.recipes.spel.ProxyContractPlugin",
      "messageKey" : "ProxyContractAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.orchestrator.core.recipes.spel.ProxyContractPlugin",
      "messageKey" : "ProxyContractAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.444Z",
    "updateTimestamp" : "2019-08-28T08:38:37.444Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "GenerateSddcManagerInput",
    "processingStateDescription" : "Generate SDDC Manager Input Data",
    "name" : "Generate SDDC Manager Input Data",
    "description" : "Generate SDDC Manager Input Data",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateSddcManagerInput.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateSddcManagerInput.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.447Z",
    "updateTimestamp" : "2019-08-28T08:38:37.447Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "GenerateVsphereMachineSshEntities",
    "processingStateDescription" : "Generate ESXi Host SSH Key Input Data",
    "name" : "Generate ESXi Host SSH Key Input Data",
    "description" : "Generate ESXi Host SSH Key Input Data",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateVsphereMachineSshEntities.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateVsphereMachineSshEntities.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.453Z",
    "updateTimestamp" : "2019-08-28T08:38:37.453Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_SddcManagerKnownHostsConfiguration_VsphereContractPlugin_RotateMachineSshKeys_2",
    "processingStateDescription" : "Rotate ESXi Host SSH Keys",
    "name" : "Rotate ESXi Host SSH Keys",
    "description" : "Rotate ESXi Host SSH Keys",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.vsphere.contract.VsphereContractPlugin",
      "messageKey" : "RotateMachineSshKeys.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.vsphere.contract.VsphereContractPlugin",
      "messageKey" : "RotateMachineSshKeys.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.456Z",
    "updateTimestamp" : "2019-08-28T08:38:37.456Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_SddcManagerKnownHostsConfiguration_SddcManagerContractPlugin_UpdateKnownHostsOnSddcManager_3",
    "processingStateDescription" : "Update Known Hosts in SDDC Manager",
    "name" : "Update Known Hosts in SDDC Manager",
    "description" : "Update Known Hosts in SDDC Manager",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.sddcmanager.SddcManagerContractPlugin",
      "messageKey" : "UpdateKnownHostsOnSddcManager.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.sddcmanager.SddcManagerContractPlugin",
      "messageKey" : "UpdateKnownHostsOnSddcManager.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.459Z",
    "updateTimestamp" : "2019-08-28T08:38:37.459Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "GenerateVsphereInput",
    "processingStateDescription" : "Generate vSphere Input Data",
    "name" : "Generate vSphere Input Data",
    "description" : "Generate vSphere Input Data",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateVsphereInput.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateVsphereInput.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.462Z",
    "updateTimestamp" : "2019-08-28T08:38:37.462Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "GenerateSddcManagerInput",
    "processingStateDescription" : "Generate SDDC Manager Input Data",
    "name" : "Generate SDDC Manager Input Data",
    "description" : "Generate SDDC Manager Input Data",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateSddcManagerInput.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateSddcManagerInput.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.465Z",
    "updateTimestamp" : "2019-08-28T08:38:37.465Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_VcenterMessagesConfigurations_VsphereContractPlugin_PrepareVcenterMessages_2",
    "processingStateDescription" : "Generate Configure vCenter Login Message and Message of the Day Input Data",
    "name" : "Generate Configure vCenter Login Message and Message of the Day Input Data",
    "description" : "Generate Configure vCenter Login Message and Message of the Day Input Data",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.vsphere.contract.VsphereContractPlugin",
      "messageKey" : "PrepareVcenterMessages.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.vsphere.contract.VsphereContractPlugin",
      "messageKey" : "PrepareVcenterMessages.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.471Z",
    "updateTimestamp" : "2019-08-28T08:38:37.471Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_VcenterMessagesConfigurations_VsphereContractPlugin_ConfigureVcenterMessages_3",
    "processingStateDescription" : "Configure vCenter Login Message and Message of the Day",
    "name" : "Configure vCenter Login Message and Message of the Day",
    "description" : "Configure vCenter Login Message and Message of the Day",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.vsphere.contract.VsphereContractPlugin",
      "messageKey" : "ConfigureVcenterMessages.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.vsphere.contract.VsphereContractPlugin",
      "messageKey" : "ConfigureVcenterMessages.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.474Z",
    "updateTimestamp" : "2019-08-28T08:38:37.474Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "GenerateClusterConfigurationInput",
    "processingStateDescription" : "Generate Cluster Configuration Input Data",
    "name" : "Generate Post Cluster Configuration Input Data",
    "description" : "Generate Cluster Configuration Input Data",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateClusterConfigurationInput.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateClusterConfigurationInput.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.477Z",
    "updateTimestamp" : "2019-08-28T08:38:37.477Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "GenerateConfigureDeploymentDetailsActionInput",
    "processingStateDescription" : "Generate Configure Deployment Details Action Input Data",
    "name" : "Generate Configure Deployment Details Action Input Data",
    "description" : "Generate Configure Deployment Details Action Input Data",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateConfigureDeploymentDetailsActionInput.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateConfigureDeploymentDetailsActionInput.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.483Z",
    "updateTimestamp" : "2019-08-28T08:38:37.483Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_PostClusterConfiguration_VspherePlugin_MigrateVmsToFoldersAction_2",
    "processingStateDescription" : "Move VMs to VM Folders",
    "name" : "Move VMs to VM Folders",
    "description" : "Move VMs to VM Folders",
    "localizableNamePack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "MigrateVmsToFoldersAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "MigrateVmsToFoldersAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.486Z",
    "updateTimestamp" : "2019-08-28T08:38:37.486Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_PostClusterConfiguration_VspherePlugin_MigrateDvsToFolderAction_3",
    "processingStateDescription" : "Move vSphere Distributed Switch to Network Folder",
    "name" : "Move vSphere Distributed Switch to Network Folder",
    "description" : "Move vSphere Distributed Switch to Network Folder",
    "localizableNamePack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "MigrateDvsToFolderAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "MigrateDvsToFolderAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.489Z",
    "updateTimestamp" : "2019-08-28T08:38:37.489Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_PostClusterConfiguration_VspherePlugin_DisableVsanForceProvisionAction_4",
    "processingStateDescription" : "Disable vSAN Force Provisioning",
    "name" : "Disable vSAN Force Provisioning",
    "description" : "Disable vSAN Force Provisioning",
    "localizableNamePack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "DisableVsanForceProvisionAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "DisableVsanForceProvisionAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.492Z",
    "updateTimestamp" : "2019-08-28T08:38:37.492Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_PostClusterConfiguration_VspherePlugin_EnableVsanPoliciesAction_5",
    "processingStateDescription" : "Enable vSAN Storage Policies",
    "name" : "Enable vSAN Storage Policies",
    "description" : "Enable vSAN Storage Policies",
    "localizableNamePack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "EnableVsanPoliciesAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "EnableVsanPoliciesAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.496Z",
    "updateTimestamp" : "2019-08-28T08:38:37.496Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_PostClusterConfiguration_VspherePlugin_RelocateAllVmsToResourcePoolAction_6",
    "processingStateDescription" : "Move VMs to Resource Pools",
    "name" : "Move VMs to Resource Pools",
    "description" : "Move VMs to Resource Pools",
    "localizableNamePack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "RelocateAllVmsToResourcePoolAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "RelocateAllVmsToResourcePoolAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.499Z",
    "updateTimestamp" : "2019-08-28T08:38:37.499Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_PostClusterConfiguration_VspherePlugin_AdjustResourcePoolReservationAction_7",
    "processingStateDescription" : "Set Reservations on Resource Pools",
    "name" : "Set Reservations on Resource Pools",
    "description" : "Set Reservations on Resource Pools",
    "localizableNamePack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "AdjustResourcePoolReservationAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "AdjustResourcePoolReservationAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.502Z",
    "updateTimestamp" : "2019-08-28T08:38:37.502Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_PostClusterConfiguration_VcPlugin_EnableClusterHaAction_8",
    "processingStateDescription" : "Enable vSphere High Availability",
    "name" : "Enable vSphere High Availability",
    "description" : "Enable vSphere High Availability",
    "localizableNamePack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "EnableClusterHaAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "EnableClusterHaAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.505Z",
    "updateTimestamp" : "2019-08-28T08:38:37.505Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_PostClusterConfiguration_VcPlugin_CreateVmAntiAffinityRuleAction_9",
    "processingStateDescription" : "Create VM Anti-Affinity Rules",
    "name" : "Create VM Anti-Affinity Rules",
    "description" : "Create VM Anti-Affinity Rules",
    "localizableNamePack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "CreateVmAntiAffinityRuleAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "CreateVmAntiAffinityRuleAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.508Z",
    "updateTimestamp" : "2019-08-28T08:38:37.508Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_PostClusterConfiguration_CreatePscVcVmGroupsPlugin_CreatePscVcVmGroupsContractAction_10",
    "processingStateDescription" : "Create VM Groups",
    "name" : "Create VM Groups",
    "description" : "Create VM Groups",
    "localizableNamePack" : {
      "component" : "com.vmware.vcf.common.fsm.plugins.action.CreatePscVcVmGroupsPlugin",
      "messageKey" : "CreatePscVcVmGroupsContractAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.vcf.common.fsm.plugins.action.CreatePscVcVmGroupsPlugin",
      "messageKey" : "CreatePscVcVmGroupsContractAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.511Z",
    "updateTimestamp" : "2019-08-28T08:38:37.511Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_PostClusterConfiguration_VspherePlugin_CreateClusterVmsToVmsRuleContractAction_11",
    "processingStateDescription" : "Create VM-VM Startup Order Rule",
    "name" : "Create VM-VM Startup Order Rule",
    "description" : "Create VM-VM Startup Order Rule",
    "localizableNamePack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "CreateClusterVmsToVmsRuleContractAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "CreateClusterVmsToVmsRuleContractAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.514Z",
    "updateTimestamp" : "2019-08-28T08:38:37.514Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_PostClusterConfiguration_ClusterVmHostPlugin_CreateClusterHostGroupContractAction_12",
    "processingStateDescription" : "Create vCenter VM/Host RuleNsxServiceImpl.java",
    "name" : "Create vCenter VM/Host Rule",
    "description" : "Create vCenter VM/Host RuleNsxServiceImpl.java",
    "localizableNamePack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "CreateClusterHostGroupContractAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "CreateClusterHostGroupContractAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.517Z",
    "updateTimestamp" : "2019-08-28T08:38:37.517Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_PostClusterConfiguration_ClusterVmHostPlugin_CreateClusterVmHostRuleContractAction_13",
    "processingStateDescription" : "Create Platform Services Controller VM/Host Rule",
    "name" : "Create Platform Services Controller VM/Host Rule",
    "description" : "Create Platform Services Controller VM/Host Rule",
    "localizableNamePack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "CreatePSCVMHostRuleActionId.name"
    },
    "localizableDescriptionPack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "CreatePSCVMHostRuleActionId.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.520Z",
    "updateTimestamp" : "2019-08-28T08:38:37.520Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_PostClusterConfiguration_ClusterVmHostPlugin_CreateClusterVmHostRuleContractAction_14",
    "processingStateDescription" : "Create Cluster Rule",
    "name" : "Create Cluster Rule",
    "description" : "Create Cluster Rule",
    "localizableNamePack" : {
      "component" : "com.vmware.vcf.common.fsm.plugins.action.ClusterVmHostPlugin",
      "messageKey" : "CreateClusterVmHostRuleContractAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.vcf.common.fsm.plugins.action.ClusterVmHostPlugin",
      "messageKey" : "CreateClusterVmHostRuleContractAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.523Z",
    "updateTimestamp" : "2019-08-28T08:38:37.523Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_PostClusterConfiguration_VcPlugin_ConfigureEsxAdvancedOptionsAction_15",
    "processingStateDescription" : "Configure ESXi Advanced Options",
    "name" : "Configure ESXi Advanced Options",
    "description" : "Configure ESXi Advanced Options",
    "localizableNamePack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "ConfigureEsxAdvancedOptionsAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "ConfigureEsxAdvancedOptionsAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.526Z",
    "updateTimestamp" : "2019-08-28T08:38:37.526Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_PostClusterConfiguration_VspherePlugin_ReconfigureHAOnClusterAction_16",
    "processingStateDescription" : "Reconfigure vSphere High Availability",
    "name" : "Reconfigure vSphere High Availability",
    "description" : "Reconfigure vSphere High Availability",
    "localizableNamePack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "ReconfigureHAOnClusterAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "ReconfigureHAOnClusterAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.529Z",
    "updateTimestamp" : "2019-08-28T08:38:37.529Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_PostClusterConfiguration_VspherePlugin_ClearVsanAlarmsOnClusterAction_17",
    "processingStateDescription" : "Clear Alarms on vSAN",
    "name" : "Clear Alarms on vSAN",
    "description" : "Clear Alarms on vSAN",
    "localizableNamePack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "ClearVsanAlarmsOnClusterAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "ClearVsanAlarmsOnClusterAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.532Z",
    "updateTimestamp" : "2019-08-28T08:38:37.532Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_PostClusterConfiguration_VspherePlugin_ClearRedAlarmsOnHostAction_18",
    "processingStateDescription" : "Clear Alerts on Hosts",
    "name" : "Clear Alerts on Hosts",
    "description" : "Clear Alerts on Hosts",
    "localizableNamePack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "ClearRedAlarmsOnHostAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "ClearRedAlarmsOnHostAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.535Z",
    "updateTimestamp" : "2019-08-28T08:38:37.535Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_PostClusterConfiguration_VspherePlugin_ConfigureDeploymentDetailsContractAction_19",
    "processingStateDescription" : "Set SDDC Deployment Details on the Management vCenter Server",
    "name" : "Set SDDC Deployment Details on the Management vCenter Server",
    "description" : "Set SDDC Deployment Details on the Management vCenter Server",
    "localizableNamePack" : {
      "component" : "com.vmware.vcf.common.fsm.plugins.action.VspherePlugin",
      "messageKey" : "ConfigureDeploymentDetailsContractAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.vcf.common.fsm.plugins.action.VspherePlugin",
      "messageKey" : "ConfigureDeploymentDetailsContractAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.539Z",
    "updateTimestamp" : "2019-08-28T08:38:37.539Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "GenerateVsphereInput",
    "processingStateDescription" : "Generate vSphere Input Data",
    "name" : "Generate vSphere Input Data",
    "description" : "Generate vSphere Input Data",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateVsphereInput.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateVsphereInput.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.542Z",
    "updateTimestamp" : "2019-08-28T08:38:37.542Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_DisableBashShellOnVcAndPsc_VsphereContractPlugin_DisableBashShell_1",
    "processingStateDescription" : "Disable Bash Shell on vCenter Server",
    "name" : "Disable Bash Shell on vCenter Server",
    "description" : "Disable Bash Shell on vCenter Server",
    "localizableNamePack" : {
      "component" : "workflowconfig.common_recipes.DisableBashShellOnVcAndPsc",
      "messageKey" : "DisableBashShellOnVCenterId.name"
    },
    "localizableDescriptionPack" : {
      "component" : "workflowconfig.common_recipes.DisableBashShellOnVcAndPsc",
      "messageKey" : "DisableBashShellOnVCenterId.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.545Z",
    "updateTimestamp" : "2019-08-28T08:38:37.545Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_DisableBashShellOnVcAndPsc_VsphereContractPlugin_DisableBashShell_2",
    "processingStateDescription" : "Disable Bash Shell on Platform Services Controllers",
    "name" : "Disable Bash Shell on Platform Services Controllers",
    "description" : "Disable Bash Shell on Platform Services Controllers",
    "localizableNamePack" : {
      "component" : "workflowconfig.common_recipes.DisableBashShellOnVcAndPsc",
      "messageKey" : "DisableBashShellOnPSCsId.name"
    },
    "localizableDescriptionPack" : {
      "component" : "workflowconfig.common_recipes.DisableBashShellOnVcAndPsc",
      "messageKey" : "DisableBashShellOnPSCsId.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.548Z",
    "updateTimestamp" : "2019-08-28T08:38:37.548Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "NSXvConfigurationForSDDCManager",
    "processingStateDescription" : "Configure NSX for vSphere",
    "name" : "Add VMs to NSX Distributed Firewall Exclusion List",
    "description" : "Configure NSX for vSphere",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
      "messageKey" : "AddVmsIntoDfwExclusionList.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
      "messageKey" : "AddVmsIntoDfwExclusionList.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.551Z",
    "updateTimestamp" : "2019-08-28T08:38:37.551Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "NSXBackupConfiguration",
    "processingStateDescription" : "Configure Backup on NSX for vSphere",
    "name" : "Configure NSX Manager Backups",
    "description" : "Configure Backup on NSX for vSphere",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.plugin.spi.LcmPlugin",
      "messageKey" : "ConfigureBackupForNSX.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.plugin.spi.LcmPlugin",
      "messageKey" : "ConfigureBackupForNSX.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.554Z",
    "updateTimestamp" : "2019-08-28T08:38:37.554Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "GenerateLogInsightInput",
    "processingStateDescription" : "Generate vRealize Log Insight Input Data",
    "name" : "Generate vRealize Log Insight Input Data",
    "description" : "Generate vRealize Log Insight Input Data",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateLogInsightInput.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateLogInsightInput.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.557Z",
    "updateTimestamp" : "2019-08-28T08:38:37.557Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_LogInsightConfiguration_ConfigureLogInsightAgentPlugin_ConfigureSddcManagerInLogInsightAction_1",
    "processingStateDescription" : "Configure Syslog Settings for SDDC Manager",
    "name" : "Configure Syslog Settings for SDDC Manager",
    "description" : "Configure Syslog Settings for SDDC Manager",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.common.fsmplugins.loginsight.plugin.ConfigureLogInsightAgentPlugin",
      "messageKey" : "ConfigureSddcManagerInLogInsightAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.common.fsmplugins.loginsight.plugin.ConfigureLogInsightAgentPlugin",
      "messageKey" : "ConfigureSddcManagerInLogInsightAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.561Z",
    "updateTimestamp" : "2019-08-28T08:38:37.561Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_LogInsightConfiguration_ConfigureLogInsightAgentPlugin_ConfigureVCenterInLogInsightWithSyslogAction_2",
    "processingStateDescription" : "Configure Syslog Settings for vCenter Server",
    "name" : "Configure Syslog Settings for vCenter Server",
    "description" : "Configure Syslog Settings for vCenter Server",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.common.fsmplugins.loginsight.plugin.ConfigureLogInsightAgentPlugin",
      "messageKey" : "ConfigureVCenterInLogInsightWithSyslogAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.common.fsmplugins.loginsight.plugin.ConfigureLogInsightAgentPlugin",
      "messageKey" : "ConfigureVCenterInLogInsightWithSyslogAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.565Z",
    "updateTimestamp" : "2019-08-28T08:38:37.565Z"
  } ]
}

  1. Invoke the API without providing SDDC creation details

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/sddcs/b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a' -i -u 'admin:VMwareInfra@1' -X PATCH \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json' \
    -d '{
  "skipEsxThumbprintValidation" : true,
  "managementPoolName" : "bringup-networkpool",
  "sddcManagerSpec" : {
    "secondUserCredentials" : {
      "username" : "vcf",
      "password" : "VMware123!"
    },
    "ipAddress" : "10.0.0.4",
    "netmask" : "255.255.255.0",
    "hostname" : "sddc-manager",
    "rootUserCredentials" : {
      "username" : "root",
      "password" : "VMware123!"
    },
    "restApiCredentials" : {
      "username" : "admin",
      "password" : "VMware123!"
    }
  },
  "sddcId" : "sddcId-public-api-05",
  "esxLicense" : "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
  "taskName" : "workflowconfig/workflowspec-ems.json",
  "ntpServers" : [ "10.0.0.250" ],
  "dnsSpec" : {
    "subdomain" : "vrack.vsphere.local",
    "domain" : "vsphere.local",
    "nameserver" : "10.0.0.250",
    "secondaryNameserver" : "10.0.0.250"
  },
  "networkSpecs" : [ {
    "subnet" : "10.0.0.0/22",
    "vlanId" : "0",
    "mtu" : "1500",
    "networkType" : "MANAGEMENT",
    "gateway" : "10.0.0.250"
  }, {
    "subnet" : "10.0.4.0/24",
    "includeIpAddressRanges" : [ {
      "startIpAddress" : "10.0.4.7",
      "endIpAddress" : "10.0.4.48"
    }, {
      "startIpAddress" : "10.0.4.3",
      "endIpAddress" : "10.0.4.6"
    } ],
    "includeIpAddress" : [ "10.0.4.50", "10.0.4.49" ],
    "vlanId" : "0",
    "mtu" : "8940",
    "networkType" : "VSAN",
    "gateway" : "10.0.4.253"
  }, {
    "subnet" : "10.0.8.0/24",
    "includeIpAddressRanges" : [ {
      "startIpAddress" : "10.0.8.3",
      "endIpAddress" : "10.0.8.50"
    } ],
    "vlanId" : "0",
    "mtu" : "8940",
    "networkType" : "VMOTION",
    "gateway" : "10.0.8.253"
  } ],
  "nsxSpec" : {
    "nsxId" : "sfo01m01nsx01",
    "nsxManagerIp" : "10.0.0.9",
    "nsxManagerHostname" : "nsxManager",
    "nsxSegmentRangeBegin" : "5000",
    "nsxSegmentRangeEnd" : "5200",
    "multicastRangeBegin" : "239.1.0.0",
    "multicastRangeEnd" : "239.1.255.255",
    "license" : "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
    "adminNsxManagerPassword" : "VMware1!",
    "privilegedNsxManagerPassword" : "VMware123!",
    "adminNsxControllerPassword" : "VMware1234567!",
    "nsxVxlanSpec" : {
      "vxlanCluster" : "SDDC-Cluster1",
      "vxlanDvs" : "SDDC-Dswitch-Private",
      "vxlanVlanId" : "0",
      "vxlanMtu" : "8940",
      "vtepVmknicCount" : 2
    },
    "controllerIPPoolSpec" : {
      "poolName" : "sfo01-mgmt01-nsxc01",
      "startIp" : "10.0.0.40",
      "endIp" : "10.0.0.42",
      "prefix" : "22",
      "defaultGateway" : "10.0.0.250"
    }
  },
  "vsanSpec" : {
    "vsanName" : "vsan-1",
    "licenseFile" : "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
    "datastoreName" : "sfo01-m01-vsan"
  },
  "dvsSpecs" : [ {
    "mtu" : 8940,
    "niocSpec" : [ {
      "trafficType" : "VSAN",
      "value" : "HIGH"
    }, {
      "trafficType" : "VMOTION",
      "value" : "LOW"
    }, {
      "trafficType" : "VDP",
      "value" : "LOW"
    }, {
      "trafficType" : "VIRTUALMACHINE",
      "value" : "HIGH"
    }, {
      "trafficType" : "MANAGEMENT",
      "value" : "NORMAL"
    }, {
      "trafficType" : "NFS",
      "value" : "LOW"
    }, {
      "trafficType" : "HBR",
      "value" : "LOW"
    }, {
      "trafficType" : "FAULTTOLERANCE",
      "value" : "LOW"
    }, {
      "trafficType" : "ISCSI",
      "value" : "LOW"
    } ],
    "dvsName" : "SDDC-Dswitch-Private",
    "vmnics" : [ "vmnic0", "vmnic1" ],
    "networks" : [ "MANAGEMENT", "VSAN", "VMOTION" ]
  } ],
  "clusterSpec" : {
    "clusterName" : "SDDC-Cluster1",
    "clusterEvcMode" : "",
    "resourcePoolSpecs" : [ {
      "cpuSharesLevel" : "high",
      "cpuSharesValue" : 0,
      "name" : "Mgmt-ResourcePool",
      "memorySharesValue" : 0,
      "cpuReservationPercentage" : 0,
      "memoryLimit" : -1,
      "memoryReservationPercentage" : 0,
      "cpuReservationExpandable" : true,
      "memoryReservationExpandable" : true,
      "memorySharesLevel" : "normal",
      "cpuLimit" : -1,
      "type" : "management"
    }, {
      "cpuSharesLevel" : "high",
      "cpuSharesValue" : 0,
      "name" : "Network-ResourcePool",
      "memorySharesValue" : 0,
      "cpuReservationPercentage" : 0,
      "memoryLimit" : -1,
      "memoryReservationPercentage" : 0,
      "cpuReservationExpandable" : true,
      "memoryReservationExpandable" : true,
      "memorySharesLevel" : "normal",
      "cpuLimit" : -1,
      "type" : "network"
    }, {
      "cpuSharesLevel" : "normal",
      "cpuSharesValue" : 0,
      "name" : "Compute-ResourcePool",
      "memorySharesValue" : 0,
      "cpuReservationPercentage" : 0,
      "memoryLimit" : -1,
      "memoryReservationPercentage" : 0,
      "cpuReservationExpandable" : true,
      "memoryReservationExpandable" : true,
      "memorySharesLevel" : "normal",
      "cpuLimit" : -1,
      "type" : "compute"
    }, {
      "name" : "User-RP",
      "type" : "compute",
      "cpuReservationPercentage" : 0,
      "cpuLimit" : -1,
      "cpuReservationExpandable" : true,
      "cpuSharesLevel" : "normal",
      "cpuSharesValue" : 0,
      "memoryReservationPercentage" : 0,
      "memoryLimit" : -1,
      "memoryReservationExpandable" : true,
      "memorySharesLevel" : "normal",
      "memorySharesValue" : 0
    } ]
  },
  "pscSpecs" : [ {
    "pscId" : "psc-1",
    "rootPscPassword" : "VMware123!",
    "automationUserSsoPassword" : "VMware123!",
    "automationUserSsoUsername" : "automationuser",
    "pscIp" : "10.0.0.5",
    "pscHostName" : "psc-1",
    "pscSsoSpec" : {
      "ssoSiteName" : "vmwvcf2",
      "ssoDomain" : "vsphere.local",
      "isJoinSsoDomain" : false
    },
    "adminUserSsoPassword" : "VMware123!"
  }, {
    "pscId" : "psc-2",
    "rootPscPassword" : "VMware123!",
    "automationUserSsoPassword" : "VMware123!",
    "automationUserSsoUsername" : "automationuser",
    "pscIp" : "10.0.0.7",
    "pscHostName" : "psc-2",
    "pscSsoSpec" : {
      "replicationPartner" : "psc-1",
      "ssoSiteName" : "vmwvcf2",
      "ssoDomainPassword" : "VMware123!",
      "ssoDomain" : "vsphere.local",
      "isJoinSsoDomain" : false
    },
    "adminUserSsoPassword" : "VMware123!"
  } ],
  "vcenterSpec" : {
    "vcenterIp" : "10.0.0.6",
    "vcenterHostname" : "vcenter-1",
    "licenseFile" : "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
    "rootVcenterPassword" : "VMware1!",
    "vmSize" : "tiny"
  },
  "hostSpecs" : [ {
    "credentials" : {
      "username" : "root",
      "password" : "EvoSddc!2016"
    },
    "ipAddressPrivate" : {
      "subnet" : "255.255.252.0",
      "cidr" : "",
      "ipAddress" : "10.0.0.100",
      "gateway" : "10.0.0.250"
    },
    "hostname" : "esxi-1",
    "vSwitch" : "vSwitch0",
    "serverId" : "host-0",
    "association" : "SDDC-Datacenter"
  }, {
    "credentials" : {
      "username" : "root",
      "password" : "EvoSddc!2016"
    },
    "ipAddressPrivate" : {
      "subnet" : "255.255.252.0",
      "cidr" : "",
      "ipAddress" : "10.0.0.101",
      "gateway" : "10.0.0.250"
    },
    "hostname" : "esxi-2",
    "vSwitch" : "vSwitch0",
    "serverId" : "host-1",
    "association" : "SDDC-Datacenter"
  }, {
    "credentials" : {
      "username" : "root",
      "password" : "EvoSddc!2016"
    },
    "ipAddressPrivate" : {
      "subnet" : "255.255.255.0",
      "cidr" : "",
      "ipAddress" : "10.0.0.102",
      "gateway" : "10.0.0.250"
    },
    "hostname" : "esxi-3",
    "vSwitch" : "vSwitch0",
    "serverId" : "host-2",
    "association" : "SDDC-Datacenter"
  }, {
    "credentials" : {
      "username" : "root",
      "password" : "EvoSddc!2016"
    },
    "ipAddressPrivate" : {
      "subnet" : "255.255.255.0",
      "cidr" : "",
      "ipAddress" : "10.0.0.103",
      "gateway" : "10.0.0.250"
    },
    "hostname" : "esxi-4",
    "vSwitch" : "vSwitch0",
    "serverId" : "host-3",
    "association" : "SDDC-Datacenter"
  } ],
  "vrliDeploymentSpec" : {
    "adminPassword" : "VMware1234!",
    "sshPassword" : "VMware12345!",
    "vmSize" : "small",
    "loadBalancerHostname" : "load-balancer",
    "loadBalancerIpAddress" : "10.0.0.15",
    "vrliNodeSpecs" : [ {
      "ipAddress" : "10.0.0.16",
      "hostname" : "loginsight-node-1"
    }, {
      "ipAddress" : "10.0.0.17",
      "hostname" : "loginsight-node-2"
    }, {
      "ipAddress" : "10.0.0.18",
      "hostname" : "loginsight-node-3"
    } ]
  }
}'

HTTP Request

PATCH /v1/sddcs/b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a HTTP/1.1
Accept: application/json
Host: sddc-manager.sfo01.rainpole.local
Content-Length: 8293
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==
Content-Type: application/json

{
  "skipEsxThumbprintValidation" : true,
  "managementPoolName" : "bringup-networkpool",
  "sddcManagerSpec" : {
    "secondUserCredentials" : {
      "username" : "vcf",
      "password" : "VMware123!"
    },
    "ipAddress" : "10.0.0.4",
    "netmask" : "255.255.255.0",
    "hostname" : "sddc-manager",
    "rootUserCredentials" : {
      "username" : "root",
      "password" : "VMware123!"
    },
    "restApiCredentials" : {
      "username" : "admin",
      "password" : "VMware123!"
    }
  },
  "sddcId" : "sddcId-public-api-05",
  "esxLicense" : "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
  "taskName" : "workflowconfig/workflowspec-ems.json",
  "ntpServers" : [ "10.0.0.250" ],
  "dnsSpec" : {
    "subdomain" : "vrack.vsphere.local",
    "domain" : "vsphere.local",
    "nameserver" : "10.0.0.250",
    "secondaryNameserver" : "10.0.0.250"
  },
  "networkSpecs" : [ {
    "subnet" : "10.0.0.0/22",
    "vlanId" : "0",
    "mtu" : "1500",
    "networkType" : "MANAGEMENT",
    "gateway" : "10.0.0.250"
  }, {
    "subnet" : "10.0.4.0/24",
    "includeIpAddressRanges" : [ {
      "startIpAddress" : "10.0.4.7",
      "endIpAddress" : "10.0.4.48"
    }, {
      "startIpAddress" : "10.0.4.3",
      "endIpAddress" : "10.0.4.6"
    } ],
    "includeIpAddress" : [ "10.0.4.50", "10.0.4.49" ],
    "vlanId" : "0",
    "mtu" : "8940",
    "networkType" : "VSAN",
    "gateway" : "10.0.4.253"
  }, {
    "subnet" : "10.0.8.0/24",
    "includeIpAddressRanges" : [ {
      "startIpAddress" : "10.0.8.3",
      "endIpAddress" : "10.0.8.50"
    } ],
    "vlanId" : "0",
    "mtu" : "8940",
    "networkType" : "VMOTION",
    "gateway" : "10.0.8.253"
  } ],
  "nsxSpec" : {
    "nsxId" : "sfo01m01nsx01",
    "nsxManagerIp" : "10.0.0.9",
    "nsxManagerHostname" : "nsxManager",
    "nsxSegmentRangeBegin" : "5000",
    "nsxSegmentRangeEnd" : "5200",
    "multicastRangeBegin" : "239.1.0.0",
    "multicastRangeEnd" : "239.1.255.255",
    "license" : "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
    "adminNsxManagerPassword" : "VMware1!",
    "privilegedNsxManagerPassword" : "VMware123!",
    "adminNsxControllerPassword" : "VMware1234567!",
    "nsxVxlanSpec" : {
      "vxlanCluster" : "SDDC-Cluster1",
      "vxlanDvs" : "SDDC-Dswitch-Private",
      "vxlanVlanId" : "0",
      "vxlanMtu" : "8940",
      "vtepVmknicCount" : 2
    },
    "controllerIPPoolSpec" : {
      "poolName" : "sfo01-mgmt01-nsxc01",
      "startIp" : "10.0.0.40",
      "endIp" : "10.0.0.42",
      "prefix" : "22",
      "defaultGateway" : "10.0.0.250"
    }
  },
  "vsanSpec" : {
    "vsanName" : "vsan-1",
    "licenseFile" : "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
    "datastoreName" : "sfo01-m01-vsan"
  },
  "dvsSpecs" : [ {
    "mtu" : 8940,
    "niocSpec" : [ {
      "trafficType" : "VSAN",
      "value" : "HIGH"
    }, {
      "trafficType" : "VMOTION",
      "value" : "LOW"
    }, {
      "trafficType" : "VDP",
      "value" : "LOW"
    }, {
      "trafficType" : "VIRTUALMACHINE",
      "value" : "HIGH"
    }, {
      "trafficType" : "MANAGEMENT",
      "value" : "NORMAL"
    }, {
      "trafficType" : "NFS",
      "value" : "LOW"
    }, {
      "trafficType" : "HBR",
      "value" : "LOW"
    }, {
      "trafficType" : "FAULTTOLERANCE",
      "value" : "LOW"
    }, {
      "trafficType" : "ISCSI",
      "value" : "LOW"
    } ],
    "dvsName" : "SDDC-Dswitch-Private",
    "vmnics" : [ "vmnic0", "vmnic1" ],
    "networks" : [ "MANAGEMENT", "VSAN", "VMOTION" ]
  } ],
  "clusterSpec" : {
    "clusterName" : "SDDC-Cluster1",
    "clusterEvcMode" : "",
    "resourcePoolSpecs" : [ {
      "cpuSharesLevel" : "high",
      "cpuSharesValue" : 0,
      "name" : "Mgmt-ResourcePool",
      "memorySharesValue" : 0,
      "cpuReservationPercentage" : 0,
      "memoryLimit" : -1,
      "memoryReservationPercentage" : 0,
      "cpuReservationExpandable" : true,
      "memoryReservationExpandable" : true,
      "memorySharesLevel" : "normal",
      "cpuLimit" : -1,
      "type" : "management"
    }, {
      "cpuSharesLevel" : "high",
      "cpuSharesValue" : 0,
      "name" : "Network-ResourcePool",
      "memorySharesValue" : 0,
      "cpuReservationPercentage" : 0,
      "memoryLimit" : -1,
      "memoryReservationPercentage" : 0,
      "cpuReservationExpandable" : true,
      "memoryReservationExpandable" : true,
      "memorySharesLevel" : "normal",
      "cpuLimit" : -1,
      "type" : "network"
    }, {
      "cpuSharesLevel" : "normal",
      "cpuSharesValue" : 0,
      "name" : "Compute-ResourcePool",
      "memorySharesValue" : 0,
      "cpuReservationPercentage" : 0,
      "memoryLimit" : -1,
      "memoryReservationPercentage" : 0,
      "cpuReservationExpandable" : true,
      "memoryReservationExpandable" : true,
      "memorySharesLevel" : "normal",
      "cpuLimit" : -1,
      "type" : "compute"
    }, {
      "name" : "User-RP",
      "type" : "compute",
      "cpuReservationPercentage" : 0,
      "cpuLimit" : -1,
      "cpuReservationExpandable" : true,
      "cpuSharesLevel" : "normal",
      "cpuSharesValue" : 0,
      "memoryReservationPercentage" : 0,
      "memoryLimit" : -1,
      "memoryReservationExpandable" : true,
      "memorySharesLevel" : "normal",
      "memorySharesValue" : 0
    } ]
  },
  "pscSpecs" : [ {
    "pscId" : "psc-1",
    "rootPscPassword" : "VMware123!",
    "automationUserSsoPassword" : "VMware123!",
    "automationUserSsoUsername" : "automationuser",
    "pscIp" : "10.0.0.5",
    "pscHostName" : "psc-1",
    "pscSsoSpec" : {
      "ssoSiteName" : "vmwvcf2",
      "ssoDomain" : "vsphere.local",
      "isJoinSsoDomain" : false
    },
    "adminUserSsoPassword" : "VMware123!"
  }, {
    "pscId" : "psc-2",
    "rootPscPassword" : "VMware123!",
    "automationUserSsoPassword" : "VMware123!",
    "automationUserSsoUsername" : "automationuser",
    "pscIp" : "10.0.0.7",
    "pscHostName" : "psc-2",
    "pscSsoSpec" : {
      "replicationPartner" : "psc-1",
      "ssoSiteName" : "vmwvcf2",
      "ssoDomainPassword" : "VMware123!",
      "ssoDomain" : "vsphere.local",
      "isJoinSsoDomain" : false
    },
    "adminUserSsoPassword" : "VMware123!"
  } ],
  "vcenterSpec" : {
    "vcenterIp" : "10.0.0.6",
    "vcenterHostname" : "vcenter-1",
    "licenseFile" : "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
    "rootVcenterPassword" : "VMware1!",
    "vmSize" : "tiny"
  },
  "hostSpecs" : [ {
    "credentials" : {
      "username" : "root",
      "password" : "EvoSddc!2016"
    },
    "ipAddressPrivate" : {
      "subnet" : "255.255.252.0",
      "cidr" : "",
      "ipAddress" : "10.0.0.100",
      "gateway" : "10.0.0.250"
    },
    "hostname" : "esxi-1",
    "vSwitch" : "vSwitch0",
    "serverId" : "host-0",
    "association" : "SDDC-Datacenter"
  }, {
    "credentials" : {
      "username" : "root",
      "password" : "EvoSddc!2016"
    },
    "ipAddressPrivate" : {
      "subnet" : "255.255.252.0",
      "cidr" : "",
      "ipAddress" : "10.0.0.101",
      "gateway" : "10.0.0.250"
    },
    "hostname" : "esxi-2",
    "vSwitch" : "vSwitch0",
    "serverId" : "host-1",
    "association" : "SDDC-Datacenter"
  }, {
    "credentials" : {
      "username" : "root",
      "password" : "EvoSddc!2016"
    },
    "ipAddressPrivate" : {
      "subnet" : "255.255.255.0",
      "cidr" : "",
      "ipAddress" : "10.0.0.102",
      "gateway" : "10.0.0.250"
    },
    "hostname" : "esxi-3",
    "vSwitch" : "vSwitch0",
    "serverId" : "host-2",
    "association" : "SDDC-Datacenter"
  }, {
    "credentials" : {
      "username" : "root",
      "password" : "EvoSddc!2016"
    },
    "ipAddressPrivate" : {
      "subnet" : "255.255.255.0",
      "cidr" : "",
      "ipAddress" : "10.0.0.103",
      "gateway" : "10.0.0.250"
    },
    "hostname" : "esxi-4",
    "vSwitch" : "vSwitch0",
    "serverId" : "host-3",
    "association" : "SDDC-Datacenter"
  } ],
  "vrliDeploymentSpec" : {
    "adminPassword" : "VMware1234!",
    "sshPassword" : "VMware12345!",
    "vmSize" : "small",
    "loadBalancerHostname" : "load-balancer",
    "loadBalancerIpAddress" : "10.0.0.15",
    "vrliNodeSpecs" : [ {
      "ipAddress" : "10.0.0.16",
      "hostname" : "loginsight-node-1"
    }, {
      "ipAddress" : "10.0.0.17",
      "hostname" : "loginsight-node-2"
    }, {
      "ipAddress" : "10.0.0.18",
      "hostname" : "loginsight-node-3"
    } ]
  }
}

HTTP Response

HTTP/1.1 200 OK
Content-Length: 100905
Content-Type: application/json;charset=UTF-8

{
  "id" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
  "name" : "Bringup-Ems",
  "status" : "IN_PROGRESS",
  "creationTimestamp" : "2019-08-28T08:38:37.568Z",
  "sddcSubTasks" : [ {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "GenerateEsxiForVsanDedupInput",
    "processingStateDescription" : "Generate ESXi Host vSAN Deduplication Input Data",
    "name" : "Generate ESXi Host vSAN Deduplication Input Data",
    "description" : "Generate ESXi Host vSAN Deduplication Input Data",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateEsxiForVsanDedupInput.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateEsxiForVsanDedupInput.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.568Z",
    "updateTimestamp" : "2019-08-28T08:38:37.568Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "GenerateEsxiInput",
    "processingStateDescription" : "Generate ESXi Host Input Data",
    "name" : "Generate ESXi Host Input Data",
    "description" : "Generate ESXi Host Input Data",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateEsxiInput.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateEsxiInput.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.216Z",
    "updateTimestamp" : "2019-08-28T08:38:37.216Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_InitialEnvironmentSetup_VspherePlugin_PrepareEsxiForVsanDedupAction_2",
    "processingStateDescription" : "Prepare ESXi Hosts for vSAN with Deduplication",
    "name" : "Prepare ESXi Hosts for vSAN with Deduplication Action",
    "description" : "Prepare ESXi Hosts for vSAN with Deduplication",
    "localizableNamePack" : {
      "component" : "com.vmware.vcf.common.fsm.plugins.action.VspherePlugin",
      "messageKey" : "PrepareEsxiForVsanDedupAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.vcf.common.fsm.plugins.action.VspherePlugin",
      "messageKey" : "PrepareEsxiForVsanDedupAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.220Z",
    "updateTimestamp" : "2019-08-28T08:38:37.220Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_InitialEnvironmentSetup_VspherePlugin_EnableVsanDedupOnFirstHostAction_3",
    "processingStateDescription" : "Enable vSAN Deduplication for the First Host",
    "name" : "Enable vSAN Deduplication for the First Host Action",
    "description" : "Enable vSAN Deduplication for the First Host",
    "localizableNamePack" : {
      "component" : "com.vmware.vcf.common.fsm.plugins.action.VspherePlugin",
      "messageKey" : "EnableVsanDedupOnFirstHostAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.vcf.common.fsm.plugins.action.VspherePlugin",
      "messageKey" : "EnableVsanDedupOnFirstHostAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.224Z",
    "updateTimestamp" : "2019-08-28T08:38:37.224Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_InitialEnvironmentSetup_HostPlugin_CreateVmPortGroupAction_4",
    "processingStateDescription" : "Create 'VM Network' Portgroup on ESXi Hosts",
    "name" : "Create 'VM Network' Portgroup on ESXi Hosts",
    "description" : "Create 'VM Network' Portgroup on ESXi Hosts",
    "localizableNamePack" : {
      "component" : "com.vmware.vcf.common.fsm.plugins.action.HostPlugin",
      "messageKey" : "CreateVmPortGroupAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.vcf.common.fsm.plugins.action.HostPlugin",
      "messageKey" : "CreateVmPortGroupAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.227Z",
    "updateTimestamp" : "2019-08-28T08:38:37.227Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_InitialEnvironmentSetup_HostPlugin_ReconfigureHostDnsAction_5",
    "processingStateDescription" : "Configure ESXi Host DNS",
    "name" : "Configure ESXi Host DNS",
    "description" : "Configure ESXi Host DNS",
    "localizableNamePack" : {
      "component" : "com.vmware.vcf.common.fsm.plugins.action.HostPlugin",
      "messageKey" : "ReconfigureHostDnsAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.vcf.common.fsm.plugins.action.HostPlugin",
      "messageKey" : "ReconfigureHostDnsAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.231Z",
    "updateTimestamp" : "2019-08-28T08:38:37.231Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_InitialEnvironmentSetup_com.vmware.evo.sddc.bringup.plugin.spi.VspherePlugin_DetermineSoftwareVersionAction_6",
    "processingStateDescription" : "Determine Software Version on ESXi Hosts",
    "name" : "Determine Software Version on ESXi Hosts",
    "description" : "Determine Software Version on ESXi Hosts",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "DetermineSoftwareVersionAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "DetermineSoftwareVersionAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.234Z",
    "updateTimestamp" : "2019-08-28T08:38:37.234Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "PSCDeploymentInputGeneration",
    "processingStateDescription" : "Generate Platform Services Controller Deployment Input Data",
    "name" : "Generate Platform Services Controller Deployment Input Data",
    "description" : "Generate Platform Services Controller Deployment Input Data",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "PSCDeploymentInputGeneration.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "PSCDeploymentInputGeneration.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.238Z",
    "updateTimestamp" : "2019-08-28T08:38:37.238Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_PSCDeployment_PscPlugin_DeployPsc1Action_1",
    "processingStateDescription" : "Deploy Platform Service Controller",
    "name" : "Deploy Platform Service Controller",
    "description" : "Deploy Platform Service Controller",
    "localizableNamePack" : {
      "component" : "com.vmware.vcf.common.fsm.plugins.action.plugins.PscPlugin",
      "messageKey" : "DeployPsc1Action.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.vcf.common.fsm.plugins.action.plugins.PscPlugin",
      "messageKey" : "DeployPsc1Action.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.243Z",
    "updateTimestamp" : "2019-08-28T08:38:37.243Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_PSCDeployment_PscPlugin_CreateUserGroupsAction_2",
    "processingStateDescription" : "Create Admin User Groups in vsphere.local Domain",
    "name" : "Create Admin User Groups in vsphere.local Domain",
    "description" : "Create Admin User Groups in vsphere.local Domain",
    "localizableNamePack" : {
      "component" : "com.vmware.vcf.common.fsm.plugins.action.plugins.PscPlugin",
      "messageKey" : "CreateUserGroupsAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.vcf.common.fsm.plugins.action.plugins.PscPlugin",
      "messageKey" : "CreateUserGroupsAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.248Z",
    "updateTimestamp" : "2019-08-28T08:38:37.248Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_GenerateLicenseRenameInput_ProxyContractPlugin_ProxyContractAction_0",
    "processingStateDescription" : "Automation Helper Action",
    "name" : "ProxyContractAction",
    "description" : "Automation Helper Action",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.orchestrator.core.recipes.spel.ProxyContractPlugin",
      "messageKey" : "ProxyContractAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.orchestrator.core.recipes.spel.ProxyContractPlugin",
      "messageKey" : "ProxyContractAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.253Z",
    "updateTimestamp" : "2019-08-28T08:38:37.253Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "GenerateLicenseRenameInput",
    "processingStateDescription" : "Generate license rename input",
    "name" : "Generate vCenter License Rename Input Data",
    "description" : "Generate license rename input",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.input.generation.recipes.GenerateLicenseRenameInput",
      "messageKey" : "GenerateLicenseRenameInput.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.input.generation.recipes.GenerateLicenseRenameInput",
      "messageKey" : "GenerateLicenseRenameInput.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.258Z",
    "updateTimestamp" : "2019-08-28T08:38:37.258Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "GenerateVcDeploymentInput",
    "processingStateDescription" : "Generate Vc Deployment Input",
    "name" : "Generate vCenter Server Deployment Input Data",
    "description" : "Generate Vc Deployment Input",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateVcDeploymentInput.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateVcDeploymentInput.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.264Z",
    "updateTimestamp" : "2019-08-28T08:38:37.264Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_VCDeployment_VcPlugin_DeployVcAction_3",
    "processingStateDescription" : "Deploy vCenter Server",
    "name" : "Deploy vCenter Server",
    "description" : "Deploy vCenter Server",
    "localizableNamePack" : {
      "component" : "com.vmware.vcf.common.fsm.plugins.action.plugins.VcPlugin",
      "messageKey" : "DeployVcAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.vcf.common.fsm.plugins.action.plugins.VcPlugin",
      "messageKey" : "DeployVcAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.269Z",
    "updateTimestamp" : "2019-08-28T08:38:37.269Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_VCDeployment_VcPlugin_ApplyVcLicenseAction_4",
    "processingStateDescription" : "Apply vCenter Server, vSphere, and vSAN Licenses",
    "name" : "Apply vCenter Server, vSphere, and vSAN Licenses",
    "description" : "Apply vCenter Server, vSphere, and vSAN Licenses",
    "localizableNamePack" : {
      "component" : "workflowconfig.ems_recipes.VCDeployment",
      "messageKey" : "ApplyVcLicenseAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "workflowconfig.ems_recipes.VCDeployment",
      "messageKey" : "ApplyVcLicenseAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.272Z",
    "updateTimestamp" : "2019-08-28T08:38:37.272Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_VCDeployment_LicensePlugin_RenameLicense_5",
    "processingStateDescription" : "Rename the Applied vCenter License in vCenter Server",
    "name" : "Rename the Applied vCenter License in vCenter Server",
    "description" : "Rename the Applied vCenter License in vCenter Server",
    "localizableNamePack" : {
      "component" : "workflowconfig.ems_recipes.VCDeployment",
      "messageKey" : "RenameLicense.name"
    },
    "localizableDescriptionPack" : {
      "component" : "workflowconfig.ems_recipes.VCDeployment",
      "messageKey" : "RenameLicense.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.276Z",
    "updateTimestamp" : "2019-08-28T08:38:37.276Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ManagementClusterConfiguration",
    "processingStateDescription" : "Create Vsphere Cluster",
    "name" : "Create vSphere Cluster",
    "description" : "Create Vsphere Cluster",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "CreateCluster.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "CreateCluster.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.281Z",
    "updateTimestamp" : "2019-08-28T08:38:37.281Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ManagementClusterConfiguration",
    "processingStateDescription" : "Create Vsphere Cluster",
    "name" : "Enable vSphere DRS",
    "description" : "Create Vsphere Cluster",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "EnableClusterDrs.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "EnableClusterDrs.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.281Z",
    "updateTimestamp" : "2019-08-28T08:38:37.281Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ManagementClusterConfiguration",
    "processingStateDescription" : "Create Vsphere Cluster",
    "name" : "Apply vSAN Dormant License File (DLF)",
    "description" : "Create Vsphere Cluster",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "ApplyVsanDlf.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "ApplyVsanDlf.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.281Z",
    "updateTimestamp" : "2019-08-28T08:38:37.281Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ManagementClusterConfiguration",
    "processingStateDescription" : "Create Vsphere Cluster",
    "name" : "Apply vSAN License",
    "description" : "Create Vsphere Cluster",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "ApplyVsanLicense.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "ApplyVsanLicense.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.281Z",
    "updateTimestamp" : "2019-08-28T08:38:37.281Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ManagementClusterConfiguration",
    "processingStateDescription" : "Create Vsphere Cluster",
    "name" : "Generate vSAN License Rename Input Data",
    "description" : "Create Vsphere Cluster",
    "localizableNamePack" : {
      "component" : "workflowconfig.ems_recipes.ManagementClusterConfiguration",
      "messageKey" : "GenerateVSANLicenseRenameInputId.name"
    },
    "localizableDescriptionPack" : {
      "component" : "workflowconfig.ems_recipes.ManagementClusterConfiguration",
      "messageKey" : "GenerateVSANLicenseRenameInputId.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.281Z",
    "updateTimestamp" : "2019-08-28T08:38:37.281Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ManagementClusterConfiguration",
    "processingStateDescription" : "Create Vsphere Cluster",
    "name" : "Rename the Applied VSAN License in vCenter Server",
    "description" : "Create Vsphere Cluster",
    "localizableNamePack" : {
      "component" : "workflowconfig.ems_recipes.ManagementClusterConfiguration",
      "messageKey" : "RenameVSANLicenseId.name"
    },
    "localizableDescriptionPack" : {
      "component" : "workflowconfig.ems_recipes.ManagementClusterConfiguration",
      "messageKey" : "RenameVSANLicenseId.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.281Z",
    "updateTimestamp" : "2019-08-28T08:38:37.281Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ManagementClusterConfiguration",
    "processingStateDescription" : "Create Vsphere Cluster",
    "name" : "Assign Administrator Privileges to SDDCAdmins Group",
    "description" : "Create Vsphere Cluster",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "AuthorizeSddcAdminGroup.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "AuthorizeSddcAdminGroup.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.281Z",
    "updateTimestamp" : "2019-08-28T08:38:37.281Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ManagementClusterConfiguration",
    "processingStateDescription" : "Create Vsphere Cluster",
    "name" : "Create vSphere Distributed Switch",
    "description" : "Create Vsphere Cluster",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "CreateDvs.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "CreateDvs.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.281Z",
    "updateTimestamp" : "2019-08-28T08:38:37.281Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ManagementClusterConfiguration",
    "processingStateDescription" : "Create Vsphere Cluster",
    "name" : "Add ESXi Host to vSphere Cluster",
    "description" : "Create Vsphere Cluster",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "AddHostToCluster.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "AddHostToCluster.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.281Z",
    "updateTimestamp" : "2019-08-28T08:38:37.281Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ManagementClusterConfiguration",
    "processingStateDescription" : "Create Vsphere Cluster",
    "name" : "Enable/Disable EVC Mode on vSphere Cluster",
    "description" : "Create Vsphere Cluster",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "EnableEvc.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "EnableEvc.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.281Z",
    "updateTimestamp" : "2019-08-28T08:38:37.281Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ManagementClusterConfiguration",
    "processingStateDescription" : "Create Vsphere Cluster",
    "name" : "Add ESXi Hosts to vSphere Distributed Switch",
    "description" : "Create Vsphere Cluster",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "AddHostToDvswitch.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "AddHostToDvswitch.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.281Z",
    "updateTimestamp" : "2019-08-28T08:38:37.281Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ManagementClusterConfiguration",
    "processingStateDescription" : "Create Vsphere Cluster",
    "name" : "Create VM Folders",
    "description" : "Create Vsphere Cluster",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "CreateVmFolders.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "CreateVmFolders.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.281Z",
    "updateTimestamp" : "2019-08-28T08:38:37.281Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ManagementClusterConfiguration",
    "processingStateDescription" : "Create Vsphere Cluster",
    "name" : "Create Network Folders",
    "description" : "Create Vsphere Cluster",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "CreateNetworkFolders.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "CreateNetworkFolders.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.281Z",
    "updateTimestamp" : "2019-08-28T08:38:37.281Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ManagementClusterConfiguration",
    "processingStateDescription" : "Create Vsphere Cluster",
    "name" : "Create vMotion vmknics",
    "description" : "Create Vsphere Cluster",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "CreateVmotionVmknics.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "CreateVmotionVmknics.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.281Z",
    "updateTimestamp" : "2019-08-28T08:38:37.281Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ManagementClusterConfiguration",
    "processingStateDescription" : "Create Vsphere Cluster",
    "name" : "Create vSAN vmknics",
    "description" : "Create Vsphere Cluster",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "CreateVsanVmknics.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "CreateVsanVmknics.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.281Z",
    "updateTimestamp" : "2019-08-28T08:38:37.281Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ManagementClusterConfiguration",
    "processingStateDescription" : "Create Vsphere Cluster",
    "name" : "Configure VLANs on vSphere Distributed Switch Portgroups",
    "description" : "Create Vsphere Cluster",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "TagVlanIdsOnPortgroups.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "TagVlanIdsOnPortgroups.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.281Z",
    "updateTimestamp" : "2019-08-28T08:38:37.281Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ManagementClusterConfiguration",
    "processingStateDescription" : "Create Vsphere Cluster",
    "name" : "Migrate VMs to vSphere Distributed Switch",
    "description" : "Create Vsphere Cluster",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "MigrateVmsToPortgroups.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "MigrateVmsToPortgroups.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.281Z",
    "updateTimestamp" : "2019-08-28T08:38:37.281Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ManagementClusterConfiguration",
    "processingStateDescription" : "Create Vsphere Cluster",
    "name" : "Migrate ESXi Host vmknics to vSphere Distributed Switch",
    "description" : "Create Vsphere Cluster",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "MigrateHostVmknicsToPortgroups.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "MigrateHostVmknicsToPortgroups.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.281Z",
    "updateTimestamp" : "2019-08-28T08:38:37.281Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ManagementClusterConfiguration",
    "processingStateDescription" : "Create Vsphere Cluster",
    "name" : "Detach ESXi Host vmnics from vSphere Standard Switch",
    "description" : "Create Vsphere Cluster",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "DetachVmnicFromVswitch.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "DetachVmnicFromVswitch.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.281Z",
    "updateTimestamp" : "2019-08-28T08:38:37.281Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ManagementClusterConfiguration",
    "processingStateDescription" : "Create Vsphere Cluster",
    "name" : "Attach ESXi Host vmnics to vSphere Distributed Switch",
    "description" : "Create Vsphere Cluster",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "AttachVmnicToDvs.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "AttachVmnicToDvs.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.281Z",
    "updateTimestamp" : "2019-08-28T08:38:37.281Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ManagementClusterConfiguration",
    "processingStateDescription" : "Create Vsphere Cluster",
    "name" : "Remove vSphere Standard Switch",
    "description" : "Create Vsphere Cluster",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "RemoveVswitch.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "RemoveVswitch.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.281Z",
    "updateTimestamp" : "2019-08-28T08:38:37.281Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ManagementClusterConfiguration",
    "processingStateDescription" : "Create Vsphere Cluster",
    "name" : "Update vSAN Hardware Compatability List (HCL) Database",
    "description" : "Create Vsphere Cluster",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "UpdateVsanHcl.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "UpdateVsanHcl.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.281Z",
    "updateTimestamp" : "2019-08-28T08:38:37.281Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ManagementClusterConfiguration",
    "processingStateDescription" : "Create Vsphere Cluster",
    "name" : "Enable vSAN",
    "description" : "Create Vsphere Cluster",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "EnableVsan.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "EnableVsan.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.281Z",
    "updateTimestamp" : "2019-08-28T08:38:37.281Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ManagementClusterConfiguration",
    "processingStateDescription" : "Create Vsphere Cluster",
    "name" : "Enable vSAN Deduplication on Cluster",
    "description" : "Create Vsphere Cluster",
    "localizableNamePack" : {
      "component" : "com.vmware.vcf.common.fsm.plugins.action.VspherePlugin",
      "messageKey" : "EnableVsanDedupOnClusterAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.vcf.common.fsm.plugins.action.VspherePlugin",
      "messageKey" : "EnableVsanDedupOnClusterAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.281Z",
    "updateTimestamp" : "2019-08-28T08:38:37.281Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ManagementClusterConfiguration",
    "processingStateDescription" : "Create Vsphere Cluster",
    "name" : "Enable vSAN Storage Policies",
    "description" : "Create Vsphere Cluster",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "EnableVsanPolicies.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "EnableVsanPolicies.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.281Z",
    "updateTimestamp" : "2019-08-28T08:38:37.281Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ManagementClusterConfiguration",
    "processingStateDescription" : "Create Vsphere Cluster",
    "name" : "Create vSAN Disk Groups",
    "description" : "Create Vsphere Cluster",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "VsanClaimDisks.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "VsanClaimDisks.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.281Z",
    "updateTimestamp" : "2019-08-28T08:38:37.281Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ManagementClusterConfiguration",
    "processingStateDescription" : "Create Vsphere Cluster",
    "name" : "Create Resource Pools in vCenter Server",
    "description" : "Create Vsphere Cluster",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "CreateResourcePool.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.vsphere.action.VsphereActionPlugin",
      "messageKey" : "CreateResourcePool.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.281Z",
    "updateTimestamp" : "2019-08-28T08:38:37.281Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ApplyEsxLicense",
    "processingStateDescription" : "Apply ESXi Host License Key",
    "name" : "Apply ESXi Host License Key",
    "description" : "Apply ESXi Host License Key",
    "localizableNamePack" : {
      "component" : "workflowconfig.ems_recipes.ApplyEsxLicense",
      "messageKey" : "ApplyEsxiLicenseInVcAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "workflowconfig.ems_recipes.ApplyEsxLicense",
      "messageKey" : "ApplyEsxiLicenseInVcAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.321Z",
    "updateTimestamp" : "2019-08-28T08:38:37.321Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ApplyEsxLicense",
    "processingStateDescription" : "Apply ESXi Host License Key",
    "name" : "Generate ESXi License Rename Input Data",
    "description" : "Apply ESXi Host License Key",
    "localizableNamePack" : {
      "component" : "workflowconfig.ems_recipes.ApplyEsxLicense",
      "messageKey" : "GenerateLicenseRenameInput.name"
    },
    "localizableDescriptionPack" : {
      "component" : "workflowconfig.ems_recipes.ApplyEsxLicense",
      "messageKey" : "GenerateLicenseRenameInput.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.321Z",
    "updateTimestamp" : "2019-08-28T08:38:37.321Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "ApplyEsxLicense",
    "processingStateDescription" : "Apply ESXi Host License Key",
    "name" : "Rename the Applied ESXi License in vCenter Server",
    "description" : "Apply ESXi Host License Key",
    "localizableNamePack" : {
      "component" : "workflowconfig.ems_recipes.ApplyEsxLicense",
      "messageKey" : "RenameLicense.name"
    },
    "localizableDescriptionPack" : {
      "component" : "workflowconfig.ems_recipes.ApplyEsxLicense",
      "messageKey" : "RenameLicense.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.321Z",
    "updateTimestamp" : "2019-08-28T08:38:37.321Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "NSXvConfiguration",
    "processingStateDescription" : "Deploy and Configure NSX for vSphere",
    "name" : "Deploy NSX Manager",
    "description" : "Deploy and Configure NSX for vSphere",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
      "messageKey" : "DeployNsxManager.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
      "messageKey" : "DeployNsxManager.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.328Z",
    "updateTimestamp" : "2019-08-28T08:38:37.328Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "NSXvConfiguration",
    "processingStateDescription" : "Deploy and Configure NSX for vSphere",
    "name" : "Generate and Install VMCA Certificate on NSX Manager",
    "description" : "Deploy and Configure NSX for vSphere",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
      "messageKey" : "UploadNsxManagerVmcaCert.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
      "messageKey" : "UploadNsxManagerVmcaCert.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.328Z",
    "updateTimestamp" : "2019-08-28T08:38:37.328Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "NSXvConfiguration",
    "processingStateDescription" : "Deploy and Configure NSX for vSphere",
    "name" : "Update NSX Manager TLS Settings",
    "description" : "Deploy and Configure NSX for vSphere",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
      "messageKey" : "UpdateNsxManagerTLSSettings.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
      "messageKey" : "UpdateNsxManagerTLSSettings.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.328Z",
    "updateTimestamp" : "2019-08-28T08:38:37.328Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "NSXvConfiguration",
    "processingStateDescription" : "Deploy and Configure NSX for vSphere",
    "name" : "Register NSX Manager with vCenter Server",
    "description" : "Deploy and Configure NSX for vSphere",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.action64.NsxServicePluginActionPlugin64",
      "messageKey" : "RegisterVcNsx.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.action64.NsxServicePluginActionPlugin64",
      "messageKey" : "RegisterVcNsx.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.328Z",
    "updateTimestamp" : "2019-08-28T08:38:37.328Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "NSXvConfiguration",
    "processingStateDescription" : "Deploy and Configure NSX for vSphere",
    "name" : "Apply NSX Dormant License File (DLF)",
    "description" : "Deploy and Configure NSX for vSphere",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
      "messageKey" : "UploadNsxDlf.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
      "messageKey" : "UploadNsxDlf.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.328Z",
    "updateTimestamp" : "2019-08-28T08:38:37.328Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "NSXvConfiguration",
    "processingStateDescription" : "Deploy and Configure NSX for vSphere",
    "name" : "Apply NSX License",
    "description" : "Deploy and Configure NSX for vSphere",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
      "messageKey" : "ApplyNsxLicense.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
      "messageKey" : "ApplyNsxLicense.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.328Z",
    "updateTimestamp" : "2019-08-28T08:38:37.328Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "NSXvConfiguration",
    "processingStateDescription" : "Deploy and Configure NSX for vSphere",
    "name" : "Generate NSX License Rename Input Data",
    "description" : "Deploy and Configure NSX for vSphere",
    "localizableNamePack" : {
      "component" : "workflowconfig.ems_recipes.NSXvConfiguration",
      "messageKey" : "GenerateLicenseRenameInputId.name"
    },
    "localizableDescriptionPack" : {
      "component" : "workflowconfig.ems_recipes.NSXvConfiguration",
      "messageKey" : "GenerateLicenseRenameInputId.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.328Z",
    "updateTimestamp" : "2019-08-28T08:38:37.328Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "NSXvConfiguration",
    "processingStateDescription" : "Deploy and Configure NSX for vSphere",
    "name" : "Rename the Applied NSX License in vCenter Server",
    "description" : "Deploy and Configure NSX for vSphere",
    "localizableNamePack" : {
      "component" : "workflowconfig.ems_recipes.NSXvConfiguration",
      "messageKey" : "RenameLicenseId.name"
    },
    "localizableDescriptionPack" : {
      "component" : "workflowconfig.ems_recipes.NSXvConfiguration",
      "messageKey" : "RenameLicenseId.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.328Z",
    "updateTimestamp" : "2019-08-28T08:38:37.328Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "NSXvConfiguration",
    "processingStateDescription" : "Deploy and Configure NSX for vSphere",
    "name" : "Generate NSX Manager Input Data",
    "description" : "Deploy and Configure NSX for vSphere",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.vvd.plugin.VvdPlugin",
      "messageKey" : "GenerateNsxInput.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.vvd.plugin.VvdPlugin",
      "messageKey" : "GenerateNsxInput.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.328Z",
    "updateTimestamp" : "2019-08-28T08:38:37.328Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "NSXvConfiguration",
    "processingStateDescription" : "Deploy and Configure NSX for vSphere",
    "name" : "Configure DNS on the NSX Controller Cluster",
    "description" : "Deploy and Configure NSX for vSphere",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.common.nsx.NsxManagerPlugin",
      "messageKey" : "ConfigureControllerDns.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.common.nsx.NsxManagerPlugin",
      "messageKey" : "ConfigureControllerDns.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.328Z",
    "updateTimestamp" : "2019-08-28T08:38:37.328Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "NSXvConfiguration",
    "processingStateDescription" : "Deploy and Configure NSX for vSphere",
    "name" : "Configure NTP on the NSX Controller Cluster",
    "description" : "Deploy and Configure NSX for vSphere",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.common.nsx.NsxManagerPlugin",
      "messageKey" : "ConfigureControllerNtp.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.common.nsx.NsxManagerPlugin",
      "messageKey" : "ConfigureControllerNtp.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.328Z",
    "updateTimestamp" : "2019-08-28T08:38:37.328Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "NSXvConfiguration",
    "processingStateDescription" : "Deploy and Configure NSX for vSphere",
    "name" : "Create NSX Controller Cluster",
    "description" : "Deploy and Configure NSX for vSphere",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
      "messageKey" : "DeployNsxController.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
      "messageKey" : "DeployNsxController.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.328Z",
    "updateTimestamp" : "2019-08-28T08:38:37.328Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "NSXvConfiguration",
    "processingStateDescription" : "Deploy and Configure NSX for vSphere",
    "name" : "Configure VXLAN Transport",
    "description" : "Deploy and Configure NSX for vSphere",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
      "messageKey" : "CreateVxlan.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
      "messageKey" : "CreateVxlan.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.328Z",
    "updateTimestamp" : "2019-08-28T08:38:37.328Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "NSXvConfiguration",
    "processingStateDescription" : "Deploy and Configure NSX for vSphere",
    "name" : "Resolve NSX Cluster Issues",
    "description" : "Deploy and Configure NSX for vSphere",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
      "messageKey" : "ResolveNsxClusterIssues.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
      "messageKey" : "ResolveNsxClusterIssues.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.328Z",
    "updateTimestamp" : "2019-08-28T08:38:37.328Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "NSXvConfiguration",
    "processingStateDescription" : "Deploy and Configure NSX for vSphere",
    "name" : "Set Universal Sync Role on NSX Manager",
    "description" : "Deploy and Configure NSX for vSphere",
    "localizableNamePack" : {
      "component" : "com.vmware.vcf.common.fsm.plugins.action.nsx.NsxPlugin",
      "messageKey" : "SetNsxRoleAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.vcf.common.fsm.plugins.action.nsx.NsxPlugin",
      "messageKey" : "SetNsxRoleAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.328Z",
    "updateTimestamp" : "2019-08-28T08:38:37.328Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "NSXvConfiguration",
    "processingStateDescription" : "Deploy and Configure NSX for vSphere",
    "name" : "Create NSX Segment Range",
    "description" : "Deploy and Configure NSX for vSphere",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
      "messageKey" : "CreateNsxSegmentRange.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
      "messageKey" : "CreateNsxSegmentRange.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.328Z",
    "updateTimestamp" : "2019-08-28T08:38:37.328Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "NSXvConfiguration",
    "processingStateDescription" : "Deploy and Configure NSX for vSphere",
    "name" : "Create NSX Multicast Range",
    "description" : "Deploy and Configure NSX for vSphere",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.plugin.ConfigureNsxPlugin",
      "messageKey" : "CreateMulticastRange.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.plugin.ConfigureNsxPlugin",
      "messageKey" : "CreateMulticastRange.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.328Z",
    "updateTimestamp" : "2019-08-28T08:38:37.328Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "NSXvConfiguration",
    "processingStateDescription" : "Deploy and Configure NSX for vSphere",
    "name" : "Create NSX Transport Zone",
    "description" : "Deploy and Configure NSX for vSphere",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
      "messageKey" : "CreateNsxTransportZone.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
      "messageKey" : "CreateNsxTransportZone.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.328Z",
    "updateTimestamp" : "2019-08-28T08:38:37.328Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "NSXvConfiguration",
    "processingStateDescription" : "Deploy and Configure NSX for vSphere",
    "name" : "Configure SSO on NSX Manager",
    "description" : "Deploy and Configure NSX for vSphere",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
      "messageKey" : "ConfigureSsoOnNSX.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
      "messageKey" : "ConfigureSsoOnNSX.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.328Z",
    "updateTimestamp" : "2019-08-28T08:38:37.328Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "GenerateLogInsightInput",
    "processingStateDescription" : "Generate vRealize Log Insight Input Data",
    "name" : "Generate vRealize Log Insight Input Data",
    "description" : "Generate vRealize Log Insight Input Data",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateLogInsightInput.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateLogInsightInput.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.359Z",
    "updateTimestamp" : "2019-08-28T08:38:37.359Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_LogInsightDeployment_DeployLogInsightPlugin_DeployLogInsightAction_1",
    "processingStateDescription" : "Deploy vRealize Log Insight",
    "name" : "Deploy vRealize Log Insight",
    "description" : "Deploy vRealize Log Insight",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.common.fsmplugins.loginsight.plugin.DeployLogInsightPlugin",
      "messageKey" : "DeployLogInsightAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.common.fsmplugins.loginsight.plugin.DeployLogInsightPlugin",
      "messageKey" : "DeployLogInsightAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.364Z",
    "updateTimestamp" : "2019-08-28T08:38:37.364Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_LogInsightDeployment_ConfigureLogInsightPlugin_AddLogInsightLicenseAction_2",
    "processingStateDescription" : "Apply vRealize Log Insight License",
    "name" : "Apply vRealize Log Insight License Action",
    "description" : "Apply vRealize Log Insight License",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.common.fsmplugins.loginsight.plugin.ConfigureLogInsightPlugin",
      "messageKey" : "AddLogInsightLicenseAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.common.fsmplugins.loginsight.plugin.ConfigureLogInsightPlugin",
      "messageKey" : "AddLogInsightLicenseAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.368Z",
    "updateTimestamp" : "2019-08-28T08:38:37.368Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_LogInsightDeployment_ConfigureLogInsightPlugin_BootstrapLogInsightClusterAction_3",
    "processingStateDescription" : "Bootstrap vRealize Log Insight Cluster",
    "name" : "Bootstrap vRealize Log Insight Cluster Action",
    "description" : "Bootstrap vRealize Log Insight Cluster",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.common.fsmplugins.loginsight.plugin.ConfigureLogInsightPlugin",
      "messageKey" : "BootstrapLogInsightClusterAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.common.fsmplugins.loginsight.plugin.ConfigureLogInsightPlugin",
      "messageKey" : "BootstrapLogInsightClusterAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.372Z",
    "updateTimestamp" : "2019-08-28T08:38:37.372Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_LogInsightDeployment_ConfigureLogInsightPlugin_GenerateLogInsightCertificateAction_4",
    "processingStateDescription" : "Generate and Install VMCA Certificate for vRealize Log Insight",
    "name" : "Generate and Install VMCA Certificate for vRealize Log Insight",
    "description" : "Generate and Install VMCA Certificate for vRealize Log Insight",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.common.fsmplugins.loginsight.plugin.ConfigureLogInsightPlugin",
      "messageKey" : "GenerateLogInsightCertificateAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.common.fsmplugins.loginsight.plugin.ConfigureLogInsightPlugin",
      "messageKey" : "GenerateLogInsightCertificateAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.377Z",
    "updateTimestamp" : "2019-08-28T08:38:37.377Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_LogInsightDeployment_ConfigureLogInsightPlugin_DisableTlsOnLogInsightAction_5",
    "processingStateDescription" : "Disable TLS 1.0 on vRealize Log Insight Nodes",
    "name" : "Disable TLS 1.0 on vRealize Log Insight Nodes Action",
    "description" : "Disable TLS 1.0 on vRealize Log Insight Nodes",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.common.fsmplugins.loginsight.plugin.ConfigureLogInsightPlugin",
      "messageKey" : "DisableTlsOnLogInsightAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.common.fsmplugins.loginsight.plugin.ConfigureLogInsightPlugin",
      "messageKey" : "DisableTlsOnLogInsightAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.381Z",
    "updateTimestamp" : "2019-08-28T08:38:37.381Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_LogInsightDeployment_ConfigureLogInsightPlugin_InstallContentPacksInLogInsightAction_6",
    "processingStateDescription" : "Install vRealize Log Insight Content Packs",
    "name" : "Install vRealize Log Insight Content Packs Action",
    "description" : "Install vRealize Log Insight Content Packs",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.common.fsmplugins.loginsight.plugin.ConfigureLogInsightPlugin",
      "messageKey" : "InstallContentPacksInLogInsightAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.common.fsmplugins.loginsight.plugin.ConfigureLogInsightPlugin",
      "messageKey" : "InstallContentPacksInLogInsightAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.385Z",
    "updateTimestamp" : "2019-08-28T08:38:37.385Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "GenerateNsxvLogInsightIntegrationInput",
    "processingStateDescription" : "Generate NsxvLogInsightIntegration input",
    "name" : "Generate NSX for vSphere Integration with vRealize Log Insight Input Data",
    "description" : "Generate NsxvLogInsightIntegration input",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateNsxvLogInsightIntegrationInput.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateNsxvLogInsightIntegrationInput.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.389Z",
    "updateTimestamp" : "2019-08-28T08:38:37.389Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_NsxvLogInsightIntegration_ConfigureSyslogInNsxPlugin_ConfigureSyslogInNsxManagerAction_1",
    "processingStateDescription" : "Configure Syslog Settings for NSX Manager",
    "name" : "Configure Syslog Settings for NSX Manager",
    "description" : "Configure Syslog Settings for NSX Manager",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.common.fsmplugins.loginsight.plugin.ConfigureSyslogInNsxPlugin",
      "messageKey" : "ConfigureSyslogInNsxManagerAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.common.fsmplugins.loginsight.plugin.ConfigureSyslogInNsxPlugin",
      "messageKey" : "ConfigureSyslogInNsxManagerAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.392Z",
    "updateTimestamp" : "2019-08-28T08:38:37.392Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_NsxvLogInsightIntegration_ConfigureSyslogInNsxPlugin_ConfigureSyslogInNsxControllerAction_2",
    "processingStateDescription" : "Configure Syslog Settings for NSX Controllers",
    "name" : "Configure Syslog Settings for NSX Controllers",
    "description" : "Configure Syslog Settings for NSX Controllers",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.common.fsmplugins.loginsight.plugin.ConfigureSyslogInNsxPlugin",
      "messageKey" : "ConfigureSyslogInNsxControllerAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.common.fsmplugins.loginsight.plugin.ConfigureSyslogInNsxPlugin",
      "messageKey" : "ConfigureSyslogInNsxControllerAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.396Z",
    "updateTimestamp" : "2019-08-28T08:38:37.396Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "GenerateSddcManagerInput",
    "processingStateDescription" : "Generate SDDC Manager Input Data",
    "name" : "Generate SDDC Manager Input Data",
    "description" : "Generate SDDC Manager Input Data",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateSddcManagerInput.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateSddcManagerInput.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.399Z",
    "updateTimestamp" : "2019-08-28T08:38:37.399Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_SDDCManagerConfiguration_SddcManagerContractPlugin_DeploySddcManagerOnClusterAction_1",
    "processingStateDescription" : "Deploy SDDC Manager",
    "name" : "Deploy SDDC Manager",
    "description" : "Deploy SDDC Manager",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.sddcmanager.SddcManagerContractPlugin",
      "messageKey" : "DeploySddcManagerOnClusterAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.sddcmanager.SddcManagerContractPlugin",
      "messageKey" : "DeploySddcManagerOnClusterAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.405Z",
    "updateTimestamp" : "2019-08-28T08:38:37.405Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_SDDCManagerConfiguration_SddcManagerContractPlugin_ConfigureLCMRepoOnSddcManagerAction_2",
    "processingStateDescription" : "Configure Lifecycle Management Repository on SDDC Manager",
    "name" : "Configure Lifecycle Management Repository on SDDC Manager",
    "description" : "Configure Lifecycle Management Repository on SDDC Manager",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.sddcmanager.SddcManagerContractPlugin",
      "messageKey" : "ConfigureLCMRepoOnSddcManagerAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.sddcmanager.SddcManagerContractPlugin",
      "messageKey" : "ConfigureLCMRepoOnSddcManagerAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.410Z",
    "updateTimestamp" : "2019-08-28T08:38:37.410Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_SDDCManagerConfiguration_HostPlugin_CreateNFSDatastoreOnHostsAction_3",
    "processingStateDescription" : "Mount Repository NFS Datastore on ESXi Hosts",
    "name" : "Mount Repository NFS Datastore on ESXi Hosts",
    "description" : "Mount Repository NFS Datastore on ESXi Hosts",
    "localizableNamePack" : {
      "component" : "com.vmware.vcf.common.fsm.plugins.action.HostPlugin",
      "messageKey" : "CreateNFSDatastoreOnHostsAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.vcf.common.fsm.plugins.action.HostPlugin",
      "messageKey" : "CreateNFSDatastoreOnHostsAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.414Z",
    "updateTimestamp" : "2019-08-28T08:38:37.414Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_SDDCManagerConfiguration_SddcManagerContractPlugin_ConfigureBaseImageRepoAction_4",
    "processingStateDescription" : "Configure Base Install Image Repository on SDDC Manager",
    "name" : "Configure Base Install Image Repository on SDDC Manager",
    "description" : "Configure Base Install Image Repository on SDDC Manager",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.sddcmanager.SddcManagerContractPlugin",
      "messageKey" : "ConfigureBaseImageRepoAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.sddcmanager.SddcManagerContractPlugin",
      "messageKey" : "ConfigureBaseImageRepoAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.417Z",
    "updateTimestamp" : "2019-08-28T08:38:37.417Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_SDDCManagerConfiguration_SddcManagerContractPlugin_InstallVmcaRootCertOnSddcManagerAction_5",
    "processingStateDescription" : "Install VMCA Root Certificate on SDDC Manager",
    "name" : "Install VMCA Root Certificate on SDDC Manager",
    "description" : "Install VMCA Root Certificate on SDDC Manager",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.sddcmanager.SddcManagerContractPlugin",
      "messageKey" : "InstallVmcaRootCertOnSddcManagerAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.sddcmanager.SddcManagerContractPlugin",
      "messageKey" : "InstallVmcaRootCertOnSddcManagerAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.421Z",
    "updateTimestamp" : "2019-08-28T08:38:37.421Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_SDDCManagerConfiguration_SddcManagerContractPlugin_InstallSddcManagerVmcaCertificateAction_6",
    "processingStateDescription" : "Generate and Install VMCA Certificate on SDDC Manager",
    "name" : "Generate and Install VMCA Certificate on SDDC Manager",
    "description" : "Generate and Install VMCA Certificate on SDDC Manager",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.sddcmanager.SddcManagerContractPlugin",
      "messageKey" : "InstallSddcManagerVmcaCertificateAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.sddcmanager.SddcManagerContractPlugin",
      "messageKey" : "InstallSddcManagerVmcaCertificateAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.425Z",
    "updateTimestamp" : "2019-08-28T08:38:37.425Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "GenerateInventoryForSddcManagerConfiguration",
    "processingStateDescription" : "Generate Inventory Data For SDDC Manager Configuration",
    "name" : "Generate Inventory data For SDDC Manager Configuration",
    "description" : "Generate Inventory Data For SDDC Manager Configuration",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateInventoryForSddcManagerConfiguration.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateInventoryForSddcManagerConfiguration.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.429Z",
    "updateTimestamp" : "2019-08-28T08:38:37.429Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_SDDCManagerPostInventory_SddcManagerContractPlugin_PostInventoryAndCredentialsAction_1",
    "processingStateDescription" : "Update SDDC Manager Inventory with Credential Details",
    "name" : "Update SDDC Manager Inventory with Credential Details",
    "description" : "Update SDDC Manager Inventory with Credential Details",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.sddcmanager.SddcManagerContractPlugin",
      "messageKey" : "PostInventoryAndCredentialsAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.sddcmanager.SddcManagerContractPlugin",
      "messageKey" : "PostInventoryAndCredentialsAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.433Z",
    "updateTimestamp" : "2019-08-28T08:38:37.433Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_SDDCManagerPostInventory_SddcManagerContractPlugin_PostNetworkPoolInventoryAction_2",
    "processingStateDescription" : "Update SDDC Manager Inventory with Network Pool Details",
    "name" : "Update SDDC Manager Inventory with Network Pool Details",
    "description" : "Update SDDC Manager Inventory with Network Pool Details",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.sddcmanager.SddcManagerContractPlugin",
      "messageKey" : "PostNetworkPoolInventoryAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.sddcmanager.SddcManagerContractPlugin",
      "messageKey" : "PostNetworkPoolInventoryAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.437Z",
    "updateTimestamp" : "2019-08-28T08:38:37.437Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_SDDCManagerPostInventory_SddcManagerContractPlugin_PostSddcLicenseInventoryAction_3",
    "processingStateDescription" : "Update SDDC Manager Inventory with License Details",
    "name" : "Update SDDC Manager Inventory with License Details",
    "description" : "Update SDDC Manager Inventory with License Details",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.sddcmanager.SddcManagerContractPlugin",
      "messageKey" : "PostSddcLicenseInventoryAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.sddcmanager.SddcManagerContractPlugin",
      "messageKey" : "PostSddcLicenseInventoryAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.441Z",
    "updateTimestamp" : "2019-08-28T08:38:37.441Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_SddcManagerKnownHostsConfiguration_ProxyContractPlugin_ProxyContractAction_17",
    "processingStateDescription" : "Automation Helper Action",
    "name" : "ProxyContractAction",
    "description" : "Automation Helper Action",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.orchestrator.core.recipes.spel.ProxyContractPlugin",
      "messageKey" : "ProxyContractAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.orchestrator.core.recipes.spel.ProxyContractPlugin",
      "messageKey" : "ProxyContractAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.444Z",
    "updateTimestamp" : "2019-08-28T08:38:37.444Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "GenerateSddcManagerInput",
    "processingStateDescription" : "Generate SDDC Manager Input Data",
    "name" : "Generate SDDC Manager Input Data",
    "description" : "Generate SDDC Manager Input Data",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateSddcManagerInput.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateSddcManagerInput.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.447Z",
    "updateTimestamp" : "2019-08-28T08:38:37.447Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "GenerateVsphereMachineSshEntities",
    "processingStateDescription" : "Generate ESXi Host SSH Key Input Data",
    "name" : "Generate ESXi Host SSH Key Input Data",
    "description" : "Generate ESXi Host SSH Key Input Data",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateVsphereMachineSshEntities.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateVsphereMachineSshEntities.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.453Z",
    "updateTimestamp" : "2019-08-28T08:38:37.453Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_SddcManagerKnownHostsConfiguration_VsphereContractPlugin_RotateMachineSshKeys_2",
    "processingStateDescription" : "Rotate ESXi Host SSH Keys",
    "name" : "Rotate ESXi Host SSH Keys",
    "description" : "Rotate ESXi Host SSH Keys",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.vsphere.contract.VsphereContractPlugin",
      "messageKey" : "RotateMachineSshKeys.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.vsphere.contract.VsphereContractPlugin",
      "messageKey" : "RotateMachineSshKeys.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.456Z",
    "updateTimestamp" : "2019-08-28T08:38:37.456Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_SddcManagerKnownHostsConfiguration_SddcManagerContractPlugin_UpdateKnownHostsOnSddcManager_3",
    "processingStateDescription" : "Update Known Hosts in SDDC Manager",
    "name" : "Update Known Hosts in SDDC Manager",
    "description" : "Update Known Hosts in SDDC Manager",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.sddcmanager.SddcManagerContractPlugin",
      "messageKey" : "UpdateKnownHostsOnSddcManager.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.sddcmanager.SddcManagerContractPlugin",
      "messageKey" : "UpdateKnownHostsOnSddcManager.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.459Z",
    "updateTimestamp" : "2019-08-28T08:38:37.459Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "GenerateVsphereInput",
    "processingStateDescription" : "Generate vSphere Input Data",
    "name" : "Generate vSphere Input Data",
    "description" : "Generate vSphere Input Data",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateVsphereInput.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateVsphereInput.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.462Z",
    "updateTimestamp" : "2019-08-28T08:38:37.462Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "GenerateSddcManagerInput",
    "processingStateDescription" : "Generate SDDC Manager Input Data",
    "name" : "Generate SDDC Manager Input Data",
    "description" : "Generate SDDC Manager Input Data",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateSddcManagerInput.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateSddcManagerInput.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.465Z",
    "updateTimestamp" : "2019-08-28T08:38:37.465Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_VcenterMessagesConfigurations_VsphereContractPlugin_PrepareVcenterMessages_2",
    "processingStateDescription" : "Generate Configure vCenter Login Message and Message of the Day Input Data",
    "name" : "Generate Configure vCenter Login Message and Message of the Day Input Data",
    "description" : "Generate Configure vCenter Login Message and Message of the Day Input Data",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.vsphere.contract.VsphereContractPlugin",
      "messageKey" : "PrepareVcenterMessages.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.vsphere.contract.VsphereContractPlugin",
      "messageKey" : "PrepareVcenterMessages.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.471Z",
    "updateTimestamp" : "2019-08-28T08:38:37.471Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_VcenterMessagesConfigurations_VsphereContractPlugin_ConfigureVcenterMessages_3",
    "processingStateDescription" : "Configure vCenter Login Message and Message of the Day",
    "name" : "Configure vCenter Login Message and Message of the Day",
    "description" : "Configure vCenter Login Message and Message of the Day",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.vsphere.contract.VsphereContractPlugin",
      "messageKey" : "ConfigureVcenterMessages.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.vsphere.contract.VsphereContractPlugin",
      "messageKey" : "ConfigureVcenterMessages.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.474Z",
    "updateTimestamp" : "2019-08-28T08:38:37.474Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "GenerateClusterConfigurationInput",
    "processingStateDescription" : "Generate Cluster Configuration Input Data",
    "name" : "Generate Post Cluster Configuration Input Data",
    "description" : "Generate Cluster Configuration Input Data",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateClusterConfigurationInput.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateClusterConfigurationInput.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.477Z",
    "updateTimestamp" : "2019-08-28T08:38:37.477Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "GenerateConfigureDeploymentDetailsActionInput",
    "processingStateDescription" : "Generate Configure Deployment Details Action Input Data",
    "name" : "Generate Configure Deployment Details Action Input Data",
    "description" : "Generate Configure Deployment Details Action Input Data",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateConfigureDeploymentDetailsActionInput.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateConfigureDeploymentDetailsActionInput.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.483Z",
    "updateTimestamp" : "2019-08-28T08:38:37.483Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_PostClusterConfiguration_VspherePlugin_MigrateVmsToFoldersAction_2",
    "processingStateDescription" : "Move VMs to VM Folders",
    "name" : "Move VMs to VM Folders",
    "description" : "Move VMs to VM Folders",
    "localizableNamePack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "MigrateVmsToFoldersAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "MigrateVmsToFoldersAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.486Z",
    "updateTimestamp" : "2019-08-28T08:38:37.486Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_PostClusterConfiguration_VspherePlugin_MigrateDvsToFolderAction_3",
    "processingStateDescription" : "Move vSphere Distributed Switch to Network Folder",
    "name" : "Move vSphere Distributed Switch to Network Folder",
    "description" : "Move vSphere Distributed Switch to Network Folder",
    "localizableNamePack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "MigrateDvsToFolderAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "MigrateDvsToFolderAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.489Z",
    "updateTimestamp" : "2019-08-28T08:38:37.489Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_PostClusterConfiguration_VspherePlugin_DisableVsanForceProvisionAction_4",
    "processingStateDescription" : "Disable vSAN Force Provisioning",
    "name" : "Disable vSAN Force Provisioning",
    "description" : "Disable vSAN Force Provisioning",
    "localizableNamePack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "DisableVsanForceProvisionAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "DisableVsanForceProvisionAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.492Z",
    "updateTimestamp" : "2019-08-28T08:38:37.492Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_PostClusterConfiguration_VspherePlugin_EnableVsanPoliciesAction_5",
    "processingStateDescription" : "Enable vSAN Storage Policies",
    "name" : "Enable vSAN Storage Policies",
    "description" : "Enable vSAN Storage Policies",
    "localizableNamePack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "EnableVsanPoliciesAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "EnableVsanPoliciesAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.496Z",
    "updateTimestamp" : "2019-08-28T08:38:37.496Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_PostClusterConfiguration_VspherePlugin_RelocateAllVmsToResourcePoolAction_6",
    "processingStateDescription" : "Move VMs to Resource Pools",
    "name" : "Move VMs to Resource Pools",
    "description" : "Move VMs to Resource Pools",
    "localizableNamePack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "RelocateAllVmsToResourcePoolAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "RelocateAllVmsToResourcePoolAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.499Z",
    "updateTimestamp" : "2019-08-28T08:38:37.499Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_PostClusterConfiguration_VspherePlugin_AdjustResourcePoolReservationAction_7",
    "processingStateDescription" : "Set Reservations on Resource Pools",
    "name" : "Set Reservations on Resource Pools",
    "description" : "Set Reservations on Resource Pools",
    "localizableNamePack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "AdjustResourcePoolReservationAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "AdjustResourcePoolReservationAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.502Z",
    "updateTimestamp" : "2019-08-28T08:38:37.502Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_PostClusterConfiguration_VcPlugin_EnableClusterHaAction_8",
    "processingStateDescription" : "Enable vSphere High Availability",
    "name" : "Enable vSphere High Availability",
    "description" : "Enable vSphere High Availability",
    "localizableNamePack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "EnableClusterHaAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "EnableClusterHaAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.505Z",
    "updateTimestamp" : "2019-08-28T08:38:37.505Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_PostClusterConfiguration_VcPlugin_CreateVmAntiAffinityRuleAction_9",
    "processingStateDescription" : "Create VM Anti-Affinity Rules",
    "name" : "Create VM Anti-Affinity Rules",
    "description" : "Create VM Anti-Affinity Rules",
    "localizableNamePack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "CreateVmAntiAffinityRuleAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "CreateVmAntiAffinityRuleAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.508Z",
    "updateTimestamp" : "2019-08-28T08:38:37.508Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_PostClusterConfiguration_CreatePscVcVmGroupsPlugin_CreatePscVcVmGroupsContractAction_10",
    "processingStateDescription" : "Create VM Groups",
    "name" : "Create VM Groups",
    "description" : "Create VM Groups",
    "localizableNamePack" : {
      "component" : "com.vmware.vcf.common.fsm.plugins.action.CreatePscVcVmGroupsPlugin",
      "messageKey" : "CreatePscVcVmGroupsContractAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.vcf.common.fsm.plugins.action.CreatePscVcVmGroupsPlugin",
      "messageKey" : "CreatePscVcVmGroupsContractAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.511Z",
    "updateTimestamp" : "2019-08-28T08:38:37.511Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_PostClusterConfiguration_VspherePlugin_CreateClusterVmsToVmsRuleContractAction_11",
    "processingStateDescription" : "Create VM-VM Startup Order Rule",
    "name" : "Create VM-VM Startup Order Rule",
    "description" : "Create VM-VM Startup Order Rule",
    "localizableNamePack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "CreateClusterVmsToVmsRuleContractAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "CreateClusterVmsToVmsRuleContractAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.514Z",
    "updateTimestamp" : "2019-08-28T08:38:37.514Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_PostClusterConfiguration_ClusterVmHostPlugin_CreateClusterHostGroupContractAction_12",
    "processingStateDescription" : "Create vCenter VM/Host RuleNsxServiceImpl.java",
    "name" : "Create vCenter VM/Host Rule",
    "description" : "Create vCenter VM/Host RuleNsxServiceImpl.java",
    "localizableNamePack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "CreateClusterHostGroupContractAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "CreateClusterHostGroupContractAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.517Z",
    "updateTimestamp" : "2019-08-28T08:38:37.517Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_PostClusterConfiguration_ClusterVmHostPlugin_CreateClusterVmHostRuleContractAction_13",
    "processingStateDescription" : "Create Platform Services Controller VM/Host Rule",
    "name" : "Create Platform Services Controller VM/Host Rule",
    "description" : "Create Platform Services Controller VM/Host Rule",
    "localizableNamePack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "CreatePSCVMHostRuleActionId.name"
    },
    "localizableDescriptionPack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "CreatePSCVMHostRuleActionId.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.520Z",
    "updateTimestamp" : "2019-08-28T08:38:37.520Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_PostClusterConfiguration_ClusterVmHostPlugin_CreateClusterVmHostRuleContractAction_14",
    "processingStateDescription" : "Create Cluster Rule",
    "name" : "Create Cluster Rule",
    "description" : "Create Cluster Rule",
    "localizableNamePack" : {
      "component" : "com.vmware.vcf.common.fsm.plugins.action.ClusterVmHostPlugin",
      "messageKey" : "CreateClusterVmHostRuleContractAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.vcf.common.fsm.plugins.action.ClusterVmHostPlugin",
      "messageKey" : "CreateClusterVmHostRuleContractAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.523Z",
    "updateTimestamp" : "2019-08-28T08:38:37.523Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_PostClusterConfiguration_VcPlugin_ConfigureEsxAdvancedOptionsAction_15",
    "processingStateDescription" : "Configure ESXi Advanced Options",
    "name" : "Configure ESXi Advanced Options",
    "description" : "Configure ESXi Advanced Options",
    "localizableNamePack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "ConfigureEsxAdvancedOptionsAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "ConfigureEsxAdvancedOptionsAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.526Z",
    "updateTimestamp" : "2019-08-28T08:38:37.526Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_PostClusterConfiguration_VspherePlugin_ReconfigureHAOnClusterAction_16",
    "processingStateDescription" : "Reconfigure vSphere High Availability",
    "name" : "Reconfigure vSphere High Availability",
    "description" : "Reconfigure vSphere High Availability",
    "localizableNamePack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "ReconfigureHAOnClusterAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "ReconfigureHAOnClusterAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.529Z",
    "updateTimestamp" : "2019-08-28T08:38:37.529Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_PostClusterConfiguration_VspherePlugin_ClearVsanAlarmsOnClusterAction_17",
    "processingStateDescription" : "Clear Alarms on vSAN",
    "name" : "Clear Alarms on vSAN",
    "description" : "Clear Alarms on vSAN",
    "localizableNamePack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "ClearVsanAlarmsOnClusterAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "ClearVsanAlarmsOnClusterAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.532Z",
    "updateTimestamp" : "2019-08-28T08:38:37.532Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_PostClusterConfiguration_VspherePlugin_ClearRedAlarmsOnHostAction_18",
    "processingStateDescription" : "Clear Alerts on Hosts",
    "name" : "Clear Alerts on Hosts",
    "description" : "Clear Alerts on Hosts",
    "localizableNamePack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "ClearRedAlarmsOnHostAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "workflowconfig.ems_recipes.PostClusterConfiguration",
      "messageKey" : "ClearRedAlarmsOnHostAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.535Z",
    "updateTimestamp" : "2019-08-28T08:38:37.535Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_PostClusterConfiguration_VspherePlugin_ConfigureDeploymentDetailsContractAction_19",
    "processingStateDescription" : "Set SDDC Deployment Details on the Management vCenter Server",
    "name" : "Set SDDC Deployment Details on the Management vCenter Server",
    "description" : "Set SDDC Deployment Details on the Management vCenter Server",
    "localizableNamePack" : {
      "component" : "com.vmware.vcf.common.fsm.plugins.action.VspherePlugin",
      "messageKey" : "ConfigureDeploymentDetailsContractAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.vcf.common.fsm.plugins.action.VspherePlugin",
      "messageKey" : "ConfigureDeploymentDetailsContractAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.539Z",
    "updateTimestamp" : "2019-08-28T08:38:37.539Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "GenerateVsphereInput",
    "processingStateDescription" : "Generate vSphere Input Data",
    "name" : "Generate vSphere Input Data",
    "description" : "Generate vSphere Input Data",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateVsphereInput.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateVsphereInput.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.542Z",
    "updateTimestamp" : "2019-08-28T08:38:37.542Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_DisableBashShellOnVcAndPsc_VsphereContractPlugin_DisableBashShell_1",
    "processingStateDescription" : "Disable Bash Shell on vCenter Server",
    "name" : "Disable Bash Shell on vCenter Server",
    "description" : "Disable Bash Shell on vCenter Server",
    "localizableNamePack" : {
      "component" : "workflowconfig.common_recipes.DisableBashShellOnVcAndPsc",
      "messageKey" : "DisableBashShellOnVCenterId.name"
    },
    "localizableDescriptionPack" : {
      "component" : "workflowconfig.common_recipes.DisableBashShellOnVcAndPsc",
      "messageKey" : "DisableBashShellOnVCenterId.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.545Z",
    "updateTimestamp" : "2019-08-28T08:38:37.545Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_DisableBashShellOnVcAndPsc_VsphereContractPlugin_DisableBashShell_2",
    "processingStateDescription" : "Disable Bash Shell on Platform Services Controllers",
    "name" : "Disable Bash Shell on Platform Services Controllers",
    "description" : "Disable Bash Shell on Platform Services Controllers",
    "localizableNamePack" : {
      "component" : "workflowconfig.common_recipes.DisableBashShellOnVcAndPsc",
      "messageKey" : "DisableBashShellOnPSCsId.name"
    },
    "localizableDescriptionPack" : {
      "component" : "workflowconfig.common_recipes.DisableBashShellOnVcAndPsc",
      "messageKey" : "DisableBashShellOnPSCsId.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.548Z",
    "updateTimestamp" : "2019-08-28T08:38:37.548Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "NSXvConfigurationForSDDCManager",
    "processingStateDescription" : "Configure NSX for vSphere",
    "name" : "Add VMs to NSX Distributed Firewall Exclusion List",
    "description" : "Configure NSX for vSphere",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
      "messageKey" : "AddVmsIntoDfwExclusionList.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.nsx.action63.NsxServicePluginActionPlugin63",
      "messageKey" : "AddVmsIntoDfwExclusionList.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.551Z",
    "updateTimestamp" : "2019-08-28T08:38:37.551Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "NSXBackupConfiguration",
    "processingStateDescription" : "Configure Backup on NSX for vSphere",
    "name" : "Configure NSX Manager Backups",
    "description" : "Configure Backup on NSX for vSphere",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.bringup.plugin.spi.LcmPlugin",
      "messageKey" : "ConfigureBackupForNSX.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.bringup.plugin.spi.LcmPlugin",
      "messageKey" : "ConfigureBackupForNSX.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.554Z",
    "updateTimestamp" : "2019-08-28T08:38:37.554Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "GenerateLogInsightInput",
    "processingStateDescription" : "Generate vRealize Log Insight Input Data",
    "name" : "Generate vRealize Log Insight Input Data",
    "description" : "Generate vRealize Log Insight Input Data",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateLogInsightInput.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.input.generation.InputGenerationPlugin",
      "messageKey" : "GenerateLogInsightInput.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.557Z",
    "updateTimestamp" : "2019-08-28T08:38:37.557Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_LogInsightConfiguration_ConfigureLogInsightAgentPlugin_ConfigureSddcManagerInLogInsightAction_1",
    "processingStateDescription" : "Configure Syslog Settings for SDDC Manager",
    "name" : "Configure Syslog Settings for SDDC Manager",
    "description" : "Configure Syslog Settings for SDDC Manager",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.common.fsmplugins.loginsight.plugin.ConfigureLogInsightAgentPlugin",
      "messageKey" : "ConfigureSddcManagerInLogInsightAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.common.fsmplugins.loginsight.plugin.ConfigureLogInsightAgentPlugin",
      "messageKey" : "ConfigureSddcManagerInLogInsightAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.561Z",
    "updateTimestamp" : "2019-08-28T08:38:37.561Z"
  }, {
    "sddcId" : "b285bfc6-8ef2-48d3-a8e2-4ccf921b1f1a",
    "processingStateName" : "_LogInsightConfiguration_ConfigureLogInsightAgentPlugin_ConfigureVCenterInLogInsightWithSyslogAction_2",
    "processingStateDescription" : "Configure Syslog Settings for vCenter Server",
    "name" : "Configure Syslog Settings for vCenter Server",
    "description" : "Configure Syslog Settings for vCenter Server",
    "localizableNamePack" : {
      "component" : "com.vmware.evo.sddc.common.fsmplugins.loginsight.plugin.ConfigureLogInsightAgentPlugin",
      "messageKey" : "ConfigureVCenterInLogInsightWithSyslogAction.name"
    },
    "localizableDescriptionPack" : {
      "component" : "com.vmware.evo.sddc.common.fsmplugins.loginsight.plugin.ConfigureLogInsightAgentPlugin",
      "messageKey" : "ConfigureVCenterInLogInsightWithSyslogAction.desc"
    },
    "status" : "INITIALIZED",
    "creationTimestamp" : "2019-08-28T08:38:37.565Z",
    "updateTimestamp" : "2019-08-28T08:38:37.565Z"
  } ]
}
Related APIs

Create SDDC
Retrieve all SDDCs
Retrieve a SDDC
Retry failed SDDC creation

2.2. Customer Experience Improvement Program

2.2.1. Get CEIP Status

Steps

  1. Invoke the API.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/system/ceip' -i -u 'admin:VMwareInfra@1' -X GET

HTTP Request

GET /v1/system/ceip HTTP/1.1
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==

HTTP Response

HTTP/1.1 200 OK
Content-Length: 83
Content-Type: application/json;charset=UTF-8

{
  "status" : "ENABLED",
  "instanceId" : "3f39d4a1-78d2-11e8-af85-f1cf26258cdc"
}
Related APIs

Update CEIP Status

2.2.2. Update CEIP Status

Steps

  1. Invoke the API.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/system/ceip' -i -u 'admin:VMwareInfra@1' -X PATCH \
    -H 'Content-Type: application/json' \
    -d '{
  "status" : "ENABLE"
}'

HTTP Request

PATCH /v1/system/ceip HTTP/1.1
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==
Content-Type: application/json
Content-Length: 25

{
  "status" : "ENABLE"
}

HTTP Response

HTTP/1.1 202 Accepted
Location: /v1/tasks/3f39d4a1-78d2-11e8-af85-f1cf26258cdc
Content-Type: application/json
Content-Length: 79

{
  "id" : "3f39d4a1-78d2-11e8-af85-f1cf26258cdc",
  "status" : "IN_PROGRESS"
}

  1. Track the task status using the "id" from the previous response. The GET URL is set in the header response and can be used directly. Refer to: Get a Task.

    • If the "status" is "IN_PROGRESS", the task is still in progress.

    • If the "status" is "SUCCESSFUL", the task is completed successfully.

    • If the "status" is "FAILED", the task can be re-executed.

Tip
 To retry task refer to: Retry a Task.
Related APIs

Get CEIP Status
Get a Task
Retry a Task

2.3. Network Pools

2.3.1. Create a Network Pool

  • Used to create a Network pool in the system. The added network pool would be used during domain deployments, host commission/expansion flows.

  • If a network pool which is already added before is added, you will get an error with HTTP status 400.

  • If a malformed network pool is added (payload for network parameters, name which is already exist), you will get an error.

Prerequisites

  1. The following data is required

    • Name

    • List of networks associated with network pool in which each network has

      • Network type - It can be VSAN, VMOTION or NFS Type.

      • VLAN ID - Valid Vlan id range is 0 to 4096.

      • MTU - Valid MTU range is 1500 to 9216.

      • Subnet - Networks of diferent types (e.g. VSAN/VMOTION/NFS) must not have overlapping subnets

      • Subnet mask

      • gateway - The gateway defined for the specified subnet

      • List of IP address ranges - the start and end IP address of each IP Pool should be part of the subnet

Steps

  1. Invoke the API

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/network-pools' -i -u 'admin:VMwareInfra@1' -X POST \
    -H 'Content-Type: application/json' \
    -d '{
  "name" : "engineering-networkpool",
  "networks" : [ {
    "type" : "VSAN",
    "vlanId" : 3002,
    "mtu" : 9001,
    "subnet" : "192.168.8.0",
    "mask" : "255.255.252.0",
    "gateway" : "192.168.8.1",
    "ipPools" : [ {
      "start" : "192.168.8.5",
      "end" : "192.168.8.8"
    } ]
  } ]
}'

HTTP Request

POST /v1/network-pools HTTP/1.1
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==
Content-Length: 304
Content-Type: application/json

{
  "name" : "engineering-networkpool",
  "networks" : [ {
    "type" : "VSAN",
    "vlanId" : 3002,
    "mtu" : 9001,
    "subnet" : "192.168.8.0",
    "mask" : "255.255.252.0",
    "gateway" : "192.168.8.1",
    "ipPools" : [ {
      "start" : "192.168.8.5",
      "end" : "192.168.8.8"
    } ]
  } ]
}

HTTP Response

HTTP/1.1 201 Created
Location: /v1/network-pools/b4822234-76d2-4068-a281-7c9ca0ee7347
Related APIs

Create a Network Pool

2.3.2. Get the Network Pools

Prerequisites

None

Steps

  1. Invoke the API

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/network-pools' -i -u 'admin:VMwareInfra@1' -X GET \
    -H 'Content-Type: application/json'

HTTP Request

GET /v1/network-pools HTTP/1.1
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==
Content-Type: application/json

HTTP Response

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 375

{
  "elements" : [ {
    "id" : "7e213359-512b-456d-935a-ad47f61642cd",
    "name" : "engineering-networkpool",
    "networks" : [ {
      "id" : "6b0033dc-8a7f-4a9c-8b64-139a9a15d326"
    } ]
  }, {
    "id" : "ad73b695-53b1-4cef-95a2-c39c8c48b2c4",
    "name" : "finance-networkpool",
    "networks" : [ {
      "id" : "cca551ce-8a8b-49ef-8ba6-ef0fbc21b696"
    } ]
  } ]
}
Related APIs

Get the Network Pools
Get a Network Pool
Get the Networks of a Network Pool
Get a Network of a Network Pool

2.3.3. Get a Network Pool

Prerequisites

  1. The following data is required

    • ID of the network pool

Steps

  1. Invoke the API

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/network-pools/ed8782d8-0cad-496b-a160-7ad990d16f87' -i -u 'admin:VMwareInfra@1' -X GET \
    -H 'Content-Type: application/json'

HTTP Request

GET /v1/network-pools/ed8782d8-0cad-496b-a160-7ad990d16f87 HTTP/1.1
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==
Content-Type: application/json

HTTP Response

HTTP/1.1 200 OK
Content-Length: 165
Content-Type: application/json;charset=UTF-8

{
  "id" : "ed8782d8-0cad-496b-a160-7ad990d16f87",
  "name" : "engineering-networkpool",
  "networks" : [ {
    "id" : "d34e9917-fa56-452b-b625-3f8b51a8e501"
  } ]
}
Related APIs

Get the Network Pools
Get a Network Pool
Get the Networks of a Network Pool
Get a Network of a Network Pool

2.3.4. Get a Network of a Network Pool

Prerequisites

  1. The following data is required

    • ID of the network

Steps

  1. Invoke the API

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/network-pools/e698c5ae-3803-4b5f-ae9b-4465a1d13d70/networks/9f5a1d72-5a4b-4965-808c-29e67f30ec11' -i -u 'admin:VMwareInfra@1' -X GET \
    -H 'Content-Type: application/json'

HTTP Response

HTTP/1.1 200 OK
Content-Length: 270
Content-Type: application/json;charset=UTF-8

{
  "id" : "9f5a1d72-5a4b-4965-808c-29e67f30ec11",
  "type" : "VSAN",
  "vlanId" : 3002,
  "mtu" : 9216,
  "subnet" : "192.168.8.0",
  "mask" : "255.255.252.0",
  "gateway" : "192.168.8.1",
  "ipPools" : [ {
    "start" : "192.168.8.5",
    "end" : "192.168.8.8"
  } ]
}
Related APIs

Get the Network Pools
Get a Network Pool
Get the Networks of a Network Pool
Get a Network of a Network Pool

2.3.5. Delete a Network Pool

  • Used to delete a Network pool.

  • Deleting a networkpool which is being used, will give an error.

  • Deleting a networkpool which does not exist, will give a HTTP response code 404.

Prerequisites

  1. The following data is required

    • ID of the network pool

Steps

  1. Invoke the API

Tip
 Refer to: Get the Network Pools to retrieve all network pools in the system and use the ID of network pool to be deleted.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/network-pools/c7c24fdd-a86f-4dfb-a93b-e1e7a01cfefb' -i -u 'admin:VMwareInfra@1' -X DELETE \
    -H 'Content-Type: application/json'

HTTP Request

DELETE /v1/network-pools/c7c24fdd-a86f-4dfb-a93b-e1e7a01cfefb HTTP/1.1
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==
Content-Type: application/json

HTTP Response

HTTP/1.1 204 No Content
Related APIs

Delete a Network Pool
Get the Network Pools
Get a Network Pool

2.3.6. Add an IP Pool to a Network of a Network Pool

Prerequisites

  1. The following data is required

    • ID of the network pool

Tip
 Refer to: Get the Network Pools

  • ID of the network.

Tip
 Refer to: Get a Network of a Network Pool

  • The start and end IP addresses for the IP pool

Steps

  1. Invoke the API

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/network-pools/025865b9-6663-490b-92a8-c5ab0bec6f6b/networks/46385fad-c925-4873-8410-678d2d470f3d/ip-pools' -i -u 'admin:VMwareInfra@1' -X POST \
    -H 'Content-Type: application/json' \
    -d '{
  "start" : "192.168.8.5",
  "end" : "192.168.8.8"
}'
Request Body
POST /v1/network-pools/025865b9-6663-490b-92a8-c5ab0bec6f6b/networks/46385fad-c925-4873-8410-678d2d470f3d/ip-pools HTTP/1.1
Content-Length: 54
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==
Content-Type: application/json

{
  "start" : "192.168.8.5",
  "end" : "192.168.8.8"
}
Response Body
HTTP/1.1 200 OK
Content-Length: 270
Content-Type: application/json;charset=UTF-8

{
  "id" : "2d64834e-9eb7-42ae-905c-83cfb9dbbc9a",
  "type" : "VSAN",
  "vlanId" : 3002,
  "mtu" : 9216,
  "subnet" : "192.168.8.0",
  "mask" : "255.255.252.0",
  "gateway" : "192.168.8.1",
  "ipPools" : [ {
    "start" : "192.168.8.5",
    "end" : "192.168.8.8"
  } ]
}
Related APIs

Add an IP Pool to a Network of a Network Pool
Get the Network Pools
Get a Network Pool
Get the Networks of a Network Pool
Get a Network of a Network Pool

2.3.7. Delete an IP Pool from a Network of a Network Pool

Prerequisites

  1. The following data is required

    • ID of the IP pool

Steps

  1. Invoke the API

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/network-pools/9b077b48-fdbd-4d01-b55d-701543aaf0f9/networks/9d58ec4c-f0d1-4f3c-a3d6-a3c7b9dae171/ip-pools' -i -u 'admin:VMwareInfra@1' -X DELETE \
    -H 'Content-Type: application/json' \
    -d '{
  "start" : "192.168.8.5",
  "end" : "192.168.8.8"
}'
Response Body
DELETE /v1/network-pools/9b077b48-fdbd-4d01-b55d-701543aaf0f9/networks/9d58ec4c-f0d1-4f3c-a3d6-a3c7b9dae171/ip-pools HTTP/1.1
Content-Length: 54
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==
Content-Type: application/json

{
  "start" : "192.168.8.5",
  "end" : "192.168.8.8"
}
Response Body
HTTP/1.1 204 No Content
Related APIs

Delete an IP Pool from a Network of a Network Pool
Get the Network Pools
Get a Network Pool
Get the Networks of a Network Pool
Get a Network of a Network Pool

2.4. Tasks

2.4.1. Get the Tasks

Prerequisites

None

Steps

  1. Invoke the API

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/tasks' -i -u 'admin:VMwareInfra@1' -X GET \
    -H 'Content-Type: application/json'

HTTP Request

GET /v1/tasks HTTP/1.1
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==
Content-Type: application/json

HTTP Response

HTTP/1.1 200 OK
Content-Length: 1808
Content-Type: application/json;charset=UTF-8

{
  "elements" : [ {
    "id" : "d685266a-b544-4295-86fd-bc8cee3fa297",
    "name" : "Commissioning host(s) esxi-5.vrack.vsphere.local to VMware Cloud Foundation",
    "status" : "Failed",
    "creationTimestamp" : "2019-06-20T12:03:18.890Z",
    "subTasks" : [ {
      "name" : "HostVibValidationAction",
      "description" : "Validate the hosts for any disallowed VIBS",
      "status" : "SUCCESSFUL",
      "creationTimestamp" : "2019-06-20T12:03:18.890Z"
    }, {
      "name" : "HostMaintenanceModeValidationAction",
      "description" : "Verifies that none of the hosts are in maintenance mode",
      "status" : "FAILED",
      "creationTimestamp" : "2019-06-20T12:03:18.890Z"
    }, {
      "name" : "FetchDnsAndNtpAction",
      "description" : "Fetches DNS \\u0026 NTP IPs",
      "status" : "PENDING",
      "creationTimestamp" : "2019-06-20T12:03:18.890Z"
    } ],
    "errors" : [ {
      "errorCode" : "COMMISION_HOST_FAILED",
      "message" : "Failed to Commissioning host(s) esxi-5.vrack.vsphere.local to VMware Cloud Foundation"
    } ],
    "resources" : [ {
      "resourceId" : "b9f8552e-535a-4d3a-b826-99cf69f0a7e6",
      "type" : "HOST"
    } ],
    "isCancellable" : false
  }, {
    "id" : "d9c054a7-81e9-4d7b-8574-fe7b0c3fd2cc",
    "name" : "Credentials rotate operation",
    "status" : "Successful",
    "creationTimestamp" : "2019-06-20T12:03:18.890Z",
    "subTasks" : [ {
      "name" : "sddc-manager.vrack.vsphere.local:FTP",
      "description" : "Password rotate for sddc-manager.vrack.vsphere.local and credential type FTP",
      "status" : "SUCCESSFUL",
      "creationTimestamp" : "2019-06-20T12:03:18.890Z"
    } ],
    "resources" : [ {
      "resourceId" : "2191f134-fa4b-4226-9d64-e646f72892b2",
      "type" : "HOST"
    } ],
    "isCancellable" : false
  } ]
}
Related APIs

Get the Tasks
Get a Task

2.4.2. Get a Task

Prerequisites

  1. The following data is required

    • ID of the task

Steps

  1. Invoke the API

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/tasks/f09ffa27-9da6-41fd-a75a-50e6549d02c6' -i -u 'admin:VMwareInfra@1' -X GET \
    -H 'Content-Type: application/json'

HTTP Request

GET /v1/tasks/f09ffa27-9da6-41fd-a75a-50e6549d02c6 HTTP/1.1
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==
Content-Type: application/json

HTTP Response

HTTP/1.1 200 OK
Content-Length: 905
Content-Type: application/json;charset=UTF-8

{
  "id" : "f09ffa27-9da6-41fd-a75a-50e6549d02c6",
  "name" : "Vi workload Domain Creation",
  "status" : "FAILED",
  "creationTimestamp" : "1970-01-19T04:20:54.836Z",
  "subTasks" : [ {
    "name" : "HostVibValidationAction",
    "description" : "Validate the hosts for any disallowed VIBS",
    "status" : "SUCCESSFUL",
    "creationTimestamp" : "2019-06-20T12:03:18.890Z"
  }, {
    "name" : "HostMaintenanceModeValidationAction",
    "description" : "Verifies that none of the hosts are in maintenance mode",
    "status" : "FAILED",
    "creationTimestamp" : "2019-06-20T12:03:18.890Z"
  }, {
    "name" : "FetchDnsAndNtpAction",
    "description" : "Fetches DNS \\u0026 NTP IPs",
    "status" : "PENDING",
    "creationTimestamp" : "2019-06-20T12:03:18.890Z"
  } ],
  "resources" : [ {
    "resourceId" : "d1662e07-8698-47eb-849b-9a1121121fc3",
    "type" : "HOST"
  } ],
  "isCancellable" : false
}
Related APIs

Get the Tasks
Get a Task

2.4.3. Retry a Task

Used to retry a failed task/workflow.

Prerequisites

  1. The following data is required

    • ID of the failed task

Steps

  1. Invoke the API

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/tasks/64cf103a-cfe3-4924-9702-e4e83fcff0c0' -i -u 'admin:VMwareInfra@1' -X PATCH \
    -H 'Content-Type: application/json'

HTTP Request

PATCH /v1/tasks/64cf103a-cfe3-4924-9702-e4e83fcff0c0 HTTP/1.1
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==
Content-Type: application/json

HTTP Response

HTTP/1.1 200 OK
Note
 The credentials' update/rotate password tasks cannot be retried using this API. Refer to Retry a failed credentials task for a given ID section.
Related APIs

Get the Tasks
Get a Task

2.5. Hosts

2.5.1. Commission the Hosts

Prerequisites

  1. The following data is required

    • Username of each host

    • Password of each host

    • FQDN of each host

    • Network pool name to which each host has to be associated with (Optional)

    • Network pool ID to which each host has to be associated with

Tip
 Refer to: Get the Network Pools and Get a Network of a Network Pool

  1. The host, if intended to be used for a vSAN domain, should be vSAN compliant and certified as per the VMware Hardware Compatibility Guide.

  2. BIOS, HBA, SSD, HDD, etc. of the host must match the VMware Hardware Compatibility Guide.

  3. The host must have the drivers and firmware versions specified in the VMware Hardware Compatibility Guide.

  4. The host must have the supported version of ESXi (i.e 6.7.0-13006603) pre-installed on it.

  5. SSH and syslog must be enabled on the host.

  6. The host must be configured with DNS server for forward and reverse lookup and FQDN.

  7. The host name must be same as the FQDN.

  8. The host must have a standard switch with two NIC ports with a minimum 10 Gbps speed.

  9. The management IP must be configured to the first NIC port.

  10. Ensure that the host has a standard switch and the default uplinks with 10Gb speed are configured starting with traditional numbering (e.g., vmnic0) and increasing sequentially.

  11. Ensure that the host hardware health status is healthy without any errors.

  12. All disk partitions on HDD / SSD are deleted.

  13. The hosts, if intended to be used for vSAN, domain must be associated with vSAN enabled network pool.

  14. The hosts, if intended to be used for NFS, domain must be associated with NFS enabled network pool.

  15. The hosts, if intended to be used for VMFS on FC, domain must be associated with either a NFS enabled or vMotion enabled network pool.

Steps

  1. Validate the input specification.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/hosts/validations' -i -u 'admin:VMwareInfra@1' -X POST \
    -H 'Content-Type: application/json' \
    -d '{
  "hostCommissionSpecs" : [ {
    "fqdn" : "esfo01m01esx01.sfo01.rainpole.local",
    "username" : "root",
    "password" : "VMwareInfra@1",
    "storageType" : "VSAN",
    "networkPoolId" : "58d74167-ee80-4eb8-90d9-cdfb3c1cd9f3",
    "networkPoolName" : "engineering-networkpool"
  }, {
    "fqdn" : "esfo01m01esx02.sfo01.rainpole.local",
    "username" : "root",
    "password" : "VMwareInfra@1",
    "storageType" : "VSAN",
    "networkPoolId" : "1ff2838a-1983-4747-a94d-d30b2d13a973",
    "networkPoolName" : "finance-networkpool"
  } ]
}'

HTTP Request

POST /v1/hosts/validations HTTP/1.1
Host: sddc-manager.sfo01.rainpole.local
Content-Length: 544
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==
Content-Type: application/json

{
  "hostCommissionSpecs" : [ {
    "fqdn" : "esfo01m01esx01.sfo01.rainpole.local",
    "username" : "root",
    "password" : "VMwareInfra@1",
    "storageType" : "VSAN",
    "networkPoolId" : "58d74167-ee80-4eb8-90d9-cdfb3c1cd9f3",
    "networkPoolName" : "engineering-networkpool"
  }, {
    "fqdn" : "esfo01m01esx02.sfo01.rainpole.local",
    "username" : "root",
    "password" : "VMwareInfra@1",
    "storageType" : "VSAN",
    "networkPoolId" : "1ff2838a-1983-4747-a94d-d30b2d13a973",
    "networkPoolName" : "finance-networkpool"
  } ]
}

HTTP Response

HTTP/1.1 202 Accepted
Location: /v1/hosts/validations/0ac71edb-4ed3-443e-8f9f-7bbb806b7cac
Content-Type: application/json;charset=UTF-8
Content-Length: 542

{
  "id" : "0ac71edb-4ed3-443e-8f9f-7bbb806b7cac",
  "description" : "Validate input specification to commission one or more hosts to VMware Cloud Foundation",
  "executionStatus" : "IN_PROGRESS",
  "validationChecks" : [ {
    "description" : "Validating input specification",
    "resultStatus" : "UNKNOWN"
  }, {
    "description" : "Validating host esfo01m01esx01.sfo01.rainpole.local",
    "resultStatus" : "UNKNOWN"
  }, {
    "description" : "Validating host esfo01m01esx02.sfo01.rainpole.local",
    "resultStatus" : "UNKNOWN"
  } ]
}

  1. Poll until "executionStatus" is not "IN_PROGRESS" using the "id" from the previous response.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/hosts/validations/0ac71edb-4ed3-443e-8f9f-7bbb806b7cac' -i -u 'admin:VMwareInfra@1' -X GET \
    -H 'Content-Type: application/json'

HTTP Request

GET /v1/hosts/validations/0ac71edb-4ed3-443e-8f9f-7bbb806b7cac HTTP/1.1
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==
Content-Type: application/json

HTTP Response

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 452

{
  "id" : "0ac71edb-4ed3-443e-8f9f-7bbb806b7cac",
  "description" : "Validate input specification to commission one or more hosts to VMware Cloud Foundation",
  "executionStatus" : "IN_PROGRESS",
  "validationChecks" : [ {
    "description" : "Validating host esfo01m01esx01.sfo01.rainpole.local",
    "resultStatus" : "SUCCEEDED"
  }, {
    "description" : "Validating host esfo01m01esx02.sfo01.rainpole.local",
    "resultStatus" : "UNKNOWN"
  } ]
}

  1. In case of no errors in the input specification, the "executionStatus" is "COMPLETED" and "resultStatus" is "SUCCEEDED".

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/hosts/validations/0ac71edb-4ed3-443e-8f9f-7bbb806b7cac' -i -u 'admin:VMwareInfra@1' -X GET \
    -H 'Content-Type: application/json'

HTTP Request

GET /v1/hosts/validations/0ac71edb-4ed3-443e-8f9f-7bbb806b7cac HTTP/1.1
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==
Content-Type: application/json

HTTP Response

HTTP/1.1 200 OK
Content-Length: 484
Content-Type: application/json;charset=UTF-8

{
  "id" : "0ac71edb-4ed3-443e-8f9f-7bbb806b7cac",
  "description" : "Validate input specification to commission one or more hosts to VMware Cloud Foundation",
  "executionStatus" : "COMPLETED",
  "resultStatus" : "SUCCEEDED",
  "validationChecks" : [ {
    "description" : "Validating host esfo01m01esx01.sfo01.rainpole.local",
    "resultStatus" : "SUCCEEDED"
  }, {
    "description" : "Validating host esfo01m01esx02.sfo01.rainpole.local",
    "resultStatus" : "SUCCEEDED"
  } ]
}

  1. In case of errors in the input specification, the "executionStatus" is "COMPLETED" and "resultStatus" is "FAILED".

Note
 Make changes to the input specification and re-validate using a new API invocation.

  1. Trigger the task using the valid input specification.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/hosts' -i -u 'admin:VMwareInfra@1' -X POST \
    -H 'Content-Type: application/json' \
    -d '[ {
  "fqdn" : "esfo01m01esx01.sfo01.rainpole.local",
  "username" : "root",
  "password" : "VMwareInfra@1",
  "storageType" : "VSAN",
  "networkPoolId" : "58d74167-ee80-4eb8-90d9-cdfb3c1cd9f3",
  "networkPoolName" : "engineering-networkpool"
}, {
  "fqdn" : "esfo01m01esx02.sfo01.rainpole.local",
  "username" : "root",
  "password" : "VMwareInfra@1",
  "storageType" : "VSAN",
  "networkPoolId" : "1ff2838a-1983-4747-a94d-d30b2d13a973",
  "networkPoolName" : "finance-networkpool"
} ]'

HTTP Request

POST /v1/hosts HTTP/1.1
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==
Content-Type: application/json
Content-Length: 486

[ {
  "fqdn" : "esfo01m01esx01.sfo01.rainpole.local",
  "username" : "root",
  "password" : "VMwareInfra@1",
  "storageType" : "VSAN",
  "networkPoolId" : "58d74167-ee80-4eb8-90d9-cdfb3c1cd9f3",
  "networkPoolName" : "engineering-networkpool"
}, {
  "fqdn" : "esfo01m01esx02.sfo01.rainpole.local",
  "username" : "root",
  "password" : "VMwareInfra@1",
  "storageType" : "VSAN",
  "networkPoolId" : "1ff2838a-1983-4747-a94d-d30b2d13a973",
  "networkPoolName" : "finance-networkpool"
} ]

HTTP Response

HTTP/1.1 202 Accepted
Location: /v1/tasks/9c342403-d05e-4b22-a89d-51d206ce9c1a
Content-Type: application/json;charset=UTF-8
Content-Length: 79

{
  "id" : "9c342403-d05e-4b22-a89d-51d206ce9c1a",
  "status" : "IN_PROGRESS"
}

  1. Poll the task until "status" is not "IN_PROGRESS" using the "id" from the previous response.

Tip
 Refer to: Get a Task.

  • If the "status" is "SUCCESSFUL", the task is completed successfully.

  • If the "status" is "FAILED", the task can be re-executed.

Tip
 Refer to: Retry a Task.
Related APIs

Validate the input spec for hosts operations
Get the status of the validation of the input specification to commission the Hosts
Commission the Hosts
Get a Task
Retry a Task
Get the Network Pools
Get the Networks of a Network Pool
Get a Network of a Network Pool
Create a Network Pool
Add an IP Pool to a Network of a Network Pool
Delete an IP Pool from a Network of a Network Pool

2.5.2. Get the Hosts

Prerequisites

None

Get All Hosts

Steps

  1. Invoke the API.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/hosts' -i -u 'admin:VMwareInfra@1' -X GET \
    -H 'Accept: application/json'

HTTP Request

GET /v1/hosts HTTP/1.1
Accept: application/json
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==

HTTP Response

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 4077

{
  "elements" : [ {
    "id" : "c0703437-6746-470b-9e1c-f9d3bbc9b1c1",
    "esxiVersion" : "6.7.0-13006603",
    "fqdn" : "esfo01m01esx01.sfo01.rainpole.local",
    "hardwareVendor" : "VMware, Inc.",
    "hardwareModel" : "VMware Virtual Platform",
    "ipAddresses" : [ {
      "ipAddress" : "10.0.0.100",
      "type" : "MANAGEMENT"
    } ],
    "cpu" : {
      "frequencyMHz" : 4994.0,
      "cores" : 2,
      "cpuCores" : [ {
        "frequencyMHz" : 2497.0,
        "model" : "Intel(R) Xeon(R) CPU E5-2680 v3 @ 2.50GHz",
        "manufacturer" : "Intel"
      }, {
        "frequencyMHz" : 2497.0,
        "model" : "Intel(R) Xeon(R) CPU E5-2680 v3 @ 2.50GHz",
        "manufacturer" : "Intel"
      } ]
    },
    "memory" : {
      "totalCapacityMB" : 79999.0
    },
    "storage" : {
      "totalCapacityMB" : 781250.0,
      "disks" : [ {
        "capacityMB" : 390625.0,
        "diskType" : "HDD"
      }, {
        "capacityMB" : 390625.0,
        "diskType" : "FLASH"
      } ]
    },
    "physicalNics" : [ {
      "deviceName" : "vmnic0",
      "macAddress" : "02:00:1b:31:93:d2"
    }, {
      "deviceName" : "vmnic1",
      "macAddress" : "02:00:1b:31:93:d3"
    } ],
    "domain" : {
      "id" : "377236f7-4965-4179-895e-eeb4eb9a6ad1"
    },
    "networkpool" : {
      "id" : "1205afdd-84f5-403e-a052-1a9bba09ef41"
    },
    "cluster" : {
      "id" : "4205afdd-94f5-403e-a051-1a9bba09ef40"
    },
    "status" : "ASSIGNED",
    "compatibleStorageType" : "VMFS_FC"
  }, {
    "id" : "8045e44e-974e-4f43-9862-7f0326782638",
    "esxiVersion" : "6.5.0-13006603",
    "fqdn" : "esfo01m01esx02.sfo01.rainpole.local",
    "hardwareVendor" : "VMware, Inc.",
    "hardwareModel" : "VMware Virtual Platform",
    "ipAddresses" : [ {
      "ipAddress" : "10.0.0.101",
      "type" : "MANAGEMENT"
    } ],
    "cpu" : {
      "frequencyMHz" : 4994.0,
      "cores" : 2,
      "cpuCores" : [ {
        "frequencyMHz" : 2497.0,
        "model" : "Intel(R) Xeon(R) CPU E5-2680 v3 @ 2.50GHz",
        "manufacturer" : "Intel"
      }, {
        "frequencyMHz" : 2497.0,
        "model" : "Intel(R) Xeon(R) CPU E5-2680 v3 @ 2.50GHz",
        "manufacturer" : "Intel"
      } ]
    },
    "memory" : {
      "totalCapacityMB" : 79999.0
    },
    "storage" : {
      "totalCapacityMB" : 781250.0,
      "disks" : [ {
        "capacityMB" : 390625.0,
        "diskType" : "HDD"
      }, {
        "capacityMB" : 390625.0,
        "diskType" : "FLASH"
      } ]
    },
    "physicalNics" : [ {
      "deviceName" : "vmnic0",
      "macAddress" : "02:00:1b:31:93:d2"
    }, {
      "deviceName" : "vmnic1",
      "macAddress" : "02:00:1b:31:93:d3"
    } ],
    "networkpool" : {
      "id" : "1205afdd-84f5-403e-a052-1a9bba09ef41"
    },
    "status" : "UNASSIGNED_USEABLE"
  }, {
    "id" : "8045e44e-974e-4f43-9862-7f0326782638",
    "esxiVersion" : "6.5.0-13006603",
    "fqdn" : "esfo01m01esx03.sfo01.rainpole.local",
    "hardwareVendor" : "VMware, Inc.",
    "hardwareModel" : "VMware Virtual Platform",
    "ipAddresses" : [ {
      "ipAddress" : "10.0.0.102",
      "type" : "MANAGEMENT"
    } ],
    "cpu" : {
      "frequencyMHz" : 4994.0,
      "cores" : 2,
      "cpuCores" : [ {
        "frequencyMHz" : 2497.0,
        "model" : "Intel(R) Xeon(R) CPU E5-2680 v3 @ 2.50GHz",
        "manufacturer" : "Intel"
      }, {
        "frequencyMHz" : 2497.0,
        "model" : "Intel(R) Xeon(R) CPU E5-2680 v3 @ 2.50GHz",
        "manufacturer" : "Intel"
      } ]
    },
    "memory" : {
      "totalCapacityMB" : 79999.0
    },
    "storage" : {
      "totalCapacityMB" : 781250.0,
      "disks" : [ {
        "capacityMB" : 390625.0,
        "diskType" : "HDD"
      }, {
        "capacityMB" : 390625.0,
        "diskType" : "FLASH"
      } ]
    },
    "physicalNics" : [ {
      "deviceName" : "vmnic0",
      "macAddress" : "02:00:1b:31:93:d2"
    }, {
      "deviceName" : "vmnic1",
      "macAddress" : "02:00:1b:31:93:d3"
    } ],
    "networkpool" : {
      "id" : "1205afdd-84f5-403e-a052-1a9bba09ef41"
    },
    "status" : "UNASSIGNED_UNUSEABLE"
  } ]
}

Get ASSIGNED Hosts

This API can be used to fetch all the hosts that are currently assigned to any domain and hence cannot be used for other domain tasks

Steps

  1. Invoke the API by specifying the "status" as "ASSIGNED".

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/hosts?status=ASSIGNED' -i -u 'admin:VMwareInfra@1' -X GET \
    -H 'Accept: application/json'

HTTP Request

GET /v1/hosts?status=ASSIGNED HTTP/1.1
Accept: application/json
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==

HTTP Response

HTTP/1.1 200 OK
Content-Length: 1495
Content-Type: application/json;charset=UTF-8

{
  "elements" : [ {
    "id" : "c0703437-6746-470b-9e1c-f9d3bbc9b1c1",
    "esxiVersion" : "6.7.0-13006603",
    "fqdn" : "esfo01m01esx01.sfo01.rainpole.local",
    "hardwareVendor" : "VMware, Inc.",
    "hardwareModel" : "VMware Virtual Platform",
    "ipAddresses" : [ {
      "ipAddress" : "10.0.0.100",
      "type" : "MANAGEMENT"
    } ],
    "cpu" : {
      "frequencyMHz" : 4994.0,
      "cores" : 2,
      "cpuCores" : [ {
        "frequencyMHz" : 2497.0,
        "model" : "Intel(R) Xeon(R) CPU E5-2680 v3 @ 2.50GHz",
        "manufacturer" : "Intel"
      }, {
        "frequencyMHz" : 2497.0,
        "model" : "Intel(R) Xeon(R) CPU E5-2680 v3 @ 2.50GHz",
        "manufacturer" : "Intel"
      } ]
    },
    "memory" : {
      "totalCapacityMB" : 79999.0
    },
    "storage" : {
      "totalCapacityMB" : 781250.0,
      "disks" : [ {
        "capacityMB" : 390625.0,
        "diskType" : "HDD"
      }, {
        "capacityMB" : 390625.0,
        "diskType" : "FLASH"
      } ]
    },
    "physicalNics" : [ {
      "deviceName" : "vmnic0",
      "macAddress" : "02:00:1b:31:93:d2"
    }, {
      "deviceName" : "vmnic1",
      "macAddress" : "02:00:1b:31:93:d3"
    } ],
    "domain" : {
      "id" : "377236f7-4965-4179-895e-eeb4eb9a6ad1"
    },
    "networkpool" : {
      "id" : "1205afdd-84f5-403e-a052-1a9bba09ef41"
    },
    "cluster" : {
      "id" : "4205afdd-94f5-403e-a051-1a9bba09ef40"
    },
    "status" : "ASSIGNED",
    "compatibleStorageType" : "VMFS_FC"
  } ]
}

Get UNASSIGNED_USEABLE Hosts

This API can be used to fetch all the hosts that are currently not assigned to any domain and hence can be used for other domain tasks

Steps

  1. Invoke the API by specifying the "status" as "UNASSIGNED_USEABLE".

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/hosts?status=UNASSIGNED_USEABLE' -i -u 'admin:VMwareInfra@1' -X GET \
    -H 'Accept: application/json'

HTTP Request

GET /v1/hosts?status=UNASSIGNED_USEABLE HTTP/1.1
Accept: application/json
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==

HTTP Response

HTTP/1.1 200 OK
Content-Length: 1311
Content-Type: application/json;charset=UTF-8

{
  "elements" : [ {
    "id" : "8045e44e-974e-4f43-9862-7f0326782638",
    "esxiVersion" : "6.5.0-13006603",
    "fqdn" : "esfo01m01esx02.sfo01.rainpole.local",
    "hardwareVendor" : "VMware, Inc.",
    "hardwareModel" : "VMware Virtual Platform",
    "ipAddresses" : [ {
      "ipAddress" : "10.0.0.101",
      "type" : "MANAGEMENT"
    } ],
    "cpu" : {
      "frequencyMHz" : 4994.0,
      "cores" : 2,
      "cpuCores" : [ {
        "frequencyMHz" : 2497.0,
        "model" : "Intel(R) Xeon(R) CPU E5-2680 v3 @ 2.50GHz",
        "manufacturer" : "Intel"
      }, {
        "frequencyMHz" : 2497.0,
        "model" : "Intel(R) Xeon(R) CPU E5-2680 v3 @ 2.50GHz",
        "manufacturer" : "Intel"
      } ]
    },
    "memory" : {
      "totalCapacityMB" : 79999.0
    },
    "storage" : {
      "totalCapacityMB" : 781250.0,
      "disks" : [ {
        "capacityMB" : 390625.0,
        "diskType" : "HDD"
      }, {
        "capacityMB" : 390625.0,
        "diskType" : "FLASH"
      } ]
    },
    "physicalNics" : [ {
      "deviceName" : "vmnic0",
      "macAddress" : "02:00:1b:31:93:d2"
    }, {
      "deviceName" : "vmnic1",
      "macAddress" : "02:00:1b:31:93:d3"
    } ],
    "networkpool" : {
      "id" : "1205afdd-84f5-403e-a052-1a9bba09ef41"
    },
    "status" : "UNASSIGNED_USEABLE"
  } ]
}

Get UNASSIGNED_UNUSEABLE Hosts

This API can be used to fetch all the hosts that are currently not assigned to any domain and can be used for other domain tasks after completion of cleanup operation

Note
 Cleanup operations must be performed to get these host back into "UNASSIGNED" and "USEABLE" state.
Steps

  1. Invoke the API by specifying the "status" as "UNASSIGNED_UNUSEABLE".

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/hosts?status=UNASSIGNED_UNUSEABLE' -i -u 'admin:VMwareInfra@1' -X GET \
    -H 'Accept: application/json'

HTTP Request

GET /v1/hosts?status=UNASSIGNED_UNUSEABLE HTTP/1.1
Accept: application/json
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==

HTTP Response

HTTP/1.1 200 OK
Content-Length: 1313
Content-Type: application/json;charset=UTF-8

{
  "elements" : [ {
    "id" : "8045e44e-974e-4f43-9862-7f0326782638",
    "esxiVersion" : "6.5.0-13006603",
    "fqdn" : "esfo01m01esx03.sfo01.rainpole.local",
    "hardwareVendor" : "VMware, Inc.",
    "hardwareModel" : "VMware Virtual Platform",
    "ipAddresses" : [ {
      "ipAddress" : "10.0.0.102",
      "type" : "MANAGEMENT"
    } ],
    "cpu" : {
      "frequencyMHz" : 4994.0,
      "cores" : 2,
      "cpuCores" : [ {
        "frequencyMHz" : 2497.0,
        "model" : "Intel(R) Xeon(R) CPU E5-2680 v3 @ 2.50GHz",
        "manufacturer" : "Intel"
      }, {
        "frequencyMHz" : 2497.0,
        "model" : "Intel(R) Xeon(R) CPU E5-2680 v3 @ 2.50GHz",
        "manufacturer" : "Intel"
      } ]
    },
    "memory" : {
      "totalCapacityMB" : 79999.0
    },
    "storage" : {
      "totalCapacityMB" : 781250.0,
      "disks" : [ {
        "capacityMB" : 390625.0,
        "diskType" : "HDD"
      }, {
        "capacityMB" : 390625.0,
        "diskType" : "FLASH"
      } ]
    },
    "physicalNics" : [ {
      "deviceName" : "vmnic0",
      "macAddress" : "02:00:1b:31:93:d2"
    }, {
      "deviceName" : "vmnic1",
      "macAddress" : "02:00:1b:31:93:d3"
    } ],
    "networkpool" : {
      "id" : "1205afdd-84f5-403e-a052-1a9bba09ef41"
    },
    "status" : "UNASSIGNED_UNUSEABLE"
  } ]
}

Get Hosts by Domain

This API can be used to fetch all the hosts that are currently assigned to a given domain.

Steps

  1. Invoke the API by specifying the "domainId".

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/hosts?domainId=377236f7-4965-4179-895e-eeb4eb9a6ad1' -i -u 'admin:VMwareInfra@1' -X GET \
    -H 'Accept: application/json'

HTTP Request

GET /v1/hosts?domainId=377236f7-4965-4179-895e-eeb4eb9a6ad1 HTTP/1.1
Accept: application/json
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==

HTTP Response

HTTP/1.1 200 OK
Content-Length: 1495
Content-Type: application/json;charset=UTF-8

{
  "elements" : [ {
    "id" : "c0703437-6746-470b-9e1c-f9d3bbc9b1c1",
    "esxiVersion" : "6.7.0-13006603",
    "fqdn" : "esfo01m01esx01.sfo01.rainpole.local",
    "hardwareVendor" : "VMware, Inc.",
    "hardwareModel" : "VMware Virtual Platform",
    "ipAddresses" : [ {
      "ipAddress" : "10.0.0.100",
      "type" : "MANAGEMENT"
    } ],
    "cpu" : {
      "frequencyMHz" : 4994.0,
      "cores" : 2,
      "cpuCores" : [ {
        "frequencyMHz" : 2497.0,
        "model" : "Intel(R) Xeon(R) CPU E5-2680 v3 @ 2.50GHz",
        "manufacturer" : "Intel"
      }, {
        "frequencyMHz" : 2497.0,
        "model" : "Intel(R) Xeon(R) CPU E5-2680 v3 @ 2.50GHz",
        "manufacturer" : "Intel"
      } ]
    },
    "memory" : {
      "totalCapacityMB" : 79999.0
    },
    "storage" : {
      "totalCapacityMB" : 781250.0,
      "disks" : [ {
        "capacityMB" : 390625.0,
        "diskType" : "HDD"
      }, {
        "capacityMB" : 390625.0,
        "diskType" : "FLASH"
      } ]
    },
    "physicalNics" : [ {
      "deviceName" : "vmnic0",
      "macAddress" : "02:00:1b:31:93:d2"
    }, {
      "deviceName" : "vmnic1",
      "macAddress" : "02:00:1b:31:93:d3"
    } ],
    "domain" : {
      "id" : "377236f7-4965-4179-895e-eeb4eb9a6ad1"
    },
    "networkpool" : {
      "id" : "1205afdd-84f5-403e-a052-1a9bba09ef41"
    },
    "cluster" : {
      "id" : "4205afdd-94f5-403e-a051-1a9bba09ef40"
    },
    "status" : "ASSIGNED",
    "compatibleStorageType" : "VMFS_FC"
  } ]
}

Get Hosts by Cluster

This API can be used to fetch all the hosts that are currently assigned to a given cluster.

Steps

  1. Invoke the API by specifying the "clusterId".

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/hosts?clusterId=4205afdd-94f5-403e-a051-1a9bba09ef40' -i -u 'admin:VMwareInfra@1' -X GET \
    -H 'Accept: application/json'

HTTP Request

GET /v1/hosts?clusterId=4205afdd-94f5-403e-a051-1a9bba09ef40 HTTP/1.1
Accept: application/json
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==

HTTP Response

HTTP/1.1 200 OK
Content-Length: 1495
Content-Type: application/json;charset=UTF-8

{
  "elements" : [ {
    "id" : "c0703437-6746-470b-9e1c-f9d3bbc9b1c1",
    "esxiVersion" : "6.7.0-13006603",
    "fqdn" : "esfo01m01esx01.sfo01.rainpole.local",
    "hardwareVendor" : "VMware, Inc.",
    "hardwareModel" : "VMware Virtual Platform",
    "ipAddresses" : [ {
      "ipAddress" : "10.0.0.100",
      "type" : "MANAGEMENT"
    } ],
    "cpu" : {
      "frequencyMHz" : 4994.0,
      "cores" : 2,
      "cpuCores" : [ {
        "frequencyMHz" : 2497.0,
        "model" : "Intel(R) Xeon(R) CPU E5-2680 v3 @ 2.50GHz",
        "manufacturer" : "Intel"
      }, {
        "frequencyMHz" : 2497.0,
        "model" : "Intel(R) Xeon(R) CPU E5-2680 v3 @ 2.50GHz",
        "manufacturer" : "Intel"
      } ]
    },
    "memory" : {
      "totalCapacityMB" : 79999.0
    },
    "storage" : {
      "totalCapacityMB" : 781250.0,
      "disks" : [ {
        "capacityMB" : 390625.0,
        "diskType" : "HDD"
      }, {
        "capacityMB" : 390625.0,
        "diskType" : "FLASH"
      } ]
    },
    "physicalNics" : [ {
      "deviceName" : "vmnic0",
      "macAddress" : "02:00:1b:31:93:d2"
    }, {
      "deviceName" : "vmnic1",
      "macAddress" : "02:00:1b:31:93:d3"
    } ],
    "domain" : {
      "id" : "377236f7-4965-4179-895e-eeb4eb9a6ad1"
    },
    "networkpool" : {
      "id" : "1205afdd-84f5-403e-a052-1a9bba09ef41"
    },
    "cluster" : {
      "id" : "4205afdd-94f5-403e-a051-1a9bba09ef40"
    },
    "status" : "ASSIGNED",
    "compatibleStorageType" : "VMFS_FC"
  } ]
}

Get Hosts by Network Pool

This API can be used to fetch all the hosts that are currently assigned to a given network pool.

Steps

  1. Invoke the API by specifying the "networkpoolId".

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/hosts?networkpoolId=1205afdd-84f5-403e-a052-1a9bba09ef41' -i -u 'admin:VMwareInfra@1' -X GET \
    -H 'Accept: application/json'

HTTP Request

GET /v1/hosts?networkpoolId=1205afdd-84f5-403e-a052-1a9bba09ef41 HTTP/1.1
Accept: application/json
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==

HTTP Response

HTTP/1.1 200 OK
Content-Length: 1495
Content-Type: application/json;charset=UTF-8

{
  "elements" : [ {
    "id" : "c0703437-6746-470b-9e1c-f9d3bbc9b1c1",
    "esxiVersion" : "6.7.0-13006603",
    "fqdn" : "esfo01m01esx01.sfo01.rainpole.local",
    "hardwareVendor" : "VMware, Inc.",
    "hardwareModel" : "VMware Virtual Platform",
    "ipAddresses" : [ {
      "ipAddress" : "10.0.0.100",
      "type" : "MANAGEMENT"
    } ],
    "cpu" : {
      "frequencyMHz" : 4994.0,
      "cores" : 2,
      "cpuCores" : [ {
        "frequencyMHz" : 2497.0,
        "model" : "Intel(R) Xeon(R) CPU E5-2680 v3 @ 2.50GHz",
        "manufacturer" : "Intel"
      }, {
        "frequencyMHz" : 2497.0,
        "model" : "Intel(R) Xeon(R) CPU E5-2680 v3 @ 2.50GHz",
        "manufacturer" : "Intel"
      } ]
    },
    "memory" : {
      "totalCapacityMB" : 79999.0
    },
    "storage" : {
      "totalCapacityMB" : 781250.0,
      "disks" : [ {
        "capacityMB" : 390625.0,
        "diskType" : "HDD"
      }, {
        "capacityMB" : 390625.0,
        "diskType" : "FLASH"
      } ]
    },
    "physicalNics" : [ {
      "deviceName" : "vmnic0",
      "macAddress" : "02:00:1b:31:93:d2"
    }, {
      "deviceName" : "vmnic1",
      "macAddress" : "02:00:1b:31:93:d3"
    } ],
    "domain" : {
      "id" : "377236f7-4965-4179-895e-eeb4eb9a6ad1"
    },
    "networkpool" : {
      "id" : "1205afdd-84f5-403e-a052-1a9bba09ef41"
    },
    "cluster" : {
      "id" : "4205afdd-94f5-403e-a051-1a9bba09ef40"
    },
    "status" : "ASSIGNED",
    "compatibleStorageType" : "VMFS_FC"
  } ]
}

Get Hosts by Storage Type

This API can be used to fetch all the hosts that are currently configured with the given storage type.

Note
 Supported storage type is "VMFS_FC".
Steps

  1. Invoke the API by specifying the "storageType".

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/hosts?storageType=VMFS_FC' -i -u 'admin:VMwareInfra@1' -X GET \
    -H 'Accept: application/json'

HTTP Request

GET /v1/hosts?storageType=VMFS_FC HTTP/1.1
Accept: application/json
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==

HTTP Response

HTTP/1.1 200 OK
Content-Length: 1495
Content-Type: application/json;charset=UTF-8

{
  "elements" : [ {
    "id" : "c0703437-6746-470b-9e1c-f9d3bbc9b1c1",
    "esxiVersion" : "6.7.0-13006603",
    "fqdn" : "esfo01m01esx01.sfo01.rainpole.local",
    "hardwareVendor" : "VMware, Inc.",
    "hardwareModel" : "VMware Virtual Platform",
    "ipAddresses" : [ {
      "ipAddress" : "10.0.0.100",
      "type" : "MANAGEMENT"
    } ],
    "cpu" : {
      "frequencyMHz" : 4994.0,
      "cores" : 2,
      "cpuCores" : [ {
        "frequencyMHz" : 2497.0,
        "model" : "Intel(R) Xeon(R) CPU E5-2680 v3 @ 2.50GHz",
        "manufacturer" : "Intel"
      }, {
        "frequencyMHz" : 2497.0,
        "model" : "Intel(R) Xeon(R) CPU E5-2680 v3 @ 2.50GHz",
        "manufacturer" : "Intel"
      } ]
    },
    "memory" : {
      "totalCapacityMB" : 79999.0
    },
    "storage" : {
      "totalCapacityMB" : 781250.0,
      "disks" : [ {
        "capacityMB" : 390625.0,
        "diskType" : "HDD"
      }, {
        "capacityMB" : 390625.0,
        "diskType" : "FLASH"
      } ]
    },
    "physicalNics" : [ {
      "deviceName" : "vmnic0",
      "macAddress" : "02:00:1b:31:93:d2"
    }, {
      "deviceName" : "vmnic1",
      "macAddress" : "02:00:1b:31:93:d3"
    } ],
    "domain" : {
      "id" : "377236f7-4965-4179-895e-eeb4eb9a6ad1"
    },
    "networkpool" : {
      "id" : "1205afdd-84f5-403e-a052-1a9bba09ef41"
    },
    "cluster" : {
      "id" : "4205afdd-94f5-403e-a051-1a9bba09ef40"
    },
    "status" : "ASSIGNED",
    "compatibleStorageType" : "VMFS_FC"
  } ]
}

Get Hosts by Datastore Name

This API can be used to fetch all the hosts that are currently configured with the given datastore.

Steps

  1. Invoke the API by specifying the "datastoreName".

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/hosts?datastoreName=datastore1' -i -u 'admin:VMwareInfra@1' -X GET \
    -H 'Accept: application/json'

HTTP Request

GET /v1/hosts?datastoreName=datastore1 HTTP/1.1
Accept: application/json
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==

HTTP Response

HTTP/1.1 200 OK
Content-Length: 1495
Content-Type: application/json;charset=UTF-8

{
  "elements" : [ {
    "id" : "c0703437-6746-470b-9e1c-f9d3bbc9b1c1",
    "esxiVersion" : "6.7.0-13006603",
    "fqdn" : "esfo01m01esx01.sfo01.rainpole.local",
    "hardwareVendor" : "VMware, Inc.",
    "hardwareModel" : "VMware Virtual Platform",
    "ipAddresses" : [ {
      "ipAddress" : "10.0.0.100",
      "type" : "MANAGEMENT"
    } ],
    "cpu" : {
      "frequencyMHz" : 4994.0,
      "cores" : 2,
      "cpuCores" : [ {
        "frequencyMHz" : 2497.0,
        "model" : "Intel(R) Xeon(R) CPU E5-2680 v3 @ 2.50GHz",
        "manufacturer" : "Intel"
      }, {
        "frequencyMHz" : 2497.0,
        "model" : "Intel(R) Xeon(R) CPU E5-2680 v3 @ 2.50GHz",
        "manufacturer" : "Intel"
      } ]
    },
    "memory" : {
      "totalCapacityMB" : 79999.0
    },
    "storage" : {
      "totalCapacityMB" : 781250.0,
      "disks" : [ {
        "capacityMB" : 390625.0,
        "diskType" : "HDD"
      }, {
        "capacityMB" : 390625.0,
        "diskType" : "FLASH"
      } ]
    },
    "physicalNics" : [ {
      "deviceName" : "vmnic0",
      "macAddress" : "02:00:1b:31:93:d2"
    }, {
      "deviceName" : "vmnic1",
      "macAddress" : "02:00:1b:31:93:d3"
    } ],
    "domain" : {
      "id" : "377236f7-4965-4179-895e-eeb4eb9a6ad1"
    },
    "networkpool" : {
      "id" : "1205afdd-84f5-403e-a052-1a9bba09ef41"
    },
    "cluster" : {
      "id" : "4205afdd-94f5-403e-a051-1a9bba09ef40"
    },
    "status" : "ASSIGNED",
    "compatibleStorageType" : "VMFS_FC"
  } ]
}
Related APIs

Get the Hosts
Get a Host

2.5.3. Get a Host

Prerequisites

  1. The following data is required

    • ID of the host

Steps

  1. Invoke the API.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/hosts/c0703437-6746-470b-9e1c-f9d3bbc9b1c1' -i -u 'admin:VMwareInfra@1' -X GET \
    -H 'Accept: application/json'

HTTP Request

GET /v1/hosts/c0703437-6746-470b-9e1c-f9d3bbc9b1c1 HTTP/1.1
Accept: application/json
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==

HTTP Response

HTTP/1.1 200 OK
Content-Length: 1364
Content-Type: application/json;charset=UTF-8

{
  "id" : "c0703437-6746-470b-9e1c-f9d3bbc9b1c1",
  "esxiVersion" : "6.7.0-13006603",
  "fqdn" : "esfo01m01esx01.sfo01.rainpole.local",
  "hardwareVendor" : "VMware, Inc.",
  "hardwareModel" : "VMware Virtual Platform",
  "ipAddresses" : [ {
    "ipAddress" : "10.0.0.100",
    "type" : "MANAGEMENT"
  } ],
  "cpu" : {
    "frequencyMHz" : 4994.0,
    "cores" : 2,
    "cpuCores" : [ {
      "frequencyMHz" : 2497.0,
      "model" : "Intel(R) Xeon(R) CPU E5-2680 v3 @ 2.50GHz",
      "manufacturer" : "Intel"
    }, {
      "frequencyMHz" : 2497.0,
      "model" : "Intel(R) Xeon(R) CPU E5-2680 v3 @ 2.50GHz",
      "manufacturer" : "Intel"
    } ]
  },
  "memory" : {
    "totalCapacityMB" : 79999.0
  },
  "storage" : {
    "totalCapacityMB" : 781250.0,
    "disks" : [ {
      "capacityMB" : 390625.0,
      "diskType" : "HDD"
    }, {
      "capacityMB" : 390625.0,
      "diskType" : "FLASH"
    } ]
  },
  "physicalNics" : [ {
    "deviceName" : "vmnic0",
    "macAddress" : "02:00:1b:31:93:d2"
  }, {
    "deviceName" : "vmnic1",
    "macAddress" : "02:00:1b:31:93:d3"
  } ],
  "domain" : {
    "id" : "377236f7-4965-4179-895e-eeb4eb9a6ad1"
  },
  "networkpool" : {
    "id" : "1205afdd-84f5-403e-a052-1a9bba09ef41"
  },
  "cluster" : {
    "id" : "4205afdd-94f5-403e-a051-1a9bba09ef40"
  },
  "status" : "ASSIGNED",
  "compatibleStorageType" : "VMFS_FC"
}
Related APIs

Get the Hosts
Get a Host

2.5.4. Decommission the Hosts

Prerequisites

  1. The following data is required

    • FQDN of each host

  2. The host must not be assigned to a domain i.e "status" must be "UNASSIGNED_USEABLE".

Tip
 Refer to: Get the Hosts to fetch the hosts with the required "status"
Steps

  1. Invoke the API

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/hosts' -i -u 'admin:VMwareInfra@1' -X DELETE \
    -H 'Content-Type: application/json' \
    -d '[ {
  "fqdn" : "esfo01m01esx01.sfo01.rainpole.local"
}, {
  "fqdn" : "esfo01m01esx02.sfo01.rainpole.local"
} ]'

HTTP Request

DELETE /v1/hosts HTTP/1.1
Host: sddc-manager.sfo01.rainpole.local
Content-Length: 110
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==
Content-Type: application/json

[ {
  "fqdn" : "esfo01m01esx01.sfo01.rainpole.local"
}, {
  "fqdn" : "esfo01m01esx02.sfo01.rainpole.local"
} ]

HTTP Response

HTTP/1.1 202 Accepted
Location: /v1/tasks/38e8228e-76ec-4f4a-9f87-5d58f8755ab0
Content-Type: application/json;charset=UTF-8
Content-Length: 79

{
  "id" : "38e8228e-76ec-4f4a-9f87-5d58f8755ab0",
  "status" : "IN_PROGRESS"
}

  1. Poll the task until "status" is not "IN_PROGRESS" using the "id" from the previous response.

Tip
 Refer to: Get a Task.

  • If the "status" is "SUCCESSFUL", the task is completed successfully.

  • If the "status" is "FAILED", the task can be re-executed.

Tip
 Refer to: Retry a Task.
Related APIs

Decommission the Hosts
Get a Task
Retry a Task
Get the Hosts
Get a Host

2.6. License Keys

2.6.1. Add a License Key

  • This API is used to add a license key.

  • Adding a license key which is already added , will give an error.

Tip
 Refer to: Get a License Key to check if a license key is already present.

  • Adding an incorrect (key size and format) or an invalid license key (invalid or expired), will give an error.

Prerequisites

  1. The following data is required

    • License key

    • Product type

    • License key description

Steps

  1. Invoke the API

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/license-keys' -i -u 'admin:VMwareInfra@1' -X POST \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json' \
    -d '{
  "key" : "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
  "productType" : "NSXV",
  "description" : "NSXV license key"
}'

HTTP Request

POST /v1/license-keys HTTP/1.1
Accept: application/json
Host: sddc-manager.sfo01.rainpole.local
Content-Length: 109
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==
Content-Type: application/json

{
  "key" : "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
  "productType" : "NSXV",
  "description" : "NSXV license key"
}

HTTP Response

HTTP/1.1 201 Created
Location: /v1/license-keys/XXXXX-XXXXX-XXXXX-XXXXX-XXXXX
Related APIs

Add a License Key

2.6.2. Get the License Keys

  • This API is used to get all the license keys.

  • This also gives the license key metrics like usage and validity of a license key.

  • License keys can be filtered based on product type and/or license key status.

Prerequisites

None

Get All License Keys

Steps

  1. Invoke the API.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/license-keys' -i -u 'admin:VMwareInfra@1' -X GET \
    -H 'Accept: application/json'

HTTP Request

GET /v1/license-keys HTTP/1.1
Accept: application/json
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==

HTTP Response

HTTP/1.1 200 OK
Content-Length: 912
Content-Type: application/json;charset=UTF-8

{
  "elements" : [ {
    "id" : "408529cb-7f03-467a-84d0-7e8659b0ef43",
    "key" : "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
    "productType" : "VCENTER",
    "description" : "vCenter license key",
    "isUnlimited" : false,
    "licenseKeyUsage" : {
      "total" : 5,
      "remaining" : 4,
      "used" : 1,
      "licenseUnit" : "INSTANCE"
    },
    "licenseKeyValidity" : {
      "licenseKeyStatus" : "ACTIVE",
      "expiryDate" : "2029-05-23T16:12:53.001Z"
    }
  }, {
    "id" : "c8426790-827e-4db4-836b-d06f1e1073ee",
    "key" : "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
    "productType" : "NSXV",
    "description" : "NSX-V license key",
    "isUnlimited" : false,
    "licenseKeyUsage" : {
      "total" : 15,
      "remaining" : 14,
      "used" : 1,
      "licenseUnit" : "VM"
    },
    "licenseKeyValidity" : {
      "licenseKeyStatus" : "ACTIVE",
      "expiryDate" : "2029-05-23T16:12:53.001Z"
    }
  } ]
}

Get License Keys By Product Type

Steps

  1. Invoke the API by specifying the _"productType".

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/license-keys?productType=VCENTER,ESXI' -i -u 'admin:VMwareInfra@1' -X GET \
    -H 'Accept: application/json'

HTTP Request

GET /v1/license-keys?productType=VCENTER,ESXI HTTP/1.1
Accept: application/json
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==

HTTP Response

HTTP/1.1 200 OK
Content-Length: 471
Content-Type: application/json;charset=UTF-8

{
  "elements" : [ {
    "id" : "59189eff-1244-4199-92b4-49a092965f8d",
    "key" : "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
    "productType" : "VCENTER",
    "description" : "vCenter license key",
    "isUnlimited" : false,
    "licenseKeyUsage" : {
      "total" : 5,
      "remaining" : 4,
      "used" : 1,
      "licenseUnit" : "INSTANCE"
    },
    "licenseKeyValidity" : {
      "licenseKeyStatus" : "ACTIVE",
      "expiryDate" : "2029-05-23T16:12:53.001Z"
    }
  } ]
}

Get License Keys By Status Of The License Key

Steps

  1. Invoke the API by specifying the _"licenseKeyStatus".

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/license-keys?licenseKeyStatus=ACTIVE,NEVER_EXPIRES' -i -u 'admin:VMwareInfra@1' -X GET \
    -H 'Accept: application/json'

HTTP Request

GET /v1/license-keys?licenseKeyStatus=ACTIVE,NEVER_EXPIRES HTTP/1.1
Accept: application/json
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==

HTTP Response

HTTP/1.1 200 OK
Content-Length: 471
Content-Type: application/json;charset=UTF-8

{
  "elements" : [ {
    "id" : "82780b13-1f4a-4e71-bdeb-751395a923f4",
    "key" : "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
    "productType" : "VCENTER",
    "description" : "vCenter license key",
    "isUnlimited" : false,
    "licenseKeyUsage" : {
      "total" : 5,
      "remaining" : 4,
      "used" : 1,
      "licenseUnit" : "INSTANCE"
    },
    "licenseKeyValidity" : {
      "licenseKeyStatus" : "ACTIVE",
      "expiryDate" : "2029-05-23T16:12:53.001Z"
    }
  } ]
}
Related APIs

Get the License Keys
Get a License Key by key

2.6.3. Get a License Key

  • This API is used to get the license key metrics like usage and validity of a license key.

  • If the license key does not exist, you will get an error.

Prerequisites

  1. The following data is required

    • License key

Steps

  1. Invoke the API

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/license-keys/XXXXX-XXXXX-XXXXX-XXXXX-XXXXX' -i -u 'admin:VMwareInfra@1' -X GET \
    -H 'Accept: application/json'

HTTP Request

GET /v1/license-keys/XXXXX-XXXXX-XXXXX-XXXXX-XXXXX HTTP/1.1
Accept: application/json
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==

HTTP Response

HTTP/1.1 200 OK
Content-Length: 416
Content-Type: application/json;charset=UTF-8

{
  "id" : "7224e805-fa35-4167-80f9-0d79527e9723",
  "key" : "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
  "productType" : "VCENTER",
  "description" : "vCenter license key",
  "isUnlimited" : false,
  "licenseKeyUsage" : {
    "total" : 5,
    "remaining" : 4,
    "used" : 1,
    "licenseUnit" : "INSTANCE"
  },
  "licenseKeyValidity" : {
    "licenseKeyStatus" : "ACTIVE",
    "expiryDate" : "2029-05-23T16:12:53.001Z"
  }
}
Related APIs

Get the License Keys
Get a License Key by key

2.6.4. Delete a License Key

  • This API is used to delete a license key.

Warning
 Deleting a license key which is in use, will give an error.
Prerequisites

  1. The following data is required

    • License key

Steps

  1. Invoke the API

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/license-keys/XXXXX-XXXXX-XXXXX-XXXXX-XXXXX' -i -u 'admin:VMwareInfra@1' -X DELETE \
    -H 'Accept: application/json'

HTTP Request

DELETE /v1/license-keys/XXXXX-XXXXX-XXXXX-XXXXX-XXXXX HTTP/1.1
Accept: application/json
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==

HTTP Response

HTTP/1.1 204 No Content
Related APIs

Delete a License Key
Get the License Keys
Get a License Key by key

2.7. Domains

A workload domain is a policy based resource container with specific availability and performance attributes that combines compute (vSphere), storage (vSAN/NFS/VMFS on FC) and networking (NSX) into a single consumable entity.

2.7.1. Create a Domain

The Create a Domain workflow automatically:

  • Deploys an additional vCenter Server Appliance for the new domain within the management domain.

  • By leveraging a separate vCenter Server instance per domain, software updates can be applied without impacting other domains. It also allows for each domain to have additional isolation as needed.

  • Connects the specified ESXi servers to this vCenter Server instance and groups them into a cluster. Each host is configured with the port groups applicable for the domain.

  • Configures networking on each ESXi host.

  • If vSAN or NFS storage provided, they are configured on the ESXi hosts. If VMFS on FC storage provided, it’s consumed.

  • For each NSX for vSphere Domain, the workflow deploys an NSX Manager in the management domain and three NSX controllers on the ESXi datastore. The workflow also configures an anti-affinity rule between the controller VMs to prevent them from being on the same host for High Availability.

  • For the first NSX-T VI Domain in your environment, the workflow deploys an NSX Manager and three NSX controllers in the management domain. The workflow also configures an anti-affinity rule between the controller VMs to prevent them from being on the same host for High Availability. All subsequent NSX-T Domains share this NSX-T Manager and Controllers.

  • For an NSX-T Domain, NSX Edges are needed to enable overlay VI networks and public networks for north-south traffic. NSX Edges are not deployed automatically for an NSX-T VI Domain. You can deploy them manually after the VI domain is created. Subsequent NSX-T VI Domains share the NSX-T Edges deployed for the first domain.

  • Licenses and integrates the deployed components with the appropriate pieces in the Cloud Foundation software stack.

The result is a workload-ready SDDC environment.

Prerequisites

  1. The following data is required

    • Name of the domain

    • vCenter details

      • Name of the vCenter

      • Network details

        • IP Address of the vCenter

        • FQDN of the vCenter

        • Gateway

        • Subnet mask

      • License key for the vCenter

      • Password for the root user (8-20 characters)

      • Name of the datacenter where vCenter needs to be deployed

    • List of clusters

      • For each cluster

        • Name of the cluster

        • List of hosts

          • For each host

            • ID of the host (UUID)

            • License key for the host

            • List of VDS names to associate with host

            • ID of the vmNic host to be associated with VDS, once added to cluster

        • Datastore details

          Note
          		 Only one of "vsanDatastoreSpec" (For VSAN) , "nfsDatastoreSpec" (For NFS) or "vmfsDatastoreSpec" (For VMFS on FC) must be specified.

          • For VSAN

            • Number of host failures to tolerate (can be 0, 1, or 2)

            • License key for the vSAN datastore

              {
  "vsanDatastoreSpec" : {
    "failuresToTolerate" : 1,
    "licenseKey" : "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
    "datastoreName" : "vSanDatastore"
  }
}

          • For NFS

            • List of NFS server names

            • Shared directory path

            • User tag used to annotate NFS share

            • Boolean to identify if the mount directory should be read-only

            {
  "nfsDatastoreSpecs" : [ {
    "nasVolume" : {
      "serverName" : [ "10.0.0.250" ],
      "path" : "/nfs_mount/my_read_write_folder",
      "readOnly" : false
    },
    "datastoreName" : "NFSShare"
  } ]
}

        • For VMFS on FC

          • Ensure that the ESXi hosts have the given VMFS on FC datastore name configured.

            {
  "vmfsDatastoreSpec" : {
    "fcSpec" : [ {
      "datastoreName" : "sample-vmfs-on-fc-datastore-name"
    } ]
  }
}

        • Network Details

          • List of VDS details

            • For each VDS

              • Port group names and the corresponding transport type

              • DVS host Infrastructure traffic resource type

              • Maximum allowed usage for a traffic class

              • Amount of bandwidth to be reserved for the host infrastructure traffic class

          • NSX cluster Details

            Note
            		 Only one of "nsxVClusterSpec" (For NSX-V) or "nsxTClusterSpec" (For NSX-T) must be specified.

            • For NSX-V

              • VLAN ID of the VXLAN

              • License key for NSX

              • VDS to be used for VXLAN traffic/port group. This should belong to one of the VDS being created for the cluster

            {
  "nsxVClusterSpec" : {
    "vlanId" : 3,
    "vdsNameForVxlanConfig" : "SDDC-Dswitch-Private1"
  }
}

            • For NSX-T

              • VLAN ID of Geneve

        {
  "nsxTClusterSpec" : {
    "geneveVlanId" : 2
  }
}

    • NSX details

      Note
      		 Only one of "nsxVSpec" (For NSX-V) or "nsxTSpec" (For NSX-T) must be specified.

      • For NSX-V

        • NSX Manager virtual machine details

          • Name of the NSX Manager virtual machine

          • Network details

            • IP address of the virtual machine

            • Fully-qualified domain name

            • Gateway

            • Subnet mask

        • NSX-V Controller Details

          • Controller IP addresses (three IPs) without duplicates

          • Controller password

          • Controller gateway

          • Controller subnet mask

        • License key for NSX

        • NSX Manager admin password (basic authorization and SSH)

        • NSX Manager enable password

        {
  "nsxManagerSpec" : {
    "name" : "nsx-manager-2",
    "networkDetailsSpec" : {
      "ipAddress" : "10.0.0.44",
      "dnsName" : "nsx-manager-2.sfo01.rainpole.local",
      "gateway" : "10.0.0.250",
      "subnetMask" : "255.255.255.0"
    }
  },
  "nsxVControllerSpec" : {
    "nsxControllerIps" : [ "10.0.0.45", "10.0.0.46", "10.0.0.47" ],
    "nsxControllerPassword" : "Test123456$%",
    "nsxControllerGateway" : "10.0.0.250",
    "nsxControllerSubnetMask" : "255.255.255.0"
  },
  "licenseKey" : "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
  "nsxManagerAdminPassword" : "Random0$",
  "nsxManagerEnablePassword" : "Random0$"
}

      • For NSX-T

        • NSX Manager virtual machine details

          • Name of the NSX Manager virtual machine

          • Network details

            • IP Address of the virtual machine

            • Fully-qualified domain name

            • Gateway

            • Subnet mask

        • Virtual IP address which would act as proxy/alias for NSX-T managers

        • Fully-qualified domain name for VIP so that common SSL certificates can be installed across all managers

        • License key for NSX

        • NSX manager admin Password (basic authorization and SSH)

    {
  "nsxManagerSpecs" : [ {
    "name" : "nsx-manager-2",
    "networkDetailsSpec" : {
      "ipAddress" : "10.0.0.44",
      "dnsName" : "nsx-manager-2.sfo01.rainpole.local",
      "gateway" : "10.0.0.250",
      "subnetMask" : "255.255.255.0"
    }
  }, {
    "name" : "nsx-manager-3",
    "networkDetailsSpec" : {
      "ipAddress" : "10.0.0.44",
      "dnsName" : "nsx-manager-2.sfo01.rainpole.local",
      "gateway" : "10.0.0.250",
      "subnetMask" : "255.255.255.0"
    }
  }, {
    "name" : "nsx-manager-4",
    "networkDetailsSpec" : {
      "ipAddress" : "10.0.0.44",
      "dnsName" : "nsx-manager-2.sfo01.rainpole.local",
      "gateway" : "10.0.0.250",
      "subnetMask" : "255.255.255.0"
    }
  } ],
  "vip" : "10.0.0.166",
  "vipFqdn" : "vip-nsxmanager.sfo01.rainpole.local",
  "licenseKey" : "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
  "nsxManagerAdminPassword" : "Random0$"
}
Warning
 NSX details (i.e "nsxVSpec" or "nsxTSpec") must match NSX cluster details (i.e "nsxVClusterSpec" or "nsxTClusterSpec") in the input specification.

  1. Network pool should be configured.

Tip
 Refer to Create a Network Pool

  1. Hosts should be commissioned.

Tip
 Refer to Commission the Hosts

  1. A DHCP server must be configured on the VXLAN VLAN of the management domain. When NSX creates VXLAN VTEPs for the domain, they are assigned IP addresses from the DHCP server.

  2. Ensure that host configuration has a minimum of two active vmNics. There must be a free uplink on each host to be used for the domain.

Steps

  1. Validate the input specification.

Note
 The below example is for creating a domain using vSAN storage (i.e "vsanDatastoreSpec") and NSX-V (i.e "nsxVSpec" and "nsxVClusterSpec")

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/domains/validations' -i -u 'admin:VMwareInfra@1' -X POST \
    -H 'Content-Type: application/json' \
    -d '{
  "domainCreationSpec" : {
    "domainName" : "Domain1",
    "vcenterSpec" : {
      "name" : "vCenter1",
      "networkDetailsSpec" : {
        "ipAddress" : "10.0.0.43",
        "dnsName" : "vcenter-2.sfo01.rainpole.local",
        "gateway" : "10.0.0.250",
        "subnetMask" : "255.255.255.0"
      },
      "rootPassword" : "Random0$",
      "datacenterName" : "new-vi-1"
    },
    "computeSpec" : {
      "clusterSpecs" : [ {
        "name" : "Cluster1",
        "hostSpecs" : [ {
          "id" : "607140c3-fef3-409d-a504-6571a9523a37",
          "hostNetworkSpec" : {
            "vmNics" : [ {
              "id" : "vmNicId1",
              "vdsName" : "SDDC-Dswitch-Private1"
            } ]
          }
        }, {
          "id" : "1c34fe4b-c06c-47b7-970b-cc7c151b71a2",
          "hostNetworkSpec" : {
            "vmNics" : [ {
              "id" : "vmNicId1",
              "vdsName" : "SDDC-Dswitch-Private1"
            } ]
          }
        }, {
          "id" : "eb1be9a2-c29a-48af-abe1-377fc902f5f9",
          "hostNetworkSpec" : {
            "vmNics" : [ {
              "id" : "vmNicId1",
              "vdsName" : "SDDC-Dswitch-Private1"
            } ]
          }
        } ],
        "datastoreSpec" : {
          "vsanDatastoreSpec" : {
            "failuresToTolerate" : 1,
            "licenseKey" : "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
            "datastoreName" : "vSanDatastore"
          }
        },
        "networkSpec" : {
          "vdsSpecs" : [ {
            "name" : "SDDC-Dswitch-Private1",
            "portGroupSpecs" : [ {
              "name" : "SDDC-DPortGroup-Mgmt",
              "transportType" : "MANAGEMENT"
            }, {
              "name" : "SDDC-DPortGroup-VSAN",
              "transportType" : "VSAN"
            }, {
              "name" : "SDDC-DPortGroup-vMotion",
              "transportType" : "VMOTION"
            } ]
          } ],
          "nsxClusterSpec" : {
            "nsxVClusterSpec" : {
              "vlanId" : 3,
              "vdsNameForVxlanConfig" : "SDDC-Dswitch-Private1"
            }
          }
        }
      } ]
    },
    "nsxVSpec" : {
      "nsxManagerSpec" : {
        "name" : "nsx-manager-2",
        "networkDetailsSpec" : {
          "ipAddress" : "10.0.0.44",
          "dnsName" : "nsx-manager-2.sfo01.rainpole.local",
          "gateway" : "10.0.0.250",
          "subnetMask" : "255.255.255.0"
        }
      },
      "nsxVControllerSpec" : {
        "nsxControllerIps" : [ "10.0.0.45", "10.0.0.46", "10.0.0.47" ],
        "nsxControllerPassword" : "Test123456$%",
        "nsxControllerGateway" : "10.0.0.250",
        "nsxControllerSubnetMask" : "255.255.255.0"
      },
      "licenseKey" : "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
      "nsxManagerAdminPassword" : "Random0$",
      "nsxManagerEnablePassword" : "Random0$"
    }
  }
}'

HTTP Request

POST /v1/domains/validations HTTP/1.1
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==
Content-Type: application/json
Content-Length: 2844

{
  "domainCreationSpec" : {
    "domainName" : "Domain1",
    "vcenterSpec" : {
      "name" : "vCenter1",
      "networkDetailsSpec" : {
        "ipAddress" : "10.0.0.43",
        "dnsName" : "vcenter-2.sfo01.rainpole.local",
        "gateway" : "10.0.0.250",
        "subnetMask" : "255.255.255.0"
      },
      "rootPassword" : "Random0$",
      "datacenterName" : "new-vi-1"
    },
    "computeSpec" : {
      "clusterSpecs" : [ {
        "name" : "Cluster1",
        "hostSpecs" : [ {
          "id" : "607140c3-fef3-409d-a504-6571a9523a37",
          "hostNetworkSpec" : {
            "vmNics" : [ {
              "id" : "vmNicId1",
              "vdsName" : "SDDC-Dswitch-Private1"
            } ]
          }
        }, {
          "id" : "1c34fe4b-c06c-47b7-970b-cc7c151b71a2",
          "hostNetworkSpec" : {
            "vmNics" : [ {
              "id" : "vmNicId1",
              "vdsName" : "SDDC-Dswitch-Private1"
            } ]
          }
        }, {
          "id" : "eb1be9a2-c29a-48af-abe1-377fc902f5f9",
          "hostNetworkSpec" : {
            "vmNics" : [ {
              "id" : "vmNicId1",
              "vdsName" : "SDDC-Dswitch-Private1"
            } ]
          }
        } ],
        "datastoreSpec" : {
          "vsanDatastoreSpec" : {
            "failuresToTolerate" : 1,
            "licenseKey" : "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
            "datastoreName" : "vSanDatastore"
          }
        },
        "networkSpec" : {
          "vdsSpecs" : [ {
            "name" : "SDDC-Dswitch-Private1",
            "portGroupSpecs" : [ {
              "name" : "SDDC-DPortGroup-Mgmt",
              "transportType" : "MANAGEMENT"
            }, {
              "name" : "SDDC-DPortGroup-VSAN",
              "transportType" : "VSAN"
            }, {
              "name" : "SDDC-DPortGroup-vMotion",
              "transportType" : "VMOTION"
            } ]
          } ],
          "nsxClusterSpec" : {
            "nsxVClusterSpec" : {
              "vlanId" : 3,
              "vdsNameForVxlanConfig" : "SDDC-Dswitch-Private1"
            }
          }
        }
      } ]
    },
    "nsxVSpec" : {
      "nsxManagerSpec" : {
        "name" : "nsx-manager-2",
        "networkDetailsSpec" : {
          "ipAddress" : "10.0.0.44",
          "dnsName" : "nsx-manager-2.sfo01.rainpole.local",
          "gateway" : "10.0.0.250",
          "subnetMask" : "255.255.255.0"
        }
      },
      "nsxVControllerSpec" : {
        "nsxControllerIps" : [ "10.0.0.45", "10.0.0.46", "10.0.0.47" ],
        "nsxControllerPassword" : "Test123456$%",
        "nsxControllerGateway" : "10.0.0.250",
        "nsxControllerSubnetMask" : "255.255.255.0"
      },
      "licenseKey" : "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
      "nsxManagerAdminPassword" : "Random0$",
      "nsxManagerEnablePassword" : "Random0$"
    }
  }
}

HTTP Response

HTTP/1.1 200 OK
Content-Length: 290
Content-Type: application/json

{
  "id" : "438bf659-b046-4c47-abab-5ae2cf7f8cc8",
  "description" : "Validating Domain Creation Spec",
  "executionStatus" : "COMPLETED",
  "resultStatus" : "SUCCEEDED",
  "validationChecks" : [ {
    "description" : "DomainCreationSpecValidation",
    "resultStatus" : "SUCCEEDED"
  } ]
}

  1. In case of no errors in the input specification, the "executionStatus" is "COMPLETED" and "resultStatus" is "SUCCEEDED".

  2. In case of errors in the input specification, the "executionStatus" is "COMPLETED" and "resultStatus" is "FAILED".

    Note
    		 Make changes to the input specification and re-validate using a new API invocation.

  1. Trigger the task using the valid input specification.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/domains' -i -u 'admin:VMwareInfra@1' -X POST \
    -H 'Content-Type: application/json' \
    -d '{
  "domainName" : "Domain1",
  "vcenterSpec" : {
    "name" : "vCenter1",
    "networkDetailsSpec" : {
      "ipAddress" : "10.0.0.43",
      "dnsName" : "vcenter-2.sfo01.rainpole.local",
      "gateway" : "10.0.0.250",
      "subnetMask" : "255.255.255.0"
    },
    "rootPassword" : "Random0$",
    "datacenterName" : "new-vi-1"
  },
  "computeSpec" : {
    "clusterSpecs" : [ {
      "name" : "Cluster1",
      "hostSpecs" : [ {
        "id" : "811f2a26-d542-45c6-95cf-703570180e50",
        "hostNetworkSpec" : {
          "vmNics" : [ {
            "id" : "vmNicId1",
            "vdsName" : "SDDC-Dswitch-Private1"
          } ]
        }
      }, {
        "id" : "cbad39d9-bc50-4f34-b40f-f1eb70e3175b",
        "hostNetworkSpec" : {
          "vmNics" : [ {
            "id" : "vmNicId1",
            "vdsName" : "SDDC-Dswitch-Private1"
          } ]
        }
      }, {
        "id" : "1be12a40-f963-4ff9-aa4a-ec3b4d2cc9d5",
        "hostNetworkSpec" : {
          "vmNics" : [ {
            "id" : "vmNicId1",
            "vdsName" : "SDDC-Dswitch-Private1"
          } ]
        }
      } ],
      "datastoreSpec" : {
        "vsanDatastoreSpec" : {
          "failuresToTolerate" : 1,
          "licenseKey" : "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
          "datastoreName" : "vSanDatastore"
        }
      },
      "networkSpec" : {
        "vdsSpecs" : [ {
          "name" : "SDDC-Dswitch-Private1",
          "portGroupSpecs" : [ {
            "name" : "SDDC-DPortGroup-Mgmt",
            "transportType" : "MANAGEMENT"
          }, {
            "name" : "SDDC-DPortGroup-VSAN",
            "transportType" : "VSAN"
          }, {
            "name" : "SDDC-DPortGroup-vMotion",
            "transportType" : "VMOTION"
          } ]
        } ],
        "nsxClusterSpec" : {
          "nsxVClusterSpec" : {
            "vlanId" : 3,
            "vdsNameForVxlanConfig" : "SDDC-Dswitch-Private1"
          }
        }
      }
    } ]
  },
  "nsxVSpec" : {
    "nsxManagerSpec" : {
      "name" : "nsx-manager-2",
      "networkDetailsSpec" : {
        "ipAddress" : "10.0.0.44",
        "dnsName" : "nsx-manager-2.sfo01.rainpole.local",
        "gateway" : "10.0.0.250",
        "subnetMask" : "255.255.255.0"
      }
    },
    "nsxVControllerSpec" : {
      "nsxControllerIps" : [ "10.0.0.45", "10.0.0.46", "10.0.0.47" ],
      "nsxControllerPassword" : "Test123456$%",
      "nsxControllerGateway" : "10.0.0.250",
      "nsxControllerSubnetMask" : "255.255.255.0"
    },
    "licenseKey" : "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
    "nsxManagerAdminPassword" : "Random0$",
    "nsxManagerEnablePassword" : "Random0$"
  }
}'

HTTP Request

POST /v1/domains HTTP/1.1
Host: sddc-manager.sfo01.rainpole.local
Content-Length: 2633
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==
Content-Type: application/json

{
  "domainName" : "Domain1",
  "vcenterSpec" : {
    "name" : "vCenter1",
    "networkDetailsSpec" : {
      "ipAddress" : "10.0.0.43",
      "dnsName" : "vcenter-2.sfo01.rainpole.local",
      "gateway" : "10.0.0.250",
      "subnetMask" : "255.255.255.0"
    },
    "rootPassword" : "Random0$",
    "datacenterName" : "new-vi-1"
  },
  "computeSpec" : {
    "clusterSpecs" : [ {
      "name" : "Cluster1",
      "hostSpecs" : [ {
        "id" : "811f2a26-d542-45c6-95cf-703570180e50",
        "hostNetworkSpec" : {
          "vmNics" : [ {
            "id" : "vmNicId1",
            "vdsName" : "SDDC-Dswitch-Private1"
          } ]
        }
      }, {
        "id" : "cbad39d9-bc50-4f34-b40f-f1eb70e3175b",
        "hostNetworkSpec" : {
          "vmNics" : [ {
            "id" : "vmNicId1",
            "vdsName" : "SDDC-Dswitch-Private1"
          } ]
        }
      }, {
        "id" : "1be12a40-f963-4ff9-aa4a-ec3b4d2cc9d5",
        "hostNetworkSpec" : {
          "vmNics" : [ {
            "id" : "vmNicId1",
            "vdsName" : "SDDC-Dswitch-Private1"
          } ]
        }
      } ],
      "datastoreSpec" : {
        "vsanDatastoreSpec" : {
          "failuresToTolerate" : 1,
          "licenseKey" : "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
          "datastoreName" : "vSanDatastore"
        }
      },
      "networkSpec" : {
        "vdsSpecs" : [ {
          "name" : "SDDC-Dswitch-Private1",
          "portGroupSpecs" : [ {
            "name" : "SDDC-DPortGroup-Mgmt",
            "transportType" : "MANAGEMENT"
          }, {
            "name" : "SDDC-DPortGroup-VSAN",
            "transportType" : "VSAN"
          }, {
            "name" : "SDDC-DPortGroup-vMotion",
            "transportType" : "VMOTION"
          } ]
        } ],
        "nsxClusterSpec" : {
          "nsxVClusterSpec" : {
            "vlanId" : 3,
            "vdsNameForVxlanConfig" : "SDDC-Dswitch-Private1"
          }
        }
      }
    } ]
  },
  "nsxVSpec" : {
    "nsxManagerSpec" : {
      "name" : "nsx-manager-2",
      "networkDetailsSpec" : {
        "ipAddress" : "10.0.0.44",
        "dnsName" : "nsx-manager-2.sfo01.rainpole.local",
        "gateway" : "10.0.0.250",
        "subnetMask" : "255.255.255.0"
      }
    },
    "nsxVControllerSpec" : {
      "nsxControllerIps" : [ "10.0.0.45", "10.0.0.46", "10.0.0.47" ],
      "nsxControllerPassword" : "Test123456$%",
      "nsxControllerGateway" : "10.0.0.250",
      "nsxControllerSubnetMask" : "255.255.255.0"
    },
    "licenseKey" : "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
    "nsxManagerAdminPassword" : "Random0$",
    "nsxManagerEnablePassword" : "Random0$"
  }
}

HTTP Response

HTTP/1.1 202 Accepted
Content-Length: 142
Location: /v1/tasks/0b8395c0-b065-4196-bdc2-ceda1cf397d9
Content-Type: application/json

{
  "id" : "0b8395c0-b065-4196-bdc2-ceda1cf397d9",
  "name" : "",
  "status" : "UNKNOWN",
  "creationTimestamp" : "2019-10-12T04:33:19.241Z"
}

  1. Poll the task until "status" is not "IN_PROGRESS" with the ID from the previous response.

Tip
 Refer to: Get a Task.

  • If the "status" is "SUCCESSFUL", the task is completed successfully.

  • If the "status" is "FAILED", the task can be re-executed.

Tip
 Refer to: Retry a Task.
Related APIs

Validate the input spec for domains operations
Create a Domain
Get the Hosts
Get a Host
Get the Tasks
Get a Task
Retry a Task

2.7.2. Get the Domains

Prerequisites

None

Steps

  1. Invoke the API.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/domains' -i -u 'admin:VMwareInfra@1' -X GET

HTTP Request

GET /v1/domains HTTP/1.1
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==

HTTP Response

HTTP/1.1 200 OK
Content-Length: 567
Content-Type: application/json;charset=UTF-8

{
  "elements" : [ {
    "id" : "c0703437-6746-470b-9e1c-f9d3bbc9b1c5",
    "name" : "VI-1",
    "vcenters" : [ {
      "id" : "c0703437-6756-470b-9e1c-f9d3bbc9b1c6"
    } ],
    "clusters" : [ {
      "id" : "8045e44e-974e-4f43-9862-7f0326782655"
    } ]
  }, {
    "id" : "c0703437-6746-470b-9e1c-f9d3bbc9b1c1",
    "name" : "VDI-1",
    "vcenters" : [ {
      "id" : "c0703437-6846-470b-9e1c-f9d3bbc9b1c9"
    } ],
    "clusters" : [ {
      "id" : "8045e44e-974e-4f43-9862-7f0326782677"
    }, {
      "id" : "8045e44e-974e-4f43-9861-7f0326782633"
    } ]
  } ]
}
Related APIs

Get the Domains
Get a Domain

2.7.3. Get a Domain

Prerequisites

  1. The following data is required

    • ID of the domain

Steps

  1. Invoke the API.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/domains/c0703437-6746-470b-9e1c-f9d3bbc9b1c5' -i -u 'admin:VMwareInfra@1' -X GET

HTTP Request

GET /v1/domains/c0703437-6746-470b-9e1c-f9d3bbc9b1c5 HTTP/1.1
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==

HTTP Response

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 222

{
  "id" : "c0703437-6746-470b-9e1c-f9d3bbc9b1c5",
  "name" : "VI-1",
  "vcenters" : [ {
    "id" : "c0703437-6756-470b-9e1c-f9d3bbc9b1c6"
  } ],
  "clusters" : [ {
    "id" : "8045e44e-974e-4f43-9862-7f0326782655"
  } ]
}
Related APIs

Get the Domains
Get a Domain

2.7.4. Get Domain Endpoints

Prerequisites

  1. The following data is required

    • ID of the domain

Steps

  1. Invoke the API.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/domains/30f51e01-21de-4c88-ab53-5eda4ec7e76c/endpoints' -i -u 'admin:VMwareInfra@1' -X GET

HTTP Request

GET /v1/domains/30f51e01-21de-4c88-ab53-5eda4ec7e76c/endpoints HTTP/1.1
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==

HTTP Response

HTTP/1.1 200 OK
Content-Length: 192
Content-Type: application/json;charset=UTF-8

{
  "elements" : [ {
    "type" : "VCENTER",
    "url" : "https://vcenter-1.vrack.vsphere.local"
  }, {
    "type" : "NSX_MANAGER",
    "url" : "https://nsxManager.vrack.vsphere.local"
  } ]
}
Related APIs

Get Endpoints of a Domain
Get the Domains
Get a Domain

2.7.5. Delete a Domain

When you delete a domain, the clusters within the domain are deleted and the hosts are returned to the free pool.

Warning
 Deleting a domain is an irreversible operation. All clusters and VMs within the domain are deleted and the underlying datastores are destroyed.
Warning
 Deleting a domain puts the host "status" to UNASSIGNED_UNUSEABLE. Cleanup the hosts to change the "status" to UNASSIGNED_USEABLE.
Note
 The network pools used by the domain are not deleted as part of task and must be deleted separately.
Prerequisites

  1. The following data is required

    • ID of the domain that has to be deleted.

Tip
 Back up the data on the domain.
Tip
 Migrate the VMs that you want to retain, to another domain.
Steps

  1. Initialize the deletion.

Warning
 It is not possible to delete a domain without having marked it for deletion. This 2-step deletion ensures that a domain is not deleted accidentally.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/domains/f74c2d97-621a-4984-9ab6-5d84effde82f' -i -u 'admin:VMwareInfra@1' -X PATCH \
    -H 'Content-Type: application/json' \
    -d '{
  "markForDeletion" : true
}'

HTTP Request

PATCH /v1/domains/f74c2d97-621a-4984-9ab6-5d84effde82f HTTP/1.1
Content-Length: 30
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==
Content-Type: application/json

{
  "markForDeletion" : true
}

HTTP Response

HTTP/1.1 200 OK

  1. Trigger the deletion.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/domains/f74c2d97-621a-4984-9ab6-5d84effde82f' -i -u 'admin:VMwareInfra@1' -X DELETE

HTTP Request

DELETE /v1/domains/f74c2d97-621a-4984-9ab6-5d84effde82f HTTP/1.1
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==

HTTP Response

HTTP/1.1 202 Accepted
Content-Length: 142
Location: /v1/tasks/cdcb44bd-c0bb-4cf4-a2f9-24658c63f977
Content-Type: application/json

{
  "id" : "cdcb44bd-c0bb-4cf4-a2f9-24658c63f977",
  "name" : "",
  "status" : "UNKNOWN",
  "creationTimestamp" : "2019-10-12T04:33:17.840Z"
}

  1. Poll the task until "status" is not "IN_PROGRESS" using the "id" from the previous response.

Tip
 Refer to: Get a Task.

  • If the "status" is "SUCCESSFUL", the task is completed successfully.

  • If the "status" is "FAILED", the task can be re-executed.

Tip
 Refer to: Retry a Task.
Related APIs

Get the Domains
Get a Domain
Update a Domain by marking for deletion
Get a Task
Retry a Task

2.8. Clusters

2.8.1. Create a Cluster

After you add the primary cluster, you can add more clusters to expand the domain.

Prerequisites

  1. The following data is required

    • ID of the domain in which the cluster is to be created

    • Cluster details

      • Name of the cluster

      • Hosts details

        • ID of the host (UUID)

        • License key for the host

        • List of VDS names to associate with host

        • ID of the vmNic host to be associated with VDS, once added to cluster

      • Datastore details

        Note
        		 Only one of "vsanDatastoreSpec" (For VSAN), "nfsDatastoreSpec" (For NFS) or "vmfsDatastoreSpec" (For VMFS on FC) must be specified.

        • For VSAN

          • Number of host failures to tolerate (can be 0, 1, or 2)

          • License key for the vSAN datastore

            {
  "vsanDatastoreSpec" : {
    "failuresToTolerate" : 1,
    "licenseKey" : "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
    "datastoreName" : "vSanDatastore"
  }
}

        • For NFS

          • List of NFS server names

          • Shared directory path

          • User tag used to annotate NFS share

          • Boolean to identify if the mount directory should be read-only

            {
  "nfsDatastoreSpecs" : [ {
    "nasVolume" : {
      "serverName" : [ "10.0.0.250" ],
      "path" : "/nfs_mount/my_read_write_folder",
      "readOnly" : false
    },
    "datastoreName" : "NFSShare"
  } ]
}

        • For VMFS on FC

          • Ensure that the ESXi hosts have the given VMFS on FC datastore name configured.

          {
  "vmfsDatastoreSpec" : {
    "fcSpec" : [ {
      "datastoreName" : "sample-vmfs-on-fc-datastore-name"
    } ]
  }
}

        • Network Details

          • List of VDS details

            • For each VDS

              • Port group names and the corresponding transport type

              • DVS host Infrastructure traffic resource type

              • Maximum allowed usage for a traffic class

              • Amount of bandwidth to be reserved for the host infrastructure traffic class

          • NSX cluster Details

            Note
            		 Only one of "nsxVClusterSpec" (For NSX-V) or "nsxTClusterSpec" (For NSX-T) must be specified.

            • For NSX-V

              • VLAN ID of the VXLAN

              • License key for NSX

              • VDS to be used for VXLAN traffic/port group. This should belong to one of the VDS being created for the cluster

        {
  "nsxVClusterSpec" : {
    "vlanId" : 3,
    "vdsNameForVxlanConfig" : "SDDC-Dswitch-Private1"
  }
}

        • For NSX-T

          • VLAN ID of Geneve

    {
  "nsxTClusterSpec" : {
    "geneveVlanId" : 2
  }
}

  2. Network pool must be configured.

  3. Logical VMware Cloud Foundation container (Workload Domain) must be provisioned.

Note
 NSX manager and controller is configured when domain is created.

  1. Prerequisites for vSAN, NFS or VMFS on FC must be met.

  2. License key details may be provisioned in vCenter.

  3. Host configuration must have minimum two active vmNics.

  4. There must be at least three hosts available in the VMware Cloud Foundation inventory.

  5. Ensure that the hosts you want to add to the cluster are in UNASSIGNED_USEABLE state.

  6. You must have valid host and vSAN (if using vSAN storage) license key specified with adequate sockets available for the host to be added.

  7. A DHCP server must be configured on the VXLAN VLAN of the management domain. When NSX creates VXLAN VTEPs for the domain, they are assigned IP addresses from the DHCP server.

Steps

  1. Validate the input specification.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/clusters/validations' -i -u 'admin:VMwareInfra@1' -X POST \
    -H 'Content-Type: application/json' \
    -d '{
  "clusterCreationSpec" : {
    "domainId" : "4dcb9c51-373c-46ea-bc63-5afa0f340e06",
    "computeSpec" : {
      "clusterSpecs" : [ {
        "name" : "Cluster1",
        "hostSpecs" : [ {
          "id" : "75903c2a-848f-4422-a0a6-e4ef85f39c75"
        } ],
        "datastoreSpec" : {
          "vsanDatastoreSpec" : {
            "failuresToTolerate" : 1,
            "licenseKey" : "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
            "datastoreName" : "vSanDatastore"
          }
        },
        "networkSpec" : {
          "vdsSpecs" : [ {
            "name" : "vRack-DSwitch",
            "portGroupSpecs" : [ {
              "name" : "SDDC-DPortGroup-Mgmt",
              "transportType" : "MANAGEMENT"
            }, {
              "name" : "SDDC-DPortGroup-VSAN",
              "transportType" : "VSAN"
            }, {
              "name" : "SDDC-DPortGroup-vMotion",
              "transportType" : "VMOTION"
            } ]
          } ],
          "nsxClusterSpec" : {
            "nsxVClusterSpec" : {
              "vlanId" : 0,
              "vdsNameForVxlanConfig" : "vds_name"
            }
          }
        }
      } ]
    }
  }
}'

HTTP Request

POST /v1/clusters/validations HTTP/1.1
Content-Length: 1151
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==
Content-Type: application/json

{
  "clusterCreationSpec" : {
    "domainId" : "4dcb9c51-373c-46ea-bc63-5afa0f340e06",
    "computeSpec" : {
      "clusterSpecs" : [ {
        "name" : "Cluster1",
        "hostSpecs" : [ {
          "id" : "75903c2a-848f-4422-a0a6-e4ef85f39c75"
        } ],
        "datastoreSpec" : {
          "vsanDatastoreSpec" : {
            "failuresToTolerate" : 1,
            "licenseKey" : "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
            "datastoreName" : "vSanDatastore"
          }
        },
        "networkSpec" : {
          "vdsSpecs" : [ {
            "name" : "vRack-DSwitch",
            "portGroupSpecs" : [ {
              "name" : "SDDC-DPortGroup-Mgmt",
              "transportType" : "MANAGEMENT"
            }, {
              "name" : "SDDC-DPortGroup-VSAN",
              "transportType" : "VSAN"
            }, {
              "name" : "SDDC-DPortGroup-vMotion",
              "transportType" : "VMOTION"
            } ]
          } ],
          "nsxClusterSpec" : {
            "nsxVClusterSpec" : {
              "vlanId" : 0,
              "vdsNameForVxlanConfig" : "vds_name"
            }
          }
        }
      } ]
    }
  }
}

HTTP Response

HTTP/1.1 200 OK
Content-Length: 292
Content-Type: application/json

{
  "id" : "7031bb6b-ed74-425f-9eb6-9242d30de964",
  "description" : "Validating Cluster Creation Spec",
  "executionStatus" : "COMPLETED",
  "resultStatus" : "SUCCEEDED",
  "validationChecks" : [ {
    "description" : "ClusterCreationSpecValidation",
    "resultStatus" : "SUCCEEDED"
  } ]
}

  1. In case of no errors in the input specification, the "executionStatus" is "COMPLETED" and "resultStatus" is "SUCCEEDED".

  2. In case of errors in the input specification, the "executionStatus" is "COMPLETED" and "resultStatus" is "FAILED".

    Note
    		 Make changes to the input specification and re-validate using a new API invocation.

  1. Trigger the task using the valid input specification.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/clusters' -i -u 'admin:VMwareInfra@1' -X POST \
    -H 'Content-Type: application/json' \
    -d '{
  "domainId" : "9244b2d9-c1c0-42ab-b59d-c16d35fe7818",
  "computeSpec" : {
    "clusterSpecs" : [ {
      "name" : "Cluster1",
      "hostSpecs" : [ {
        "id" : "a4047058-e15b-4b38-abfe-9f0fc1767aea"
      } ],
      "datastoreSpec" : {
        "vsanDatastoreSpec" : {
          "failuresToTolerate" : 1,
          "licenseKey" : "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
          "datastoreName" : "vSanDatastore"
        }
      },
      "networkSpec" : {
        "vdsSpecs" : [ {
          "name" : "vRack-DSwitch",
          "portGroupSpecs" : [ {
            "name" : "SDDC-DPortGroup-Mgmt",
            "transportType" : "MANAGEMENT"
          }, {
            "name" : "SDDC-DPortGroup-VSAN",
            "transportType" : "VSAN"
          }, {
            "name" : "SDDC-DPortGroup-vMotion",
            "transportType" : "VMOTION"
          } ]
        } ],
        "nsxClusterSpec" : {
          "nsxVClusterSpec" : {
            "vlanId" : 0,
            "vdsNameForVxlanConfig" : "vds_name"
          }
        }
      }
    } ]
  }
}'

HTTP Request

POST /v1/clusters HTTP/1.1
Host: sddc-manager.sfo01.rainpole.local
Content-Length: 1045
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==
Content-Type: application/json

{
  "domainId" : "9244b2d9-c1c0-42ab-b59d-c16d35fe7818",
  "computeSpec" : {
    "clusterSpecs" : [ {
      "name" : "Cluster1",
      "hostSpecs" : [ {
        "id" : "a4047058-e15b-4b38-abfe-9f0fc1767aea"
      } ],
      "datastoreSpec" : {
        "vsanDatastoreSpec" : {
          "failuresToTolerate" : 1,
          "licenseKey" : "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
          "datastoreName" : "vSanDatastore"
        }
      },
      "networkSpec" : {
        "vdsSpecs" : [ {
          "name" : "vRack-DSwitch",
          "portGroupSpecs" : [ {
            "name" : "SDDC-DPortGroup-Mgmt",
            "transportType" : "MANAGEMENT"
          }, {
            "name" : "SDDC-DPortGroup-VSAN",
            "transportType" : "VSAN"
          }, {
            "name" : "SDDC-DPortGroup-vMotion",
            "transportType" : "VMOTION"
          } ]
        } ],
        "nsxClusterSpec" : {
          "nsxVClusterSpec" : {
            "vlanId" : 0,
            "vdsNameForVxlanConfig" : "vds_name"
          }
        }
      }
    } ]
  }
}

HTTP Response

HTTP/1.1 202 Accepted
Content-Length: 142
Location: /v1/tasks/f62ffa1b-7387-4bdd-afda-72a03b10d070
Content-Type: application/json

{
  "id" : "f62ffa1b-7387-4bdd-afda-72a03b10d070",
  "name" : "",
  "status" : "UNKNOWN",
  "creationTimestamp" : "2019-10-12T04:32:20.409Z"
}

  1. Poll the task until "status" is not "IN_PROGRESS" using the "id" from the previous response.

Tip
 Refer to: Get a Task.

  • If the "status" is "SUCCESSFUL", the task is completed successfully.

  • If the "status" is "FAILED", the task can be re-executed.

Tip
 Refer to: Retry a Task.
Related APIs

Validate the input spec for clusters operations
Create a Cluster and add to an existing Domain
Get the Domains
Get a Domain
Get the Clusters
Get a Cluster
Get the Hosts
Get a Host
Get the Tasks
Get a Task
Retry a Task

2.8.2. Get the Clusters

Prerequisites

None

Steps

  1. Invoke the API.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/clusters' -i -u 'admin:VMwareInfra@1' -X GET

HTTP Request

GET /v1/clusters HTTP/1.1
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==

HTTP Response

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 1721

{
  "elements" : [ {
    "id" : "8045e44e-974e-4f43-9862-7f0326782655",
    "name" : "sfo01-m01-mgmt01",
    "primaryDatastoreName" : "sfo01-m01-vsan01",
    "primaryDatastoreType" : "VSAN",
    "hosts" : [ {
      "id" : "c0703437-6746-470b-9e1c-f9d3bbc9b1c5"
    }, {
      "id" : "c0703431-6742-470b-9e1d-f9d3bbc9b1c9"
    } ],
    "isStretched" : false
  }, {
    "id" : "8045e44e-974e-4f43-9862-7f0326782677",
    "name" : "sfo01-m01-wld01",
    "primaryDatastoreName" : "sfo01-m01-nfs01",
    "primaryDatastoreType" : "NFS",
    "hosts" : [ {
      "id" : "c0703437-6746-470z-9e1c-f9d3bbc9b1c6"
    }, {
      "id" : "c0703431-6742-470t-9e1d-f9d3bbc9b1c1"
    } ],
    "isStretched" : false
  }, {
    "id" : "8045e44e-974e-4f43-9861-7f0326782633",
    "name" : "sfo01-m01-wld02",
    "primaryDatastoreName" : "sfo01-m01-nfs02",
    "primaryDatastoreType" : "NFS",
    "hosts" : [ {
      "id" : "c0703437-6746-470e-9e1c-f9d3bbc9b1c3"
    }, {
      "id" : "c0703431-6742-470r-9e1d-f9d3bbc9b1c4"
    } ],
    "isStretched" : false
  }, {
    "id" : "8045e44e-974e-4f43-9861-7f0326782677",
    "name" : "sfo01-m01-wld03",
    "primaryDatastoreName" : "sfo01-m01-fc01",
    "primaryDatastoreType" : "FC",
    "hosts" : [ {
      "id" : "c0703437-6746-470e-9e2c-f9d3bbc9b1c3"
    }, {
      "id" : "c0703431-6742-460r-9e1d-f9d3bbc9b1c4"
    } ],
    "isStretched" : false
  }, {
    "id" : "2345e44e-974e-4f43-9862-7f0326782898",
    "name" : "SDDC-Cluster1",
    "primaryDatastoreName" : "sfo01-m01-vsan01",
    "primaryDatastoreType" : "VSAN",
    "hosts" : [ {
      "id" : "c0703437-6746-470b-9e1c-f9d3bbc9b1c5"
    }, {
      "id" : "c0703431-6742-470b-9e1d-f9d3bbc9b1c9"
    } ],
    "isStretched" : true
  } ]
}

Get the Stretched Clusters

Prerequisites

None

Steps

  1. Invoke the API.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/clusters?isStretched=true' -i -u 'admin:VMwareInfra@1' -X GET

HTTP Request

GET /v1/clusters?isStretched=true HTTP/1.1
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==

HTTP Response

HTTP/1.1 200 OK
Content-Length: 363
Content-Type: application/json;charset=UTF-8

{
  "elements" : [ {
    "id" : "2345e44e-974e-4f43-9862-7f0326782898",
    "name" : "sfo01-m01-mgmt01",
    "primaryDatastoreName" : "sfo01-m01-vsan01",
    "primaryDatastoreType" : "VSAN",
    "hosts" : [ {
      "id" : "c0703437-6746-470b-9e1c-f9d3bbc9b1c5"
    }, {
      "id" : "c0703431-6742-470b-9e1d-f9d3bbc9b1c9"
    } ],
    "isStretched" : true
  } ]
}

Get the Vanilla Clusters

Prerequisites

None

Steps

  1. Invoke the API.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/clusters?isStretched=false' -i -u 'admin:VMwareInfra@1' -X GET

HTTP Request

GET /v1/clusters?isStretched=false HTTP/1.1
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==

HTTP Response

HTTP/1.1 200 OK
Content-Length: 1382
Content-Type: application/json;charset=UTF-8

{
  "elements" : [ {
    "id" : "8045e44e-974e-4f43-9862-7f0326782655",
    "name" : "sfo01-m01-mgmt01",
    "primaryDatastoreName" : "sfo01-m01-vsan01",
    "primaryDatastoreType" : "VSAN",
    "hosts" : [ {
      "id" : "c0703437-6746-470b-9e1c-f9d3bbc9b1c5"
    }, {
      "id" : "c0703431-6742-470b-9e1d-f9d3bbc9b1c9"
    } ],
    "isStretched" : false
  }, {
    "id" : "8045e44e-974e-4f43-9862-7f0326782677",
    "name" : "sfo01-m01-wld01",
    "primaryDatastoreName" : "sfo01-m01-nfs01",
    "primaryDatastoreType" : "NFS",
    "hosts" : [ {
      "id" : "c0703437-6746-470z-9e1c-f9d3bbc9b1c6"
    }, {
      "id" : "c0703431-6742-470t-9e1d-f9d3bbc9b1c1"
    } ],
    "isStretched" : false
  }, {
    "id" : "8045e44e-974e-4f43-9861-7f0326782633",
    "name" : "sfo01-m01-wld02",
    "primaryDatastoreName" : "sfo01-m01-nfs02",
    "primaryDatastoreType" : "NFS",
    "hosts" : [ {
      "id" : "c0703437-6746-470e-9e1c-f9d3bbc9b1c3"
    }, {
      "id" : "c0703431-6742-470r-9e1d-f9d3bbc9b1c4"
    } ],
    "isStretched" : false
  }, {
    "id" : "8045e44e-974e-4f43-9861-7f0326782677",
    "name" : "sfo01-m01-wld03",
    "primaryDatastoreName" : "sfo01-m01-fc01",
    "primaryDatastoreType" : "FC",
    "hosts" : [ {
      "id" : "c0703437-6746-470e-9e2c-f9d3bbc9b1c3"
    }, {
      "id" : "c0703431-6742-460r-9e1d-f9d3bbc9b1c4"
    } ],
    "isStretched" : false
  } ]
}
Related APIs

Get the Clusters
Get a Cluster

2.8.3. Get a Cluster

Prerequisites

  1. The following data is required

    • ID of the cluster

Steps

  1. Invoke the API.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/clusters/8045e44e-974e-4f43-9862-7f0326782655' -i -u 'admin:VMwareInfra@1' -X GET

HTTP Request

GET /v1/clusters/8045e44e-974e-4f43-9862-7f0326782655 HTTP/1.1
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==

HTTP Response

HTTP/1.1 200 OK
Content-Length: 319
Content-Type: application/json;charset=UTF-8

{
  "id" : "8045e44e-974e-4f43-9862-7f0326782655",
  "name" : "sfo01-m01-mgmt01",
  "primaryDatastoreName" : "sfo01-m01-vsan01",
  "primaryDatastoreType" : "VSAN",
  "hosts" : [ {
    "id" : "c0703437-6746-470b-9e1c-f9d3bbc9b1c5"
  }, {
    "id" : "c0703431-6742-470b-9e1d-f9d3bbc9b1c9"
  } ],
  "isStretched" : false
}
Related APIs

Get the Clusters
Get a Cluster

2.8.4. Expand a Cluster

Adding an individual host to a cluster adds the resources of that host to the cluster. You can add multiple hosts at a time to a cluster.

Prerequisites

  1. The following data is required

    • ID of the cluster

    • For each host

      • ID of the host (UUID)

      • List of VDS names to associate with host

      • ID of the vmNic, host is associated to

    • License key of ESXi

  2. The cluster in a domain to which hosts are to be added must exist.

  3. There must be a host available in the VMware Cloud Foundation inventory.

  4. The hosts to be added must have been commissioned.

  5. Ensure that the host you want to add is in an active state.

  6. You must have a valid ESXi license specified with adequate sockets available for the host to be added.

  7. Ensure that the host to be added to the cluster matches the configuration of the hosts already in the cluster. This ensures a balanced configuration of the cluster.

  8. Cluster should be in Stretched state, if expansion to be performed is on Stretched cluster.

Steps

  1. Validate the input specification.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/clusters/2d54bb6c-637a-49a4-a94c-622671d0ab32/validations' -i -u 'admin:VMwareInfra@1' -X POST \
    -H 'Content-Type: application/json' \
    -d '{
  "clusterUpdateSpec" : {
    "clusterExpansionSpec" : {
      "hostSpecs" : [ {
        "id" : "c47b1148-c7fc-4fe7-9408-b83041ee233a"
      } ]
    }
  }
}'

HTTP Request

POST /v1/clusters/2d54bb6c-637a-49a4-a94c-622671d0ab32/validations HTTP/1.1
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==
Content-Type: application/json
Content-Length: 158

{
  "clusterUpdateSpec" : {
    "clusterExpansionSpec" : {
      "hostSpecs" : [ {
        "id" : "c47b1148-c7fc-4fe7-9408-b83041ee233a"
      } ]
    }
  }
}

HTTP Response

HTTP/1.1 200 OK
Content-Length: 294
Content-Type: application/json

{
  "id" : "ebea58a9-8384-49c2-ab6f-6d744e62aca8",
  "description" : "Validating Cluster Expansion Spec",
  "executionStatus" : "COMPLETED",
  "resultStatus" : "SUCCEEDED",
  "validationChecks" : [ {
    "description" : "ClusterExpansionSpecValidation",
    "resultStatus" : "SUCCEEDED"
  } ]
}

  1. In case of no errors in the input specification, the "executionStatus" is "COMPLETED" and "resultStatus" is "SUCCEEDED".

  2. In case of errors in the input specification, the "executionStatus" is "COMPLETED" and "resultStatus" is "FAILED".

    Note
    		 Make changes to the input specification and re-validate using a new API invocation.

  1. Trigger the task using the valid input specification.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/clusters/2d54bb6c-637a-49a4-a94c-622671d0ab32' -i -u 'admin:VMwareInfra@1' -X PATCH \
    -H 'Content-Type: application/json' \
    -d '{
  "clusterExpansionSpec" : {
    "hostSpecs" : [ {
      "id" : "8ae0f724-f4a7-4779-b358-d20edb90d40c"
    } ]
  }
}'

HTTP Request

PATCH /v1/clusters/2d54bb6c-637a-49a4-a94c-622671d0ab32 HTTP/1.1
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==
Content-Type: application/json
Content-Length: 118

{
  "clusterExpansionSpec" : {
    "hostSpecs" : [ {
      "id" : "8ae0f724-f4a7-4779-b358-d20edb90d40c"
    } ]
  }
}

HTTP Response

HTTP/1.1 202 Accepted
Content-Length: 142
Content-Type: application/json
Location: /v1/tasks/67a9dc36-13b0-42c0-8b0d-0774abd9e6b5

{
  "id" : "67a9dc36-13b0-42c0-8b0d-0774abd9e6b5",
  "name" : "",
  "status" : "UNKNOWN",
  "creationTimestamp" : "2019-10-12T04:32:18.312Z"
}

  1. Poll the task until "status" is not "IN_PROGRESS" using the "id" from the previous response.

Tip
 Refer to: Get a Task.

  • If the "status" is "SUCCESSFUL", the task is completed successfully.

  • If the "status" is "FAILED", the task can be re-executed.

Tip
 Refer to: Retry a Task.
Related APIs

Validate the input spec for operations on a cluster
Update a Cluster by adding or removing Hosts, Stretching a standard vSAN cluster, Unstretching a stretched cluster or by marking for deletion
Get the Hosts
Get a Host
Get the Tasks
Get a Task
Retry a Task

2.8.5. Compact a Cluster

When a host is removed from a cluster in a domain, the vSAN members are reduced. Ensure that you have enough hosts remaining to facilitate the configured vSAN availability. Failure to do so might result in the datastore being marked as read-only or in data loss.

Prerequisites

  1. The following data is required

    • For each host to be removed

      • ID of the host

Steps

  1. Validate the input specification.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/clusters/2d54bb6c-637a-49a4-a94c-622671d0ab32/validations' -i -u 'admin:VMwareInfra@1' -X POST \
    -H 'Content-Type: application/json' \
    -d '{
  "clusterUpdateSpec" : {
    "clusterCompactionSpec" : {
      "hosts" : [ {
        "id" : "f224a5b3-8c2e-402c-8337-6cabd9b24048"
      } ]
    }
  }
}'

HTTP Request

POST /v1/clusters/2d54bb6c-637a-49a4-a94c-622671d0ab32/validations HTTP/1.1
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==
Content-Type: application/json
Content-Length: 155

{
  "clusterUpdateSpec" : {
    "clusterCompactionSpec" : {
      "hosts" : [ {
        "id" : "f224a5b3-8c2e-402c-8337-6cabd9b24048"
      } ]
    }
  }
}

HTTP Response

HTTP/1.1 200 OK
Content-Length: 296
Content-Type: application/json

{
  "id" : "2d76fc93-60d5-4a60-bcca-60af30629fa7",
  "description" : "Validating Cluster Compaction Spec",
  "executionStatus" : "COMPLETED",
  "resultStatus" : "SUCCEEDED",
  "validationChecks" : [ {
    "description" : "ClusterCompactionSpecValidation",
    "resultStatus" : "SUCCEEDED"
  } ]
}

  1. In case of no errors in the input specification, the "executionStatus" is "COMPLETED" and "resultStatus" is "SUCCEEDED".

  2. In case of errors in the input specification, the "executionStatus" is "COMPLETED" and "resultStatus" is "FAILED".

    Note
    		 Make changes to the input specification and re-validate using a new API invocation.

  1. Trigger the task using the valid input specification.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/clusters/2d54bb6c-637a-49a4-a94c-622671d0ab32' -i -u 'admin:VMwareInfra@1' -X PATCH \
    -H 'Content-Type: application/json' \
    -d '{
  "clusterCompactionSpec" : {
    "hosts" : [ {
      "id" : "64230169-945c-48da-94cc-b2c5645b1a57"
    } ]
  }
}'

HTTP Request

PATCH /v1/clusters/2d54bb6c-637a-49a4-a94c-622671d0ab32 HTTP/1.1
Host: sddc-manager.sfo01.rainpole.local
Content-Length: 115
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==
Content-Type: application/json

{
  "clusterCompactionSpec" : {
    "hosts" : [ {
      "id" : "64230169-945c-48da-94cc-b2c5645b1a57"
    } ]
  }
}

HTTP Response

HTTP/1.1 202 Accepted
Content-Length: 142
Content-Type: application/json
Location: /v1/tasks/659f246c-1083-46b1-909b-18a325d81a19

{
  "id" : "659f246c-1083-46b1-909b-18a325d81a19",
  "name" : "",
  "status" : "UNKNOWN",
  "creationTimestamp" : "2019-10-12T04:32:22.276Z"
}

  1. Poll the task until "status" is not "IN_PROGRESS" using the "id" from the previous response.

Tip
 Refer to: Get a Task.

  • If the "status" is "SUCCESSFUL", the task is completed successfully.

  • If the "status" is "FAILED", the task can be re-executed.

Tip
 Refer to: Retry a Task.
Related APIs

Validate the input spec for operations on a cluster
Update a Cluster by adding or removing Hosts, Stretching a standard vSAN cluster, Unstretching a stretched cluster or by marking for deletion
Get the Hosts
Get a Host
Get the Tasks
Get a Task
Retry a Task

2.8.6. Stretch a Cluster

Convert a Standard vSAN cluster to a Stretched cluster

Prerequisites

  1. The following data is required

    • ID of the cluster

    • For each host

      • ID of the host (UUID)

      • License key of ESXi

    • For each Witness host

      • ID of witness host

      • FQDN of witness host

      • vSAN subnet cidr of witness host

  2. The cluster must exist.

  3. There must be a host available in the VMware Cloud Foundation inventory.

  4. The hosts to be added must have been commissioned.

  5. Ensure that the host you want to add is in an active state.

  6. You must have a valid ESXi license specified with adequate sockets available for the host to be added.

  7. Ensure that the host to be added to the cluster matches the configuration of the hosts already in the cluster. This ensures a balanced configuration of the cluster.

  8. vSAN witness should be configured.

  9. Underlying physical network should have proper MTUs and vSAN/vMotion connectivity between availability zones and the witness.

Steps

  1. Validate the input specification.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/clusters/2d54bb6c-637a-49a4-a94c-622671d0ab32/validations' -i -u 'admin:VMwareInfra@1' -X POST \
    -H 'Content-Type: application/json' \
    -d '{
  "clusterUpdateSpec" : {
    "clusterStretchSpec" : {
      "hostSpecs" : [ {
        "id" : "ab80ec8f-b919-4d27-b48b-b5f606415517",
        "licenseKey" : "7f21a8da-bde8-47c4-881e-6ae92b5751e3"
      } ],
      "witnessSpec" : {
        "vsanIp" : "10.0.4.88",
        "fqdn" : "witness-vsan.vrack.vsphere.local",
        "vsanCidr" : "10.0.4.0/24"
      }
    }
  }
}'

HTTP Request

POST /v1/clusters/2d54bb6c-637a-49a4-a94c-622671d0ab32/validations HTTP/1.1
Content-Length: 372
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==
Content-Type: application/json

{
  "clusterUpdateSpec" : {
    "clusterStretchSpec" : {
      "hostSpecs" : [ {
        "id" : "ab80ec8f-b919-4d27-b48b-b5f606415517",
        "licenseKey" : "7f21a8da-bde8-47c4-881e-6ae92b5751e3"
      } ],
      "witnessSpec" : {
        "vsanIp" : "10.0.4.88",
        "fqdn" : "witness-vsan.vrack.vsphere.local",
        "vsanCidr" : "10.0.4.0/24"
      }
    }
  }
}

HTTP Response

HTTP/1.1 200 OK
Content-Length: 290
Content-Type: application/json

{
  "id" : "9b43e1f2-9264-4bc3-b8e9-41d66c38ee4d",
  "description" : "Validating Cluster Stretch Spec",
  "executionStatus" : "COMPLETED",
  "resultStatus" : "SUCCEEDED",
  "validationChecks" : [ {
    "description" : "ClusterStretchSpecValidation",
    "resultStatus" : "SUCCEEDED"
  } ]
}

  1. In case of no errors in the input specification, the "executionStatus" is "COMPLETED" and "resultStatus" is "SUCCEEDED".

  2. In case of errors in the input specification, the "executionStatus" is "COMPLETED" and "resultStatus" is "FAILED".

    Note
    		 Make changes to the input specification and re-validate using a new API invocation.

  1. Trigger the task using the valid input specification.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/clusters/2d54bb6c-637a-49a4-a94c-622671d0ab32' -i -u 'admin:VMwareInfra@1' -X PATCH \
    -H 'Content-Type: application/json' \
    -d '{
  "clusterStretchSpec" : {
    "hostSpecs" : [ {
      "id" : "2247bbef-31b7-4043-b633-1d9771f3ef41",
      "licenseKey" : "eca3edb4-bae7-4ad0-aad4-2773c3781f58"
    } ],
    "witnessSpec" : {
      "vsanIp" : "10.0.4.88",
      "fqdn" : "witness-vsan.vrack.vsphere.local",
      "vsanCidr" : "10.0.4.0/24"
    }
  }
}'

HTTP Request

PATCH /v1/clusters/2d54bb6c-637a-49a4-a94c-622671d0ab32 HTTP/1.1
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==
Content-Type: application/json
Content-Length: 320

{
  "clusterStretchSpec" : {
    "hostSpecs" : [ {
      "id" : "2247bbef-31b7-4043-b633-1d9771f3ef41",
      "licenseKey" : "eca3edb4-bae7-4ad0-aad4-2773c3781f58"
    } ],
    "witnessSpec" : {
      "vsanIp" : "10.0.4.88",
      "fqdn" : "witness-vsan.vrack.vsphere.local",
      "vsanCidr" : "10.0.4.0/24"
    }
  }
}

HTTP Response

HTTP/1.1 202 Accepted
Location: /v1/tasks/0420db6a-01ff-4948-8a45-7346fd825058
Content-Length: 142
Content-Type: application/json

{
  "id" : "0420db6a-01ff-4948-8a45-7346fd825058",
  "name" : "",
  "status" : "UNKNOWN",
  "creationTimestamp" : "2019-10-12T04:32:21.062Z"
}

  1. Poll the task until "status" is not "IN_PROGRESS" using the "id" from the previous response.

Tip
 Refer to: Get a Task.

  • If the "status" is "SUCCESSFUL", the task is completed successfully.

  • If the "status" is "FAILED", the task can be re-executed.

Tip
 Refer to: Retry a Task.
Related APIs

Validate the input spec for operations on a cluster
Update a Cluster by adding or removing Hosts, Stretching a standard vSAN cluster, Unstretching a stretched cluster or by marking for deletion
Get the Clusters
Get the Tasks
Get a Task
Retry a Task

2.8.7. Unstretch a Cluster

Convert a Stretched cluster to a Standard vSAN cluster

Prerequisites

  1. The following data is required

    • ID of the cluster

  2. The cluster must exist.

  3. Cluster should be in Stretched state.

Steps

  1. Trigger the task using the valid input specification.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/clusters/2d54bb6c-637a-49a4-a94c-622671d0ab32' -i -u 'admin:VMwareInfra@1' -X PATCH \
    -H 'Content-Type: application/json' \
    -d '{
  "clusterUnstretchSpec" : { }
}'

HTTP Request

PATCH /v1/clusters/2d54bb6c-637a-49a4-a94c-622671d0ab32 HTTP/1.1
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==
Content-Type: application/json
Content-Length: 34

{
  "clusterUnstretchSpec" : { }
}

HTTP Response

HTTP/1.1 202 Accepted
Content-Length: 142
Content-Type: application/json
Location: /v1/tasks/b3a1294b-9f7d-4654-8ad7-b1909cc30efb

{
  "id" : "b3a1294b-9f7d-4654-8ad7-b1909cc30efb",
  "name" : "",
  "status" : "UNKNOWN",
  "creationTimestamp" : "2019-10-12T04:32:20.260Z"
}

  1. Poll the task until "status" is not "IN_PROGRESS" using the "id" from the previous response.

Tip
 Refer to: Get a Task.

  • If the "status" is "SUCCESSFUL", the task is completed successfully.

  • If the "status" is "FAILED", the task can be re-executed.

Tip
 Refer to: Retry a Task.
Related APIs

Update a Cluster by adding or removing Hosts, Stretching a standard vSAN cluster, Unstretching a stretched cluster or by marking for deletion
Get the Clusters
Get the Tasks
Get a Task
Retry a Task

2.8.8. Delete a Cluster

Warning
 Datastores on the ESXi hosts in the cluster that will be deleted are destroyed.
Note
 You cannot delete the last cluster in a domain. Instead, the domain can be deleted.
Prerequisites

  1. The following data is required

    • ID of the cluster to be deleted

  2. Ensure that a cluster with the given ID exists.

  3. The cluster has been marked for deletion.

  4. Migrate or backup the VMs and data on the data store associated with the cluster to another location.

Steps

  1. Initialize the deletion.

Warning
 It is not possible to delete a cluster without having marked it for deletion. This 2-step deletion ensures that a cluster is not deleted accidentally.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/clusters/2d54bb6c-637a-49a4-a94c-622671d0ab32' -i -u 'admin:VMwareInfra@1' -X PATCH \
    -H 'Content-Type: application/json' \
    -d '{
  "markForDeletion" : true
}'

HTTP Request

PATCH /v1/clusters/2d54bb6c-637a-49a4-a94c-622671d0ab32 HTTP/1.1
Content-Length: 30
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==
Content-Type: application/json

{
  "markForDeletion" : true
}

HTTP Response

HTTP/1.1 200 OK

  1. Trigger the deletion.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/clusters/2d54bb6c-637a-49a4-a94c-622671d0ab32' -i -u 'admin:VMwareInfra@1' -X DELETE

HTTP Request

DELETE /v1/clusters/2d54bb6c-637a-49a4-a94c-622671d0ab32 HTTP/1.1
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==

HTTP Response

HTTP/1.1 202 Accepted
Content-Length: 142
Location: /v1/tasks/ac8fe949-4981-48e9-95d9-d7cc741dc72b
Content-Type: application/json

{
  "id" : "ac8fe949-4981-48e9-95d9-d7cc741dc72b",
  "name" : "",
  "status" : "UNKNOWN",
  "creationTimestamp" : "2019-10-12T04:32:19.317Z"
}

  1. Poll the task until "status" is not "IN_PROGRESS" using the "id" from the previous response.

Tip
 Refer to: Get a Task.

  • If the "status" is "SUCCESSFUL", the task is completed successfully.

  • If the "status" is "FAILED", the task can be re-executed.

Tip
 Refer to: Retry a Task.
Related APIs

Get the Domains
Get a Domain
Get the Clusters
Get a Cluster
Update a Cluster by adding or removing Hosts, Stretching a standard vSAN cluster, Unstretching a stretched cluster or by marking for deletion
Get a Task
Retry a Task

2.9. Pivotal Container Service

2.9.1. Validate Pivotal Container Service specification

Prerequisites

  1. NSX-T Workload Domain.

    • An NSX-T backed workload domain must be prepared and available for consumption.

  2. DNS and IP Allocation

    • Prepare the IP addressees and forward/reserve DNS records for:

      1. PKS API

      2. Pivotal Operations Manager

      3. Harbor Registry (optional)

  3. Certificates

    • Generate the certificates and private keys from a trusted certificate authority that include the fully qualified domain names for each PKS management component.

  4. NSX-T Overlay Networking

    • Prepare the following NSX-T objects:

      1. NSX-T Tier-0 router

      2. NSX-T Tier-1 router

      3. node and pod IP blocks

      4. floating IP pool

  5. Availability Zones

    • Prepare the network settings and resources for the availability zones. This includes:

      1. network CIDR

      2. gateway

      3. reserved IP ranges

      4. target logical switch

      5. vSphere cluster for the management and the Kubernetes availability zones

    • At least three Kubernetes availability zones are recommended for a highly available deployment of your chosen application runtime.

Steps

  1. Invoke the API

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/pkses/validations' -i -u 'admin:VMwareInfra@1' -X POST \
    -H 'Content-Type: application/json' \
    -d '{
  "domainId" : "76df11e9-5c1f-4376-b913-0ea93ebda983",
  "name" : "PKS-1",
  "pksApiHostname" : "pksApi.sfo01.rainpole.local",
  "adminPassword" : "SecurePassword123!",
  "decryptionPassphrase" : "SecurePassword123!",
  "harborHostname" : "harbor.sfo01.rainpole.local",
  "installHarbor" : true,
  "nsxtItemsSpec" : {
    "t0routerId" : "bc3fda31-74b9-4759-8e1f-ff72726b8d5d",
    "nodesIpBlockId" : "b73446a0-9ffe-4291-b34f-ff0b6ee67ff3",
    "floatingIpPoolId" : "ee7d0bc1-0cd3-4c59-8944-65a36fe35cf7",
    "podsIpBlockId" : "6f5db6d2-30f6-47e3-a765-3ebc34390bce"
  },
  "pksOpsManagerVmSpec" : {
    "network" : {
      "network" : "network",
      "dnsServers" : [ "172.16.11.4", "172.16.11.5" ],
      "ntpServers" : [ "172.16.11.251", "172.16.11.252" ],
      "dnsSuffix" : "*.sfo01.rainpole.local",
      "gateway" : "10.255.0.1",
      "netmask" : "255.255.255.0"
    },
    "appliance" : {
      "ip" : "10.255.0.10",
      "hostname" : "pcf.sfo01.rainpole.local",
      "vmName" : "ops-manager"
    }
  },
  "availabilityZoneSpec" : {
    "managementNetwork" : {
      "vcenterNetwork" : "VcenterNetwork",
      "cidr" : "10.255.0.0/24",
      "gateway" : "10.255.0.1",
      "reservedRanges" : "10.255.0.1-10.255.0.10",
      "dnsServer" : "172.16.11.4"
    },
    "kubernetesNetwork" : {
      "vcenterNetwork" : "VcenterNetwork",
      "cidr" : "10.255.1.0/24",
      "gateway" : "10.255.1.1",
      "reservedRanges" : "10.255.1.1-10.255.1.10",
      "dnsServer" : "172.16.11.4"
    },
    "managementZone" : {
      "name" : "AZ1",
      "resourcePoolName" : "AZ1_Resource_Pool",
      "clusterName" : "pks-cluster"
    },
    "kubernetesZones" : [ {
      "name" : "AZ2",
      "resourcePoolName" : "AZ2_Resource_Pool",
      "clusterName" : "pks-cluster"
    }, {
      "name" : "AZ3",
      "resourcePoolName" : "AZ3_Resource_Pool",
      "clusterName" : "pks-cluster"
    } ]
  },
  "certificateBundle" : {
    "trustedCertificates" : "-----BEGIN CERTIFICATE-----\nMIIDNTCCAh2gAwIBAgIJAMFqmuO1XQb9MA0GCSqGSIb3DQEBCwUAMBYxFDASBgNV\nBAMMC0Vhc3ktUlNBIENBMB4XDTE5MDQwNjExMDQ0NVoXDTI5MDQwMzExMDQ0NVow\nFjEUMBIGA1UEAwwLRWFzeS1SU0EgQ0EwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAw\nggEKAoIBAQC2Mw1Zu/Uj2d1CrQUPG96rJS116tbTRtaIlRjWW2W+6Ng6S/wRxMKS\nQKQbx2MBYYJYC76PRAu1r1AkZMh7QhN/ohzJNrXa+C1UAkKg0zD6xqbxbSIsyYCV\n3WDyL2jRjPjbelveKV7AvP+rbratF3fH8PtnMa9Jp5/fkWI76T8GipF4dYW1vAxy\nApD464PWKvkz4Y2Ey20gr15W/L4gNFgXdaENW7aY9T9N8JuFpIbBK6QS1vV+w4XJ\nqlEilT2l0MYUA78zAOl4e8XI4awGmc0lHU60+87/Za7ODZbp93EtXkRTjR23Ybvh\nqvYmbc4bZu+u5wHz8Zf5Q9S5bzciUlQ5AgMBAAGjgYUwgYIwHQYDVR0OBBYEFLRw\nFacXernqj0VPJ4TgtLdhFG++MEYGA1UdIwQ/MD2AFLRwFacXernqj0VPJ4TgtLdh\nFG++oRqkGDAWMxcvaswweewWhjhHVDklhlsfgsBDQYIJAMFqmuO1XQb9MAwGA1Ud\nEwQFMAMBAf8wCwYDVR0PBAQDAgEGMA0GCSqGSIb3DQEBCwUAA4IBAQARdK+wt2xr\nPiEX25Fmdw5CGlom2WDL5fqB7f05EgkMCzAWHZeVjIoHF2aPmEZTuCymk8neLyw6\nY5P0maW8VHhNwD93uovZnn1qccERjaOWSuxE/lJUWnrt7n4lJhWs4WBCc1SFeuvj\nL/AJyRv/DnGDUw7eXPQYR2vPa1yHZt8jr4nA5gbINAenJ0rX48mDB3jaroXyOUWE\nLfqtuLlxmWDE9iF4Aqu1vwYltEvbQ3k2tgDy6gTQbNl7/9UKMvl3bHI6xwjONvut\nfSJHetpy1h3sN5/XkOBnoNXiuoiDxo83+yDeIfCdDnCMcu13ByvZ9xSM4rBPSQNk\nfnIFWgyCUH8F\n-----END CERTIFICATE-----",
    "pcfRsaCert" : {
      "publicCert" : "-----BEGIN CERTIFICATE-----\nMIIDhDCCAmygAwIBAgIQQ/1NNsYBUlTDTSEBUXrT3TANBgkqhkiG9w0BAQsFADAW\nMRQwEgYDVQQDDAtFYXN5LVJTQSBDQTAeFw0xOTA0MDYxMTA0NDVaFw0yMjAzMjEx\nMTA0NDVaMCUxIzAhBgNVBAMMGmhhcmJvci52cmFjay52c3BoZXJlLmxvY2FsMIIB\nIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAsT/VwtwC45Z/OJeuTmuN6PXZ\njkQ/pz/RFZv7K0z/SWUW7QX5EFqpg7Vns7Ie3pbUs2jDH7W1Dn4NbDSChUmImD4i\nUXLHhhp7QCNaemqwersdfasnYO6VIcG6uF9oTOcGKPV2D/JE45H4hdEPwF50U8Ze\nZACyToSJbc1gzElZX+zlGiq+D+6AOjhlULAJrkNzyCwvq3CSPi/eS/OCN7cGVt0+\nyxonIH7mJM/sNU2W3MnmHQOESxOe8I99aOUtYNuhHTiP5HWFfCbIfqGcWlMgBLiG\nEsFLrKql6Ci8HOrW4vOzwho3Q4eRjGhNWBHddmGL2vbpfHsESDBmqoOYaXc6eQID\nAQABo4G+MIG7MAkGA1UdEwQCMAAwHQYDVR0OBBYEFJVT9cvazVOlO5DS6ryMwubg\nJLruMEYGA1UdIwQ/MD2AFLRwFacXernqj0VPJ4TgtLdhFG++oRqkGDAWMRQwEgYD\nVQQDDAtFYXN5LVJTQSBDQYIJAMFqmuO1XQb9MBMGA1UdJQQMMAoGCCsGAQUFBwMB\nMAsGA1UdDwQEAwIFoDAlBgNVHREEHjAcghpoYXJib3IudnJhY2sudnNwaGVyZS5s\nb2NhbDANBgkqhkiG9w0BAQsFAAOCAQEAXJgFwsjBU4apGKJvex4ro4vO0iMiGx4r\nlL4JkozNp4JJGGfPWY3cAmeykAX3mUfPNRosp6KqwHKUvP+bU0hsLDd+mrCRsA/J\ndsyyhfJqbtB0Ez3bQdelAacKS8aaCt3cmXU+hrPGTOkCoOeeeiR6uZFuuywG8dld\ntUD9jFd6CkizVVqsyk/lmZ0mEapW+4+D6VhPzrMFlqwW3h+1WM6CmMRPOJc42wQI\nG1GEpi9Sghs7V/VkrO78dWBWe6mcfYv3OsxR5iyGiNtIfM99EnIknf01HO3kUlP8\nvgS2QcTyDdpj1VI2oUL2wM77SXGfUynnmL1fCEdU++qO/bb2tsTiXA==\n-----END CERTIFICATE-----",
      "privateKey" : "-----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKCAQEAsT/VwtwC45Z/OJeuTmuN6PXZjkQ/pz/RFZv7K0z/SWUW7QX5\nEFqpg7Vns7Ie3pbUs2jDH7W1Dn4NbDSChUmImD4iUXLHhhp7QCNaemu03y3Npwfn\nYO6VIcG6uF9oTOcGKPV2D/JE45H4hdEPwF50U8ZeZACyToSJbc1gzElZX+zlGiq+\nD+6AOjhlULAJrkNzyCwvq3CSPi/eS/OCN7cGVt0+yxonIH7mJM/sNU2W3MnmHQOE\nSxOe8I99aOUtYNuhHTiP5HWFfCbIfqGcWlMgBLiGEsFLrKql6Ci8HOrW4vOzwho3\nQ4eRjGhNWBHddmGL2vbpfHsESDBmqoOYaXc6eQIDAQABAoIBAAXAq6BiYZmfVcux\naI/U/8sSx5fNcT9tW8zWviUen55zMHZK3lWAi8XhilcTrdrNjGOyP7r0u8aXornj\nTmUjCNLgGV8JWZ5pl5xySUp12m3v35/PKtxDggWRcwzu08TDLrj/lnBYDZJRN36o\nVVmJ9z6Mzp1yRFc2B/vPUZfvvX3WdZLwYSQeV4JLlfhiyCE1cYdc6y4RLfpOHQiw\nnhyoHYf1Uumy8g7co41sdcsergCBiNQe98Mola+x9f5srP9eu/YCnx1twBRM66iG\noq8lwykAN4xMSGZDFxCkaFC59lA7ek46uaMjeYcCU09OxvGGJdoRpEMCPDCg3lFC\n2SS95YECgYEA4jUWjHcyuhWfk6CYchGzA+D06FE0aAi47m3XU1Wx1SfZXVNoKymk\n9ebyu0V4UadYnZK6mGgFOpay6md32V41cFwJIOcwX9CVzDW74+w6PkqHo6HRbhNi\n3HDkKc2H1nPEQKqrrBneHajV8KyK+1lJoh1IHqn9V14q1TP90gc5wmkCgYEAyJgO\nSV4PtTdcfPWwQ3ujPpR6Av3B4F8Y5akx3w2P8QY7Qraovvdehblhc5MO2iNkXWdJ\nDks+buil2V5DJv2/L1dSM6WqjBaQY39iQ9R3r6/qSgG/RxYnAqr28jgBBqtjnrI1\nJjMJTBzhKFvXAtCJAPGeJKae/ZHpxa61oOGxlZECgYAg/YkaV1AIn5q0VxmkmTw4\ndpiBQUaZXZxK+a4Ls1XKNpOW7tEkamBqlJIWCd2wWu2rnXilPZZ1owDY+toZ04mL\np4CVUeJWNv+B1txeM1eTOh9qF/GJUj560+QSzKzg8+VNYRbEdMlWHgeFoERsv+rj\nP84C2tvd4BfzHDAKb49W8QKBgDOwuz28t1+DPJoW1a0OFyrxJ9/NdEBVQR0tVGSe\nIhGCAZNXbnSHWhwrgSk/I/yiUiKfkvvT9+qsmNBCshtCGBoi7lPQxPoEdoCtOq0v\n+weS1VTszlWLJ9JQLAKO2/TUBX/HfFqznBm492xm/ikDg8pyeMYJCb9d8le2hadH\ngXOBAoGBAN+Q14/0v64qQCmUlqq14IKEGyt9OUCMSGF/PRcRreaO/okM/0E0+uCf\n9eEoUyDvvvyM3xyqltf428mbaBEpBzF/IUDrSlHieyTSdSzJm6E83HJzVcWHQ4Nu\n5Ct0EQnyYqrmw0C3hpoBz9sgsF4oFRX4h8b4ammWXnI+OEUKPIsp\n-----END RSA PRIVATE KEY-----"
    },
    "pksRsaCert" : {
      "publicCert" : "-----BEGIN CERTIFICATE-----\nMIIDhDCCAmygAwIBAgIQQ/1NNsYBUlTDTSEBUXrT3TANBgkqhkiG9w0BAQsFADAW\nMRQwEgYDVQQDDAtFYXN5LVJTQSBDQTAeFw0xOTA0MDYxMTA0NDVaFw0yMjAzMjEx\nMTA0NDVaMCUxIzAhBgNVBAMMGmhhcmJvci52cmFjay52c3BoZXJlLmxvY2FsMIIB\nIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAsT/VwtwC45Z/OJeuTmuN6PXZ\njkQ/pz/RFZv7K0z/SWUW7QX5EFqpg7Vns7Ie3pbUs2jDH7W1Dn4NbDSChUmImD4i\nUXLHhhp7QCNaemqwersdfasnYO6VIcG6uF9oTOcGKPV2D/JE45H4hdEPwF50U8Ze\nZACyToSJbc1gzElZX+zlGiq+D+6AOjhlULAJrkNzyCwvq3CSPi/eS/OCN7cGVt0+\nyxonIH7mJM/sNU2W3MnmHQOESxOe8I99aOUtYNuhHTiP5HWFfCbIfqGcWlMgBLiG\nEsFLrKql6Ci8HOrW4vOzwho3Q4eRjGhNWBHddmGL2vbpfHsESDBmqoOYaXc6eQID\nAQABo4G+MIG7MAkGA1UdEwQCMAAwHQYDVR0OBBYEFJVT9cvazVOlO5DS6ryMwubg\nJLruMEYGA1UdIwQ/MD2AFLRwFacXernqj0VPJ4TgtLdhFG++oRqkGDAWMRQwEgYD\nVQQDDAtFYXN5LVJTQSBDQYIJAMFqmuO1XQb9MBMGA1UdJQQMMAoGCCsGAQUFBwMB\nMAsGA1UdDwQEAwIFoDAlBgNVHREEHjAcghpoYXJib3IudnJhY2sudnNwaGVyZS5s\nb2NhbDANBgkqhkiG9w0BAQsFAAOCAQEAXJgFwsjBU4apGKJvex4ro4vO0iMiGx4r\nlL4JkozNp4JJGGfPWY3cAmeykAX3mUfPNRosp6KqwHKUvP+bU0hsLDd+mrCRsA/J\ndsyyhfJqbtB0Ez3bQdelAacKS8aaCt3cmXU+hrPGTOkCoOeeeiR6uZFuuywG8dld\ntUD9jFd6CkizVVqsyk/lmZ0mEapW+4+D6VhPzrMFlqwW3h+1WM6CmMRPOJc42wQI\nG1GEpi9Sghs7V/VkrO78dWBWe6mcfYv3OsxR5iyGiNtIfM99EnIknf01HO3kUlP8\nvgS2QcTyDdpj1VI2oUL2wM77SXGfUynnmL1fCEdU++qO/bb2tsTiXA==\n-----END CERTIFICATE-----",
      "privateKey" : "-----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKCAQEAsT/VwtwC45Z/OJeuTmuN6PXZjkQ/pz/RFZv7K0z/SWUW7QX5\nEFqpg7Vns7Ie3pbUs2jDH7W1Dn4NbDSChUmImD4iUXLHhhp7QCNaemu03y3Npwfn\nYO6VIcG6uF9oTOcGKPV2D/JE45H4hdEPwF50U8ZeZACyToSJbc1gzElZX+zlGiq+\nD+6AOjhlULAJrkNzyCwvq3CSPi/eS/OCN7cGVt0+yxonIH7mJM/sNU2W3MnmHQOE\nSxOe8I99aOUtYNuhHTiP5HWFfCbIfqGcWlMgBLiGEsFLrKql6Ci8HOrW4vOzwho3\nQ4eRjGhNWBHddmGL2vbpfHsESDBmqoOYaXc6eQIDAQABAoIBAAXAq6BiYZmfVcux\naI/U/8sSx5fNcT9tW8zWviUen55zMHZK3lWAi8XhilcTrdrNjGOyP7r0u8aXornj\nTmUjCNLgGV8JWZ5pl5xySUp12m3v35/PKtxDggWRcwzu08TDLrj/lnBYDZJRN36o\nVVmJ9z6Mzp1yRFc2B/vPUZfvvX3WdZLwYSQeV4JLlfhiyCE1cYdc6y4RLfpOHQiw\nnhyoHYf1Uumy8g7co41sdcsergCBiNQe98Mola+x9f5srP9eu/YCnx1twBRM66iG\noq8lwykAN4xMSGZDFxCkaFC59lA7ek46uaMjeYcCU09OxvGGJdoRpEMCPDCg3lFC\n2SS95YECgYEA4jUWjHcyuhWfk6CYchGzA+D06FE0aAi47m3XU1Wx1SfZXVNoKymk\n9ebyu0V4UadYnZK6mGgFOpay6md32V41cFwJIOcwX9CVzDW74+w6PkqHo6HRbhNi\n3HDkKc2H1nPEQKqrrBneHajV8KyK+1lJoh1IHqn9V14q1TP90gc5wmkCgYEAyJgO\nSV4PtTdcfPWwQ3ujPpR6Av3B4F8Y5akx3w2P8QY7Qraovvdehblhc5MO2iNkXWdJ\nDks+buil2V5DJv2/L1dSM6WqjBaQY39iQ9R3r6/qSgG/RxYnAqr28jgBBqtjnrI1\nJjMJTBzhKFvXAtCJAPGeJKae/ZHpxa61oOGxlZECgYAg/YkaV1AIn5q0VxmkmTw4\ndpiBQUaZXZxK+a4Ls1XKNpOW7tEkamBqlJIWCd2wWu2rnXilPZZ1owDY+toZ04mL\np4CVUeJWNv+B1txeM1eTOh9qF/GJUj560+QSzKzg8+VNYRbEdMlWHgeFoERsv+rj\nP84C2tvd4BfzHDAKb49W8QKBgDOwuz28t1+DPJoW1a0OFyrxJ9/NdEBVQR0tVGSe\nIhGCAZNXbnSHWhwrgSk/I/yiUiKfkvvT9+qsmNBCshtCGBoi7lPQxPoEdoCtOq0v\n+weS1VTszlWLJ9JQLAKO2/TUBX/HfFqznBm492xm/ikDg8pyeMYJCb9d8le2hadH\ngXOBAoGBAN+Q14/0v64qQCmUlqq14IKEGyt9OUCMSGF/PRcRreaO/okM/0E0+uCf\n9eEoUyDvvvyM3xyqltf428mbaBEpBzF/IUDrSlHieyTSdSzJm6E83HJzVcWHQ4Nu\n5Ct0EQnyYqrmw0C3hpoBz9sgsF4oFRX4h8b4ammWXnI+OEUKPIsp\n-----END RSA PRIVATE KEY-----"
    },
    "nsxtRsaCert" : {
      "publicCert" : "-----BEGIN CERTIFICATE-----\nMIIDhDCCAmygAwIBAgIQQ/1NNsYBUlTDTSEBUXrT3TANBgkqhkiG9w0BAQsFADAW\nMRQwEgYDVQQDDAtFYXN5LVJTQSBDQTAeFw0xOTA0MDYxMTA0NDVaFw0yMjAzMjEx\nMTA0NDVaMCUxIzAhBgNVBAMMGmhhcmJvci52cmFjay52c3BoZXJlLmxvY2FsMIIB\nIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAsT/VwtwC45Z/OJeuTmuN6PXZ\njkQ/pz/RFZv7K0z/SWUW7QX5EFqpg7Vns7Ie3pbUs2jDH7W1Dn4NbDSChUmImD4i\nUXLHhhp7QCNaemqwersdfasnYO6VIcG6uF9oTOcGKPV2D/JE45H4hdEPwF50U8Ze\nZACyToSJbc1gzElZX+zlGiq+D+6AOjhlULAJrkNzyCwvq3CSPi/eS/OCN7cGVt0+\nyxonIH7mJM/sNU2W3MnmHQOESxOe8I99aOUtYNuhHTiP5HWFfCbIfqGcWlMgBLiG\nEsFLrKql6Ci8HOrW4vOzwho3Q4eRjGhNWBHddmGL2vbpfHsESDBmqoOYaXc6eQID\nAQABo4G+MIG7MAkGA1UdEwQCMAAwHQYDVR0OBBYEFJVT9cvazVOlO5DS6ryMwubg\nJLruMEYGA1UdIwQ/MD2AFLRwFacXernqj0VPJ4TgtLdhFG++oRqkGDAWMRQwEgYD\nVQQDDAtFYXN5LVJTQSBDQYIJAMFqmuO1XQb9MBMGA1UdJQQMMAoGCCsGAQUFBwMB\nMAsGA1UdDwQEAwIFoDAlBgNVHREEHjAcghpoYXJib3IudnJhY2sudnNwaGVyZS5s\nb2NhbDANBgkqhkiG9w0BAQsFAAOCAQEAXJgFwsjBU4apGKJvex4ro4vO0iMiGx4r\nlL4JkozNp4JJGGfPWY3cAmeykAX3mUfPNRosp6KqwHKUvP+bU0hsLDd+mrCRsA/J\ndsyyhfJqbtB0Ez3bQdelAacKS8aaCt3cmXU+hrPGTOkCoOeeeiR6uZFuuywG8dld\ntUD9jFd6CkizVVqsyk/lmZ0mEapW+4+D6VhPzrMFlqwW3h+1WM6CmMRPOJc42wQI\nG1GEpi9Sghs7V/VkrO78dWBWe6mcfYv3OsxR5iyGiNtIfM99EnIknf01HO3kUlP8\nvgS2QcTyDdpj1VI2oUL2wM77SXGfUynnmL1fCEdU++qO/bb2tsTiXA==\n-----END CERTIFICATE-----",
      "privateKey" : "-----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKCAQEAsT/VwtwC45Z/OJeuTmuN6PXZjkQ/pz/RFZv7K0z/SWUW7QX5\nEFqpg7Vns7Ie3pbUs2jDH7W1Dn4NbDSChUmImD4iUXLHhhp7QCNaemu03y3Npwfn\nYO6VIcG6uF9oTOcGKPV2D/JE45H4hdEPwF50U8ZeZACyToSJbc1gzElZX+zlGiq+\nD+6AOjhlULAJrkNzyCwvq3CSPi/eS/OCN7cGVt0+yxonIH7mJM/sNU2W3MnmHQOE\nSxOe8I99aOUtYNuhHTiP5HWFfCbIfqGcWlMgBLiGEsFLrKql6Ci8HOrW4vOzwho3\nQ4eRjGhNWBHddmGL2vbpfHsESDBmqoOYaXc6eQIDAQABAoIBAAXAq6BiYZmfVcux\naI/U/8sSx5fNcT9tW8zWviUen55zMHZK3lWAi8XhilcTrdrNjGOyP7r0u8aXornj\nTmUjCNLgGV8JWZ5pl5xySUp12m3v35/PKtxDggWRcwzu08TDLrj/lnBYDZJRN36o\nVVmJ9z6Mzp1yRFc2B/vPUZfvvX3WdZLwYSQeV4JLlfhiyCE1cYdc6y4RLfpOHQiw\nnhyoHYf1Uumy8g7co41sdcsergCBiNQe98Mola+x9f5srP9eu/YCnx1twBRM66iG\noq8lwykAN4xMSGZDFxCkaFC59lA7ek46uaMjeYcCU09OxvGGJdoRpEMCPDCg3lFC\n2SS95YECgYEA4jUWjHcyuhWfk6CYchGzA+D06FE0aAi47m3XU1Wx1SfZXVNoKymk\n9ebyu0V4UadYnZK6mGgFOpay6md32V41cFwJIOcwX9CVzDW74+w6PkqHo6HRbhNi\n3HDkKc2H1nPEQKqrrBneHajV8KyK+1lJoh1IHqn9V14q1TP90gc5wmkCgYEAyJgO\nSV4PtTdcfPWwQ3ujPpR6Av3B4F8Y5akx3w2P8QY7Qraovvdehblhc5MO2iNkXWdJ\nDks+buil2V5DJv2/L1dSM6WqjBaQY39iQ9R3r6/qSgG/RxYnAqr28jgBBqtjnrI1\nJjMJTBzhKFvXAtCJAPGeJKae/ZHpxa61oOGxlZECgYAg/YkaV1AIn5q0VxmkmTw4\ndpiBQUaZXZxK+a4Ls1XKNpOW7tEkamBqlJIWCd2wWu2rnXilPZZ1owDY+toZ04mL\np4CVUeJWNv+B1txeM1eTOh9qF/GJUj560+QSzKzg8+VNYRbEdMlWHgeFoERsv+rj\nP84C2tvd4BfzHDAKb49W8QKBgDOwuz28t1+DPJoW1a0OFyrxJ9/NdEBVQR0tVGSe\nIhGCAZNXbnSHWhwrgSk/I/yiUiKfkvvT9+qsmNBCshtCGBoi7lPQxPoEdoCtOq0v\n+weS1VTszlWLJ9JQLAKO2/TUBX/HfFqznBm492xm/ikDg8pyeMYJCb9d8le2hadH\ngXOBAoGBAN+Q14/0v64qQCmUlqq14IKEGyt9OUCMSGF/PRcRreaO/okM/0E0+uCf\n9eEoUyDvvvyM3xyqltf428mbaBEpBzF/IUDrSlHieyTSdSzJm6E83HJzVcWHQ4Nu\n5Ct0EQnyYqrmw0C3hpoBz9sgsF4oFRX4h8b4ammWXnI+OEUKPIsp\n-----END RSA PRIVATE KEY-----"
    },
    "harborRsaCert" : {
      "publicCert" : "-----BEGIN CERTIFICATE-----\nMIIDhDCCAmygAwIBAgIQQ/1NNsYBUlTDTSEBUXrT3TANBgkqhkiG9w0BAQsFADAW\nMRQwEgYDVQQDDAtFYXN5LVJTQSBDQTAeFw0xOTA0MDYxMTA0NDVaFw0yMjAzMjEx\nMTA0NDVaMCUxIzAhBgNVBAMMGmhhcmJvci52cmFjay52c3BoZXJlLmxvY2FsMIIB\nIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAsT/VwtwC45Z/OJeuTmuN6PXZ\njkQ/pz/RFZv7K0z/SWUW7QX5EFqpg7Vns7Ie3pbUs2jDH7W1Dn4NbDSChUmImD4i\nUXLHhhp7QCNaemqwersdfasnYO6VIcG6uF9oTOcGKPV2D/JE45H4hdEPwF50U8Ze\nZACyToSJbc1gzElZX+zlGiq+D+6AOjhlULAJrkNzyCwvq3CSPi/eS/OCN7cGVt0+\nyxonIH7mJM/sNU2W3MnmHQOESxOe8I99aOUtYNuhHTiP5HWFfCbIfqGcWlMgBLiG\nEsFLrKql6Ci8HOrW4vOzwho3Q4eRjGhNWBHddmGL2vbpfHsESDBmqoOYaXc6eQID\nAQABo4G+MIG7MAkGA1UdEwQCMAAwHQYDVR0OBBYEFJVT9cvazVOlO5DS6ryMwubg\nJLruMEYGA1UdIwQ/MD2AFLRwFacXernqj0VPJ4TgtLdhFG++oRqkGDAWMRQwEgYD\nVQQDDAtFYXN5LVJTQSBDQYIJAMFqmuO1XQb9MBMGA1UdJQQMMAoGCCsGAQUFBwMB\nMAsGA1UdDwQEAwIFoDAlBgNVHREEHjAcghpoYXJib3IudnJhY2sudnNwaGVyZS5s\nb2NhbDANBgkqhkiG9w0BAQsFAAOCAQEAXJgFwsjBU4apGKJvex4ro4vO0iMiGx4r\nlL4JkozNp4JJGGfPWY3cAmeykAX3mUfPNRosp6KqwHKUvP+bU0hsLDd+mrCRsA/J\ndsyyhfJqbtB0Ez3bQdelAacKS8aaCt3cmXU+hrPGTOkCoOeeeiR6uZFuuywG8dld\ntUD9jFd6CkizVVqsyk/lmZ0mEapW+4+D6VhPzrMFlqwW3h+1WM6CmMRPOJc42wQI\nG1GEpi9Sghs7V/VkrO78dWBWe6mcfYv3OsxR5iyGiNtIfM99EnIknf01HO3kUlP8\nvgS2QcTyDdpj1VI2oUL2wM77SXGfUynnmL1fCEdU++qO/bb2tsTiXA==\n-----END CERTIFICATE-----",
      "privateKey" : "-----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKCAQEAsT/VwtwC45Z/OJeuTmuN6PXZjkQ/pz/RFZv7K0z/SWUW7QX5\nEFqpg7Vns7Ie3pbUs2jDH7W1Dn4NbDSChUmImD4iUXLHhhp7QCNaemu03y3Npwfn\nYO6VIcG6uF9oTOcGKPV2D/JE45H4hdEPwF50U8ZeZACyToSJbc1gzElZX+zlGiq+\nD+6AOjhlULAJrkNzyCwvq3CSPi/eS/OCN7cGVt0+yxonIH7mJM/sNU2W3MnmHQOE\nSxOe8I99aOUtYNuhHTiP5HWFfCbIfqGcWlMgBLiGEsFLrKql6Ci8HOrW4vOzwho3\nQ4eRjGhNWBHddmGL2vbpfHsESDBmqoOYaXc6eQIDAQABAoIBAAXAq6BiYZmfVcux\naI/U/8sSx5fNcT9tW8zWviUen55zMHZK3lWAi8XhilcTrdrNjGOyP7r0u8aXornj\nTmUjCNLgGV8JWZ5pl5xySUp12m3v35/PKtxDggWRcwzu08TDLrj/lnBYDZJRN36o\nVVmJ9z6Mzp1yRFc2B/vPUZfvvX3WdZLwYSQeV4JLlfhiyCE1cYdc6y4RLfpOHQiw\nnhyoHYf1Uumy8g7co41sdcsergCBiNQe98Mola+x9f5srP9eu/YCnx1twBRM66iG\noq8lwykAN4xMSGZDFxCkaFC59lA7ek46uaMjeYcCU09OxvGGJdoRpEMCPDCg3lFC\n2SS95YECgYEA4jUWjHcyuhWfk6CYchGzA+D06FE0aAi47m3XU1Wx1SfZXVNoKymk\n9ebyu0V4UadYnZK6mGgFOpay6md32V41cFwJIOcwX9CVzDW74+w6PkqHo6HRbhNi\n3HDkKc2H1nPEQKqrrBneHajV8KyK+1lJoh1IHqn9V14q1TP90gc5wmkCgYEAyJgO\nSV4PtTdcfPWwQ3ujPpR6Av3B4F8Y5akx3w2P8QY7Qraovvdehblhc5MO2iNkXWdJ\nDks+buil2V5DJv2/L1dSM6WqjBaQY39iQ9R3r6/qSgG/RxYnAqr28jgBBqtjnrI1\nJjMJTBzhKFvXAtCJAPGeJKae/ZHpxa61oOGxlZECgYAg/YkaV1AIn5q0VxmkmTw4\ndpiBQUaZXZxK+a4Ls1XKNpOW7tEkamBqlJIWCd2wWu2rnXilPZZ1owDY+toZ04mL\np4CVUeJWNv+B1txeM1eTOh9qF/GJUj560+QSzKzg8+VNYRbEdMlWHgeFoERsv+rj\nP84C2tvd4BfzHDAKb49W8QKBgDOwuz28t1+DPJoW1a0OFyrxJ9/NdEBVQR0tVGSe\nIhGCAZNXbnSHWhwrgSk/I/yiUiKfkvvT9+qsmNBCshtCGBoi7lPQxPoEdoCtOq0v\n+weS1VTszlWLJ9JQLAKO2/TUBX/HfFqznBm492xm/ikDg8pyeMYJCb9d8le2hadH\ngXOBAoGBAN+Q14/0v64qQCmUlqq14IKEGyt9OUCMSGF/PRcRreaO/okM/0E0+uCf\n9eEoUyDvvvyM3xyqltf428mbaBEpBzF/IUDrSlHieyTSdSzJm6E83HJzVcWHQ4Nu\n5Ct0EQnyYqrmw0C3hpoBz9sgsF4oFRX4h8b4ammWXnI+OEUKPIsp\n-----END RSA PRIVATE KEY-----"
    }
  },
  "datastore" : "datastore"
}'

HTTP Request

POST /v1/pkses/validations HTTP/1.1
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==
Content-Type: application/json
Content-Length: 15494

{
  "domainId" : "76df11e9-5c1f-4376-b913-0ea93ebda983",
  "name" : "PKS-1",
  "pksApiHostname" : "pksApi.sfo01.rainpole.local",
  "adminPassword" : "SecurePassword123!",
  "decryptionPassphrase" : "SecurePassword123!",
  "harborHostname" : "harbor.sfo01.rainpole.local",
  "installHarbor" : true,
  "nsxtItemsSpec" : {
    "t0routerId" : "bc3fda31-74b9-4759-8e1f-ff72726b8d5d",
    "nodesIpBlockId" : "b73446a0-9ffe-4291-b34f-ff0b6ee67ff3",
    "floatingIpPoolId" : "ee7d0bc1-0cd3-4c59-8944-65a36fe35cf7",
    "podsIpBlockId" : "6f5db6d2-30f6-47e3-a765-3ebc34390bce"
  },
  "pksOpsManagerVmSpec" : {
    "network" : {
      "network" : "network",
      "dnsServers" : [ "172.16.11.4", "172.16.11.5" ],
      "ntpServers" : [ "172.16.11.251", "172.16.11.252" ],
      "dnsSuffix" : "*.sfo01.rainpole.local",
      "gateway" : "10.255.0.1",
      "netmask" : "255.255.255.0"
    },
    "appliance" : {
      "ip" : "10.255.0.10",
      "hostname" : "pcf.sfo01.rainpole.local",
      "vmName" : "ops-manager"
    }
  },
  "availabilityZoneSpec" : {
    "managementNetwork" : {
      "vcenterNetwork" : "VcenterNetwork",
      "cidr" : "10.255.0.0/24",
      "gateway" : "10.255.0.1",
      "reservedRanges" : "10.255.0.1-10.255.0.10",
      "dnsServer" : "172.16.11.4"
    },
    "kubernetesNetwork" : {
      "vcenterNetwork" : "VcenterNetwork",
      "cidr" : "10.255.1.0/24",
      "gateway" : "10.255.1.1",
      "reservedRanges" : "10.255.1.1-10.255.1.10",
      "dnsServer" : "172.16.11.4"
    },
    "managementZone" : {
      "name" : "AZ1",
      "resourcePoolName" : "AZ1_Resource_Pool",
      "clusterName" : "pks-cluster"
    },
    "kubernetesZones" : [ {
      "name" : "AZ2",
      "resourcePoolName" : "AZ2_Resource_Pool",
      "clusterName" : "pks-cluster"
    }, {
      "name" : "AZ3",
      "resourcePoolName" : "AZ3_Resource_Pool",
      "clusterName" : "pks-cluster"
    } ]
  },
  "certificateBundle" : {
    "trustedCertificates" : "-----BEGIN CERTIFICATE-----\nMIIDNTCCAh2gAwIBAgIJAMFqmuO1XQb9MA0GCSqGSIb3DQEBCwUAMBYxFDASBgNV\nBAMMC0Vhc3ktUlNBIENBMB4XDTE5MDQwNjExMDQ0NVoXDTI5MDQwMzExMDQ0NVow\nFjEUMBIGA1UEAwwLRWFzeS1SU0EgQ0EwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAw\nggEKAoIBAQC2Mw1Zu/Uj2d1CrQUPG96rJS116tbTRtaIlRjWW2W+6Ng6S/wRxMKS\nQKQbx2MBYYJYC76PRAu1r1AkZMh7QhN/ohzJNrXa+C1UAkKg0zD6xqbxbSIsyYCV\n3WDyL2jRjPjbelveKV7AvP+rbratF3fH8PtnMa9Jp5/fkWI76T8GipF4dYW1vAxy\nApD464PWKvkz4Y2Ey20gr15W/L4gNFgXdaENW7aY9T9N8JuFpIbBK6QS1vV+w4XJ\nqlEilT2l0MYUA78zAOl4e8XI4awGmc0lHU60+87/Za7ODZbp93EtXkRTjR23Ybvh\nqvYmbc4bZu+u5wHz8Zf5Q9S5bzciUlQ5AgMBAAGjgYUwgYIwHQYDVR0OBBYEFLRw\nFacXernqj0VPJ4TgtLdhFG++MEYGA1UdIwQ/MD2AFLRwFacXernqj0VPJ4TgtLdh\nFG++oRqkGDAWMxcvaswweewWhjhHVDklhlsfgsBDQYIJAMFqmuO1XQb9MAwGA1Ud\nEwQFMAMBAf8wCwYDVR0PBAQDAgEGMA0GCSqGSIb3DQEBCwUAA4IBAQARdK+wt2xr\nPiEX25Fmdw5CGlom2WDL5fqB7f05EgkMCzAWHZeVjIoHF2aPmEZTuCymk8neLyw6\nY5P0maW8VHhNwD93uovZnn1qccERjaOWSuxE/lJUWnrt7n4lJhWs4WBCc1SFeuvj\nL/AJyRv/DnGDUw7eXPQYR2vPa1yHZt8jr4nA5gbINAenJ0rX48mDB3jaroXyOUWE\nLfqtuLlxmWDE9iF4Aqu1vwYltEvbQ3k2tgDy6gTQbNl7/9UKMvl3bHI6xwjONvut\nfSJHetpy1h3sN5/XkOBnoNXiuoiDxo83+yDeIfCdDnCMcu13ByvZ9xSM4rBPSQNk\nfnIFWgyCUH8F\n-----END CERTIFICATE-----",
    "pcfRsaCert" : {
      "publicCert" : "-----BEGIN CERTIFICATE-----\nMIIDhDCCAmygAwIBAgIQQ/1NNsYBUlTDTSEBUXrT3TANBgkqhkiG9w0BAQsFADAW\nMRQwEgYDVQQDDAtFYXN5LVJTQSBDQTAeFw0xOTA0MDYxMTA0NDVaFw0yMjAzMjEx\nMTA0NDVaMCUxIzAhBgNVBAMMGmhhcmJvci52cmFjay52c3BoZXJlLmxvY2FsMIIB\nIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAsT/VwtwC45Z/OJeuTmuN6PXZ\njkQ/pz/RFZv7K0z/SWUW7QX5EFqpg7Vns7Ie3pbUs2jDH7W1Dn4NbDSChUmImD4i\nUXLHhhp7QCNaemqwersdfasnYO6VIcG6uF9oTOcGKPV2D/JE45H4hdEPwF50U8Ze\nZACyToSJbc1gzElZX+zlGiq+D+6AOjhlULAJrkNzyCwvq3CSPi/eS/OCN7cGVt0+\nyxonIH7mJM/sNU2W3MnmHQOESxOe8I99aOUtYNuhHTiP5HWFfCbIfqGcWlMgBLiG\nEsFLrKql6Ci8HOrW4vOzwho3Q4eRjGhNWBHddmGL2vbpfHsESDBmqoOYaXc6eQID\nAQABo4G+MIG7MAkGA1UdEwQCMAAwHQYDVR0OBBYEFJVT9cvazVOlO5DS6ryMwubg\nJLruMEYGA1UdIwQ/MD2AFLRwFacXernqj0VPJ4TgtLdhFG++oRqkGDAWMRQwEgYD\nVQQDDAtFYXN5LVJTQSBDQYIJAMFqmuO1XQb9MBMGA1UdJQQMMAoGCCsGAQUFBwMB\nMAsGA1UdDwQEAwIFoDAlBgNVHREEHjAcghpoYXJib3IudnJhY2sudnNwaGVyZS5s\nb2NhbDANBgkqhkiG9w0BAQsFAAOCAQEAXJgFwsjBU4apGKJvex4ro4vO0iMiGx4r\nlL4JkozNp4JJGGfPWY3cAmeykAX3mUfPNRosp6KqwHKUvP+bU0hsLDd+mrCRsA/J\ndsyyhfJqbtB0Ez3bQdelAacKS8aaCt3cmXU+hrPGTOkCoOeeeiR6uZFuuywG8dld\ntUD9jFd6CkizVVqsyk/lmZ0mEapW+4+D6VhPzrMFlqwW3h+1WM6CmMRPOJc42wQI\nG1GEpi9Sghs7V/VkrO78dWBWe6mcfYv3OsxR5iyGiNtIfM99EnIknf01HO3kUlP8\nvgS2QcTyDdpj1VI2oUL2wM77SXGfUynnmL1fCEdU++qO/bb2tsTiXA==\n-----END CERTIFICATE-----",
      "privateKey" : "-----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKCAQEAsT/VwtwC45Z/OJeuTmuN6PXZjkQ/pz/RFZv7K0z/SWUW7QX5\nEFqpg7Vns7Ie3pbUs2jDH7W1Dn4NbDSChUmImD4iUXLHhhp7QCNaemu03y3Npwfn\nYO6VIcG6uF9oTOcGKPV2D/JE45H4hdEPwF50U8ZeZACyToSJbc1gzElZX+zlGiq+\nD+6AOjhlULAJrkNzyCwvq3CSPi/eS/OCN7cGVt0+yxonIH7mJM/sNU2W3MnmHQOE\nSxOe8I99aOUtYNuhHTiP5HWFfCbIfqGcWlMgBLiGEsFLrKql6Ci8HOrW4vOzwho3\nQ4eRjGhNWBHddmGL2vbpfHsESDBmqoOYaXc6eQIDAQABAoIBAAXAq6BiYZmfVcux\naI/U/8sSx5fNcT9tW8zWviUen55zMHZK3lWAi8XhilcTrdrNjGOyP7r0u8aXornj\nTmUjCNLgGV8JWZ5pl5xySUp12m3v35/PKtxDggWRcwzu08TDLrj/lnBYDZJRN36o\nVVmJ9z6Mzp1yRFc2B/vPUZfvvX3WdZLwYSQeV4JLlfhiyCE1cYdc6y4RLfpOHQiw\nnhyoHYf1Uumy8g7co41sdcsergCBiNQe98Mola+x9f5srP9eu/YCnx1twBRM66iG\noq8lwykAN4xMSGZDFxCkaFC59lA7ek46uaMjeYcCU09OxvGGJdoRpEMCPDCg3lFC\n2SS95YECgYEA4jUWjHcyuhWfk6CYchGzA+D06FE0aAi47m3XU1Wx1SfZXVNoKymk\n9ebyu0V4UadYnZK6mGgFOpay6md32V41cFwJIOcwX9CVzDW74+w6PkqHo6HRbhNi\n3HDkKc2H1nPEQKqrrBneHajV8KyK+1lJoh1IHqn9V14q1TP90gc5wmkCgYEAyJgO\nSV4PtTdcfPWwQ3ujPpR6Av3B4F8Y5akx3w2P8QY7Qraovvdehblhc5MO2iNkXWdJ\nDks+buil2V5DJv2/L1dSM6WqjBaQY39iQ9R3r6/qSgG/RxYnAqr28jgBBqtjnrI1\nJjMJTBzhKFvXAtCJAPGeJKae/ZHpxa61oOGxlZECgYAg/YkaV1AIn5q0VxmkmTw4\ndpiBQUaZXZxK+a4Ls1XKNpOW7tEkamBqlJIWCd2wWu2rnXilPZZ1owDY+toZ04mL\np4CVUeJWNv+B1txeM1eTOh9qF/GJUj560+QSzKzg8+VNYRbEdMlWHgeFoERsv+rj\nP84C2tvd4BfzHDAKb49W8QKBgDOwuz28t1+DPJoW1a0OFyrxJ9/NdEBVQR0tVGSe\nIhGCAZNXbnSHWhwrgSk/I/yiUiKfkvvT9+qsmNBCshtCGBoi7lPQxPoEdoCtOq0v\n+weS1VTszlWLJ9JQLAKO2/TUBX/HfFqznBm492xm/ikDg8pyeMYJCb9d8le2hadH\ngXOBAoGBAN+Q14/0v64qQCmUlqq14IKEGyt9OUCMSGF/PRcRreaO/okM/0E0+uCf\n9eEoUyDvvvyM3xyqltf428mbaBEpBzF/IUDrSlHieyTSdSzJm6E83HJzVcWHQ4Nu\n5Ct0EQnyYqrmw0C3hpoBz9sgsF4oFRX4h8b4ammWXnI+OEUKPIsp\n-----END RSA PRIVATE KEY-----"
    },
    "pksRsaCert" : {
      "publicCert" : "-----BEGIN CERTIFICATE-----\nMIIDhDCCAmygAwIBAgIQQ/1NNsYBUlTDTSEBUXrT3TANBgkqhkiG9w0BAQsFADAW\nMRQwEgYDVQQDDAtFYXN5LVJTQSBDQTAeFw0xOTA0MDYxMTA0NDVaFw0yMjAzMjEx\nMTA0NDVaMCUxIzAhBgNVBAMMGmhhcmJvci52cmFjay52c3BoZXJlLmxvY2FsMIIB\nIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAsT/VwtwC45Z/OJeuTmuN6PXZ\njkQ/pz/RFZv7K0z/SWUW7QX5EFqpg7Vns7Ie3pbUs2jDH7W1Dn4NbDSChUmImD4i\nUXLHhhp7QCNaemqwersdfasnYO6VIcG6uF9oTOcGKPV2D/JE45H4hdEPwF50U8Ze\nZACyToSJbc1gzElZX+zlGiq+D+6AOjhlULAJrkNzyCwvq3CSPi/eS/OCN7cGVt0+\nyxonIH7mJM/sNU2W3MnmHQOESxOe8I99aOUtYNuhHTiP5HWFfCbIfqGcWlMgBLiG\nEsFLrKql6Ci8HOrW4vOzwho3Q4eRjGhNWBHddmGL2vbpfHsESDBmqoOYaXc6eQID\nAQABo4G+MIG7MAkGA1UdEwQCMAAwHQYDVR0OBBYEFJVT9cvazVOlO5DS6ryMwubg\nJLruMEYGA1UdIwQ/MD2AFLRwFacXernqj0VPJ4TgtLdhFG++oRqkGDAWMRQwEgYD\nVQQDDAtFYXN5LVJTQSBDQYIJAMFqmuO1XQb9MBMGA1UdJQQMMAoGCCsGAQUFBwMB\nMAsGA1UdDwQEAwIFoDAlBgNVHREEHjAcghpoYXJib3IudnJhY2sudnNwaGVyZS5s\nb2NhbDANBgkqhkiG9w0BAQsFAAOCAQEAXJgFwsjBU4apGKJvex4ro4vO0iMiGx4r\nlL4JkozNp4JJGGfPWY3cAmeykAX3mUfPNRosp6KqwHKUvP+bU0hsLDd+mrCRsA/J\ndsyyhfJqbtB0Ez3bQdelAacKS8aaCt3cmXU+hrPGTOkCoOeeeiR6uZFuuywG8dld\ntUD9jFd6CkizVVqsyk/lmZ0mEapW+4+D6VhPzrMFlqwW3h+1WM6CmMRPOJc42wQI\nG1GEpi9Sghs7V/VkrO78dWBWe6mcfYv3OsxR5iyGiNtIfM99EnIknf01HO3kUlP8\nvgS2QcTyDdpj1VI2oUL2wM77SXGfUynnmL1fCEdU++qO/bb2tsTiXA==\n-----END CERTIFICATE-----",
      "privateKey" : "-----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKCAQEAsT/VwtwC45Z/OJeuTmuN6PXZjkQ/pz/RFZv7K0z/SWUW7QX5\nEFqpg7Vns7Ie3pbUs2jDH7W1Dn4NbDSChUmImD4iUXLHhhp7QCNaemu03y3Npwfn\nYO6VIcG6uF9oTOcGKPV2D/JE45H4hdEPwF50U8ZeZACyToSJbc1gzElZX+zlGiq+\nD+6AOjhlULAJrkNzyCwvq3CSPi/eS/OCN7cGVt0+yxonIH7mJM/sNU2W3MnmHQOE\nSxOe8I99aOUtYNuhHTiP5HWFfCbIfqGcWlMgBLiGEsFLrKql6Ci8HOrW4vOzwho3\nQ4eRjGhNWBHddmGL2vbpfHsESDBmqoOYaXc6eQIDAQABAoIBAAXAq6BiYZmfVcux\naI/U/8sSx5fNcT9tW8zWviUen55zMHZK3lWAi8XhilcTrdrNjGOyP7r0u8aXornj\nTmUjCNLgGV8JWZ5pl5xySUp12m3v35/PKtxDggWRcwzu08TDLrj/lnBYDZJRN36o\nVVmJ9z6Mzp1yRFc2B/vPUZfvvX3WdZLwYSQeV4JLlfhiyCE1cYdc6y4RLfpOHQiw\nnhyoHYf1Uumy8g7co41sdcsergCBiNQe98Mola+x9f5srP9eu/YCnx1twBRM66iG\noq8lwykAN4xMSGZDFxCkaFC59lA7ek46uaMjeYcCU09OxvGGJdoRpEMCPDCg3lFC\n2SS95YECgYEA4jUWjHcyuhWfk6CYchGzA+D06FE0aAi47m3XU1Wx1SfZXVNoKymk\n9ebyu0V4UadYnZK6mGgFOpay6md32V41cFwJIOcwX9CVzDW74+w6PkqHo6HRbhNi\n3HDkKc2H1nPEQKqrrBneHajV8KyK+1lJoh1IHqn9V14q1TP90gc5wmkCgYEAyJgO\nSV4PtTdcfPWwQ3ujPpR6Av3B4F8Y5akx3w2P8QY7Qraovvdehblhc5MO2iNkXWdJ\nDks+buil2V5DJv2/L1dSM6WqjBaQY39iQ9R3r6/qSgG/RxYnAqr28jgBBqtjnrI1\nJjMJTBzhKFvXAtCJAPGeJKae/ZHpxa61oOGxlZECgYAg/YkaV1AIn5q0VxmkmTw4\ndpiBQUaZXZxK+a4Ls1XKNpOW7tEkamBqlJIWCd2wWu2rnXilPZZ1owDY+toZ04mL\np4CVUeJWNv+B1txeM1eTOh9qF/GJUj560+QSzKzg8+VNYRbEdMlWHgeFoERsv+rj\nP84C2tvd4BfzHDAKb49W8QKBgDOwuz28t1+DPJoW1a0OFyrxJ9/NdEBVQR0tVGSe\nIhGCAZNXbnSHWhwrgSk/I/yiUiKfkvvT9+qsmNBCshtCGBoi7lPQxPoEdoCtOq0v\n+weS1VTszlWLJ9JQLAKO2/TUBX/HfFqznBm492xm/ikDg8pyeMYJCb9d8le2hadH\ngXOBAoGBAN+Q14/0v64qQCmUlqq14IKEGyt9OUCMSGF/PRcRreaO/okM/0E0+uCf\n9eEoUyDvvvyM3xyqltf428mbaBEpBzF/IUDrSlHieyTSdSzJm6E83HJzVcWHQ4Nu\n5Ct0EQnyYqrmw0C3hpoBz9sgsF4oFRX4h8b4ammWXnI+OEUKPIsp\n-----END RSA PRIVATE KEY-----"
    },
    "nsxtRsaCert" : {
      "publicCert" : "-----BEGIN CERTIFICATE-----\nMIIDhDCCAmygAwIBAgIQQ/1NNsYBUlTDTSEBUXrT3TANBgkqhkiG9w0BAQsFADAW\nMRQwEgYDVQQDDAtFYXN5LVJTQSBDQTAeFw0xOTA0MDYxMTA0NDVaFw0yMjAzMjEx\nMTA0NDVaMCUxIzAhBgNVBAMMGmhhcmJvci52cmFjay52c3BoZXJlLmxvY2FsMIIB\nIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAsT/VwtwC45Z/OJeuTmuN6PXZ\njkQ/pz/RFZv7K0z/SWUW7QX5EFqpg7Vns7Ie3pbUs2jDH7W1Dn4NbDSChUmImD4i\nUXLHhhp7QCNaemqwersdfasnYO6VIcG6uF9oTOcGKPV2D/JE45H4hdEPwF50U8Ze\nZACyToSJbc1gzElZX+zlGiq+D+6AOjhlULAJrkNzyCwvq3CSPi/eS/OCN7cGVt0+\nyxonIH7mJM/sNU2W3MnmHQOESxOe8I99aOUtYNuhHTiP5HWFfCbIfqGcWlMgBLiG\nEsFLrKql6Ci8HOrW4vOzwho3Q4eRjGhNWBHddmGL2vbpfHsESDBmqoOYaXc6eQID\nAQABo4G+MIG7MAkGA1UdEwQCMAAwHQYDVR0OBBYEFJVT9cvazVOlO5DS6ryMwubg\nJLruMEYGA1UdIwQ/MD2AFLRwFacXernqj0VPJ4TgtLdhFG++oRqkGDAWMRQwEgYD\nVQQDDAtFYXN5LVJTQSBDQYIJAMFqmuO1XQb9MBMGA1UdJQQMMAoGCCsGAQUFBwMB\nMAsGA1UdDwQEAwIFoDAlBgNVHREEHjAcghpoYXJib3IudnJhY2sudnNwaGVyZS5s\nb2NhbDANBgkqhkiG9w0BAQsFAAOCAQEAXJgFwsjBU4apGKJvex4ro4vO0iMiGx4r\nlL4JkozNp4JJGGfPWY3cAmeykAX3mUfPNRosp6KqwHKUvP+bU0hsLDd+mrCRsA/J\ndsyyhfJqbtB0Ez3bQdelAacKS8aaCt3cmXU+hrPGTOkCoOeeeiR6uZFuuywG8dld\ntUD9jFd6CkizVVqsyk/lmZ0mEapW+4+D6VhPzrMFlqwW3h+1WM6CmMRPOJc42wQI\nG1GEpi9Sghs7V/VkrO78dWBWe6mcfYv3OsxR5iyGiNtIfM99EnIknf01HO3kUlP8\nvgS2QcTyDdpj1VI2oUL2wM77SXGfUynnmL1fCEdU++qO/bb2tsTiXA==\n-----END CERTIFICATE-----",
      "privateKey" : "-----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKCAQEAsT/VwtwC45Z/OJeuTmuN6PXZjkQ/pz/RFZv7K0z/SWUW7QX5\nEFqpg7Vns7Ie3pbUs2jDH7W1Dn4NbDSChUmImD4iUXLHhhp7QCNaemu03y3Npwfn\nYO6VIcG6uF9oTOcGKPV2D/JE45H4hdEPwF50U8ZeZACyToSJbc1gzElZX+zlGiq+\nD+6AOjhlULAJrkNzyCwvq3CSPi/eS/OCN7cGVt0+yxonIH7mJM/sNU2W3MnmHQOE\nSxOe8I99aOUtYNuhHTiP5HWFfCbIfqGcWlMgBLiGEsFLrKql6Ci8HOrW4vOzwho3\nQ4eRjGhNWBHddmGL2vbpfHsESDBmqoOYaXc6eQIDAQABAoIBAAXAq6BiYZmfVcux\naI/U/8sSx5fNcT9tW8zWviUen55zMHZK3lWAi8XhilcTrdrNjGOyP7r0u8aXornj\nTmUjCNLgGV8JWZ5pl5xySUp12m3v35/PKtxDggWRcwzu08TDLrj/lnBYDZJRN36o\nVVmJ9z6Mzp1yRFc2B/vPUZfvvX3WdZLwYSQeV4JLlfhiyCE1cYdc6y4RLfpOHQiw\nnhyoHYf1Uumy8g7co41sdcsergCBiNQe98Mola+x9f5srP9eu/YCnx1twBRM66iG\noq8lwykAN4xMSGZDFxCkaFC59lA7ek46uaMjeYcCU09OxvGGJdoRpEMCPDCg3lFC\n2SS95YECgYEA4jUWjHcyuhWfk6CYchGzA+D06FE0aAi47m3XU1Wx1SfZXVNoKymk\n9ebyu0V4UadYnZK6mGgFOpay6md32V41cFwJIOcwX9CVzDW74+w6PkqHo6HRbhNi\n3HDkKc2H1nPEQKqrrBneHajV8KyK+1lJoh1IHqn9V14q1TP90gc5wmkCgYEAyJgO\nSV4PtTdcfPWwQ3ujPpR6Av3B4F8Y5akx3w2P8QY7Qraovvdehblhc5MO2iNkXWdJ\nDks+buil2V5DJv2/L1dSM6WqjBaQY39iQ9R3r6/qSgG/RxYnAqr28jgBBqtjnrI1\nJjMJTBzhKFvXAtCJAPGeJKae/ZHpxa61oOGxlZECgYAg/YkaV1AIn5q0VxmkmTw4\ndpiBQUaZXZxK+a4Ls1XKNpOW7tEkamBqlJIWCd2wWu2rnXilPZZ1owDY+toZ04mL\np4CVUeJWNv+B1txeM1eTOh9qF/GJUj560+QSzKzg8+VNYRbEdMlWHgeFoERsv+rj\nP84C2tvd4BfzHDAKb49W8QKBgDOwuz28t1+DPJoW1a0OFyrxJ9/NdEBVQR0tVGSe\nIhGCAZNXbnSHWhwrgSk/I/yiUiKfkvvT9+qsmNBCshtCGBoi7lPQxPoEdoCtOq0v\n+weS1VTszlWLJ9JQLAKO2/TUBX/HfFqznBm492xm/ikDg8pyeMYJCb9d8le2hadH\ngXOBAoGBAN+Q14/0v64qQCmUlqq14IKEGyt9OUCMSGF/PRcRreaO/okM/0E0+uCf\n9eEoUyDvvvyM3xyqltf428mbaBEpBzF/IUDrSlHieyTSdSzJm6E83HJzVcWHQ4Nu\n5Ct0EQnyYqrmw0C3hpoBz9sgsF4oFRX4h8b4ammWXnI+OEUKPIsp\n-----END RSA PRIVATE KEY-----"
    },
    "harborRsaCert" : {
      "publicCert" : "-----BEGIN CERTIFICATE-----\nMIIDhDCCAmygAwIBAgIQQ/1NNsYBUlTDTSEBUXrT3TANBgkqhkiG9w0BAQsFADAW\nMRQwEgYDVQQDDAtFYXN5LVJTQSBDQTAeFw0xOTA0MDYxMTA0NDVaFw0yMjAzMjEx\nMTA0NDVaMCUxIzAhBgNVBAMMGmhhcmJvci52cmFjay52c3BoZXJlLmxvY2FsMIIB\nIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAsT/VwtwC45Z/OJeuTmuN6PXZ\njkQ/pz/RFZv7K0z/SWUW7QX5EFqpg7Vns7Ie3pbUs2jDH7W1Dn4NbDSChUmImD4i\nUXLHhhp7QCNaemqwersdfasnYO6VIcG6uF9oTOcGKPV2D/JE45H4hdEPwF50U8Ze\nZACyToSJbc1gzElZX+zlGiq+D+6AOjhlULAJrkNzyCwvq3CSPi/eS/OCN7cGVt0+\nyxonIH7mJM/sNU2W3MnmHQOESxOe8I99aOUtYNuhHTiP5HWFfCbIfqGcWlMgBLiG\nEsFLrKql6Ci8HOrW4vOzwho3Q4eRjGhNWBHddmGL2vbpfHsESDBmqoOYaXc6eQID\nAQABo4G+MIG7MAkGA1UdEwQCMAAwHQYDVR0OBBYEFJVT9cvazVOlO5DS6ryMwubg\nJLruMEYGA1UdIwQ/MD2AFLRwFacXernqj0VPJ4TgtLdhFG++oRqkGDAWMRQwEgYD\nVQQDDAtFYXN5LVJTQSBDQYIJAMFqmuO1XQb9MBMGA1UdJQQMMAoGCCsGAQUFBwMB\nMAsGA1UdDwQEAwIFoDAlBgNVHREEHjAcghpoYXJib3IudnJhY2sudnNwaGVyZS5s\nb2NhbDANBgkqhkiG9w0BAQsFAAOCAQEAXJgFwsjBU4apGKJvex4ro4vO0iMiGx4r\nlL4JkozNp4JJGGfPWY3cAmeykAX3mUfPNRosp6KqwHKUvP+bU0hsLDd+mrCRsA/J\ndsyyhfJqbtB0Ez3bQdelAacKS8aaCt3cmXU+hrPGTOkCoOeeeiR6uZFuuywG8dld\ntUD9jFd6CkizVVqsyk/lmZ0mEapW+4+D6VhPzrMFlqwW3h+1WM6CmMRPOJc42wQI\nG1GEpi9Sghs7V/VkrO78dWBWe6mcfYv3OsxR5iyGiNtIfM99EnIknf01HO3kUlP8\nvgS2QcTyDdpj1VI2oUL2wM77SXGfUynnmL1fCEdU++qO/bb2tsTiXA==\n-----END CERTIFICATE-----",
      "privateKey" : "-----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKCAQEAsT/VwtwC45Z/OJeuTmuN6PXZjkQ/pz/RFZv7K0z/SWUW7QX5\nEFqpg7Vns7Ie3pbUs2jDH7W1Dn4NbDSChUmImD4iUXLHhhp7QCNaemu03y3Npwfn\nYO6VIcG6uF9oTOcGKPV2D/JE45H4hdEPwF50U8ZeZACyToSJbc1gzElZX+zlGiq+\nD+6AOjhlULAJrkNzyCwvq3CSPi/eS/OCN7cGVt0+yxonIH7mJM/sNU2W3MnmHQOE\nSxOe8I99aOUtYNuhHTiP5HWFfCbIfqGcWlMgBLiGEsFLrKql6Ci8HOrW4vOzwho3\nQ4eRjGhNWBHddmGL2vbpfHsESDBmqoOYaXc6eQIDAQABAoIBAAXAq6BiYZmfVcux\naI/U/8sSx5fNcT9tW8zWviUen55zMHZK3lWAi8XhilcTrdrNjGOyP7r0u8aXornj\nTmUjCNLgGV8JWZ5pl5xySUp12m3v35/PKtxDggWRcwzu08TDLrj/lnBYDZJRN36o\nVVmJ9z6Mzp1yRFc2B/vPUZfvvX3WdZLwYSQeV4JLlfhiyCE1cYdc6y4RLfpOHQiw\nnhyoHYf1Uumy8g7co41sdcsergCBiNQe98Mola+x9f5srP9eu/YCnx1twBRM66iG\noq8lwykAN4xMSGZDFxCkaFC59lA7ek46uaMjeYcCU09OxvGGJdoRpEMCPDCg3lFC\n2SS95YECgYEA4jUWjHcyuhWfk6CYchGzA+D06FE0aAi47m3XU1Wx1SfZXVNoKymk\n9ebyu0V4UadYnZK6mGgFOpay6md32V41cFwJIOcwX9CVzDW74+w6PkqHo6HRbhNi\n3HDkKc2H1nPEQKqrrBneHajV8KyK+1lJoh1IHqn9V14q1TP90gc5wmkCgYEAyJgO\nSV4PtTdcfPWwQ3ujPpR6Av3B4F8Y5akx3w2P8QY7Qraovvdehblhc5MO2iNkXWdJ\nDks+buil2V5DJv2/L1dSM6WqjBaQY39iQ9R3r6/qSgG/RxYnAqr28jgBBqtjnrI1\nJjMJTBzhKFvXAtCJAPGeJKae/ZHpxa61oOGxlZECgYAg/YkaV1AIn5q0VxmkmTw4\ndpiBQUaZXZxK+a4Ls1XKNpOW7tEkamBqlJIWCd2wWu2rnXilPZZ1owDY+toZ04mL\np4CVUeJWNv+B1txeM1eTOh9qF/GJUj560+QSzKzg8+VNYRbEdMlWHgeFoERsv+rj\nP84C2tvd4BfzHDAKb49W8QKBgDOwuz28t1+DPJoW1a0OFyrxJ9/NdEBVQR0tVGSe\nIhGCAZNXbnSHWhwrgSk/I/yiUiKfkvvT9+qsmNBCshtCGBoi7lPQxPoEdoCtOq0v\n+weS1VTszlWLJ9JQLAKO2/TUBX/HfFqznBm492xm/ikDg8pyeMYJCb9d8le2hadH\ngXOBAoGBAN+Q14/0v64qQCmUlqq14IKEGyt9OUCMSGF/PRcRreaO/okM/0E0+uCf\n9eEoUyDvvvyM3xyqltf428mbaBEpBzF/IUDrSlHieyTSdSzJm6E83HJzVcWHQ4Nu\n5Ct0EQnyYqrmw0C3hpoBz9sgsF4oFRX4h8b4ammWXnI+OEUKPIsp\n-----END RSA PRIVATE KEY-----"
    }
  },
  "datastore" : "datastore"
}

HTTP Response

HTTP/1.1 202 Accepted
Content-Type: application/json;charset=UTF-8
Content-Length: 79
Location: /v1/pkses/validations/d39fc601-b2dc-4641-8abd-2cb169a18421

{
  "id" : "d39fc601-b2dc-4641-8abd-2cb169a18421",
  "status" : "IN_PROGRESS"
}
Related APIs

Install PKS
Get a list of installed PKS
Validate PKS specification before installation
Get validation results
Get PKS details
Delete PKS
Initialize PKS deletion

2.9.2. Get validation results for Pivotal Container Service

Prerequisites

  1. None

Steps

  1. Invoke the API

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/pkses/validations/8b4f5440-a2dc-4e48-ac3e-be875b3f72ec' -i -u 'admin:VMwareInfra@1' -X GET

HTTP Request

GET /v1/pkses/validations/8b4f5440-a2dc-4e48-ac3e-be875b3f72ec HTTP/1.1
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==

HTTP Response

HTTP/1.1 200 OK
Content-Length: 281
Content-Type: application/json;charset=UTF-8

{
  "id" : "bc3fda31-74b9-4759-8e1f-ff72726b8d5d",
  "description" : "Validation description",
  "executionStatus" : "COMPLETED",
  "resultStatus" : "SUCCEEDED",
  "validationChecks" : [ {
    "description" : "Validation check description",
    "resultStatus" : "SUCCEEDED"
  } ]
}
Related APIs

Install PKS
Validate PKS specification before installation
Get validation results
Get a list of installed PKS
Get PKS details
Initialize PKS deletion
Delete PKS

2.9.3. Install Pivotal Container Service

Prerequisites

  1. The Validate Pivotal Container Service specification workflow should finish successfully

Steps

  1. Invoke the API

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/pkses' -i -u 'admin:VMwareInfra@1' -X POST \
    -H 'Content-Type: application/json' \
    -d '{
  "domainId" : "76df11e9-5c1f-4376-b913-0ea93ebda983",
  "name" : "PKS-1",
  "pksApiHostname" : "pksApi.sfo01.rainpole.local",
  "adminPassword" : "SecurePassword123!",
  "decryptionPassphrase" : "SecurePassword123!",
  "harborHostname" : "harbor.sfo01.rainpole.local",
  "installHarbor" : true,
  "nsxtItemsSpec" : {
    "t0routerId" : "bc3fda31-74b9-4759-8e1f-ff72726b8d5d",
    "nodesIpBlockId" : "b73446a0-9ffe-4291-b34f-ff0b6ee67ff3",
    "floatingIpPoolId" : "ee7d0bc1-0cd3-4c59-8944-65a36fe35cf7",
    "podsIpBlockId" : "6f5db6d2-30f6-47e3-a765-3ebc34390bce"
  },
  "pksOpsManagerVmSpec" : {
    "network" : {
      "network" : "network",
      "dnsServers" : [ "172.16.11.4", "172.16.11.5" ],
      "ntpServers" : [ "172.16.11.251", "172.16.11.252" ],
      "dnsSuffix" : "*.sfo01.rainpole.local",
      "gateway" : "10.255.0.1",
      "netmask" : "255.255.255.0"
    },
    "appliance" : {
      "ip" : "10.255.0.10",
      "hostname" : "pcf.sfo01.rainpole.local",
      "vmName" : "ops-manager"
    }
  },
  "availabilityZoneSpec" : {
    "managementNetwork" : {
      "vcenterNetwork" : "VcenterNetwork",
      "cidr" : "10.255.0.0/24",
      "gateway" : "10.255.0.1",
      "reservedRanges" : "10.255.0.1-10.255.0.10",
      "dnsServer" : "172.16.11.4"
    },
    "kubernetesNetwork" : {
      "vcenterNetwork" : "VcenterNetwork",
      "cidr" : "10.255.1.0/24",
      "gateway" : "10.255.1.1",
      "reservedRanges" : "10.255.1.1-10.255.1.10",
      "dnsServer" : "172.16.11.4"
    },
    "managementZone" : {
      "name" : "AZ1",
      "resourcePoolName" : "AZ1_Resource_Pool",
      "clusterName" : "pks-cluster"
    },
    "kubernetesZones" : [ {
      "name" : "AZ2",
      "resourcePoolName" : "AZ2_Resource_Pool",
      "clusterName" : "pks-cluster"
    }, {
      "name" : "AZ3",
      "resourcePoolName" : "AZ3_Resource_Pool",
      "clusterName" : "pks-cluster"
    } ]
  },
  "certificateBundle" : {
    "trustedCertificates" : "-----BEGIN CERTIFICATE-----\nMIIDNTCCAh2gAwIBAgIJAMFqmuO1XQb9MA0GCSqGSIb3DQEBCwUAMBYxFDASBgNV\nBAMMC0Vhc3ktUlNBIENBMB4XDTE5MDQwNjExMDQ0NVoXDTI5MDQwMzExMDQ0NVow\nFjEUMBIGA1UEAwwLRWFzeS1SU0EgQ0EwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAw\nggEKAoIBAQC2Mw1Zu/Uj2d1CrQUPG96rJS116tbTRtaIlRjWW2W+6Ng6S/wRxMKS\nQKQbx2MBYYJYC76PRAu1r1AkZMh7QhN/ohzJNrXa+C1UAkKg0zD6xqbxbSIsyYCV\n3WDyL2jRjPjbelveKV7AvP+rbratF3fH8PtnMa9Jp5/fkWI76T8GipF4dYW1vAxy\nApD464PWKvkz4Y2Ey20gr15W/L4gNFgXdaENW7aY9T9N8JuFpIbBK6QS1vV+w4XJ\nqlEilT2l0MYUA78zAOl4e8XI4awGmc0lHU60+87/Za7ODZbp93EtXkRTjR23Ybvh\nqvYmbc4bZu+u5wHz8Zf5Q9S5bzciUlQ5AgMBAAGjgYUwgYIwHQYDVR0OBBYEFLRw\nFacXernqj0VPJ4TgtLdhFG++MEYGA1UdIwQ/MD2AFLRwFacXernqj0VPJ4TgtLdh\nFG++oRqkGDAWMxcvaswweewWhjhHVDklhlsfgsBDQYIJAMFqmuO1XQb9MAwGA1Ud\nEwQFMAMBAf8wCwYDVR0PBAQDAgEGMA0GCSqGSIb3DQEBCwUAA4IBAQARdK+wt2xr\nPiEX25Fmdw5CGlom2WDL5fqB7f05EgkMCzAWHZeVjIoHF2aPmEZTuCymk8neLyw6\nY5P0maW8VHhNwD93uovZnn1qccERjaOWSuxE/lJUWnrt7n4lJhWs4WBCc1SFeuvj\nL/AJyRv/DnGDUw7eXPQYR2vPa1yHZt8jr4nA5gbINAenJ0rX48mDB3jaroXyOUWE\nLfqtuLlxmWDE9iF4Aqu1vwYltEvbQ3k2tgDy6gTQbNl7/9UKMvl3bHI6xwjONvut\nfSJHetpy1h3sN5/XkOBnoNXiuoiDxo83+yDeIfCdDnCMcu13ByvZ9xSM4rBPSQNk\nfnIFWgyCUH8F\n-----END CERTIFICATE-----",
    "pcfRsaCert" : {
      "publicCert" : "-----BEGIN CERTIFICATE-----\nMIIDhDCCAmygAwIBAgIQQ/1NNsYBUlTDTSEBUXrT3TANBgkqhkiG9w0BAQsFADAW\nMRQwEgYDVQQDDAtFYXN5LVJTQSBDQTAeFw0xOTA0MDYxMTA0NDVaFw0yMjAzMjEx\nMTA0NDVaMCUxIzAhBgNVBAMMGmhhcmJvci52cmFjay52c3BoZXJlLmxvY2FsMIIB\nIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAsT/VwtwC45Z/OJeuTmuN6PXZ\njkQ/pz/RFZv7K0z/SWUW7QX5EFqpg7Vns7Ie3pbUs2jDH7W1Dn4NbDSChUmImD4i\nUXLHhhp7QCNaemqwersdfasnYO6VIcG6uF9oTOcGKPV2D/JE45H4hdEPwF50U8Ze\nZACyToSJbc1gzElZX+zlGiq+D+6AOjhlULAJrkNzyCwvq3CSPi/eS/OCN7cGVt0+\nyxonIH7mJM/sNU2W3MnmHQOESxOe8I99aOUtYNuhHTiP5HWFfCbIfqGcWlMgBLiG\nEsFLrKql6Ci8HOrW4vOzwho3Q4eRjGhNWBHddmGL2vbpfHsESDBmqoOYaXc6eQID\nAQABo4G+MIG7MAkGA1UdEwQCMAAwHQYDVR0OBBYEFJVT9cvazVOlO5DS6ryMwubg\nJLruMEYGA1UdIwQ/MD2AFLRwFacXernqj0VPJ4TgtLdhFG++oRqkGDAWMRQwEgYD\nVQQDDAtFYXN5LVJTQSBDQYIJAMFqmuO1XQb9MBMGA1UdJQQMMAoGCCsGAQUFBwMB\nMAsGA1UdDwQEAwIFoDAlBgNVHREEHjAcghpoYXJib3IudnJhY2sudnNwaGVyZS5s\nb2NhbDANBgkqhkiG9w0BAQsFAAOCAQEAXJgFwsjBU4apGKJvex4ro4vO0iMiGx4r\nlL4JkozNp4JJGGfPWY3cAmeykAX3mUfPNRosp6KqwHKUvP+bU0hsLDd+mrCRsA/J\ndsyyhfJqbtB0Ez3bQdelAacKS8aaCt3cmXU+hrPGTOkCoOeeeiR6uZFuuywG8dld\ntUD9jFd6CkizVVqsyk/lmZ0mEapW+4+D6VhPzrMFlqwW3h+1WM6CmMRPOJc42wQI\nG1GEpi9Sghs7V/VkrO78dWBWe6mcfYv3OsxR5iyGiNtIfM99EnIknf01HO3kUlP8\nvgS2QcTyDdpj1VI2oUL2wM77SXGfUynnmL1fCEdU++qO/bb2tsTiXA==\n-----END CERTIFICATE-----",
      "privateKey" : "-----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKCAQEAsT/VwtwC45Z/OJeuTmuN6PXZjkQ/pz/RFZv7K0z/SWUW7QX5\nEFqpg7Vns7Ie3pbUs2jDH7W1Dn4NbDSChUmImD4iUXLHhhp7QCNaemu03y3Npwfn\nYO6VIcG6uF9oTOcGKPV2D/JE45H4hdEPwF50U8ZeZACyToSJbc1gzElZX+zlGiq+\nD+6AOjhlULAJrkNzyCwvq3CSPi/eS/OCN7cGVt0+yxonIH7mJM/sNU2W3MnmHQOE\nSxOe8I99aOUtYNuhHTiP5HWFfCbIfqGcWlMgBLiGEsFLrKql6Ci8HOrW4vOzwho3\nQ4eRjGhNWBHddmGL2vbpfHsESDBmqoOYaXc6eQIDAQABAoIBAAXAq6BiYZmfVcux\naI/U/8sSx5fNcT9tW8zWviUen55zMHZK3lWAi8XhilcTrdrNjGOyP7r0u8aXornj\nTmUjCNLgGV8JWZ5pl5xySUp12m3v35/PKtxDggWRcwzu08TDLrj/lnBYDZJRN36o\nVVmJ9z6Mzp1yRFc2B/vPUZfvvX3WdZLwYSQeV4JLlfhiyCE1cYdc6y4RLfpOHQiw\nnhyoHYf1Uumy8g7co41sdcsergCBiNQe98Mola+x9f5srP9eu/YCnx1twBRM66iG\noq8lwykAN4xMSGZDFxCkaFC59lA7ek46uaMjeYcCU09OxvGGJdoRpEMCPDCg3lFC\n2SS95YECgYEA4jUWjHcyuhWfk6CYchGzA+D06FE0aAi47m3XU1Wx1SfZXVNoKymk\n9ebyu0V4UadYnZK6mGgFOpay6md32V41cFwJIOcwX9CVzDW74+w6PkqHo6HRbhNi\n3HDkKc2H1nPEQKqrrBneHajV8KyK+1lJoh1IHqn9V14q1TP90gc5wmkCgYEAyJgO\nSV4PtTdcfPWwQ3ujPpR6Av3B4F8Y5akx3w2P8QY7Qraovvdehblhc5MO2iNkXWdJ\nDks+buil2V5DJv2/L1dSM6WqjBaQY39iQ9R3r6/qSgG/RxYnAqr28jgBBqtjnrI1\nJjMJTBzhKFvXAtCJAPGeJKae/ZHpxa61oOGxlZECgYAg/YkaV1AIn5q0VxmkmTw4\ndpiBQUaZXZxK+a4Ls1XKNpOW7tEkamBqlJIWCd2wWu2rnXilPZZ1owDY+toZ04mL\np4CVUeJWNv+B1txeM1eTOh9qF/GJUj560+QSzKzg8+VNYRbEdMlWHgeFoERsv+rj\nP84C2tvd4BfzHDAKb49W8QKBgDOwuz28t1+DPJoW1a0OFyrxJ9/NdEBVQR0tVGSe\nIhGCAZNXbnSHWhwrgSk/I/yiUiKfkvvT9+qsmNBCshtCGBoi7lPQxPoEdoCtOq0v\n+weS1VTszlWLJ9JQLAKO2/TUBX/HfFqznBm492xm/ikDg8pyeMYJCb9d8le2hadH\ngXOBAoGBAN+Q14/0v64qQCmUlqq14IKEGyt9OUCMSGF/PRcRreaO/okM/0E0+uCf\n9eEoUyDvvvyM3xyqltf428mbaBEpBzF/IUDrSlHieyTSdSzJm6E83HJzVcWHQ4Nu\n5Ct0EQnyYqrmw0C3hpoBz9sgsF4oFRX4h8b4ammWXnI+OEUKPIsp\n-----END RSA PRIVATE KEY-----"
    },
    "pksRsaCert" : {
      "publicCert" : "-----BEGIN CERTIFICATE-----\nMIIDhDCCAmygAwIBAgIQQ/1NNsYBUlTDTSEBUXrT3TANBgkqhkiG9w0BAQsFADAW\nMRQwEgYDVQQDDAtFYXN5LVJTQSBDQTAeFw0xOTA0MDYxMTA0NDVaFw0yMjAzMjEx\nMTA0NDVaMCUxIzAhBgNVBAMMGmhhcmJvci52cmFjay52c3BoZXJlLmxvY2FsMIIB\nIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAsT/VwtwC45Z/OJeuTmuN6PXZ\njkQ/pz/RFZv7K0z/SWUW7QX5EFqpg7Vns7Ie3pbUs2jDH7W1Dn4NbDSChUmImD4i\nUXLHhhp7QCNaemqwersdfasnYO6VIcG6uF9oTOcGKPV2D/JE45H4hdEPwF50U8Ze\nZACyToSJbc1gzElZX+zlGiq+D+6AOjhlULAJrkNzyCwvq3CSPi/eS/OCN7cGVt0+\nyxonIH7mJM/sNU2W3MnmHQOESxOe8I99aOUtYNuhHTiP5HWFfCbIfqGcWlMgBLiG\nEsFLrKql6Ci8HOrW4vOzwho3Q4eRjGhNWBHddmGL2vbpfHsESDBmqoOYaXc6eQID\nAQABo4G+MIG7MAkGA1UdEwQCMAAwHQYDVR0OBBYEFJVT9cvazVOlO5DS6ryMwubg\nJLruMEYGA1UdIwQ/MD2AFLRwFacXernqj0VPJ4TgtLdhFG++oRqkGDAWMRQwEgYD\nVQQDDAtFYXN5LVJTQSBDQYIJAMFqmuO1XQb9MBMGA1UdJQQMMAoGCCsGAQUFBwMB\nMAsGA1UdDwQEAwIFoDAlBgNVHREEHjAcghpoYXJib3IudnJhY2sudnNwaGVyZS5s\nb2NhbDANBgkqhkiG9w0BAQsFAAOCAQEAXJgFwsjBU4apGKJvex4ro4vO0iMiGx4r\nlL4JkozNp4JJGGfPWY3cAmeykAX3mUfPNRosp6KqwHKUvP+bU0hsLDd+mrCRsA/J\ndsyyhfJqbtB0Ez3bQdelAacKS8aaCt3cmXU+hrPGTOkCoOeeeiR6uZFuuywG8dld\ntUD9jFd6CkizVVqsyk/lmZ0mEapW+4+D6VhPzrMFlqwW3h+1WM6CmMRPOJc42wQI\nG1GEpi9Sghs7V/VkrO78dWBWe6mcfYv3OsxR5iyGiNtIfM99EnIknf01HO3kUlP8\nvgS2QcTyDdpj1VI2oUL2wM77SXGfUynnmL1fCEdU++qO/bb2tsTiXA==\n-----END CERTIFICATE-----",
      "privateKey" : "-----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKCAQEAsT/VwtwC45Z/OJeuTmuN6PXZjkQ/pz/RFZv7K0z/SWUW7QX5\nEFqpg7Vns7Ie3pbUs2jDH7W1Dn4NbDSChUmImD4iUXLHhhp7QCNaemu03y3Npwfn\nYO6VIcG6uF9oTOcGKPV2D/JE45H4hdEPwF50U8ZeZACyToSJbc1gzElZX+zlGiq+\nD+6AOjhlULAJrkNzyCwvq3CSPi/eS/OCN7cGVt0+yxonIH7mJM/sNU2W3MnmHQOE\nSxOe8I99aOUtYNuhHTiP5HWFfCbIfqGcWlMgBLiGEsFLrKql6Ci8HOrW4vOzwho3\nQ4eRjGhNWBHddmGL2vbpfHsESDBmqoOYaXc6eQIDAQABAoIBAAXAq6BiYZmfVcux\naI/U/8sSx5fNcT9tW8zWviUen55zMHZK3lWAi8XhilcTrdrNjGOyP7r0u8aXornj\nTmUjCNLgGV8JWZ5pl5xySUp12m3v35/PKtxDggWRcwzu08TDLrj/lnBYDZJRN36o\nVVmJ9z6Mzp1yRFc2B/vPUZfvvX3WdZLwYSQeV4JLlfhiyCE1cYdc6y4RLfpOHQiw\nnhyoHYf1Uumy8g7co41sdcsergCBiNQe98Mola+x9f5srP9eu/YCnx1twBRM66iG\noq8lwykAN4xMSGZDFxCkaFC59lA7ek46uaMjeYcCU09OxvGGJdoRpEMCPDCg3lFC\n2SS95YECgYEA4jUWjHcyuhWfk6CYchGzA+D06FE0aAi47m3XU1Wx1SfZXVNoKymk\n9ebyu0V4UadYnZK6mGgFOpay6md32V41cFwJIOcwX9CVzDW74+w6PkqHo6HRbhNi\n3HDkKc2H1nPEQKqrrBneHajV8KyK+1lJoh1IHqn9V14q1TP90gc5wmkCgYEAyJgO\nSV4PtTdcfPWwQ3ujPpR6Av3B4F8Y5akx3w2P8QY7Qraovvdehblhc5MO2iNkXWdJ\nDks+buil2V5DJv2/L1dSM6WqjBaQY39iQ9R3r6/qSgG/RxYnAqr28jgBBqtjnrI1\nJjMJTBzhKFvXAtCJAPGeJKae/ZHpxa61oOGxlZECgYAg/YkaV1AIn5q0VxmkmTw4\ndpiBQUaZXZxK+a4Ls1XKNpOW7tEkamBqlJIWCd2wWu2rnXilPZZ1owDY+toZ04mL\np4CVUeJWNv+B1txeM1eTOh9qF/GJUj560+QSzKzg8+VNYRbEdMlWHgeFoERsv+rj\nP84C2tvd4BfzHDAKb49W8QKBgDOwuz28t1+DPJoW1a0OFyrxJ9/NdEBVQR0tVGSe\nIhGCAZNXbnSHWhwrgSk/I/yiUiKfkvvT9+qsmNBCshtCGBoi7lPQxPoEdoCtOq0v\n+weS1VTszlWLJ9JQLAKO2/TUBX/HfFqznBm492xm/ikDg8pyeMYJCb9d8le2hadH\ngXOBAoGBAN+Q14/0v64qQCmUlqq14IKEGyt9OUCMSGF/PRcRreaO/okM/0E0+uCf\n9eEoUyDvvvyM3xyqltf428mbaBEpBzF/IUDrSlHieyTSdSzJm6E83HJzVcWHQ4Nu\n5Ct0EQnyYqrmw0C3hpoBz9sgsF4oFRX4h8b4ammWXnI+OEUKPIsp\n-----END RSA PRIVATE KEY-----"
    },
    "nsxtRsaCert" : {
      "publicCert" : "-----BEGIN CERTIFICATE-----\nMIIDhDCCAmygAwIBAgIQQ/1NNsYBUlTDTSEBUXrT3TANBgkqhkiG9w0BAQsFADAW\nMRQwEgYDVQQDDAtFYXN5LVJTQSBDQTAeFw0xOTA0MDYxMTA0NDVaFw0yMjAzMjEx\nMTA0NDVaMCUxIzAhBgNVBAMMGmhhcmJvci52cmFjay52c3BoZXJlLmxvY2FsMIIB\nIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAsT/VwtwC45Z/OJeuTmuN6PXZ\njkQ/pz/RFZv7K0z/SWUW7QX5EFqpg7Vns7Ie3pbUs2jDH7W1Dn4NbDSChUmImD4i\nUXLHhhp7QCNaemqwersdfasnYO6VIcG6uF9oTOcGKPV2D/JE45H4hdEPwF50U8Ze\nZACyToSJbc1gzElZX+zlGiq+D+6AOjhlULAJrkNzyCwvq3CSPi/eS/OCN7cGVt0+\nyxonIH7mJM/sNU2W3MnmHQOESxOe8I99aOUtYNuhHTiP5HWFfCbIfqGcWlMgBLiG\nEsFLrKql6Ci8HOrW4vOzwho3Q4eRjGhNWBHddmGL2vbpfHsESDBmqoOYaXc6eQID\nAQABo4G+MIG7MAkGA1UdEwQCMAAwHQYDVR0OBBYEFJVT9cvazVOlO5DS6ryMwubg\nJLruMEYGA1UdIwQ/MD2AFLRwFacXernqj0VPJ4TgtLdhFG++oRqkGDAWMRQwEgYD\nVQQDDAtFYXN5LVJTQSBDQYIJAMFqmuO1XQb9MBMGA1UdJQQMMAoGCCsGAQUFBwMB\nMAsGA1UdDwQEAwIFoDAlBgNVHREEHjAcghpoYXJib3IudnJhY2sudnNwaGVyZS5s\nb2NhbDANBgkqhkiG9w0BAQsFAAOCAQEAXJgFwsjBU4apGKJvex4ro4vO0iMiGx4r\nlL4JkozNp4JJGGfPWY3cAmeykAX3mUfPNRosp6KqwHKUvP+bU0hsLDd+mrCRsA/J\ndsyyhfJqbtB0Ez3bQdelAacKS8aaCt3cmXU+hrPGTOkCoOeeeiR6uZFuuywG8dld\ntUD9jFd6CkizVVqsyk/lmZ0mEapW+4+D6VhPzrMFlqwW3h+1WM6CmMRPOJc42wQI\nG1GEpi9Sghs7V/VkrO78dWBWe6mcfYv3OsxR5iyGiNtIfM99EnIknf01HO3kUlP8\nvgS2QcTyDdpj1VI2oUL2wM77SXGfUynnmL1fCEdU++qO/bb2tsTiXA==\n-----END CERTIFICATE-----",
      "privateKey" : "-----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKCAQEAsT/VwtwC45Z/OJeuTmuN6PXZjkQ/pz/RFZv7K0z/SWUW7QX5\nEFqpg7Vns7Ie3pbUs2jDH7W1Dn4NbDSChUmImD4iUXLHhhp7QCNaemu03y3Npwfn\nYO6VIcG6uF9oTOcGKPV2D/JE45H4hdEPwF50U8ZeZACyToSJbc1gzElZX+zlGiq+\nD+6AOjhlULAJrkNzyCwvq3CSPi/eS/OCN7cGVt0+yxonIH7mJM/sNU2W3MnmHQOE\nSxOe8I99aOUtYNuhHTiP5HWFfCbIfqGcWlMgBLiGEsFLrKql6Ci8HOrW4vOzwho3\nQ4eRjGhNWBHddmGL2vbpfHsESDBmqoOYaXc6eQIDAQABAoIBAAXAq6BiYZmfVcux\naI/U/8sSx5fNcT9tW8zWviUen55zMHZK3lWAi8XhilcTrdrNjGOyP7r0u8aXornj\nTmUjCNLgGV8JWZ5pl5xySUp12m3v35/PKtxDggWRcwzu08TDLrj/lnBYDZJRN36o\nVVmJ9z6Mzp1yRFc2B/vPUZfvvX3WdZLwYSQeV4JLlfhiyCE1cYdc6y4RLfpOHQiw\nnhyoHYf1Uumy8g7co41sdcsergCBiNQe98Mola+x9f5srP9eu/YCnx1twBRM66iG\noq8lwykAN4xMSGZDFxCkaFC59lA7ek46uaMjeYcCU09OxvGGJdoRpEMCPDCg3lFC\n2SS95YECgYEA4jUWjHcyuhWfk6CYchGzA+D06FE0aAi47m3XU1Wx1SfZXVNoKymk\n9ebyu0V4UadYnZK6mGgFOpay6md32V41cFwJIOcwX9CVzDW74+w6PkqHo6HRbhNi\n3HDkKc2H1nPEQKqrrBneHajV8KyK+1lJoh1IHqn9V14q1TP90gc5wmkCgYEAyJgO\nSV4PtTdcfPWwQ3ujPpR6Av3B4F8Y5akx3w2P8QY7Qraovvdehblhc5MO2iNkXWdJ\nDks+buil2V5DJv2/L1dSM6WqjBaQY39iQ9R3r6/qSgG/RxYnAqr28jgBBqtjnrI1\nJjMJTBzhKFvXAtCJAPGeJKae/ZHpxa61oOGxlZECgYAg/YkaV1AIn5q0VxmkmTw4\ndpiBQUaZXZxK+a4Ls1XKNpOW7tEkamBqlJIWCd2wWu2rnXilPZZ1owDY+toZ04mL\np4CVUeJWNv+B1txeM1eTOh9qF/GJUj560+QSzKzg8+VNYRbEdMlWHgeFoERsv+rj\nP84C2tvd4BfzHDAKb49W8QKBgDOwuz28t1+DPJoW1a0OFyrxJ9/NdEBVQR0tVGSe\nIhGCAZNXbnSHWhwrgSk/I/yiUiKfkvvT9+qsmNBCshtCGBoi7lPQxPoEdoCtOq0v\n+weS1VTszlWLJ9JQLAKO2/TUBX/HfFqznBm492xm/ikDg8pyeMYJCb9d8le2hadH\ngXOBAoGBAN+Q14/0v64qQCmUlqq14IKEGyt9OUCMSGF/PRcRreaO/okM/0E0+uCf\n9eEoUyDvvvyM3xyqltf428mbaBEpBzF/IUDrSlHieyTSdSzJm6E83HJzVcWHQ4Nu\n5Ct0EQnyYqrmw0C3hpoBz9sgsF4oFRX4h8b4ammWXnI+OEUKPIsp\n-----END RSA PRIVATE KEY-----"
    },
    "harborRsaCert" : {
      "publicCert" : "-----BEGIN CERTIFICATE-----\nMIIDhDCCAmygAwIBAgIQQ/1NNsYBUlTDTSEBUXrT3TANBgkqhkiG9w0BAQsFADAW\nMRQwEgYDVQQDDAtFYXN5LVJTQSBDQTAeFw0xOTA0MDYxMTA0NDVaFw0yMjAzMjEx\nMTA0NDVaMCUxIzAhBgNVBAMMGmhhcmJvci52cmFjay52c3BoZXJlLmxvY2FsMIIB\nIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAsT/VwtwC45Z/OJeuTmuN6PXZ\njkQ/pz/RFZv7K0z/SWUW7QX5EFqpg7Vns7Ie3pbUs2jDH7W1Dn4NbDSChUmImD4i\nUXLHhhp7QCNaemqwersdfasnYO6VIcG6uF9oTOcGKPV2D/JE45H4hdEPwF50U8Ze\nZACyToSJbc1gzElZX+zlGiq+D+6AOjhlULAJrkNzyCwvq3CSPi/eS/OCN7cGVt0+\nyxonIH7mJM/sNU2W3MnmHQOESxOe8I99aOUtYNuhHTiP5HWFfCbIfqGcWlMgBLiG\nEsFLrKql6Ci8HOrW4vOzwho3Q4eRjGhNWBHddmGL2vbpfHsESDBmqoOYaXc6eQID\nAQABo4G+MIG7MAkGA1UdEwQCMAAwHQYDVR0OBBYEFJVT9cvazVOlO5DS6ryMwubg\nJLruMEYGA1UdIwQ/MD2AFLRwFacXernqj0VPJ4TgtLdhFG++oRqkGDAWMRQwEgYD\nVQQDDAtFYXN5LVJTQSBDQYIJAMFqmuO1XQb9MBMGA1UdJQQMMAoGCCsGAQUFBwMB\nMAsGA1UdDwQEAwIFoDAlBgNVHREEHjAcghpoYXJib3IudnJhY2sudnNwaGVyZS5s\nb2NhbDANBgkqhkiG9w0BAQsFAAOCAQEAXJgFwsjBU4apGKJvex4ro4vO0iMiGx4r\nlL4JkozNp4JJGGfPWY3cAmeykAX3mUfPNRosp6KqwHKUvP+bU0hsLDd+mrCRsA/J\ndsyyhfJqbtB0Ez3bQdelAacKS8aaCt3cmXU+hrPGTOkCoOeeeiR6uZFuuywG8dld\ntUD9jFd6CkizVVqsyk/lmZ0mEapW+4+D6VhPzrMFlqwW3h+1WM6CmMRPOJc42wQI\nG1GEpi9Sghs7V/VkrO78dWBWe6mcfYv3OsxR5iyGiNtIfM99EnIknf01HO3kUlP8\nvgS2QcTyDdpj1VI2oUL2wM77SXGfUynnmL1fCEdU++qO/bb2tsTiXA==\n-----END CERTIFICATE-----",
      "privateKey" : "-----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKCAQEAsT/VwtwC45Z/OJeuTmuN6PXZjkQ/pz/RFZv7K0z/SWUW7QX5\nEFqpg7Vns7Ie3pbUs2jDH7W1Dn4NbDSChUmImD4iUXLHhhp7QCNaemu03y3Npwfn\nYO6VIcG6uF9oTOcGKPV2D/JE45H4hdEPwF50U8ZeZACyToSJbc1gzElZX+zlGiq+\nD+6AOjhlULAJrkNzyCwvq3CSPi/eS/OCN7cGVt0+yxonIH7mJM/sNU2W3MnmHQOE\nSxOe8I99aOUtYNuhHTiP5HWFfCbIfqGcWlMgBLiGEsFLrKql6Ci8HOrW4vOzwho3\nQ4eRjGhNWBHddmGL2vbpfHsESDBmqoOYaXc6eQIDAQABAoIBAAXAq6BiYZmfVcux\naI/U/8sSx5fNcT9tW8zWviUen55zMHZK3lWAi8XhilcTrdrNjGOyP7r0u8aXornj\nTmUjCNLgGV8JWZ5pl5xySUp12m3v35/PKtxDggWRcwzu08TDLrj/lnBYDZJRN36o\nVVmJ9z6Mzp1yRFc2B/vPUZfvvX3WdZLwYSQeV4JLlfhiyCE1cYdc6y4RLfpOHQiw\nnhyoHYf1Uumy8g7co41sdcsergCBiNQe98Mola+x9f5srP9eu/YCnx1twBRM66iG\noq8lwykAN4xMSGZDFxCkaFC59lA7ek46uaMjeYcCU09OxvGGJdoRpEMCPDCg3lFC\n2SS95YECgYEA4jUWjHcyuhWfk6CYchGzA+D06FE0aAi47m3XU1Wx1SfZXVNoKymk\n9ebyu0V4UadYnZK6mGgFOpay6md32V41cFwJIOcwX9CVzDW74+w6PkqHo6HRbhNi\n3HDkKc2H1nPEQKqrrBneHajV8KyK+1lJoh1IHqn9V14q1TP90gc5wmkCgYEAyJgO\nSV4PtTdcfPWwQ3ujPpR6Av3B4F8Y5akx3w2P8QY7Qraovvdehblhc5MO2iNkXWdJ\nDks+buil2V5DJv2/L1dSM6WqjBaQY39iQ9R3r6/qSgG/RxYnAqr28jgBBqtjnrI1\nJjMJTBzhKFvXAtCJAPGeJKae/ZHpxa61oOGxlZECgYAg/YkaV1AIn5q0VxmkmTw4\ndpiBQUaZXZxK+a4Ls1XKNpOW7tEkamBqlJIWCd2wWu2rnXilPZZ1owDY+toZ04mL\np4CVUeJWNv+B1txeM1eTOh9qF/GJUj560+QSzKzg8+VNYRbEdMlWHgeFoERsv+rj\nP84C2tvd4BfzHDAKb49W8QKBgDOwuz28t1+DPJoW1a0OFyrxJ9/NdEBVQR0tVGSe\nIhGCAZNXbnSHWhwrgSk/I/yiUiKfkvvT9+qsmNBCshtCGBoi7lPQxPoEdoCtOq0v\n+weS1VTszlWLJ9JQLAKO2/TUBX/HfFqznBm492xm/ikDg8pyeMYJCb9d8le2hadH\ngXOBAoGBAN+Q14/0v64qQCmUlqq14IKEGyt9OUCMSGF/PRcRreaO/okM/0E0+uCf\n9eEoUyDvvvyM3xyqltf428mbaBEpBzF/IUDrSlHieyTSdSzJm6E83HJzVcWHQ4Nu\n5Ct0EQnyYqrmw0C3hpoBz9sgsF4oFRX4h8b4ammWXnI+OEUKPIsp\n-----END RSA PRIVATE KEY-----"
    }
  },
  "datastore" : "datastore"
}'

HTTP Request

POST /v1/pkses HTTP/1.1
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==
Content-Type: application/json
Content-Length: 15494

{
  "domainId" : "76df11e9-5c1f-4376-b913-0ea93ebda983",
  "name" : "PKS-1",
  "pksApiHostname" : "pksApi.sfo01.rainpole.local",
  "adminPassword" : "SecurePassword123!",
  "decryptionPassphrase" : "SecurePassword123!",
  "harborHostname" : "harbor.sfo01.rainpole.local",
  "installHarbor" : true,
  "nsxtItemsSpec" : {
    "t0routerId" : "bc3fda31-74b9-4759-8e1f-ff72726b8d5d",
    "nodesIpBlockId" : "b73446a0-9ffe-4291-b34f-ff0b6ee67ff3",
    "floatingIpPoolId" : "ee7d0bc1-0cd3-4c59-8944-65a36fe35cf7",
    "podsIpBlockId" : "6f5db6d2-30f6-47e3-a765-3ebc34390bce"
  },
  "pksOpsManagerVmSpec" : {
    "network" : {
      "network" : "network",
      "dnsServers" : [ "172.16.11.4", "172.16.11.5" ],
      "ntpServers" : [ "172.16.11.251", "172.16.11.252" ],
      "dnsSuffix" : "*.sfo01.rainpole.local",
      "gateway" : "10.255.0.1",
      "netmask" : "255.255.255.0"
    },
    "appliance" : {
      "ip" : "10.255.0.10",
      "hostname" : "pcf.sfo01.rainpole.local",
      "vmName" : "ops-manager"
    }
  },
  "availabilityZoneSpec" : {
    "managementNetwork" : {
      "vcenterNetwork" : "VcenterNetwork",
      "cidr" : "10.255.0.0/24",
      "gateway" : "10.255.0.1",
      "reservedRanges" : "10.255.0.1-10.255.0.10",
      "dnsServer" : "172.16.11.4"
    },
    "kubernetesNetwork" : {
      "vcenterNetwork" : "VcenterNetwork",
      "cidr" : "10.255.1.0/24",
      "gateway" : "10.255.1.1",
      "reservedRanges" : "10.255.1.1-10.255.1.10",
      "dnsServer" : "172.16.11.4"
    },
    "managementZone" : {
      "name" : "AZ1",
      "resourcePoolName" : "AZ1_Resource_Pool",
      "clusterName" : "pks-cluster"
    },
    "kubernetesZones" : [ {
      "name" : "AZ2",
      "resourcePoolName" : "AZ2_Resource_Pool",
      "clusterName" : "pks-cluster"
    }, {
      "name" : "AZ3",
      "resourcePoolName" : "AZ3_Resource_Pool",
      "clusterName" : "pks-cluster"
    } ]
  },
  "certificateBundle" : {
    "trustedCertificates" : "-----BEGIN CERTIFICATE-----\nMIIDNTCCAh2gAwIBAgIJAMFqmuO1XQb9MA0GCSqGSIb3DQEBCwUAMBYxFDASBgNV\nBAMMC0Vhc3ktUlNBIENBMB4XDTE5MDQwNjExMDQ0NVoXDTI5MDQwMzExMDQ0NVow\nFjEUMBIGA1UEAwwLRWFzeS1SU0EgQ0EwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAw\nggEKAoIBAQC2Mw1Zu/Uj2d1CrQUPG96rJS116tbTRtaIlRjWW2W+6Ng6S/wRxMKS\nQKQbx2MBYYJYC76PRAu1r1AkZMh7QhN/ohzJNrXa+C1UAkKg0zD6xqbxbSIsyYCV\n3WDyL2jRjPjbelveKV7AvP+rbratF3fH8PtnMa9Jp5/fkWI76T8GipF4dYW1vAxy\nApD464PWKvkz4Y2Ey20gr15W/L4gNFgXdaENW7aY9T9N8JuFpIbBK6QS1vV+w4XJ\nqlEilT2l0MYUA78zAOl4e8XI4awGmc0lHU60+87/Za7ODZbp93EtXkRTjR23Ybvh\nqvYmbc4bZu+u5wHz8Zf5Q9S5bzciUlQ5AgMBAAGjgYUwgYIwHQYDVR0OBBYEFLRw\nFacXernqj0VPJ4TgtLdhFG++MEYGA1UdIwQ/MD2AFLRwFacXernqj0VPJ4TgtLdh\nFG++oRqkGDAWMxcvaswweewWhjhHVDklhlsfgsBDQYIJAMFqmuO1XQb9MAwGA1Ud\nEwQFMAMBAf8wCwYDVR0PBAQDAgEGMA0GCSqGSIb3DQEBCwUAA4IBAQARdK+wt2xr\nPiEX25Fmdw5CGlom2WDL5fqB7f05EgkMCzAWHZeVjIoHF2aPmEZTuCymk8neLyw6\nY5P0maW8VHhNwD93uovZnn1qccERjaOWSuxE/lJUWnrt7n4lJhWs4WBCc1SFeuvj\nL/AJyRv/DnGDUw7eXPQYR2vPa1yHZt8jr4nA5gbINAenJ0rX48mDB3jaroXyOUWE\nLfqtuLlxmWDE9iF4Aqu1vwYltEvbQ3k2tgDy6gTQbNl7/9UKMvl3bHI6xwjONvut\nfSJHetpy1h3sN5/XkOBnoNXiuoiDxo83+yDeIfCdDnCMcu13ByvZ9xSM4rBPSQNk\nfnIFWgyCUH8F\n-----END CERTIFICATE-----",
    "pcfRsaCert" : {
      "publicCert" : "-----BEGIN CERTIFICATE-----\nMIIDhDCCAmygAwIBAgIQQ/1NNsYBUlTDTSEBUXrT3TANBgkqhkiG9w0BAQsFADAW\nMRQwEgYDVQQDDAtFYXN5LVJTQSBDQTAeFw0xOTA0MDYxMTA0NDVaFw0yMjAzMjEx\nMTA0NDVaMCUxIzAhBgNVBAMMGmhhcmJvci52cmFjay52c3BoZXJlLmxvY2FsMIIB\nIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAsT/VwtwC45Z/OJeuTmuN6PXZ\njkQ/pz/RFZv7K0z/SWUW7QX5EFqpg7Vns7Ie3pbUs2jDH7W1Dn4NbDSChUmImD4i\nUXLHhhp7QCNaemqwersdfasnYO6VIcG6uF9oTOcGKPV2D/JE45H4hdEPwF50U8Ze\nZACyToSJbc1gzElZX+zlGiq+D+6AOjhlULAJrkNzyCwvq3CSPi/eS/OCN7cGVt0+\nyxonIH7mJM/sNU2W3MnmHQOESxOe8I99aOUtYNuhHTiP5HWFfCbIfqGcWlMgBLiG\nEsFLrKql6Ci8HOrW4vOzwho3Q4eRjGhNWBHddmGL2vbpfHsESDBmqoOYaXc6eQID\nAQABo4G+MIG7MAkGA1UdEwQCMAAwHQYDVR0OBBYEFJVT9cvazVOlO5DS6ryMwubg\nJLruMEYGA1UdIwQ/MD2AFLRwFacXernqj0VPJ4TgtLdhFG++oRqkGDAWMRQwEgYD\nVQQDDAtFYXN5LVJTQSBDQYIJAMFqmuO1XQb9MBMGA1UdJQQMMAoGCCsGAQUFBwMB\nMAsGA1UdDwQEAwIFoDAlBgNVHREEHjAcghpoYXJib3IudnJhY2sudnNwaGVyZS5s\nb2NhbDANBgkqhkiG9w0BAQsFAAOCAQEAXJgFwsjBU4apGKJvex4ro4vO0iMiGx4r\nlL4JkozNp4JJGGfPWY3cAmeykAX3mUfPNRosp6KqwHKUvP+bU0hsLDd+mrCRsA/J\ndsyyhfJqbtB0Ez3bQdelAacKS8aaCt3cmXU+hrPGTOkCoOeeeiR6uZFuuywG8dld\ntUD9jFd6CkizVVqsyk/lmZ0mEapW+4+D6VhPzrMFlqwW3h+1WM6CmMRPOJc42wQI\nG1GEpi9Sghs7V/VkrO78dWBWe6mcfYv3OsxR5iyGiNtIfM99EnIknf01HO3kUlP8\nvgS2QcTyDdpj1VI2oUL2wM77SXGfUynnmL1fCEdU++qO/bb2tsTiXA==\n-----END CERTIFICATE-----",
      "privateKey" : "-----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKCAQEAsT/VwtwC45Z/OJeuTmuN6PXZjkQ/pz/RFZv7K0z/SWUW7QX5\nEFqpg7Vns7Ie3pbUs2jDH7W1Dn4NbDSChUmImD4iUXLHhhp7QCNaemu03y3Npwfn\nYO6VIcG6uF9oTOcGKPV2D/JE45H4hdEPwF50U8ZeZACyToSJbc1gzElZX+zlGiq+\nD+6AOjhlULAJrkNzyCwvq3CSPi/eS/OCN7cGVt0+yxonIH7mJM/sNU2W3MnmHQOE\nSxOe8I99aOUtYNuhHTiP5HWFfCbIfqGcWlMgBLiGEsFLrKql6Ci8HOrW4vOzwho3\nQ4eRjGhNWBHddmGL2vbpfHsESDBmqoOYaXc6eQIDAQABAoIBAAXAq6BiYZmfVcux\naI/U/8sSx5fNcT9tW8zWviUen55zMHZK3lWAi8XhilcTrdrNjGOyP7r0u8aXornj\nTmUjCNLgGV8JWZ5pl5xySUp12m3v35/PKtxDggWRcwzu08TDLrj/lnBYDZJRN36o\nVVmJ9z6Mzp1yRFc2B/vPUZfvvX3WdZLwYSQeV4JLlfhiyCE1cYdc6y4RLfpOHQiw\nnhyoHYf1Uumy8g7co41sdcsergCBiNQe98Mola+x9f5srP9eu/YCnx1twBRM66iG\noq8lwykAN4xMSGZDFxCkaFC59lA7ek46uaMjeYcCU09OxvGGJdoRpEMCPDCg3lFC\n2SS95YECgYEA4jUWjHcyuhWfk6CYchGzA+D06FE0aAi47m3XU1Wx1SfZXVNoKymk\n9ebyu0V4UadYnZK6mGgFOpay6md32V41cFwJIOcwX9CVzDW74+w6PkqHo6HRbhNi\n3HDkKc2H1nPEQKqrrBneHajV8KyK+1lJoh1IHqn9V14q1TP90gc5wmkCgYEAyJgO\nSV4PtTdcfPWwQ3ujPpR6Av3B4F8Y5akx3w2P8QY7Qraovvdehblhc5MO2iNkXWdJ\nDks+buil2V5DJv2/L1dSM6WqjBaQY39iQ9R3r6/qSgG/RxYnAqr28jgBBqtjnrI1\nJjMJTBzhKFvXAtCJAPGeJKae/ZHpxa61oOGxlZECgYAg/YkaV1AIn5q0VxmkmTw4\ndpiBQUaZXZxK+a4Ls1XKNpOW7tEkamBqlJIWCd2wWu2rnXilPZZ1owDY+toZ04mL\np4CVUeJWNv+B1txeM1eTOh9qF/GJUj560+QSzKzg8+VNYRbEdMlWHgeFoERsv+rj\nP84C2tvd4BfzHDAKb49W8QKBgDOwuz28t1+DPJoW1a0OFyrxJ9/NdEBVQR0tVGSe\nIhGCAZNXbnSHWhwrgSk/I/yiUiKfkvvT9+qsmNBCshtCGBoi7lPQxPoEdoCtOq0v\n+weS1VTszlWLJ9JQLAKO2/TUBX/HfFqznBm492xm/ikDg8pyeMYJCb9d8le2hadH\ngXOBAoGBAN+Q14/0v64qQCmUlqq14IKEGyt9OUCMSGF/PRcRreaO/okM/0E0+uCf\n9eEoUyDvvvyM3xyqltf428mbaBEpBzF/IUDrSlHieyTSdSzJm6E83HJzVcWHQ4Nu\n5Ct0EQnyYqrmw0C3hpoBz9sgsF4oFRX4h8b4ammWXnI+OEUKPIsp\n-----END RSA PRIVATE KEY-----"
    },
    "pksRsaCert" : {
      "publicCert" : "-----BEGIN CERTIFICATE-----\nMIIDhDCCAmygAwIBAgIQQ/1NNsYBUlTDTSEBUXrT3TANBgkqhkiG9w0BAQsFADAW\nMRQwEgYDVQQDDAtFYXN5LVJTQSBDQTAeFw0xOTA0MDYxMTA0NDVaFw0yMjAzMjEx\nMTA0NDVaMCUxIzAhBgNVBAMMGmhhcmJvci52cmFjay52c3BoZXJlLmxvY2FsMIIB\nIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAsT/VwtwC45Z/OJeuTmuN6PXZ\njkQ/pz/RFZv7K0z/SWUW7QX5EFqpg7Vns7Ie3pbUs2jDH7W1Dn4NbDSChUmImD4i\nUXLHhhp7QCNaemqwersdfasnYO6VIcG6uF9oTOcGKPV2D/JE45H4hdEPwF50U8Ze\nZACyToSJbc1gzElZX+zlGiq+D+6AOjhlULAJrkNzyCwvq3CSPi/eS/OCN7cGVt0+\nyxonIH7mJM/sNU2W3MnmHQOESxOe8I99aOUtYNuhHTiP5HWFfCbIfqGcWlMgBLiG\nEsFLrKql6Ci8HOrW4vOzwho3Q4eRjGhNWBHddmGL2vbpfHsESDBmqoOYaXc6eQID\nAQABo4G+MIG7MAkGA1UdEwQCMAAwHQYDVR0OBBYEFJVT9cvazVOlO5DS6ryMwubg\nJLruMEYGA1UdIwQ/MD2AFLRwFacXernqj0VPJ4TgtLdhFG++oRqkGDAWMRQwEgYD\nVQQDDAtFYXN5LVJTQSBDQYIJAMFqmuO1XQb9MBMGA1UdJQQMMAoGCCsGAQUFBwMB\nMAsGA1UdDwQEAwIFoDAlBgNVHREEHjAcghpoYXJib3IudnJhY2sudnNwaGVyZS5s\nb2NhbDANBgkqhkiG9w0BAQsFAAOCAQEAXJgFwsjBU4apGKJvex4ro4vO0iMiGx4r\nlL4JkozNp4JJGGfPWY3cAmeykAX3mUfPNRosp6KqwHKUvP+bU0hsLDd+mrCRsA/J\ndsyyhfJqbtB0Ez3bQdelAacKS8aaCt3cmXU+hrPGTOkCoOeeeiR6uZFuuywG8dld\ntUD9jFd6CkizVVqsyk/lmZ0mEapW+4+D6VhPzrMFlqwW3h+1WM6CmMRPOJc42wQI\nG1GEpi9Sghs7V/VkrO78dWBWe6mcfYv3OsxR5iyGiNtIfM99EnIknf01HO3kUlP8\nvgS2QcTyDdpj1VI2oUL2wM77SXGfUynnmL1fCEdU++qO/bb2tsTiXA==\n-----END CERTIFICATE-----",
      "privateKey" : "-----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKCAQEAsT/VwtwC45Z/OJeuTmuN6PXZjkQ/pz/RFZv7K0z/SWUW7QX5\nEFqpg7Vns7Ie3pbUs2jDH7W1Dn4NbDSChUmImD4iUXLHhhp7QCNaemu03y3Npwfn\nYO6VIcG6uF9oTOcGKPV2D/JE45H4hdEPwF50U8ZeZACyToSJbc1gzElZX+zlGiq+\nD+6AOjhlULAJrkNzyCwvq3CSPi/eS/OCN7cGVt0+yxonIH7mJM/sNU2W3MnmHQOE\nSxOe8I99aOUtYNuhHTiP5HWFfCbIfqGcWlMgBLiGEsFLrKql6Ci8HOrW4vOzwho3\nQ4eRjGhNWBHddmGL2vbpfHsESDBmqoOYaXc6eQIDAQABAoIBAAXAq6BiYZmfVcux\naI/U/8sSx5fNcT9tW8zWviUen55zMHZK3lWAi8XhilcTrdrNjGOyP7r0u8aXornj\nTmUjCNLgGV8JWZ5pl5xySUp12m3v35/PKtxDggWRcwzu08TDLrj/lnBYDZJRN36o\nVVmJ9z6Mzp1yRFc2B/vPUZfvvX3WdZLwYSQeV4JLlfhiyCE1cYdc6y4RLfpOHQiw\nnhyoHYf1Uumy8g7co41sdcsergCBiNQe98Mola+x9f5srP9eu/YCnx1twBRM66iG\noq8lwykAN4xMSGZDFxCkaFC59lA7ek46uaMjeYcCU09OxvGGJdoRpEMCPDCg3lFC\n2SS95YECgYEA4jUWjHcyuhWfk6CYchGzA+D06FE0aAi47m3XU1Wx1SfZXVNoKymk\n9ebyu0V4UadYnZK6mGgFOpay6md32V41cFwJIOcwX9CVzDW74+w6PkqHo6HRbhNi\n3HDkKc2H1nPEQKqrrBneHajV8KyK+1lJoh1IHqn9V14q1TP90gc5wmkCgYEAyJgO\nSV4PtTdcfPWwQ3ujPpR6Av3B4F8Y5akx3w2P8QY7Qraovvdehblhc5MO2iNkXWdJ\nDks+buil2V5DJv2/L1dSM6WqjBaQY39iQ9R3r6/qSgG/RxYnAqr28jgBBqtjnrI1\nJjMJTBzhKFvXAtCJAPGeJKae/ZHpxa61oOGxlZECgYAg/YkaV1AIn5q0VxmkmTw4\ndpiBQUaZXZxK+a4Ls1XKNpOW7tEkamBqlJIWCd2wWu2rnXilPZZ1owDY+toZ04mL\np4CVUeJWNv+B1txeM1eTOh9qF/GJUj560+QSzKzg8+VNYRbEdMlWHgeFoERsv+rj\nP84C2tvd4BfzHDAKb49W8QKBgDOwuz28t1+DPJoW1a0OFyrxJ9/NdEBVQR0tVGSe\nIhGCAZNXbnSHWhwrgSk/I/yiUiKfkvvT9+qsmNBCshtCGBoi7lPQxPoEdoCtOq0v\n+weS1VTszlWLJ9JQLAKO2/TUBX/HfFqznBm492xm/ikDg8pyeMYJCb9d8le2hadH\ngXOBAoGBAN+Q14/0v64qQCmUlqq14IKEGyt9OUCMSGF/PRcRreaO/okM/0E0+uCf\n9eEoUyDvvvyM3xyqltf428mbaBEpBzF/IUDrSlHieyTSdSzJm6E83HJzVcWHQ4Nu\n5Ct0EQnyYqrmw0C3hpoBz9sgsF4oFRX4h8b4ammWXnI+OEUKPIsp\n-----END RSA PRIVATE KEY-----"
    },
    "nsxtRsaCert" : {
      "publicCert" : "-----BEGIN CERTIFICATE-----\nMIIDhDCCAmygAwIBAgIQQ/1NNsYBUlTDTSEBUXrT3TANBgkqhkiG9w0BAQsFADAW\nMRQwEgYDVQQDDAtFYXN5LVJTQSBDQTAeFw0xOTA0MDYxMTA0NDVaFw0yMjAzMjEx\nMTA0NDVaMCUxIzAhBgNVBAMMGmhhcmJvci52cmFjay52c3BoZXJlLmxvY2FsMIIB\nIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAsT/VwtwC45Z/OJeuTmuN6PXZ\njkQ/pz/RFZv7K0z/SWUW7QX5EFqpg7Vns7Ie3pbUs2jDH7W1Dn4NbDSChUmImD4i\nUXLHhhp7QCNaemqwersdfasnYO6VIcG6uF9oTOcGKPV2D/JE45H4hdEPwF50U8Ze\nZACyToSJbc1gzElZX+zlGiq+D+6AOjhlULAJrkNzyCwvq3CSPi/eS/OCN7cGVt0+\nyxonIH7mJM/sNU2W3MnmHQOESxOe8I99aOUtYNuhHTiP5HWFfCbIfqGcWlMgBLiG\nEsFLrKql6Ci8HOrW4vOzwho3Q4eRjGhNWBHddmGL2vbpfHsESDBmqoOYaXc6eQID\nAQABo4G+MIG7MAkGA1UdEwQCMAAwHQYDVR0OBBYEFJVT9cvazVOlO5DS6ryMwubg\nJLruMEYGA1UdIwQ/MD2AFLRwFacXernqj0VPJ4TgtLdhFG++oRqkGDAWMRQwEgYD\nVQQDDAtFYXN5LVJTQSBDQYIJAMFqmuO1XQb9MBMGA1UdJQQMMAoGCCsGAQUFBwMB\nMAsGA1UdDwQEAwIFoDAlBgNVHREEHjAcghpoYXJib3IudnJhY2sudnNwaGVyZS5s\nb2NhbDANBgkqhkiG9w0BAQsFAAOCAQEAXJgFwsjBU4apGKJvex4ro4vO0iMiGx4r\nlL4JkozNp4JJGGfPWY3cAmeykAX3mUfPNRosp6KqwHKUvP+bU0hsLDd+mrCRsA/J\ndsyyhfJqbtB0Ez3bQdelAacKS8aaCt3cmXU+hrPGTOkCoOeeeiR6uZFuuywG8dld\ntUD9jFd6CkizVVqsyk/lmZ0mEapW+4+D6VhPzrMFlqwW3h+1WM6CmMRPOJc42wQI\nG1GEpi9Sghs7V/VkrO78dWBWe6mcfYv3OsxR5iyGiNtIfM99EnIknf01HO3kUlP8\nvgS2QcTyDdpj1VI2oUL2wM77SXGfUynnmL1fCEdU++qO/bb2tsTiXA==\n-----END CERTIFICATE-----",
      "privateKey" : "-----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKCAQEAsT/VwtwC45Z/OJeuTmuN6PXZjkQ/pz/RFZv7K0z/SWUW7QX5\nEFqpg7Vns7Ie3pbUs2jDH7W1Dn4NbDSChUmImD4iUXLHhhp7QCNaemu03y3Npwfn\nYO6VIcG6uF9oTOcGKPV2D/JE45H4hdEPwF50U8ZeZACyToSJbc1gzElZX+zlGiq+\nD+6AOjhlULAJrkNzyCwvq3CSPi/eS/OCN7cGVt0+yxonIH7mJM/sNU2W3MnmHQOE\nSxOe8I99aOUtYNuhHTiP5HWFfCbIfqGcWlMgBLiGEsFLrKql6Ci8HOrW4vOzwho3\nQ4eRjGhNWBHddmGL2vbpfHsESDBmqoOYaXc6eQIDAQABAoIBAAXAq6BiYZmfVcux\naI/U/8sSx5fNcT9tW8zWviUen55zMHZK3lWAi8XhilcTrdrNjGOyP7r0u8aXornj\nTmUjCNLgGV8JWZ5pl5xySUp12m3v35/PKtxDggWRcwzu08TDLrj/lnBYDZJRN36o\nVVmJ9z6Mzp1yRFc2B/vPUZfvvX3WdZLwYSQeV4JLlfhiyCE1cYdc6y4RLfpOHQiw\nnhyoHYf1Uumy8g7co41sdcsergCBiNQe98Mola+x9f5srP9eu/YCnx1twBRM66iG\noq8lwykAN4xMSGZDFxCkaFC59lA7ek46uaMjeYcCU09OxvGGJdoRpEMCPDCg3lFC\n2SS95YECgYEA4jUWjHcyuhWfk6CYchGzA+D06FE0aAi47m3XU1Wx1SfZXVNoKymk\n9ebyu0V4UadYnZK6mGgFOpay6md32V41cFwJIOcwX9CVzDW74+w6PkqHo6HRbhNi\n3HDkKc2H1nPEQKqrrBneHajV8KyK+1lJoh1IHqn9V14q1TP90gc5wmkCgYEAyJgO\nSV4PtTdcfPWwQ3ujPpR6Av3B4F8Y5akx3w2P8QY7Qraovvdehblhc5MO2iNkXWdJ\nDks+buil2V5DJv2/L1dSM6WqjBaQY39iQ9R3r6/qSgG/RxYnAqr28jgBBqtjnrI1\nJjMJTBzhKFvXAtCJAPGeJKae/ZHpxa61oOGxlZECgYAg/YkaV1AIn5q0VxmkmTw4\ndpiBQUaZXZxK+a4Ls1XKNpOW7tEkamBqlJIWCd2wWu2rnXilPZZ1owDY+toZ04mL\np4CVUeJWNv+B1txeM1eTOh9qF/GJUj560+QSzKzg8+VNYRbEdMlWHgeFoERsv+rj\nP84C2tvd4BfzHDAKb49W8QKBgDOwuz28t1+DPJoW1a0OFyrxJ9/NdEBVQR0tVGSe\nIhGCAZNXbnSHWhwrgSk/I/yiUiKfkvvT9+qsmNBCshtCGBoi7lPQxPoEdoCtOq0v\n+weS1VTszlWLJ9JQLAKO2/TUBX/HfFqznBm492xm/ikDg8pyeMYJCb9d8le2hadH\ngXOBAoGBAN+Q14/0v64qQCmUlqq14IKEGyt9OUCMSGF/PRcRreaO/okM/0E0+uCf\n9eEoUyDvvvyM3xyqltf428mbaBEpBzF/IUDrSlHieyTSdSzJm6E83HJzVcWHQ4Nu\n5Ct0EQnyYqrmw0C3hpoBz9sgsF4oFRX4h8b4ammWXnI+OEUKPIsp\n-----END RSA PRIVATE KEY-----"
    },
    "harborRsaCert" : {
      "publicCert" : "-----BEGIN CERTIFICATE-----\nMIIDhDCCAmygAwIBAgIQQ/1NNsYBUlTDTSEBUXrT3TANBgkqhkiG9w0BAQsFADAW\nMRQwEgYDVQQDDAtFYXN5LVJTQSBDQTAeFw0xOTA0MDYxMTA0NDVaFw0yMjAzMjEx\nMTA0NDVaMCUxIzAhBgNVBAMMGmhhcmJvci52cmFjay52c3BoZXJlLmxvY2FsMIIB\nIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAsT/VwtwC45Z/OJeuTmuN6PXZ\njkQ/pz/RFZv7K0z/SWUW7QX5EFqpg7Vns7Ie3pbUs2jDH7W1Dn4NbDSChUmImD4i\nUXLHhhp7QCNaemqwersdfasnYO6VIcG6uF9oTOcGKPV2D/JE45H4hdEPwF50U8Ze\nZACyToSJbc1gzElZX+zlGiq+D+6AOjhlULAJrkNzyCwvq3CSPi/eS/OCN7cGVt0+\nyxonIH7mJM/sNU2W3MnmHQOESxOe8I99aOUtYNuhHTiP5HWFfCbIfqGcWlMgBLiG\nEsFLrKql6Ci8HOrW4vOzwho3Q4eRjGhNWBHddmGL2vbpfHsESDBmqoOYaXc6eQID\nAQABo4G+MIG7MAkGA1UdEwQCMAAwHQYDVR0OBBYEFJVT9cvazVOlO5DS6ryMwubg\nJLruMEYGA1UdIwQ/MD2AFLRwFacXernqj0VPJ4TgtLdhFG++oRqkGDAWMRQwEgYD\nVQQDDAtFYXN5LVJTQSBDQYIJAMFqmuO1XQb9MBMGA1UdJQQMMAoGCCsGAQUFBwMB\nMAsGA1UdDwQEAwIFoDAlBgNVHREEHjAcghpoYXJib3IudnJhY2sudnNwaGVyZS5s\nb2NhbDANBgkqhkiG9w0BAQsFAAOCAQEAXJgFwsjBU4apGKJvex4ro4vO0iMiGx4r\nlL4JkozNp4JJGGfPWY3cAmeykAX3mUfPNRosp6KqwHKUvP+bU0hsLDd+mrCRsA/J\ndsyyhfJqbtB0Ez3bQdelAacKS8aaCt3cmXU+hrPGTOkCoOeeeiR6uZFuuywG8dld\ntUD9jFd6CkizVVqsyk/lmZ0mEapW+4+D6VhPzrMFlqwW3h+1WM6CmMRPOJc42wQI\nG1GEpi9Sghs7V/VkrO78dWBWe6mcfYv3OsxR5iyGiNtIfM99EnIknf01HO3kUlP8\nvgS2QcTyDdpj1VI2oUL2wM77SXGfUynnmL1fCEdU++qO/bb2tsTiXA==\n-----END CERTIFICATE-----",
      "privateKey" : "-----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKCAQEAsT/VwtwC45Z/OJeuTmuN6PXZjkQ/pz/RFZv7K0z/SWUW7QX5\nEFqpg7Vns7Ie3pbUs2jDH7W1Dn4NbDSChUmImD4iUXLHhhp7QCNaemu03y3Npwfn\nYO6VIcG6uF9oTOcGKPV2D/JE45H4hdEPwF50U8ZeZACyToSJbc1gzElZX+zlGiq+\nD+6AOjhlULAJrkNzyCwvq3CSPi/eS/OCN7cGVt0+yxonIH7mJM/sNU2W3MnmHQOE\nSxOe8I99aOUtYNuhHTiP5HWFfCbIfqGcWlMgBLiGEsFLrKql6Ci8HOrW4vOzwho3\nQ4eRjGhNWBHddmGL2vbpfHsESDBmqoOYaXc6eQIDAQABAoIBAAXAq6BiYZmfVcux\naI/U/8sSx5fNcT9tW8zWviUen55zMHZK3lWAi8XhilcTrdrNjGOyP7r0u8aXornj\nTmUjCNLgGV8JWZ5pl5xySUp12m3v35/PKtxDggWRcwzu08TDLrj/lnBYDZJRN36o\nVVmJ9z6Mzp1yRFc2B/vPUZfvvX3WdZLwYSQeV4JLlfhiyCE1cYdc6y4RLfpOHQiw\nnhyoHYf1Uumy8g7co41sdcsergCBiNQe98Mola+x9f5srP9eu/YCnx1twBRM66iG\noq8lwykAN4xMSGZDFxCkaFC59lA7ek46uaMjeYcCU09OxvGGJdoRpEMCPDCg3lFC\n2SS95YECgYEA4jUWjHcyuhWfk6CYchGzA+D06FE0aAi47m3XU1Wx1SfZXVNoKymk\n9ebyu0V4UadYnZK6mGgFOpay6md32V41cFwJIOcwX9CVzDW74+w6PkqHo6HRbhNi\n3HDkKc2H1nPEQKqrrBneHajV8KyK+1lJoh1IHqn9V14q1TP90gc5wmkCgYEAyJgO\nSV4PtTdcfPWwQ3ujPpR6Av3B4F8Y5akx3w2P8QY7Qraovvdehblhc5MO2iNkXWdJ\nDks+buil2V5DJv2/L1dSM6WqjBaQY39iQ9R3r6/qSgG/RxYnAqr28jgBBqtjnrI1\nJjMJTBzhKFvXAtCJAPGeJKae/ZHpxa61oOGxlZECgYAg/YkaV1AIn5q0VxmkmTw4\ndpiBQUaZXZxK+a4Ls1XKNpOW7tEkamBqlJIWCd2wWu2rnXilPZZ1owDY+toZ04mL\np4CVUeJWNv+B1txeM1eTOh9qF/GJUj560+QSzKzg8+VNYRbEdMlWHgeFoERsv+rj\nP84C2tvd4BfzHDAKb49W8QKBgDOwuz28t1+DPJoW1a0OFyrxJ9/NdEBVQR0tVGSe\nIhGCAZNXbnSHWhwrgSk/I/yiUiKfkvvT9+qsmNBCshtCGBoi7lPQxPoEdoCtOq0v\n+weS1VTszlWLJ9JQLAKO2/TUBX/HfFqznBm492xm/ikDg8pyeMYJCb9d8le2hadH\ngXOBAoGBAN+Q14/0v64qQCmUlqq14IKEGyt9OUCMSGF/PRcRreaO/okM/0E0+uCf\n9eEoUyDvvvyM3xyqltf428mbaBEpBzF/IUDrSlHieyTSdSzJm6E83HJzVcWHQ4Nu\n5Ct0EQnyYqrmw0C3hpoBz9sgsF4oFRX4h8b4ammWXnI+OEUKPIsp\n-----END RSA PRIVATE KEY-----"
    }
  },
  "datastore" : "datastore"
}

HTTP Response

HTTP/1.1 202 Accepted
Location: /v1/tasks/d39fc601-b2dc-4641-8abd-2cb169a18421
Content-Type: application/json;charset=UTF-8
Content-Length: 79

{
  "id" : "d39fc601-b2dc-4641-8abd-2cb169a18421",
  "status" : "IN_PROGRESS"
}
Related APIs

Install PKS
Validate PKS specification before installation
Get validation results
Get a list of installed PKS
Get PKS details
Initialize PKS deletion
Delete PKS

2.9.4. Get a list of Pivotal Container Services

Prerequisites

  1. None

Steps

  1. Invoke the API

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/pkses' -i -u 'admin:VMwareInfra@1' -X GET \
    -H 'Content-Type: application/json'

HTTP Request

GET /v1/pkses HTTP/1.1
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==
Content-Type: application/json

HTTP Response

HTTP/1.1 200 OK
Content-Length: 16972
Content-Type: application/json;charset=UTF-8

{
  "elements" : [ {
    "inputSpec" : {
      "domainId" : "76df11e9-5c1f-4376-b913-0ea93ebda983",
      "name" : "PKS-1",
      "pksApiHostname" : "pksApi.sfo01.rainpole.local",
      "adminPassword" : "SecurePassword123!",
      "decryptionPassphrase" : "SecurePassword123!",
      "harborHostname" : "harbor.sfo01.rainpole.local",
      "installHarbor" : true,
      "nsxtItemsSpec" : {
        "t0routerId" : "bc3fda31-74b9-4759-8e1f-ff72726b8d5d",
        "nodesIpBlockId" : "b73446a0-9ffe-4291-b34f-ff0b6ee67ff3",
        "floatingIpPoolId" : "ee7d0bc1-0cd3-4c59-8944-65a36fe35cf7",
        "podsIpBlockId" : "6f5db6d2-30f6-47e3-a765-3ebc34390bce"
      },
      "pksOpsManagerVmSpec" : {
        "network" : {
          "network" : "network",
          "dnsServers" : [ "172.16.11.4", "172.16.11.5" ],
          "ntpServers" : [ "172.16.11.251", "172.16.11.252" ],
          "dnsSuffix" : "*.sfo01.rainpole.local",
          "gateway" : "10.255.0.1",
          "netmask" : "255.255.255.0"
        },
        "appliance" : {
          "ip" : "10.255.0.10",
          "hostname" : "pcf.sfo01.rainpole.local",
          "vmName" : "ops-manager"
        }
      },
      "availabilityZoneSpec" : {
        "managementNetwork" : {
          "vcenterNetwork" : "VcenterNetwork",
          "cidr" : "10.255.0.0/24",
          "gateway" : "10.255.0.1",
          "reservedRanges" : "10.255.0.1-10.255.0.10",
          "dnsServer" : "172.16.11.4"
        },
        "kubernetesNetwork" : {
          "vcenterNetwork" : "VcenterNetwork",
          "cidr" : "10.255.1.0/24",
          "gateway" : "10.255.1.1",
          "reservedRanges" : "10.255.1.1-10.255.1.10",
          "dnsServer" : "172.16.11.4"
        },
        "managementZone" : {
          "name" : "AZ1",
          "resourcePoolName" : "AZ1_Resource_Pool",
          "clusterName" : "pks-cluster"
        },
        "kubernetesZones" : [ {
          "name" : "AZ2",
          "resourcePoolName" : "AZ2_Resource_Pool",
          "clusterName" : "pks-cluster"
        }, {
          "name" : "AZ3",
          "resourcePoolName" : "AZ3_Resource_Pool",
          "clusterName" : "pks-cluster"
        } ]
      },
      "certificateBundle" : {
        "trustedCertificates" : "-----BEGIN CERTIFICATE-----\nMIIDNTCCAh2gAwIBAgIJAMFqmuO1XQb9MA0GCSqGSIb3DQEBCwUAMBYxFDASBgNV\nBAMMC0Vhc3ktUlNBIENBMB4XDTE5MDQwNjExMDQ0NVoXDTI5MDQwMzExMDQ0NVow\nFjEUMBIGA1UEAwwLRWFzeS1SU0EgQ0EwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAw\nggEKAoIBAQC2Mw1Zu/Uj2d1CrQUPG96rJS116tbTRtaIlRjWW2W+6Ng6S/wRxMKS\nQKQbx2MBYYJYC76PRAu1r1AkZMh7QhN/ohzJNrXa+C1UAkKg0zD6xqbxbSIsyYCV\n3WDyL2jRjPjbelveKV7AvP+rbratF3fH8PtnMa9Jp5/fkWI76T8GipF4dYW1vAxy\nApD464PWKvkz4Y2Ey20gr15W/L4gNFgXdaENW7aY9T9N8JuFpIbBK6QS1vV+w4XJ\nqlEilT2l0MYUA78zAOl4e8XI4awGmc0lHU60+87/Za7ODZbp93EtXkRTjR23Ybvh\nqvYmbc4bZu+u5wHz8Zf5Q9S5bzciUlQ5AgMBAAGjgYUwgYIwHQYDVR0OBBYEFLRw\nFacXernqj0VPJ4TgtLdhFG++MEYGA1UdIwQ/MD2AFLRwFacXernqj0VPJ4TgtLdh\nFG++oRqkGDAWMxcvaswweewWhjhHVDklhlsfgsBDQYIJAMFqmuO1XQb9MAwGA1Ud\nEwQFMAMBAf8wCwYDVR0PBAQDAgEGMA0GCSqGSIb3DQEBCwUAA4IBAQARdK+wt2xr\nPiEX25Fmdw5CGlom2WDL5fqB7f05EgkMCzAWHZeVjIoHF2aPmEZTuCymk8neLyw6\nY5P0maW8VHhNwD93uovZnn1qccERjaOWSuxE/lJUWnrt7n4lJhWs4WBCc1SFeuvj\nL/AJyRv/DnGDUw7eXPQYR2vPa1yHZt8jr4nA5gbINAenJ0rX48mDB3jaroXyOUWE\nLfqtuLlxmWDE9iF4Aqu1vwYltEvbQ3k2tgDy6gTQbNl7/9UKMvl3bHI6xwjONvut\nfSJHetpy1h3sN5/XkOBnoNXiuoiDxo83+yDeIfCdDnCMcu13ByvZ9xSM4rBPSQNk\nfnIFWgyCUH8F\n-----END CERTIFICATE-----",
        "pcfRsaCert" : {
          "publicCert" : "-----BEGIN CERTIFICATE-----\nMIIDhDCCAmygAwIBAgIQQ/1NNsYBUlTDTSEBUXrT3TANBgkqhkiG9w0BAQsFADAW\nMRQwEgYDVQQDDAtFYXN5LVJTQSBDQTAeFw0xOTA0MDYxMTA0NDVaFw0yMjAzMjEx\nMTA0NDVaMCUxIzAhBgNVBAMMGmhhcmJvci52cmFjay52c3BoZXJlLmxvY2FsMIIB\nIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAsT/VwtwC45Z/OJeuTmuN6PXZ\njkQ/pz/RFZv7K0z/SWUW7QX5EFqpg7Vns7Ie3pbUs2jDH7W1Dn4NbDSChUmImD4i\nUXLHhhp7QCNaemqwersdfasnYO6VIcG6uF9oTOcGKPV2D/JE45H4hdEPwF50U8Ze\nZACyToSJbc1gzElZX+zlGiq+D+6AOjhlULAJrkNzyCwvq3CSPi/eS/OCN7cGVt0+\nyxonIH7mJM/sNU2W3MnmHQOESxOe8I99aOUtYNuhHTiP5HWFfCbIfqGcWlMgBLiG\nEsFLrKql6Ci8HOrW4vOzwho3Q4eRjGhNWBHddmGL2vbpfHsESDBmqoOYaXc6eQID\nAQABo4G+MIG7MAkGA1UdEwQCMAAwHQYDVR0OBBYEFJVT9cvazVOlO5DS6ryMwubg\nJLruMEYGA1UdIwQ/MD2AFLRwFacXernqj0VPJ4TgtLdhFG++oRqkGDAWMRQwEgYD\nVQQDDAtFYXN5LVJTQSBDQYIJAMFqmuO1XQb9MBMGA1UdJQQMMAoGCCsGAQUFBwMB\nMAsGA1UdDwQEAwIFoDAlBgNVHREEHjAcghpoYXJib3IudnJhY2sudnNwaGVyZS5s\nb2NhbDANBgkqhkiG9w0BAQsFAAOCAQEAXJgFwsjBU4apGKJvex4ro4vO0iMiGx4r\nlL4JkozNp4JJGGfPWY3cAmeykAX3mUfPNRosp6KqwHKUvP+bU0hsLDd+mrCRsA/J\ndsyyhfJqbtB0Ez3bQdelAacKS8aaCt3cmXU+hrPGTOkCoOeeeiR6uZFuuywG8dld\ntUD9jFd6CkizVVqsyk/lmZ0mEapW+4+D6VhPzrMFlqwW3h+1WM6CmMRPOJc42wQI\nG1GEpi9Sghs7V/VkrO78dWBWe6mcfYv3OsxR5iyGiNtIfM99EnIknf01HO3kUlP8\nvgS2QcTyDdpj1VI2oUL2wM77SXGfUynnmL1fCEdU++qO/bb2tsTiXA==\n-----END CERTIFICATE-----",
          "privateKey" : "-----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKCAQEAsT/VwtwC45Z/OJeuTmuN6PXZjkQ/pz/RFZv7K0z/SWUW7QX5\nEFqpg7Vns7Ie3pbUs2jDH7W1Dn4NbDSChUmImD4iUXLHhhp7QCNaemu03y3Npwfn\nYO6VIcG6uF9oTOcGKPV2D/JE45H4hdEPwF50U8ZeZACyToSJbc1gzElZX+zlGiq+\nD+6AOjhlULAJrkNzyCwvq3CSPi/eS/OCN7cGVt0+yxonIH7mJM/sNU2W3MnmHQOE\nSxOe8I99aOUtYNuhHTiP5HWFfCbIfqGcWlMgBLiGEsFLrKql6Ci8HOrW4vOzwho3\nQ4eRjGhNWBHddmGL2vbpfHsESDBmqoOYaXc6eQIDAQABAoIBAAXAq6BiYZmfVcux\naI/U/8sSx5fNcT9tW8zWviUen55zMHZK3lWAi8XhilcTrdrNjGOyP7r0u8aXornj\nTmUjCNLgGV8JWZ5pl5xySUp12m3v35/PKtxDggWRcwzu08TDLrj/lnBYDZJRN36o\nVVmJ9z6Mzp1yRFc2B/vPUZfvvX3WdZLwYSQeV4JLlfhiyCE1cYdc6y4RLfpOHQiw\nnhyoHYf1Uumy8g7co41sdcsergCBiNQe98Mola+x9f5srP9eu/YCnx1twBRM66iG\noq8lwykAN4xMSGZDFxCkaFC59lA7ek46uaMjeYcCU09OxvGGJdoRpEMCPDCg3lFC\n2SS95YECgYEA4jUWjHcyuhWfk6CYchGzA+D06FE0aAi47m3XU1Wx1SfZXVNoKymk\n9ebyu0V4UadYnZK6mGgFOpay6md32V41cFwJIOcwX9CVzDW74+w6PkqHo6HRbhNi\n3HDkKc2H1nPEQKqrrBneHajV8KyK+1lJoh1IHqn9V14q1TP90gc5wmkCgYEAyJgO\nSV4PtTdcfPWwQ3ujPpR6Av3B4F8Y5akx3w2P8QY7Qraovvdehblhc5MO2iNkXWdJ\nDks+buil2V5DJv2/L1dSM6WqjBaQY39iQ9R3r6/qSgG/RxYnAqr28jgBBqtjnrI1\nJjMJTBzhKFvXAtCJAPGeJKae/ZHpxa61oOGxlZECgYAg/YkaV1AIn5q0VxmkmTw4\ndpiBQUaZXZxK+a4Ls1XKNpOW7tEkamBqlJIWCd2wWu2rnXilPZZ1owDY+toZ04mL\np4CVUeJWNv+B1txeM1eTOh9qF/GJUj560+QSzKzg8+VNYRbEdMlWHgeFoERsv+rj\nP84C2tvd4BfzHDAKb49W8QKBgDOwuz28t1+DPJoW1a0OFyrxJ9/NdEBVQR0tVGSe\nIhGCAZNXbnSHWhwrgSk/I/yiUiKfkvvT9+qsmNBCshtCGBoi7lPQxPoEdoCtOq0v\n+weS1VTszlWLJ9JQLAKO2/TUBX/HfFqznBm492xm/ikDg8pyeMYJCb9d8le2hadH\ngXOBAoGBAN+Q14/0v64qQCmUlqq14IKEGyt9OUCMSGF/PRcRreaO/okM/0E0+uCf\n9eEoUyDvvvyM3xyqltf428mbaBEpBzF/IUDrSlHieyTSdSzJm6E83HJzVcWHQ4Nu\n5Ct0EQnyYqrmw0C3hpoBz9sgsF4oFRX4h8b4ammWXnI+OEUKPIsp\n-----END RSA PRIVATE KEY-----"
        },
        "pksRsaCert" : {
          "publicCert" : "-----BEGIN CERTIFICATE-----\nMIIDhDCCAmygAwIBAgIQQ/1NNsYBUlTDTSEBUXrT3TANBgkqhkiG9w0BAQsFADAW\nMRQwEgYDVQQDDAtFYXN5LVJTQSBDQTAeFw0xOTA0MDYxMTA0NDVaFw0yMjAzMjEx\nMTA0NDVaMCUxIzAhBgNVBAMMGmhhcmJvci52cmFjay52c3BoZXJlLmxvY2FsMIIB\nIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAsT/VwtwC45Z/OJeuTmuN6PXZ\njkQ/pz/RFZv7K0z/SWUW7QX5EFqpg7Vns7Ie3pbUs2jDH7W1Dn4NbDSChUmImD4i\nUXLHhhp7QCNaemqwersdfasnYO6VIcG6uF9oTOcGKPV2D/JE45H4hdEPwF50U8Ze\nZACyToSJbc1gzElZX+zlGiq+D+6AOjhlULAJrkNzyCwvq3CSPi/eS/OCN7cGVt0+\nyxonIH7mJM/sNU2W3MnmHQOESxOe8I99aOUtYNuhHTiP5HWFfCbIfqGcWlMgBLiG\nEsFLrKql6Ci8HOrW4vOzwho3Q4eRjGhNWBHddmGL2vbpfHsESDBmqoOYaXc6eQID\nAQABo4G+MIG7MAkGA1UdEwQCMAAwHQYDVR0OBBYEFJVT9cvazVOlO5DS6ryMwubg\nJLruMEYGA1UdIwQ/MD2AFLRwFacXernqj0VPJ4TgtLdhFG++oRqkGDAWMRQwEgYD\nVQQDDAtFYXN5LVJTQSBDQYIJAMFqmuO1XQb9MBMGA1UdJQQMMAoGCCsGAQUFBwMB\nMAsGA1UdDwQEAwIFoDAlBgNVHREEHjAcghpoYXJib3IudnJhY2sudnNwaGVyZS5s\nb2NhbDANBgkqhkiG9w0BAQsFAAOCAQEAXJgFwsjBU4apGKJvex4ro4vO0iMiGx4r\nlL4JkozNp4JJGGfPWY3cAmeykAX3mUfPNRosp6KqwHKUvP+bU0hsLDd+mrCRsA/J\ndsyyhfJqbtB0Ez3bQdelAacKS8aaCt3cmXU+hrPGTOkCoOeeeiR6uZFuuywG8dld\ntUD9jFd6CkizVVqsyk/lmZ0mEapW+4+D6VhPzrMFlqwW3h+1WM6CmMRPOJc42wQI\nG1GEpi9Sghs7V/VkrO78dWBWe6mcfYv3OsxR5iyGiNtIfM99EnIknf01HO3kUlP8\nvgS2QcTyDdpj1VI2oUL2wM77SXGfUynnmL1fCEdU++qO/bb2tsTiXA==\n-----END CERTIFICATE-----",
          "privateKey" : "-----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKCAQEAsT/VwtwC45Z/OJeuTmuN6PXZjkQ/pz/RFZv7K0z/SWUW7QX5\nEFqpg7Vns7Ie3pbUs2jDH7W1Dn4NbDSChUmImD4iUXLHhhp7QCNaemu03y3Npwfn\nYO6VIcG6uF9oTOcGKPV2D/JE45H4hdEPwF50U8ZeZACyToSJbc1gzElZX+zlGiq+\nD+6AOjhlULAJrkNzyCwvq3CSPi/eS/OCN7cGVt0+yxonIH7mJM/sNU2W3MnmHQOE\nSxOe8I99aOUtYNuhHTiP5HWFfCbIfqGcWlMgBLiGEsFLrKql6Ci8HOrW4vOzwho3\nQ4eRjGhNWBHddmGL2vbpfHsESDBmqoOYaXc6eQIDAQABAoIBAAXAq6BiYZmfVcux\naI/U/8sSx5fNcT9tW8zWviUen55zMHZK3lWAi8XhilcTrdrNjGOyP7r0u8aXornj\nTmUjCNLgGV8JWZ5pl5xySUp12m3v35/PKtxDggWRcwzu08TDLrj/lnBYDZJRN36o\nVVmJ9z6Mzp1yRFc2B/vPUZfvvX3WdZLwYSQeV4JLlfhiyCE1cYdc6y4RLfpOHQiw\nnhyoHYf1Uumy8g7co41sdcsergCBiNQe98Mola+x9f5srP9eu/YCnx1twBRM66iG\noq8lwykAN4xMSGZDFxCkaFC59lA7ek46uaMjeYcCU09OxvGGJdoRpEMCPDCg3lFC\n2SS95YECgYEA4jUWjHcyuhWfk6CYchGzA+D06FE0aAi47m3XU1Wx1SfZXVNoKymk\n9ebyu0V4UadYnZK6mGgFOpay6md32V41cFwJIOcwX9CVzDW74+w6PkqHo6HRbhNi\n3HDkKc2H1nPEQKqrrBneHajV8KyK+1lJoh1IHqn9V14q1TP90gc5wmkCgYEAyJgO\nSV4PtTdcfPWwQ3ujPpR6Av3B4F8Y5akx3w2P8QY7Qraovvdehblhc5MO2iNkXWdJ\nDks+buil2V5DJv2/L1dSM6WqjBaQY39iQ9R3r6/qSgG/RxYnAqr28jgBBqtjnrI1\nJjMJTBzhKFvXAtCJAPGeJKae/ZHpxa61oOGxlZECgYAg/YkaV1AIn5q0VxmkmTw4\ndpiBQUaZXZxK+a4Ls1XKNpOW7tEkamBqlJIWCd2wWu2rnXilPZZ1owDY+toZ04mL\np4CVUeJWNv+B1txeM1eTOh9qF/GJUj560+QSzKzg8+VNYRbEdMlWHgeFoERsv+rj\nP84C2tvd4BfzHDAKb49W8QKBgDOwuz28t1+DPJoW1a0OFyrxJ9/NdEBVQR0tVGSe\nIhGCAZNXbnSHWhwrgSk/I/yiUiKfkvvT9+qsmNBCshtCGBoi7lPQxPoEdoCtOq0v\n+weS1VTszlWLJ9JQLAKO2/TUBX/HfFqznBm492xm/ikDg8pyeMYJCb9d8le2hadH\ngXOBAoGBAN+Q14/0v64qQCmUlqq14IKEGyt9OUCMSGF/PRcRreaO/okM/0E0+uCf\n9eEoUyDvvvyM3xyqltf428mbaBEpBzF/IUDrSlHieyTSdSzJm6E83HJzVcWHQ4Nu\n5Ct0EQnyYqrmw0C3hpoBz9sgsF4oFRX4h8b4ammWXnI+OEUKPIsp\n-----END RSA PRIVATE KEY-----"
        },
        "nsxtRsaCert" : {
          "publicCert" : "-----BEGIN CERTIFICATE-----\nMIIDhDCCAmygAwIBAgIQQ/1NNsYBUlTDTSEBUXrT3TANBgkqhkiG9w0BAQsFADAW\nMRQwEgYDVQQDDAtFYXN5LVJTQSBDQTAeFw0xOTA0MDYxMTA0NDVaFw0yMjAzMjEx\nMTA0NDVaMCUxIzAhBgNVBAMMGmhhcmJvci52cmFjay52c3BoZXJlLmxvY2FsMIIB\nIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAsT/VwtwC45Z/OJeuTmuN6PXZ\njkQ/pz/RFZv7K0z/SWUW7QX5EFqpg7Vns7Ie3pbUs2jDH7W1Dn4NbDSChUmImD4i\nUXLHhhp7QCNaemqwersdfasnYO6VIcG6uF9oTOcGKPV2D/JE45H4hdEPwF50U8Ze\nZACyToSJbc1gzElZX+zlGiq+D+6AOjhlULAJrkNzyCwvq3CSPi/eS/OCN7cGVt0+\nyxonIH7mJM/sNU2W3MnmHQOESxOe8I99aOUtYNuhHTiP5HWFfCbIfqGcWlMgBLiG\nEsFLrKql6Ci8HOrW4vOzwho3Q4eRjGhNWBHddmGL2vbpfHsESDBmqoOYaXc6eQID\nAQABo4G+MIG7MAkGA1UdEwQCMAAwHQYDVR0OBBYEFJVT9cvazVOlO5DS6ryMwubg\nJLruMEYGA1UdIwQ/MD2AFLRwFacXernqj0VPJ4TgtLdhFG++oRqkGDAWMRQwEgYD\nVQQDDAtFYXN5LVJTQSBDQYIJAMFqmuO1XQb9MBMGA1UdJQQMMAoGCCsGAQUFBwMB\nMAsGA1UdDwQEAwIFoDAlBgNVHREEHjAcghpoYXJib3IudnJhY2sudnNwaGVyZS5s\nb2NhbDANBgkqhkiG9w0BAQsFAAOCAQEAXJgFwsjBU4apGKJvex4ro4vO0iMiGx4r\nlL4JkozNp4JJGGfPWY3cAmeykAX3mUfPNRosp6KqwHKUvP+bU0hsLDd+mrCRsA/J\ndsyyhfJqbtB0Ez3bQdelAacKS8aaCt3cmXU+hrPGTOkCoOeeeiR6uZFuuywG8dld\ntUD9jFd6CkizVVqsyk/lmZ0mEapW+4+D6VhPzrMFlqwW3h+1WM6CmMRPOJc42wQI\nG1GEpi9Sghs7V/VkrO78dWBWe6mcfYv3OsxR5iyGiNtIfM99EnIknf01HO3kUlP8\nvgS2QcTyDdpj1VI2oUL2wM77SXGfUynnmL1fCEdU++qO/bb2tsTiXA==\n-----END CERTIFICATE-----",
          "privateKey" : "-----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKCAQEAsT/VwtwC45Z/OJeuTmuN6PXZjkQ/pz/RFZv7K0z/SWUW7QX5\nEFqpg7Vns7Ie3pbUs2jDH7W1Dn4NbDSChUmImD4iUXLHhhp7QCNaemu03y3Npwfn\nYO6VIcG6uF9oTOcGKPV2D/JE45H4hdEPwF50U8ZeZACyToSJbc1gzElZX+zlGiq+\nD+6AOjhlULAJrkNzyCwvq3CSPi/eS/OCN7cGVt0+yxonIH7mJM/sNU2W3MnmHQOE\nSxOe8I99aOUtYNuhHTiP5HWFfCbIfqGcWlMgBLiGEsFLrKql6Ci8HOrW4vOzwho3\nQ4eRjGhNWBHddmGL2vbpfHsESDBmqoOYaXc6eQIDAQABAoIBAAXAq6BiYZmfVcux\naI/U/8sSx5fNcT9tW8zWviUen55zMHZK3lWAi8XhilcTrdrNjGOyP7r0u8aXornj\nTmUjCNLgGV8JWZ5pl5xySUp12m3v35/PKtxDggWRcwzu08TDLrj/lnBYDZJRN36o\nVVmJ9z6Mzp1yRFc2B/vPUZfvvX3WdZLwYSQeV4JLlfhiyCE1cYdc6y4RLfpOHQiw\nnhyoHYf1Uumy8g7co41sdcsergCBiNQe98Mola+x9f5srP9eu/YCnx1twBRM66iG\noq8lwykAN4xMSGZDFxCkaFC59lA7ek46uaMjeYcCU09OxvGGJdoRpEMCPDCg3lFC\n2SS95YECgYEA4jUWjHcyuhWfk6CYchGzA+D06FE0aAi47m3XU1Wx1SfZXVNoKymk\n9ebyu0V4UadYnZK6mGgFOpay6md32V41cFwJIOcwX9CVzDW74+w6PkqHo6HRbhNi\n3HDkKc2H1nPEQKqrrBneHajV8KyK+1lJoh1IHqn9V14q1TP90gc5wmkCgYEAyJgO\nSV4PtTdcfPWwQ3ujPpR6Av3B4F8Y5akx3w2P8QY7Qraovvdehblhc5MO2iNkXWdJ\nDks+buil2V5DJv2/L1dSM6WqjBaQY39iQ9R3r6/qSgG/RxYnAqr28jgBBqtjnrI1\nJjMJTBzhKFvXAtCJAPGeJKae/ZHpxa61oOGxlZECgYAg/YkaV1AIn5q0VxmkmTw4\ndpiBQUaZXZxK+a4Ls1XKNpOW7tEkamBqlJIWCd2wWu2rnXilPZZ1owDY+toZ04mL\np4CVUeJWNv+B1txeM1eTOh9qF/GJUj560+QSzKzg8+VNYRbEdMlWHgeFoERsv+rj\nP84C2tvd4BfzHDAKb49W8QKBgDOwuz28t1+DPJoW1a0OFyrxJ9/NdEBVQR0tVGSe\nIhGCAZNXbnSHWhwrgSk/I/yiUiKfkvvT9+qsmNBCshtCGBoi7lPQxPoEdoCtOq0v\n+weS1VTszlWLJ9JQLAKO2/TUBX/HfFqznBm492xm/ikDg8pyeMYJCb9d8le2hadH\ngXOBAoGBAN+Q14/0v64qQCmUlqq14IKEGyt9OUCMSGF/PRcRreaO/okM/0E0+uCf\n9eEoUyDvvvyM3xyqltf428mbaBEpBzF/IUDrSlHieyTSdSzJm6E83HJzVcWHQ4Nu\n5Ct0EQnyYqrmw0C3hpoBz9sgsF4oFRX4h8b4ammWXnI+OEUKPIsp\n-----END RSA PRIVATE KEY-----"
        },
        "harborRsaCert" : {
          "publicCert" : "-----BEGIN CERTIFICATE-----\nMIIDhDCCAmygAwIBAgIQQ/1NNsYBUlTDTSEBUXrT3TANBgkqhkiG9w0BAQsFADAW\nMRQwEgYDVQQDDAtFYXN5LVJTQSBDQTAeFw0xOTA0MDYxMTA0NDVaFw0yMjAzMjEx\nMTA0NDVaMCUxIzAhBgNVBAMMGmhhcmJvci52cmFjay52c3BoZXJlLmxvY2FsMIIB\nIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAsT/VwtwC45Z/OJeuTmuN6PXZ\njkQ/pz/RFZv7K0z/SWUW7QX5EFqpg7Vns7Ie3pbUs2jDH7W1Dn4NbDSChUmImD4i\nUXLHhhp7QCNaemqwersdfasnYO6VIcG6uF9oTOcGKPV2D/JE45H4hdEPwF50U8Ze\nZACyToSJbc1gzElZX+zlGiq+D+6AOjhlULAJrkNzyCwvq3CSPi/eS/OCN7cGVt0+\nyxonIH7mJM/sNU2W3MnmHQOESxOe8I99aOUtYNuhHTiP5HWFfCbIfqGcWlMgBLiG\nEsFLrKql6Ci8HOrW4vOzwho3Q4eRjGhNWBHddmGL2vbpfHsESDBmqoOYaXc6eQID\nAQABo4G+MIG7MAkGA1UdEwQCMAAwHQYDVR0OBBYEFJVT9cvazVOlO5DS6ryMwubg\nJLruMEYGA1UdIwQ/MD2AFLRwFacXernqj0VPJ4TgtLdhFG++oRqkGDAWMRQwEgYD\nVQQDDAtFYXN5LVJTQSBDQYIJAMFqmuO1XQb9MBMGA1UdJQQMMAoGCCsGAQUFBwMB\nMAsGA1UdDwQEAwIFoDAlBgNVHREEHjAcghpoYXJib3IudnJhY2sudnNwaGVyZS5s\nb2NhbDANBgkqhkiG9w0BAQsFAAOCAQEAXJgFwsjBU4apGKJvex4ro4vO0iMiGx4r\nlL4JkozNp4JJGGfPWY3cAmeykAX3mUfPNRosp6KqwHKUvP+bU0hsLDd+mrCRsA/J\ndsyyhfJqbtB0Ez3bQdelAacKS8aaCt3cmXU+hrPGTOkCoOeeeiR6uZFuuywG8dld\ntUD9jFd6CkizVVqsyk/lmZ0mEapW+4+D6VhPzrMFlqwW3h+1WM6CmMRPOJc42wQI\nG1GEpi9Sghs7V/VkrO78dWBWe6mcfYv3OsxR5iyGiNtIfM99EnIknf01HO3kUlP8\nvgS2QcTyDdpj1VI2oUL2wM77SXGfUynnmL1fCEdU++qO/bb2tsTiXA==\n-----END CERTIFICATE-----",
          "privateKey" : "-----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKCAQEAsT/VwtwC45Z/OJeuTmuN6PXZjkQ/pz/RFZv7K0z/SWUW7QX5\nEFqpg7Vns7Ie3pbUs2jDH7W1Dn4NbDSChUmImD4iUXLHhhp7QCNaemu03y3Npwfn\nYO6VIcG6uF9oTOcGKPV2D/JE45H4hdEPwF50U8ZeZACyToSJbc1gzElZX+zlGiq+\nD+6AOjhlULAJrkNzyCwvq3CSPi/eS/OCN7cGVt0+yxonIH7mJM/sNU2W3MnmHQOE\nSxOe8I99aOUtYNuhHTiP5HWFfCbIfqGcWlMgBLiGEsFLrKql6Ci8HOrW4vOzwho3\nQ4eRjGhNWBHddmGL2vbpfHsESDBmqoOYaXc6eQIDAQABAoIBAAXAq6BiYZmfVcux\naI/U/8sSx5fNcT9tW8zWviUen55zMHZK3lWAi8XhilcTrdrNjGOyP7r0u8aXornj\nTmUjCNLgGV8JWZ5pl5xySUp12m3v35/PKtxDggWRcwzu08TDLrj/lnBYDZJRN36o\nVVmJ9z6Mzp1yRFc2B/vPUZfvvX3WdZLwYSQeV4JLlfhiyCE1cYdc6y4RLfpOHQiw\nnhyoHYf1Uumy8g7co41sdcsergCBiNQe98Mola+x9f5srP9eu/YCnx1twBRM66iG\noq8lwykAN4xMSGZDFxCkaFC59lA7ek46uaMjeYcCU09OxvGGJdoRpEMCPDCg3lFC\n2SS95YECgYEA4jUWjHcyuhWfk6CYchGzA+D06FE0aAi47m3XU1Wx1SfZXVNoKymk\n9ebyu0V4UadYnZK6mGgFOpay6md32V41cFwJIOcwX9CVzDW74+w6PkqHo6HRbhNi\n3HDkKc2H1nPEQKqrrBneHajV8KyK+1lJoh1IHqn9V14q1TP90gc5wmkCgYEAyJgO\nSV4PtTdcfPWwQ3ujPpR6Av3B4F8Y5akx3w2P8QY7Qraovvdehblhc5MO2iNkXWdJ\nDks+buil2V5DJv2/L1dSM6WqjBaQY39iQ9R3r6/qSgG/RxYnAqr28jgBBqtjnrI1\nJjMJTBzhKFvXAtCJAPGeJKae/ZHpxa61oOGxlZECgYAg/YkaV1AIn5q0VxmkmTw4\ndpiBQUaZXZxK+a4Ls1XKNpOW7tEkamBqlJIWCd2wWu2rnXilPZZ1owDY+toZ04mL\np4CVUeJWNv+B1txeM1eTOh9qF/GJUj560+QSzKzg8+VNYRbEdMlWHgeFoERsv+rj\nP84C2tvd4BfzHDAKb49W8QKBgDOwuz28t1+DPJoW1a0OFyrxJ9/NdEBVQR0tVGSe\nIhGCAZNXbnSHWhwrgSk/I/yiUiKfkvvT9+qsmNBCshtCGBoi7lPQxPoEdoCtOq0v\n+weS1VTszlWLJ9JQLAKO2/TUBX/HfFqznBm492xm/ikDg8pyeMYJCb9d8le2hadH\ngXOBAoGBAN+Q14/0v64qQCmUlqq14IKEGyt9OUCMSGF/PRcRreaO/okM/0E0+uCf\n9eEoUyDvvvyM3xyqltf428mbaBEpBzF/IUDrSlHieyTSdSzJm6E83HJzVcWHQ4Nu\n5Ct0EQnyYqrmw0C3hpoBz9sgsF4oFRX4h8b4ammWXnI+OEUKPIsp\n-----END RSA PRIVATE KEY-----"
        }
      },
      "datastore" : "datastore"
    },
    "info" : {
      "id" : "53841912-fc90-49b9-a600-04ac48f54600",
      "name" : "PKS-1",
      "status" : "ACTIVE",
      "domainId" : "76df11e9-5c1f-4376-b913-0ea93ebda983"
    },
    "summary" : {
      "managementZonesCount" : 1,
      "kubernetesZonesCount" : 2,
      "opsManagerUrl" : "https://pcf.sfo01.rainpole.local",
      "harborRegistryUrl" : "https://harbor.sfo01.rainpole.local",
      "pksApiFqdn" : "pksApi.sfo01.rainpole.local",
      "wldName" : "PKS-WLD"
    },
    "serviceVms" : [ {
      "name" : "Pivotal Ops Manager",
      "url" : "https://pcf.sfo01.rainpole.local",
      "ip" : "10.255.0.10"
    }, {
      "name" : "Harbor Registry",
      "url" : "https://harbor.sfo01.rainpole.local",
      "ip" : "10.255.0.12"
    }, {
      "name" : "PKS API",
      "url" : "pksApi.sfo01.rainpole.local",
      "ip" : "10.255.0.11"
    }, {
      "name" : "vCenter Server",
      "url" : "https://vcenter-1.sfo01.rainpole.local",
      "ip" : "172.16.11.60"
    }, {
      "name" : "NSX Manager",
      "url" : "https://vip-nsxmanager.sfo01.rainpole.local",
      "ip" : "172.16.11.61"
    } ]
  } ]
}
Related APIs

Install PKS
Validate PKS specification before installation
Get validation results
Get a list of installed PKS
Get PKS details
Initialize PKS deletion
Delete PKS

2.9.5. Get a Pivotal Container Service

Prerequisites

  1. None

Steps

  1. Invoke the API

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/pkses/76df11e9-5c1f-4376-b913-0ea93ebda983' -i -u 'admin:VMwareInfra@1' -X GET \
    -H 'Content-Type: application/json'

HTTP Request

GET /v1/pkses/76df11e9-5c1f-4376-b913-0ea93ebda983 HTTP/1.1
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==
Content-Type: application/json

HTTP Response

HTTP/1.1 200 OK
Content-Length: 16717
Content-Type: application/json;charset=UTF-8

{
  "inputSpec" : {
    "domainId" : "76df11e9-5c1f-4376-b913-0ea93ebda983",
    "name" : "PKS-1",
    "pksApiHostname" : "pksApi.sfo01.rainpole.local",
    "adminPassword" : "SecurePassword123!",
    "decryptionPassphrase" : "SecurePassword123!",
    "harborHostname" : "harbor.sfo01.rainpole.local",
    "installHarbor" : true,
    "nsxtItemsSpec" : {
      "t0routerId" : "bc3fda31-74b9-4759-8e1f-ff72726b8d5d",
      "nodesIpBlockId" : "b73446a0-9ffe-4291-b34f-ff0b6ee67ff3",
      "floatingIpPoolId" : "ee7d0bc1-0cd3-4c59-8944-65a36fe35cf7",
      "podsIpBlockId" : "6f5db6d2-30f6-47e3-a765-3ebc34390bce"
    },
    "pksOpsManagerVmSpec" : {
      "network" : {
        "network" : "network",
        "dnsServers" : [ "172.16.11.4", "172.16.11.5" ],
        "ntpServers" : [ "172.16.11.251", "172.16.11.252" ],
        "dnsSuffix" : "*.sfo01.rainpole.local",
        "gateway" : "10.255.0.1",
        "netmask" : "255.255.255.0"
      },
      "appliance" : {
        "ip" : "10.255.0.10",
        "hostname" : "pcf.sfo01.rainpole.local",
        "vmName" : "ops-manager"
      }
    },
    "availabilityZoneSpec" : {
      "managementNetwork" : {
        "vcenterNetwork" : "VcenterNetwork",
        "cidr" : "10.255.0.0/24",
        "gateway" : "10.255.0.1",
        "reservedRanges" : "10.255.0.1-10.255.0.10",
        "dnsServer" : "172.16.11.4"
      },
      "kubernetesNetwork" : {
        "vcenterNetwork" : "VcenterNetwork",
        "cidr" : "10.255.1.0/24",
        "gateway" : "10.255.1.1",
        "reservedRanges" : "10.255.1.1-10.255.1.10",
        "dnsServer" : "172.16.11.4"
      },
      "managementZone" : {
        "name" : "AZ1",
        "resourcePoolName" : "AZ1_Resource_Pool",
        "clusterName" : "pks-cluster"
      },
      "kubernetesZones" : [ {
        "name" : "AZ2",
        "resourcePoolName" : "AZ2_Resource_Pool",
        "clusterName" : "pks-cluster"
      }, {
        "name" : "AZ3",
        "resourcePoolName" : "AZ3_Resource_Pool",
        "clusterName" : "pks-cluster"
      } ]
    },
    "certificateBundle" : {
      "trustedCertificates" : "-----BEGIN CERTIFICATE-----\nMIIDNTCCAh2gAwIBAgIJAMFqmuO1XQb9MA0GCSqGSIb3DQEBCwUAMBYxFDASBgNV\nBAMMC0Vhc3ktUlNBIENBMB4XDTE5MDQwNjExMDQ0NVoXDTI5MDQwMzExMDQ0NVow\nFjEUMBIGA1UEAwwLRWFzeS1SU0EgQ0EwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAw\nggEKAoIBAQC2Mw1Zu/Uj2d1CrQUPG96rJS116tbTRtaIlRjWW2W+6Ng6S/wRxMKS\nQKQbx2MBYYJYC76PRAu1r1AkZMh7QhN/ohzJNrXa+C1UAkKg0zD6xqbxbSIsyYCV\n3WDyL2jRjPjbelveKV7AvP+rbratF3fH8PtnMa9Jp5/fkWI76T8GipF4dYW1vAxy\nApD464PWKvkz4Y2Ey20gr15W/L4gNFgXdaENW7aY9T9N8JuFpIbBK6QS1vV+w4XJ\nqlEilT2l0MYUA78zAOl4e8XI4awGmc0lHU60+87/Za7ODZbp93EtXkRTjR23Ybvh\nqvYmbc4bZu+u5wHz8Zf5Q9S5bzciUlQ5AgMBAAGjgYUwgYIwHQYDVR0OBBYEFLRw\nFacXernqj0VPJ4TgtLdhFG++MEYGA1UdIwQ/MD2AFLRwFacXernqj0VPJ4TgtLdh\nFG++oRqkGDAWMxcvaswweewWhjhHVDklhlsfgsBDQYIJAMFqmuO1XQb9MAwGA1Ud\nEwQFMAMBAf8wCwYDVR0PBAQDAgEGMA0GCSqGSIb3DQEBCwUAA4IBAQARdK+wt2xr\nPiEX25Fmdw5CGlom2WDL5fqB7f05EgkMCzAWHZeVjIoHF2aPmEZTuCymk8neLyw6\nY5P0maW8VHhNwD93uovZnn1qccERjaOWSuxE/lJUWnrt7n4lJhWs4WBCc1SFeuvj\nL/AJyRv/DnGDUw7eXPQYR2vPa1yHZt8jr4nA5gbINAenJ0rX48mDB3jaroXyOUWE\nLfqtuLlxmWDE9iF4Aqu1vwYltEvbQ3k2tgDy6gTQbNl7/9UKMvl3bHI6xwjONvut\nfSJHetpy1h3sN5/XkOBnoNXiuoiDxo83+yDeIfCdDnCMcu13ByvZ9xSM4rBPSQNk\nfnIFWgyCUH8F\n-----END CERTIFICATE-----",
      "pcfRsaCert" : {
        "publicCert" : "-----BEGIN CERTIFICATE-----\nMIIDhDCCAmygAwIBAgIQQ/1NNsYBUlTDTSEBUXrT3TANBgkqhkiG9w0BAQsFADAW\nMRQwEgYDVQQDDAtFYXN5LVJTQSBDQTAeFw0xOTA0MDYxMTA0NDVaFw0yMjAzMjEx\nMTA0NDVaMCUxIzAhBgNVBAMMGmhhcmJvci52cmFjay52c3BoZXJlLmxvY2FsMIIB\nIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAsT/VwtwC45Z/OJeuTmuN6PXZ\njkQ/pz/RFZv7K0z/SWUW7QX5EFqpg7Vns7Ie3pbUs2jDH7W1Dn4NbDSChUmImD4i\nUXLHhhp7QCNaemqwersdfasnYO6VIcG6uF9oTOcGKPV2D/JE45H4hdEPwF50U8Ze\nZACyToSJbc1gzElZX+zlGiq+D+6AOjhlULAJrkNzyCwvq3CSPi/eS/OCN7cGVt0+\nyxonIH7mJM/sNU2W3MnmHQOESxOe8I99aOUtYNuhHTiP5HWFfCbIfqGcWlMgBLiG\nEsFLrKql6Ci8HOrW4vOzwho3Q4eRjGhNWBHddmGL2vbpfHsESDBmqoOYaXc6eQID\nAQABo4G+MIG7MAkGA1UdEwQCMAAwHQYDVR0OBBYEFJVT9cvazVOlO5DS6ryMwubg\nJLruMEYGA1UdIwQ/MD2AFLRwFacXernqj0VPJ4TgtLdhFG++oRqkGDAWMRQwEgYD\nVQQDDAtFYXN5LVJTQSBDQYIJAMFqmuO1XQb9MBMGA1UdJQQMMAoGCCsGAQUFBwMB\nMAsGA1UdDwQEAwIFoDAlBgNVHREEHjAcghpoYXJib3IudnJhY2sudnNwaGVyZS5s\nb2NhbDANBgkqhkiG9w0BAQsFAAOCAQEAXJgFwsjBU4apGKJvex4ro4vO0iMiGx4r\nlL4JkozNp4JJGGfPWY3cAmeykAX3mUfPNRosp6KqwHKUvP+bU0hsLDd+mrCRsA/J\ndsyyhfJqbtB0Ez3bQdelAacKS8aaCt3cmXU+hrPGTOkCoOeeeiR6uZFuuywG8dld\ntUD9jFd6CkizVVqsyk/lmZ0mEapW+4+D6VhPzrMFlqwW3h+1WM6CmMRPOJc42wQI\nG1GEpi9Sghs7V/VkrO78dWBWe6mcfYv3OsxR5iyGiNtIfM99EnIknf01HO3kUlP8\nvgS2QcTyDdpj1VI2oUL2wM77SXGfUynnmL1fCEdU++qO/bb2tsTiXA==\n-----END CERTIFICATE-----",
        "privateKey" : "-----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKCAQEAsT/VwtwC45Z/OJeuTmuN6PXZjkQ/pz/RFZv7K0z/SWUW7QX5\nEFqpg7Vns7Ie3pbUs2jDH7W1Dn4NbDSChUmImD4iUXLHhhp7QCNaemu03y3Npwfn\nYO6VIcG6uF9oTOcGKPV2D/JE45H4hdEPwF50U8ZeZACyToSJbc1gzElZX+zlGiq+\nD+6AOjhlULAJrkNzyCwvq3CSPi/eS/OCN7cGVt0+yxonIH7mJM/sNU2W3MnmHQOE\nSxOe8I99aOUtYNuhHTiP5HWFfCbIfqGcWlMgBLiGEsFLrKql6Ci8HOrW4vOzwho3\nQ4eRjGhNWBHddmGL2vbpfHsESDBmqoOYaXc6eQIDAQABAoIBAAXAq6BiYZmfVcux\naI/U/8sSx5fNcT9tW8zWviUen55zMHZK3lWAi8XhilcTrdrNjGOyP7r0u8aXornj\nTmUjCNLgGV8JWZ5pl5xySUp12m3v35/PKtxDggWRcwzu08TDLrj/lnBYDZJRN36o\nVVmJ9z6Mzp1yRFc2B/vPUZfvvX3WdZLwYSQeV4JLlfhiyCE1cYdc6y4RLfpOHQiw\nnhyoHYf1Uumy8g7co41sdcsergCBiNQe98Mola+x9f5srP9eu/YCnx1twBRM66iG\noq8lwykAN4xMSGZDFxCkaFC59lA7ek46uaMjeYcCU09OxvGGJdoRpEMCPDCg3lFC\n2SS95YECgYEA4jUWjHcyuhWfk6CYchGzA+D06FE0aAi47m3XU1Wx1SfZXVNoKymk\n9ebyu0V4UadYnZK6mGgFOpay6md32V41cFwJIOcwX9CVzDW74+w6PkqHo6HRbhNi\n3HDkKc2H1nPEQKqrrBneHajV8KyK+1lJoh1IHqn9V14q1TP90gc5wmkCgYEAyJgO\nSV4PtTdcfPWwQ3ujPpR6Av3B4F8Y5akx3w2P8QY7Qraovvdehblhc5MO2iNkXWdJ\nDks+buil2V5DJv2/L1dSM6WqjBaQY39iQ9R3r6/qSgG/RxYnAqr28jgBBqtjnrI1\nJjMJTBzhKFvXAtCJAPGeJKae/ZHpxa61oOGxlZECgYAg/YkaV1AIn5q0VxmkmTw4\ndpiBQUaZXZxK+a4Ls1XKNpOW7tEkamBqlJIWCd2wWu2rnXilPZZ1owDY+toZ04mL\np4CVUeJWNv+B1txeM1eTOh9qF/GJUj560+QSzKzg8+VNYRbEdMlWHgeFoERsv+rj\nP84C2tvd4BfzHDAKb49W8QKBgDOwuz28t1+DPJoW1a0OFyrxJ9/NdEBVQR0tVGSe\nIhGCAZNXbnSHWhwrgSk/I/yiUiKfkvvT9+qsmNBCshtCGBoi7lPQxPoEdoCtOq0v\n+weS1VTszlWLJ9JQLAKO2/TUBX/HfFqznBm492xm/ikDg8pyeMYJCb9d8le2hadH\ngXOBAoGBAN+Q14/0v64qQCmUlqq14IKEGyt9OUCMSGF/PRcRreaO/okM/0E0+uCf\n9eEoUyDvvvyM3xyqltf428mbaBEpBzF/IUDrSlHieyTSdSzJm6E83HJzVcWHQ4Nu\n5Ct0EQnyYqrmw0C3hpoBz9sgsF4oFRX4h8b4ammWXnI+OEUKPIsp\n-----END RSA PRIVATE KEY-----"
      },
      "pksRsaCert" : {
        "publicCert" : "-----BEGIN CERTIFICATE-----\nMIIDhDCCAmygAwIBAgIQQ/1NNsYBUlTDTSEBUXrT3TANBgkqhkiG9w0BAQsFADAW\nMRQwEgYDVQQDDAtFYXN5LVJTQSBDQTAeFw0xOTA0MDYxMTA0NDVaFw0yMjAzMjEx\nMTA0NDVaMCUxIzAhBgNVBAMMGmhhcmJvci52cmFjay52c3BoZXJlLmxvY2FsMIIB\nIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAsT/VwtwC45Z/OJeuTmuN6PXZ\njkQ/pz/RFZv7K0z/SWUW7QX5EFqpg7Vns7Ie3pbUs2jDH7W1Dn4NbDSChUmImD4i\nUXLHhhp7QCNaemqwersdfasnYO6VIcG6uF9oTOcGKPV2D/JE45H4hdEPwF50U8Ze\nZACyToSJbc1gzElZX+zlGiq+D+6AOjhlULAJrkNzyCwvq3CSPi/eS/OCN7cGVt0+\nyxonIH7mJM/sNU2W3MnmHQOESxOe8I99aOUtYNuhHTiP5HWFfCbIfqGcWlMgBLiG\nEsFLrKql6Ci8HOrW4vOzwho3Q4eRjGhNWBHddmGL2vbpfHsESDBmqoOYaXc6eQID\nAQABo4G+MIG7MAkGA1UdEwQCMAAwHQYDVR0OBBYEFJVT9cvazVOlO5DS6ryMwubg\nJLruMEYGA1UdIwQ/MD2AFLRwFacXernqj0VPJ4TgtLdhFG++oRqkGDAWMRQwEgYD\nVQQDDAtFYXN5LVJTQSBDQYIJAMFqmuO1XQb9MBMGA1UdJQQMMAoGCCsGAQUFBwMB\nMAsGA1UdDwQEAwIFoDAlBgNVHREEHjAcghpoYXJib3IudnJhY2sudnNwaGVyZS5s\nb2NhbDANBgkqhkiG9w0BAQsFAAOCAQEAXJgFwsjBU4apGKJvex4ro4vO0iMiGx4r\nlL4JkozNp4JJGGfPWY3cAmeykAX3mUfPNRosp6KqwHKUvP+bU0hsLDd+mrCRsA/J\ndsyyhfJqbtB0Ez3bQdelAacKS8aaCt3cmXU+hrPGTOkCoOeeeiR6uZFuuywG8dld\ntUD9jFd6CkizVVqsyk/lmZ0mEapW+4+D6VhPzrMFlqwW3h+1WM6CmMRPOJc42wQI\nG1GEpi9Sghs7V/VkrO78dWBWe6mcfYv3OsxR5iyGiNtIfM99EnIknf01HO3kUlP8\nvgS2QcTyDdpj1VI2oUL2wM77SXGfUynnmL1fCEdU++qO/bb2tsTiXA==\n-----END CERTIFICATE-----",
        "privateKey" : "-----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKCAQEAsT/VwtwC45Z/OJeuTmuN6PXZjkQ/pz/RFZv7K0z/SWUW7QX5\nEFqpg7Vns7Ie3pbUs2jDH7W1Dn4NbDSChUmImD4iUXLHhhp7QCNaemu03y3Npwfn\nYO6VIcG6uF9oTOcGKPV2D/JE45H4hdEPwF50U8ZeZACyToSJbc1gzElZX+zlGiq+\nD+6AOjhlULAJrkNzyCwvq3CSPi/eS/OCN7cGVt0+yxonIH7mJM/sNU2W3MnmHQOE\nSxOe8I99aOUtYNuhHTiP5HWFfCbIfqGcWlMgBLiGEsFLrKql6Ci8HOrW4vOzwho3\nQ4eRjGhNWBHddmGL2vbpfHsESDBmqoOYaXc6eQIDAQABAoIBAAXAq6BiYZmfVcux\naI/U/8sSx5fNcT9tW8zWviUen55zMHZK3lWAi8XhilcTrdrNjGOyP7r0u8aXornj\nTmUjCNLgGV8JWZ5pl5xySUp12m3v35/PKtxDggWRcwzu08TDLrj/lnBYDZJRN36o\nVVmJ9z6Mzp1yRFc2B/vPUZfvvX3WdZLwYSQeV4JLlfhiyCE1cYdc6y4RLfpOHQiw\nnhyoHYf1Uumy8g7co41sdcsergCBiNQe98Mola+x9f5srP9eu/YCnx1twBRM66iG\noq8lwykAN4xMSGZDFxCkaFC59lA7ek46uaMjeYcCU09OxvGGJdoRpEMCPDCg3lFC\n2SS95YECgYEA4jUWjHcyuhWfk6CYchGzA+D06FE0aAi47m3XU1Wx1SfZXVNoKymk\n9ebyu0V4UadYnZK6mGgFOpay6md32V41cFwJIOcwX9CVzDW74+w6PkqHo6HRbhNi\n3HDkKc2H1nPEQKqrrBneHajV8KyK+1lJoh1IHqn9V14q1TP90gc5wmkCgYEAyJgO\nSV4PtTdcfPWwQ3ujPpR6Av3B4F8Y5akx3w2P8QY7Qraovvdehblhc5MO2iNkXWdJ\nDks+buil2V5DJv2/L1dSM6WqjBaQY39iQ9R3r6/qSgG/RxYnAqr28jgBBqtjnrI1\nJjMJTBzhKFvXAtCJAPGeJKae/ZHpxa61oOGxlZECgYAg/YkaV1AIn5q0VxmkmTw4\ndpiBQUaZXZxK+a4Ls1XKNpOW7tEkamBqlJIWCd2wWu2rnXilPZZ1owDY+toZ04mL\np4CVUeJWNv+B1txeM1eTOh9qF/GJUj560+QSzKzg8+VNYRbEdMlWHgeFoERsv+rj\nP84C2tvd4BfzHDAKb49W8QKBgDOwuz28t1+DPJoW1a0OFyrxJ9/NdEBVQR0tVGSe\nIhGCAZNXbnSHWhwrgSk/I/yiUiKfkvvT9+qsmNBCshtCGBoi7lPQxPoEdoCtOq0v\n+weS1VTszlWLJ9JQLAKO2/TUBX/HfFqznBm492xm/ikDg8pyeMYJCb9d8le2hadH\ngXOBAoGBAN+Q14/0v64qQCmUlqq14IKEGyt9OUCMSGF/PRcRreaO/okM/0E0+uCf\n9eEoUyDvvvyM3xyqltf428mbaBEpBzF/IUDrSlHieyTSdSzJm6E83HJzVcWHQ4Nu\n5Ct0EQnyYqrmw0C3hpoBz9sgsF4oFRX4h8b4ammWXnI+OEUKPIsp\n-----END RSA PRIVATE KEY-----"
      },
      "nsxtRsaCert" : {
        "publicCert" : "-----BEGIN CERTIFICATE-----\nMIIDhDCCAmygAwIBAgIQQ/1NNsYBUlTDTSEBUXrT3TANBgkqhkiG9w0BAQsFADAW\nMRQwEgYDVQQDDAtFYXN5LVJTQSBDQTAeFw0xOTA0MDYxMTA0NDVaFw0yMjAzMjEx\nMTA0NDVaMCUxIzAhBgNVBAMMGmhhcmJvci52cmFjay52c3BoZXJlLmxvY2FsMIIB\nIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAsT/VwtwC45Z/OJeuTmuN6PXZ\njkQ/pz/RFZv7K0z/SWUW7QX5EFqpg7Vns7Ie3pbUs2jDH7W1Dn4NbDSChUmImD4i\nUXLHhhp7QCNaemqwersdfasnYO6VIcG6uF9oTOcGKPV2D/JE45H4hdEPwF50U8Ze\nZACyToSJbc1gzElZX+zlGiq+D+6AOjhlULAJrkNzyCwvq3CSPi/eS/OCN7cGVt0+\nyxonIH7mJM/sNU2W3MnmHQOESxOe8I99aOUtYNuhHTiP5HWFfCbIfqGcWlMgBLiG\nEsFLrKql6Ci8HOrW4vOzwho3Q4eRjGhNWBHddmGL2vbpfHsESDBmqoOYaXc6eQID\nAQABo4G+MIG7MAkGA1UdEwQCMAAwHQYDVR0OBBYEFJVT9cvazVOlO5DS6ryMwubg\nJLruMEYGA1UdIwQ/MD2AFLRwFacXernqj0VPJ4TgtLdhFG++oRqkGDAWMRQwEgYD\nVQQDDAtFYXN5LVJTQSBDQYIJAMFqmuO1XQb9MBMGA1UdJQQMMAoGCCsGAQUFBwMB\nMAsGA1UdDwQEAwIFoDAlBgNVHREEHjAcghpoYXJib3IudnJhY2sudnNwaGVyZS5s\nb2NhbDANBgkqhkiG9w0BAQsFAAOCAQEAXJgFwsjBU4apGKJvex4ro4vO0iMiGx4r\nlL4JkozNp4JJGGfPWY3cAmeykAX3mUfPNRosp6KqwHKUvP+bU0hsLDd+mrCRsA/J\ndsyyhfJqbtB0Ez3bQdelAacKS8aaCt3cmXU+hrPGTOkCoOeeeiR6uZFuuywG8dld\ntUD9jFd6CkizVVqsyk/lmZ0mEapW+4+D6VhPzrMFlqwW3h+1WM6CmMRPOJc42wQI\nG1GEpi9Sghs7V/VkrO78dWBWe6mcfYv3OsxR5iyGiNtIfM99EnIknf01HO3kUlP8\nvgS2QcTyDdpj1VI2oUL2wM77SXGfUynnmL1fCEdU++qO/bb2tsTiXA==\n-----END CERTIFICATE-----",
        "privateKey" : "-----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKCAQEAsT/VwtwC45Z/OJeuTmuN6PXZjkQ/pz/RFZv7K0z/SWUW7QX5\nEFqpg7Vns7Ie3pbUs2jDH7W1Dn4NbDSChUmImD4iUXLHhhp7QCNaemu03y3Npwfn\nYO6VIcG6uF9oTOcGKPV2D/JE45H4hdEPwF50U8ZeZACyToSJbc1gzElZX+zlGiq+\nD+6AOjhlULAJrkNzyCwvq3CSPi/eS/OCN7cGVt0+yxonIH7mJM/sNU2W3MnmHQOE\nSxOe8I99aOUtYNuhHTiP5HWFfCbIfqGcWlMgBLiGEsFLrKql6Ci8HOrW4vOzwho3\nQ4eRjGhNWBHddmGL2vbpfHsESDBmqoOYaXc6eQIDAQABAoIBAAXAq6BiYZmfVcux\naI/U/8sSx5fNcT9tW8zWviUen55zMHZK3lWAi8XhilcTrdrNjGOyP7r0u8aXornj\nTmUjCNLgGV8JWZ5pl5xySUp12m3v35/PKtxDggWRcwzu08TDLrj/lnBYDZJRN36o\nVVmJ9z6Mzp1yRFc2B/vPUZfvvX3WdZLwYSQeV4JLlfhiyCE1cYdc6y4RLfpOHQiw\nnhyoHYf1Uumy8g7co41sdcsergCBiNQe98Mola+x9f5srP9eu/YCnx1twBRM66iG\noq8lwykAN4xMSGZDFxCkaFC59lA7ek46uaMjeYcCU09OxvGGJdoRpEMCPDCg3lFC\n2SS95YECgYEA4jUWjHcyuhWfk6CYchGzA+D06FE0aAi47m3XU1Wx1SfZXVNoKymk\n9ebyu0V4UadYnZK6mGgFOpay6md32V41cFwJIOcwX9CVzDW74+w6PkqHo6HRbhNi\n3HDkKc2H1nPEQKqrrBneHajV8KyK+1lJoh1IHqn9V14q1TP90gc5wmkCgYEAyJgO\nSV4PtTdcfPWwQ3ujPpR6Av3B4F8Y5akx3w2P8QY7Qraovvdehblhc5MO2iNkXWdJ\nDks+buil2V5DJv2/L1dSM6WqjBaQY39iQ9R3r6/qSgG/RxYnAqr28jgBBqtjnrI1\nJjMJTBzhKFvXAtCJAPGeJKae/ZHpxa61oOGxlZECgYAg/YkaV1AIn5q0VxmkmTw4\ndpiBQUaZXZxK+a4Ls1XKNpOW7tEkamBqlJIWCd2wWu2rnXilPZZ1owDY+toZ04mL\np4CVUeJWNv+B1txeM1eTOh9qF/GJUj560+QSzKzg8+VNYRbEdMlWHgeFoERsv+rj\nP84C2tvd4BfzHDAKb49W8QKBgDOwuz28t1+DPJoW1a0OFyrxJ9/NdEBVQR0tVGSe\nIhGCAZNXbnSHWhwrgSk/I/yiUiKfkvvT9+qsmNBCshtCGBoi7lPQxPoEdoCtOq0v\n+weS1VTszlWLJ9JQLAKO2/TUBX/HfFqznBm492xm/ikDg8pyeMYJCb9d8le2hadH\ngXOBAoGBAN+Q14/0v64qQCmUlqq14IKEGyt9OUCMSGF/PRcRreaO/okM/0E0+uCf\n9eEoUyDvvvyM3xyqltf428mbaBEpBzF/IUDrSlHieyTSdSzJm6E83HJzVcWHQ4Nu\n5Ct0EQnyYqrmw0C3hpoBz9sgsF4oFRX4h8b4ammWXnI+OEUKPIsp\n-----END RSA PRIVATE KEY-----"
      },
      "harborRsaCert" : {
        "publicCert" : "-----BEGIN CERTIFICATE-----\nMIIDhDCCAmygAwIBAgIQQ/1NNsYBUlTDTSEBUXrT3TANBgkqhkiG9w0BAQsFADAW\nMRQwEgYDVQQDDAtFYXN5LVJTQSBDQTAeFw0xOTA0MDYxMTA0NDVaFw0yMjAzMjEx\nMTA0NDVaMCUxIzAhBgNVBAMMGmhhcmJvci52cmFjay52c3BoZXJlLmxvY2FsMIIB\nIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAsT/VwtwC45Z/OJeuTmuN6PXZ\njkQ/pz/RFZv7K0z/SWUW7QX5EFqpg7Vns7Ie3pbUs2jDH7W1Dn4NbDSChUmImD4i\nUXLHhhp7QCNaemqwersdfasnYO6VIcG6uF9oTOcGKPV2D/JE45H4hdEPwF50U8Ze\nZACyToSJbc1gzElZX+zlGiq+D+6AOjhlULAJrkNzyCwvq3CSPi/eS/OCN7cGVt0+\nyxonIH7mJM/sNU2W3MnmHQOESxOe8I99aOUtYNuhHTiP5HWFfCbIfqGcWlMgBLiG\nEsFLrKql6Ci8HOrW4vOzwho3Q4eRjGhNWBHddmGL2vbpfHsESDBmqoOYaXc6eQID\nAQABo4G+MIG7MAkGA1UdEwQCMAAwHQYDVR0OBBYEFJVT9cvazVOlO5DS6ryMwubg\nJLruMEYGA1UdIwQ/MD2AFLRwFacXernqj0VPJ4TgtLdhFG++oRqkGDAWMRQwEgYD\nVQQDDAtFYXN5LVJTQSBDQYIJAMFqmuO1XQb9MBMGA1UdJQQMMAoGCCsGAQUFBwMB\nMAsGA1UdDwQEAwIFoDAlBgNVHREEHjAcghpoYXJib3IudnJhY2sudnNwaGVyZS5s\nb2NhbDANBgkqhkiG9w0BAQsFAAOCAQEAXJgFwsjBU4apGKJvex4ro4vO0iMiGx4r\nlL4JkozNp4JJGGfPWY3cAmeykAX3mUfPNRosp6KqwHKUvP+bU0hsLDd+mrCRsA/J\ndsyyhfJqbtB0Ez3bQdelAacKS8aaCt3cmXU+hrPGTOkCoOeeeiR6uZFuuywG8dld\ntUD9jFd6CkizVVqsyk/lmZ0mEapW+4+D6VhPzrMFlqwW3h+1WM6CmMRPOJc42wQI\nG1GEpi9Sghs7V/VkrO78dWBWe6mcfYv3OsxR5iyGiNtIfM99EnIknf01HO3kUlP8\nvgS2QcTyDdpj1VI2oUL2wM77SXGfUynnmL1fCEdU++qO/bb2tsTiXA==\n-----END CERTIFICATE-----",
        "privateKey" : "-----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKCAQEAsT/VwtwC45Z/OJeuTmuN6PXZjkQ/pz/RFZv7K0z/SWUW7QX5\nEFqpg7Vns7Ie3pbUs2jDH7W1Dn4NbDSChUmImD4iUXLHhhp7QCNaemu03y3Npwfn\nYO6VIcG6uF9oTOcGKPV2D/JE45H4hdEPwF50U8ZeZACyToSJbc1gzElZX+zlGiq+\nD+6AOjhlULAJrkNzyCwvq3CSPi/eS/OCN7cGVt0+yxonIH7mJM/sNU2W3MnmHQOE\nSxOe8I99aOUtYNuhHTiP5HWFfCbIfqGcWlMgBLiGEsFLrKql6Ci8HOrW4vOzwho3\nQ4eRjGhNWBHddmGL2vbpfHsESDBmqoOYaXc6eQIDAQABAoIBAAXAq6BiYZmfVcux\naI/U/8sSx5fNcT9tW8zWviUen55zMHZK3lWAi8XhilcTrdrNjGOyP7r0u8aXornj\nTmUjCNLgGV8JWZ5pl5xySUp12m3v35/PKtxDggWRcwzu08TDLrj/lnBYDZJRN36o\nVVmJ9z6Mzp1yRFc2B/vPUZfvvX3WdZLwYSQeV4JLlfhiyCE1cYdc6y4RLfpOHQiw\nnhyoHYf1Uumy8g7co41sdcsergCBiNQe98Mola+x9f5srP9eu/YCnx1twBRM66iG\noq8lwykAN4xMSGZDFxCkaFC59lA7ek46uaMjeYcCU09OxvGGJdoRpEMCPDCg3lFC\n2SS95YECgYEA4jUWjHcyuhWfk6CYchGzA+D06FE0aAi47m3XU1Wx1SfZXVNoKymk\n9ebyu0V4UadYnZK6mGgFOpay6md32V41cFwJIOcwX9CVzDW74+w6PkqHo6HRbhNi\n3HDkKc2H1nPEQKqrrBneHajV8KyK+1lJoh1IHqn9V14q1TP90gc5wmkCgYEAyJgO\nSV4PtTdcfPWwQ3ujPpR6Av3B4F8Y5akx3w2P8QY7Qraovvdehblhc5MO2iNkXWdJ\nDks+buil2V5DJv2/L1dSM6WqjBaQY39iQ9R3r6/qSgG/RxYnAqr28jgBBqtjnrI1\nJjMJTBzhKFvXAtCJAPGeJKae/ZHpxa61oOGxlZECgYAg/YkaV1AIn5q0VxmkmTw4\ndpiBQUaZXZxK+a4Ls1XKNpOW7tEkamBqlJIWCd2wWu2rnXilPZZ1owDY+toZ04mL\np4CVUeJWNv+B1txeM1eTOh9qF/GJUj560+QSzKzg8+VNYRbEdMlWHgeFoERsv+rj\nP84C2tvd4BfzHDAKb49W8QKBgDOwuz28t1+DPJoW1a0OFyrxJ9/NdEBVQR0tVGSe\nIhGCAZNXbnSHWhwrgSk/I/yiUiKfkvvT9+qsmNBCshtCGBoi7lPQxPoEdoCtOq0v\n+weS1VTszlWLJ9JQLAKO2/TUBX/HfFqznBm492xm/ikDg8pyeMYJCb9d8le2hadH\ngXOBAoGBAN+Q14/0v64qQCmUlqq14IKEGyt9OUCMSGF/PRcRreaO/okM/0E0+uCf\n9eEoUyDvvvyM3xyqltf428mbaBEpBzF/IUDrSlHieyTSdSzJm6E83HJzVcWHQ4Nu\n5Ct0EQnyYqrmw0C3hpoBz9sgsF4oFRX4h8b4ammWXnI+OEUKPIsp\n-----END RSA PRIVATE KEY-----"
      }
    },
    "datastore" : "datastore"
  },
  "info" : {
    "id" : "53841912-fc90-49b9-a600-04ac48f54600",
    "name" : "PKS-1",
    "status" : "ACTIVE",
    "domainId" : "76df11e9-5c1f-4376-b913-0ea93ebda983"
  },
  "summary" : {
    "managementZonesCount" : 1,
    "kubernetesZonesCount" : 2,
    "opsManagerUrl" : "https://pcf.sfo01.rainpole.local",
    "harborRegistryUrl" : "https://harbor.sfo01.rainpole.local",
    "pksApiFqdn" : "pksApi.sfo01.rainpole.local",
    "wldName" : "PKS-WLD"
  },
  "serviceVms" : [ {
    "name" : "Pivotal Ops Manager",
    "url" : "https://pcf.sfo01.rainpole.local",
    "ip" : "10.255.0.10"
  }, {
    "name" : "Harbor Registry",
    "url" : "https://harbor.sfo01.rainpole.local",
    "ip" : "10.255.0.12"
  }, {
    "name" : "PKS API",
    "url" : "pksApi.sfo01.rainpole.local",
    "ip" : "10.255.0.11"
  }, {
    "name" : "vCenter Server",
    "url" : "https://vcenter-1.sfo01.rainpole.local",
    "ip" : "172.16.11.60"
  }, {
    "name" : "NSX Manager",
    "url" : "https://vip-nsxmanager.sfo01.rainpole.local",
    "ip" : "172.16.11.61"
  } ]
}
Related APIs

Install PKS
Validate PKS specification before installation
Get validation results
Get a list of installed PKS
Get PKS details
Initialize PKS deletion
Delete PKS

2.9.6. Initialize Pivotal Container Service deletion

Prerequisites

  1. PKS should be installed.

Steps

  1. Invoke the API

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/pkses/76df11e9-5c1f-4376-b913-0ea93ebda983' -i -u 'admin:VMwareInfra@1' -X PATCH \
    -H 'Content-Type: application/json' \
    -d '{
  "markForDeletion" : true
}'

HTTP Request

PATCH /v1/pkses/76df11e9-5c1f-4376-b913-0ea93ebda983 HTTP/1.1
Content-Length: 30
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==
Content-Type: application/json

{
  "markForDeletion" : true
}

HTTP Response

HTTP/1.1 200 OK
Related APIs

Install PKS
Validate PKS specification before installation
Get validation results
Get a list of installed PKS
Get PKS details
Initialize PKS deletion
Delete PKS

2.9.7. Delete Pivotal Container Service

Prerequisites

  1. PKS should be installed

  2. PKS Deletion should be initialized using Initialize Pivotal Container Service deletion

Steps

  1. Invoke the API

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/pkses/76df11e9-5c1f-4376-b913-0ea93ebda983' -i -u 'admin:VMwareInfra@1' -X DELETE \
    -H 'Content-Type: application/json'

HTTP Request

DELETE /v1/pkses/76df11e9-5c1f-4376-b913-0ea93ebda983 HTTP/1.1
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==
Content-Type: application/json

HTTP Response

HTTP/1.1 202 Accepted
Location: /v1/tasks/d39fc601-b2dc-4641-8abd-2cb169a18421
Content-Type: application/json;charset=UTF-8
Content-Length: 79

{
  "id" : "d39fc601-b2dc-4641-8abd-2cb169a18421",
  "status" : "IN_PROGRESS"
}
Related APIs

Install PKS
Validate PKS specification before installation
Get validation results
Get a list of installed PKS
Get PKS details
Initialize PKS deletion
Delete PKS

2.10. Horizon Suites

2.10.1. Create Horizon Suite

Create Horizon Suite workflow automatically deploys and configures VMware Horizon View, including the following Horizon Suite infrastructure:

  • Connection servers

  • Composer servers (optional)

  • Unified Access Gateway (optional)

  • User Environment Manager (optional)

  • App Volumes (optional)

  • Load balancers for Connection servers, Unified Access Gateway (optional) and App Volumes (optional)

Prerequisites
Infrastructure requirements:

  1. Pre-created VI Workload Domains, which are then associated with the Horizon Suite domain. These VI domains wil be used to place the end user desktops.

  2. Networks and IP addresses:

    1. Horizon management network - a network dedicated to the Horizon components

    2. DMZ network - intermediate network between the corporate network and the internet

    3. Interconnect network - optional network for high security environments, routable to the Horizon management network, when not used, Horizon management network will be used to connect Unified Access Gateway

    4. External IP addresses must be available for all VMs and all used load balancers, mentioned above

    5. VXLAN Port Groups for Horizon VMs in the Horizon management network, Incoming interface (DMZ network) and Outgoing interface (Interconnect network)

    6. DNS Records for all user load balancers (DNS names assigned to the entry points for load balancers should be resolvable to their respective IP addresses)

  3. Custom Windows Image (in OVA format) with administrator user account enabled for use with the Windows server components

  4. Microsoft Active Directory with pre-created:

    1. Organizational Unit (OU) for Horizon servers computer accounts

    2. Security group that will be configured as administrators for the Horizon Suite (optionally, separate group for the App Volumes can be used)

    3. User accounts:

      1. Composer Servers account (dedicated account for each Composer Server can also be used), optional (if Composer servers are not used)

      2. account with read-write permissions for the Organizational Unit (used for joining the servers).

      3. Horizon administrator account for logging in to Horizon and App Volumes (must be a member of both the Horizon and App Volumes groups)

  5. SQL servers (single or multiple) and user account for it with create database permissions (multiple accounts per server can be used or single one for all)

Additional prerequisites:

  1. Horizon 7 License key

  2. Horizon 7 Install Bundle (pre-downloaded and installed)

Steps

  1. Prepare your Horizon configuration spec with its required and optional sections and save it into a file.

Tip
 Refer to Horizon
Note
 Regarding the HorizonInstallDetails section, all images path should match the one from the actual installed bundle. In case of manual images upload (no bundle), it is user’s responsibility to ensure all paths are correct.
Tip
 Refer to HorizonInstallDetails

  1. Validate your Horizon configuration spec (be sure to use PRE_VALIDATION_CREATION as HorizonValidationOperation):

Tip
 Refer to Validate Horizon Suite Configuration Spec

  1. Start Horizon Suite deployment workflow, using the validated configuration spec from previous step.

Tip
 Refer to Deploy Horizon Suite

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/horizons' -i -u 'admin:VMwareInfra@1' -X POST \
    -H 'Accept: application/json;charset=UTF-8' \
    -H 'Content-Type: application/json' \
    -d '{
  "name" : "Horizon Suite Deployment 1",
  "managementVcenters" : [ {
    "clusterName" : "SDDC-Cluster1",
    "datacenterName" : "SDDC-Datacenter",
    "datastoreName" : "sfo01-m01-vsan",
    "dmzPortgroup" : "Horizon-DPortGroup-DMZ",
    "interconnectPortgroup" : "Horizon-DPortGroup-Mgmt",
    "managementPortgroup" : "Horizon-DPortGroup-Mgmt",
    "uagManagementPortgroup" : "Horizon-DPortGroup-Mgmt",
    "nsx" : {
      "host" : "nsxManager.vrack.vsphere.local",
      "password" : "x$7G$7o49x#fs0y"
    },
    "username" : "[email protected]",
    "password" : "d9X!A0F76L942#$",
    "host" : "vcenter-1.vrack.vsphere.local",
    "psc" : {
      "host" : "psc-2.vrack.vsphere.local"
    }
  } ],
  "resourceVcenters" : [ {
    "state" : "NEW",
    "datacenters" : [ {
      "name" : "new-vi-DC",
      "datastores" : [ {
        "name" : "local-0",
        "id" : "local-0",
        "hostIds" : [ "esxi-1" ]
      } ],
      "clusters" : [ {
        "name" : "via-cluster1",
        "hosts" : [ {
          "fqdn" : "esxi-1.vrack.vsphere.local",
          "id" : "esxi-1",
          "username" : "root",
          "password" : "Password!1234"
        } ]
      } ]
    } ],
    "username" : "[email protected]",
    "password" : "x7P#!!G72K820_#",
    "host" : "vcenter-2.vrack.vsphere.local",
    "psc" : {
      "host" : "psc-2.vrack.vsphere.local"
    }
  } ],
  "peripheralServices" : {
    "loadBalancers" : [ {
      "ipAddress" : "10.0.240.30",
      "fqdn" : "vipcs.horizon-1.local",
      "state" : "NEW",
      "deployDetails" : {
        "vmName" : "vipcs",
        "subnetMask" : "255.255.0.0",
        "gateway" : "10.0.0.250",
        "portgroup" : "Horizon-DPortGroup-Mgmt",
        "cliPassword" : "Password123456789!"
      }
    }, {
      "ipAddress" : "10.0.240.31",
      "fqdn" : "vipav.horizon-1.local",
      "state" : "NEW",
      "deployDetails" : {
        "vmName" : "vipav",
        "subnetMask" : "255.255.0.0",
        "gateway" : "10.0.0.250",
        "portgroup" : "Horizon-DPortGroup-Mgmt",
        "cliPassword" : "Password123456789!"
      }
    }, {
      "ipAddress" : "10.0.240.32",
      "fqdn" : "vipdmz.horizon-1.local",
      "state" : "NEW",
      "deployDetails" : {
        "vmName" : "vipdmz",
        "subnetMask" : "255.255.0.0",
        "gateway" : "10.0.0.250",
        "portgroup" : "Horizon-DPortGroup-DMZ",
        "cliPassword" : "Password123456789!"
      }
    } ],
    "activeDirectory" : {
      "fqdn" : "horizon-1.local",
      "netBiosName" : "horizon-1",
      "vdiAdminUsername" : "horizon-1.local\\vdiadmin",
      "vdiAdminPassword" : "Password123!",
      "vdiServerOu" : "OU=vdi,DC=horizon-1,DC=local",
      "ouRwUsername" : "horizon-1.local\\rwadmin",
      "ouRwPassword" : "Password123!",
      "adminUsername" : "horizon-1.local\\administrator",
      "adminPassword" : "Password1!",
      "securedAD" : false,
      "domainControllers" : [ {
        "ipAddress" : "10.0.240.81"
      } ]
    },
    "installDetails" : {
      "imagePath" : "/home/vcf/download/template_new_vmware_tools.ova",
      "connectionServerBinaryPath" : "/nfs/vmware/vcf/nfs-mount/bundle/cd0661c8-f626-41ca-a07b-3e168e386e04/bundle-16029/horizon_install/VMware-Horizon-Connection-Server-x86_64-7.9.0-13956742.exe",
      "composerServerBinaryPath" : "/nfs/vmware/vcf/nfs-mount/bundle/cd0661c8-f626-41ca-a07b-3e168e386e04/bundle-16029/horizon_install/VMware-viewcomposer-7.9.0-13810618.exe",
      "appVolumesServerBinaryPath" : "/nfs/vmware/vcf/nfs-mount/bundle/cd0661c8-f626-41ca-a07b-3e168e386e04/bundle-16029/horizon_install/AppVolumesManager.msi",
      "uagOvaPath" : "/nfs/vmware/vcf/nfs-mount/bundle/cd0661c8-f626-41ca-a07b-3e168e386e04/bundle-16029/horizon_install/euc-unified-access-gateway-3.6.0.0-14019369_OVF10.ova",
      "sqlExpressPath" : "/nfs/vmware/vcf/nfs-mount/bundle/cd0661c8-f626-41ca-a07b-3e168e386e04/bundle-16029/horizon_install/SQLEXPR_x64_ENU.exe",
      "uemBinaryPath" : "/nfs/vmware/vcf/nfs-mount/bundle/cd0661c8-f626-41ca-a07b-3e168e386e04/bundle-16029/horizon_install/VMware User Environment Manager 9.8.0.895 x64.msi",
      "connectionServerVersion" : "7.9.0-13956742",
      "composerServerVersion" : "7.9.0-13810618",
      "appVolumesServerVersion" : "2.17.0",
      "uagOvaVersion" : "3.6.0.0-14019369",
      "sqlExpressVersion" : "2017",
      "uemVersion" : "9.8.0.895",
      "ova" : {
        "administratorUsername" : "administrator",
        "administratorPassword" : "Password1!"
      },
      "updateKb2919442BinaryPath" : "/nfs/vmware/vcf/nfs-mount/bundle/cd0661c8-f626-41ca-a07b-3e168e386e04/bundle-16029/horizon_install/Windows8.1-KB2919442-x64.msu",
      "updateKb2919355BinaryPath" : "/nfs/vmware/vcf/nfs-mount/bundle/cd0661c8-f626-41ca-a07b-3e168e386e04/bundle-16029/horizon_install/Windows8.1-KB2919355-x64.msu",
      "dotNet462BinaryPath" : "/nfs/vmware/vcf/nfs-mount/bundle/cd0661c8-f626-41ca-a07b-3e168e386e04/bundle-16029/horizon_install/NDP462-KB3151800-x86-x64-AllOS-ENU.exe"
    },
    "sqlConnections" : [ {
      "fqdn" : "sql.horizon-1.local",
      "id" : "sql_av",
      "sqlInstanceName" : "SQLEXPRESS",
      "sqlPort" : 1433,
      "state" : "NEW",
      "dbUsername" : "av_db_admin",
      "dbPassword" : "Password123!"
    }, {
      "fqdn" : "sql.horizon-1.local",
      "id" : "sql_event",
      "sqlInstanceName" : "SQLEXPRESS",
      "sqlPort" : 1433,
      "state" : "NEW",
      "dbUsername" : "event_db_admin",
      "dbPassword" : "Password123!"
    }, {
      "fqdn" : "sql.horizon-1.local",
      "id" : "sqlext",
      "state" : "NEW",
      "dbUsername" : "composer_db_admin1",
      "dbPassword" : "Password123!"
    } ]
  },
  "horizon" : {
    "pods" : [ {
      "eventDbName" : "event-db",
      "sqlId" : "sql_event",
      "vcFqdns" : [ "vcenter-2.vrack.vsphere.local" ],
      "uagAppliances" : [ {
        "vmName" : "uag1",
        "mgmtSubnetMask" : "255.255.0.0",
        "mgmtIpAddress" : "10.0.240.33",
        "externalSubnetMask" : "255.255.0.0",
        "internalSubnetMask" : "255.255.0.0",
        "defaultGateway" : "10.0.0.250",
        "internalIpAddress" : "10.0.240.34",
        "externalIpAddress" : "10.0.240.35",
        "administratorPassword" : "Password123!",
        "state" : "NEW"
      } ],
      "connectionServers" : [ {
        "fqdn" : "cs1.horizon-1.local",
        "state" : "NEW",
        "deployDetails" : {
          "ipAddress" : "10.0.240.20",
          "gateway" : "10.0.0.250",
          "subnetMask" : "255.255.0.0",
          "vmName" : "cs1",
          "computerName" : "cs1"
        }
      } ],
      "composerServers" : [ {
        "fqdn" : "compsvc1.horizon-1.local",
        "composerServiceAccount" : "horizon-1.local\\compsvc1",
        "composerServicePassword" : "Password123!",
        "sqlId" : "sqlext",
        "dbName" : "internal-db-name",
        "vcFqdn" : "vcenter-2.vrack.vsphere.local",
        "state" : "NEW",
        "deployDetails" : {
          "ipAddress" : "10.0.240.22",
          "gateway" : "10.0.0.250",
          "subnetMask" : "255.255.0.0",
          "vmName" : "comp-server",
          "computerName" : "compsvc1"
        }
      } ]
    } ],
    "internalLbFqdn" : "vipcs.horizon-1.local",
    "externalLbFqdn" : "vipdmz.horizon-1.local",
    "license" : "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
    "adminGroupName" : "horizonadmins",
    "uemDetails" : {
      "uems" : [ {
        "fqdn" : "uem.horizon-1.local",
        "configurationShare" : "/share/drive",
        "profileArchiveShare" : "profileshare",
        "state" : "NEW",
        "deployDetails" : {
          "dataDriveSizeGb" : 10,
          "configurationShareLocation" : "/share/location",
          "profileArchiveShareLocation" : "/profile/location",
          "ipAddress" : "10.0.240.23",
          "gateway" : "10.0.0.250",
          "subnetMask" : "255.255.0.0",
          "vmName" : "uem-vm",
          "computerName" : "uem"
        }
      } ]
    }
  },
  "appVolumesDetails" : {
    "adminGroupName" : "avadmins",
    "dbName" : "appvol-db-ext",
    "sqlId" : "sql_av",
    "lbFqdn" : "vipav.horizon-1.local",
    "datastores" : [ {
      "id" : "local-0",
      "isPrimary" : true
    } ],
    "appVolumes" : [ {
      "fqdn" : "appv1.horizon-1.local",
      "state" : "NEW",
      "deployDetails" : {
        "ipAddress" : "10.0.240.24",
        "gateway" : "10.0.0.250",
        "subnetMask" : "255.255.0.0",
        "vmName" : "appv1",
        "computerName" : "appv1"
      }
    } ]
  }
}'

HTTP Request

POST /v1/horizons HTTP/1.1
Accept: application/json;charset=UTF-8
Host: sddc-manager.sfo01.rainpole.local
Content-Length: 8513
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==
Content-Type: application/json

{
  "name" : "Horizon Suite Deployment 1",
  "managementVcenters" : [ {
    "clusterName" : "SDDC-Cluster1",
    "datacenterName" : "SDDC-Datacenter",
    "datastoreName" : "sfo01-m01-vsan",
    "dmzPortgroup" : "Horizon-DPortGroup-DMZ",
    "interconnectPortgroup" : "Horizon-DPortGroup-Mgmt",
    "managementPortgroup" : "Horizon-DPortGroup-Mgmt",
    "uagManagementPortgroup" : "Horizon-DPortGroup-Mgmt",
    "nsx" : {
      "host" : "nsxManager.vrack.vsphere.local",
      "password" : "x$7G$7o49x#fs0y"
    },
    "username" : "[email protected]",
    "password" : "d9X!A0F76L942#$",
    "host" : "vcenter-1.vrack.vsphere.local",
    "psc" : {
      "host" : "psc-2.vrack.vsphere.local"
    }
  } ],
  "resourceVcenters" : [ {
    "state" : "NEW",
    "datacenters" : [ {
      "name" : "new-vi-DC",
      "datastores" : [ {
        "name" : "local-0",
        "id" : "local-0",
        "hostIds" : [ "esxi-1" ]
      } ],
      "clusters" : [ {
        "name" : "via-cluster1",
        "hosts" : [ {
          "fqdn" : "esxi-1.vrack.vsphere.local",
          "id" : "esxi-1",
          "username" : "root",
          "password" : "Password!1234"
        } ]
      } ]
    } ],
    "username" : "[email protected]",
    "password" : "x7P#!!G72K820_#",
    "host" : "vcenter-2.vrack.vsphere.local",
    "psc" : {
      "host" : "psc-2.vrack.vsphere.local"
    }
  } ],
  "peripheralServices" : {
    "loadBalancers" : [ {
      "ipAddress" : "10.0.240.30",
      "fqdn" : "vipcs.horizon-1.local",
      "state" : "NEW",
      "deployDetails" : {
        "vmName" : "vipcs",
        "subnetMask" : "255.255.0.0",
        "gateway" : "10.0.0.250",
        "portgroup" : "Horizon-DPortGroup-Mgmt",
        "cliPassword" : "Password123456789!"
      }
    }, {
      "ipAddress" : "10.0.240.31",
      "fqdn" : "vipav.horizon-1.local",
      "state" : "NEW",
      "deployDetails" : {
        "vmName" : "vipav",
        "subnetMask" : "255.255.0.0",
        "gateway" : "10.0.0.250",
        "portgroup" : "Horizon-DPortGroup-Mgmt",
        "cliPassword" : "Password123456789!"
      }
    }, {
      "ipAddress" : "10.0.240.32",
      "fqdn" : "vipdmz.horizon-1.local",
      "state" : "NEW",
      "deployDetails" : {
        "vmName" : "vipdmz",
        "subnetMask" : "255.255.0.0",
        "gateway" : "10.0.0.250",
        "portgroup" : "Horizon-DPortGroup-DMZ",
        "cliPassword" : "Password123456789!"
      }
    } ],
    "activeDirectory" : {
      "fqdn" : "horizon-1.local",
      "netBiosName" : "horizon-1",
      "vdiAdminUsername" : "horizon-1.local\\vdiadmin",
      "vdiAdminPassword" : "Password123!",
      "vdiServerOu" : "OU=vdi,DC=horizon-1,DC=local",
      "ouRwUsername" : "horizon-1.local\\rwadmin",
      "ouRwPassword" : "Password123!",
      "adminUsername" : "horizon-1.local\\administrator",
      "adminPassword" : "Password1!",
      "securedAD" : false,
      "domainControllers" : [ {
        "ipAddress" : "10.0.240.81"
      } ]
    },
    "installDetails" : {
      "imagePath" : "/home/vcf/download/template_new_vmware_tools.ova",
      "connectionServerBinaryPath" : "/nfs/vmware/vcf/nfs-mount/bundle/cd0661c8-f626-41ca-a07b-3e168e386e04/bundle-16029/horizon_install/VMware-Horizon-Connection-Server-x86_64-7.9.0-13956742.exe",
      "composerServerBinaryPath" : "/nfs/vmware/vcf/nfs-mount/bundle/cd0661c8-f626-41ca-a07b-3e168e386e04/bundle-16029/horizon_install/VMware-viewcomposer-7.9.0-13810618.exe",
      "appVolumesServerBinaryPath" : "/nfs/vmware/vcf/nfs-mount/bundle/cd0661c8-f626-41ca-a07b-3e168e386e04/bundle-16029/horizon_install/AppVolumesManager.msi",
      "uagOvaPath" : "/nfs/vmware/vcf/nfs-mount/bundle/cd0661c8-f626-41ca-a07b-3e168e386e04/bundle-16029/horizon_install/euc-unified-access-gateway-3.6.0.0-14019369_OVF10.ova",
      "sqlExpressPath" : "/nfs/vmware/vcf/nfs-mount/bundle/cd0661c8-f626-41ca-a07b-3e168e386e04/bundle-16029/horizon_install/SQLEXPR_x64_ENU.exe",
      "uemBinaryPath" : "/nfs/vmware/vcf/nfs-mount/bundle/cd0661c8-f626-41ca-a07b-3e168e386e04/bundle-16029/horizon_install/VMware User Environment Manager 9.8.0.895 x64.msi",
      "connectionServerVersion" : "7.9.0-13956742",
      "composerServerVersion" : "7.9.0-13810618",
      "appVolumesServerVersion" : "2.17.0",
      "uagOvaVersion" : "3.6.0.0-14019369",
      "sqlExpressVersion" : "2017",
      "uemVersion" : "9.8.0.895",
      "ova" : {
        "administratorUsername" : "administrator",
        "administratorPassword" : "Password1!"
      },
      "updateKb2919442BinaryPath" : "/nfs/vmware/vcf/nfs-mount/bundle/cd0661c8-f626-41ca-a07b-3e168e386e04/bundle-16029/horizon_install/Windows8.1-KB2919442-x64.msu",
      "updateKb2919355BinaryPath" : "/nfs/vmware/vcf/nfs-mount/bundle/cd0661c8-f626-41ca-a07b-3e168e386e04/bundle-16029/horizon_install/Windows8.1-KB2919355-x64.msu",
      "dotNet462BinaryPath" : "/nfs/vmware/vcf/nfs-mount/bundle/cd0661c8-f626-41ca-a07b-3e168e386e04/bundle-16029/horizon_install/NDP462-KB3151800-x86-x64-AllOS-ENU.exe"
    },
    "sqlConnections" : [ {
      "fqdn" : "sql.horizon-1.local",
      "id" : "sql_av",
      "sqlInstanceName" : "SQLEXPRESS",
      "sqlPort" : 1433,
      "state" : "NEW",
      "dbUsername" : "av_db_admin",
      "dbPassword" : "Password123!"
    }, {
      "fqdn" : "sql.horizon-1.local",
      "id" : "sql_event",
      "sqlInstanceName" : "SQLEXPRESS",
      "sqlPort" : 1433,
      "state" : "NEW",
      "dbUsername" : "event_db_admin",
      "dbPassword" : "Password123!"
    }, {
      "fqdn" : "sql.horizon-1.local",
      "id" : "sqlext",
      "state" : "NEW",
      "dbUsername" : "composer_db_admin1",
      "dbPassword" : "Password123!"
    } ]
  },
  "horizon" : {
    "pods" : [ {
      "eventDbName" : "event-db",
      "sqlId" : "sql_event",
      "vcFqdns" : [ "vcenter-2.vrack.vsphere.local" ],
      "uagAppliances" : [ {
        "vmName" : "uag1",
        "mgmtSubnetMask" : "255.255.0.0",
        "mgmtIpAddress" : "10.0.240.33",
        "externalSubnetMask" : "255.255.0.0",
        "internalSubnetMask" : "255.255.0.0",
        "defaultGateway" : "10.0.0.250",
        "internalIpAddress" : "10.0.240.34",
        "externalIpAddress" : "10.0.240.35",
        "administratorPassword" : "Password123!",
        "state" : "NEW"
      } ],
      "connectionServers" : [ {
        "fqdn" : "cs1.horizon-1.local",
        "state" : "NEW",
        "deployDetails" : {
          "ipAddress" : "10.0.240.20",
          "gateway" : "10.0.0.250",
          "subnetMask" : "255.255.0.0",
          "vmName" : "cs1",
          "computerName" : "cs1"
        }
      } ],
      "composerServers" : [ {
        "fqdn" : "compsvc1.horizon-1.local",
        "composerServiceAccount" : "horizon-1.local\\compsvc1",
        "composerServicePassword" : "Password123!",
        "sqlId" : "sqlext",
        "dbName" : "internal-db-name",
        "vcFqdn" : "vcenter-2.vrack.vsphere.local",
        "state" : "NEW",
        "deployDetails" : {
          "ipAddress" : "10.0.240.22",
          "gateway" : "10.0.0.250",
          "subnetMask" : "255.255.0.0",
          "vmName" : "comp-server",
          "computerName" : "compsvc1"
        }
      } ]
    } ],
    "internalLbFqdn" : "vipcs.horizon-1.local",
    "externalLbFqdn" : "vipdmz.horizon-1.local",
    "license" : "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
    "adminGroupName" : "horizonadmins",
    "uemDetails" : {
      "uems" : [ {
        "fqdn" : "uem.horizon-1.local",
        "configurationShare" : "/share/drive",
        "profileArchiveShare" : "profileshare",
        "state" : "NEW",
        "deployDetails" : {
          "dataDriveSizeGb" : 10,
          "configurationShareLocation" : "/share/location",
          "profileArchiveShareLocation" : "/profile/location",
          "ipAddress" : "10.0.240.23",
          "gateway" : "10.0.0.250",
          "subnetMask" : "255.255.0.0",
          "vmName" : "uem-vm",
          "computerName" : "uem"
        }
      } ]
    }
  },
  "appVolumesDetails" : {
    "adminGroupName" : "avadmins",
    "dbName" : "appvol-db-ext",
    "sqlId" : "sql_av",
    "lbFqdn" : "vipav.horizon-1.local",
    "datastores" : [ {
      "id" : "local-0",
      "isPrimary" : true
    } ],
    "appVolumes" : [ {
      "fqdn" : "appv1.horizon-1.local",
      "state" : "NEW",
      "deployDetails" : {
        "ipAddress" : "10.0.240.24",
        "gateway" : "10.0.0.250",
        "subnetMask" : "255.255.0.0",
        "vmName" : "appv1",
        "computerName" : "appv1"
      }
    } ]
  }
}

HTTP Response

HTTP/1.1 202 Accepted
Content-Length: 198
Location: /v1/tasks/fb9d9e31-b4d5-4d66-b743-df67d210794d
Content-Type: application/json;charset=UTF-8

{
  "id" : "fb9d9e31-b4d5-4d66-b743-df67d210794d",
  "name" : "Adding Horizon deployment Horizon Suite Deployment 1",
  "status" : "IN_PROGRESS",
  "creationTimestamp" : "2019-10-12T04:45:21.886Z"
}

  1. Poll the task until "status" is not "IN_PROGRESS" with the ID from the previous response.

Tip
 Refer to: Get a Task.

  • If the "status" is "SUCCESSFUL", the task is completed successfully.

  • If the "status" is "FAILED", the task can be re-executed.

Tip
 Refer to: Retry a Task.
Related APIs

Deploy Horizon Suite
Validates Horizon configuration
Get a Task
Retry a Task

2.10.2. Expand Horizon Suite

Expanding Horizon Suite allows you the following operations (can be combined also):

  • add whole new optional components such as:

    • VI domains for extending virtual desktops capacity

    • Composer servers

    • Unified Access Gateway appliances

    • User Environment Manager

    • App Volumes

    • peripheral infrastructure such as SQL server connections, load balancers etc.

  • deploy additional servers for existing components such as:

    • Connection servers

    • Composer servers

    • Unified Access Gateway appliances

    • App Volumes servers

    • SQL server connections

Prerequisites

  1. In order to expand a Horizon Suite, except for the deployed Horizon Suite itself, you do not nee any general prerequisites. However, depending on the expansion components, some specific prerequisites will be needed (i.e. for adding VI domain, it should be pre-deployed and readily available).

Important
 When expanding Horizon Suite, always use exported Horizon spec from the current state and add to it desired new components and servers. That will ensure your data consistency for the expansion spec.
Steps

  1. Get Horizon Suite configuration spec to alter (using its Id and the API below).

Tip
 Refer to Get Horizon Suite configuration spec

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/horizons/1475a612-f84e-4e51-b1ac-9cbec72b0dce' -i -u 'admin:VMwareInfra@1' -X GET \
    -H 'Accept: application/json;charset=UTF-8' \
    -H 'Content-Type: application/json'

HTTP Request

GET /v1/horizons/1475a612-f84e-4e51-b1ac-9cbec72b0dce HTTP/1.1
Accept: application/json;charset=UTF-8
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==
Content-Type: application/json

HTTP Response

HTTP/1.1 200 OK
Content-Length: 9639
Content-Type: application/json;charset=UTF-8

{
  "id" : "1475a612-f84e-4e51-b1ac-9cbec72b0dce",
  "name" : "Horizon Suite Deployment 1",
  "managementVcenters" : [ {
    "clusterName" : "SDDC-Cluster1",
    "datacenterName" : "SDDC-Datacenter",
    "datastoreName" : "sfo01-m01-vsan",
    "dmzPortgroup" : "Horizon-DPortGroup-DMZ",
    "interconnectPortgroup" : "Horizon-DPortGroup-Mgmt",
    "managementPortgroup" : "Horizon-DPortGroup-Mgmt",
    "uagManagementPortgroup" : "Horizon-DPortGroup-Mgmt",
    "nsx" : {
      "host" : "nsxManager.vrack.vsphere.local",
      "password" : "x$7G$7o49x#fs0y"
    },
    "username" : "[email protected]",
    "password" : "d9X!A0F76L942#$",
    "host" : "vcenter-1.vrack.vsphere.local",
    "psc" : {
      "host" : "psc-2.vrack.vsphere.local"
    }
  } ],
  "resourceVcenters" : [ {
    "state" : "DEPLOYED",
    "datacenters" : [ {
      "name" : "new-vi-DC",
      "datastores" : [ {
        "name" : "local-0",
        "id" : "local-0",
        "hostIds" : [ "esxi-1" ]
      } ],
      "clusters" : [ {
        "name" : "via-cluster1",
        "hosts" : [ {
          "fqdn" : "esxi-1.vrack.vsphere.local",
          "id" : "esxi-1",
          "username" : "root",
          "password" : "Password!1234"
        } ]
      } ]
    } ],
    "username" : "[email protected]",
    "password" : "x7P#!!G72K820_#",
    "host" : "vcenter-2.vrack.vsphere.local",
    "psc" : {
      "host" : "psc-2.vrack.vsphere.local"
    }
  } ],
  "peripheralServices" : {
    "loadBalancers" : [ {
      "ipAddress" : "10.0.240.30",
      "certificatePath" : "/var/opt/vmware/vcf/solutionsmanager/vdi/ConServCertificate.p12",
      "certificatePassword" : "ATrg9PsA",
      "fqdn" : "vipcs.horizon-1.local",
      "state" : "DEPLOYED",
      "deployDetails" : {
        "vmName" : "vipcs",
        "subnetMask" : "255.255.0.0",
        "gateway" : "10.0.0.250",
        "portgroup" : "Horizon-DPortGroup-Mgmt",
        "cliPassword" : "Password123456789!"
      }
    }, {
      "ipAddress" : "10.0.240.31",
      "certificatePath" : "/var/opt/vmware/vcf/solutionsmanager/vdi/AppVCertificate.p12",
      "certificatePassword" : "WxyrG6z1",
      "fqdn" : "vipav.horizon-1.local",
      "state" : "DEPLOYED",
      "deployDetails" : {
        "vmName" : "vipav",
        "subnetMask" : "255.255.0.0",
        "gateway" : "10.0.0.250",
        "portgroup" : "Horizon-DPortGroup-Mgmt",
        "cliPassword" : "Password123456789!"
      }
    }, {
      "ipAddress" : "10.0.240.32",
      "certificatePath" : "/var/opt/vmware/vcf/solutionsmanager/vdi/UagCertificate.p12",
      "certificatePassword" : "kEAbJS1",
      "fqdn" : "vipdmz.horizon-1.local",
      "state" : "DEPLOYED",
      "deployDetails" : {
        "vmName" : "vipdmz",
        "subnetMask" : "255.255.0.0",
        "gateway" : "10.0.0.250",
        "portgroup" : "Horizon-DPortGroup-DMZ",
        "cliPassword" : "Password123456789!"
      }
    } ],
    "activeDirectory" : {
      "fqdn" : "horizon-1.local",
      "netBiosName" : "horizon-1",
      "vdiAdminUsername" : "horizon-1.local\\vdiadmin",
      "vdiAdminPassword" : "Password123!",
      "vdiServerOu" : "OU=vdi,DC=horizon-1,DC=local",
      "ouRwUsername" : "horizon-1.local\\rwadmin",
      "ouRwPassword" : "Password123!",
      "adminUsername" : "horizon-1.local\\administrator",
      "adminPassword" : "Password1!",
      "securedAD" : false,
      "domainControllers" : [ {
        "ipAddress" : "10.0.240.81"
      } ]
    },
    "installDetails" : {
      "imagePath" : "/home/vcf/download/template_new_vmware_tools.ova",
      "connectionServerBinaryPath" : "/nfs/vmware/vcf/nfs-mount/bundle/cd0661c8-f626-41ca-a07b-3e168e386e04/bundle-16029/horizon_install/VMware-Horizon-Connection-Server-x86_64-7.9.0-13956742.exe",
      "composerServerBinaryPath" : "/nfs/vmware/vcf/nfs-mount/bundle/cd0661c8-f626-41ca-a07b-3e168e386e04/bundle-16029/horizon_install/VMware-viewcomposer-7.9.0-13810618.exe",
      "appVolumesServerBinaryPath" : "/nfs/vmware/vcf/nfs-mount/bundle/cd0661c8-f626-41ca-a07b-3e168e386e04/bundle-16029/horizon_install/AppVolumesManager.msi",
      "uagOvaPath" : "/nfs/vmware/vcf/nfs-mount/bundle/cd0661c8-f626-41ca-a07b-3e168e386e04/bundle-16029/horizon_install/euc-unified-access-gateway-3.6.0.0-14019369_OVF10.ova",
      "sqlExpressPath" : "/nfs/vmware/vcf/nfs-mount/bundle/cd0661c8-f626-41ca-a07b-3e168e386e04/bundle-16029/horizon_install/SQLEXPR_x64_ENU.exe",
      "uemBinaryPath" : "/nfs/vmware/vcf/nfs-mount/bundle/cd0661c8-f626-41ca-a07b-3e168e386e04/bundle-16029/horizon_install/VMware User Environment Manager 9.8.0.895 x64.msi",
      "connectionServerVersion" : "7.9.0-13956742",
      "composerServerVersion" : "7.9.0-13810618",
      "appVolumesServerVersion" : "2.17.0",
      "uagOvaVersion" : "3.6.0.0-14019369",
      "sqlExpressVersion" : "2017",
      "uemVersion" : "9.8.0.895",
      "ova" : {
        "administratorUsername" : "administrator",
        "administratorPassword" : "Password1!"
      },
      "updateKb2919442BinaryPath" : "/nfs/vmware/vcf/nfs-mount/bundle/cd0661c8-f626-41ca-a07b-3e168e386e04/bundle-16029/horizon_install/Windows8.1-KB2919442-x64.msu",
      "updateKb2919355BinaryPath" : "/nfs/vmware/vcf/nfs-mount/bundle/cd0661c8-f626-41ca-a07b-3e168e386e04/bundle-16029/horizon_install/Windows8.1-KB2919355-x64.msu",
      "dotNet462BinaryPath" : "/nfs/vmware/vcf/nfs-mount/bundle/cd0661c8-f626-41ca-a07b-3e168e386e04/bundle-16029/horizon_install/NDP462-KB3151800-x86-x64-AllOS-ENU.exe"
    },
    "sqlConnections" : [ {
      "fqdn" : "sql.horizon-1.local",
      "id" : "sql_av",
      "sqlInstanceName" : "SQLEXPRESS",
      "sqlPort" : 1433,
      "state" : "DEPLOYED",
      "deployDetails" : null,
      "dbUsername" : "av_db_admin",
      "dbPassword" : "Password123!"
    }, {
      "fqdn" : "sql.horizon-1.local",
      "id" : "sql_event",
      "sqlInstanceName" : "SQLEXPRESS",
      "sqlPort" : 1433,
      "state" : "DEPLOYED",
      "deployDetails" : null,
      "dbUsername" : "event_db_admin",
      "dbPassword" : "Password123!"
    }, {
      "fqdn" : "sql.horizon-1.local",
      "id" : "sqlext",
      "sqlInstanceName" : null,
      "sqlPort" : null,
      "state" : "DEPLOYED",
      "deployDetails" : null,
      "dbUsername" : "composer_db_admin1",
      "dbPassword" : "Password123!"
    } ]
  },
  "horizon" : {
    "pods" : [ {
      "eventDbName" : "event-db",
      "sqlId" : "sql_event",
      "vcFqdns" : [ "vcenter-2.vrack.vsphere.local,vcenter-3.vrack.vsphere.local" ],
      "uagAppliances" : [ {
        "vmName" : "uag1",
        "mgmtSubnetMask" : "255.255.0.0",
        "mgmtIpAddress" : "10.0.240.33",
        "externalSubnetMask" : "255.255.0.0",
        "internalSubnetMask" : "255.255.0.0",
        "defaultGateway" : "10.0.0.250",
        "internalIpAddress" : "10.0.240.34",
        "externalIpAddress" : "10.0.240.35",
        "administratorPassword" : "Password123!",
        "connectionServerFqdn" : null,
        "state" : "DEPLOYED"
      } ],
      "connectionServers" : [ {
        "fqdn" : "cs1.horizon-1.local",
        "certificatePath" : "/var/opt/vmware/vcf/solutionsmanager/vdi/ConServCertificate.p12",
        "certificatePassword" : "ATrg9PsA",
        "state" : "DEPLOYED",
        "deployDetails" : {
          "ipAddress" : "10.0.240.20",
          "gateway" : "10.0.0.250",
          "subnetMask" : "255.255.0.0",
          "vmName" : "cs1",
          "computerName" : "cs1"
        }
      } ],
      "composerServers" : [ {
        "fqdn" : "compsvc1.horizon-1.local",
        "composerServiceAccount" : "horizon-1.local\\compsvc1",
        "composerServicePassword" : "Password123!",
        "sqlId" : "sqlext",
        "internalDbUsername" : null,
        "internalDbPassword" : null,
        "dbName" : "internal-db-name",
        "certificatePath" : "/var/opt/vmware/vcf/solutionsmanager/vdi/CompServerCertificate.p12",
        "certificatePassword" : "Password123!",
        "vcFqdn" : "vcenter-2.vrack.vsphere.local",
        "state" : "DEPLOYED",
        "deployDetails" : {
          "ipAddress" : "10.0.240.22",
          "gateway" : "10.0.0.250",
          "subnetMask" : "255.255.0.0",
          "vmName" : "comp-server",
          "computerName" : "compsvc1"
        }
      } ]
    } ],
    "internalLbFqdn" : "vipcs.horizon-1.local",
    "externalLbFqdn" : "vipdmz.horizon-1.local",
    "license" : "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
    "adminGroupName" : "horizonadmins",
    "uemDetails" : {
      "license" : null,
      "uems" : [ {
        "fqdn" : "uem.horizon-1.local",
        "configurationShare" : "/share/drive",
        "profileArchiveShare" : "profileshare",
        "state" : "DEPLOYED",
        "deployDetails" : {
          "dataDriveSizeGb" : 10,
          "configurationShareLocation" : "/share/location",
          "profileArchiveShareLocation" : "/profile/location",
          "gateway" : "10.0.0.250",
          "subnetMask" : "255.255.0.0",
          "vmName" : "uem-vm",
          "computerName" : "uem",
          "ipAddress" : "10.0.240.23"
        }
      } ]
    }
  },
  "appVolumesDetails" : {
    "adminGroupName" : "avadmins",
    "dbName" : "appvol-db-ext",
    "sqlId" : "sql_av",
    "license" : null,
    "lbFqdn" : "vipav.horizon-1.local",
    "datastores" : [ {
      "id" : "local-0",
      "isPrimary" : true
    } ],
    "appVolumes" : [ {
      "fqdn" : "appv1.horizon-1.local",
      "state" : "DEPLOYED",
      "deployDetails" : {
        "ipAddress" : "10.0.240.24",
        "gateway" : "10.0.0.250",
        "subnetMask" : "255.255.0.0",
        "vmName" : "appv1",
        "computerName" : "appv1"
      }
    } ]
  }
}

  1. Alter the configuration spec by adding new servers or components. Follow these general guidelines:

Note
 Removing of components (including VI workload domains) or servers is not supported.

  1. Validate your Horizon configuration spec (be sure to use PRE_VALIDATION_EXPANSION as HorizonValidationOperation):

Tip
 Refer to Validate Horizon Suite Configuration Spec

  1. Start Horizon Suite expansion workflow, using the validated configuration spec from previous step

Tip
 Refer to Expand Horizon Suite

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/horizons/1475a612-f84e-4e51-b1ac-9cbec72b0dce' -i -u 'admin:VMwareInfra@1' -X PUT \
    -H 'Accept: application/json;charset=UTF-8' \
    -H 'Content-Type: application/json' \
    -d '{
  "id" : "1475a612-f84e-4e51-b1ac-9cbec72b0dce",
  "name" : "Horizon Suite Deployment 1",
  "managementVcenters" : [ {
    "clusterName" : "SDDC-Cluster1",
    "datacenterName" : "SDDC-Datacenter",
    "datastoreName" : "sfo01-m01-vsan",
    "dmzPortgroup" : "Horizon-DPortGroup-DMZ",
    "interconnectPortgroup" : "Horizon-DPortGroup-Mgmt",
    "managementPortgroup" : "Horizon-DPortGroup-Mgmt",
    "uagManagementPortgroup" : "Horizon-DPortGroup-Mgmt",
    "nsx" : {
      "host" : "nsxManager.vrack.vsphere.local",
      "password" : "x$7G$7o49x#fs0y"
    },
    "username" : "[email protected]",
    "password" : "d9X!A0F76L942#$",
    "host" : "vcenter-1.vrack.vsphere.local",
    "psc" : {
      "host" : "psc-2.vrack.vsphere.local"
    }
  } ],
  "resourceVcenters" : [ {
    "state" : "DEPLOYED",
    "datacenters" : [ {
      "name" : "new-vi-DC",
      "datastores" : [ {
        "name" : "local-0",
        "id" : "local-0",
        "hostIds" : [ "esxi-1" ]
      } ],
      "clusters" : [ {
        "name" : "via-cluster1",
        "hosts" : [ {
          "fqdn" : "esxi-1.vrack.vsphere.local",
          "id" : "esxi-1",
          "username" : "root",
          "password" : "Password!1234"
        } ]
      } ]
    } ],
    "username" : "[email protected]",
    "password" : "x7P#!!G72K820_#",
    "host" : "vcenter-2.vrack.vsphere.local",
    "psc" : {
      "host" : "psc-2.vrack.vsphere.local"
    }
  }, {
    "state" : "NEW",
    "datacenters" : [ {
      "name" : "new-vi-DC",
      "datastores" : [ {
        "name" : "local-1",
        "id" : "local-1",
        "hostIds" : [ "esxi-2" ]
      } ],
      "clusters" : [ {
        "name" : "via-cluster1",
        "hosts" : [ {
          "fqdn" : "esxi-2.vrack.vsphere.local",
          "id" : "esxi-2",
          "username" : "root",
          "password" : "Password!1234"
        } ]
      } ]
    } ],
    "username" : "[email protected]",
    "password" : "x7P#!!G72K820_#",
    "host" : "vcenter-3.vrack.vsphere.local",
    "psc" : {
      "host" : "psc-2.vrack.vsphere.local"
    }
  } ],
  "peripheralServices" : {
    "loadBalancers" : [ {
      "ipAddress" : "10.0.240.30",
      "certificatePath" : "/var/opt/vmware/vcf/solutionsmanager/vdi/ConServCertificate.p12",
      "certificatePassword" : "ATrg9PsA",
      "fqdn" : "vipcs.horizon-1.local",
      "state" : "DEPLOYED",
      "deployDetails" : {
        "vmName" : "vipcs",
        "subnetMask" : "255.255.0.0",
        "gateway" : "10.0.0.250",
        "portgroup" : "Horizon-DPortGroup-Mgmt",
        "cliPassword" : "Password123456789!"
      }
    }, {
      "ipAddress" : "10.0.240.31",
      "certificatePath" : "/var/opt/vmware/vcf/solutionsmanager/vdi/AppVCertificate.p12",
      "certificatePassword" : "WxyrG6z1",
      "fqdn" : "vipav.horizon-1.local",
      "state" : "DEPLOYED",
      "deployDetails" : {
        "vmName" : "vipav",
        "subnetMask" : "255.255.0.0",
        "gateway" : "10.0.0.250",
        "portgroup" : "Horizon-DPortGroup-Mgmt",
        "cliPassword" : "Password123456789!"
      }
    }, {
      "ipAddress" : "10.0.240.32",
      "certificatePath" : "/var/opt/vmware/vcf/solutionsmanager/vdi/UagCertificate.p12",
      "certificatePassword" : "kEAbJS1",
      "fqdn" : "vipdmz.horizon-1.local",
      "state" : "DEPLOYED",
      "deployDetails" : {
        "vmName" : "vipdmz",
        "subnetMask" : "255.255.0.0",
        "gateway" : "10.0.0.250",
        "portgroup" : "Horizon-DPortGroup-DMZ",
        "cliPassword" : "Password123456789!"
      }
    } ],
    "activeDirectory" : {
      "fqdn" : "horizon-1.local",
      "netBiosName" : "horizon-1",
      "vdiAdminUsername" : "horizon-1.local\\vdiadmin",
      "vdiAdminPassword" : "Password123!",
      "vdiServerOu" : "OU=vdi,DC=horizon-1,DC=local",
      "ouRwUsername" : "horizon-1.local\\rwadmin",
      "ouRwPassword" : "Password123!",
      "adminUsername" : "horizon-1.local\\administrator",
      "adminPassword" : "Password1!",
      "securedAD" : false,
      "domainControllers" : [ {
        "ipAddress" : "10.0.240.81"
      } ]
    },
    "installDetails" : {
      "imagePath" : "/home/vcf/download/template_new_vmware_tools.ova",
      "connectionServerBinaryPath" : "/nfs/vmware/vcf/nfs-mount/bundle/cd0661c8-f626-41ca-a07b-3e168e386e04/bundle-16029/horizon_install/VMware-Horizon-Connection-Server-x86_64-7.9.0-13956742.exe",
      "composerServerBinaryPath" : "/nfs/vmware/vcf/nfs-mount/bundle/cd0661c8-f626-41ca-a07b-3e168e386e04/bundle-16029/horizon_install/VMware-viewcomposer-7.9.0-13810618.exe",
      "appVolumesServerBinaryPath" : "/nfs/vmware/vcf/nfs-mount/bundle/cd0661c8-f626-41ca-a07b-3e168e386e04/bundle-16029/horizon_install/AppVolumesManager.msi",
      "uagOvaPath" : "/nfs/vmware/vcf/nfs-mount/bundle/cd0661c8-f626-41ca-a07b-3e168e386e04/bundle-16029/horizon_install/euc-unified-access-gateway-3.6.0.0-14019369_OVF10.ova",
      "sqlExpressPath" : "/nfs/vmware/vcf/nfs-mount/bundle/cd0661c8-f626-41ca-a07b-3e168e386e04/bundle-16029/horizon_install/SQLEXPR_x64_ENU.exe",
      "uemBinaryPath" : "/nfs/vmware/vcf/nfs-mount/bundle/cd0661c8-f626-41ca-a07b-3e168e386e04/bundle-16029/horizon_install/VMware User Environment Manager 9.8.0.895 x64.msi",
      "connectionServerVersion" : "7.9.0-13956742",
      "composerServerVersion" : "7.9.0-13810618",
      "appVolumesServerVersion" : "2.17.0",
      "uagOvaVersion" : "3.6.0.0-14019369",
      "sqlExpressVersion" : "2017",
      "uemVersion" : "9.8.0.895",
      "ova" : {
        "administratorUsername" : "administrator",
        "administratorPassword" : "Password1!"
      },
      "updateKb2919442BinaryPath" : "/nfs/vmware/vcf/nfs-mount/bundle/cd0661c8-f626-41ca-a07b-3e168e386e04/bundle-16029/horizon_install/Windows8.1-KB2919442-x64.msu",
      "updateKb2919355BinaryPath" : "/nfs/vmware/vcf/nfs-mount/bundle/cd0661c8-f626-41ca-a07b-3e168e386e04/bundle-16029/horizon_install/Windows8.1-KB2919355-x64.msu",
      "dotNet462BinaryPath" : "/nfs/vmware/vcf/nfs-mount/bundle/cd0661c8-f626-41ca-a07b-3e168e386e04/bundle-16029/horizon_install/NDP462-KB3151800-x86-x64-AllOS-ENU.exe"
    },
    "sqlConnections" : [ {
      "fqdn" : "sql.horizon-1.local",
      "id" : "sql_av",
      "sqlInstanceName" : "SQLEXPRESS",
      "sqlPort" : 1433,
      "state" : "DEPLOYED",
      "dbUsername" : "av_db_admin",
      "dbPassword" : "Password123!"
    }, {
      "fqdn" : "sql.horizon-1.local",
      "id" : "sql_event",
      "sqlInstanceName" : "SQLEXPRESS",
      "sqlPort" : 1433,
      "state" : "DEPLOYED",
      "dbUsername" : "event_db_admin",
      "dbPassword" : "Password123!"
    }, {
      "fqdn" : "sql.horizon-1.local",
      "id" : "sqlext",
      "state" : "DEPLOYED",
      "dbUsername" : "composer_db_admin1",
      "dbPassword" : "Password123!"
    } ]
  },
  "horizon" : {
    "pods" : [ {
      "eventDbName" : "event-db",
      "sqlId" : "sql_event",
      "vcFqdns" : [ "vcenter-2.vrack.vsphere.local,vcenter-3.vrack.vsphere.local" ],
      "uagAppliances" : [ {
        "vmName" : "uag1",
        "mgmtSubnetMask" : "255.255.0.0",
        "mgmtIpAddress" : "10.0.240.33",
        "externalSubnetMask" : "255.255.0.0",
        "internalSubnetMask" : "255.255.0.0",
        "defaultGateway" : "10.0.0.250",
        "internalIpAddress" : "10.0.240.34",
        "externalIpAddress" : "10.0.240.35",
        "administratorPassword" : "Password123!",
        "state" : "DEPLOYED"
      }, {
        "vmName" : "uag2",
        "mgmtSubnetMask" : "255.255.0.0",
        "mgmtIpAddress" : "10.0.240.37",
        "externalSubnetMask" : "255.255.0.0",
        "internalSubnetMask" : "255.255.0.0",
        "defaultGateway" : "10.0.0.250",
        "internalIpAddress" : "10.0.240.27",
        "externalIpAddress" : "10.0.240.39",
        "administratorPassword" : "Password123!",
        "state" : "NEW"
      } ],
      "connectionServers" : [ {
        "fqdn" : "cs1.horizon-1.local",
        "certificatePath" : "/var/opt/vmware/vcf/solutionsmanager/vdi/ConServCertificate.p12",
        "certificatePassword" : "ATrg9PsA",
        "state" : "DEPLOYED",
        "deployDetails" : {
          "ipAddress" : "10.0.240.20",
          "gateway" : "10.0.0.250",
          "subnetMask" : "255.255.0.0",
          "vmName" : "cs1",
          "computerName" : "cs1"
        }
      }, {
        "fqdn" : "cs2.horizon-1.local",
        "state" : "NEW",
        "deployDetails" : {
          "ipAddress" : "10.0.240.29",
          "gateway" : "10.0.0.250",
          "subnetMask" : "255.255.0.0",
          "vmName" : "cs2",
          "computerName" : "cs2"
        }
      } ],
      "composerServers" : [ {
        "fqdn" : "compsvc1.horizon-1.local",
        "composerServiceAccount" : "horizon-1.local\\compsvc1",
        "composerServicePassword" : "Password123!",
        "sqlId" : "sqlext",
        "dbName" : "internal-db-name",
        "certificatePath" : "/var/opt/vmware/vcf/solutionsmanager/vdi/CompServerCertificate.p12",
        "certificatePassword" : "Password123!",
        "vcFqdn" : "vcenter-2.vrack.vsphere.local",
        "state" : "DEPLOYED",
        "deployDetails" : {
          "ipAddress" : "10.0.240.22",
          "gateway" : "10.0.0.250",
          "subnetMask" : "255.255.0.0",
          "vmName" : "comp-server",
          "computerName" : "compsvc1"
        }
      }, {
        "fqdn" : "compsvc2.horizon-1.local",
        "composerServiceAccount" : "horizon-1.local\\compsvc2",
        "composerServicePassword" : "Password123!",
        "sqlId" : "sqlext",
        "dbName" : "internal-db-name2",
        "vcFqdn" : "vcenter-3.vrack.vsphere.local",
        "state" : "NEW",
        "deployDetails" : {
          "ipAddress" : "10.0.240.28",
          "gateway" : "10.0.0.250",
          "subnetMask" : "255.255.0.0",
          "vmName" : "comp-server2",
          "computerName" : "compsvc2"
        }
      } ]
    } ],
    "internalLbFqdn" : "vipcs.horizon-1.local",
    "externalLbFqdn" : "vipdmz.horizon-1.local",
    "license" : "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
    "adminGroupName" : "horizonadmins",
    "uemDetails" : {
      "uems" : [ {
        "fqdn" : "uem.horizon-1.local",
        "configurationShare" : "/share/drive",
        "profileArchiveShare" : "profileshare",
        "state" : "DEPLOYED",
        "deployDetails" : {
          "dataDriveSizeGb" : 10,
          "configurationShareLocation" : "/share/location",
          "profileArchiveShareLocation" : "/profile/location",
          "ipAddress" : "10.0.240.23",
          "gateway" : "10.0.0.250",
          "subnetMask" : "255.255.0.0",
          "vmName" : "uem-vm",
          "computerName" : "uem"
        }
      } ]
    }
  },
  "appVolumesDetails" : {
    "adminGroupName" : "avadmins",
    "dbName" : "appvol-db-ext",
    "sqlId" : "sql_av",
    "lbFqdn" : "vipav.horizon-1.local",
    "datastores" : [ {
      "id" : "local-0",
      "isPrimary" : true
    } ],
    "appVolumes" : [ {
      "fqdn" : "appv1.horizon-1.local",
      "state" : "DEPLOYED",
      "deployDetails" : {
        "ipAddress" : "10.0.240.24",
        "gateway" : "10.0.0.250",
        "subnetMask" : "255.255.0.0",
        "vmName" : "appv1",
        "computerName" : "appv1"
      }
    }, {
      "fqdn" : "appv1.horizon-2.local",
      "state" : "NEW",
      "deployDetails" : {
        "ipAddress" : "10.0.240.26",
        "gateway" : "10.0.0.250",
        "subnetMask" : "255.255.0.0",
        "vmName" : "appv2",
        "computerName" : "appv2"
      }
    } ]
  }
}'

HTTP Request

PUT /v1/horizons/1475a612-f84e-4e51-b1ac-9cbec72b0dce HTTP/1.1
Accept: application/json;charset=UTF-8
Content-Length: 11514
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==
Content-Type: application/json

{
  "id" : "1475a612-f84e-4e51-b1ac-9cbec72b0dce",
  "name" : "Horizon Suite Deployment 1",
  "managementVcenters" : [ {
    "clusterName" : "SDDC-Cluster1",
    "datacenterName" : "SDDC-Datacenter",
    "datastoreName" : "sfo01-m01-vsan",
    "dmzPortgroup" : "Horizon-DPortGroup-DMZ",
    "interconnectPortgroup" : "Horizon-DPortGroup-Mgmt",
    "managementPortgroup" : "Horizon-DPortGroup-Mgmt",
    "uagManagementPortgroup" : "Horizon-DPortGroup-Mgmt",
    "nsx" : {
      "host" : "nsxManager.vrack.vsphere.local",
      "password" : "x$7G$7o49x#fs0y"
    },
    "username" : "[email protected]",
    "password" : "d9X!A0F76L942#$",
    "host" : "vcenter-1.vrack.vsphere.local",
    "psc" : {
      "host" : "psc-2.vrack.vsphere.local"
    }
  } ],
  "resourceVcenters" : [ {
    "state" : "DEPLOYED",
    "datacenters" : [ {
      "name" : "new-vi-DC",
      "datastores" : [ {
        "name" : "local-0",
        "id" : "local-0",
        "hostIds" : [ "esxi-1" ]
      } ],
      "clusters" : [ {
        "name" : "via-cluster1",
        "hosts" : [ {
          "fqdn" : "esxi-1.vrack.vsphere.local",
          "id" : "esxi-1",
          "username" : "root",
          "password" : "Password!1234"
        } ]
      } ]
    } ],
    "username" : "[email protected]",
    "password" : "x7P#!!G72K820_#",
    "host" : "vcenter-2.vrack.vsphere.local",
    "psc" : {
      "host" : "psc-2.vrack.vsphere.local"
    }
  }, {
    "state" : "NEW",
    "datacenters" : [ {
      "name" : "new-vi-DC",
      "datastores" : [ {
        "name" : "local-1",
        "id" : "local-1",
        "hostIds" : [ "esxi-2" ]
      } ],
      "clusters" : [ {
        "name" : "via-cluster1",
        "hosts" : [ {
          "fqdn" : "esxi-2.vrack.vsphere.local",
          "id" : "esxi-2",
          "username" : "root",
          "password" : "Password!1234"
        } ]
      } ]
    } ],
    "username" : "[email protected]",
    "password" : "x7P#!!G72K820_#",
    "host" : "vcenter-3.vrack.vsphere.local",
    "psc" : {
      "host" : "psc-2.vrack.vsphere.local"
    }
  } ],
  "peripheralServices" : {
    "loadBalancers" : [ {
      "ipAddress" : "10.0.240.30",
      "certificatePath" : "/var/opt/vmware/vcf/solutionsmanager/vdi/ConServCertificate.p12",
      "certificatePassword" : "ATrg9PsA",
      "fqdn" : "vipcs.horizon-1.local",
      "state" : "DEPLOYED",
      "deployDetails" : {
        "vmName" : "vipcs",
        "subnetMask" : "255.255.0.0",
        "gateway" : "10.0.0.250",
        "portgroup" : "Horizon-DPortGroup-Mgmt",
        "cliPassword" : "Password123456789!"
      }
    }, {
      "ipAddress" : "10.0.240.31",
      "certificatePath" : "/var/opt/vmware/vcf/solutionsmanager/vdi/AppVCertificate.p12",
      "certificatePassword" : "WxyrG6z1",
      "fqdn" : "vipav.horizon-1.local",
      "state" : "DEPLOYED",
      "deployDetails" : {
        "vmName" : "vipav",
        "subnetMask" : "255.255.0.0",
        "gateway" : "10.0.0.250",
        "portgroup" : "Horizon-DPortGroup-Mgmt",
        "cliPassword" : "Password123456789!"
      }
    }, {
      "ipAddress" : "10.0.240.32",
      "certificatePath" : "/var/opt/vmware/vcf/solutionsmanager/vdi/UagCertificate.p12",
      "certificatePassword" : "kEAbJS1",
      "fqdn" : "vipdmz.horizon-1.local",
      "state" : "DEPLOYED",
      "deployDetails" : {
        "vmName" : "vipdmz",
        "subnetMask" : "255.255.0.0",
        "gateway" : "10.0.0.250",
        "portgroup" : "Horizon-DPortGroup-DMZ",
        "cliPassword" : "Password123456789!"
      }
    } ],
    "activeDirectory" : {
      "fqdn" : "horizon-1.local",
      "netBiosName" : "horizon-1",
      "vdiAdminUsername" : "horizon-1.local\\vdiadmin",
      "vdiAdminPassword" : "Password123!",
      "vdiServerOu" : "OU=vdi,DC=horizon-1,DC=local",
      "ouRwUsername" : "horizon-1.local\\rwadmin",
      "ouRwPassword" : "Password123!",
      "adminUsername" : "horizon-1.local\\administrator",
      "adminPassword" : "Password1!",
      "securedAD" : false,
      "domainControllers" : [ {
        "ipAddress" : "10.0.240.81"
      } ]
    },
    "installDetails" : {
      "imagePath" : "/home/vcf/download/template_new_vmware_tools.ova",
      "connectionServerBinaryPath" : "/nfs/vmware/vcf/nfs-mount/bundle/cd0661c8-f626-41ca-a07b-3e168e386e04/bundle-16029/horizon_install/VMware-Horizon-Connection-Server-x86_64-7.9.0-13956742.exe",
      "composerServerBinaryPath" : "/nfs/vmware/vcf/nfs-mount/bundle/cd0661c8-f626-41ca-a07b-3e168e386e04/bundle-16029/horizon_install/VMware-viewcomposer-7.9.0-13810618.exe",
      "appVolumesServerBinaryPath" : "/nfs/vmware/vcf/nfs-mount/bundle/cd0661c8-f626-41ca-a07b-3e168e386e04/bundle-16029/horizon_install/AppVolumesManager.msi",
      "uagOvaPath" : "/nfs/vmware/vcf/nfs-mount/bundle/cd0661c8-f626-41ca-a07b-3e168e386e04/bundle-16029/horizon_install/euc-unified-access-gateway-3.6.0.0-14019369_OVF10.ova",
      "sqlExpressPath" : "/nfs/vmware/vcf/nfs-mount/bundle/cd0661c8-f626-41ca-a07b-3e168e386e04/bundle-16029/horizon_install/SQLEXPR_x64_ENU.exe",
      "uemBinaryPath" : "/nfs/vmware/vcf/nfs-mount/bundle/cd0661c8-f626-41ca-a07b-3e168e386e04/bundle-16029/horizon_install/VMware User Environment Manager 9.8.0.895 x64.msi",
      "connectionServerVersion" : "7.9.0-13956742",
      "composerServerVersion" : "7.9.0-13810618",
      "appVolumesServerVersion" : "2.17.0",
      "uagOvaVersion" : "3.6.0.0-14019369",
      "sqlExpressVersion" : "2017",
      "uemVersion" : "9.8.0.895",
      "ova" : {
        "administratorUsername" : "administrator",
        "administratorPassword" : "Password1!"
      },
      "updateKb2919442BinaryPath" : "/nfs/vmware/vcf/nfs-mount/bundle/cd0661c8-f626-41ca-a07b-3e168e386e04/bundle-16029/horizon_install/Windows8.1-KB2919442-x64.msu",
      "updateKb2919355BinaryPath" : "/nfs/vmware/vcf/nfs-mount/bundle/cd0661c8-f626-41ca-a07b-3e168e386e04/bundle-16029/horizon_install/Windows8.1-KB2919355-x64.msu",
      "dotNet462BinaryPath" : "/nfs/vmware/vcf/nfs-mount/bundle/cd0661c8-f626-41ca-a07b-3e168e386e04/bundle-16029/horizon_install/NDP462-KB3151800-x86-x64-AllOS-ENU.exe"
    },
    "sqlConnections" : [ {
      "fqdn" : "sql.horizon-1.local",
      "id" : "sql_av",
      "sqlInstanceName" : "SQLEXPRESS",
      "sqlPort" : 1433,
      "state" : "DEPLOYED",
      "dbUsername" : "av_db_admin",
      "dbPassword" : "Password123!"
    }, {
      "fqdn" : "sql.horizon-1.local",
      "id" : "sql_event",
      "sqlInstanceName" : "SQLEXPRESS",
      "sqlPort" : 1433,
      "state" : "DEPLOYED",
      "dbUsername" : "event_db_admin",
      "dbPassword" : "Password123!"
    }, {
      "fqdn" : "sql.horizon-1.local",
      "id" : "sqlext",
      "state" : "DEPLOYED",
      "dbUsername" : "composer_db_admin1",
      "dbPassword" : "Password123!"
    } ]
  },
  "horizon" : {
    "pods" : [ {
      "eventDbName" : "event-db",
      "sqlId" : "sql_event",
      "vcFqdns" : [ "vcenter-2.vrack.vsphere.local,vcenter-3.vrack.vsphere.local" ],
      "uagAppliances" : [ {
        "vmName" : "uag1",
        "mgmtSubnetMask" : "255.255.0.0",
        "mgmtIpAddress" : "10.0.240.33",
        "externalSubnetMask" : "255.255.0.0",
        "internalSubnetMask" : "255.255.0.0",
        "defaultGateway" : "10.0.0.250",
        "internalIpAddress" : "10.0.240.34",
        "externalIpAddress" : "10.0.240.35",
        "administratorPassword" : "Password123!",
        "state" : "DEPLOYED"
      }, {
        "vmName" : "uag2",
        "mgmtSubnetMask" : "255.255.0.0",
        "mgmtIpAddress" : "10.0.240.37",
        "externalSubnetMask" : "255.255.0.0",
        "internalSubnetMask" : "255.255.0.0",
        "defaultGateway" : "10.0.0.250",
        "internalIpAddress" : "10.0.240.27",
        "externalIpAddress" : "10.0.240.39",
        "administratorPassword" : "Password123!",
        "state" : "NEW"
      } ],
      "connectionServers" : [ {
        "fqdn" : "cs1.horizon-1.local",
        "certificatePath" : "/var/opt/vmware/vcf/solutionsmanager/vdi/ConServCertificate.p12",
        "certificatePassword" : "ATrg9PsA",
        "state" : "DEPLOYED",
        "deployDetails" : {
          "ipAddress" : "10.0.240.20",
          "gateway" : "10.0.0.250",
          "subnetMask" : "255.255.0.0",
          "vmName" : "cs1",
          "computerName" : "cs1"
        }
      }, {
        "fqdn" : "cs2.horizon-1.local",
        "state" : "NEW",
        "deployDetails" : {
          "ipAddress" : "10.0.240.29",
          "gateway" : "10.0.0.250",
          "subnetMask" : "255.255.0.0",
          "vmName" : "cs2",
          "computerName" : "cs2"
        }
      } ],
      "composerServers" : [ {
        "fqdn" : "compsvc1.horizon-1.local",
        "composerServiceAccount" : "horizon-1.local\\compsvc1",
        "composerServicePassword" : "Password123!",
        "sqlId" : "sqlext",
        "dbName" : "internal-db-name",
        "certificatePath" : "/var/opt/vmware/vcf/solutionsmanager/vdi/CompServerCertificate.p12",
        "certificatePassword" : "Password123!",
        "vcFqdn" : "vcenter-2.vrack.vsphere.local",
        "state" : "DEPLOYED",
        "deployDetails" : {
          "ipAddress" : "10.0.240.22",
          "gateway" : "10.0.0.250",
          "subnetMask" : "255.255.0.0",
          "vmName" : "comp-server",
          "computerName" : "compsvc1"
        }
      }, {
        "fqdn" : "compsvc2.horizon-1.local",
        "composerServiceAccount" : "horizon-1.local\\compsvc2",
        "composerServicePassword" : "Password123!",
        "sqlId" : "sqlext",
        "dbName" : "internal-db-name2",
        "vcFqdn" : "vcenter-3.vrack.vsphere.local",
        "state" : "NEW",
        "deployDetails" : {
          "ipAddress" : "10.0.240.28",
          "gateway" : "10.0.0.250",
          "subnetMask" : "255.255.0.0",
          "vmName" : "comp-server2",
          "computerName" : "compsvc2"
        }
      } ]
    } ],
    "internalLbFqdn" : "vipcs.horizon-1.local",
    "externalLbFqdn" : "vipdmz.horizon-1.local",
    "license" : "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
    "adminGroupName" : "horizonadmins",
    "uemDetails" : {
      "uems" : [ {
        "fqdn" : "uem.horizon-1.local",
        "configurationShare" : "/share/drive",
        "profileArchiveShare" : "profileshare",
        "state" : "DEPLOYED",
        "deployDetails" : {
          "dataDriveSizeGb" : 10,
          "configurationShareLocation" : "/share/location",
          "profileArchiveShareLocation" : "/profile/location",
          "ipAddress" : "10.0.240.23",
          "gateway" : "10.0.0.250",
          "subnetMask" : "255.255.0.0",
          "vmName" : "uem-vm",
          "computerName" : "uem"
        }
      } ]
    }
  },
  "appVolumesDetails" : {
    "adminGroupName" : "avadmins",
    "dbName" : "appvol-db-ext",
    "sqlId" : "sql_av",
    "lbFqdn" : "vipav.horizon-1.local",
    "datastores" : [ {
      "id" : "local-0",
      "isPrimary" : true
    } ],
    "appVolumes" : [ {
      "fqdn" : "appv1.horizon-1.local",
      "state" : "DEPLOYED",
      "deployDetails" : {
        "ipAddress" : "10.0.240.24",
        "gateway" : "10.0.0.250",
        "subnetMask" : "255.255.0.0",
        "vmName" : "appv1",
        "computerName" : "appv1"
      }
    }, {
      "fqdn" : "appv1.horizon-2.local",
      "state" : "NEW",
      "deployDetails" : {
        "ipAddress" : "10.0.240.26",
        "gateway" : "10.0.0.250",
        "subnetMask" : "255.255.0.0",
        "vmName" : "appv2",
        "computerName" : "appv2"
      }
    } ]
  }
}

HTTP Response

HTTP/1.1 202 Accepted
Content-Type: application/json;charset=UTF-8
Location: /v1/tasks/2fea8472-98f4-48a9-bb82-8703129fe0fb
Content-Length: 201

{
  "id" : "2fea8472-98f4-48a9-bb82-8703129fe0fb",
  "name" : "Expanding Horizon deployment Horizon Suite Deployment 1",
  "status" : "IN_PROGRESS",
  "creationTimestamp" : "2019-10-12T04:45:21.356Z"
}

  1. Poll the task until "status" is not "IN_PROGRESS" with the ID from the previous response.

Tip
 Refer to: Get a Task.

  • If the "status" is "SUCCESSFUL", the task is completed successfully.

  • If the "status" is "FAILED", the task can be re-executed.

Tip
 Refer to: Retry a Task.
Related APIs

Expand Horizon Suite
Validates Horizon configuration
Get a Task
Retry a Task

2.10.3. Delete Horizon Suite

Delete Horizon Suite workflow will automatically destroy its existing virtual infrastructure (shared components will be excluded). All consumed physical and network resources will be available again.

Important
 This process is not reversible and the whole virtual infrastructure, settings and data will be deleted.
Prerequisites

  1. In order to delete a Horizon Suite, you do not need any specific prerequisites other than Horizon Suite Id.

Steps

Horizon Suite deletion operation is performed as a two steps process in order to avoid accidental deletion of important infrastructure and data. For both steps, the input data is Horizon Suite Id.

  1. Initialize Horizon Suite deletion. This step selects the Horizon Suite for deletion, but does not actually delete any infrastructure components or data.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/horizons/1475a612-f84e-4e51-b1ac-9cbec72b0dce' -i -u 'admin:VMwareInfra@1' -X PATCH \
    -H 'Accept: application/json;charset=UTF-8' \
    -H 'Content-Type: application/json' \
    -d '{
  "markForDeletion" : true
}'

HTTP Request

PATCH /v1/horizons/1475a612-f84e-4e51-b1ac-9cbec72b0dce HTTP/1.1
Accept: application/json;charset=UTF-8
Content-Length: 30
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==
Content-Type: application/json

{
  "markForDeletion" : true
}

HTTP Response

HTTP/1.1 200 OK
Tip
 Refer to Initialize Horizon Suite deletion

  1. Initiate the actual Horizon Suite deletion workflow.

Tip
 Refer to Delete Horizon Suite

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/horizons/1475a612-f84e-4e51-b1ac-9cbec72b0dce' -i -u 'admin:VMwareInfra@1' -X DELETE \
    -H 'Accept: application/json;charset=UTF-8' \
    -H 'Content-Type: application/json'

HTTP Request

DELETE /v1/horizons/1475a612-f84e-4e51-b1ac-9cbec72b0dce HTTP/1.1
Accept: application/json;charset=UTF-8
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==
Content-Type: application/json

HTTP Response

HTTP/1.1 202 Accepted
Location: /v1/tasks/e9e5c5cc-0edf-473a-b7c1-b7fc8dd10dfe
Content-Type: application/json;charset=UTF-8
Content-Length: 200

{
  "id" : "e9e5c5cc-0edf-473a-b7c1-b7fc8dd10dfe",
  "name" : "Removing Horizon deployment Horizon Suite Deployment 1",
  "status" : "IN_PROGRESS",
  "creationTimestamp" : "2019-10-12T04:45:21.060Z"
}

  1. Poll the task until "status" is not "IN_PROGRESS" with the ID from the previous response.

Tip
 Refer to: Get a Task.

  • If the "status" is "SUCCESSFUL", the task is completed successfully.

  • If the "status" is "FAILED", the task can be re-executed.

Tip
 Refer to: Retry a Task.
Related APIs

Initialize Horizon Suite deletion
Delete Horizon Suite
Get a Task
Retry a Task

2.10.4. Validate Horizon Suite Configuration Spec

  • Validation process of Horizon configuration spec has two steps:

    • Semantic pre-validation, which will fail immediately if the posted spec has problems

    • Start in-depth validation workflow, which will elaborately check the integrity of the data in the spec.
      In this case the user should poll for the validation workflow completion and check its findings, when done.

Steps

  1. Prepare your HorizonValidationSpec object, using your Horizon configuration spec and one of the following values for HorizonValidationOperation:

    • for creation of Horizon Suite, use PRE_VALIDATION_CREATION

    • for expansion of Horizon Suite, use PRE_VALIDATION_EXPANSION

Tip
 Refer to HorizonValidationSpec

  1. Pass the HorizonValidationSpec object (as JSON) to the validation API:

Tip
 Refer to Validates Horizon configuration

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/horizons/validations' -i -u 'admin:VMwareInfra@1' -X POST \
    -H 'Accept: application/json;charset=UTF-8' \
    -H 'Content-Type: application/json' \
    -d '{
  "horizon" : {
    "name" : "Horizon Suite Deployment 1",
    "managementVcenters" : [ {
      "clusterName" : "SDDC-Cluster1",
      "datacenterName" : "SDDC-Datacenter",
      "datastoreName" : "sfo01-m01-vsan",
      "dmzPortgroup" : "Horizon-DPortGroup-DMZ",
      "interconnectPortgroup" : "Horizon-DPortGroup-Mgmt",
      "managementPortgroup" : "Horizon-DPortGroup-Mgmt",
      "uagManagementPortgroup" : "Horizon-DPortGroup-Mgmt",
      "nsx" : {
        "host" : "nsxManager.vrack.vsphere.local",
        "password" : "x$7G$7o49x#fs0y"
      },
      "username" : "[email protected]",
      "password" : "d9X!A0F76L942#$",
      "host" : "vcenter-1.vrack.vsphere.local",
      "psc" : {
        "host" : "psc-2.vrack.vsphere.local"
      }
    } ],
    "resourceVcenters" : [ {
      "state" : "NEW",
      "datacenters" : [ {
        "name" : "new-vi-DC",
        "datastores" : [ {
          "name" : "local-0",
          "id" : "local-0",
          "hostIds" : [ "esxi-1" ]
        } ],
        "clusters" : [ {
          "name" : "via-cluster1",
          "hosts" : [ {
            "fqdn" : "esxi-1.vrack.vsphere.local",
            "id" : "esxi-1",
            "username" : "root",
            "password" : "Password!1234"
          } ]
        } ]
      } ],
      "username" : "[email protected]",
      "password" : "x7P#!!G72K820_#",
      "host" : "vcenter-2.vrack.vsphere.local",
      "psc" : {
        "host" : "psc-2.vrack.vsphere.local"
      }
    } ],
    "peripheralServices" : {
      "loadBalancers" : [ {
        "ipAddress" : "10.0.240.30",
        "fqdn" : "vipcs.horizon-1.local",
        "state" : "NEW",
        "deployDetails" : {
          "vmName" : "vipcs",
          "subnetMask" : "255.255.0.0",
          "gateway" : "10.0.0.250",
          "portgroup" : "Horizon-DPortGroup-Mgmt",
          "cliPassword" : "Password123456789!"
        }
      }, {
        "ipAddress" : "10.0.240.31",
        "fqdn" : "vipav.horizon-1.local",
        "state" : "NEW",
        "deployDetails" : {
          "vmName" : "vipav",
          "subnetMask" : "255.255.0.0",
          "gateway" : "10.0.0.250",
          "portgroup" : "Horizon-DPortGroup-Mgmt",
          "cliPassword" : "Password123456789!"
        }
      }, {
        "ipAddress" : "10.0.240.32",
        "fqdn" : "vipdmz.horizon-1.local",
        "state" : "NEW",
        "deployDetails" : {
          "vmName" : "vipdmz",
          "subnetMask" : "255.255.0.0",
          "gateway" : "10.0.0.250",
          "portgroup" : "Horizon-DPortGroup-DMZ",
          "cliPassword" : "Password123456789!"
        }
      } ],
      "activeDirectory" : {
        "fqdn" : "horizon-1.local",
        "netBiosName" : "horizon-1",
        "vdiAdminUsername" : "horizon-1.local\\vdiadmin",
        "vdiAdminPassword" : "Password123!",
        "vdiServerOu" : "OU=vdi,DC=horizon-1,DC=local",
        "ouRwUsername" : "horizon-1.local\\rwadmin",
        "ouRwPassword" : "Password123!",
        "adminUsername" : "horizon-1.local\\administrator",
        "adminPassword" : "Password1!",
        "securedAD" : false,
        "domainControllers" : [ {
          "ipAddress" : "10.0.240.81"
        } ]
      },
      "installDetails" : {
        "imagePath" : "/home/vcf/download/template_new_vmware_tools.ova",
        "connectionServerBinaryPath" : "/nfs/vmware/vcf/nfs-mount/bundle/cd0661c8-f626-41ca-a07b-3e168e386e04/bundle-16029/horizon_install/VMware-Horizon-Connection-Server-x86_64-7.9.0-13956742.exe",
        "composerServerBinaryPath" : "/nfs/vmware/vcf/nfs-mount/bundle/cd0661c8-f626-41ca-a07b-3e168e386e04/bundle-16029/horizon_install/VMware-viewcomposer-7.9.0-13810618.exe",
        "appVolumesServerBinaryPath" : "/nfs/vmware/vcf/nfs-mount/bundle/cd0661c8-f626-41ca-a07b-3e168e386e04/bundle-16029/horizon_install/AppVolumesManager.msi",
        "uagOvaPath" : "/nfs/vmware/vcf/nfs-mount/bundle/cd0661c8-f626-41ca-a07b-3e168e386e04/bundle-16029/horizon_install/euc-unified-access-gateway-3.6.0.0-14019369_OVF10.ova",
        "sqlExpressPath" : "/nfs/vmware/vcf/nfs-mount/bundle/cd0661c8-f626-41ca-a07b-3e168e386e04/bundle-16029/horizon_install/SQLEXPR_x64_ENU.exe",
        "uemBinaryPath" : "/nfs/vmware/vcf/nfs-mount/bundle/cd0661c8-f626-41ca-a07b-3e168e386e04/bundle-16029/horizon_install/VMware User Environment Manager 9.8.0.895 x64.msi",
        "connectionServerVersion" : "7.9.0-13956742",
        "composerServerVersion" : "7.9.0-13810618",
        "appVolumesServerVersion" : "2.17.0",
        "uagOvaVersion" : "3.6.0.0-14019369",
        "sqlExpressVersion" : "2017",
        "uemVersion" : "9.8.0.895",
        "ova" : {
          "administratorUsername" : "administrator",
          "administratorPassword" : "Password1!"
        },
        "updateKb2919442BinaryPath" : "/nfs/vmware/vcf/nfs-mount/bundle/cd0661c8-f626-41ca-a07b-3e168e386e04/bundle-16029/horizon_install/Windows8.1-KB2919442-x64.msu",
        "updateKb2919355BinaryPath" : "/nfs/vmware/vcf/nfs-mount/bundle/cd0661c8-f626-41ca-a07b-3e168e386e04/bundle-16029/horizon_install/Windows8.1-KB2919355-x64.msu",
        "dotNet462BinaryPath" : "/nfs/vmware/vcf/nfs-mount/bundle/cd0661c8-f626-41ca-a07b-3e168e386e04/bundle-16029/horizon_install/NDP462-KB3151800-x86-x64-AllOS-ENU.exe"
      },
      "sqlConnections" : [ {
        "fqdn" : "sql.horizon-1.local",
        "id" : "sql_av",
        "sqlInstanceName" : "SQLEXPRESS",
        "sqlPort" : 1433,
        "state" : "NEW",
        "dbUsername" : "av_db_admin",
        "dbPassword" : "Password123!"
      }, {
        "fqdn" : "sql.horizon-1.local",
        "id" : "sql_event",
        "sqlInstanceName" : "SQLEXPRESS",
        "sqlPort" : 1433,
        "state" : "NEW",
        "dbUsername" : "event_db_admin",
        "dbPassword" : "Password123!"
      }, {
        "fqdn" : "sql.horizon-1.local",
        "id" : "sqlext",
        "state" : "NEW",
        "dbUsername" : "composer_db_admin1",
        "dbPassword" : "Password123!"
      } ]
    },
    "horizon" : {
      "pods" : [ {
        "eventDbName" : "event-db",
        "sqlId" : "sql_event",
        "vcFqdns" : [ "vcenter-2.vrack.vsphere.local" ],
        "uagAppliances" : [ {
          "vmName" : "uag1",
          "mgmtSubnetMask" : "255.255.0.0",
          "mgmtIpAddress" : "10.0.240.33",
          "externalSubnetMask" : "255.255.0.0",
          "internalSubnetMask" : "255.255.0.0",
          "defaultGateway" : "10.0.0.250",
          "internalIpAddress" : "10.0.240.34",
          "externalIpAddress" : "10.0.240.35",
          "administratorPassword" : "Password123!",
          "state" : "NEW"
        } ],
        "connectionServers" : [ {
          "fqdn" : "cs1.horizon-1.local",
          "state" : "NEW",
          "deployDetails" : {
            "ipAddress" : "10.0.240.20",
            "gateway" : "10.0.0.250",
            "subnetMask" : "255.255.0.0",
            "vmName" : "cs1",
            "computerName" : "cs1"
          }
        } ],
        "composerServers" : [ {
          "fqdn" : "compsvc1.horizon-1.local",
          "composerServiceAccount" : "horizon-1.local\\compsvc1",
          "composerServicePassword" : "Password123!",
          "sqlId" : "sqlext",
          "dbName" : "internal-db-name",
          "vcFqdn" : "vcenter-2.vrack.vsphere.local",
          "state" : "NEW",
          "deployDetails" : {
            "ipAddress" : "10.0.240.22",
            "gateway" : "10.0.0.250",
            "subnetMask" : "255.255.0.0",
            "vmName" : "comp-server",
            "computerName" : "compsvc1"
          }
        } ]
      } ],
      "internalLbFqdn" : "vipcs.horizon-1.local",
      "externalLbFqdn" : "vipdmz.horizon-1.local",
      "license" : "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
      "adminGroupName" : "horizonadmins",
      "uemDetails" : {
        "uems" : [ {
          "fqdn" : "uem.horizon-1.local",
          "configurationShare" : "/share/drive",
          "profileArchiveShare" : "profileshare",
          "state" : "NEW",
          "deployDetails" : {
            "dataDriveSizeGb" : 10,
            "configurationShareLocation" : "/share/location",
            "profileArchiveShareLocation" : "/profile/location",
            "ipAddress" : "10.0.240.23",
            "gateway" : "10.0.0.250",
            "subnetMask" : "255.255.0.0",
            "vmName" : "uem-vm",
            "computerName" : "uem"
          }
        } ]
      }
    },
    "appVolumesDetails" : {
      "adminGroupName" : "avadmins",
      "dbName" : "appvol-db-ext",
      "sqlId" : "sql_av",
      "lbFqdn" : "vipav.horizon-1.local",
      "datastores" : [ {
        "id" : "local-0",
        "isPrimary" : true
      } ],
      "appVolumes" : [ {
        "fqdn" : "appv1.horizon-1.local",
        "state" : "NEW",
        "deployDetails" : {
          "ipAddress" : "10.0.240.24",
          "gateway" : "10.0.0.250",
          "subnetMask" : "255.255.0.0",
          "vmName" : "appv1",
          "computerName" : "appv1"
        }
      } ]
    }
  },
  "horizonValidationOperation" : {
    "type" : "PRE_VALIDATION_CREATION"
  }
}'

HTTP Request

POST /v1/horizons/validations HTTP/1.1
Accept: application/json;charset=UTF-8
Host: sddc-manager.sfo01.rainpole.local
Content-Length: 9074
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==
Content-Type: application/json

{
  "horizon" : {
    "name" : "Horizon Suite Deployment 1",
    "managementVcenters" : [ {
      "clusterName" : "SDDC-Cluster1",
      "datacenterName" : "SDDC-Datacenter",
      "datastoreName" : "sfo01-m01-vsan",
      "dmzPortgroup" : "Horizon-DPortGroup-DMZ",
      "interconnectPortgroup" : "Horizon-DPortGroup-Mgmt",
      "managementPortgroup" : "Horizon-DPortGroup-Mgmt",
      "uagManagementPortgroup" : "Horizon-DPortGroup-Mgmt",
      "nsx" : {
        "host" : "nsxManager.vrack.vsphere.local",
        "password" : "x$7G$7o49x#fs0y"
      },
      "username" : "[email protected]",
      "password" : "d9X!A0F76L942#$",
      "host" : "vcenter-1.vrack.vsphere.local",
      "psc" : {
        "host" : "psc-2.vrack.vsphere.local"
      }
    } ],
    "resourceVcenters" : [ {
      "state" : "NEW",
      "datacenters" : [ {
        "name" : "new-vi-DC",
        "datastores" : [ {
          "name" : "local-0",
          "id" : "local-0",
          "hostIds" : [ "esxi-1" ]
        } ],
        "clusters" : [ {
          "name" : "via-cluster1",
          "hosts" : [ {
            "fqdn" : "esxi-1.vrack.vsphere.local",
            "id" : "esxi-1",
            "username" : "root",
            "password" : "Password!1234"
          } ]
        } ]
      } ],
      "username" : "[email protected]",
      "password" : "x7P#!!G72K820_#",
      "host" : "vcenter-2.vrack.vsphere.local",
      "psc" : {
        "host" : "psc-2.vrack.vsphere.local"
      }
    } ],
    "peripheralServices" : {
      "loadBalancers" : [ {
        "ipAddress" : "10.0.240.30",
        "fqdn" : "vipcs.horizon-1.local",
        "state" : "NEW",
        "deployDetails" : {
          "vmName" : "vipcs",
          "subnetMask" : "255.255.0.0",
          "gateway" : "10.0.0.250",
          "portgroup" : "Horizon-DPortGroup-Mgmt",
          "cliPassword" : "Password123456789!"
        }
      }, {
        "ipAddress" : "10.0.240.31",
        "fqdn" : "vipav.horizon-1.local",
        "state" : "NEW",
        "deployDetails" : {
          "vmName" : "vipav",
          "subnetMask" : "255.255.0.0",
          "gateway" : "10.0.0.250",
          "portgroup" : "Horizon-DPortGroup-Mgmt",
          "cliPassword" : "Password123456789!"
        }
      }, {
        "ipAddress" : "10.0.240.32",
        "fqdn" : "vipdmz.horizon-1.local",
        "state" : "NEW",
        "deployDetails" : {
          "vmName" : "vipdmz",
          "subnetMask" : "255.255.0.0",
          "gateway" : "10.0.0.250",
          "portgroup" : "Horizon-DPortGroup-DMZ",
          "cliPassword" : "Password123456789!"
        }
      } ],
      "activeDirectory" : {
        "fqdn" : "horizon-1.local",
        "netBiosName" : "horizon-1",
        "vdiAdminUsername" : "horizon-1.local\\vdiadmin",
        "vdiAdminPassword" : "Password123!",
        "vdiServerOu" : "OU=vdi,DC=horizon-1,DC=local",
        "ouRwUsername" : "horizon-1.local\\rwadmin",
        "ouRwPassword" : "Password123!",
        "adminUsername" : "horizon-1.local\\administrator",
        "adminPassword" : "Password1!",
        "securedAD" : false,
        "domainControllers" : [ {
          "ipAddress" : "10.0.240.81"
        } ]
      },
      "installDetails" : {
        "imagePath" : "/home/vcf/download/template_new_vmware_tools.ova",
        "connectionServerBinaryPath" : "/nfs/vmware/vcf/nfs-mount/bundle/cd0661c8-f626-41ca-a07b-3e168e386e04/bundle-16029/horizon_install/VMware-Horizon-Connection-Server-x86_64-7.9.0-13956742.exe",
        "composerServerBinaryPath" : "/nfs/vmware/vcf/nfs-mount/bundle/cd0661c8-f626-41ca-a07b-3e168e386e04/bundle-16029/horizon_install/VMware-viewcomposer-7.9.0-13810618.exe",
        "appVolumesServerBinaryPath" : "/nfs/vmware/vcf/nfs-mount/bundle/cd0661c8-f626-41ca-a07b-3e168e386e04/bundle-16029/horizon_install/AppVolumesManager.msi",
        "uagOvaPath" : "/nfs/vmware/vcf/nfs-mount/bundle/cd0661c8-f626-41ca-a07b-3e168e386e04/bundle-16029/horizon_install/euc-unified-access-gateway-3.6.0.0-14019369_OVF10.ova",
        "sqlExpressPath" : "/nfs/vmware/vcf/nfs-mount/bundle/cd0661c8-f626-41ca-a07b-3e168e386e04/bundle-16029/horizon_install/SQLEXPR_x64_ENU.exe",
        "uemBinaryPath" : "/nfs/vmware/vcf/nfs-mount/bundle/cd0661c8-f626-41ca-a07b-3e168e386e04/bundle-16029/horizon_install/VMware User Environment Manager 9.8.0.895 x64.msi",
        "connectionServerVersion" : "7.9.0-13956742",
        "composerServerVersion" : "7.9.0-13810618",
        "appVolumesServerVersion" : "2.17.0",
        "uagOvaVersion" : "3.6.0.0-14019369",
        "sqlExpressVersion" : "2017",
        "uemVersion" : "9.8.0.895",
        "ova" : {
          "administratorUsername" : "administrator",
          "administratorPassword" : "Password1!"
        },
        "updateKb2919442BinaryPath" : "/nfs/vmware/vcf/nfs-mount/bundle/cd0661c8-f626-41ca-a07b-3e168e386e04/bundle-16029/horizon_install/Windows8.1-KB2919442-x64.msu",
        "updateKb2919355BinaryPath" : "/nfs/vmware/vcf/nfs-mount/bundle/cd0661c8-f626-41ca-a07b-3e168e386e04/bundle-16029/horizon_install/Windows8.1-KB2919355-x64.msu",
        "dotNet462BinaryPath" : "/nfs/vmware/vcf/nfs-mount/bundle/cd0661c8-f626-41ca-a07b-3e168e386e04/bundle-16029/horizon_install/NDP462-KB3151800-x86-x64-AllOS-ENU.exe"
      },
      "sqlConnections" : [ {
        "fqdn" : "sql.horizon-1.local",
        "id" : "sql_av",
        "sqlInstanceName" : "SQLEXPRESS",
        "sqlPort" : 1433,
        "state" : "NEW",
        "dbUsername" : "av_db_admin",
        "dbPassword" : "Password123!"
      }, {
        "fqdn" : "sql.horizon-1.local",
        "id" : "sql_event",
        "sqlInstanceName" : "SQLEXPRESS",
        "sqlPort" : 1433,
        "state" : "NEW",
        "dbUsername" : "event_db_admin",
        "dbPassword" : "Password123!"
      }, {
        "fqdn" : "sql.horizon-1.local",
        "id" : "sqlext",
        "state" : "NEW",
        "dbUsername" : "composer_db_admin1",
        "dbPassword" : "Password123!"
      } ]
    },
    "horizon" : {
      "pods" : [ {
        "eventDbName" : "event-db",
        "sqlId" : "sql_event",
        "vcFqdns" : [ "vcenter-2.vrack.vsphere.local" ],
        "uagAppliances" : [ {
          "vmName" : "uag1",
          "mgmtSubnetMask" : "255.255.0.0",
          "mgmtIpAddress" : "10.0.240.33",
          "externalSubnetMask" : "255.255.0.0",
          "internalSubnetMask" : "255.255.0.0",
          "defaultGateway" : "10.0.0.250",
          "internalIpAddress" : "10.0.240.34",
          "externalIpAddress" : "10.0.240.35",
          "administratorPassword" : "Password123!",
          "state" : "NEW"
        } ],
        "connectionServers" : [ {
          "fqdn" : "cs1.horizon-1.local",
          "state" : "NEW",
          "deployDetails" : {
            "ipAddress" : "10.0.240.20",
            "gateway" : "10.0.0.250",
            "subnetMask" : "255.255.0.0",
            "vmName" : "cs1",
            "computerName" : "cs1"
          }
        } ],
        "composerServers" : [ {
          "fqdn" : "compsvc1.horizon-1.local",
          "composerServiceAccount" : "horizon-1.local\\compsvc1",
          "composerServicePassword" : "Password123!",
          "sqlId" : "sqlext",
          "dbName" : "internal-db-name",
          "vcFqdn" : "vcenter-2.vrack.vsphere.local",
          "state" : "NEW",
          "deployDetails" : {
            "ipAddress" : "10.0.240.22",
            "gateway" : "10.0.0.250",
            "subnetMask" : "255.255.0.0",
            "vmName" : "comp-server",
            "computerName" : "compsvc1"
          }
        } ]
      } ],
      "internalLbFqdn" : "vipcs.horizon-1.local",
      "externalLbFqdn" : "vipdmz.horizon-1.local",
      "license" : "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
      "adminGroupName" : "horizonadmins",
      "uemDetails" : {
        "uems" : [ {
          "fqdn" : "uem.horizon-1.local",
          "configurationShare" : "/share/drive",
          "profileArchiveShare" : "profileshare",
          "state" : "NEW",
          "deployDetails" : {
            "dataDriveSizeGb" : 10,
            "configurationShareLocation" : "/share/location",
            "profileArchiveShareLocation" : "/profile/location",
            "ipAddress" : "10.0.240.23",
            "gateway" : "10.0.0.250",
            "subnetMask" : "255.255.0.0",
            "vmName" : "uem-vm",
            "computerName" : "uem"
          }
        } ]
      }
    },
    "appVolumesDetails" : {
      "adminGroupName" : "avadmins",
      "dbName" : "appvol-db-ext",
      "sqlId" : "sql_av",
      "lbFqdn" : "vipav.horizon-1.local",
      "datastores" : [ {
        "id" : "local-0",
        "isPrimary" : true
      } ],
      "appVolumes" : [ {
        "fqdn" : "appv1.horizon-1.local",
        "state" : "NEW",
        "deployDetails" : {
          "ipAddress" : "10.0.240.24",
          "gateway" : "10.0.0.250",
          "subnetMask" : "255.255.0.0",
          "vmName" : "appv1",
          "computerName" : "appv1"
        }
      } ]
    }
  },
  "horizonValidationOperation" : {
    "type" : "PRE_VALIDATION_CREATION"
  }
}

HTTP Response

HTTP/1.1 202 Accepted
Content-Length: 132
Location: /v1/horizons/validations/d73756ee-fd62-46b0-9ce0-59b48bb0a259
Content-Type: application/json;charset=UTF-8

{
  "id" : "d73756ee-fd62-46b0-9ce0-59b48bb0a259",
  "description" : "PREVALIDATE_VDI_DOMAIN",
  "executionStatus" : "IN_PROGRESS"
}

  1. Check the API call result - if the API call fails immediately, check the returned result to determine if the semantic validation has failed. In case the API call is successful, a validation workflow will be started. The user should poll for the workflow completion (using its Id, returned by the starting API call). Upon completion, detailed information will be provided for the performed validation steps and their status.

Tip
 Refer to Get Horizon Validation
Important
 It is crucial to distinguish the successful completion of the validation workflow and the success of all steps in it (some steps may fail, others may succeed). In order to continue, all validation steps should succeed.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/horizons/validations/9aa41f72-8e92-48c1-a400-151745928ce5' -i -u 'admin:VMwareInfra@1' -X GET \
    -H 'Accept: application/json;charset=UTF-8' \
    -H 'Content-Type: application/json'

HTTP Request

GET /v1/horizons/validations/9aa41f72-8e92-48c1-a400-151745928ce5 HTTP/1.1
Accept: application/json;charset=UTF-8
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==
Content-Type: application/json

HTTP Response

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 19963

{
  "id" : "d73756ee-fd62-46b0-9ce0-59b48bb0a259",
  "description" : "PREVALIDATE_VDI_DOMAIN",
  "executionStatus" : "COMPLETED",
  "resultStatus" : "FAILED",
  "validationChecks" : [ {
    "description" : "Files Validation",
    "severity" : "INFO",
    "resultStatus" : "SUCCEEDED",
    "nestedValidationChecks" : [ {
      "description" : "Validate files existence and permissions",
      "severity" : "INFO",
      "resultStatus" : "SUCCEEDED",
      "nestedValidationChecks" : [ {
        "description" : "Validation if file /nfs/vmware/vcf/nfs-mount/bundle/1c563584-1369-4c9e-988b-01d218c81a3a/bundle-15005/horizon_install/VMware-Horizon-Connection-Server-x86_64-7.9.0-13956742.exe exists and has all required permissions",
        "severity" : "INFO",
        "resultStatus" : "SUCCEEDED"
      }, {
        "description" : "Validation if file /nfs/vmware/vcf/nfs-mount/bundle/1c563584-1369-4c9e-988b-01d218c81a3a/bundle-15005/horizon_install/VMware-viewcomposer-7.9.0-13810618.exe exists and has all required permissions",
        "severity" : "INFO",
        "resultStatus" : "SUCCEEDED"
      }, {
        "description" : "Validation if file /nfs/vmware/vcf/nfs-mount/bundle/1c563584-1369-4c9e-988b-01d218c81a3a/bundle-15005/horizon_install/AppVolumesManager.msi exists and has all required permissions",
        "severity" : "INFO",
        "resultStatus" : "SUCCEEDED"
      }, {
        "description" : "Validation if file /nfs/vmware/vcf/nfs-mount/bundle/1c563584-1369-4c9e-988b-01d218c81a3a/bundle-15005/horizon_install/euc-unified-access-gateway-3.6.0.0-14019369_OVF10.ova exists and has all required permissions",
        "severity" : "INFO",
        "resultStatus" : "SUCCEEDED"
      }, {
        "description" : "Validation if file /nfs/vmware/vcf/nfs-mount/bundle/1c563584-1369-4c9e-988b-01d218c81a3a/bundle-15005/horizon_install/SQLEXPR_x64_ENU.exe exists and has all required permissions",
        "severity" : "INFO",
        "resultStatus" : "SUCCEEDED"
      }, {
        "description" : "Validation if file /nfs/vmware/vcf/nfs-mount/bundle/1c563584-1369-4c9e-988b-01d218c81a3a/bundle-15005/horizon_install/VMware User Environment Manager 9.8.0.895 x64.msi exists and has all required permissions",
        "severity" : "INFO",
        "resultStatus" : "SUCCEEDED"
      }, {
        "description" : "Validation if file /nfs/vmware/vcf/nfs-mount/bundle/1c563584-1369-4c9e-988b-01d218c81a3a/bundle-15005/horizon_install/Windows8.1-KB2919442-x64.msu exists and has all required permissions",
        "severity" : "INFO",
        "resultStatus" : "SUCCEEDED"
      }, {
        "description" : "Validation if file /nfs/vmware/vcf/nfs-mount/bundle/1c563584-1369-4c9e-988b-01d218c81a3a/bundle-15005/horizon_install/Windows8.1-KB2919355-x64.msu exists and has all required permissions",
        "severity" : "INFO",
        "resultStatus" : "SUCCEEDED"
      }, {
        "description" : "Validation if file /nfs/vmware/vcf/nfs-mount/bundle/1c563584-1369-4c9e-988b-01d218c81a3a/bundle-15005/horizon_install/NDP462-KB3151800-x86-x64-AllOS-ENU.exe exists and has all required permissions",
        "severity" : "INFO",
        "resultStatus" : "SUCCEEDED"
      } ]
    } ]
  }, {
    "description" : "Network Validation",
    "severity" : "INFO",
    "resultStatus" : "SUCCEEDED",
    "nestedValidationChecks" : [ {
      "description" : "Validate provided NSX details",
      "severity" : "INFO",
      "resultStatus" : "SUCCEEDED",
      "nestedValidationChecks" : [ {
        "description" : "Validation of connection to NSX nsxManager.vrack.vsphere.local with user admin",
        "severity" : "INFO",
        "resultStatus" : "SUCCEEDED"
      } ]
    }, {
      "description" : "Validate that IP address is not in provided network (CIDR Notation)",
      "severity" : "INFO",
      "resultStatus" : "SUCCEEDED",
      "nestedValidationChecks" : [ {
        "description" : "Validation if IP 10.0.240.31 is not in network 10.0.0.0/22",
        "severity" : "INFO",
        "resultStatus" : "SUCCEEDED"
      }, {
        "description" : "Validation if IP 10.0.240.32 is not in network 10.0.0.0/22",
        "severity" : "INFO",
        "resultStatus" : "SUCCEEDED"
      }, {
        "description" : "Validation if IP 10.0.240.30 is not in network 10.0.0.0/22",
        "severity" : "INFO",
        "resultStatus" : "SUCCEEDED"
      } ]
    }, {
      "description" : "Validate IP uniqueness within the provided IP addresses and FQDNs",
      "severity" : "INFO",
      "resultStatus" : "SUCCEEDED",
      "nestedValidationChecks" : [ {
        "description" : "Validation if IP 10.0.0.105 resolved from FQDN esxi-6.vrack.vsphere.local is unique within the configuration",
        "severity" : "INFO",
        "resultStatus" : "SUCCEEDED"
      }, {
        "description" : "Validation if IP 10.0.0.9 resolved from FQDN nsxManager.vrack.vsphere.local is unique within the configuration",
        "severity" : "INFO",
        "resultStatus" : "SUCCEEDED"
      }, {
        "description" : "Validation if IP 10.0.0.6 resolved from FQDN vcenter-1.vrack.vsphere.local is unique within the configuration",
        "severity" : "INFO",
        "resultStatus" : "SUCCEEDED"
      }, {
        "description" : "Validation if IP 10.0.0.104 resolved from FQDN esxi-5.vrack.vsphere.local is unique within the configuration",
        "severity" : "INFO",
        "resultStatus" : "SUCCEEDED"
      }, {
        "description" : "Validation if IP 10.0.0.5 resolved from FQDN psc-1.vrack.vsphere.local is unique within the configuration",
        "severity" : "INFO",
        "resultStatus" : "SUCCEEDED"
      }, {
        "description" : "Validation if IP 10.0.0.106 resolved from FQDN esxi-7.vrack.vsphere.local is unique within the configuration",
        "severity" : "INFO",
        "resultStatus" : "SUCCEEDED"
      }, {
        "description" : "Validation if IP 10.0.0.43 resolved from FQDN vcenter-2.vrack.vsphere.local is unique within the configuration",
        "severity" : "INFO",
        "resultStatus" : "SUCCEEDED"
      } ]
    } ]
  }, {
    "description" : "AD Validation",
    "severity" : "ERROR",
    "resultStatus" : "FAILED",
    "errorResponse" : {
      "errorCode" : "AD_VALIDATION",
      "arguments" : [ ],
      "context" : {
        "bundleName" : "com.vmware.evo.sddc.common.validation.errors.messages",
        "severity" : "ERROR"
      },
      "message" : "AD Validation",
      "causes" : [ ]
    },
    "nestedValidationChecks" : [ {
      "description" : "Validate if a connection can be established to provided DC IP addresses",
      "severity" : "ERROR",
      "resultStatus" : "FAILED",
      "errorResponse" : {
        "errorCode" : "AD_CONNECTIVITY_VALIDATION",
        "arguments" : [ ],
        "context" : {
          "bundleName" : "com.vmware.evo.sddc.common.validation.errors.messages",
          "severity" : "ERROR"
        },
        "message" : "Validate if a connection can be established to provided DC IP addresses",
        "causes" : [ ]
      },
      "nestedValidationChecks" : [ {
        "description" : "Connection to 10.0.1.253 with username [email protected]",
        "severity" : "ERROR",
        "resultStatus" : "FAILED",
        "errorResponse" : {
          "errorCode" : "AD_CONNECTIVITY.error",
          "arguments" : [ "10.0.1.253", "[email protected]" ],
          "context" : {
            "bundleName" : "com.vmware.evo.sddc.common.validation.errors.messages",
            "severity" : "ERROR"
          },
          "message" : "Authentication with Active Directory 10.0.1.253 failed for user [email protected]. Please check network connectivity and credentials correctness",
          "causes" : [ ]
        }
      }, {
        "description" : "Connection to 10.0.1.253 with username [email protected]",
        "severity" : "ERROR",
        "resultStatus" : "FAILED",
        "errorResponse" : {
          "errorCode" : "AD_CONNECTIVITY.error",
          "arguments" : [ "10.0.1.253", "[email protected]" ],
          "context" : {
            "bundleName" : "com.vmware.evo.sddc.common.validation.errors.messages",
            "severity" : "ERROR"
          },
          "message" : "Authentication with Active Directory 10.0.1.253 failed for user [email protected]. Please check network connectivity and credentials correctness",
          "causes" : [ ]
        }
      }, {
        "description" : "Connection to 10.0.1.253 with username [email protected]",
        "severity" : "ERROR",
        "resultStatus" : "FAILED",
        "errorResponse" : {
          "errorCode" : "AD_CONNECTIVITY.error",
          "arguments" : [ "10.0.1.253", "[email protected]" ],
          "context" : {
            "bundleName" : "com.vmware.evo.sddc.common.validation.errors.messages",
            "severity" : "ERROR"
          },
          "message" : "Authentication with Active Directory 10.0.1.253 failed for user [email protected]. Please check network connectivity and credentials correctness",
          "causes" : [ ]
        }
      } ]
    }, {
      "description" : "Validate if the provided AD name matches the DN retrieved from the AD",
      "severity" : "ERROR",
      "resultStatus" : "FAILED",
      "errorResponse" : {
        "errorCode" : "AD_NAME_VALIDATION",
        "arguments" : [ ],
        "context" : {
          "bundleName" : "com.vmware.evo.sddc.common.validation.errors.messages",
          "severity" : "ERROR"
        },
        "message" : "Validate if the provided AD name matches the DN retrieved from the AD",
        "causes" : [ ]
      },
      "nestedValidationChecks" : [ {
        "description" : "Connection to 10.0.1.253 with username [email protected]",
        "severity" : "ERROR",
        "resultStatus" : "FAILED",
        "errorResponse" : {
          "errorCode" : "AD_CONNECTIVITY.error",
          "arguments" : [ "10.0.1.253", "[email protected]" ],
          "context" : {
            "bundleName" : "com.vmware.evo.sddc.common.validation.errors.messages",
            "severity" : "ERROR"
          },
          "message" : "Authentication with Active Directory 10.0.1.253 failed for user [email protected]. Please check network connectivity and credentials correctness",
          "causes" : [ ]
        }
      } ]
    }, {
      "description" : "Validate if OU exists within the AD. Check user permissions if required",
      "severity" : "ERROR",
      "resultStatus" : "FAILED",
      "errorResponse" : {
        "errorCode" : "AD_OU_VALIDATION",
        "arguments" : [ ],
        "context" : {
          "bundleName" : "com.vmware.evo.sddc.common.validation.errors.messages",
          "severity" : "ERROR"
        },
        "message" : "Validate if OU exists within the AD. Check user permissions if required",
        "causes" : [ ]
      },
      "nestedValidationChecks" : [ {
        "description" : "Connection to 10.0.1.253 with username [email protected]",
        "severity" : "ERROR",
        "resultStatus" : "FAILED",
        "errorResponse" : {
          "errorCode" : "AD_CONNECTIVITY.error",
          "arguments" : [ "10.0.1.253", "[email protected]" ],
          "context" : {
            "bundleName" : "com.vmware.evo.sddc.common.validation.errors.messages",
            "severity" : "ERROR"
          },
          "message" : "Authentication with Active Directory 10.0.1.253 failed for user [email protected]. Please check network connectivity and credentials correctness",
          "causes" : [ ]
        }
      } ]
    }, {
      "description" : "Validate if Computer objects exists within the AD",
      "severity" : "INFO",
      "resultStatus" : "SUCCEEDED"
    }, {
      "description" : "Validate AD Group existence and check user membership if required",
      "severity" : "ERROR",
      "resultStatus" : "FAILED",
      "errorResponse" : {
        "errorCode" : "AD_GROUP_VALIDATION",
        "arguments" : [ ],
        "context" : {
          "bundleName" : "com.vmware.evo.sddc.common.validation.errors.messages",
          "severity" : "ERROR"
        },
        "message" : "Validate AD Group existence and check user membership if required",
        "causes" : [ ]
      },
      "nestedValidationChecks" : [ {
        "description" : "Connection to 10.0.1.253 with username [email protected]",
        "severity" : "ERROR",
        "resultStatus" : "FAILED",
        "errorResponse" : {
          "errorCode" : "AD_CONNECTIVITY.error",
          "arguments" : [ "10.0.1.253", "[email protected]" ],
          "context" : {
            "bundleName" : "com.vmware.evo.sddc.common.validation.errors.messages",
            "severity" : "ERROR"
          },
          "message" : "Authentication with Active Directory 10.0.1.253 failed for user [email protected]. Please check network connectivity and credentials correctness",
          "causes" : [ ]
        }
      } ]
    } ]
  }, {
    "description" : "vCenter Validation",
    "severity" : "INFO",
    "resultStatus" : "SUCCEEDED",
    "nestedValidationChecks" : [ {
      "description" : "Validate provided vSphere details",
      "severity" : "INFO",
      "resultStatus" : "SUCCEEDED",
      "nestedValidationChecks" : [ {
        "description" : "Validation of connection to vcenter-1.vrack.vsphere.local with user [email protected]",
        "severity" : "INFO",
        "resultStatus" : "SUCCEEDED"
      }, {
        "description" : "Validation of connection to vcenter-2.vrack.vsphere.local with user [email protected]",
        "severity" : "INFO",
        "resultStatus" : "SUCCEEDED"
      }, {
        "description" : "Validation of connection to esxi-6.vrack.vsphere.local with user root",
        "severity" : "INFO",
        "resultStatus" : "SUCCEEDED"
      }, {
        "description" : "Validation of connection to esxi-7.vrack.vsphere.local with user root",
        "severity" : "INFO",
        "resultStatus" : "SUCCEEDED"
      }, {
        "description" : "Validation of connection to esxi-5.vrack.vsphere.local with user root",
        "severity" : "INFO",
        "resultStatus" : "SUCCEEDED"
      } ]
    }, {
      "description" : "Validate provided virtual machine names for uniqueness in the vCenter",
      "severity" : "INFO",
      "resultStatus" : "SUCCEEDED"
    }, {
      "description" : "Validate vCenter object existence",
      "severity" : "INFO",
      "resultStatus" : "SUCCEEDED",
      "nestedValidationChecks" : [ {
        "description" : "Validated of vCenter object SDDC-Datacenter with type Datacenter existence within vCenter vcenter-1.vrack.vsphere.local",
        "severity" : "INFO",
        "resultStatus" : "SUCCEEDED"
      }, {
        "description" : "Validated of vCenter object sfo01-m01-vsan with type Datastore existence within vCenter vcenter-1.vrack.vsphere.local",
        "severity" : "INFO",
        "resultStatus" : "SUCCEEDED"
      }, {
        "description" : "Validated of vCenter object SDDC-Cluster1 with type ClusterComputeResource existence within vCenter vcenter-1.vrack.vsphere.local",
        "severity" : "INFO",
        "resultStatus" : "SUCCEEDED"
      }, {
        "description" : "Validated of vCenter object VDI-DPortGroup-Mgmt with type DistributedVirtualPortgroup existence within vCenter vcenter-1.vrack.vsphere.local",
        "severity" : "INFO",
        "resultStatus" : "SUCCEEDED"
      }, {
        "description" : "Validated of vCenter object VDI-DPortGroup-Mgmt with type DistributedVirtualPortgroup existence within vCenter vcenter-1.vrack.vsphere.local",
        "severity" : "INFO",
        "resultStatus" : "SUCCEEDED"
      }, {
        "description" : "Validated of vCenter object VDI-DPortGroup-Mgmt with type DistributedVirtualPortgroup existence within vCenter vcenter-1.vrack.vsphere.local",
        "severity" : "INFO",
        "resultStatus" : "SUCCEEDED"
      }, {
        "description" : "Validated of vCenter object VDI-DPortGroup-DMZ with type DistributedVirtualPortgroup existence within vCenter vcenter-1.vrack.vsphere.local",
        "severity" : "INFO",
        "resultStatus" : "SUCCEEDED"
      }, {
        "description" : "Validated of vCenter object VI1-DC with type Datacenter existence within vCenter vcenter-2.vrack.vsphere.local",
        "severity" : "INFO",
        "resultStatus" : "SUCCEEDED"
      }, {
        "description" : "Validated of vCenter object VI1-vcenter-2-VI1-vsan01 with type Datastore existence within vCenter vcenter-2.vrack.vsphere.local",
        "severity" : "INFO",
        "resultStatus" : "SUCCEEDED"
      }, {
        "description" : "Validated of vCenter object VI1 with type ClusterComputeResource existence within vCenter vcenter-2.vrack.vsphere.local",
        "severity" : "INFO",
        "resultStatus" : "SUCCEEDED"
      }, {
        "description" : "Validated of vCenter object esxi-6.vrack.vsphere.local with type HostSystem existence within vCenter vcenter-2.vrack.vsphere.local",
        "severity" : "INFO",
        "resultStatus" : "SUCCEEDED"
      }, {
        "description" : "Validated of vCenter object esxi-7.vrack.vsphere.local with type HostSystem existence within vCenter vcenter-2.vrack.vsphere.local",
        "severity" : "INFO",
        "resultStatus" : "SUCCEEDED"
      }, {
        "description" : "Validated of vCenter object esxi-5.vrack.vsphere.local with type HostSystem existence within vCenter vcenter-2.vrack.vsphere.local",
        "severity" : "INFO",
        "resultStatus" : "SUCCEEDED"
      } ]
    }, {
      "description" : "Validate if provided Portgroups does not match management vCenter portgroup",
      "severity" : "INFO",
      "resultStatus" : "SUCCEEDED",
      "nestedValidationChecks" : [ {
        "description" : "Validation that Portgroup VDI-DPortGroup-Mgmt does not match management portgroup",
        "severity" : "INFO",
        "resultStatus" : "SUCCEEDED"
      } ]
    }, {
      "description" : "Validate provided virtual machine inventory paths for existence within the vCenter",
      "severity" : "INFO",
      "resultStatus" : "SUCCEEDED",
      "nestedValidationChecks" : [ {
        "description" : "Validation of VM with inventory path SDDC-Datacenter/vm/vdi-vm-vdi-fa32d995-92ee-4fe4-b817-d0218f993549 existence within vCenter vcenter-1.vrack.vsphere.local",
        "severity" : "INFO",
        "resultStatus" : "SUCCEEDED"
      } ]
    } ]
  }, {
    "description" : "Cluster Resources Validation",
    "severity" : "INFO",
    "resultStatus" : "SUCCEEDED",
    "nestedValidationChecks" : [ {
      "description" : "Validate cluster has enough storage",
      "severity" : "INFO",
      "resultStatus" : "SUCCEEDED",
      "nestedValidationChecks" : [ {
        "description" : "Validation that datastore sfo01-m01-vsan in cluster SDDC-Cluster1 on vCenter vcenter-1.vrack.vsphere.local has enough storage for the VMs that will be deployed",
        "severity" : "INFO",
        "resultStatus" : "SUCCEEDED"
      } ]
    }, {
      "description" : "Validate cluster has enough memory",
      "severity" : "INFO",
      "resultStatus" : "SUCCEEDED",
      "nestedValidationChecks" : [ {
        "description" : "Validation that cluster SDDC-Cluster1 on vCenter vcenter-1.vrack.vsphere.local has enough memory for the VMs that will be deployed",
        "severity" : "INFO",
        "resultStatus" : "SUCCEEDED"
      } ]
    } ]
  }, {
    "description" : "Horizon View Validation",
    "severity" : "INFO",
    "resultStatus" : "SUCCEEDED",
    "nestedValidationChecks" : [ {
      "description" : "Validate Horizon View attached VC configuration",
      "severity" : "INFO",
      "resultStatus" : "SUCCEEDED",
      "nestedValidationChecks" : [ {
        "description" : "Validation of horizon configuration state for VC vcenter-2.vrack.vsphere.local",
        "severity" : "INFO",
        "resultStatus" : "SUCCEEDED"
      } ]
    } ]
  } ]
}
Related APIs

Validates Horizon configuration
Get Horizon Validation

2.11. vRealize Suite Lifecycle Manager

2.11.1. vRealize Suite Lifecycle Manager Deployment

To deploy and manage the vRealize Suite products after the initial greenfield deploy of VMware Cloud Foundation, one must first deploy vRealize Suite Lifecycle Manager. As part of this operation the vRealize network for the vRealize products will be created. To guarantee the success of the vRealize Suite Lifecycle Manager deployment operation one should pre-validate the deployment input.

Prerequisites

  1. The following data is required:

    • Unique vRealize Suite Lifecycle Manager hostname and corresponding IP address from vRealize network

    • vRealize Suite Lifecycle Manager API and root passwords

    • VLAN ID, subnet mask and gateway for the vRealize network

  2. Additional prerequisites:

    • The vRealize Suite Lifecycle Manager bundle needs to be downloaded and applied on the SDDC Manager

    • Prerequisite for the successful vRealize Suite Lifecycle Manager deployment is the vRealize Network to have connectivity to the management VLAN

Note
 vRealize Suite Lifecycle Manager deploy is not available if vRealize Suite Lifecycle Manager is successfully deployed as only one instance of it is allowed in the system. In this case calling the API will produce an error and the user will be provided with information about the allowed HTTP methods for the given endpoint. This information can be found in the "allow" field from the response headers.
Steps

  1. Assemble the vRealize Suite Lifecycle Manager deployment input specification.

Tip
 Refer to VrslcmDeploymentSpec

  1. Trigger the vRealize Suite Lifecycle Manager deployment input specification validations. For help using the vRealize Suite Lifecycle Manager validation API refer to: Get the status of the validations for vRealize Lifecycle Manager deployment

Warning
 The triggered validations return a response containing a validation report ID. With that ID poll the vRealize Suite Lifecycle Manager validations API. While the validations are running the "executionStatus" is "IN_PROGRESS". One should poll the API until the "executionStatus" is "COMPLETED".

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/vrslcms/validations/77c17ee9-7fa6-455f-ace6-602e43c76887' -i -u 'admin:VMwareInfra@1' -X GET \
    -H 'Content-Type: application/json'

HTTP Request

GET /v1/vrslcms/validations/77c17ee9-7fa6-455f-ace6-602e43c76887 HTTP/1.1
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==
Content-Type: application/json

HTTP Response

HTTP/1.1 200 OK
Content-Length: 170
Content-Type: application/json;charset=UTF-8

{
  "id" : "9b56b98b-ba62-42cb-9ac1-f65e2d20ff9c",
  "description" : "Validating vRealize Suite Lifecycle Manager input parameters",
  "executionStatus" : "IN_PROGRESS"
}

  1. Once the validations are completed one can get the overall result of the validations and a detailed list with all checks that have been done and the corresponding status of each check.

    • In case of no errors in the input specification, the "executionStatus" is "COMPLETED" and "resultStatus" is "SUCCEEDED".

    • In case of only warnings in the input specification, the "executionStatus" is "COMPLETED" and "resultStatus" is "FAILED_WITH_WARNINGS".

    • In case of errors in the input specification, the "executionStatus" is "COMPLETED" and "resultStatus" is "FAILED".

Tip
 The validation checks have two severity levels - warning and error; If a failed validation check is marked as an error the issue must be resolved before proceeding with the deployment. If the issue is marked as a warning, one is advised to look at it and do one’s best to fix it. One could ignore it and proceed on one’s risk without fixing it, but this might affect the deployment and make it fail at a later stage.
NOTE: Make changes to the input specification and re-validate using a new API invocation

  1. Once there are no errors and warnings in the validation response one can proceed with the vRealize Suite Lifecycle Manager deployment. Although the warnings are not forced to be resolved one should give one’s best to resolve the uncovered issues by the validations.

  2. Trigger the vRealize Suite Lifecycle Manager deployment. This will start a long-running task which details can be obtained form the HTTP response.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/vrslcms' -i -u 'admin:VMwareInfra@1' -X POST \
    -H 'Content-Type: application/json' \
    -d '{
  "networkSpec" : {
    "vlanId" : "45",
    "subnetMask" : "255.255.252.0",
    "gateway" : "10.0.1.250"
  },
  "fqdn" : "vrslcm.vrack.vsphere.local",
  "sshPassword" : "VMware123!",
  "apiPassword" : "VMware123!"
}'

HTTP Request

POST /v1/vrslcms HTTP/1.1
Host: sddc-manager.sfo01.rainpole.local
Content-Length: 218
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==
Content-Type: application/json

{
  "networkSpec" : {
    "vlanId" : "45",
    "subnetMask" : "255.255.252.0",
    "gateway" : "10.0.1.250"
  },
  "fqdn" : "vrslcm.vrack.vsphere.local",
  "sshPassword" : "VMware123!",
  "apiPassword" : "VMware123!"
}

HTTP Response

HTTP/1.1 202 Accepted
Location: /v1/tasks/9b56b98b-ba62-42cb-9ac1-f65e2d20ff9c
Content-Length: 131
Allow: GET
Content-Type: application/json;charset=UTF-8

{
  "id" : "9b56b98b-ba62-42cb-9ac1-f65e2d20ff9c",
  "status" : "IN_PROGRESS",
  "creationTimestamp" : "2019-05-10T11:13:22.551Z"
}

  1. Track the task status using the "id" from the previous response. The GET URL is set in the header response and can be used directly. Refer to: Get a Task.

    • If the "status" is "IN_PROGRESS", the task is still in progress.

    • If the "status" is "SUCCESSFUL", the task is completed successfully.

    • If the "status" is "FAILED", the task can be re-executed.

Tip
 Refer to: Retry a Task.

If after trying to restart the task the workflow keeps failing one can perform vRealize Suite Lifecycle Manager rollback.

Tip
 Refer to: vRealize Suite Lifecycle Manager Rollback.
Related APIs

Validate the input specification for vRealize Suite Lifecycle Manager deployment
Get the status of the validations for vRealize Lifecycle Manager deployment
Deploy vRealize Suite Lifecycle Manager
Get a Task
Retry a Task

2.11.2. vRealize Suite Lifecycle Manager Rollback

When vRealize Suite Lifecycle Manager deployment fails one can perform rollback to get one’s environment in a clean state and start a fresh vRealize Suite Lifecycle Manager deployment. Note that all vRealize network configurations will be also reverted as part of the vRealize Suite Lifecycle Manager rollback.

Prerequisites

  1. Failed vRealize Suite Lifecycle Manager deployment.

Note
 vRealize Suite Lifecycle Manager rollback is not available if vRealize Suite Lifecycle Manager is successfully deployed. In this case calling the API will produce an error and the user will be provided with information about the allowed HTTP methods for the given endpoint. This information can be found in the "allow" field from the response headers.
Steps

  1. Trigger the vRealize Suite Lifecycle Manager rollback.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/vrslcm' -i -u 'admin:VMwareInfra@1' -X DELETE

HTTP Request

DELETE /v1/vrslcm HTTP/1.1
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==

HTTP Response

HTTP/1.1 202 Accepted
Location: /v1/tasks/9b56b98b-ba62-42cb-9ac1-f65e2d20ff9c
Content-Length: 131
Content-Type: application/json;charset=UTF-8

{
  "id" : "9b56b98b-ba62-42cb-9ac1-f65e2d20ff9c",
  "status" : "IN_PROGRESS",
  "creationTimestamp" : "2019-05-10T11:13:22.551Z"
}

  1. Track the task status using the "id" from the previous response. The GET URL is set in the header response and can be used directly.

Tip
 Refer to: Get a Task.

  • If the "status" is "IN_PROGRESS", the task is still in progress.

  • If the "status" is "SUCCESSFUL", the task is completed successfully.

  • If the "status" is "FAILED", the task can be re-executed.

Tip
 Refer to: Retry a Task.
Related APIs

Get the existing vRealize Suite Lifecycle Manager
Rollback vRealize Suite Lifecycle Manager after unsuccessful deployment
Get a Task
Retry a Task

2.11.3. vRealize Suite Lifecycle Manager Redeployment

If vRealize Suite Lifecycle Manager goes in a corrupted state or if one wishes to get a fresh vRealize Suite Lifecycle Manager without losing the environment information stored inside one can redeploy it.

Prerequisites

  1. vRealize Suite Lifecycle Manager in active state in VCF inventory.

Tip
 vRealize Suite Lifecycle Manager rollback is only available when there is a failed deployment on the environment. In the case when the latter condition is not met calling the API will produce an error and the user will be provided with information about the allowed HTTP methods for the given endpoint. This information can be found in the "allow" field from the response headers.
Steps

  1. Trigger the vRealize Suite Lifecycle Manager redeploy.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/vrslcm' -i -u 'admin:VMwareInfra@1' -X PATCH

HTTP Request

PATCH /v1/vrslcm HTTP/1.1
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==

HTTP Response

HTTP/1.1 202 Accepted
Location: /v1/tasks/9b56b98b-ba62-42cb-9ac1-f65e2d20ff9c
Content-Length: 131
Content-Type: application/json;charset=UTF-8

{
  "id" : "9b56b98b-ba62-42cb-9ac1-f65e2d20ff9c",
  "status" : "IN_PROGRESS",
  "creationTimestamp" : "2019-05-10T11:13:22.551Z"
}

  1. Track the task status using the "id" from the previous response. The GET URL is set in the header response and can be used directly.

Tip
 Refer to: Get a Task.

  • If the "status" is "IN_PROGRESS", the task is still in progress.

  • If the "status" is "SUCCESSFUL", the task is completed successfully.

  • If the "status" is "FAILED", the task can be re-executed.

Tip
 Refer to: Retry a Task.

  1. Once the vRealize Suite Lifecycle Manager redeployment succeeds one can use it to deploy and manage the vRealize Suite products.

Related APIs

Redeploy vRealize Suite Lifecycle Manager
Get the existing vRealize Suite Lifecycle Manager
Get a Task
Retry a Task

2.12. vRealize Operations

2.12.1. Deploy vRealize Operations

vRealize Operations tracks and analyzes the operation of multiple data sources in Cloud Foundation by using specialized analytic algorithms. These algorithms help vRealize Operations learn and predict the behavior of every object it monitors. Users access this information by using views, reports, and dashboards. SDDC Manager automates the deployment of vRealize Operations in Cloud Foundation.

Note
 The vRealize Operations deployment is available only when it is not deployed. After successful deployment the deploy operation becomes unavailable.
Prerequisites

  1. The following data is required:

    • The IP allocation and forward/reverse DNS records are prepared the vRealize Operations components.

    • The password for the vRealize Operations system administrator.

  1. Additional prerequisites:

    • There is a valid license key for vRealize Operations.

Tip
 Refer to: Get a License Key, Add a License Key.

  • vRealize Suite Lifecycle Manager is deployed and in "Active" state.

Tip
 Refer to: Get the existing vRealize Suite Lifecycle Manager, vRealize Suite Lifecycle Manager Deployment

  • The vRealize Operations bundle is downloaded from the VMware Depot and applied on SDDC Manager.

Tip
 Refer to: Upload a Bundle
Steps

  1. Assemble the vRealize Operations deployment input specification

Tip
 Refer to: VropsDeploymentSpec.

  1. Trigger the vRealize Operations deployment input specification validations.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/vropses/validations' -i -u 'admin:VMwareInfra@1' -X POST \
    -H 'Content-Type: application/json' \
    -d '{
  "vropsDeploymentSpec" : {
    "nodes" : [ {
      "fqdn" : "vrops-master.vrack.vsphere.local",
      "type" : "MASTER"
    }, {
      "fqdn" : "vrops-replica.vrack.vsphere.local",
      "type" : "REPLICA"
    } ],
    "enableHa" : false,
    "vrealizeEdgeFqdn" : "vrealize-edge.vrack.vsphere.local",
    "apiPassword" : "VMware123!",
    "licenseKey" : "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
    "nodeSize" : "medium",
    "loadBalancerFqdn" : "vrops-lb.vrack.vsphere.local"
  }
}'

HTTP Request

POST /v1/vropses/validations HTTP/1.1
Host: sddc-manager.sfo01.rainpole.local
Content-Length: 478
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==
Content-Type: application/json

{
  "vropsDeploymentSpec" : {
    "nodes" : [ {
      "fqdn" : "vrops-master.vrack.vsphere.local",
      "type" : "MASTER"
    }, {
      "fqdn" : "vrops-replica.vrack.vsphere.local",
      "type" : "REPLICA"
    } ],
    "enableHa" : false,
    "vrealizeEdgeFqdn" : "vrealize-edge.vrack.vsphere.local",
    "apiPassword" : "VMware123!",
    "licenseKey" : "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
    "nodeSize" : "medium",
    "loadBalancerFqdn" : "vrops-lb.vrack.vsphere.local"
  }
}

HTTP Response

HTTP/1.1 202 Accepted
Content-Length: 127
Content-Type: application/json;charset=UTF-8

{
  "id" : "123e4567-e89b-12d3-a456-556642440000",
  "description" : "vROps Validations",
  "executionStatus" : "IN_PROGRESS"
}
Warning
 The triggered validations return a response containing a validation report ID. With that ID poll the vRealize Operations validations API. While the validations are running the "executionStatus" is "IN_PROGRESS". One should poll the API until the "executionStatus" is "COMPLETED".

  1. Once the validations are completed one can get the overall result of the validations and a detailed list with all checks that have been done and the corresponding status of each check.

    • In case of no errors in the input specification, the "executionStatus" is "COMPLETED" and "resultStatus" is "SUCCEEDED".

    • In case of only warnings in the input specification, the "executionStatus" is "COMPLETED" and "resultStatus" is "FAILED_WITH_WARNINGS".

    • In case of errors in the input specification, the "executionStatus" is "COMPLETED" and "resultStatus" is "FAILED".

Tip
 For help using the vRealize Operations validation API refer to: Get the status of the validations for vRealize Operations
Tip
 The validation checks have two severity levels - warning and error; If a failed validation check is marked as an error the issue must be resolved before proceeding with the deployment. If the issue is marked as a warning, one is advised to look at it and do one’s best to fix it. One could ignore it and proceed on one’s risk without fixing it, but this might affect the deployment and make it fail at a later stage.

  1. Trigger the vRealize Operations deployment.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/vropses' -i -u 'admin:VMwareInfra@1' -X POST \
    -H 'Content-Type: application/json' \
    -d '{
  "nodes" : [ {
    "fqdn" : "vrops-master.vrack.vsphere.local",
    "type" : "MASTER"
  }, {
    "fqdn" : "vrops-replica.vrack.vsphere.local",
    "type" : "REPLICA"
  } ],
  "enableHa" : true,
  "vrealizeEdgeFqdn" : "vrealize-edge.vrack.vsphere.local",
  "apiPassword" : "VMware123!",
  "licenseKey" : "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
  "nodeSize" : "medium",
  "loadBalancerFqdn" : "vrops-lb.vrack.vsphere.local"
}'

HTTP Request

POST /v1/vropses HTTP/1.1
Host: sddc-manager.sfo01.rainpole.local
Content-Length: 419
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==
Content-Type: application/json

{
  "nodes" : [ {
    "fqdn" : "vrops-master.vrack.vsphere.local",
    "type" : "MASTER"
  }, {
    "fqdn" : "vrops-replica.vrack.vsphere.local",
    "type" : "REPLICA"
  } ],
  "enableHa" : true,
  "vrealizeEdgeFqdn" : "vrealize-edge.vrack.vsphere.local",
  "apiPassword" : "VMware123!",
  "licenseKey" : "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
  "nodeSize" : "medium",
  "loadBalancerFqdn" : "vrops-lb.vrack.vsphere.local"
}

HTTP Response

HTTP/1.1 202 Accepted
Location: /v1/tasks/9b56b98b-ba62-42cb-9ac1-f65e2d20ff9c
Content-Length: 131
Allow: GET
Content-Type: application/json;charset=UTF-8

{
  "id" : "9b56b98b-ba62-42cb-9ac1-f65e2d20ff9c",
  "status" : "IN_PROGRESS",
  "creationTimestamp" : "2019-05-10T11:13:22.551Z"
}
Note
 This deployment is a long-running task which details can be obtained form the HTTP response.

  1. Track the task status using the "id" from the previous response.

Tip
 Refer to: Get a Task.

  • If the "status" is "IN_PROGRESS", the task is still in progress.

  • If the "status" is "SUCCESSFUL", the task is completed successfully.

  • If the "status" is "FAILED", the task can be re-executed.

Tip
 For task re-execution refer to: Retry a Task.

  1. If after trying to restart the task the workflow keeps failing one can perform vRealize Operations rollback.

Tip
 For rollback refer to: Rollback vRealize Operations.
Related APIs

Deploy vRealize Operations
Get the existing vRealize Suite Lifecycle Manager
Get a License Key by key
Add a License Key
Validate vRealize Operations Input Specification
Get the status of the validations for vRealize Operations
Get the Tasks
Get a Task
Get the existing vRealize Suite Lifecycle Manager
Retry a Task
Rollback vRealize Operations

2.12.2. Rollback vRealize Operations

Failed vRealize Operations deployment can be rolled back to get the environment in a clean state and start a fresh vRealize Operations deployment.

Prerequisites

  • Failed deployment of vRealize Operations.

Tip
 vRealize Operations rollback is not available if vRealize Operations is successfully deployed. In this case calling the API will produce an error and the user will be provided with information about the allowed HTTP methods for the given endpoint. This information can be found in the "allow" field from the response headers.
Steps

  1. Trigger the vRealize Operations rollback.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/vrops' -i -u 'admin:VMwareInfra@1' -X DELETE

HTTP Request

DELETE /v1/vrops HTTP/1.1
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==

HTTP Response

HTTP/1.1 202 Accepted
Location: /v1/tasks/9b56b98b-ba62-42cb-9ac1-f65e2d20ff9c
Content-Length: 131
Content-Type: application/json;charset=UTF-8

{
  "id" : "9b56b98b-ba62-42cb-9ac1-f65e2d20ff9c",
  "status" : "IN_PROGRESS",
  "creationTimestamp" : "2019-05-10T11:13:22.551Z"
}

  1. Track the task status using the "id" from the previous response. The GET URL is set in the header response and can be used directly.

Tip
 Refer to: Get a Task.

  • If the "status" is "IN_PROGRESS", the task is still in progress.

  • If the "status" is "SUCCESSFUL", the task is completed successfully.

  • If the "status" is "FAILED", the task can be re-executed.

Tip
 Refer to: Retry a Task.
Related APIs

Get the existing vRealize Operations
Rollback vRealize Operations
Get a Task
Retry a Task

2.12.3. Expand vRealize Operations by adding a new data node

When your vRealize Operations analytics cluster needs more resources, you can add additional data node.

Note
 You can use this procedure to expand the size of the vRealize Operations analytics cluster one node at a time. If the maximum number of nodes is exceeded, an error will be returned.
Prerequisites

  1. The vRealize Operations is deployed and in "Active" state.

Tip
 Refer to: Get the existing vRealize Operations, Deploy vRealize Operations

  1. The datastore has enough disk space for the new node.

  2. Forward and reverse DNS resolution is working for the FQDN of the new node.

  3. The IP address for the new node is in the same subnet as the existing vRealize Operations nodes.

  4. By default, the new node uses the master node’s password. Provide password if you want to use a different password for the new node. (Optional)

  5. The type for the new node should be set to "DATA".

Steps

  1. Assemble the vRealize Operations specification for the new data node.

Tip
 Refer to: VropsNode

  1. Trigger the vRealize Operations expansion input specification validations.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/vropses/validations' -i -u 'admin:VMwareInfra@1' -X POST \
    -H 'Content-Type: application/json' \
    -d '{
  "vropsExpansionSpec" : {
    "password" : "VMware123!",
    "fqdn" : "vrops-node.vrack.vsphere.local",
    "type" : "DATA"
  }
}'

HTTP Request

POST /v1/vropses/validations HTTP/1.1
Host: sddc-manager.sfo01.rainpole.local
Content-Length: 132
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==
Content-Type: application/json

{
  "vropsExpansionSpec" : {
    "password" : "VMware123!",
    "fqdn" : "vrops-node.vrack.vsphere.local",
    "type" : "DATA"
  }
}

HTTP Response

HTTP/1.1 202 Accepted
Content-Length: 127
Content-Type: application/json;charset=UTF-8

{
  "id" : "123e4567-e89b-12d3-a456-556642440000",
  "description" : "vROps Validations",
  "executionStatus" : "IN_PROGRESS"
}

  1. Once the validations are completed one can get the overall result of the validations and a detailed list with all checks that have been done and the corresponding status of each check.

    • In case of no errors in the input specification, the "executionStatus" is "COMPLETED" and "resultStatus" is "SUCCEEDED".

    • In case of only warnings in the input specification, the "executionStatus" is "COMPLETED" and "resultStatus" is "FAILED_WITH_WARNINGS".

    • In case of errors in the input specification, the "executionStatus" is "COMPLETED" and "resultStatus" is "FAILED".

Tip
 For help using the vRealize Operations validation API refer to: Get the status of the validations for vRealize Operations
Tip
 The validation checks have two severity levels - warning and error; If a failed validation check is marked as an error the issue must be resolved before proceeding with the deployment. If the issue is marked as a warning, one is advised to look at it and do one’s best to fix it. One could ignore it and proceed on one’s risk without fixing it, but this might affect the deployment and make it fail at a later stage.

  1. Invoke the add node API

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/vrops/nodes' -i -u 'admin:VMwareInfra@1' -X POST \
    -H 'Content-Type: application/json' \
    -d '{
  "fqdn" : "vrops-node.vrack.vsphere.local",
  "type" : "DATA"
}'

HTTP Request

POST /v1/vrops/nodes HTTP/1.1
Host: sddc-manager.sfo01.rainpole.local
Content-Length: 66
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==
Content-Type: application/json

{
  "fqdn" : "vrops-node.vrack.vsphere.local",
  "type" : "DATA"
}

HTTP Response

HTTP/1.1 202 Accepted
Location: /v1/tasks/9b56b98b-ba62-42cb-9ac1-f65e2d20ff9c
Content-Length: 131
Content-Type: application/json;charset=UTF-8

{
  "id" : "9b56b98b-ba62-42cb-9ac1-f65e2d20ff9c",
  "status" : "IN_PROGRESS",
  "creationTimestamp" : "2019-05-10T11:13:22.551Z"
}
Note
 This will start is a long-running task which details can be obtained form the HTTP response.

  1. Track the task status using the "id" from the previous response.

Tip
 Refer to: Get a Task.

  • If the "status" is "IN_PROGRESS", the task is still in progress.

  • If the "status" is "SUCCESSFUL", the task is completed successfully.

  • If the "status" is "FAILED", the task can be re-executed.

Tip
 For task re-execution refer to: Retry a Task.

  1. If after trying to restart the task the workflow keeps failing one can perform rollback.

Tip
 For rollback refer to: Rollback failed vRealize Operations expansion.
Related APIs

Expand vRealize Operations by adding a new DATA node
Get the existing vRealize Operations
Validate vRealize Operations Input Specification
Get the Tasks
Get a Task
Retry a Task

2.12.4. Rollback failed vRealize Operations expansion

Failed vRealize Operations expansion can be rolled back to get the environment in a clean state and start a fresh vRealize Operations expand operation.

Prerequisites

  • The vRealize Operations cluster in a healthy state.

  • Failed data node during expansion of vRealize Operations cluster.

Tip
 vRealize Operations add node rollback is not available if there is no failed add node operation and node in failed state.
Steps

  1. Find the ID of the failed vRealize Operations data node

Tip
 Refer to: Get the existing vRealize Operations, Get all vRealize Operations nodes

  1. Trigger the vRealize Operations Add Node rollback.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/vrops/nodes/c2c3a1c6-1e90-4a6d-9f8e-56aaf41f2eda' -i -u 'admin:VMwareInfra@1' -X DELETE \
    -H 'Content-Type: application/json'

HTTP Request

DELETE /v1/vrops/nodes/c2c3a1c6-1e90-4a6d-9f8e-56aaf41f2eda HTTP/1.1
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==
Content-Type: application/json

HTTP Response

HTTP/1.1 202 Accepted
Content-Length: 131
Content-Type: application/json;charset=UTF-8

{
  "id" : "9b56b98b-ba62-42cb-9ac1-f65e2d20ff9c",
  "status" : "IN_PROGRESS",
  "creationTimestamp" : "2019-05-10T11:13:22.551Z"
}

  1. Track the task status using the "id" from the previous response. The GET URL is set in the header response and can be used directly.

Tip
 Refer to: Get a Task.

  • If the "status" is "IN_PROGRESS", the task is still in progress.

  • If the "status" is "SUCCESSFUL", the task is completed successfully.

  • If the "status" is "FAILED", the task can be re-executed.

Tip
 Refer to: Retry a Task.
Related APIs

Get the existing vRealize Operations
Get all vRealize Operations nodes
Rollback after failed vRealize Operations expansion
Get a Task
Retry a Task

2.12.5. Connect vRealize Operations to workload domain

You can connect vRealize Operations product deployment in Cloud Foundation to your workload domains.

Prerequisites

  1. Before you can connect the managment domain or workload domains to vRealize Operations, it must be deployed and in "ACTIVE" state.

Tip
 For more information refer to Get the existing vRealize Operations, Deploy vRealize Operations
Steps

  1. Assemble the vRealize Operations domain specification.

Tip
 Refer to DomainIntegration

  1. Trigger the vRealize Operations domain connection.

Tip
 For help using the vRealize Log Insight domain connection API refer to: Connect/disconnect workload domains with vRealize Operations

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/vrops/domains' -i -u 'admin:VMwareInfra@1' -X PUT \
    -H 'Content-Type: application/json' \
    -d '{
  "domainId" : "f7550e0e-3303-46ab-b7ab-fff61d370be8",
  "status" : "ENABLED"
}'

HTTP Request

PUT /v1/vrops/domains HTTP/1.1
Host: sddc-manager.sfo01.rainpole.local
Content-Length: 81
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==
Content-Type: application/json

{
  "domainId" : "f7550e0e-3303-46ab-b7ab-fff61d370be8",
  "status" : "ENABLED"
}

HTTP Response

HTTP/1.1 202 Accepted
Location: /v1/tasks/9b56b98b-ba62-42cb-9ac1-f65e2d20ff9c
Content-Length: 131
Content-Type: application/json;charset=UTF-8

{
  "id" : "9b56b98b-ba62-42cb-9ac1-f65e2d20ff9c",
  "status" : "IN_PROGRESS",
  "creationTimestamp" : "2019-05-10T11:13:22.551Z"
}
Note
 This operation is a long-running task which details can be obtained form the HTTP response.

  1. Track the task status using the "id" from the previous response.

Tip
 Refer to: Get a Task.

  • If the "status" is "IN_PROGRESS", the task is still in progress.

  • If the "status" is "SUCCESSFUL", the task is completed successfully.

  • If the "status" is "FAILED", the task can be re-executed.

Tip
 For task re-execution refer to: Retry a Task.
Note
 To see the domain connection status of vRealize Operations refer to: Get vRealize Operations connection to Workload domains
Related APIs

Connect/disconnect workload domains with vRealize Operations
Get the existing vRealize Operations
Deploy vRealize Operations
Get the Tasks
Get a Task
Retry a Task

2.13. vRealize Log Insight

2.13.1. Connect vRealize Log Insight to workload domains

In order for vRealize Log Insight to collect logs from workload domains after deploying, one must first enable the workload domain connection. Once enabled, you cannot disable the connection to vRealize Log Insight.All subsequently created workload domains will automatically connect and send logs to the vRealize Log Insight cluster.

Prerequisites

  1. Verify you have a valid license key for vRealize Log Insight, which is purchased separately from VMware Cloud Foundation.

  2. Verify that the vRealize Log Insight cluster is online and operational.

Tip
 Refer to Get the existing vRealize Log Insight
Steps

  1. Assemble the vRealize Log Insight domain specification.

Tip
 Refer to Vrli

  1. Trigger the vRealize Log Insight domain connection.

Tip
 For help using the vRealize Log Insight domain connection API refer to: Connects vRealize Log Insight with workload domains

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/vrli' -i -u 'admin:VMwareInfra@1' -X PATCH \
    -H 'Content-Type: application/json' \
    -d '{
  "workloadDomainConnection" : true
}'

HTTP Request

PATCH /v1/vrli HTTP/1.1
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==
Content-Length: 39
Content-Type: application/json

{
  "workloadDomainConnection" : true
}

HTTP Response

HTTP/1.1 202 Accepted
Location: /v1/tasks/9b56b98b-ba62-42cb-9ac1-f65e2d20ff9c
Content-Length: 131
Allow: GET
Content-Type: application/json;charset=UTF-8

{
  "id" : "9b56b98b-ba62-42cb-9ac1-f65e2d20ff9c",
  "status" : "IN_PROGRESS",
  "creationTimestamp" : "2019-05-10T11:13:22.551Z"
}
Note
 This operation is a long-running task which details can be obtained form the HTTP response.

  1. Track the task status using the "id" from the previous response.

Tip
 Refer to: Get a Task.

  • If the "status" is "IN_PROGRESS", the task is still in progress.

  • If the "status" is "SUCCESSFUL", the task is completed successfully.

  • If the "status" is "FAILED", the task can be re-executed.

Tip
 For task re-execution refer to: Retry a Task.
Related APIs

Connects vRealize Log Insight with workload domains
Get the existing vRealize Log Insight
Get the Tasks
Get a Task
Retry a Task

2.14. Backup and Restore

Back up and restore solution is provided to backup SDDC manager and configure NSX manager backup.

2.14.1. Configure backup of SDDC manager and NSX manager

It is essential to review the basic principles in a file-based solution for backup. In such a solution, the state of a product is periodically exported to a file that is stored in a domain different than the one where the product is running. If the product needs to be restored, the OVA is re-deployed and a selected backup-file is used to restore the state.

NSX Manager files are backed up by default in the SDDC Manager VM which also has to be backed up. You can configure an external SFTP server as a backup location which is the recommended solution. NSX Manager is backed up every 1 hour

This section provides the steps to configure NSX backup location to an external SFTP server along with encryption configuration for both SDDC Manager and NSX Manager backup.

Prerequisites

  1. The following data is required

    • Encryption

      • Twelve or more characters.

      • At least one upper-case letter.

      • At least two digits.

      • At least one special character.

Note
 SDDC Manager does not store previously-used passphrases. You must store the passphrase in a secure location separate from the backup files and from the Cloud Foundation environment you are protecting.

  • FTP server details to save the backup file :

    • IP of the server

    • port

    • protocol, which is SFTP

    • username

    • password

    • ssh fingerprint

    • directory path to save the backup file

  • Privileged user credentials

Tip
 To get fingerprint execute the below command 
ssh-keygen -lf <(ssh-keyscan -t ssh-rsa -p <port-number> <server-IP-address> 2>/dev/null)
Note
 Fingerprint should be SHA-256 RSA key.
Steps

  1. Trigger the task using the valid input specification.

Note
 To trigger the API dual authentication is required. A privileged user has to be created in management domain vCenter and associated to group "Sddc_Secured_Access". Along with "admin" account, Privileged user credentials has to be passed in request headers("privileged-username" and "privileged-password") of secured APIs in plain text.
Tip
 Refer to Security section to set the privileged user.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/system/backup-configuration' -i -u 'admin:VMwareInfra@1' -X PUT \
    -H 'Content-Type: application/json' \
    -H 'privileged-password: VMwareInfra@1' \
    -H 'privileged-username: [email protected]' \
    -d '{
  "encryption" : {
    "passphrase" : "VMwareBackup@1"
  },
  "backupLocations" : [ {
    "server" : "ftp.vrack.vsphere.local",
    "port" : 22,
    "protocol" : "SFTP",
    "username" : "backup",
    "password" : "FTPServer@1",
    "directoryPath" : "/vmware/backup",
    "sshFingerprint" : "SHA256:w2NgXhG2XXXXXXXX"
  } ]
}'
Request Body
PUT /v1/system/backup-configuration HTTP/1.1
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==
Content-Type: application/json
Content-Length: 327
privileged-password: VMwareInfra@1
privileged-username: [email protected]

{
  "encryption" : {
    "passphrase" : "VMwareBackup@1"
  },
  "backupLocations" : [ {
    "server" : "ftp.vrack.vsphere.local",
    "port" : 22,
    "protocol" : "SFTP",
    "username" : "backup",
    "password" : "FTPServer@1",
    "directoryPath" : "/vmware/backup",
    "sshFingerprint" : "SHA256:w2NgXhG2XXXXXXXX"
  } ]
}
Response Body
HTTP/1.1 202 Accepted
Location: /v1/tasks/2dbd8fea-90e0-4662-8e41-c95974f0cc40
Content-Type: application/json;charset=UTF-8
Content-Length: 210

{
  "id" : "2dbd8fea-90e0-4662-8e41-c95974f0cc40",
  "name" : "Configure backup on VCF Components and register backup locations",
  "status" : "IN_PROGRESS",
  "creationTimestamp" : "2019-05-10T11:13:22.551Z"
}

  1. Poll the task until "status" is not "IN_PROGRESS" using the "id" from the previous response.

Tip
 Refer to: Get a Task.

  • If the "status" is "SUCCESSFUL", the task is completed successfully.

  • If the "status" is "FAILED", the task can be re-executed.

Note
 The SFTP server credentials are saved before configuring any NSX managers. In case configuring the NSX manager failed, an attempt is still made to configure as many NSX managers as possible before failing the task.
Tip
 Refer to: Retry a Task.
Related APIs

Get a Task
Retry a Task

2.14.2. Edit the Backup Configuration

Prerequisites

  1. The following data is required

    • The configuration which has to be edited (Backup location or Encryption or both).

    • Privileged user credentials

Note
 In case you are editing the passphrase, you must store the passphrase in a secure location separate from the backup files and from the Cloud Foundation environment. The encryption passphrase is mapped to the backup file. Editing the passphrase will not update the configured passphrase for previously backed up file.
Note
 In case you are editing the backup location, previously collected NSX backups must be manually migrated to the new location.
All the parameters of backup location have to be given as input while editing the backup location.
Note
 Editing backup configuration updates all the NSX manager’s backup configuration.
Steps

  1. Invoke the API

Tip
 To get the current backup configuration Refer to: Get the Backup Configuration

  1. The example shown is to edit only the backup location and the encryption is unchanged.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/system/backup-configuration' -i -u 'admin:VMwareInfra@1' -X PATCH \
    -H 'Content-Type: application/json' \
    -H 'privileged-password: VMwareInfra@1' \
    -H 'privileged-username: [email protected]' \
    -d '{
  "backupLocations" : [ {
    "server" : "ftp2.vrack.vsphere.local",
    "port" : 22,
    "protocol" : "SFTP",
    "username" : "backup",
    "password" : "FTPServer@2",
    "directoryPath" : "/vmware/backup",
    "sshFingerprint" : "SHA256:w2NgXhG2XXXXXXXX"
  } ]
}'
Request Body
PATCH /v1/system/backup-configuration HTTP/1.1
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==
Content-Type: application/json
privileged-password: VMwareInfra@1
privileged-username: [email protected]
Content-Length: 268

{
  "backupLocations" : [ {
    "server" : "ftp2.vrack.vsphere.local",
    "port" : 22,
    "protocol" : "SFTP",
    "username" : "backup",
    "password" : "FTPServer@2",
    "directoryPath" : "/vmware/backup",
    "sshFingerprint" : "SHA256:w2NgXhG2XXXXXXXX"
  } ]
}
Response Body
HTTP/1.1 202 Accepted
Location: /v1/tasks/8f981dc4-a321-4c8f-bd19-e9f824fe2bf9
Content-Type: application/json;charset=UTF-8
Content-Length: 210

{
  "id" : "8f981dc4-a321-4c8f-bd19-e9f824fe2bf9",
  "name" : "Configure backup on VCF Components and register backup locations",
  "status" : "IN_PROGRESS",
  "creationTimestamp" : "2019-05-10T11:13:22.551Z"
}

  1. Poll the task until "status" is not "IN_PROGRESS" using the "id" from the previous response.

Tip
 Refer to: Get a Task.

  • If the "status" is "SUCCESSFUL", the task is completed successfully.

  • If the "status" is "FAILED", the task can be re-executed.

Tip
 Refer to: Retry a Task.
Related APIs

Configure backup of SDDC manager and NSX manager
Get the Backup Configuration
Get a Task
Retry a Task

2.14.3. Get the Backup Configuration

Prerequisites

None

Steps

  1. Invoke the API.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/system/backup-configuration' -i -u 'admin:VMwareInfra@1' -X GET

HTTP Request

GET /v1/system/backup-configuration HTTP/1.1
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==

HTTP Response

HTTP/1.1 200 OK
Content-Length: 198
Content-Type: application/json;charset=UTF-8

{
  "backupLocations" : [ {
    "server" : "10.92.33.24",
    "port" : 22,
    "protocol" : "SFTP",
    "username" : "backup",
    "directoryPath" : "/vmware/backup"
  } ],
  "isConfigured" : true
}
Note
 "isConfigured" notifies if the backup has been configured.
Note
 Encryption details which was configured is not returned due to security reasons.
Related APIs

Configure backup of SDDC manager and NSX manager

2.14.4. Initiate Backup of SDDC Manager

Back up the SDDC Manager VM regularly to avoid downtime and data loss in case of a system failure. If the SDDC Manager VM does fail, you can restore VM to the last backup

In case you need to restore the SDDC Manager VM, you select the backup file to restore and download the appropriate OVA file. You can deploy this OVA either through vCenter Server or the OVF tool. You then load the state on the newly deployed SDDC Manager VM.

Prerequisites

  1. The following data is required

    • Backup must be configured

  2. Computer that runs the backup automation script (or where you manually run the APIs). This computer may also be used to coordinate and support a restore operation. It can also host the FTP server required to protect the NSX Manager instances.

  3. Reliable and secure storage volume on which the backup files are stored. The computer and the storage need to be in a different fault domain.

Note
 Only resourceType:SDDC_MANAGER is supported currently.
Tip
 Refer to: Configure backup of SDDC manager and NSX manager
Steps

  1. Trigger the task using the valid input specification.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/backups/tasks' -i -u 'admin:VMwareInfra@1' -X POST \
    -H 'Content-Type: application/json' \
    -d '{
  "elements" : [ {
    "resourceType" : "SDDC_MANAGER"
  } ]
}'

HTTP Request

POST /v1/backups/tasks HTTP/1.1
Content-Length: 64
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==
Content-Type: application/json

{
  "elements" : [ {
    "resourceType" : "SDDC_MANAGER"
  } ]
}

HTTP Response

HTTP/1.1 202 Accepted
Location: 3b48ffc5-fafd-46e5-88ee-ce3ccc4d7a93
Content-Length: 252
Content-Type: application/json;charset=UTF-8

{
  "id" : "3b48ffc5-fafd-46e5-88ee-ce3ccc4d7a93",
  "name" : "SDDC Manager Backup Operation",
  "status" : "IN_PROGRESS",
  "resources" : [ {
    "type" : "BACKUP",
    "name" : "vcf-backup-sddc-manager-vrack-vsphere-local-2019-07-29-12-02-46"
  } ]
}

  1. Poll the task until "status" is not "IN_PROGRESS" using the "id" from the previous response.

Tip
 Refer to: Get a Task.

  • If the "status" is "SUCCESSFUL", the task is completed successfully.

  • If the "status" is "FAILED", the task can be re-executed.

  1. The backup files are saved in the /nfs/vmware/vcf/nfs-mount/sddc-manager-backup directory on the SDDC Manager VM.

  2. In this example, the full filename of the backup file will be vcf-backup-sddc-manager-vrack-vsphere-local-2019-07-29-12-02-46.tar.gz

Tip
 To inspect the contents of a backup tar file, use the decrypt command described in Initiate Restore of SDDC Manager
Note
 Make sure to copy the backup file to a known location along with the corresponding passphrases.
Related APIs

Get a Task
Retry a Task

2.14.5. Initiate Restore of SDDC Manager

In case of a failure, you can restore SDDC Manager from a saved backup.

Prerequisites

  1. The following data is required

    • Backup file name and location of the backup file

    • Encryption passphrase used to encrypt the backup file

Note
 Only resourceType:SDDC_MANAGER is supported currently
Steps

  1. Power off the original SDDC Manager VM.

  2. Rename the VM to something like sddc-manager-original using the management domain vCenter Server.

  3. Identify the backup file to be used for the restore operation.

Tip
 In most cases, you should select the most recently taken backup.

  1. The backup file contains sensitive data about your Cloud Foundation instance, including passwords in plain text. It is recommended you control access to the decrypted files and securely delete them when you are done with the restore operation.

  2. Using a computer that has access to the secure secondary storage where the backup files are stored, navigate to the backup file and extract the contents of the encrypted tar file using the following command.

openssl enc -d -aes256 -in filename-of-selected-file | tar -xz

  1. At the prompt, enter the passphrase that you configured before backing up SDDC Manager.

  2. In order to restore SDDC Manager, you need to deploy the SDDC Manager OVA.

  3. The link to download the OVA is found in the metadata.json file in the backup file.

  4. Download the SDDC Manager OVA from the link provided.

  5. Deploy SDDC Manager VM from vCenter Server or with the OVF Tool.

    • Deploy SDDC Manager VM from vCenter server

      • Log in to the management domain vCenter Server using a web browser that is running on a system that has access to the downloaded SDDC Manager OVA.

      • In the vSphere Client, expand SDDC-Datacenter > SDDC-Cluster1.

      • Right-click on Mgmt-ResourcePool and select Deploy OVF Template.

      • The Deploy OVF Template wizard appears.

      • Use the local file option and choose the downloaded SDDC Manager OVA

      • Specify the VM name as sddc-manager.

      • Select the location of the SDDC Manager VM as SDDC-Datacenter > Management VMs and click Next.

      • Specify the compute resource destination. See the metadata.json file for the name of the pool and click Next.

      • Verify the template details and click Next.

      • Read the license terms and click the checkbox at the bottom of the page to accept the license agreements.

      • On the storage page, keep the vSAN datastore selection. The datastore name is in the metadata.json file and click Next.

      • On the networks page:

        • Do not change the default setting for Source Network.

        • In Destination Network, select the port group that is listed in the metadata.json file.

        • Do not change the default setting for IP allocation and IP protocol.

      • Click Next.

      • For the fields on the Customize template page, refer to the metadata.json file. Note the following:

        • Specify the backup user password from the security_password_vault.jsonfile.

        • For the other root, vcf, and admin user accounts, you can re-use the passwords for the original
          ***SDDC Manager or assign new ones. For password considerations, refer to the About the

        • Deployment Parameter Sheet section in the VMware Cloud Foundation Architecture and

        • Deployment Guide.

        • Leave the DNS and NTP fields empty

        • Ignore the Brownfield Settings section.

      • Click Next.

      • Review the OVF details and click Finish. The OVF deployment begins. You can view the details in the Tasks pane.

      • Power on the newly deployed SDDC Manager VM and wait for the vCenter Server UI to report its IP address has been assigned.

      • SSH in to the SDDC Manager and log in as the vcf user.

    • Deploy SDDC Manager VM with the OVF tool

      • Install the OVF tool on a system that has access to the SDDC Manager OVA that you downloaded.

      • Prerequisites

        • Download the OVF tool and install it on a system that has access to the SDDC Manager OVA that you downloaded

        • Retrieve the DNS name or IP address of a host from the management domain.

          • Log into the management domain vCenter Server

          • navigate to the management domain cluster

          • select an active host that is not reporting any vSAN errors

        • Retrieve the rRoot password for the selected host. Search for the host’s DNS name in the security_password_vault.json, which displays the root password.

      • Run the following command with information from the metadata.json file.

        ovftool --noSSLVerify --skipManifestCheck --powerOn --diskMode=thin --acceptAllEulas --
allowExtraConfig --ipProtocol=IPv4 --ipAllocationPolicy=fixedPolicy --datastore=datastoreName --
name=sddc-manager --X:injectOvfEnv --X:waitForIp --prop:ROOT_PASSWORD=Password --
prop:VCF_PASSWORD=Password --prop:BASIC_AUTH_PASSWORD=Password --prop:BACKUP_PASSWORD=Password
--prop:vami.gateway.SDDC-Manager=gatewayIP --prop:vami.ip0.SDDC-Manager=SDDC_Manager_IP --
prop:vami.netmask0.SDDC-Manager=networkMask --prop:vami.hostname=hostName --
prop:vami.searchpath.SDDC-Manager=searchPath --prop:vami.domain.SDDC-Manager=domain --
network=portGroupName --X:logFile=./ovftool.log --X:logLevel=verbose OVA_filename vi://
root:password_for_selected_host>@host_DNS_name_or_ IP
      OUTPUT:

Opening OVA source: VCF-SDDC-Manager-Appliance-3.7.2.0-13774914_OVF10.ova
The manifest does not validate
Opening VI target: vi://[email protected]:443/
Deploying to VI: vi://[email protected]:443/
Transfer Completed
Powering on VM: sddc-manager
Task Completed
Received IP address: 10.0.0.4
Completed successfully

      • Navigate to the management domain vCenter Server.

      • Move the sddc-manager VM into the Management VM folder.

      • Move the sddc-manager VM into the Management Resource Pool. The name of this pool is available in the metadata.json file.

      • To confirm that SDDC Manager has been deployed correctly, ssh in to the VM as the vcf user.

  6. Take a snapshot of the SDDC Manager VM.

  7. Copy the encrypted backup file to the /tmp directory on the SDDC Manager VM.

  8. Trigger the task using the valid input specification.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/restores/tasks' -i -u 'admin:VMwareInfra@1' -X POST \
    -H 'Content-Type: application/json' \
    -d '{
  "elements" : [ {
    "resourceType" : "SDDC_MANAGER"
  } ],
  "backupFile" : "/tmp/backup.tar.gz",
  "encryption" : {
    "passphrase" : "VMwareBackup@1"
  }
}'

HTTP Request

POST /v1/restores/tasks HTTP/1.1
Content-Length: 163
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==
Content-Type: application/json

{
  "elements" : [ {
    "resourceType" : "SDDC_MANAGER"
  } ],
  "backupFile" : "/tmp/backup.tar.gz",
  "encryption" : {
    "passphrase" : "VMwareBackup@1"
  }
}

HTTP Response

HTTP/1.1 202 Accepted
Location: 842650cc-7cb6-4aa2-aba8-009681a7e2f7
Content-Type: application/json;charset=UTF-8
Content-Length: 79

{
  "id" : "842650cc-7cb6-4aa2-aba8-009681a7e2f7",
  "status" : "IN_PROGRESS"
}

  1. Poll the task until "status" is not "IN_PROGRESS" using the "id" from the previous response.

Tip
 Refer to: Get a Task.

  1. If the "status" is "SUCCESSFUL", the task is completed successfully.

  2. If the "status" is "FAILED" , perform the following steps to retry.

    • Copy the contents of /var/log/vmware/vcf/sddc-support/ to a filesystem that is external to SDDC Manager. This preserves the restore log file.

    • Revert the SDDC Manager VM to the snapshot taken in step 12.

    • Take a new snapshot.

    • Perform steps 13 - 16.

    • If this attempt fails, contact VSDDC ManagerMware Support.

  1. Verify SDDC Manager VM operations after restore:

    • SSH in to the SDDC Manager as the vcf user.

    • Run the following command:

      sudo /opt/vmware/sddc-support/sos --health-check

    • When prompted, enter the vcf user password.

    • A green status indicates that the health is normal, yellow provides a warning that attention might be required, and red indicates that the component needs immediate attention. Possible reasons for yellow or red status are that you used an SDDC Manager backup with unresolved workflows, you used a backup taken before a workflow was completed successfully, you restored other products in addition to SDDC Manager, or some components are not operational. Call VMware Support if you need help with resolving the yellow or red status

    • If the status was green,

      • Download the applicable install and upgrade bundles.

      • Download the NSX-V bundle and NSX-T bundle if you plan to create NSX-T workload domains.

      • Download the upgrade bundles applicable to your environment.

Related APIs

Get a Task
Retry a Task

2.15. Depot Settings

2.15.1. Get Depot Settings

Online:

Offline:

Prerequisites

None

Steps

  1. Invoke the API.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/system/settings/depot' -i -u 'admin:VMwareInfra@1' -X GET \
    -H 'Accept: application/json'

HTTP Request

GET /v1/system/settings/depot HTTP/1.1
Accept: application/json
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==

HTTP Response

HTTP/1.1 200 OK
Content-Length: 90
Content-Type: application/json;charset=UTF-8

{
  "vmwareAccount" : {
    "username" : "acmeuser",
    "password" : "acmepassword"
  }
}
Related APIs

Get Depot Settings
Update Depot Settings

2.15.2. Update Depot Settings

Online:

Offline:

  • Use the Bundle Transfer Utility tool(Please refer to the VMware Cloud Foundation documentation for more information) to manually download the bundles from the depot on your local computer and then copy them to SDDC Manager. Once the bundles are available in the SDDC Manager. Use the Upload a Bundle API to upload it to SDDC Manager.

Prerequisites

The following data is required:

  • Username of My VMware Account.

  • Password of My VMware Account.

Tip
 Refer to: DepotSettings and DepotAccount.
Steps

  1. Invoke the API.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/system/settings/depot' -i -u 'admin:VMwareInfra@1' -X PUT \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json' \
    -d '{
  "vmwareAccount" : {
    "username" : "acmeuser",
    "password" : "acmepassword"
  }
}'

HTTP Request

PUT /v1/system/settings/depot HTTP/1.1
Accept: application/json
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==
Content-Length: 90
Content-Type: application/json

{
  "vmwareAccount" : {
    "username" : "acmeuser",
    "password" : "acmepassword"
  }
}

HTTP Response

HTTP/1.1 200 OK
Content-Length: 90
Content-Type: application/json;charset=UTF-8

{
  "vmwareAccount" : {
    "username" : "acmeuser",
    "password" : "acmepassword"
  }
}
Related APIs

Get Depot Settings
Update Depot Settings

2.16. Prechecks

2.16.1. Perform System Precheck

Precheck System API is used to perform the required system level health checks and upgrade pre-checks for an upgrade to be successful. Make sure to run these checks before performing any upgrade.

Tip
 Refer to: Get the Upgradables to query for the list of upgradables which can be used for performing Domain, Cluster level checks.
Prerequisites

The following data is required:

  • Resource ID. Ex: Domain ID, Cluster ID.

  • Resource Type. Ex: DOMAIN, CLUSTER.

Tip
 Refer to: PrecheckSpec and Resource.
Note
 Supported Resource Type’s are DOMAIN, CLUSTER. For Cluster level checks, the Cluster ID’s can be retrieved based on the Host’s that are available for upgrade, Refer to: Get the Hosts and Get the Clusters API’s.
Steps

  1. Invoke the API. This API returns a precheck task which can be polled and monitored.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/system/prechecks' -i -u 'admin:VMwareInfra@1' -X POST \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json' \
    -d '{
  "resources" : [ {
    "resourceId" : "bbd38966-8537-46f1-9a54-06fbfe7079c6",
    "type" : "DOMAIN"
  } ]
}'

HTTP Request

POST /v1/system/prechecks HTTP/1.1
Accept: application/json
Host: sddc-manager.sfo01.rainpole.local
Content-Length: 110
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==
Content-Type: application/json

{
  "resources" : [ {
    "resourceId" : "bbd38966-8537-46f1-9a54-06fbfe7079c6",
    "type" : "DOMAIN"
  } ]
}

HTTP Response

HTTP/1.1 202 Accepted
Content-Length: 739
Location: /v1/system/prechecks/tasks/c7f849c2-f80e-4e1c-84d6-d8b9d6cd2b99
Content-Type: application/json

{
  "id" : "c7f849c2-f80e-4e1c-84d6-d8b9d6cd2b99",
  "name" : "Precheck Task",
  "type" : "PRECHECK",
  "status" : "IN_PROGRESS",
  "creationTimestamp" : "2019-10-12T04:35:17.489Z",
  "completionTimestamp" : "2019-10-12T04:35:17.489Z",
  "subTasks" : [ {
    "name" : "Upgrade - DOMAIN 8a818326-2561-47e4-ab7a-9ac50e57e7f9",
    "description" : "Upgrade - DOMAIN 8a818326-2561-47e4-ab7a-9ac50e57e7f9",
    "status" : "PENDING",
    "creationTimestamp" : "2019-10-12T04:35:17.489Z",
    "resources" : [ {
      "resourceId" : "8a818326-2561-47e4-ab7a-9ac50e57e7f9",
      "type" : "DOMAIN"
    } ]
  } ],
  "resources" : [ {
    "resourceId" : "8a818326-2561-47e4-ab7a-9ac50e57e7f9",
    "type" : "DOMAIN"
  } ],
  "isCancellable" : false
}

  1. Poll the status of the task using the precheck task API with the ID from the response of the previous API.

Tip
 Refer to: Get System Precheck Task.
Related APIs

Get the Upgradables
Precheck System
Get Precheck Task by ID
Perform Upgrade

2.16.2. Get System Precheck Task

Get Precheck Task by ID API is used to retrieve a precheck task.

Prerequisites

  1. The following data is required

    • ID of the precheck task

Steps

  1. Invoke the API. This API returns a precheck task which can be polled and monitored.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/system/prechecks/tasks/c7f849c2-f80e-4e1c-84d6-d8b9d6cd2b99' -i -u 'admin:VMwareInfra@1' -X GET \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json'

HTTP Response

HTTP/1.1 200 OK
Content-Length: 739
Content-Type: application/json;charset=UTF-8

{
  "id" : "c7f849c2-f80e-4e1c-84d6-d8b9d6cd2b99",
  "name" : "Precheck Task",
  "type" : "PRECHECK",
  "status" : "IN_PROGRESS",
  "creationTimestamp" : "2019-10-12T04:35:17.928Z",
  "completionTimestamp" : "2019-10-12T04:35:17.928Z",
  "subTasks" : [ {
    "name" : "Upgrade - DOMAIN 8a818326-2561-47e4-ab7a-9ac50e57e7f9",
    "description" : "Upgrade - DOMAIN 8a818326-2561-47e4-ab7a-9ac50e57e7f9",
    "status" : "PENDING",
    "creationTimestamp" : "2019-10-12T04:35:17.928Z",
    "resources" : [ {
      "resourceId" : "8a818326-2561-47e4-ab7a-9ac50e57e7f9",
      "type" : "DOMAIN"
    } ]
  } ],
  "resources" : [ {
    "resourceId" : "8a818326-2561-47e4-ab7a-9ac50e57e7f9",
    "type" : "DOMAIN"
  } ],
  "isCancellable" : false
}

HTTP Response

HTTP/1.1 200 OK
Content-Length: 739
Content-Type: application/json;charset=UTF-8

{
  "id" : "c7f849c2-f80e-4e1c-84d6-d8b9d6cd2b99",
  "name" : "Precheck Task",
  "type" : "PRECHECK",
  "status" : "IN_PROGRESS",
  "creationTimestamp" : "2019-10-12T04:35:17.928Z",
  "completionTimestamp" : "2019-10-12T04:35:17.928Z",
  "subTasks" : [ {
    "name" : "Upgrade - DOMAIN 8a818326-2561-47e4-ab7a-9ac50e57e7f9",
    "description" : "Upgrade - DOMAIN 8a818326-2561-47e4-ab7a-9ac50e57e7f9",
    "status" : "PENDING",
    "creationTimestamp" : "2019-10-12T04:35:17.928Z",
    "resources" : [ {
      "resourceId" : "8a818326-2561-47e4-ab7a-9ac50e57e7f9",
      "type" : "DOMAIN"
    } ]
  } ],
  "resources" : [ {
    "resourceId" : "8a818326-2561-47e4-ab7a-9ac50e57e7f9",
    "type" : "DOMAIN"
  } ],
  "isCancellable" : false
}
Related APIs

Get the Upgradables
Precheck System
Get Precheck Task by ID
Perform Upgrade

2.17. Bundles

2.17.1. Upload a Bundle

Offline:

  • Upload a Bundle API is used to upload Bundles which are downloaded using Bundle Transfer Utility tool.

Tip
 Please refer to the VMware Cloud Foundation documentation for more information on the Bundle Transfer Utility tool.
Prerequisites

The following data is required:

  • Bundle file path.

  • Bundle manifest file path.

  • Bundle manifest signature file path.

Tip
 Refer to: BundleUploadSpec.
Steps

  1. Invoke the API. This API returns a task which can be polled and monitored.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/bundles' -i -u 'admin:VMwareInfra@1' -X POST \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json' \
    -d '{
  "bundleFilePath" : "/home/vcf/bundles/bundle-11237.tar",
  "manifestFilePath" : "/home/vcf/bundles/bundle-11237.manifest",
  "signatureFilePath" : "/home/vcf/bundles/bundle-11237.manifest.sig"
}'

HTTP Request

POST /v1/bundles HTTP/1.1
Accept: application/json
Content-Length: 198
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==
Content-Type: application/json

{
  "bundleFilePath" : "/home/vcf/bundles/bundle-11237.tar",
  "manifestFilePath" : "/home/vcf/bundles/bundle-11237.manifest",
  "signatureFilePath" : "/home/vcf/bundles/bundle-11237.manifest.sig"
}

HTTP Response

HTTP/1.1 202 Accepted
Location: /v1/tasks/3cedced6-f439-4069-9d06-cfc219533e7e
Content-Type: application/json
Content-Length: 366

{
  "id" : "3cedced6-f439-4069-9d06-cfc219533e7e",
  "name" : "Upload BUNDLE - PSC:6.7.0-13010631 VCENTER:6.7.0-13010631",
  "type" : "BUNDLE_UPLOAD",
  "status" : "IN_PROGRESS",
  "creationTimestamp" : "2019-10-12T04:35:18.522Z",
  "resources" : [ {
    "resourceId" : "82c5fbb0-3f9c-4d44-9505-beb5c2fcbc03",
    "type" : "BUNDLE"
  } ],
  "isCancellable" : false
}

  1. Poll the status of the task using the task API with the ID from the response of the previous API.

Tip
 Refer to: Get a Task.
Related APIs

Upload a Bundle
Get the Bundles
Get a Bundle
Update a Bundle for downloading from depot
Get the Tasks
Get a Task

2.17.2. Get the Bundles

Prerequisites

None

Steps

  1. Invoke the API.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/bundles' -i -u 'admin:VMwareInfra@1' -X GET \
    -H 'Accept: application/json'

HTTP Request

GET /v1/bundles HTTP/1.1
Accept: application/json
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==

HTTP Response

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 1788

{
  "elements" : [ {
    "id" : "82c5fbb0-3f9c-4d44-9505-beb5c2fcbc03",
    "type" : "VMWARE_SOFTWARE",
    "description" : "ESX update bundle -  13004448(67EP7)==>13010696 (vsphere67U2)",
    "version" : "253.0.0-111959",
    "severity" : null,
    "vendor" : "VMware",
    "releasedDate" : "2019-05-10T10:29:10.645Z",
    "isCumulative" : false,
    "sizeMB" : 453.0,
    "downloadStatus" : "SUCCESSFUL",
    "components" : [ {
      "description" : "ESX_HOST Update Bundle",
      "vendor" : "VMware",
      "releasedDate" : "2019-05-10T10:29:10.645Z",
      "toVersion" : "6.7.0-13006603",
      "fromVersion" : "6.7.0-13004448",
      "imageType" : "PATCH",
      "id" : "a65d9d83-88b9-475f-a2ba-ee5d9be34f8d",
      "type" : "HOST"
    } ]
  }, {
    "id" : "afdd0e46-7332-4d9f-b8df-8eaf92d99596",
    "type" : "VMWARE_SOFTWARE",
    "description" : "PSC-VC -67U2-Update bundle ( 11726888 ==> 13010631)",
    "version" : "253.0.0-111959",
    "severity" : null,
    "vendor" : "VMware",
    "releasedDate" : "2019-05-10T10:29:10.645Z",
    "isCumulative" : false,
    "sizeMB" : 453.0,
    "downloadStatus" : "SUCCESSFUL",
    "components" : [ {
      "description" : "PSC Update Bundle",
      "vendor" : "VMware",
      "releasedDate" : "2019-05-10T10:29:10.645Z",
      "toVersion" : "6.7.0-13010631",
      "fromVersion" : "6.7.0-11726888",
      "imageType" : "PATCH",
      "id" : "690cbe9e-241b-4086-bbf3-719b40499d6f",
      "type" : "PSC"
    }, {
      "description" : "VCENTER Update Bundle",
      "vendor" : "VMware",
      "releasedDate" : "2019-05-10T10:29:10.645Z",
      "toVersion" : "6.7.0-13010631",
      "fromVersion" : "6.7.0-11726888",
      "imageType" : "PATCH",
      "id" : "690cbe9e-241b-4086-bbf3-719b40499d6f",
      "type" : "VCENTER"
    } ]
  } ]
}
Related APIs

Upload a Bundle
Get the Bundles
Get a Bundle
Update a Bundle for downloading from depot

2.17.3. Get a Bundle

Prerequisites

  1. The following data is required:

    • ID of the Bundle

Steps

  1. Invoke the API.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/bundles/82c5fbb0-3f9c-4d44-9505-beb5c2fcbc03' -i -u 'admin:VMwareInfra@1' -X GET \
    -H 'Accept: application/json'

HTTP Request

GET /v1/bundles/82c5fbb0-3f9c-4d44-9505-beb5c2fcbc03 HTTP/1.1
Accept: application/json
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==

HTTP Response

HTTP/1.1 200 OK
Content-Length: 973
Content-Type: application/json;charset=UTF-8

{
  "id" : "afdd0e46-7332-4d9f-b8df-8eaf92d99596",
  "type" : "VMWARE_SOFTWARE",
  "description" : "PSC-VC -67U2-Update bundle ( 11726888 ==> 13010631)",
  "version" : "253.0.0-111959",
  "severity" : null,
  "vendor" : "VMware",
  "releasedDate" : "2019-05-10T10:29:10.645Z",
  "isCumulative" : false,
  "sizeMB" : 453.0,
  "downloadStatus" : "SUCCESSFUL",
  "components" : [ {
    "description" : "PSC Update Bundle",
    "vendor" : "VMware",
    "releasedDate" : "2019-05-10T10:29:10.645Z",
    "toVersion" : "6.7.0-13010631",
    "fromVersion" : "6.7.0-11726888",
    "imageType" : "PATCH",
    "id" : "690cbe9e-241b-4086-bbf3-719b40499d6f",
    "type" : "PSC"
  }, {
    "description" : "VCENTER Update Bundle",
    "vendor" : "VMware",
    "releasedDate" : "2019-05-10T10:29:10.645Z",
    "toVersion" : "6.7.0-13010631",
    "fromVersion" : "6.7.0-11726888",
    "imageType" : "PATCH",
    "id" : "690cbe9e-241b-4086-bbf3-719b40499d6f",
    "type" : "VCENTER"
  } ]
}
Related APIs

Upload a Bundle
Get the Bundles
Get a Bundle
Update a Bundle for downloading from depot

2.17.4. Update Bundle for Downloading

Online:

Tip
 Refer to: Update Depot Settings to configure My VMware Account in SDDC Manager.
Prerequisites

  1. The following data is required

    • Bundle download details.

Tip
 Refer to: BundleUpdateSpec and BundleDownloadSpec.
Steps

  1. Invoke the API. This API returns a task which can be polled and monitored.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/bundles/82c5fbb0-3f9c-4d44-9505-beb5c2fcbc03' -i -u 'admin:VMwareInfra@1' -X PATCH \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json' \
    -d '{
  "bundleDownloadSpec" : {
    "downloadNow" : true
  }
}'

HTTP Request

PATCH /v1/bundles/82c5fbb0-3f9c-4d44-9505-beb5c2fcbc03 HTTP/1.1
Accept: application/json
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==
Content-Type: application/json
Content-Length: 59

{
  "bundleDownloadSpec" : {
    "downloadNow" : true
  }
}

HTTP Response

HTTP/1.1 202 Accepted
Location: /v1/tasks/5e6a3e64-5455-4ec1-b822-3635238bda69
Content-Length: 370
Content-Type: application/json

{
  "id" : "5e6a3e64-5455-4ec1-b822-3635238bda69",
  "name" : "Download BUNDLE - PSC:6.7.0-13010631 VCENTER:6.7.0-13010631",
  "type" : "BUNDLE_DOWNLOAD",
  "status" : "IN_PROGRESS",
  "creationTimestamp" : "2019-10-12T04:35:17.645Z",
  "resources" : [ {
    "resourceId" : "82c5fbb0-3f9c-4d44-9505-beb5c2fcbc03",
    "type" : "BUNDLE"
  } ],
  "isCancellable" : false
}

  1. Poll the status of the task using the task API with the ID from the response of the previous API.

Tip
 Refer to: Get a Task.
Related APIs

Upload a Bundle
Get the Bundles
Get a Bundle
Update a Bundle for downloading from depot
Get the Tasks
Get a Task

2.18. Upgradables

2.18.1. Get the Upgradables

Get the Upgradables API provides the list of upgradables in the system. Each upgradable provides information about the bundle, resource and its associated software components that can be prechecked and upgraded. The upgradables can be of different types ex: AVAILABLE, PENDING, SCHEDULED etc.

Note
 The Get the Upgradables DOES NOT provide the unassigned hosts which can be upgraded. Refer to: Unassigned Host Upgrade.
Prerequisites

None

Steps

  1. Invoke the API.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/system/upgradables' -i -u 'admin:VMwareInfra@1' -X GET \
    -H 'Accept: application/json'

HTTP Request

GET /v1/system/upgradables HTTP/1.1
Accept: application/json
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==

HTTP Response

HTTP/1.1 200 OK
Content-Length: 381
Content-Type: application/json;charset=UTF-8

{
  "elements" : [ {
    "bundleId" : "82c5fbb0-3f9c-4d44-9505-beb5c2fcbc03",
    "bundleType" : "SDDC_MANAGER",
    "resource" : {
      "resourceId" : "8a818326-2561-47e4-ab7a-9ac50e57e7f9",
      "type" : "DOMAIN"
    },
    "softwareComponents" : [ {
      "id" : "099914c2-6f59-44e5-8dd4-d68b74edf1d5",
      "type" : "SDDC_MANAGER"
    } ],
    "status" : "AVAILABLE"
  } ]
}
Related APIs

Get the Upgradables
Precheck System
Get Precheck Task by ID
Perform Upgrade

2.19. Upgrades

2.19.1. Perform Upgrade

Perform Upgrade API is used to perform upgrades. Upgrades are sequential. So in order to upgrade to a release, your environment must be on the version before that release. Upgrades are applied on a workload domain basis. The management domain contains the core infrastructure, so you must upgrade the management domain before upgrading the other workload domains. You must upgrade all required components to keep your system in an optimum state.

Note
 Performing upgrades are supported on VMware Cloud Foundation 3.5 BOM resources and above.
Domain Upgrade

Use the Get the Upgradables to query for the list of upgradables(bundle and resource details) which can be used for performing Domain upgrades.

Prerequisites

The following data is required:

  • Bundle ID.

  • Resource Type. Ex: DOMAIN.

  • One or more Resource upgrade specifications.

  • Each Resource upgrade specification should contain.

    • Resource ID. Ex: Domain ID.

    • Upgrade scheduled time or Upgrade now option.

Tip
 Refer to: UpgradeSpec and ResourceUpgradeSpec.
Steps

  1. Invoke the API. This API returns a task which can be polled and monitored.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/upgrades' -i -u 'admin:VMwareInfra@1' -X POST \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json' \
    -d '{
  "bundleId" : "82c5fbb0-3f9c-4d44-9505-beb5c2fcbc03",
  "resourceType" : "DOMAIN",
  "resourceUpgradeSpecs" : [ {
    "resourceId" : "8a818326-2561-47e4-ab7a-9ac50e57e7f9",
    "scheduledTimestamp" : "2019-10-12T04:35:16.854Z",
    "upgradeNow" : false
  } ]
}'

HTTP Request

POST /v1/upgrades HTTP/1.1
Accept: application/json
Content-Length: 263
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==
Content-Type: application/json

{
  "bundleId" : "82c5fbb0-3f9c-4d44-9505-beb5c2fcbc03",
  "resourceType" : "DOMAIN",
  "resourceUpgradeSpecs" : [ {
    "resourceId" : "8a818326-2561-47e4-ab7a-9ac50e57e7f9",
    "scheduledTimestamp" : "2019-10-12T04:35:16.854Z",
    "upgradeNow" : false
  } ]
}

HTTP Response

HTTP/1.1 202 Accepted
Location: /v1/tasks/55e9a53f-9c1e-4956-927e-c00fe46a2000
Content-Type: application/json
Content-Length: 485

{
  "id" : "55e9a53f-9c1e-4956-927e-c00fe46a2000",
  "name" : "Upgrade DOMAIN - [acme-domain] using BUNDLE - PSC:6.7.0-13010631 VCENTER:6.7.0-13010631",
  "type" : "DOMAIN_UPGRADE",
  "status" : "IN_PROGRESS",
  "creationTimestamp" : "2019-10-12T04:35:16.847Z",
  "resources" : [ {
    "resourceId" : "8a818326-2561-47e4-ab7a-9ac50e57e7f9",
    "type" : "DOMAIN"
  }, {
    "resourceId" : "82c5fbb0-3f9c-4d44-9505-beb5c2fcbc03",
    "type" : "BUNDLE"
  } ],
  "isCancellable" : false
}

  1. Poll the status of the task using the task API with the ID from the response of the previous API.

Tip
 Refer to: Get a Task.
Cluster Upgrade

Use the Get the Upgradables to query for the list of upgradables(bundle and resource details) which can be used for performing Cluster level upgrades.

Note
 For Cluster level upgrades, the Cluster ID’s can be retrieved based on the Host’s that are available for upgrade, Refer to: Get the Hosts and Get the Clusters API’s.
Prerequisites

The following data is required:

  • Bundle ID.

  • Resource Type. Ex: CLUSTER.

  • One or more Resource upgrade specifications.

  • Each Resource upgrade specification should contain.

    • Resource ID. Ex: Cluster ID.

    • Upgrade scheduled time or Upgrade now option.

Tip
 Refer to: UpgradeSpec and ResourceUpgradeSpec.
Steps

  1. Invoke the API. This API returns a task which can be polled and monitored.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/upgrades' -i -u 'admin:VMwareInfra@1' -X POST \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json' \
    -d '{
  "bundleId" : "82c5fbb0-3f9c-4d44-9505-beb5c2fcbc03",
  "resourceType" : "CLUSTER",
  "resourceUpgradeSpecs" : [ {
    "resourceId" : "9cc82cc5-a98f-4eed-b7c1-1420fac9c45f",
    "scheduledTimestamp" : "2019-10-12T04:35:18.206Z",
    "upgradeNow" : false
  } ]
}'

HTTP Request

POST /v1/upgrades HTTP/1.1
Accept: application/json
Content-Length: 264
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==
Content-Type: application/json

{
  "bundleId" : "82c5fbb0-3f9c-4d44-9505-beb5c2fcbc03",
  "resourceType" : "CLUSTER",
  "resourceUpgradeSpecs" : [ {
    "resourceId" : "9cc82cc5-a98f-4eed-b7c1-1420fac9c45f",
    "scheduledTimestamp" : "2019-10-12T04:35:18.206Z",
    "upgradeNow" : false
  } ]
}

HTTP Response

HTTP/1.1 202 Accepted
Location: /v1/tasks/55e9a53f-9c1e-4956-927e-c00fe46a2000
Content-Type: application/json
Content-Length: 463

{
  "id" : "55e9a53f-9c1e-4956-927e-c00fe46a2000",
  "name" : "Upgrade DOMAIN - [acme-domain] using BUNDLE - HOST:6.7.0-13006603",
  "type" : "DOMAIN_UPGRADE",
  "status" : "IN_PROGRESS",
  "creationTimestamp" : "2019-10-12T04:35:18.205Z",
  "resources" : [ {
    "resourceId" : "8a818326-2561-47e4-ab7a-9ac50e57e7f9",
    "type" : "DOMAIN"
  }, {
    "resourceId" : "82c5fbb0-3f9c-4d44-9505-beb5c2fcbc03",
    "type" : "BUNDLE"
  } ],
  "isCancellable" : false
}

  1. Poll the status of the task using the task API with the ID from the response of the previous API.

Tip
 Refer to: Get a Task.
Unassigned Host Upgrade

The Get the Upgradables DOES NOT provide the unassigned hosts which can be upgraded. These unassigned host details(current version, host ID) needs to be queried using Get the Hosts and Get the Clusters API’s.

Prerequisites

The following data is required:

  • Resource Type. Ex: UNASSIGNED_HOST.

  • One or more Resource upgrade specifications.

  • Each Resource upgrade specification should contain.

    • Resource ID. Ex: UnAssigned Host ID.

    • Upgrade scheduled time or Upgrade now option.

    • Flag denoting whether the VM’s should be shutdown.

    • The version to which the Host should be upgraded to.

Tip
 Refer to: UpgradeSpec and ResourceUpgradeSpec.
Steps

  1. Invoke the API. This API returns a task which can be polled and monitored.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/upgrades' -i -u 'admin:VMwareInfra@1' -X POST \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json' \
    -d '{
  "bundleId" : "82c5fbb0-3f9c-4d44-9505-beb5c2fcbc03",
  "resourceType" : "UNASSIGNED_HOST",
  "resourceUpgradeSpecs" : [ {
    "resourceId" : "0cdd65f3-81dc-4c7f-be23-58253981a16d",
    "shutdownVms" : true,
    "toVersion" : "6.7.0-13006603",
    "upgradeNow" : true
  } ]
}'

HTTP Request

POST /v1/upgrades HTTP/1.1
Accept: application/json
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==
Content-Type: application/json
Content-Length: 278

{
  "bundleId" : "82c5fbb0-3f9c-4d44-9505-beb5c2fcbc03",
  "resourceType" : "UNASSIGNED_HOST",
  "resourceUpgradeSpecs" : [ {
    "resourceId" : "0cdd65f3-81dc-4c7f-be23-58253981a16d",
    "shutdownVms" : true,
    "toVersion" : "6.7.0-13006603",
    "upgradeNow" : true
  } ]
}

HTTP Response

HTTP/1.1 202 Accepted
Location: /v1/tasks/90aff4f3-81c9-4490-b8c1-e6ed308e71b4
Content-Length: 458
Content-Type: application/json

{
  "id" : "90aff4f3-81c9-4490-b8c1-e6ed308e71b4",
  "name" : "Upgrade HOST - [10.0.0.100] using BUNDLE - HOST:6.7.0-13006603",
  "type" : "DOMAIN_UPGRADE",
  "status" : "IN_PROGRESS",
  "creationTimestamp" : "2019-10-12T04:35:17.262Z",
  "resources" : [ {
    "resourceId" : "0cdd65f3-81dc-4c7f-be23-58253981a16d",
    "type" : "HOST"
  }, {
    "resourceId" : "82c5fbb0-3f9c-4d44-9505-beb5c2fcbc03",
    "type" : "BUNDLE"
  } ],
  "isCancellable" : false
}

  1. Poll the status of the task using the task API with the ID from the response of the previous API.

Tip
 Refer to: Get a Task.
Related APIs

Get the Upgradables
Precheck System
Get Precheck Task by ID
Perform Upgrade
Get the Tasks
Get a Task

2.20. Credentials

2.20.1. Get the Credentials

This API is used to fetch all credentials known to the system.

Prerequisites

  1. The following data is required

    • Resource type, name, IP address or the domain name associated with the resource is required to filter the results. For allowable resource type values

Tip
 Refer to: Get the Credentials

Get All Credentials

Steps

  1. Invoke the API.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/credentials' -i -u 'admin:VMwareInfra@1' -X GET \
    -H 'Accept: application/json' \
    -H 'privileged-password: VMwareInfra@1' \
    -H 'privileged-username: [email protected]'

HTTP Request

GET /v1/credentials HTTP/1.1
Accept: application/json
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==
privileged-password: VMwareInfra@1
privileged-username: [email protected]

HTTP Response

HTTP/1.1 200 OK
Content-Length: 5846
Content-Type: application/json;charset=UTF-8

{
  "elements" : [ {
    "id" : "c8aba98f-6fb0-431c-9448-a703491f0f53",
    "credentialType" : "SSH",
    "username" : "root",
    "password" : "VMwareInfra@1",
    "resource" : {
      "resourceId" : "5f44adb9-54e3-43f5-85e6-ee37c81ab744",
      "resourceName" : "sfo01m01esx01.sfo01.rainpole.local",
      "resourceIp" : "10.0.0.100",
      "resourceType" : "ESXI",
      "domainName" : "MGMT"
    }
  }, {
    "id" : "a627e787-ad57-4106-8efa-2c2a9144ce3f",
    "credentialType" : "SSH",
    "username" : "root",
    "password" : "VMwareInfra@1",
    "resource" : {
      "resourceId" : "f9002e17-ce9f-41dc-b402-4ef77929e361",
      "resourceName" : "sfo01m01esx02.sfo01.rainpole.local",
      "resourceIp" : "10.0.0.101",
      "resourceType" : "ESXI",
      "domainName" : "MGMT"
    }
  }, {
    "id" : "e0472b50-39eb-4aec-8040-c3f2f441f4fd",
    "credentialType" : "SSH",
    "username" : "root",
    "password" : "VMwareInfra@1",
    "resource" : {
      "resourceId" : "9bfdcefd-7efe-4e62-b685-95388bb806e2",
      "resourceName" : "sfo01m01esx03.sfo01.rainpole.local",
      "resourceIp" : "10.0.0.102",
      "resourceType" : "ESXI",
      "domainName" : "MGMT"
    }
  }, {
    "id" : "1d96ba1b-b88e-4cf2-8595-dabfb263b306",
    "credentialType" : "SSH",
    "username" : "root",
    "password" : "VMwareInfra@1",
    "resource" : {
      "resourceId" : "c2286812-04fc-4afa-b05f-5a916e2b08a4",
      "resourceName" : "sfo01m01esx04.sfo01.rainpole.local",
      "resourceIp" : "10.0.0.103",
      "resourceType" : "ESXI",
      "domainName" : "MGMT"
    }
  }, {
    "id" : "9e753c22-5c60-40c6-8b00-cb472e3aa5de",
    "credentialType" : "SSH",
    "username" : "root",
    "password" : "VMwareInfra@1",
    "resource" : {
      "resourceId" : "c1ba41a0-1dd3-47bc-a961-334a2cb843fc",
      "resourceName" : "sfo01m01vcenter01.sfo01.rainpole.local",
      "resourceIp" : "10.0.0.6",
      "resourceType" : "VCENTER",
      "domainName" : "MGMT"
    }
  }, {
    "id" : "e9101045-7d10-4ddd-bdb4-530d9e710fc3",
    "credentialType" : "SSH",
    "username" : "root",
    "password" : "VMwareInfra@1",
    "resource" : {
      "resourceId" : "e8512123-6d4c-49e1-b4e0-ef59bb1286f4",
      "resourceName" : "sfo01m01psc01.sfo01.rainpole.local",
      "resourceIp" : "10.0.0.5",
      "resourceType" : "PSC",
      "domainName" : "MGMT"
    }
  }, {
    "id" : "11a02635-496f-467d-ad20-f78b9da3b166",
    "credentialType" : "SSO",
    "username" : "[email protected]",
    "password" : "VMwareInfra@1",
    "resource" : {
      "resourceId" : "82e3d07d-00a6-422d-9b5a-24b1eeac812e",
      "resourceName" : "sfo01m01psc01.sfo01.rainpole.local",
      "resourceIp" : "10.0.0.5",
      "resourceType" : "PSC",
      "domainName" : "MGMT"
    }
  }, {
    "id" : "3d56d358-d4b6-49f8-9a0c-77199158fc27",
    "credentialType" : "API",
    "username" : "admin",
    "password" : "VMwareInfra@1",
    "resource" : {
      "resourceId" : "6aa03029-7e4c-442f-bf41-8478f29979e3",
      "resourceName" : "sfo01m01nsx01.sfo01.rainpole.local",
      "resourceIp" : "10.0.0.9",
      "resourceType" : "NSX_MANAGER",
      "domainName" : "MGMT"
    }
  }, {
    "id" : "f599248e-2932-4f33-8f3b-befbcfb20d1a",
    "credentialType" : "API",
    "username" : "admin",
    "password" : "VMwareInfra@1",
    "resource" : {
      "resourceId" : "bfdfb1f3-1a15-444a-9a87-9ddd1576891a",
      "resourceName" : "sfo01m01nsxc01",
      "resourceIp" : "10.0.0.42",
      "resourceType" : "NSX_CONTROLLER",
      "domainName" : "MGMT"
    }
  }, {
    "id" : "10183d7a-c081-45c5-b741-de3c50043ae0",
    "credentialType" : "API",
    "username" : "admin",
    "password" : "VMwareInfra@1",
    "resource" : {
      "resourceId" : "329fe0f9-25ab-4b10-b1e7-ac2074be4f8e",
      "resourceName" : "sfo01vrli01.sfo01.rainpole.local",
      "resourceIp" : "10.0.0.15",
      "resourceType" : "VRLI",
      "domainName" : "MGMT"
    }
  }, {
    "id" : "880060eb-9ce2-4130-a9d3-e767a67847d0",
    "credentialType" : "SSH",
    "username" : "root",
    "password" : "VMwareInfra@1",
    "resource" : {
      "resourceId" : "4b3ac3b5-6e0f-450d-a8ca-3717b263b4ae",
      "resourceName" : "sfo01vrli01b.sfo01.rainpole.local",
      "resourceIp" : "10.0.0.16",
      "resourceType" : "VRLI",
      "domainName" : "MGMT"
    }
  }, {
    "id" : "fd578e9d-2f26-419d-a3ee-5e1e7fc1ca74",
    "credentialType" : "SSH",
    "username" : "root",
    "password" : "VMwareInfra@1",
    "resource" : {
      "resourceId" : "134ddeff-a57f-4c83-8f47-e32105336842",
      "resourceName" : "vrops01svr01a.rainpole.local",
      "resourceIp" : "10.0.1.33",
      "resourceType" : "VROPS",
      "domainName" : "MGMT"
    }
  }, {
    "id" : "51d84c97-8641-42ec-9a45-bf38a06b565e",
    "credentialType" : "API",
    "username" : "admin",
    "password" : "VMwareInfra@1",
    "resource" : {
      "resourceId" : "af395f7b-bdad-4b3f-a00a-277982a63a42",
      "resourceName" : "vrops01svr01.rainpole.local",
      "resourceIp" : "10.0.0.31",
      "resourceType" : "VROPS",
      "domainName" : "MGMT"
    }
  }, {
    "id" : "f6dbd236-0942-4aae-bf25-bd86d0df9ca6",
    "credentialType" : "SSH",
    "username" : "root",
    "password" : "VMwareInfra@1",
    "resource" : {
      "resourceId" : "46a1a898-0784-4dbe-a536-777f85debd4f",
      "resourceName" : "vrslcm01svr01a.rainpole.local",
      "resourceIp" : "10.0.0.32",
      "resourceType" : "VRSLCM",
      "domainName" : "MGMT"
    }
  }, {
    "id" : "4ba2b3c1-2462-4b7b-aedf-bb11489ea2a5",
    "credentialType" : "API",
    "username" : "admin@localhost",
    "password" : "VMwareInfra@1",
    "resource" : {
      "resourceId" : "ae111569-ca3f-47d8-bf06-6156ec516742",
      "resourceName" : "vrslcm01svr01a.rainpole.local",
      "resourceIp" : "10.0.0.32",
      "resourceType" : "VRSLCM",
      "domainName" : "MGMT"
    }
  } ]
}

Get Credentials by "resourceName"

This API can be used to fetch the credentials associated with a resource with a specific name.

Steps

  1. Invoke the API by specifying the "resourceName".

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/credentials?resourceName=sfo01m01esx02.sfo01.rainpole.local' -i -u 'admin:VMwareInfra@1' -X GET \
    -H 'Accept: application/json' \
    -H 'privileged-password: VMwareInfra@1' \
    -H 'privileged-username: [email protected]'

HTTP Request

GET /v1/credentials?resourceName=sfo01m01esx02.sfo01.rainpole.local HTTP/1.1
Accept: application/json
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==
privileged-password: VMwareInfra@1
privileged-username: [email protected]

HTTP Response

HTTP/1.1 200 OK
Content-Length: 409
Content-Type: application/json;charset=UTF-8

{
  "elements" : [ {
    "id" : "a627e787-ad57-4106-8efa-2c2a9144ce3f",
    "credentialType" : "SSH",
    "username" : "root",
    "password" : "VMwareInfra@1",
    "resource" : {
      "resourceId" : "f9002e17-ce9f-41dc-b402-4ef77929e361",
      "resourceName" : "sfo01m01esx02.sfo01.rainpole.local",
      "resourceIp" : "10.0.0.101",
      "resourceType" : "ESXI",
      "domainName" : "MGMT"
    }
  } ]
}

Get Credentials by "resourceIP"

This API can be used to fetch the credentials associated with a resource with a specific IP address.

Steps

  1. Invoke the API by specifying the "resourceIP".

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/credentials?resourceIP=10.0.0.101' -i -u 'admin:VMwareInfra@1' -X GET \
    -H 'Accept: application/json' \
    -H 'privileged-password: VMwareInfra@1' \
    -H 'privileged-username: [email protected]'

HTTP Request

GET /v1/credentials?resourceIP=10.0.0.101 HTTP/1.1
Accept: application/json
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==
privileged-password: VMwareInfra@1
privileged-username: [email protected]

HTTP Response

HTTP/1.1 200 OK
Content-Length: 409
Content-Type: application/json;charset=UTF-8

{
  "elements" : [ {
    "id" : "a627e787-ad57-4106-8efa-2c2a9144ce3f",
    "credentialType" : "SSH",
    "username" : "root",
    "password" : "VMwareInfra@1",
    "resource" : {
      "resourceId" : "f9002e17-ce9f-41dc-b402-4ef77929e361",
      "resourceName" : "sfo01m01esx02.sfo01.rainpole.local",
      "resourceIp" : "10.0.0.101",
      "resourceType" : "ESXI",
      "domainName" : "MGMT"
    }
  } ]
}

Get Credentials by "resourceType"

This API can be used to fetch the credentials associated with all the resources with a specific resource type.

Steps

  1. Invoke the API by specifying the "resourceType".

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/credentials?resourceType=ESXI' -i -u 'admin:VMwareInfra@1' -X GET \
    -H 'Accept: application/json' \
    -H 'privileged-password: VMwareInfra@1' \
    -H 'privileged-username: [email protected]'

HTTP Request

GET /v1/credentials?resourceType=ESXI HTTP/1.1
Accept: application/json
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==
privileged-password: VMwareInfra@1
privileged-username: [email protected]

HTTP Response

HTTP/1.1 200 OK
Content-Length: 1573
Content-Type: application/json;charset=UTF-8

{
  "elements" : [ {
    "id" : "70afc703-8109-4af6-a932-f4994732d083",
    "credentialType" : "SSH",
    "username" : "root",
    "password" : "VMwareInfra@1",
    "resource" : {
      "resourceId" : "83ebf1d9-5b4e-4f0c-a512-3d1a94a4b698",
      "resourceName" : "sfo01m01esx01.sfo01.rainpole.local",
      "resourceIp" : "10.0.0.100",
      "resourceType" : "ESXI",
      "domainName" : "MGMT"
    }
  }, {
    "id" : "a627e787-ad57-4106-8efa-2c2a9144ce3f",
    "credentialType" : "SSH",
    "username" : "root",
    "password" : "VMwareInfra@1",
    "resource" : {
      "resourceId" : "f9002e17-ce9f-41dc-b402-4ef77929e361",
      "resourceName" : "sfo01m01esx02.sfo01.rainpole.local",
      "resourceIp" : "10.0.0.101",
      "resourceType" : "ESXI",
      "domainName" : "MGMT"
    }
  }, {
    "id" : "455da40f-fdc5-4564-a66e-5f2bd146ed42",
    "credentialType" : "SSH",
    "username" : "root",
    "password" : "VMwareInfra@1",
    "resource" : {
      "resourceId" : "1a1e6696-b750-46ae-aa02-164c93918c1c",
      "resourceName" : "sfo01m01esx03.sfo01.rainpole.local",
      "resourceIp" : "10.0.0.102",
      "resourceType" : "ESXI",
      "domainName" : "MGMT"
    }
  }, {
    "id" : "77e26831-feaf-4fb9-9c66-883996e5c8fb",
    "credentialType" : "SSH",
    "username" : "root",
    "password" : "VMwareInfra@1",
    "resource" : {
      "resourceId" : "6f6d5449-88bb-496b-9d62-93443cab7984",
      "resourceName" : "sfo01m01esx04.sfo01.rainpole.local",
      "resourceIp" : "10.0.0.103",
      "resourceType" : "ESXI",
      "domainName" : "MGMT"
    }
  } ]
}

Get Credentials by "domainName"

This API can be used to fetch the credentials associated with all the resources belonging to a specific domain.

Steps

  1. Invoke the API by specifying the "domainName".

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/credentials?domainName=MGMT' -i -u 'admin:VMwareInfra@1' -X GET \
    -H 'Accept: application/json' \
    -H 'privileged-password: VMwareInfra@1' \
    -H 'privileged-username: [email protected]'

HTTP Request

GET /v1/credentials?domainName=MGMT HTTP/1.1
Accept: application/json
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==
privileged-password: VMwareInfra@1
privileged-username: [email protected]

HTTP Response

HTTP/1.1 200 OK
Content-Length: 5846
Content-Type: application/json;charset=UTF-8

{
  "elements" : [ {
    "id" : "d11dcadb-109e-4036-97d7-495dc6e568ee",
    "credentialType" : "SSH",
    "username" : "root",
    "password" : "VMwareInfra@1",
    "resource" : {
      "resourceId" : "4b59a78d-88af-4ef9-a696-5d1e2b4f2b2a",
      "resourceName" : "sfo01m01esx01.sfo01.rainpole.local",
      "resourceIp" : "10.0.0.100",
      "resourceType" : "ESXI",
      "domainName" : "MGMT"
    }
  }, {
    "id" : "a627e787-ad57-4106-8efa-2c2a9144ce3f",
    "credentialType" : "SSH",
    "username" : "root",
    "password" : "VMwareInfra@1",
    "resource" : {
      "resourceId" : "f9002e17-ce9f-41dc-b402-4ef77929e361",
      "resourceName" : "sfo01m01esx02.sfo01.rainpole.local",
      "resourceIp" : "10.0.0.101",
      "resourceType" : "ESXI",
      "domainName" : "MGMT"
    }
  }, {
    "id" : "d500f07b-1dde-4cc9-b786-f93264e30c72",
    "credentialType" : "SSH",
    "username" : "root",
    "password" : "VMwareInfra@1",
    "resource" : {
      "resourceId" : "0bd9b062-26d8-4628-a686-af9cd703b90e",
      "resourceName" : "sfo01m01esx03.sfo01.rainpole.local",
      "resourceIp" : "10.0.0.102",
      "resourceType" : "ESXI",
      "domainName" : "MGMT"
    }
  }, {
    "id" : "84309356-6da7-44ee-946e-67e8b8774b9a",
    "credentialType" : "SSH",
    "username" : "root",
    "password" : "VMwareInfra@1",
    "resource" : {
      "resourceId" : "23144b5a-01ac-40a5-aa90-d063a43582cd",
      "resourceName" : "sfo01m01esx04.sfo01.rainpole.local",
      "resourceIp" : "10.0.0.103",
      "resourceType" : "ESXI",
      "domainName" : "MGMT"
    }
  }, {
    "id" : "bc06f327-bef2-4982-bf2f-e541b2969cd8",
    "credentialType" : "SSH",
    "username" : "root",
    "password" : "VMwareInfra@1",
    "resource" : {
      "resourceId" : "e8c26b64-c70f-4694-b97b-9037a1dbbcc5",
      "resourceName" : "sfo01m01vcenter01.sfo01.rainpole.local",
      "resourceIp" : "10.0.0.6",
      "resourceType" : "VCENTER",
      "domainName" : "MGMT"
    }
  }, {
    "id" : "dc773dc5-925e-48fc-b425-4446ac5470dc",
    "credentialType" : "SSH",
    "username" : "root",
    "password" : "VMwareInfra@1",
    "resource" : {
      "resourceId" : "5ba7b73c-3249-4300-980f-f50a0b470360",
      "resourceName" : "sfo01m01psc01.sfo01.rainpole.local",
      "resourceIp" : "10.0.0.5",
      "resourceType" : "PSC",
      "domainName" : "MGMT"
    }
  }, {
    "id" : "8200c3ab-c9c5-420a-ac69-20ed113de151",
    "credentialType" : "SSO",
    "username" : "[email protected]",
    "password" : "VMwareInfra@1",
    "resource" : {
      "resourceId" : "6e60cf1e-6eae-4ced-8c5c-1b51d8e612cf",
      "resourceName" : "sfo01m01psc01.sfo01.rainpole.local",
      "resourceIp" : "10.0.0.5",
      "resourceType" : "PSC",
      "domainName" : "MGMT"
    }
  }, {
    "id" : "b68a76ce-9e32-4ebf-843e-f44cf192a0bd",
    "credentialType" : "API",
    "username" : "admin",
    "password" : "VMwareInfra@1",
    "resource" : {
      "resourceId" : "a0de88bd-4715-4ed3-a1f1-155552800b17",
      "resourceName" : "sfo01m01nsx01.sfo01.rainpole.local",
      "resourceIp" : "10.0.0.9",
      "resourceType" : "NSX_MANAGER",
      "domainName" : "MGMT"
    }
  }, {
    "id" : "82ac753a-722e-4ccd-b141-f2fd6cb81edb",
    "credentialType" : "API",
    "username" : "admin",
    "password" : "VMwareInfra@1",
    "resource" : {
      "resourceId" : "8b35767c-9762-4bb7-aeda-4e5ab67810e0",
      "resourceName" : "sfo01m01nsxc01",
      "resourceIp" : "10.0.0.42",
      "resourceType" : "NSX_CONTROLLER",
      "domainName" : "MGMT"
    }
  }, {
    "id" : "6f0a4aa3-1492-4604-a059-765302e466f5",
    "credentialType" : "API",
    "username" : "admin",
    "password" : "VMwareInfra@1",
    "resource" : {
      "resourceId" : "bb40dde8-95e1-4092-bbcc-008c75aea673",
      "resourceName" : "sfo01vrli01.sfo01.rainpole.local",
      "resourceIp" : "10.0.0.15",
      "resourceType" : "VRLI",
      "domainName" : "MGMT"
    }
  }, {
    "id" : "7e98e9cc-c383-4d85-92a6-b2fa24234a3d",
    "credentialType" : "SSH",
    "username" : "root",
    "password" : "VMwareInfra@1",
    "resource" : {
      "resourceId" : "64a74979-750b-48d8-9b3a-01a6a64f4b76",
      "resourceName" : "sfo01vrli01b.sfo01.rainpole.local",
      "resourceIp" : "10.0.0.16",
      "resourceType" : "VRLI",
      "domainName" : "MGMT"
    }
  }, {
    "id" : "4eec540d-9d1d-4465-a96f-81877606c13e",
    "credentialType" : "SSH",
    "username" : "root",
    "password" : "VMwareInfra@1",
    "resource" : {
      "resourceId" : "da8dcd44-cc83-45ea-b959-33a91d6b3766",
      "resourceName" : "vrops01svr01a.rainpole.local",
      "resourceIp" : "10.0.1.33",
      "resourceType" : "VROPS",
      "domainName" : "MGMT"
    }
  }, {
    "id" : "2cae3aeb-a3ab-41bb-a18d-cc1e1b94a51c",
    "credentialType" : "API",
    "username" : "admin",
    "password" : "VMwareInfra@1",
    "resource" : {
      "resourceId" : "8e6de250-50c9-421f-90a0-9063c3aa34a7",
      "resourceName" : "vrops01svr01.rainpole.local",
      "resourceIp" : "10.0.0.31",
      "resourceType" : "VROPS",
      "domainName" : "MGMT"
    }
  }, {
    "id" : "595c4052-64b7-4497-bd7e-12bd78f34145",
    "credentialType" : "SSH",
    "username" : "root",
    "password" : "VMwareInfra@1",
    "resource" : {
      "resourceId" : "4102bd8a-ed70-43d4-9b23-7961cc30af78",
      "resourceName" : "vrslcm01svr01a.rainpole.local",
      "resourceIp" : "10.0.0.32",
      "resourceType" : "VRSLCM",
      "domainName" : "MGMT"
    }
  }, {
    "id" : "8de538c1-f67b-4261-8897-b768bfba4b0b",
    "credentialType" : "API",
    "username" : "admin@localhost",
    "password" : "VMwareInfra@1",
    "resource" : {
      "resourceId" : "fd71c3f1-27bc-4ab2-968a-2619ac1ca99f",
      "resourceName" : "vrslcm01svr01a.rainpole.local",
      "resourceIp" : "10.0.0.32",
      "resourceType" : "VRSLCM",
      "domainName" : "MGMT"
    }
  } ]
}
Related APIs

Get the Credentials
Get a Credential

2.20.2. Get a Credential

This API is used to fetch credential for an ID.

Prerequisites

  1. The following data is required

    • ID of the credential

Steps

  1. Invoke the API.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/credentials/a627e787-ad57-4106-8efa-2c2a9144ce3f' -i -u 'admin:VMwareInfra@1' -X GET \
    -H 'privileged-password: VMwareInfra@1' \
    -H 'privileged-username: [email protected]'

HTTP Request

GET /v1/credentials/a627e787-ad57-4106-8efa-2c2a9144ce3f HTTP/1.1
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==
privileged-password: VMwareInfra@1
privileged-username: [email protected]

HTTP Response

HTTP/1.1 200 OK
Content-Length: 362
Content-Type: application/json;charset=UTF-8

{
  "id" : "a627e787-ad57-4106-8efa-2c2a9144ce3f",
  "credentialType" : "SSH",
  "username" : "root",
  "password" : "VMwareInfra@1",
  "resource" : {
    "resourceId" : "f9002e17-ce9f-41dc-b402-4ef77929e361",
    "resourceName" : "sfo01m01esx02.sfo01.rainpole.local",
    "resourceIp" : "10.0.0.101",
    "resourceType" : "ESXI",
    "domainName" : "MGMT"
  }
}
Related APIs

Get the Credentials
Get a Credential

2.20.3. Update the Passwords

This API is used to update passwords for list of resources by supplying new passwords.

Prerequisites

  1. The following data is required

    • Name or ID of the resource

    • Type of the resource

    • Credential type of the resource

    • Username of the resource

Tip
 Refer to: Get the Credentials to get the credential type, username, name, ID and type of the resource.

  1. New password must be in compliance with the password policies.

Tip
 Refer to the respective VMware product specific documentation for the password policies.
Steps

  1. Trigger the task using the valid input specification.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/credentials' -i -u 'admin:VMwareInfra@1' -X PATCH \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json' \
    -H 'privileged-password: VMwareInfra@1' \
    -H 'privileged-username: [email protected]' \
    -d '{
  "operationType" : "UPDATE",
  "elements" : [ {
    "resourceName" : "sfo01m01esx02.sfo01.rainpole.local",
    "resourceType" : "ESXI",
    "credentials" : [ {
      "credentialType" : "SSH",
      "username" : "root",
      "password" : "VMwareInfra@1"
    } ]
  } ]
}'

HTTP Request

PATCH /v1/credentials HTTP/1.1
Content-Length: 272
Accept: application/json
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==
Content-Type: application/json
privileged-password: VMwareInfra@1
privileged-username: [email protected]

{
  "operationType" : "UPDATE",
  "elements" : [ {
    "resourceName" : "sfo01m01esx02.sfo01.rainpole.local",
    "resourceType" : "ESXI",
    "credentials" : [ {
      "credentialType" : "SSH",
      "username" : "root",
      "password" : "VMwareInfra@1"
    } ]
  } ]
}

HTTP Response

HTTP/1.1 202 Accepted
Content-Type: application/json;charset=UTF-8
Content-Length: 100
Location: /v1/tasks/531fcbc2-d84c-443c-97e1-92397835352f

{
  "id" : "531fcbc2-d84c-443c-97e1-92397835352f",
  "name" : "UPDATE",
  "status" : "IN_PROGRESS"
}

  1. Poll the status of the task using the task API with the ID from the response of the previous API.

Tip
 Refer to: Get a Task or Get a Credentials Task.

  1. Poll the task until "status" is not "IN_PROGRESS" with the ID from the previous response.

Tip
 Refer to: Get a Task.

  • If the "status" is "SUCCESSFUL", the task is completed successfully.

  • If the "status" is "FAILED", the task can be re-executed.

Tip
 Refer to: Retry the Update Passwords Task.
Warning
 The password once updated cannot be rolled back.
Note
 The password is updated in the order of the input.
Note
 The passwords of the dependent resources of the requested resources will also get updated.
Related APIs

Update or rotate passwords for a list of resources
Get the Tasks
Get a Task
Fetch the credentials tasks
Fetch a credentials task
Retry a failed credentials task for a given ID
Cancel a failed credentials task for a given ID

2.20.4. Rotate the Passwords

This API is used to rotate passwords for list of resources using system generated passwords.

Prerequisites

  1. The following data is required

    • Name or ID of the resource

    • Type of the resource

    • Credential type of the resource

    • Username of the resource

Tip
 Refer to: Get the Credentials to get the credential type, username, name, ID and type of the resource.
Steps

  1. Trigger the task using the valid input specification.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/credentials' -i -u 'admin:VMwareInfra@1' -X PATCH \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json' \
    -H 'privileged-password: VMwareInfra@1' \
    -H 'privileged-username: [email protected]' \
    -d '{
  "operationType" : "ROTATE",
  "elements" : [ {
    "resourceName" : "sfo01m01esx02.sfo01.rainpole.local",
    "resourceType" : "ESXI",
    "credentials" : [ {
      "credentialType" : "SSH",
      "username" : "root"
    } ]
  } ]
}'

HTTP Request

PATCH /v1/credentials HTTP/1.1
Accept: application/json
Host: sddc-manager.sfo01.rainpole.local
Content-Length: 236
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==
Content-Type: application/json
privileged-password: VMwareInfra@1
privileged-username: [email protected]

{
  "operationType" : "ROTATE",
  "elements" : [ {
    "resourceName" : "sfo01m01esx02.sfo01.rainpole.local",
    "resourceType" : "ESXI",
    "credentials" : [ {
      "credentialType" : "SSH",
      "username" : "root"
    } ]
  } ]
}

HTTP Response

HTTP/1.1 202 Accepted
Location: /v1/tasks/c40032a8-ce23-410e-8136-5e8f95f3f731
Content-Type: application/json;charset=UTF-8
Content-Length: 100

{
  "id" : "c40032a8-ce23-410e-8136-5e8f95f3f731",
  "name" : "ROTATE",
  "status" : "IN_PROGRESS"
}

  1. Poll the status of the task using the task API with the ID from the response of the previous API.

Tip
 Refer to: Get a Task or Get a Credentials Task.

  1. Poll the task until "status" is not "IN_PROGRESS" with the ID from the previous response.

Tip
 Refer to: Get a Task.

  • If the "status" is "SUCCESSFUL", the task is completed successfully.

  • If the "status" is "FAILED", the task can be re-executed.

Tip
 Refer to: Retry the Rotate Passwords Task.
Warning
 The password once rotated cannot be rolled back.
Note
 The password is rotated in the order of the input.
Note
 The passwords of the dependent resources of the requested resources will also get rotated.
Related APIs

Update or rotate passwords for a list of resources
Get the Tasks
Get a Task
Fetch the credentials tasks
Fetch a credentials task
Retry a failed credentials task for a given ID
Cancel a failed credentials task for a given ID

2.20.5. Retry the Update Passwords Task

This API is used to retry a failed update passwords task.

Prerequisites

  1. The following data is required

    • ID of the last triggered failed update passwords task

    • Name or ID of the resource

    • Type of the resource

    • Credential type of the resource

    • Username of the resource

Tip
 Refer to: Get the Credentials to get the credential type, username, name, ID and type of the resource and ID of the failed task.

  1. New password must be in compliance with the password policies.

Tip
 Refer to: Documentation of the product for product specific password policies.
Steps

  1. Trigger the task using the valid input specification.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/credentials/tasks/bd193f3d-d425-4a3e-960a-a290c0b2f6e2' -i -u 'admin:VMwareInfra@1' -X PATCH \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json' \
    -H 'privileged-password: VMwareInfra@1' \
    -H 'privileged-username: [email protected]' \
    -d '{
  "operationType" : "UPDATE",
  "elements" : [ {
    "resourceName" : "sfo01m01esx02.sfo01.rainpole.local",
    "resourceType" : "ESXI",
    "credentials" : [ {
      "credentialType" : "SSH",
      "username" : "root",
      "password" : "VMwareInfra@1"
    } ]
  } ]
}'

HTTP Request

PATCH /v1/credentials/tasks/bd193f3d-d425-4a3e-960a-a290c0b2f6e2 HTTP/1.1
Content-Length: 272
Accept: application/json
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==
Content-Type: application/json
privileged-password: VMwareInfra@1
privileged-username: [email protected]

{
  "operationType" : "UPDATE",
  "elements" : [ {
    "resourceName" : "sfo01m01esx02.sfo01.rainpole.local",
    "resourceType" : "ESXI",
    "credentials" : [ {
      "credentialType" : "SSH",
      "username" : "root",
      "password" : "VMwareInfra@1"
    } ]
  } ]
}

HTTP Response

HTTP/1.1 202 Accepted
Location: /v1/tasks/bd193f3d-d425-4a3e-960a-a290c0b2f6e2
Content-Type: application/json;charset=UTF-8
Content-Length: 100

{
  "id" : "bd193f3d-d425-4a3e-960a-a290c0b2f6e2",
  "name" : "UPDATE",
  "status" : "IN_PROGRESS"
}

  1. Poll the task until "status" is not "IN_PROGRESS" with the ID from the previous response.

Tip
 Refer to: Get a Task or Get a Credentials Task.

  • If the "status" is "SUCCESSFUL", the task is completed successfully.

  • If the "status" is "FAILED", the task can be re-executed by providing previous credentials rotate specification or by amending the credentials rotate specification for FAILED resources.

Tip
 Refer to: Retry the Update Passwords Task.

  • The failed task can be cancelled.

Tip
 Refer to: Cancel the Update/Rotate Passwords Task.
Warning
 The password once updated cannot be rolled back.
Note
 The password is updated in the order of the input.
Note
 Retry should be performed if updating passwords task has failed.
Note
 Retry should be performed on the same list of resources as in the failed operation specification.
Tip
 Refer to: Get the Resource Credentials for Credentials Task for the list of resources in the failed task.
Note
 The passwords of the dependent resources of the requested resources will also get updated.
Related APIs

Retry a failed credentials task for a given ID
Get the Tasks
Get a Task
Fetch the credentials tasks
Fetch a credentials task
Fetch resource credentials for a given credentials task ID
Cancel a failed credentials task for a given ID

2.20.6. Retry the Rotate Passwords Task

This API is used to retry a failed rotate passwords task.

Prerequisites

  1. The following data is required

    • ID of the last triggered failed rotate passwords task

    • Name or ID of the resource

    • Type of the resource

    • Credential type of the resource

    • Username of the resource

Tip
 Refer to: Get the Credentials to get the credential type, username, name, ID and type of the resource and ID of the failed task.
Steps

  1. Trigger the task using the valid input specification.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/credentials/tasks/df765b71-aeff-4677-992a-85a6a6a6c7c2' -i -u 'admin:VMwareInfra@1' -X PATCH \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json' \
    -H 'privileged-password: VMwareInfra@1' \
    -H 'privileged-username: [email protected]' \
    -d '{
  "operationType" : "ROTATE",
  "elements" : [ {
    "resourceName" : "sfo01m01esx02.sfo01.rainpole.local",
    "resourceType" : "ESXI",
    "credentials" : [ {
      "credentialType" : "SSH",
      "username" : "root"
    } ]
  } ]
}'

HTTP Request

PATCH /v1/credentials/tasks/df765b71-aeff-4677-992a-85a6a6a6c7c2 HTTP/1.1
Accept: application/json
Host: sddc-manager.sfo01.rainpole.local
Content-Length: 236
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==
Content-Type: application/json
privileged-password: VMwareInfra@1
privileged-username: [email protected]

{
  "operationType" : "ROTATE",
  "elements" : [ {
    "resourceName" : "sfo01m01esx02.sfo01.rainpole.local",
    "resourceType" : "ESXI",
    "credentials" : [ {
      "credentialType" : "SSH",
      "username" : "root"
    } ]
  } ]
}

HTTP Response

HTTP/1.1 202 Accepted
Location: /v1/tasks/df765b71-aeff-4677-992a-85a6a6a6c7c2
Content-Type: application/json;charset=UTF-8
Content-Length: 100

{
  "id" : "df765b71-aeff-4677-992a-85a6a6a6c7c2",
  "name" : "ROTATE",
  "status" : "IN_PROGRESS"
}

  1. Poll the task until "status" is not "IN_PROGRESS" with the ID from the previous response.

Tip
 Refer to: Get a Task or Get a Credentials Task.

  • If the "status" is "SUCCESSFUL", the task is completed successfully.

  • If the "status" is "FAILED", the task can be re-executed by providing previous credentials rotate specification or by amending the credentials rotate specification for FAILED resources.

Tip
 Refer to: Retry the Rotate Passwords Task.

  • The failed task can be cancelled.

Tip
 Refer to: Cancel the Update/Rotate Passwords Task.
Warning
 The password once rotated cannot be rolled back.
Note
 The password is rotated in the order of the input.
Note
 Retry should be performed if some password rotation task has failed.
Note
 Retry should be performed on the same list of resources as in the failed operation specification.
Tip
 Refer to: Get the Resource Credentials for Credentials Task for the list of resources in the failed task.
Note
 The passwords of the dependent resources of the requested resources will also get rotated.
Related APIs

Retry a failed credentials task for a given ID
Get the Tasks
Get a Task
Fetch the credentials tasks
Fetch a credentials task
Fetch resource credentials for a given credentials task ID
Cancel a failed credentials task for a given ID

2.20.7. Cancel the Update/Rotate Passwords Task

  • This API is used to cancel a failed update or rotate passwords task.

Prerequisites

  1. The following data is required

    • ID of the last triggered failed update/rotate passwords task

Tip
 Refer to: Get the Credentials Tasks section to get the ID of the failed task.
Steps

  1. Invoke the API.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/credentials/tasks/3990604c-c2be-4c9a-abe3-20ab4fc0d95a' -i -u 'admin:VMwareInfra@1' -X DELETE

HTTP Request

DELETE /v1/credentials/tasks/3990604c-c2be-4c9a-abe3-20ab4fc0d95a HTTP/1.1
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==

HTTP Response

HTTP/1.1 204 No Content
Content-Type: application/json;charset=UTF-8
Content-Length: 103

{
  "id" : "3990604c-c2be-4c9a-abe3-20ab4fc0d95a",
  "name" : "USER CANCELLED",
  "status" : "FAILED"
}
Warning
 The password once updated or rotated cannot be rolled back.
Note
 The password is updated or rotated in the order of the input.
Note
 Cancel should be performed to release the internal global lock held at VCF instance level if some password updation or rotation task has failed after several retries.
Related APIs

Cancel a failed credentials task for a given ID
Get the Tasks
Get a Task
Fetch the credentials tasks
Fetch a credentials task

2.20.8. Get the Credentials Tasks

This API is used to fetch all credentials tasks in reverse chronological order.

Prerequisites

None

Steps

  1. Invoke the API.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/credentials/tasks' -i -u 'admin:VMwareInfra@1' -X GET \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json'

HTTP Request

GET /v1/credentials/tasks HTTP/1.1
Accept: application/json
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==
Content-Type: application/json

HTTP Response

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 650

{
  "elements" : [ {
    "id" : "186d891f-aac3-4501-ae52-afb89eb7e32f",
    "name" : "Credentials rotate operation",
    "creationTimestamp" : "2018-11-05T05:15:32.864Z",
    "status" : "SUCCESSFUL",
    "subTasks" : [ {
      "name" : "vracafe3.rainpole.local:SSH",
      "creationTimestamp" : "2018-11-05T05:15:32.864Z",
      "status" : "SUCCESSFUL"
    }, {
      "name" : "vracafe2.rainpole.local:SSH",
      "creationTimestamp" : "2018-11-05T05:15:32.864Z",
      "status" : "SUCCESSFUL"
    }, {
      "name" : "vracafe1.rainpole.local:SSH",
      "creationTimestamp" : "2018-11-05T05:15:32.864Z",
      "status" : "SUCCESSFUL"
    } ]
  } ]
}
Related APIs

Fetch the credentials tasks
Fetch a credentials task

2.20.9. Get a Credentials Task

This API is used to fetch a credentials task for an ID.

Prerequisites

  1. The following data is required

    • ID of the credentials task

Steps

  1. Invoke the API.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/credentials/tasks/186d891f-aac3-4501-ae52-afb89eb7e32f' -i -u 'admin:VMwareInfra@1' -X GET \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json'

HTTP Request

GET /v1/credentials/tasks/186d891f-aac3-4501-ae52-afb89eb7e32f HTTP/1.1
Accept: application/json
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==
Content-Type: application/json

HTTP Response

HTTP/1.1 200 OK
Content-Length: 591
Content-Type: application/json;charset=UTF-8

{
  "id" : "186d891f-aac3-4501-ae52-afb89eb7e32f",
  "name" : "Credentials rotate operation",
  "creationTimestamp" : "2018-11-05T05:15:32.864Z",
  "status" : "SUCCESSFUL",
  "subTasks" : [ {
    "name" : "vracafe3.rainpole.local:SSH",
    "creationTimestamp" : "2018-11-05T05:15:32.864Z",
    "status" : "SUCCESSFUL"
  }, {
    "name" : "vracafe2.rainpole.local:SSH",
    "creationTimestamp" : "2018-11-05T05:15:32.864Z",
    "status" : "SUCCESSFUL"
  }, {
    "name" : "vracafe1.rainpole.local:SSH",
    "creationTimestamp" : "2018-11-05T05:15:32.864Z",
    "status" : "SUCCESSFUL"
  } ]
}
Related APIs

Fetch the credentials tasks
Fetch a credentials task

2.20.10. Get the Resource Credentials for Credentials Task

This API is used to fetch resource credentials for a credentials task ID.

Prerequisites

  1. The following data is required

    • ID of the credentials task

Tip
 Refer to: Get the Credentials Tasks to get the ID of credentials tasks.
Steps

  1. Invoke the API.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/credentials/tasks/186d891f-aac3-4501-ae52-afb89eb7e32f/resource-credentials' -i -u 'admin:VMwareInfra@1' -X GET \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json'

HTTP Request

GET /v1/credentials/tasks/186d891f-aac3-4501-ae52-afb89eb7e32f/resource-credentials HTTP/1.1
Accept: application/json
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==
Content-Type: application/json

HTTP Response

HTTP/1.1 200 OK
Content-Length: 479
Content-Type: application/json;charset=UTF-8

[ {
  "resourceName" : "vracafe3.rainpole.local",
  "resourceType" : "VRA",
  "credentials" : [ {
    "credentialType" : "SSH",
    "username" : "root"
  } ]
}, {
  "resourceName" : "vracafe2.rainpole.local",
  "resourceType" : "VRA",
  "credentials" : [ {
    "credentialType" : "SSH",
    "username" : "root"
  } ]
}, {
  "resourceName" : "vracafe1.rainpole.local",
  "resourceType" : "VRA",
  "credentials" : [ {
    "credentialType" : "SSH",
    "username" : "root"
  } ]
} ]
Related APIs

Fetch resource credentials for a given credentials task ID
Fetch the credentials tasks
Fetch a credentials task

2.21. Certificates

2.21.1. Install Certificates By Online Mode

The following steps have to be followed to install certificates signed by VCF supporting certificate authorities (Microsoft CA and OpenSSL CA).

Prerequisites

  1. VCF environment.

Steps

  1. Check if certificate authority is configured or not by invoking the API. If certificate authority is configured, directly jump to step-3.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/certificate-authorities' -i -u 'admin:VMwareInfra@1' -X GET \
    -H 'Accept: application/json'

HTTP Request

GET /v1/certificate-authorities HTTP/1.1
Accept: application/json
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==

HTTP Response

HTTP/1.1 200 OK
Content-Length: 383
Content-Type: application/json;charset=UTF-8

{
  "elements" : [ {
    "id" : "OpenSSL",
    "commonName" : "test.openssl.eng.vmware.com",
    "country" : "India",
    "state" : "Karnataka",
    "locality" : "Bengaluru",
    "organization" : "VMware",
    "organizationUnit" : "ISBU"
  }, {
    "id" : "Microsoft",
    "username" : "Admin",
    "serverUrl" : "https://192.168.110.200/certsrv",
    "templateName" : "Vcms"
  } ]
}
Tip
 Refer to: Get certificate authorities information

  1. Configure certificate authority if it is not configured by invoking the API

Configure "Microsoft" certificate authority

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/certificate-authorities' -i -u 'admin:VMwareInfra@1' -X PUT \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json' \
    -d '{
  "microsoftCertificateAuthoritySpec" : {
    "username" : "Admin",
    "secret" : "VMwareInfra@1",
    "serverUrl" : "https://192.168.110.200/certsrv",
    "templateName" : "Vcms"
  }
}'

HTTP Request

PUT /v1/certificate-authorities HTTP/1.1
Accept: application/json
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==
Content-Type: application/json
Content-Length: 188

{
  "microsoftCertificateAuthoritySpec" : {
    "username" : "Admin",
    "secret" : "VMwareInfra@1",
    "serverUrl" : "https://192.168.110.200/certsrv",
    "templateName" : "Vcms"
  }
}

HTTP Response

HTTP/1.1 200 OK

Configure "OpenSSL" certificate authority

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/certificate-authorities' -i -u 'admin:VMwareInfra@1' -X PUT \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json' \
    -d '{
  "openSSLCertificateAuthoritySpec" : {
    "commonName" : "test.openssl.eng.vmware.com",
    "country" : "India",
    "state" : "Karnataka",
    "locality" : "Bengaluru",
    "organization" : "VMware",
    "organizationUnit" : "ISBU"
  }
}'

HTTP Request

PUT /v1/certificate-authorities HTTP/1.1
Accept: application/json
Host: sddc-manager.sfo01.rainpole.local
Content-Length: 242
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==
Content-Type: application/json

{
  "openSSLCertificateAuthoritySpec" : {
    "commonName" : "test.openssl.eng.vmware.com",
    "country" : "India",
    "state" : "Karnataka",
    "locality" : "Bengaluru",
    "organization" : "VMware",
    "organizationUnit" : "ISBU"
  }
}

HTTP Response

HTTP/1.1 200 OK
Tip
 Refer to: Create a certificate authority

  1. Reconfigure the certificate authority if required by invoking the API

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/certificate-authorities' -i -u 'admin:VMwareInfra@1' -X PATCH \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json' \
    -d '{
  "openSSLCertificateAuthoritySpec" : {
    "commonName" : "test1.openssl.eng.vmware.com"
  }
}'

HTTP Request

PATCH /v1/certificate-authorities HTTP/1.1
Accept: application/json
Content-Length: 97
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==
Content-Type: application/json

{
  "openSSLCertificateAuthoritySpec" : {
    "commonName" : "test1.openssl.eng.vmware.com"
  }
}

HTTP Response

HTTP/1.1 200 OK
Tip
 Refer to: Configure existing certificate authority

  1. Verify that the certificate authority is successfully configured by invoking the API with type of CA as the ID

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/certificate-authorities/Microsoft' -i -u 'admin:VMwareInfra@1' -X GET \
    -H 'Accept: application/json'

HTTP Request

GET /v1/certificate-authorities/Microsoft HTTP/1.1
Accept: application/json
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==

HTTP Response

HTTP/1.1 200 OK
Content-Length: 126
Content-Type: application/json;charset=UTF-8

{
  "id" : "Microsoft",
  "username" : "Admin",
  "serverUrl" : "https://192.168.110.200/certsrv",
  "templateName" : "Vcms"
}
Tip
 Refer to: Get certificate authority information

  1. After the successful certificate authority configuration, generate CSR by invoking the API

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/domains/MGMT/csrs' -i -u 'admin:VMwareInfra@1' -X PUT \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json' \
    -d '{
  "csrGenerationSpec" : {
    "country" : "India",
    "state" : "Karnataka",
    "locality" : "Bengaluru",
    "organization" : "VMware",
    "organizationUnit" : "ISBU",
    "email" : "[email protected]",
    "keySize" : "2048",
    "keyAlgorithm" : "RSA"
  },
  "resources" : [ {
    "fqdn" : "sfo01m01nsx01.sfo01.rainpole.local",
    "type" : "NSX_MANAGER"
  } ]
}'

HTTP Request

PUT /v1/domains/MGMT/csrs HTTP/1.1
Accept: application/json
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==
Content-Length: 369
Content-Type: application/json

{
  "csrGenerationSpec" : {
    "country" : "India",
    "state" : "Karnataka",
    "locality" : "Bengaluru",
    "organization" : "VMware",
    "organizationUnit" : "ISBU",
    "email" : "[email protected]",
    "keySize" : "2048",
    "keyAlgorithm" : "RSA"
  },
  "resources" : [ {
    "fqdn" : "sfo01m01nsx01.sfo01.rainpole.local",
    "type" : "NSX_MANAGER"
  } ]
}

HTTP Response

HTTP/1.1 202 Accepted
Location: /v1/tasks/75e95d1b-f03d-4af3-9786-ec2593634f1e
Content-Type: application/json;charset=UTF-8
Content-Length: 79

{
  "id" : "75e95d1b-f03d-4af3-9786-ec2593634f1e",
  "status" : "IN_PROGRESS"
}
Tip
 Refer to: Generate CSR(s)

  • Poll the status of the task using the task API with the ID from the response of the previous API.

Tip
 Refer to: Get a Task

  • Poll the task until "status" is not "IN_PROGRESS" with the ID from the previous response.

Tip
 Refer to: Get a Task.

  • If the "status" is "SUCCESSFUL", the task is completed successfully.

  • If the "status" is "FAILED", execute the generate CSR request again.

  1. If the generation of CSR is successful, fetch the contents of the CSR to check for which resources CSR is generated by invoking the API

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/domains/MGMT/csrs' -i -u 'admin:VMwareInfra@1' -X GET \
    -H 'Accept: application/json'

HTTP Request

GET /v1/domains/MGMT/csrs HTTP/1.1
Accept: application/json
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==

HTTP Response

HTTP/1.1 200 OK
Content-Length: 1163
Content-Type: application/json;charset=UTF-8

{
  "elements" : [ {
    "csrEncodedContent" : "-----BEGIN CERTIFICATE REQUEST-----\nMIICtDCCAZwCAQAwbzELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAkNBMQswCQYDVQQH\nEwJQQTEMMAoGA1UECxMDVkNGMQ8wDQYDVQQKEwZWTXdhcmUxJzAlBgNVBAMTHm5z\neE1hbmFnZXIudnJhY2sudnNwaGVyZS5sb2NhbDCCASIwDQYJKoZIhvcNAQEBBQAD\nggEPADCCAQoCggEBAKtumknTB1do77E5rCXGRgqT6iqTgW0moiDZS6USGkeTQMvj\nR5JnQjq11xJl0y1meSdA6ufft8xndOr1b8alRs4+FreuJLl/8HBIVLRECrfkfIn0\nImwZzGFih2wwrCD/evb/7paNcdt97+KF2nwqB5ADysyFkjYs0uiJxxE5i8HsST1L\n+AStKeAV0lOk/2n/qgHPUcnjH7KchJAet9DFuKBWUW7QIryQffuiQrdAFqcEPHJC\nubHyqnoBPktosD3SXs1UickNiTyXIRC1NGHK/w7VTTJfBxkXxIdejazVGjCAW8w0\n/N4iW3rCaxSpnggWLGYFbGEkhikgtkpj8zIRjk8CAwEAAaAAMA0GCSqGSIb3DQEB\nCwUAA4IBAQBkxJTuymqggHLhWbtnvtA3mU4freKzF2XDUUP+K5kz43j2IXNbsCJI\nWDpY9OCVj9NHZ+uFTvQLvCb3E+6h0vE4Dw2PVUuOpz/Ag1qmgYIxtC5vzN4gLKih\nUNROG5wYryYKO8YL4MB3XIQdx9b8y8Fxyh3ZHIvdghhUPBooWzeCUXVPD8Le4p52\nD8yMGREtSQL4avLughd+SFd0fvKQq+/K42WOFn7PYVfgLBqdW1YCjEIfAdsG+bhG\n3CIBan84uV3cKFSM4NtxCvHZnuRZmx6+0Frtt1w9sndjKvHrA6ozoHO9O1gl/E9D\nY1rzOB7KFzGiZHAMT2Cf/x/xGo8rTGFZ\n-----END CERTIFICATE REQUEST-----",
    "resource" : {
      "fqdn" : "sfo01m01nsx01.sfo01.rainpole.local"
    }
  } ]
}
Tip
 Refer to: Get available CSR(s) in json format

  1. After successful CSR generation, generate the certificates signed by supported certificates authorities (either OpenSSL or Microsoft) by invoking the API

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/domains/MGMT/certificates' -i -u 'admin:VMwareInfra@1' -X PUT \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json' \
    -d '{
  "caType" : "Microsoft",
  "resources" : [ {
    "fqdn" : "sfo01m01nsx01.sfo01.rainpole.local",
    "type" : "NSX_MANAGER"
  } ]
}'

HTTP Request

PUT /v1/domains/MGMT/certificates HTTP/1.1
Accept: application/json
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==
Content-Type: application/json
Content-Length: 133

{
  "caType" : "Microsoft",
  "resources" : [ {
    "fqdn" : "sfo01m01nsx01.sfo01.rainpole.local",
    "type" : "NSX_MANAGER"
  } ]
}

HTTP Response

HTTP/1.1 202 Accepted
Content-Type: application/json;charset=UTF-8
Location: /v1/tasks/0e3a53fc-2dfd-491f-88bf-69770b23c9dc
Content-Length: 79

{
  "id" : "0e3a53fc-2dfd-491f-88bf-69770b23c9dc",
  "status" : "IN_PROGRESS"
}
Tip
 Refer to: Generate certificate(s) for the selected resource(s) in a domain

  • Poll the status of the task using the task API with the ID from the response of the previous API.

Tip
 Refer to: Get a Task

  • Poll the task until "status" is not "IN_PROGRESS" with the ID from the previous response.

Tip
 Refer to: Get a Task.

  • If the "status" is "SUCCESSFUL", the task is completed successfully.

  • If the "status" is "FAILED", execute the generate certificate request again.

  1. After successful certificate generation, install the signed certificates on remote resources by invoking the API

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/domains/MGMT/certificates' -i -u 'admin:VMwareInfra@1' -X PATCH \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json' \
    -d '{
  "operationType" : "INSTALL",
  "resources" : [ {
    "fqdn" : "sfo01m01nsx01.sfo01.rainpole.local",
    "type" : "NSX_MANAGER"
  } ]
}'

HTTP Request

PATCH /v1/domains/MGMT/certificates HTTP/1.1
Accept: application/json
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==
Content-Length: 138
Content-Type: application/json

{
  "operationType" : "INSTALL",
  "resources" : [ {
    "fqdn" : "sfo01m01nsx01.sfo01.rainpole.local",
    "type" : "NSX_MANAGER"
  } ]
}

HTTP Response

HTTP/1.1 202 Accepted
Location: /v1/tasks/6f49fc0f-6107-4542-874a-a2c170f4257b
Content-Type: application/json;charset=UTF-8
Content-Length: 79

{
  "id" : "6f49fc0f-6107-4542-874a-a2c170f4257b",
  "status" : "IN_PROGRESS"
}
Tip
 Refer to: Replace certificate(s) for the selected resource(s) in a domain

  • Poll the status of the task using the task API with the ID from the response of the previous API.

Tip
 Refer to: Get a Task

  • Poll the task until "status" is not "IN_PROGRESS" with the ID from the previous response.

Tip
 Refer to: Get a Task.

  • If the "status" is "SUCCESSFUL", the task is completed successfully.

  • If the "status" is "FAILED", the task can be re-executed.

Tip
 Refer to: Retry a Task

  1. Fetch the installed certificates by invoking the API

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/domains/MGMT/resource-certificates' -i -u 'admin:VMwareInfra@1' -X GET \
    -H 'Accept: application/json'

HTTP Request

GET /v1/domains/MGMT/resource-certificates HTTP/1.1
Accept: application/json
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==

HTTP Response

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 8486

{
  "elements" : [ {
    "version" : "V3",
    "serialNumber" : "ca:0b:5d:6d:07:4e:db:41",
    "issuedTo" : "sfo01m01vcenter01.sfo01.rainpole.local",
    "issuedBy" : "OU=VMware Engineering, O=psc-1.vrack.vsphere.local, ST=California, C=US, DC=local, DC=vsphere, CN=CA",
    "notBefore" : "2019-07-11T10:16:05.000Z",
    "notAfter" : "2029-07-06T08:17:24.000Z",
    "signatureAlgorithm" : "SHA256withRSA",
    "subject" : "C=US, CN=vcenter-1.vrack.vsphere.local",
    "subjectAlternativeName" : [ "vcenter-1.vrack.vsphere.local" ],
    "publicKey" : "BA:16:16:DF:00:B2:88:C9:F9:E0:7F:72:B6:DC:83:1F:87:46:C3:C4:4B:8B:EB:C0:AD:B9:A2:FB:31:75:0A:89:12:25:58:B6:42:B1:78:A3:7F:19:B0:03:19:35:AD:51:5D:08:36:CB:C3:6E:63:B2:CE:89:2D:24:AD:EA:DD:BD:73:0A:06:84:4E:4D:83:AF:B8:EC:F9:E1:98:9F:35:9F:83:11:DD:71:61:5E:CF:DE:9A:BF:0D:A7:8A:64:F2:94:26:5D:A7:E0:20:B9:C2:01:BB:62:F2:7D:C3:A9:9B:91:DE:49:1E:97:B7:E8:CA:38:1C:E9:92:76:07:A8:26:95:5D:C1:89:E7:EA:27:03:57:BE:D2:76:B5:E4:AC:89:10:67:7F:42:DA:5D:52:5C:9F:65:59:A4:42:0B:81:F8:77:B5:F8:2D:18:DA:9B:1A:F4:BD:BD:F2:33:97:7A:EA:64:1B:CE:58:CF:9C:E7:18:60:94:CE:66:C9:57:7E:62:A2:AD:47:3D:29:D2:F8:DB:AB:D7:8F:D1:7D:8A:9A:FC:68:37:48:3C:AD:38:A5:76:D8:4C:E2:64:AE:87:B7:DA:78:3E:EB:2B:C8:70:43:4D:CB:4E:72:80:43:CB:D2:43:A7:71:16:22:27:0F:A1:DB:0A:83:88:2C:09:49:0A:35:8C:76:76:55:E2:3A:1C:7C:74:F0:91:60:A2:45:7F:6C:7A:2B:A5:51:87:25:D0:DB:9C:E0:B8:32:27:83:D6:3F:70:C5:7A:1B:92:09:E7:77:39:3A:C2:28:B1:5C:8A:3F:42:FE:D6:6A:7D:F6:E5:D6:FB:B0:DB:AB:D9:65:29:BE:75:DA:07:E8:38:B2:A0:75:9F:45:8E:FF:6B:AF:27:DB:FA:2E:AB:80:51:09:88:7D:7B:AC:A4:B7:15:41:30:A0:E1:0F:C7:DD:D1:F4:84:7D:D3:F8:B1:B0:F9:55:8F:A6:DC:44:E0:E6:0F:C5:DF:32:93:51:8D:7D:BA:79:4A:3E:72:CA:CB:9A:2E:8B:E6:A0:63:57:C8:CD:92:F8:70:0A:1E:6D:CA:DF:35:D4:91:45:E7:DB:7F:86:32:E9:8C:A3:D2:D0:35:15:70:A9:DA:39:DF:FA:76:9C:EF:5D:B6:A4:58:49:EE:A0:B1:74:33:D2:41:97:F6:FE:0C:07:66:DE:56:5F:3E:15:03:70:3D:56:80:5E:F6:CB:C3:FA:78:CE:14:0C:D7:E1:53:48:8B:5A:61:C0:04:BA:DD:ED:B3:E4:F1:76:AD:FD:03:27:C9:FB:EC:5A:75:0B:22:8F:6A:E8:35:47:FB:04:B7:A7:5F:51:FA:46:EF:00:64:03:27:1C:FB",
    "publicKeyAlgorithm" : "RSA",
    "keySize" : "2048",
    "thumbprintAlgorithm" : "SHA-256",
    "thumbprint" : "35:4B:A5:11:A9:3D:39:0D:B7:95:9B:4D:07:5C:73:40:D0:DF:63:D4:68:97:6E:1B:20:70:87:AE:40:3F:7E:AD",
    "numberOfDaysToExpire" : 3644,
    "expirationStatus" : "ACTIVE",
    "pemEncoded" : "-----BEGIN CERTIFICATE-----MIIFRDCCBCygAwIBAgIJAOx9cA2cGcUUMA0GCSqGSIb3DQEBCwUAMIGgMQswCQYDVQQDDAJDQTEXMBUGCgmSJomT8ixkARkWB3ZzcGhlcmUxFTATBgoJkiaJk/IsZAEZFgVsb2NhbDELMAkGA1UEBhMCVVMxEzARBgNVBAgMCkNhbGlmb3JuaWExIjAgBgNVBAoMGXBzYy0xLnZyYWNrLnZzcGhlcmUubG9jYWwxGzAZBgNVBAsMElZNd2FyZSBFbmdpbmVlcmluZzAeFw0xODA3MDIxNDE1NTJaFw0yODA2MjcxMjIyMzlaMIGwMQswCQYDVQQGEwJVUzETMBEGA1UECBMKQ2FsaWZvcm5pYTESMBAGA1UEBxMJUGFsbyBBbHRvMQ8wDQYDVQQKEwZWTXdhcmUxGzAZBgNVBAsTElZNd2FyZSBFbmdpbmVlcmluZzEqMCgGA1UEAxMhbG9hZC1iYWxhbmNlci52cmFjay52c3BoZXJlLmxvY2FsMR4wHAYJKoZIhvcNAQkBFg92bWNhQHZtd2FyZS5jb20wggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIKAoICAQC6FhbfALKIyfngf3K23IMfh0bDxEuL68CtuaL7MXUKiRIlWLZCsXijfxmwAxk1rVFdCDbLw25jss6JLSSt6t29cwoGhE5Ng6+47PnhmJ81n4MR3XFhXs/emr8Np4pk8pQmXafgILnCAbti8n3DqZuR3kkel7foyjgc6ZJ2B6gmlV3BiefqJwNXvtJ2teSsiRBnf0LaXVJcn2VZpEILgfh3tfgtGNqbGvS9vfIzl3rqZBvOWM+c5xhglM5myVd+YqKtRz0p0vjbq9eP0X2KmvxoN0g8rTildthM4mSuh7faeD7rK8hwQ03LTnKAQ8vSQ6dxFiInD6HbCoOILAlJCjWMdnZV4jocfHTwkWCiRX9seiulUYcl0Nuc4LgyJ4PWP3DFehuSCed3OTrCKLFcij9C/tZqffbl1vuw26vZZSm+ddoH6DiyoHWfRY7/a68n2/ouq4BRCYh9e6yktxVBMKDhD8fd0fSEfdP4sbD5VY+m3ETg5g/F3zKTUY19unlKPnLKy5oui+agY1fIzZL4cAoebcrfNdSRRefbf4Yy6Yyj0tA1FXCp2jnf+nac7122pFhJ7qCxdDPSQZf2/gwHZt5WXz4VA3A9VoBe9svD+njOFAzX4VNIi1phwAS63e2z5PF2rf0DJ8n77Fp1CyKPaug1R/sEt6dfUfpG7wBkAycc+wIDAQABo28wbTAJBgNVHRMEAjAAMAsGA1UdDwQEAwIF4DAyBgNVHREEKzApgiFsb2FkLWJhbGFuY2VyLnZyYWNrLnZzcGhlcmUubG9jYWyHBAoAAA8wHwYDVR0jBBgwFoAUauWGErq+/JHwQ3qju9Ch8V2097MwDQYJKoZIhvcNAQELBQADggEBAMCvNCQ3KsvncoYK9fI0cfcBYEpFuToB+duK7yztklf8P6PLRSWdU39KaG+xv5768K+xe90riOYs0Mhcs0IuUQW2F6kCnlW3ff2R3pvTeM3kGqXclk4KGKRNnhhsF3Ze8QW3drH0dzD3vNcumdLr+GvG6vF2O/Pl3+Nn9dwE72ZVl7Ai970jJM5CVjI+wST19ZQPpq1E3aad3Bk+AQcQCIGputBGkHFZUGX4T6jPH0uDOcSRjH7v6TXhF2Cury7zme0zpWYwC4RMH/AxqK4z6DlmAwu2zycN097TMM/ZUXePmvgY7JSB5BIiY4ZxlnNbJy4756XDSBt41AaHxqWNcfs=-----END CERTIFICATE-----"
  }, {
    "version" : "V3",
    "serialNumber" : "f4:80:33:5f:e5:77:2a:f7",
    "issuedTo" : "sfo01m01nsx01.sfo01.rainpole.local",
    "issuedBy" : "OU=ISBU, O=VMware, L= Bangalore, ST=Karnataka, C=IN, CN=test1.openssl.eng.vmware.com",
    "notBefore" : "2019-07-25T07:38:55.000Z",
    "notAfter" : "2020-07-24T07:38:55.000Z",
    "signatureAlgorithm" : "SHA256withRSA",
    "subject" : "C=US, CN=sfo01m01nsx01.sfo01.rainpole.local",
    "subjectAlternativeName" : [ "sfo01m01nsx01.sfo01.rainpole.local" ],
    "publicKey" : "BA:16:16:DF:00:B2:88:C9:F9:E0:7F:72:B6:DC:83:1F:87:46:C3:C4:4B:8B:EB:C0:AD:B9:A2:FB:31:75:0A:89:12:25:58:B6:42:B1:78:A3:7F:19:B0:03:19:35:AD:51:5D:08:36:CB:C3:6E:63:B2:CE:89:2D:24:AD:EA:DD:BD:73:0A:06:84:4E:4D:83:AF:B8:EC:F9:E1:98:9F:35:9F:83:11:DD:71:61:5E:CF:DE:9A:BF:0D:A7:8A:64:F2:94:26:5D:A7:E0:20:B9:C2:01:BB:62:F2:7D:C3:A9:9B:91:DE:49:1E:97:B7:E8:CA:38:1C:E9:92:76:07:A8:26:95:5D:C1:89:E7:EA:27:03:57:BE:D2:76:B5:E4:AC:89:10:67:7F:42:DA:5D:52:5C:9F:65:59:A4:42:0B:81:F8:77:B5:F8:2D:18:DA:9B:1A:F4:BD:BD:F2:33:97:7A:EA:64:1B:CE:58:CF:9C:E7:18:60:94:CE:66:C9:57:7E:62:A2:AD:47:3D:29:D2:F8:DB:AB:D7:8F:D1:7D:8A:9A:FC:68:37:48:3C:AD:38:A5:76:D8:4C:E2:64:AE:87:B7:DA:78:3E:EB:2B:C8:70:43:4D:CB:4E:72:80:43:CB:D2:43:A7:71:16:22:27:0F:A1:DB:0A:83:88:2C:09:49:0A:35:8C:76:76:55:E2:3A:1C:7C:74:F0:91:60:A2:45:7F:6C:7A:2B:A5:51:87:25:D0:DB:9C:E0:B8:32:27:83:D6:3F:70:C5:7A:1B:92:09:E7:77:39:3A:C2:28:B1:5C:8A:3F:42:FE:D6:6A:7D:F6:E5:D6:FB:B0:DB:AB:D9:65:29:BE:75:DA:07:E8:38:B2:A0:75:9F:45:8E:FF:6B:AF:27:DB:FA:2E:AB:80:51:09:88:7D:7B:AC:A4:B7:15:41:30:A0:E1:0F:C7:DD:D1:F4:84:7D:D3:F8:B1:B0:F9:55:8F:A6:DC:44:E0:E6:0F:C5:DF:32:93:51:8D:7D:BA:79:4A:3E:72:CA:CB:9A:2E:8B:E6:A0:63:57:C8:CD:92:F8:70:0A:1E:6D:CA:DF:35:D4:91:45:E7:DB:7F:86:32:E9:8C:A3:D2:D0:35:15:70:A9:DA:39:DF:FA:76:9C:EF:5D:B6:A4:58:49:EE:A0:B1:74:33:D2:41:97:F6:FE:0C:07:66:DE:56:5F:3E:15:03:70:3D:56:80:5E:F6:CB:C3:FA:78:CE:14:0C:D7:E1:53:48:8B:5A:61:C0:04:BA:DD:ED:B3:E4:F1:76:AD:FD:03:27:C9:FB:EC:5A:75:0B:22:8F:6A:E8:35:47:FB:04:B7:A7:5F:51:FA:46:EF:00:64:03:27:1C:FB",
    "publicKeyAlgorithm" : "RSA",
    "keySize" : "2048",
    "thumbprintAlgorithm" : "SHA-256",
    "thumbprint" : "02:B1:D1:01:18:9F:07:39:E1:7C:94:BC:50:07:64:E8:45:8C:F8:73:3E:A9:23:BC:D2:BD:B1:17:E9:B3:C0:11",
    "numberOfDaysToExpire" : 365,
    "expirationStatus" : "ACTIVE",
    "pemEncoded" : "-----BEGIN CERTIFICATE-----MIIFRDCCBCygAwIBAgIJAOx9cA2cGcUUMA0GCSqGSIb3DQEBCwUAMIGgMQswCQYDVQQDDAJDQTEXMBUGCgmSJomT8ixkARkWB3ZzcGhlcmUxFTATBgoJkiaJk/IsZAEZFgVsb2NhbDELMAkGA1UEBhMCVVMxEzARBgNVBAgMCkNhbGlmb3JuaWExIjAgBgNVBAoMGXBzYy0xLnZyYWNrLnZzcGhlcmUubG9jYWwxGzAZBgNVBAsMElZNd2FyZSBFbmdpbmVlcmluZzAeFw0xODA3MDIxNDE1NTJaFw0yODA2MjcxMjIyMzlaMIGwMQswCQYDVQQGEwJVUzETMBEGA1UECBMKQ2FsaWZvcm5pYTESMBAGA1UEBxMJUGFsbyBBbHRvMQ8wDQYDVQQKEwZWTXdhcmUxGzAZBgNVBAsTElZNd2FyZSBFbmdpbmVlcmluZzEqMCgGA1UEAxMhbG9hZC1iYWxhbmNlci52cmFjay52c3BoZXJlLmxvY2FsMR4wHAYJKoZIhvcNAQkBFg92bWNhQHZtd2FyZS5jb20wggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIKAoICAQC6FhbfALKIyfngf3K23IMfh0bDxEuL68CtuaL7MXUKiRIlWLZCsXijfxmwAxk1rVFdCDbLw25jss6JLSSt6t29cwoGhE5Ng6+47PnhmJ81n4MR3XFhXs/emr8Np4pk8pQmXafgILnCAbti8n3DqZuR3kkel7foyjgc6ZJ2B6gmlV3BiefqJwNXvtJ2teSsiRBnf0LaXVJcn2VZpEILgfh3tfgtGNqbGvS9vfIzl3rqZBvOWM+c5xhglM5myVd+YqKtRz0p0vjbq9eP0X2KmvxoN0g8rTildthM4mSuh7faeD7rK8hwQ03LTnKAQ8vSQ6dxFiInD6HbCoOILAlJCjWMdnZV4jocfHTwkWCiRX9seiulUYcl0Nuc4LgyJ4PWP3DFehuSCed3OTrCKLFcij9C/tZqffbl1vuw26vZZSm+ddoH6DiyoHWfRY7/a68n2/ouq4BRCYh9e6yktxVBMKDhD8fd0fSEfdP4sbD5VY+m3ETg5g/F3zKTUY19unlKPnLKy5oui+agY1fIzZL4cAoebcrfNdSRRefbf4Yy6Yyj0tA1FXCp2jnf+nac7122pFhJ7qCxdDPSQZf2/gwHZt5WXz4VA3A9VoBe9svD+njOFAzX4VNIi1phwAS63e2z5PF2rf0DJ8n77Fp1CyKPaug1R/sEt6dfUfpG7wBkAycc+wIDAQABo28wbTAJBgNVHRMEAjAAMAsGA1UdDwQEAwIF4DAyBgNVHREEKzApgiFsb2FkLWJhbGFuY2VyLnZyYWNrLnZzcGhlcmUubG9jYWyHBAoAAA8wHwYDVR0jBBgwFoAUauWGErq+/JHwQ3qju9Ch8V2097MwDQYJKoZIhvcNAQELBQADggEBAMCvNCQ3KsvncoYK9fI0cfcBYEpFuToB+duK7yztklf8P6PLRSWdU39KaG+xv5768K+xe90riOYs0Mhcs0IuUQW2F6kCnlW3ff2R3pvTeM3kGqXclk4KGKRNnhhsF3Ze8QW3drH0dzD3vNcumdLr+GvG6vF2O/Pl3+Nn9dwE72ZVl7Ai970jJM5CVjI+wST19ZQPpq1E3aad3Bk+AQcQCIGputBGkHFZUGX4T6jPH0uDOcSRjH7v6TXhF2Cury7zme0zpWYwC4RMH/AxqK4z6DlmAwu2zycN097TMM/ZUXePmvgY7JSB5BIiY4ZxlnNbJy4756XDSBt41AaHxqWNcfs=-----END CERTIFICATE-----"
  } ]
}
Tip
 Refer to: View certificate of all the resources in a domain
Warning
 Certificate installation will replace the already installed certificates.
Note
 The CSRs cannot be fetched after successful certificate installation.
Note
 Only singleton object of a particular certificate authority will exist at any point of time in the VCF environment.
Note
 Only the latest generated CSRs will exist in the VCF environment after a series of generate CSR operation.
Note
 Only the latest generated certificates will exist in the VCF environment after a series of generate certificate operation.
Related APIs

Create a certificate authority
Get certificate authorities information
Get certificate authority information
Configure existing certificate authority
Generate CSR(s)
Get available CSR(s) in json format
Generate certificate(s) for the selected resource(s) in a domain
Replace certificate(s) for the selected resource(s) in a domain
View certificate of all the resources in a domain
Get the Tasks
Get a Task

2.21.2. Install Certificates By Offline Mode

The following steps have to be followed to install certificates signed by external third party certificate authorities.

Prerequisites

  1. VCF environment.

Steps

  1. Generate CSR by invoking the API

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/domains/MGMT/csrs' -i -u 'admin:VMwareInfra@1' -X PUT \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json' \
    -d '{
  "csrGenerationSpec" : {
    "country" : "India",
    "state" : "Karnataka",
    "locality" : "Bengaluru",
    "organization" : "VMware",
    "organizationUnit" : "ISBU",
    "email" : "[email protected]",
    "keySize" : "2048",
    "keyAlgorithm" : "RSA"
  },
  "resources" : [ {
    "fqdn" : "sfo01m01nsx01.sfo01.rainpole.local",
    "type" : "NSX_MANAGER"
  } ]
}'

HTTP Request

PUT /v1/domains/MGMT/csrs HTTP/1.1
Accept: application/json
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==
Content-Length: 369
Content-Type: application/json

{
  "csrGenerationSpec" : {
    "country" : "India",
    "state" : "Karnataka",
    "locality" : "Bengaluru",
    "organization" : "VMware",
    "organizationUnit" : "ISBU",
    "email" : "[email protected]",
    "keySize" : "2048",
    "keyAlgorithm" : "RSA"
  },
  "resources" : [ {
    "fqdn" : "sfo01m01nsx01.sfo01.rainpole.local",
    "type" : "NSX_MANAGER"
  } ]
}

HTTP Response

HTTP/1.1 202 Accepted
Location: /v1/tasks/75e95d1b-f03d-4af3-9786-ec2593634f1e
Content-Type: application/json;charset=UTF-8
Content-Length: 79

{
  "id" : "75e95d1b-f03d-4af3-9786-ec2593634f1e",
  "status" : "IN_PROGRESS"
}
Tip
 Refer to: Generate CSR(s)

  • Poll the status of the task using the task API with the ID from the response of the previous API.

Tip
 Refer to: Get a Task

  • Poll the task until "status" is not "IN_PROGRESS" with the ID from the previous response.

Tip
 Refer to: Get a Task.

  • If the "status" is "SUCCESSFUL", the task is completed successfully.

  • If the "status" is "FAILED", execute the generate CSR request again.

  1. If the generation of CSR is successful, fetch the contents of the CSR to check for which resources CSR is generated by invoking the API

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/domains/MGMT/csrs' -i -u 'admin:VMwareInfra@1' -X GET \
    -H 'Accept: application/json'

HTTP Request

GET /v1/domains/MGMT/csrs HTTP/1.1
Accept: application/json
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==

HTTP Response

HTTP/1.1 200 OK
Content-Length: 1163
Content-Type: application/json;charset=UTF-8

{
  "elements" : [ {
    "csrEncodedContent" : "-----BEGIN CERTIFICATE REQUEST-----\nMIICtDCCAZwCAQAwbzELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAkNBMQswCQYDVQQH\nEwJQQTEMMAoGA1UECxMDVkNGMQ8wDQYDVQQKEwZWTXdhcmUxJzAlBgNVBAMTHm5z\neE1hbmFnZXIudnJhY2sudnNwaGVyZS5sb2NhbDCCASIwDQYJKoZIhvcNAQEBBQAD\nggEPADCCAQoCggEBAKtumknTB1do77E5rCXGRgqT6iqTgW0moiDZS6USGkeTQMvj\nR5JnQjq11xJl0y1meSdA6ufft8xndOr1b8alRs4+FreuJLl/8HBIVLRECrfkfIn0\nImwZzGFih2wwrCD/evb/7paNcdt97+KF2nwqB5ADysyFkjYs0uiJxxE5i8HsST1L\n+AStKeAV0lOk/2n/qgHPUcnjH7KchJAet9DFuKBWUW7QIryQffuiQrdAFqcEPHJC\nubHyqnoBPktosD3SXs1UickNiTyXIRC1NGHK/w7VTTJfBxkXxIdejazVGjCAW8w0\n/N4iW3rCaxSpnggWLGYFbGEkhikgtkpj8zIRjk8CAwEAAaAAMA0GCSqGSIb3DQEB\nCwUAA4IBAQBkxJTuymqggHLhWbtnvtA3mU4freKzF2XDUUP+K5kz43j2IXNbsCJI\nWDpY9OCVj9NHZ+uFTvQLvCb3E+6h0vE4Dw2PVUuOpz/Ag1qmgYIxtC5vzN4gLKih\nUNROG5wYryYKO8YL4MB3XIQdx9b8y8Fxyh3ZHIvdghhUPBooWzeCUXVPD8Le4p52\nD8yMGREtSQL4avLughd+SFd0fvKQq+/K42WOFn7PYVfgLBqdW1YCjEIfAdsG+bhG\n3CIBan84uV3cKFSM4NtxCvHZnuRZmx6+0Frtt1w9sndjKvHrA6ozoHO9O1gl/E9D\nY1rzOB7KFzGiZHAMT2Cf/x/xGo8rTGFZ\n-----END CERTIFICATE REQUEST-----",
    "resource" : {
      "fqdn" : "sfo01m01nsx01.sfo01.rainpole.local"
    }
  } ]
}
Tip
 Refer to: Get available CSR(s) in json format

  1. After successful CSR generation, download CSR in ".tar.gz" format by invoking the API

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/domains/MGMT/csrs/downloads' -i -u 'admin:VMwareInfra@1' -X GET \
    -H 'Accept: application/octet-stream'

HTTP Request

GET /v1/domains/MGMT/csrs/downloads HTTP/1.1
Host: sddc-manager.sfo01.rainpole.local
Accept: application/octet-stream
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==

HTTP Response

HTTP/1.1 200 OK
Content-Length: 1012
Accept-Ranges: bytes
Content-Type: application/octet-stream
Content-Disposition: attachment; filename="csrString.txt"

-----BEGIN CERTIFICATE REQUEST-----
MIICtDCCAZwCAQAwbzELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAkNBMQswCQYDVQQH
EwJQQTEMMAoGA1UECxMDVkNGMQ8wDQYDVQQKEwZWTXdhcmUxJzAlBgNVBAMTHm5z
eE1hbmFnZXIudnJhY2sudnNwaGVyZS5sb2NhbDCCASIwDQYJKoZIhvcNAQEBBQAD
ggEPADCCAQoCggEBAKtumknTB1do77E5rCXGRgqT6iqTgW0moiDZS6USGkeTQMvj
R5JnQjq11xJl0y1meSdA6ufft8xndOr1b8alRs4+FreuJLl/8HBIVLRECrfkfIn0
ImwZzGFih2wwrCD/evb/7paNcdt97+KF2nwqB5ADysyFkjYs0uiJxxE5i8HsST1L
+AStKeAV0lOk/2n/qgHPUcnjH7KchJAet9DFuKBWUW7QIryQffuiQrdAFqcEPHJC
ubHyqnoBPktosD3SXs1UickNiTyXIRC1NGHK/w7VTTJfBxkXxIdejazVGjCAW8w0
/N4iW3rCaxSpnggWLGYFbGEkhikgtkpj8zIRjk8CAwEAAaAAMA0GCSqGSIb3DQEB
CwUAA4IBAQBkxJTuymqggHLhWbtnvtA3mU4freKzF2XDUUP+K5kz43j2IXNbsCJI
WDpY9OCVj9NHZ+uFTvQLvCb3E+6h0vE4Dw2PVUuOpz/Ag1qmgYIxtC5vzN4gLKih
UNROG5wYryYKO8YL4MB3XIQdx9b8y8Fxyh3ZHIvdghhUPBooWzeCUXVPD8Le4p52
D8yMGREtSQL4avLughd+SFd0fvKQq+/K42WOFn7PYVfgLBqdW1YCjEIfAdsG+bhG
3CIBan84uV3cKFSM4NtxCvHZnuRZmx6+0Frtt1w9sndjKvHrA6ozoHO9O1gl/E9D
Y1rzOB7KFzGiZHAMT2Cf/x/xGo8rTGFZ
-----END CERTIFICATE REQUEST-----
Tip
 Refer to: Download available CSR(s) in tar.gz format

  1. Use the downloaded CSRs to have it manually signed by external certificate authorities.

  1. Verify that the certificate authority configuration files have been configured and packaged in the form of
    a ".tar.gz" file with the following conditions

    • The name of the top-level directory must exactly match the name of the domain to which certificates are to be installed.

    • The PEM-encoded root CA certificate chain file (rootca.crt) must reside inside this top-level directory.

    • This directory must contain one sub-directory for each component resource and the name of each sub-directory must exactly match the resource fqdn.

    • Each sub-directory must contain a corresponding ".csr" file, whose name must exactly match the
      resource fqdn followed by ".csr" extension.

    • Each sub-directory must contain a corresponding ".crt" file, whose name must exactly match the
      resource fqdn followed by ".crt" extension.

  1. Upload the packaged signed certificates by invoking the API

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/domains/MGMT/certificates/uploads' -i -u 'admin:VMwareInfra@1' -X PUT \
    -H 'Content-Type: multipart/form-data' \
    -F '[email protected];type=multipart/form-data'

HTTP Request

PUT /v1/domains/MGMT/certificates/uploads HTTP/1.1
Host: sddc-manager.sfo01.rainpole.local
Content-Type: multipart/form-data; boundary=6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==

--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Content-Disposition: form-data; name=file; filename=MGMT.tar.gz
Content-Type: multipart/form-data

-----BEGIN CERTIFICATE-----
MIIC2zCCAcMCAQAwgZUxCzAJBgNVBAYTAlVTMRMwEQYDVQQIEwpDYWxpZm9ybmlh
MRIwEAYDVQQHEwlQYWxvIEFsdG8xHjAcBgNVBAsTFVZNd2FyZSBJVCAgZGVwYXJ0
bWVudDEUMBIGA1UEChMLVk1XYXJlIEluYy4xJzAlBgNVBAMTHm5zeE1hbmFnZXIu
dnJhY2sudnNwaGVyZS5sb2NhbDCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoC
ggEBAPgggMHrSsbcC9JYjGQCDiSTsG0LPGjMcTKgEaUi6zcVKWAv7ccpvW7cwFtc
2FqtM4zlETOK0tHZmS17uUg/tsJSWq+nr2VQ541XifvZOVINcIlKnzGJO32d4qxO
3xY3lr8Pj7xZe0xZK3iP+TBiUdtHggSYJ6uWYHoZAJ74Jqp4pVdwQgjm1sINldYm
e1x+txQINQB7MFG2tflQ7iXRaiLGZKXR86xDvw/T1OcPPjtSnwFjYfeHtE2KjuT9
RiCXl4cUuH+pjQTsWSSByK0LyC8U9/tqDGnMiERxBl1g9rBKQMOoZmTCF3gr7hhx
PZ16JlYqU9hbAjPxVkGO0NkI9PsCAwEAAaAAMA0GCSqGSIb3DQEBCwUAA4IBAQAq
vqrtJ4nQepjbwOmJor2ZHOUaoqwImE3OJaa6PxaikD1c14maMXJ4XQm+ONJooCPx
CL6TVs2DSydxVzRFHj5dyAz7MJ8XIkqijvarxb+gLjhim4+O+MuS7hHaCnVU9KMg
i3QhWFc1SwDuhiHL3RXbf04gOzrbEhIPa9rBKQMOoZmTCF3gr7JiuSqBvKtG3cus
3DjxA1z9CGUgIrYBlOm2/xPDp91AIMGeP9YXh8ue/NVPZ+tlZOCgKGiS05CTK5Wr
cHaC7yQqIyZdKP9EQhv3yhxL4ho9e1xL9f4puv3CBE5VmCb8LZ/5CRIKOHEsIV70
XGKY78p5LoKf4ro2LLQ+
-----END CERTIFICATE-----
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm--

HTTP Response

HTTP/1.1 200 OK
Tip
 Refer to: Upload certificates to the certificate store

  1. After successful upload operation, install the signed certificates on remote resources by invoking the API

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/domains/MGMT/certificates' -i -u 'admin:VMwareInfra@1' -X PATCH \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json' \
    -d '{
  "operationType" : "INSTALL",
  "resources" : [ {
    "fqdn" : "sfo01m01nsx01.sfo01.rainpole.local",
    "type" : "NSX_MANAGER"
  } ]
}'

HTTP Request

PATCH /v1/domains/MGMT/certificates HTTP/1.1
Accept: application/json
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==
Content-Length: 138
Content-Type: application/json

{
  "operationType" : "INSTALL",
  "resources" : [ {
    "fqdn" : "sfo01m01nsx01.sfo01.rainpole.local",
    "type" : "NSX_MANAGER"
  } ]
}

HTTP Response

HTTP/1.1 202 Accepted
Location: /v1/tasks/6f49fc0f-6107-4542-874a-a2c170f4257b
Content-Type: application/json;charset=UTF-8
Content-Length: 79

{
  "id" : "6f49fc0f-6107-4542-874a-a2c170f4257b",
  "status" : "IN_PROGRESS"
}
Tip
 Refer to: Replace certificate(s) for the selected resource(s) in a domain

  • Poll the status of the task using the task API with the ID from the response of the previous API.

Tip
 Refer to: Get a Task

  • Poll the task until "status" is not "IN_PROGRESS" with the ID from the previous response.

Tip
 Refer to: Get a Task.

  • If the "status" is "SUCCESSFUL", the task is completed successfully.

  • If the "status" is "FAILED", the task can be re-executed.

Tip
 Refer to: Retry a Task

  1. Fetch the installed certificates by invoking the API

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/domains/MGMT/resource-certificates' -i -u 'admin:VMwareInfra@1' -X GET \
    -H 'Accept: application/json'

HTTP Request

GET /v1/domains/MGMT/resource-certificates HTTP/1.1
Accept: application/json
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==

HTTP Response

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 8486

{
  "elements" : [ {
    "version" : "V3",
    "serialNumber" : "ca:0b:5d:6d:07:4e:db:41",
    "issuedTo" : "sfo01m01vcenter01.sfo01.rainpole.local",
    "issuedBy" : "OU=VMware Engineering, O=psc-1.vrack.vsphere.local, ST=California, C=US, DC=local, DC=vsphere, CN=CA",
    "notBefore" : "2019-07-11T10:16:05.000Z",
    "notAfter" : "2029-07-06T08:17:24.000Z",
    "signatureAlgorithm" : "SHA256withRSA",
    "subject" : "C=US, CN=vcenter-1.vrack.vsphere.local",
    "subjectAlternativeName" : [ "vcenter-1.vrack.vsphere.local" ],
    "publicKey" : "BA:16:16:DF:00:B2:88:C9:F9:E0:7F:72:B6:DC:83:1F:87:46:C3:C4:4B:8B:EB:C0:AD:B9:A2:FB:31:75:0A:89:12:25:58:B6:42:B1:78:A3:7F:19:B0:03:19:35:AD:51:5D:08:36:CB:C3:6E:63:B2:CE:89:2D:24:AD:EA:DD:BD:73:0A:06:84:4E:4D:83:AF:B8:EC:F9:E1:98:9F:35:9F:83:11:DD:71:61:5E:CF:DE:9A:BF:0D:A7:8A:64:F2:94:26:5D:A7:E0:20:B9:C2:01:BB:62:F2:7D:C3:A9:9B:91:DE:49:1E:97:B7:E8:CA:38:1C:E9:92:76:07:A8:26:95:5D:C1:89:E7:EA:27:03:57:BE:D2:76:B5:E4:AC:89:10:67:7F:42:DA:5D:52:5C:9F:65:59:A4:42:0B:81:F8:77:B5:F8:2D:18:DA:9B:1A:F4:BD:BD:F2:33:97:7A:EA:64:1B:CE:58:CF:9C:E7:18:60:94:CE:66:C9:57:7E:62:A2:AD:47:3D:29:D2:F8:DB:AB:D7:8F:D1:7D:8A:9A:FC:68:37:48:3C:AD:38:A5:76:D8:4C:E2:64:AE:87:B7:DA:78:3E:EB:2B:C8:70:43:4D:CB:4E:72:80:43:CB:D2:43:A7:71:16:22:27:0F:A1:DB:0A:83:88:2C:09:49:0A:35:8C:76:76:55:E2:3A:1C:7C:74:F0:91:60:A2:45:7F:6C:7A:2B:A5:51:87:25:D0:DB:9C:E0:B8:32:27:83:D6:3F:70:C5:7A:1B:92:09:E7:77:39:3A:C2:28:B1:5C:8A:3F:42:FE:D6:6A:7D:F6:E5:D6:FB:B0:DB:AB:D9:65:29:BE:75:DA:07:E8:38:B2:A0:75:9F:45:8E:FF:6B:AF:27:DB:FA:2E:AB:80:51:09:88:7D:7B:AC:A4:B7:15:41:30:A0:E1:0F:C7:DD:D1:F4:84:7D:D3:F8:B1:B0:F9:55:8F:A6:DC:44:E0:E6:0F:C5:DF:32:93:51:8D:7D:BA:79:4A:3E:72:CA:CB:9A:2E:8B:E6:A0:63:57:C8:CD:92:F8:70:0A:1E:6D:CA:DF:35:D4:91:45:E7:DB:7F:86:32:E9:8C:A3:D2:D0:35:15:70:A9:DA:39:DF:FA:76:9C:EF:5D:B6:A4:58:49:EE:A0:B1:74:33:D2:41:97:F6:FE:0C:07:66:DE:56:5F:3E:15:03:70:3D:56:80:5E:F6:CB:C3:FA:78:CE:14:0C:D7:E1:53:48:8B:5A:61:C0:04:BA:DD:ED:B3:E4:F1:76:AD:FD:03:27:C9:FB:EC:5A:75:0B:22:8F:6A:E8:35:47:FB:04:B7:A7:5F:51:FA:46:EF:00:64:03:27:1C:FB",
    "publicKeyAlgorithm" : "RSA",
    "keySize" : "2048",
    "thumbprintAlgorithm" : "SHA-256",
    "thumbprint" : "35:4B:A5:11:A9:3D:39:0D:B7:95:9B:4D:07:5C:73:40:D0:DF:63:D4:68:97:6E:1B:20:70:87:AE:40:3F:7E:AD",
    "numberOfDaysToExpire" : 3644,
    "expirationStatus" : "ACTIVE",
    "pemEncoded" : "-----BEGIN CERTIFICATE-----MIIFRDCCBCygAwIBAgIJAOx9cA2cGcUUMA0GCSqGSIb3DQEBCwUAMIGgMQswCQYDVQQDDAJDQTEXMBUGCgmSJomT8ixkARkWB3ZzcGhlcmUxFTATBgoJkiaJk/IsZAEZFgVsb2NhbDELMAkGA1UEBhMCVVMxEzARBgNVBAgMCkNhbGlmb3JuaWExIjAgBgNVBAoMGXBzYy0xLnZyYWNrLnZzcGhlcmUubG9jYWwxGzAZBgNVBAsMElZNd2FyZSBFbmdpbmVlcmluZzAeFw0xODA3MDIxNDE1NTJaFw0yODA2MjcxMjIyMzlaMIGwMQswCQYDVQQGEwJVUzETMBEGA1UECBMKQ2FsaWZvcm5pYTESMBAGA1UEBxMJUGFsbyBBbHRvMQ8wDQYDVQQKEwZWTXdhcmUxGzAZBgNVBAsTElZNd2FyZSBFbmdpbmVlcmluZzEqMCgGA1UEAxMhbG9hZC1iYWxhbmNlci52cmFjay52c3BoZXJlLmxvY2FsMR4wHAYJKoZIhvcNAQkBFg92bWNhQHZtd2FyZS5jb20wggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIKAoICAQC6FhbfALKIyfngf3K23IMfh0bDxEuL68CtuaL7MXUKiRIlWLZCsXijfxmwAxk1rVFdCDbLw25jss6JLSSt6t29cwoGhE5Ng6+47PnhmJ81n4MR3XFhXs/emr8Np4pk8pQmXafgILnCAbti8n3DqZuR3kkel7foyjgc6ZJ2B6gmlV3BiefqJwNXvtJ2teSsiRBnf0LaXVJcn2VZpEILgfh3tfgtGNqbGvS9vfIzl3rqZBvOWM+c5xhglM5myVd+YqKtRz0p0vjbq9eP0X2KmvxoN0g8rTildthM4mSuh7faeD7rK8hwQ03LTnKAQ8vSQ6dxFiInD6HbCoOILAlJCjWMdnZV4jocfHTwkWCiRX9seiulUYcl0Nuc4LgyJ4PWP3DFehuSCed3OTrCKLFcij9C/tZqffbl1vuw26vZZSm+ddoH6DiyoHWfRY7/a68n2/ouq4BRCYh9e6yktxVBMKDhD8fd0fSEfdP4sbD5VY+m3ETg5g/F3zKTUY19unlKPnLKy5oui+agY1fIzZL4cAoebcrfNdSRRefbf4Yy6Yyj0tA1FXCp2jnf+nac7122pFhJ7qCxdDPSQZf2/gwHZt5WXz4VA3A9VoBe9svD+njOFAzX4VNIi1phwAS63e2z5PF2rf0DJ8n77Fp1CyKPaug1R/sEt6dfUfpG7wBkAycc+wIDAQABo28wbTAJBgNVHRMEAjAAMAsGA1UdDwQEAwIF4DAyBgNVHREEKzApgiFsb2FkLWJhbGFuY2VyLnZyYWNrLnZzcGhlcmUubG9jYWyHBAoAAA8wHwYDVR0jBBgwFoAUauWGErq+/JHwQ3qju9Ch8V2097MwDQYJKoZIhvcNAQELBQADggEBAMCvNCQ3KsvncoYK9fI0cfcBYEpFuToB+duK7yztklf8P6PLRSWdU39KaG+xv5768K+xe90riOYs0Mhcs0IuUQW2F6kCnlW3ff2R3pvTeM3kGqXclk4KGKRNnhhsF3Ze8QW3drH0dzD3vNcumdLr+GvG6vF2O/Pl3+Nn9dwE72ZVl7Ai970jJM5CVjI+wST19ZQPpq1E3aad3Bk+AQcQCIGputBGkHFZUGX4T6jPH0uDOcSRjH7v6TXhF2Cury7zme0zpWYwC4RMH/AxqK4z6DlmAwu2zycN097TMM/ZUXePmvgY7JSB5BIiY4ZxlnNbJy4756XDSBt41AaHxqWNcfs=-----END CERTIFICATE-----"
  }, {
    "version" : "V3",
    "serialNumber" : "f4:80:33:5f:e5:77:2a:f7",
    "issuedTo" : "sfo01m01nsx01.sfo01.rainpole.local",
    "issuedBy" : "OU=ISBU, O=VMware, L= Bangalore, ST=Karnataka, C=IN, CN=test1.openssl.eng.vmware.com",
    "notBefore" : "2019-07-25T07:38:55.000Z",
    "notAfter" : "2020-07-24T07:38:55.000Z",
    "signatureAlgorithm" : "SHA256withRSA",
    "subject" : "C=US, CN=sfo01m01nsx01.sfo01.rainpole.local",
    "subjectAlternativeName" : [ "sfo01m01nsx01.sfo01.rainpole.local" ],
    "publicKey" : "BA:16:16:DF:00:B2:88:C9:F9:E0:7F:72:B6:DC:83:1F:87:46:C3:C4:4B:8B:EB:C0:AD:B9:A2:FB:31:75:0A:89:12:25:58:B6:42:B1:78:A3:7F:19:B0:03:19:35:AD:51:5D:08:36:CB:C3:6E:63:B2:CE:89:2D:24:AD:EA:DD:BD:73:0A:06:84:4E:4D:83:AF:B8:EC:F9:E1:98:9F:35:9F:83:11:DD:71:61:5E:CF:DE:9A:BF:0D:A7:8A:64:F2:94:26:5D:A7:E0:20:B9:C2:01:BB:62:F2:7D:C3:A9:9B:91:DE:49:1E:97:B7:E8:CA:38:1C:E9:92:76:07:A8:26:95:5D:C1:89:E7:EA:27:03:57:BE:D2:76:B5:E4:AC:89:10:67:7F:42:DA:5D:52:5C:9F:65:59:A4:42:0B:81:F8:77:B5:F8:2D:18:DA:9B:1A:F4:BD:BD:F2:33:97:7A:EA:64:1B:CE:58:CF:9C:E7:18:60:94:CE:66:C9:57:7E:62:A2:AD:47:3D:29:D2:F8:DB:AB:D7:8F:D1:7D:8A:9A:FC:68:37:48:3C:AD:38:A5:76:D8:4C:E2:64:AE:87:B7:DA:78:3E:EB:2B:C8:70:43:4D:CB:4E:72:80:43:CB:D2:43:A7:71:16:22:27:0F:A1:DB:0A:83:88:2C:09:49:0A:35:8C:76:76:55:E2:3A:1C:7C:74:F0:91:60:A2:45:7F:6C:7A:2B:A5:51:87:25:D0:DB:9C:E0:B8:32:27:83:D6:3F:70:C5:7A:1B:92:09:E7:77:39:3A:C2:28:B1:5C:8A:3F:42:FE:D6:6A:7D:F6:E5:D6:FB:B0:DB:AB:D9:65:29:BE:75:DA:07:E8:38:B2:A0:75:9F:45:8E:FF:6B:AF:27:DB:FA:2E:AB:80:51:09:88:7D:7B:AC:A4:B7:15:41:30:A0:E1:0F:C7:DD:D1:F4:84:7D:D3:F8:B1:B0:F9:55:8F:A6:DC:44:E0:E6:0F:C5:DF:32:93:51:8D:7D:BA:79:4A:3E:72:CA:CB:9A:2E:8B:E6:A0:63:57:C8:CD:92:F8:70:0A:1E:6D:CA:DF:35:D4:91:45:E7:DB:7F:86:32:E9:8C:A3:D2:D0:35:15:70:A9:DA:39:DF:FA:76:9C:EF:5D:B6:A4:58:49:EE:A0:B1:74:33:D2:41:97:F6:FE:0C:07:66:DE:56:5F:3E:15:03:70:3D:56:80:5E:F6:CB:C3:FA:78:CE:14:0C:D7:E1:53:48:8B:5A:61:C0:04:BA:DD:ED:B3:E4:F1:76:AD:FD:03:27:C9:FB:EC:5A:75:0B:22:8F:6A:E8:35:47:FB:04:B7:A7:5F:51:FA:46:EF:00:64:03:27:1C:FB",
    "publicKeyAlgorithm" : "RSA",
    "keySize" : "2048",
    "thumbprintAlgorithm" : "SHA-256",
    "thumbprint" : "02:B1:D1:01:18:9F:07:39:E1:7C:94:BC:50:07:64:E8:45:8C:F8:73:3E:A9:23:BC:D2:BD:B1:17:E9:B3:C0:11",
    "numberOfDaysToExpire" : 365,
    "expirationStatus" : "ACTIVE",
    "pemEncoded" : "-----BEGIN CERTIFICATE-----MIIFRDCCBCygAwIBAgIJAOx9cA2cGcUUMA0GCSqGSIb3DQEBCwUAMIGgMQswCQYDVQQDDAJDQTEXMBUGCgmSJomT8ixkARkWB3ZzcGhlcmUxFTATBgoJkiaJk/IsZAEZFgVsb2NhbDELMAkGA1UEBhMCVVMxEzARBgNVBAgMCkNhbGlmb3JuaWExIjAgBgNVBAoMGXBzYy0xLnZyYWNrLnZzcGhlcmUubG9jYWwxGzAZBgNVBAsMElZNd2FyZSBFbmdpbmVlcmluZzAeFw0xODA3MDIxNDE1NTJaFw0yODA2MjcxMjIyMzlaMIGwMQswCQYDVQQGEwJVUzETMBEGA1UECBMKQ2FsaWZvcm5pYTESMBAGA1UEBxMJUGFsbyBBbHRvMQ8wDQYDVQQKEwZWTXdhcmUxGzAZBgNVBAsTElZNd2FyZSBFbmdpbmVlcmluZzEqMCgGA1UEAxMhbG9hZC1iYWxhbmNlci52cmFjay52c3BoZXJlLmxvY2FsMR4wHAYJKoZIhvcNAQkBFg92bWNhQHZtd2FyZS5jb20wggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIKAoICAQC6FhbfALKIyfngf3K23IMfh0bDxEuL68CtuaL7MXUKiRIlWLZCsXijfxmwAxk1rVFdCDbLw25jss6JLSSt6t29cwoGhE5Ng6+47PnhmJ81n4MR3XFhXs/emr8Np4pk8pQmXafgILnCAbti8n3DqZuR3kkel7foyjgc6ZJ2B6gmlV3BiefqJwNXvtJ2teSsiRBnf0LaXVJcn2VZpEILgfh3tfgtGNqbGvS9vfIzl3rqZBvOWM+c5xhglM5myVd+YqKtRz0p0vjbq9eP0X2KmvxoN0g8rTildthM4mSuh7faeD7rK8hwQ03LTnKAQ8vSQ6dxFiInD6HbCoOILAlJCjWMdnZV4jocfHTwkWCiRX9seiulUYcl0Nuc4LgyJ4PWP3DFehuSCed3OTrCKLFcij9C/tZqffbl1vuw26vZZSm+ddoH6DiyoHWfRY7/a68n2/ouq4BRCYh9e6yktxVBMKDhD8fd0fSEfdP4sbD5VY+m3ETg5g/F3zKTUY19unlKPnLKy5oui+agY1fIzZL4cAoebcrfNdSRRefbf4Yy6Yyj0tA1FXCp2jnf+nac7122pFhJ7qCxdDPSQZf2/gwHZt5WXz4VA3A9VoBe9svD+njOFAzX4VNIi1phwAS63e2z5PF2rf0DJ8n77Fp1CyKPaug1R/sEt6dfUfpG7wBkAycc+wIDAQABo28wbTAJBgNVHRMEAjAAMAsGA1UdDwQEAwIF4DAyBgNVHREEKzApgiFsb2FkLWJhbGFuY2VyLnZyYWNrLnZzcGhlcmUubG9jYWyHBAoAAA8wHwYDVR0jBBgwFoAUauWGErq+/JHwQ3qju9Ch8V2097MwDQYJKoZIhvcNAQELBQADggEBAMCvNCQ3KsvncoYK9fI0cfcBYEpFuToB+duK7yztklf8P6PLRSWdU39KaG+xv5768K+xe90riOYs0Mhcs0IuUQW2F6kCnlW3ff2R3pvTeM3kGqXclk4KGKRNnhhsF3Ze8QW3drH0dzD3vNcumdLr+GvG6vF2O/Pl3+Nn9dwE72ZVl7Ai970jJM5CVjI+wST19ZQPpq1E3aad3Bk+AQcQCIGputBGkHFZUGX4T6jPH0uDOcSRjH7v6TXhF2Cury7zme0zpWYwC4RMH/AxqK4z6DlmAwu2zycN097TMM/ZUXePmvgY7JSB5BIiY4ZxlnNbJy4756XDSBt41AaHxqWNcfs=-----END CERTIFICATE-----"
  } ]
}
Tip
 Refer to: View certificate of all the resources in a domain
Warning
 Certificate installation will replace the already installed certificates.
Note
 The CSRs cannot be fetched or downloaded after successful certificate installation.
Note
 Only the latest generated CSRs will exist in the VCF environment after a series of generate CSR operation.
Note
 Only the latest uploaded certificates will exist in the VCF environment after a series of upload certificate operation.
Related APIs

Generate CSR(s)
Get available CSR(s) in json format
Download available CSR(s) in tar.gz format
Upload certificates to the certificate store
Replace certificate(s) for the selected resource(s) in a domain
View certificate of all the resources in a domain
Get the Tasks
Get a Task

2.22. vCenters

2.22.1. Get a vCenter

Prerequisites

  1. The following data is required

    • ID of the vCenter

Steps

  1. Invoke the API.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/vcenters/c0703437-6756-470b-9e1c-f9d3bbc9b1c6' -i -u 'admin:VMwareInfra@1' -X GET

HTTP Request

GET /v1/vcenters/c0703437-6756-470b-9e1c-f9d3bbc9b1c6 HTTP/1.1
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==

HTTP Response

HTTP/1.1 200 OK
Content-Length: 196
Content-Type: application/json;charset=UTF-8

{
  "id" : "c0703437-6756-470b-9e1c-f9d3bbc9b1c6",
  "fqdn" : "vi-1-vcenter.vrack.vsphere.local",
  "ipAddress" : "10.0.0.6",
  "domain" : {
    "id" : "c0703437-6746-470b-9e1c-f9d3bbc9b1c5"
  }
}
Related APIs

Get vCenters
Get a vCenter

2.22.2. Get the vCenters

Prerequisites

None

Get All vCenters

Steps

  1. Invoke the API.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/vcenters' -i -u 'admin:VMwareInfra@1' -X GET

HTTP Request

GET /v1/vcenters HTTP/1.1
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==

HTTP Response

HTTP/1.1 200 OK
Content-Length: 447
Content-Type: application/json;charset=UTF-8

{
  "elements" : [ {
    "id" : "c0703437-6756-470b-9e1c-f9d3bbc9b1c6",
    "fqdn" : "vi-1-vcenter.vrack.vsphere.local",
    "ipAddress" : "10.0.0.6",
    "domain" : {
      "id" : "c0703437-6746-470b-9e1c-f9d3bbc9b1c5"
    }
  }, {
    "id" : "c0703437-6846-470b-9e1c-f9d3bbc9b1c9",
    "fqdn" : "vdi-1-vcenter.vrack.vsphere.local",
    "ipAddress" : "10.0.0.20",
    "domain" : {
      "id" : "c0703437-6746-470b-9e1c-f9d3bbc9b1c1"
    }
  } ]
}
Related APIs

Get vCenters
Get a vCenter

2.22.3. Get vCenters for a domain

Prerequisites

  1. The following data is required

    • ID of the Domain

Steps

  1. Invoke the API.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/vcenters?domainId=c0703437-6746-470b-9e1c-f9d3bbc9b1c5' -i -u 'admin:VMwareInfra@1' -X GET

HTTP Request

GET /v1/vcenters?domainId=c0703437-6746-470b-9e1c-f9d3bbc9b1c5 HTTP/1.1
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==

HTTP Response

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 233

{
  "elements" : [ {
    "id" : "c0703437-6756-470b-9e1c-f9d3bbc9b1c6",
    "fqdn" : "vi-1-vcenter.vrack.vsphere.local",
    "ipAddress" : "10.0.0.6",
    "domain" : {
      "id" : "c0703437-6746-470b-9e1c-f9d3bbc9b1c5"
    }
  } ]
}
Related APIs

Get vCenters
Get a vCenter

2.23. NSX Managers

2.23.1. Get a NsxManager

Prerequisites

  1. The following data is required

    • ID of the Nsx Manager

Steps

  1. Invoke the API.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/nsx-managers/c835d2e3-2c20-4210-8740-dced0cf4a8ad' -i -u 'admin:VMwareInfra@1' -X GET

HTTP Request

GET /v1/nsx-managers/c835d2e3-2c20-4210-8740-dced0cf4a8ad HTTP/1.1
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==

HTTP Response

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 265

{
  "id" : "c835d2e3-2c20-4210-8740-dced0cf4a8ad",
  "fqdn" : "nsxManager.vrack.vsphere.local",
  "ipAddress" : "10.0.0.9",
  "domain" : {
    "id" : "c7bb62fa-6237-495e-b90f-d752cb33eb45"
  },
  "vcenter" : {
    "id" : "6d82ed59-6870-4642-ad6e-36802713874f"
  }
}
Related APIs

Get NsxManagers
Get a NsxManager

2.23.2. Get the NsxManagers

Prerequisites

None

Get All NsxManagers

Steps

  1. Invoke the API.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/nsx-managers' -i -u 'admin:VMwareInfra@1' -X GET

HTTP Request

GET /v1/nsx-managers HTTP/1.1
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==

HTTP Response

HTTP/1.1 200 OK
Content-Length: 601
Content-Type: application/json;charset=UTF-8

{
  "elements" : [ {
    "id" : "c835d2e3-2c20-4210-8740-dced0cf4a8ad",
    "fqdn" : "nsxManager.vrack.vsphere.local",
    "ipAddress" : "10.0.0.9",
    "domain" : {
      "id" : "c7bb62fa-6237-495e-b90f-d752cb33eb45"
    },
    "vcenter" : {
      "id" : "6d82ed59-6870-4642-ad6e-36802713874f"
    }
  }, {
    "id" : "c835d2e4-2c21-4210-8740-dced0cf4a8ae",
    "fqdn" : "vi-1-nsxManager.vrack.vsphere.local",
    "ipAddress" : "10.0.0.30",
    "domain" : {
      "id" : "c7bb62f1-6237-495e-b90f-d752cb33eb46"
    },
    "vcenter" : {
      "id" : "6d82ed50-6870-4642-ad6e-368027138748"
    }
  } ]
}
Related APIs

Get NsxManagers
Get a NsxManager

2.23.3. Get NsxManagers for a domain

Prerequisites

  1. The following data is required

    • ID of the Domain

Steps

  1. Invoke the API.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/nsx-managers?domainId=c7bb62fa-6237-495e-b90f-d752cb33eb45' -i -u 'admin:VMwareInfra@1' -X GET

HTTP Request

GET /v1/nsx-managers?domainId=c7bb62fa-6237-495e-b90f-d752cb33eb45 HTTP/1.1
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==

HTTP Response

HTTP/1.1 200 OK
Content-Length: 308
Content-Type: application/json;charset=UTF-8

{
  "elements" : [ {
    "id" : "c835d2e3-2c20-4210-8740-dced0cf4a8ad",
    "fqdn" : "nsxManager.vrack.vsphere.local",
    "ipAddress" : "10.0.0.9",
    "domain" : {
      "id" : "c7bb62fa-6237-495e-b90f-d752cb33eb45"
    },
    "vcenter" : {
      "id" : "6d82ed59-6870-4642-ad6e-36802713874f"
    }
  } ]
}
Related APIs

Get NsxManagers
Get a NsxManager

2.24. NSX-T Clusters

2.24.1. Get a Nsx-T Cluster

Prerequisites

  1. The following data is required

    • ID of the Nsx-T Cluster

Steps

  1. Invoke the API.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/nsxt-clusters/0b338542-3a22-4662-84c2-f5a8d4a8f0e7' -i -u 'admin:VMwareInfra@1' -X GET

HTTP Request

GET /v1/nsxt-clusters/0b338542-3a22-4662-84c2-f5a8d4a8f0e7 HTTP/1.1
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==

HTTP Response

HTTP/1.1 200 OK
Content-Length: 491
Content-Type: application/json;charset=UTF-8

{
  "id" : "0b338542-3a22-4662-84c2-f5a8d4a8f0e7",
  "fqdn" : "vip-nsxmanager.vrack.vsphere.local",
  "ipAddress" : "10.0.0.166",
  "domains" : [ {
    "id" : "deb5b689-2217-4cfe-82cb-c591f392d27e"
  } ],
  "nodes" : [ {
    "fqdn" : "nsxt-manager.vrack.vsphere.local",
    "vmName" : "nsxt-manager"
  }, {
    "fqdn" : "vi-nsxmanager-2.vrack.vsphere.local",
    "vmName" : "vi-nsxmanager-2"
  }, {
    "fqdn" : "vi-nsxmanager-3.vrack.vsphere.local",
    "vmName" : "vi-nsxmanager-3"
  } ]
}
Related APIs

Get the NSX-T clusters
Get a NSX-T cluster

2.24.2. Get the Nsx-T Clusters

Prerequisites

None

Get All Nsx-T Clusters

Steps

  1. Invoke the API.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/nsxt-clusters' -i -u 'admin:VMwareInfra@1' -X GET

HTTP Request

GET /v1/nsxt-clusters HTTP/1.1
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==

HTTP Response

HTTP/1.1 200 OK
Content-Length: 548
Content-Type: application/json;charset=UTF-8

{
  "elements" : [ {
    "id" : "0b338542-3a22-4662-84c2-f5a8d4a8f0e7",
    "fqdn" : "vip-nsxmanager.vrack.vsphere.local",
    "ipAddress" : "10.0.0.166",
    "domains" : [ {
      "id" : "deb5b689-2217-4cfe-82cb-c591f392d27e"
    } ],
    "nodes" : [ {
      "fqdn" : "nsxt-manager.vrack.vsphere.local",
      "vmName" : "nsxt-manager"
    }, {
      "fqdn" : "vi-nsxmanager-2.vrack.vsphere.local",
      "vmName" : "vi-nsxmanager-2"
    }, {
      "fqdn" : "vi-nsxmanager-3.vrack.vsphere.local",
      "vmName" : "vi-nsxmanager-3"
    } ]
  } ]
}
Related APIs

Get the NSX-T clusters
Get a NSX-T cluster

2.25. Platform Service Controllers

2.25.1. Get a PSC

Prerequisites

  1. The following data is required

    • ID of the PSC

Steps

  1. Invoke the API.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/pscs/5aa499d2-4e9f-4221-8b57-abcd5cc3b142' -i -u 'admin:VMwareInfra@1' -X GET

HTTP Request

GET /v1/pscs/5aa499d2-4e9f-4221-8b57-abcd5cc3b142 HTTP/1.1
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==

HTTP Response

HTTP/1.1 200 OK
Content-Length: 295
Content-Type: application/json;charset=UTF-8

{
  "id" : "5aa499d2-4e9f-4221-8b57-abcd5cc3b142",
  "fqdn" : "psc-1.vrack.vsphere.local",
  "ipAddress" : "10.0.0.5",
  "ssoDomainName" : "vsphere.local",
  "ssoSubDomainName" : "vrack.vsphere.local",
  "isReplica" : false,
  "domain" : {
    "id" : "c0703437-6746-470b-9e1c-f9d3bbc9b1c5"
  }
}
Related APIs

Get the PSCs
Get a PSC

2.25.2. Get the PSCs

Prerequisites

None

Steps

  1. Invoke the API.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/pscs' -i -u 'admin:VMwareInfra@1' -X GET

HTTP Request

GET /v1/pscs HTTP/1.1
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==

HTTP Response

HTTP/1.1 200 OK
Content-Length: 654
Content-Type: application/json;charset=UTF-8

{
  "elements" : [ {
    "id" : "5aa499d2-4e9f-4221-8b57-abcd5cc3b142",
    "fqdn" : "psc-1.vrack.vsphere.local",
    "ipAddress" : "10.0.0.5",
    "ssoDomainName" : "vsphere.local",
    "ssoSubDomainName" : "vrack.vsphere.local",
    "isReplica" : false,
    "domain" : {
      "id" : "c0703437-6746-470b-9e1c-f9d3bbc9b1c5"
    }
  }, {
    "id" : "6e9f56aa-4afb-4101-91a0-1b011fab6241",
    "fqdn" : "psc-2.vrack.vsphere.local",
    "ipAddress" : "10.0.0.7",
    "ssoDomainName" : "vsphere.local",
    "ssoSubDomainName" : "vrack.vsphere.local",
    "isReplica" : true,
    "domain" : {
      "id" : "c0703437-6746-470b-9e1c-f9d3bbc9b1c5"
    }
  } ]
}
Related APIs

Get the PSCs
Get a PSC

2.26. SDDC Managers

2.26.1. Get a Sddc Manager

Prerequisites

  1. The following data is required

    • ID of the Sddc Manager

Steps

  1. Invoke the API.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/sddc-managers/ebb0944f-3b86-4872-9afa-2e80ce814c8f' -i -u 'admin:VMwareInfra@1' -X GET

HTTP Request

GET /v1/sddc-managers/ebb0944f-3b86-4872-9afa-2e80ce814c8f HTTP/1.1
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==

HTTP Response

HTTP/1.1 200 OK
Content-Length: 230
Content-Type: application/json;charset=UTF-8

{
  "id" : "ebb0944f-3b86-4872-9afa-2e80ce814c8f",
  "fqdn" : "sddc-manager.vrack.vsphere.local",
  "version" : "3.9.0.0-14713675",
  "ipAddress" : "10.0.0.4",
  "domain" : {
    "id" : "d1f91ef5-dfa2-48e7-adde-cd37b0aa7911"
  }
}
Related APIs

Get the Sddc Managers
Get a Sddc Manager

2.26.2. Get the Sddc Managers

Prerequisites

None

Steps

  1. Invoke the API.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/sddc-managers' -i -u 'admin:VMwareInfra@1' -X GET

HTTP Request

GET /v1/sddc-managers HTTP/1.1
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==

HTTP Response

HTTP/1.1 200 OK
Content-Length: 269
Content-Type: application/json;charset=UTF-8

{
  "elements" : [ {
    "id" : "ebb0944f-3b86-4872-9afa-2e80ce814c8f",
    "fqdn" : "sddc-manager.vrack.vsphere.local",
    "version" : "3.9.0.0-14713675",
    "ipAddress" : "10.0.0.4",
    "domain" : {
      "id" : "d1f91ef5-dfa2-48e7-adde-cd37b0aa7911"
    }
  } ]
}
Related APIs

Get the Sddc Managers
Get a Sddc Manager

2.27. VCF Services

2.27.1. Get a VCF Service

Prerequisites

  1. The following data is required

    • ID of the VCF Service

Steps

  1. Invoke the API.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/vcf-services/bc0debfe-bd38-453a-822d-fdd012fbd0b2' -i -u 'admin:VMwareInfra@1' -X GET

HTTP Request

GET /v1/vcf-services/bc0debfe-bd38-453a-822d-fdd012fbd0b2 HTTP/1.1
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==

HTTP Response

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 112

{
  "id" : "bc0debfe-bd38-453a-822d-fdd012fbd0b2",
  "name" : "COMMON_SERVICES",
  "version" : "3.8.2-RELEASE"
}
Related APIs

Get the VcfServices
Get a VcfService

2.27.2. Get the VCF Services

Prerequisites

None

Steps

  1. Invoke the API.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/vcf-services' -i -u 'admin:VMwareInfra@1' -X GET

HTTP Request

GET /v1/vcf-services HTTP/1.1
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==

HTTP Response

HTTP/1.1 200 OK
Content-Length: 744
Content-Type: application/json;charset=UTF-8

{
  "elements" : [ {
    "id" : "bc0debfe-bd38-453a-822d-fdd012fbd0b2",
    "name" : "COMMON_SERVICES",
    "version" : "3.8.2-RELEASE"
  }, {
    "id" : "174ca011-0f17-48ec-a4cb-8fc3d35149bd",
    "name" : "DOMAIN_MANAGER",
    "version" : "3.8.2-RELEASE"
  }, {
    "id" : "8c64a3f9-fa12-4d00-ba19-9fe747e2bda",
    "name" : "OPERATIONS_MANAGER",
    "version" : "3.8.2-RELEASE"
  }, {
    "id" : "8bd696dc-958a-482a-9747-4f4e172a3005",
    "name" : "LCM",
    "version" : "3.8.2-RELEASE"
  }, {
    "id" : "9294a99d-8755-4298-9fb6-a255ab6a12f4",
    "name" : "SDDC_MANAGER_UI",
    "version" : "3.8.2-RELEASE"
  }, {
    "id" : "20f1f50f-8e50-4f19-9fd0-3472330b0fb2",
    "name" : "SOLUTIONS_MANAGER",
    "version" : "3.8.2-RELEASE"
  } ]
}
Related APIs

Get the VcfServices
Get a VcfService

2.28. Multi Site Management

2.28.1. Create a Multi Site Management Federation

A federation is a group of Cloud Foundation instances, such that each member can view information about the other Cloud Foundation instances in the group. The federation creator is granted the controller role by default.

You can create multiple federations within your organization, but global visibility is available only within a federation. Members can belong to only a single federation at a time.

Prerequisites

  1. The following data is required

    • Name of the federation

    • Member Details

      • FQDN of the Member

      • Role of the Member (CONTROLLER)

      • Site Type (DATACENTER)

      • Site Name

      • City where the site is located

      • State where the site is located (Optional)

      • Country where the site is located

      • Location coordinates

        • Longitude

        • Latitude

  2. Ensure, VCF Instance Role is set to NOT_JOINED.

Tip
 Refer to: Get fact about a VMware Cloud Foundation
Steps

  1. Trigger the Create Federation
    cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/sddc-federation' -i -u 'admin:VMwareInfra@1' -X PUT \
    -H 'Content-Type: application/json' \
    -d '{
  "federationName" : "New Federation",
  "memberJoinDetail" : {
    "role" : "CONTROLLER",
    "fqdn" : "sddc-manager-1.vrack.vsphere.local",
    "siteType" : "DATACENTER",
    "siteName" : "Palo Alto Epic Center",
    "country" : "USA",
    "state" : "California",
    "city" : "Palo Alto",
    "coordinate" : {
      "longitude" : -122.838,
      "latitude" : 37.286
    }
  }
}'

HTTP Request

PUT /v1/sddc-federation HTTP/1.1
Content-Length: 382
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==
Content-Type: application/json

{
  "federationName" : "New Federation",
  "memberJoinDetail" : {
    "role" : "CONTROLLER",
    "fqdn" : "sddc-manager-1.vrack.vsphere.local",
    "siteType" : "DATACENTER",
    "siteName" : "Palo Alto Epic Center",
    "country" : "USA",
    "state" : "California",
    "city" : "Palo Alto",
    "coordinate" : {
      "longitude" : -122.838,
      "latitude" : 37.286
    }
  }
}

HTTP Response

HTTP/1.1 202 Accepted
Content-Type: application/json;charset=UTF-8
Content-Length: 246

{
  "status" : "SUCCEEDED",
  "operation" : null,
  "taskId" : "1a8f8148-e19e-44eb-b1a4-24f92dfbe43f",
  "remoteOperationTask" : null,
  "progressDetails" : null,
  "created" : null,
  "lastUpdated" : null,
  "errors" : null,
  "payload" : null
}

  1. Create federation API returns task object. Task object has the task id.

  2. Poll the workflow status using the task ID with request
    TIP: Refer to: Get a Task

  3. Validates the input specification.
    **Validates if VCF instance Role is other than CONTROLLER

  4. Initialize the fabric services

  5. Initialize the topics

  6. Initialize persistent store

  7. Add member to federation

  8. Update persistent store with new member details

    • If the "status" is "SUCCEEDED", the task is completed successfully.

    • If the "status" is "FAILED", the task can be re-executed.

Related APIs

Get fact about a VMware Cloud Foundation
Get details of a federation

2.28.2. Join the Federation

You can join a federation as a controller or member depending on the assigned role in the invitation.
Use the token you received as part of the invitation, to trigger a join API.

An invitation is valid for ten days. You must request a new invitation after this period.

Prerequisites

  1. The following data is required

    • Controller FQDN

      • You can provide any of the controllers FQDN to join the federation. However, it is preferred to provide
        the FQDN of the controller who sent out the invitation.

    • Token

      • Token you received from the controller as part of the invitation.

    • Member Details

      • Role of the invitee, this should match the role you provided during invite.

      • FQDN of the invitee

      • Type of the site, it will always be "DATACENTER" for 1.0 release

      • Name of the site

      • Country

      • State

      • City

      • Coordinate of the site

        • Longitude

        • Latitude

Steps

Provide above inputs and invoke the API.
If the request goes through successfully, we should see this new member on the world map.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/sddc-federation/members' -i -u 'admin:VMwareInfra@1' -X POST \
    -H 'Content-Type: application/json' \
    -d '{
  "controllerFqdn" : "sddc-manager-1.vrack.vsphere.local",
  "joinToken" : "test",
  "commonName" : "sddcmgr-newyork.msm.local",
  "memberJoinDetail" : {
    "role" : "MEMBER",
    "fqdn" : "sddcmgr-newyork.msm.local",
    "siteType" : "DATACENTER",
    "siteName" : "New York Epic Center",
    "country" : "USA",
    "state" : "New York",
    "city" : "New York",
    "coordinate" : {
      "longitude" : -74.006,
      "latitude" : 40.712
    }
  }
}'

HTTP Request

POST /v1/sddc-federation/members HTTP/1.1
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==
Content-Type: application/json
Content-Length: 454

{
  "controllerFqdn" : "sddc-manager-1.vrack.vsphere.local",
  "joinToken" : "test",
  "commonName" : "sddcmgr-newyork.msm.local",
  "memberJoinDetail" : {
    "role" : "MEMBER",
    "fqdn" : "sddcmgr-newyork.msm.local",
    "siteType" : "DATACENTER",
    "siteName" : "New York Epic Center",
    "country" : "USA",
    "state" : "New York",
    "city" : "New York",
    "coordinate" : {
      "longitude" : -74.006,
      "latitude" : 40.712
    }
  }
}

HTTP Response

HTTP/1.1 202 Accepted
Content-Type: application/json;charset=UTF-8
Content-Length: 246

{
  "status" : "SUCCEEDED",
  "operation" : null,
  "taskId" : "119a87ef-74ae-4db2-bb30-59be14a9e17a",
  "remoteOperationTask" : null,
  "progressDetails" : null,
  "created" : null,
  "lastUpdated" : null,
  "errors" : null,
  "payload" : null
}
Related APIs

Invite a VMware Cloud Foundation to be member of a federation
Get progress of an invoked operation
Leave a VMware Cloud Foundation from a federation

2.28.3. Leave from the federation

Leaving a federation removes the Multi-Instance Management view from your SDDC Manager dashboard.

If you are a controller, you can leave a federation only if there is at least one more controller in the federation.
If you are the only controller member in a federation, you must dismantle a federation instead of leaving it.

Prerequisites

  1. The following data is required

    • ID (FQDN) of the member to be deleted, specified as a path variable.

      • If member ID is equal to the FQDN of invoking SDDC Manager, it is treated as leave.

      • Otherwise, it is treated as evicting the member (specified by ID) by invoking SDDC Manager. In this case the invoking SDDC Manager must be a Controller.

  2. The following data is optional

    • force, true if the leaving member will not contact controller, but shut down local system only, false otherwise. Default is false. Specified as request body.

  3. If the invoking SDDC Manager is the only member in the federation, do not use leave, but teardown instead.

Steps

  1. If ID is the same as FQDN of invoking SDDC Manager and force is false

    • This member will issue rest request to a remote controller asking for leave, if the remote response
      is successful, it will then shut down its local system. Persistent store will be archived and cleaned up.

  2. If ID is the same as FQDN of invoking SDDC Manager and force is true

    • This member will not contact remote controller but show down its local system directly. Persistent store will be archived and cleaned up.

  3. If ID is the different from FQDN of invoking SDDC Manager

    • The invoking SDDC Manager will evict the member (specified by ID) from federation and ask the evictee to clean its system.
      force variable in this case doesn’t matter.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/sddc-federation/members/sddcmgr-newyork.msm.local' -i -u 'admin:VMwareInfra@1' -X DELETE

HTTP Request

DELETE /v1/sddc-federation/members/sddcmgr-newyork.msm.local HTTP/1.1
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==

HTTP Response

HTTP/1.1 202 Accepted
Content-Disposition: inline;filename=f.txt
Content-Type: application/json;charset=UTF-8
Content-Length: 246

{
  "status" : "SUCCEEDED",
  "operation" : null,
  "taskId" : "033686d0-ae50-4d8c-8640-96aa21d55e68",
  "remoteOperationTask" : null,
  "progressDetails" : null,
  "created" : null,
  "lastUpdated" : null,
  "errors" : null,
  "payload" : null
}

To Force remove the member use following:

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/sddc-federation/members/sddcmgr-newyork.msm.local' -i -u 'admin:VMwareInfra@1' -X DELETE

HTTP Request

DELETE /v1/sddc-federation/members/sddcmgr-newyork.msm.local HTTP/1.1
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==

HTTP Response

HTTP/1.1 202 Accepted
Content-Disposition: inline;filename=f.txt
Content-Type: application/json;charset=UTF-8
Content-Length: 246

{
  "status" : "SUCCEEDED",
  "operation" : null,
  "taskId" : "9fce617e-57fd-4897-86bd-bc60ed7ad22f",
  "remoteOperationTask" : null,
  "progressDetails" : null,
  "created" : null,
  "lastUpdated" : null,
  "errors" : null,
  "payload" : null
}
Related APIs

Teardown a federation

2.28.4. Tear Down Federation

You can dismantle a federation if you are the last controller member in the federation.
Only members with the controller role can dismantle a federation.

Prerequisites

  1. No request body is needed.

  2. Invoking SDDC Manager must be of Controller role, and the only one in the federation.

Steps

  1. All fabric services previously set up will be shut down.

  2. Persistent store will be archived and cleaned up.

cURL Request

$ curl 'https://sddc-manager.sfo01.rainpole.local/v1/sddc-federation' -i -u 'admin:VMwareInfra@1' -X DELETE

HTTP Request

DELETE /v1/sddc-federation HTTP/1.1
Host: sddc-manager.sfo01.rainpole.local
Authorization: Basic YWRtaW46Vk13YXJlSW5mcmFAMQ==

HTTP Response

HTTP/1.1 202 Accepted
Content-Type: application/json;charset=UTF-8
Content-Length: 246

{
  "status" : "SUCCEEDED",
  "operation" : null,
  "taskId" : "4fc7a8fe-4cdf-42a2-a822-cf7577c0287f",
  "remoteOperationTask" : null,
  "progressDetails" : null,
  "created" : null,
  "lastUpdated" : null,
  "errors" : null,
  "payload" : null
}
Related APIs

Bootstrap a VMware Cloud Foundation to form a federation

3. Paths

3.1. Trigger backup

POST /v1/backups/tasks

3.1.1. Parameters

Type Name Description Schema

Body

backupsSpec
required

backupsSpec

BackupSpec

3.1.2. Responses

HTTP Code Description Schema

200

OK

BackupTask

202

Accepted

BackupTask

400

Bad Request

Error

500

Internal server error

Error

3.1.3. Consumes

  • application/json

3.1.4. Produces

  • application/json

3.1.5. Tags

  • BackupRestore

3.1.6. Security

Type Name

basic

basicAuth

3.1.7. Example HTTP request

Request path
/v1/backups/tasks
Request body
{
  "elements" : [ {
    "resourceType" : "SDDC_MANAGER"
  } ]
}

3.1.8. Example HTTP response

Response 200
{
  "errors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "id" : "string",
  "name" : "string",
  "resources" : [ {
    "fqdn" : "string",
    "name" : "string",
    "resourceId" : "string",
    "type" : "string"
  } ],
  "status" : "One among: IN_PROGRESS"
}
Response 202
{
  "errors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "id" : "string",
  "name" : "string",
  "resources" : [ {
    "fqdn" : "string",
    "name" : "string",
    "resourceId" : "string",
    "type" : "string"
  } ],
  "status" : "One among: IN_PROGRESS"
}
Response 400
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 500
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.2. Upload a Bundle

POST /v1/bundles

3.2.1. Description

Upload Bundle to SDDC Manager. Used when you do not have internet connectivity for downloading bundles from VMWare/VxRail to SDDC Manager. The Bundles are manually downloaded from Depot using Bundle Transfer utility

3.2.2. Parameters

Type Name Description Schema

Body

bundleUploadSpec
required

Bundle Upload Specification

BundleUploadSpec

3.2.3. Responses

HTTP Code Description Schema

200

OK

Task

202

Accepted

Task

400

Bad Request

Error

500

Internal Server Error

Error

3.2.4. Consumes

  • application/json

3.2.5. Produces

  • application/json

3.2.6. Tags

  • Bundles

3.2.7. Security

Type Name

basic

basicAuth

3.2.8. Example HTTP request

Request path
/v1/bundles
Request body
{
  "bundleFilePath" : "string",
  "manifestFilePath" : "string",
  "signatureFilePath" : "string"
}

3.2.9. Example HTTP response

Response 200
{
  "completionTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "creationTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "errors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "id" : "string",
  "isCancellable" : true,
  "name" : "string",
  "resources" : [ {
    "fqdn" : "string",
    "name" : "string",
    "resourceId" : "string",
    "type" : "string"
  } ],
  "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
  "subTasks" : [ {
    "completionTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "creationTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "description" : "string",
    "errors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "name" : "string",
    "resources" : [ {
      "fqdn" : "string",
      "name" : "string",
      "resourceId" : "string",
      "type" : "string"
    } ],
    "stages" : [ {
      "completionTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "creationTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "description" : "string",
      "name" : "string",
      "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
      "type" : "string"
    } ],
    "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
    "type" : "string"
  } ],
  "type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}
Response 202
{
  "completionTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "creationTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "errors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "id" : "string",
  "isCancellable" : true,
  "name" : "string",
  "resources" : [ {
    "fqdn" : "string",
    "name" : "string",
    "resourceId" : "string",
    "type" : "string"
  } ],
  "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
  "subTasks" : [ {
    "completionTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "creationTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "description" : "string",
    "errors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "name" : "string",
    "resources" : [ {
      "fqdn" : "string",
      "name" : "string",
      "resourceId" : "string",
      "type" : "string"
    } ],
    "stages" : [ {
      "completionTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "creationTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "description" : "string",
      "name" : "string",
      "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
      "type" : "string"
    } ],
    "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
    "type" : "string"
  } ],
  "type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}
Response 400
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 500
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.3. Get the Bundles

GET /v1/bundles

3.3.1. Description

Get all Bundles i.e uploaded bundles and also bundles available via depot access.

3.3.2. Responses

HTTP Code Description Schema

200

Ok

PageOfBundle

500

Internal Server Error

Error

3.3.3. Consumes

  • application/json

3.3.4. Produces

  • application/json

3.3.5. Tags

  • Bundles

3.3.6. Security

Type Name

basic

basicAuth

3.3.7. Example HTTP request

Request path
/v1/bundles

3.3.8. Example HTTP response

Response 200
{
  "elements" : [ {
    "components" : [ {
      "description" : "string",
      "fromVersion" : "string",
      "id" : "string",
      "imageType" : "One among: PATCH, INSTALL",
      "releasedDate" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "toVersion" : "string",
      "type" : "string",
      "vendor" : "string"
    } ],
    "description" : "string",
    "downloadStatus" : "One among: PENDING, SCHEDULED, IN_PROGRESS, SUCCESSFUL, FAILED",
    "id" : "string",
    "isCumulative" : true,
    "releasedDate" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "severity" : "One among: CRITICAL, IMPORTANT, MODERATE, LOW",
    "sizeMB" : 0.0,
    "type" : "One among: SDDC_MANAGER, VMWARE_SOFTWARE, VXRAIL",
    "vendor" : "string",
    "version" : "string"
  } ]
}
Response 500
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.4. Get a Bundle

GET /v1/bundles/{id}

3.4.1. Description

Get a Bundle

3.4.2. Parameters

Type Name Description Schema

Path

id
required

Bundle ID

string

3.4.3. Responses

HTTP Code Description Schema

200

Ok

Bundle

404

Bundle Not Found

Error

500

Internal Server Error

Error

3.4.4. Consumes

  • application/json

3.4.5. Produces

  • application/json

3.4.6. Tags

  • Bundles

3.4.7. Security

Type Name

basic

basicAuth

3.4.8. Example HTTP request

Request path
/v1/bundles/string

3.4.9. Example HTTP response

Response 200
{
  "components" : [ {
    "description" : "string",
    "fromVersion" : "string",
    "id" : "string",
    "imageType" : "One among: PATCH, INSTALL",
    "releasedDate" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "toVersion" : "string",
    "type" : "string",
    "vendor" : "string"
  } ],
  "description" : "string",
  "downloadStatus" : "One among: PENDING, SCHEDULED, IN_PROGRESS, SUCCESSFUL, FAILED",
  "id" : "string",
  "isCumulative" : true,
  "releasedDate" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "severity" : "One among: CRITICAL, IMPORTANT, MODERATE, LOW",
  "sizeMB" : 0.0,
  "type" : "One among: SDDC_MANAGER, VMWARE_SOFTWARE, VXRAIL",
  "vendor" : "string",
  "version" : "string"
}
Response 404
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 500
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.5. Update a Bundle for downloading from depot

PATCH /v1/bundles/{id}

3.5.1. Description

Update a Bundle for scheduling/triggering download. Only one download can triggered for a Bundle.

3.5.2. Parameters

Type Name Description Schema

Path

id
required

Bundle ID

string

Body

bundleUpdateSpec
required

Bundle Update Specification

BundleUpdateSpec

3.5.3. Responses

HTTP Code Description Schema

200

OK

Task

202

Accepted

Task

400

Bad Request

Error

409

Conflict

Error

500

Internal Server Error

Error

3.5.4. Consumes

  • application/json

3.5.5. Produces

  • application/json

3.5.6. Tags

  • Bundles

3.5.7. Security

Type Name

basic

basicAuth

3.5.8. Example HTTP request

Request path
/v1/bundles/string
Request body
{
  "bundleDownloadSpec" : {
    "downloadNow" : true,
    "scheduledTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    }
  }
}

3.5.9. Example HTTP response

Response 200
{
  "completionTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "creationTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "errors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "id" : "string",
  "isCancellable" : true,
  "name" : "string",
  "resources" : [ {
    "fqdn" : "string",
    "name" : "string",
    "resourceId" : "string",
    "type" : "string"
  } ],
  "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
  "subTasks" : [ {
    "completionTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "creationTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "description" : "string",
    "errors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "name" : "string",
    "resources" : [ {
      "fqdn" : "string",
      "name" : "string",
      "resourceId" : "string",
      "type" : "string"
    } ],
    "stages" : [ {
      "completionTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "creationTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "description" : "string",
      "name" : "string",
      "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
      "type" : "string"
    } ],
    "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
    "type" : "string"
  } ],
  "type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}
Response 202
{
  "completionTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "creationTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "errors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "id" : "string",
  "isCancellable" : true,
  "name" : "string",
  "resources" : [ {
    "fqdn" : "string",
    "name" : "string",
    "resourceId" : "string",
    "type" : "string"
  } ],
  "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
  "subTasks" : [ {
    "completionTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "creationTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "description" : "string",
    "errors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "name" : "string",
    "resources" : [ {
      "fqdn" : "string",
      "name" : "string",
      "resourceId" : "string",
      "type" : "string"
    } ],
    "stages" : [ {
      "completionTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "creationTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "description" : "string",
      "name" : "string",
      "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
      "type" : "string"
    } ],
    "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
    "type" : "string"
  } ],
  "type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}
Response 400
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 409
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 500
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.6. Get certificate authorities information

GET /v1/certificate-authorities

3.6.1. Description

Get certificate authorities information

3.6.2. Responses

HTTP Code Description Schema

200

OK

PageOfCertificateAuthority

400

Bad request

Error

500

Internal Server Error

Error

3.6.3. Consumes

  • application/json

3.6.4. Produces

  • application/json

3.6.5. Tags

  • Certificates

3.6.6. Security

Type Name

basic

basicAuth

3.6.7. Example HTTP request

Request path
/v1/certificate-authorities

3.6.8. Example HTTP response

Response 200
{
  "elements" : [ {
    "commonName" : "string",
    "country" : "string",
    "id" : "One among: OpenSSL, Microsoft",
    "locality" : "string",
    "organization" : "string",
    "organizationUnit" : "string",
    "serverUrl" : "string",
    "state" : "string",
    "templateName" : "string",
    "username" : "string"
  } ]
}
Response 400
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 500
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.7. Create a certificate authority

PUT /v1/certificate-authorities

3.7.1. Description

Creates a certificate authority. This is required to generate signed certificates by supporting CAs.

3.7.2. Parameters

Type Name Description Schema

Body

certificateAuthorityCreationSpec
required

certificateAuthorityCreationSpec

CertificateAuthorityCreationSpec

3.7.3. Responses

HTTP Code Description Schema

200

OK

object

400

Bad request

Error

500

Internal server error

Error

3.7.4. Consumes

  • application/json

3.7.5. Produces

  • */*

3.7.6. Tags

  • Certificates

3.7.7. Security

Type Name

basic

basicAuth

3.7.8. Example HTTP request

Request path
/v1/certificate-authorities
Request body
{
  "microsoftCertificateAuthoritySpec" : {
    "secret" : "string",
    "serverUrl" : "string",
    "templateName" : "string",
    "username" : "string"
  },
  "openSSLCertificateAuthoritySpec" : {
    "commonName" : "string",
    "country" : "string",
    "locality" : "string",
    "organization" : "string",
    "organizationUnit" : "string",
    "state" : "string"
  }
}

3.7.9. Example HTTP response

Response 200
{ }
Response 400
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 500
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.8. Configure existing certificate authority

PATCH /v1/certificate-authorities

3.8.1. Description

Configure existing certificate authority

3.8.2. Parameters

Type Name Description Schema

Body

certificateAuthoritySpec
required

certificateAuthoritySpec

CertificateAuthorityCreationSpec

3.8.3. Responses

HTTP Code Description Schema

200

OK

object

400

Bad request

Error

404

Not Found

Error

500

Internal server error

Error

3.8.4. Consumes

  • application/json

3.8.5. Produces

  • */*

3.8.6. Tags

  • Certificates

3.8.7. Security

Type Name

basic

basicAuth

3.8.8. Example HTTP request

Request path
/v1/certificate-authorities
Request body
{
  "microsoftCertificateAuthoritySpec" : {
    "secret" : "string",
    "serverUrl" : "string",
    "templateName" : "string",
    "username" : "string"
  },
  "openSSLCertificateAuthoritySpec" : {
    "commonName" : "string",
    "country" : "string",
    "locality" : "string",
    "organization" : "string",
    "organizationUnit" : "string",
    "state" : "string"
  }
}

3.8.9. Example HTTP response

Response 200
{ }
Response 400
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 404
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 500
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.9. Get certificate authority information

GET /v1/certificate-authorities/{id}

3.9.1. Description

Get certificate authority information

3.9.2. Parameters

Type Name Description Schema

Path

id
required

CA type

string

3.9.3. Responses

HTTP Code Description Schema

200

OK

CertificateAuthority

404

Not Found

Error

500

Internal Server Error

Error

3.9.4. Consumes

  • application/json

3.9.5. Produces

  • application/json

3.9.6. Tags

  • Certificates

3.9.7. Security

Type Name

basic

basicAuth

3.9.8. Example HTTP request

Request path
/v1/certificate-authorities/string

3.9.9. Example HTTP response

Response 200
{
  "commonName" : "string",
  "country" : "string",
  "id" : "One among: OpenSSL, Microsoft",
  "locality" : "string",
  "organization" : "string",
  "organizationUnit" : "string",
  "serverUrl" : "string",
  "state" : "string",
  "templateName" : "string",
  "username" : "string"
}
Response 404
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 500
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.10. Create a Cluster and add to an existing Domain

POST /v1/clusters

3.10.1. Parameters

Type Name Description Schema

Body

clusterCreationSpec
required

Cluster Creation Spec

ClusterCreationSpec

3.10.2. Responses

HTTP Code Description Schema

200

OK

Task

202

Accepted

Task

400

Bad Request

Error

500

InternalServerError

Error

3.10.3. Consumes

  • application/json

3.10.4. Produces

  • application/json

3.10.5. Tags

  • Clusters

3.10.6. Security

Type Name

basic

basicAuth

3.10.7. Example HTTP request

Request path
/v1/clusters
Request body
{
  "computeSpec" : {
    "clusterSpecs" : [ {
      "advancedOptions" : {
        "evcMode" : "One among: INTEL_MEROM, INTEL_PENRYN, INTEL_NEALEM, INTEL_WESTMERE, INTEL_SANDYBRIDGE, INTEL_IVYBRIDGE, INTEL_HASWELL, INTEL_BROADWELL, INTEL_SKYLAKE, AMD_REV_E, AMD_REV_F, AMD_GREYHOUND_NO3DNOW, AMD_GREYHOUND, AMD_BULLDOZER, AMD_PILEDRIVER, AMD_STREAMROLLER, AMD_ZEN",
        "highAvailability" : {
          "enabled" : true
        }
      },
      "datastoreSpec" : {
        "nfsDatastoreSpecs" : [ {
          "datastoreName" : "string",
          "nasVolume" : {
            "path" : "string",
            "readOnly" : true,
            "serverName" : [ "string" ],
            "userTag" : "string"
          }
        } ],
        "vmfsDatastoreSpec" : {
          "fcSpec" : [ {
            "datastoreName" : "string"
          } ]
        },
        "vsanDatastoreSpec" : {
          "datastoreName" : "string",
          "dedupAndCompressionEnabled" : true,
          "failuresToTolerate" : 0,
          "licenseKey" : "string"
        }
      },
      "hostSpecs" : [ {
        "hostNetworkSpec" : {
          "vmNics" : [ {
            "id" : "string",
            "vdsName" : "string"
          } ]
        },
        "id" : "string",
        "licenseKey" : "string"
      } ],
      "name" : "string",
      "networkSpec" : {
        "nsxClusterSpec" : {
          "nsxTClusterSpec" : {
            "geneveVlanId" : 0
          },
          "nsxVClusterSpec" : {
            "licenseKey" : "string",
            "vdsNameForVxlanConfig" : "string",
            "vlanId" : 0
          }
        },
        "vdsSpecs" : [ {
          "name" : "string",
          "niocBandwidthAllocationSpecs" : [ {
            "niocTrafficResourceAllocation" : {
              "limit" : 0,
              "reservation" : 0
            },
            "type" : "string"
          } ],
          "portGroupSpecs" : [ {
            "name" : "string",
            "transportType" : "One among: VSAN, VMOTION, MANAGEMENT, PUBLIC, NFS"
          } ]
        } ]
      }
    } ]
  },
  "domainId" : "string"
}

3.10.8. Example HTTP response

Response 200
{
  "completionTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "creationTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "errors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "id" : "string",
  "isCancellable" : true,
  "name" : "string",
  "resources" : [ {
    "fqdn" : "string",
    "name" : "string",
    "resourceId" : "string",
    "type" : "string"
  } ],
  "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
  "subTasks" : [ {
    "completionTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "creationTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "description" : "string",
    "errors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "name" : "string",
    "resources" : [ {
      "fqdn" : "string",
      "name" : "string",
      "resourceId" : "string",
      "type" : "string"
    } ],
    "stages" : [ {
      "completionTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "creationTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "description" : "string",
      "name" : "string",
      "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
      "type" : "string"
    } ],
    "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
    "type" : "string"
  } ],
  "type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}
Response 202
{
  "completionTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "creationTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "errors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "id" : "string",
  "isCancellable" : true,
  "name" : "string",
  "resources" : [ {
    "fqdn" : "string",
    "name" : "string",
    "resourceId" : "string",
    "type" : "string"
  } ],
  "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
  "subTasks" : [ {
    "completionTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "creationTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "description" : "string",
    "errors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "name" : "string",
    "resources" : [ {
      "fqdn" : "string",
      "name" : "string",
      "resourceId" : "string",
      "type" : "string"
    } ],
    "stages" : [ {
      "completionTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "creationTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "description" : "string",
      "name" : "string",
      "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
      "type" : "string"
    } ],
    "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
    "type" : "string"
  } ],
  "type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}
Response 400
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 500
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.11. Get the Clusters

GET /v1/clusters

3.11.1. Parameters

Type Name Description Schema

Query

isStretched
optional

isStretched

boolean

3.11.2. Responses

HTTP Code Description Schema

200

Ok

PageOfCluster

400

Bad Request

Error

500

InternalServerError

Error

3.11.3. Consumes

  • application/json

3.11.4. Produces

  • application/json

3.11.5. Tags

  • Clusters

3.11.6. Security

Type Name

basic

basicAuth

3.11.7. Example HTTP request

Request path
/v1/clusters

3.11.8. Example HTTP response

Response 200
{
  "elements" : [ {
    "hosts" : [ {
      "id" : "string"
    } ],
    "id" : "string",
    "isStretched" : true,
    "name" : "string",
    "primaryDatastoreName" : "string",
    "primaryDatastoreType" : "One among: VSAN, NFS, FC"
  } ]
}
Response 400
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 500
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.12. Validate the input spec for clusters operations

POST /v1/clusters/validations

3.12.1. Parameters

Type Name Description Schema

Body

clustersOperationSpecValidation
required

Clusters Operation Spec Validation

ClustersOperationSpecValidation

3.12.2. Responses

HTTP Code Description Schema

200

Ok

Validation

400

Bad Request

Error

500

InternalServerError

Error

3.12.3. Consumes

  • application/json

3.12.4. Produces

  • application/json

3.12.5. Tags

  • Clusters

3.12.6. Security

Type Name

basic

basicAuth

3.12.7. Example HTTP request

Request path
/v1/clusters/validations
Request body
{
  "clusterCreationSpec" : {
    "computeSpec" : {
      "clusterSpecs" : [ {
        "advancedOptions" : {
          "evcMode" : "One among: INTEL_MEROM, INTEL_PENRYN, INTEL_NEALEM, INTEL_WESTMERE, INTEL_SANDYBRIDGE, INTEL_IVYBRIDGE, INTEL_HASWELL, INTEL_BROADWELL, INTEL_SKYLAKE, AMD_REV_E, AMD_REV_F, AMD_GREYHOUND_NO3DNOW, AMD_GREYHOUND, AMD_BULLDOZER, AMD_PILEDRIVER, AMD_STREAMROLLER, AMD_ZEN",
          "highAvailability" : {
            "enabled" : true
          }
        },
        "datastoreSpec" : {
          "nfsDatastoreSpecs" : [ {
            "datastoreName" : "string",
            "nasVolume" : {
              "path" : "string",
              "readOnly" : true,
              "serverName" : [ "string" ],
              "userTag" : "string"
            }
          } ],
          "vmfsDatastoreSpec" : {
            "fcSpec" : [ {
              "datastoreName" : "string"
            } ]
          },
          "vsanDatastoreSpec" : {
            "datastoreName" : "string",
            "dedupAndCompressionEnabled" : true,
            "failuresToTolerate" : 0,
            "licenseKey" : "string"
          }
        },
        "hostSpecs" : [ {
          "hostNetworkSpec" : {
            "vmNics" : [ {
              "id" : "string",
              "vdsName" : "string"
            } ]
          },
          "id" : "string",
          "licenseKey" : "string"
        } ],
        "name" : "string",
        "networkSpec" : {
          "nsxClusterSpec" : {
            "nsxTClusterSpec" : {
              "geneveVlanId" : 0
            },
            "nsxVClusterSpec" : {
              "licenseKey" : "string",
              "vdsNameForVxlanConfig" : "string",
              "vlanId" : 0
            }
          },
          "vdsSpecs" : [ {
            "name" : "string",
            "niocBandwidthAllocationSpecs" : [ {
              "niocTrafficResourceAllocation" : {
                "limit" : 0,
                "reservation" : 0
              },
              "type" : "string"
            } ],
            "portGroupSpecs" : [ {
              "name" : "string",
              "transportType" : "One among: VSAN, VMOTION, MANAGEMENT, PUBLIC, NFS"
            } ]
          } ]
        }
      } ]
    },
    "domainId" : "string"
  }
}

3.12.8. Example HTTP response

Response 200
{
  "description" : "string",
  "executionStatus" : "One among: IN_PROGRESS, FAILED, COMPLETED, SKIPPED, CANCELLED",
  "id" : "string",
  "resultStatus" : "One among: SUCCEEDED, FAILED, FAILED_WITH_WARNINGS",
  "validationChecks" : [ {
    "description" : "string",
    "errorResponse" : {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ {
        "arguments" : [ "string" ],
        "causes" : [ {
          "message" : "string",
          "type" : "string"
        } ],
        "context" : {
          "string" : "string"
        },
        "errorCode" : "string",
        "message" : "string",
        "nestedErrors" : [ "..." ],
        "referenceToken" : "string",
        "remediationMessage" : "string"
      } ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    },
    "nestedValidationChecks" : [ {
      "description" : "string",
      "errorResponse" : {
        "arguments" : [ "string" ],
        "causes" : [ {
          "message" : "string",
          "type" : "string"
        } ],
        "context" : {
          "string" : "string"
        },
        "errorCode" : "string",
        "message" : "string",
        "nestedErrors" : [ "..." ],
        "referenceToken" : "string",
        "remediationMessage" : "string"
      },
      "nestedValidationChecks" : [ "..." ],
      "resultStatus" : "One among: SUCCEEDED, FAILED",
      "severity" : "One among: WARNING, ERROR, INFO"
    } ],
    "resultStatus" : "One among: SUCCEEDED, FAILED",
    "severity" : "One among: WARNING, ERROR, INFO"
  } ]
}
Response 400
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 500
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.13. Get a Cluster

GET /v1/clusters/{id}

3.13.1. Parameters

Type Name Description Schema

Path

id
required

Cluster ID

string

3.13.2. Responses

HTTP Code Description Schema

200

Ok

Cluster

404

Cluster not found

Error

500

InternalServerError

Error

3.13.3. Consumes

  • application/json

3.13.4. Produces

  • application/json

3.13.5. Tags

  • Clusters

3.13.6. Security

Type Name

basic

basicAuth

3.13.7. Example HTTP request

Request path
/v1/clusters/string

3.13.8. Example HTTP response

Response 200
{
  "hosts" : [ {
    "id" : "string"
  } ],
  "id" : "string",
  "isStretched" : true,
  "name" : "string",
  "primaryDatastoreName" : "string",
  "primaryDatastoreType" : "One among: VSAN, NFS, FC"
}
Response 404
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 500
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.14. Delete a Cluster from a Domain if it has been previously initialized for deletion

DELETE /v1/clusters/{id}

3.14.1. Parameters

Type Name Description Schema

Path

id
required

Cluster ID

string

3.14.2. Responses

HTTP Code Description Schema

200

OK

Task

202

Accepted

Task

400

Bad Request

Error

404

Not Found

Error

500

InternalServerError

Error

3.14.3. Consumes

  • application/json

3.14.4. Produces

  • application/json

3.14.5. Tags

  • Clusters

3.14.6. Security

Type Name

basic

basicAuth

3.14.7. Example HTTP request

Request path
/v1/clusters/string

3.14.8. Example HTTP response

Response 200
{
  "completionTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "creationTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "errors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "id" : "string",
  "isCancellable" : true,
  "name" : "string",
  "resources" : [ {
    "fqdn" : "string",
    "name" : "string",
    "resourceId" : "string",
    "type" : "string"
  } ],
  "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
  "subTasks" : [ {
    "completionTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "creationTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "description" : "string",
    "errors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "name" : "string",
    "resources" : [ {
      "fqdn" : "string",
      "name" : "string",
      "resourceId" : "string",
      "type" : "string"
    } ],
    "stages" : [ {
      "completionTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "creationTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "description" : "string",
      "name" : "string",
      "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
      "type" : "string"
    } ],
    "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
    "type" : "string"
  } ],
  "type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}
Response 202
{
  "completionTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "creationTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "errors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "id" : "string",
  "isCancellable" : true,
  "name" : "string",
  "resources" : [ {
    "fqdn" : "string",
    "name" : "string",
    "resourceId" : "string",
    "type" : "string"
  } ],
  "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
  "subTasks" : [ {
    "completionTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "creationTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "description" : "string",
    "errors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "name" : "string",
    "resources" : [ {
      "fqdn" : "string",
      "name" : "string",
      "resourceId" : "string",
      "type" : "string"
    } ],
    "stages" : [ {
      "completionTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "creationTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "description" : "string",
      "name" : "string",
      "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
      "type" : "string"
    } ],
    "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
    "type" : "string"
  } ],
  "type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}
Response 400
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 404
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 500
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.15. Update a Cluster by adding or removing Hosts, Stretching a standard vSAN cluster, Unstretching a stretched cluster or by marking for deletion

PATCH /v1/clusters/{id}

3.15.1. Parameters

Type Name Description Schema

Path

id
required

Cluster ID

string

Body

clusterUpdateSpec
required

Cluster Update Data

ClusterUpdateSpec

3.15.2. Responses

HTTP Code Description Schema

200

Ok

Task

202

Accepted

Task

400

Bad Request

Error

404

Not Found

Error

500

InternalServerError

Error

3.15.3. Consumes

  • application/json

3.15.4. Produces

  • application/json

3.15.5. Tags

  • Clusters

3.15.6. Security

Type Name

basic

basicAuth

3.15.7. Example HTTP request

Request path
/v1/clusters/string
Request body
{
  "clusterCompactionSpec" : {
    "force" : true,
    "hosts" : [ {
      "id" : "string"
    } ]
  },
  "clusterExpansionSpec" : {
    "hostSpecs" : [ {
      "hostNetworkSpec" : {
        "vmNics" : [ {
          "id" : "string",
          "vdsName" : "string"
        } ]
      },
      "id" : "string",
      "licenseKey" : "string"
    } ]
  },
  "clusterStretchSpec" : {
    "hostSpecs" : [ {
      "hostNetworkSpec" : {
        "vmNics" : [ {
          "id" : "string",
          "vdsName" : "string"
        } ]
      },
      "id" : "string",
      "licenseKey" : "string"
    } ],
    "witnessSpec" : {
      "fqdn" : "string",
      "vsanCidr" : "string",
      "vsanIp" : "string"
    }
  },
  "clusterUnstretchSpec" : { },
  "markForDeletion" : true
}

3.15.8. Example HTTP response

Response 200
{
  "completionTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "creationTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "errors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "id" : "string",
  "isCancellable" : true,
  "name" : "string",
  "resources" : [ {
    "fqdn" : "string",
    "name" : "string",
    "resourceId" : "string",
    "type" : "string"
  } ],
  "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
  "subTasks" : [ {
    "completionTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "creationTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "description" : "string",
    "errors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "name" : "string",
    "resources" : [ {
      "fqdn" : "string",
      "name" : "string",
      "resourceId" : "string",
      "type" : "string"
    } ],
    "stages" : [ {
      "completionTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "creationTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "description" : "string",
      "name" : "string",
      "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
      "type" : "string"
    } ],
    "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
    "type" : "string"
  } ],
  "type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}
Response 202
{
  "completionTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "creationTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "errors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "id" : "string",
  "isCancellable" : true,
  "name" : "string",
  "resources" : [ {
    "fqdn" : "string",
    "name" : "string",
    "resourceId" : "string",
    "type" : "string"
  } ],
  "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
  "subTasks" : [ {
    "completionTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "creationTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "description" : "string",
    "errors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "name" : "string",
    "resources" : [ {
      "fqdn" : "string",
      "name" : "string",
      "resourceId" : "string",
      "type" : "string"
    } ],
    "stages" : [ {
      "completionTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "creationTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "description" : "string",
      "name" : "string",
      "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
      "type" : "string"
    } ],
    "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
    "type" : "string"
  } ],
  "type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}
Response 400
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 404
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 500
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.16. Validate the input spec for operations on a cluster

POST /v1/clusters/{id}/validations

3.16.1. Parameters

Type Name Description Schema

Path

id
required

Cluster ID

string

Body

clusterOperationSpecValidation
required

clusterOperationSpecValidation

ClusterOperationSpecValidation

3.16.2. Responses

HTTP Code Description Schema

200

Ok

Validation

400

Bad Request

Error

404

Not Found

Error

500

InternalServerError

Error

3.16.3. Consumes

  • application/json

3.16.4. Produces

  • application/json

3.16.5. Tags

  • Clusters

3.16.6. Security

Type Name

basic

basicAuth

3.16.7. Example HTTP request

Request path
/v1/clusters/string/validations
Request body
{
  "clusterUpdateSpec" : {
    "clusterCompactionSpec" : {
      "force" : true,
      "hosts" : [ {
        "id" : "string"
      } ]
    },
    "clusterExpansionSpec" : {
      "hostSpecs" : [ {
        "hostNetworkSpec" : {
          "vmNics" : [ {
            "id" : "string",
            "vdsName" : "string"
          } ]
        },
        "id" : "string",
        "licenseKey" : "string"
      } ]
    },
    "clusterStretchSpec" : {
      "hostSpecs" : [ {
        "hostNetworkSpec" : {
          "vmNics" : [ {
            "id" : "string",
            "vdsName" : "string"
          } ]
        },
        "id" : "string",
        "licenseKey" : "string"
      } ],
      "witnessSpec" : {
        "fqdn" : "string",
        "vsanCidr" : "string",
        "vsanIp" : "string"
      }
    },
    "clusterUnstretchSpec" : { },
    "markForDeletion" : true
  }
}

3.16.8. Example HTTP response

Response 200
{
  "description" : "string",
  "executionStatus" : "One among: IN_PROGRESS, FAILED, COMPLETED, SKIPPED, CANCELLED",
  "id" : "string",
  "resultStatus" : "One among: SUCCEEDED, FAILED, FAILED_WITH_WARNINGS",
  "validationChecks" : [ {
    "description" : "string",
    "errorResponse" : {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ {
        "arguments" : [ "string" ],
        "causes" : [ {
          "message" : "string",
          "type" : "string"
        } ],
        "context" : {
          "string" : "string"
        },
        "errorCode" : "string",
        "message" : "string",
        "nestedErrors" : [ "..." ],
        "referenceToken" : "string",
        "remediationMessage" : "string"
      } ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    },
    "nestedValidationChecks" : [ {
      "description" : "string",
      "errorResponse" : {
        "arguments" : [ "string" ],
        "causes" : [ {
          "message" : "string",
          "type" : "string"
        } ],
        "context" : {
          "string" : "string"
        },
        "errorCode" : "string",
        "message" : "string",
        "nestedErrors" : [ "..." ],
        "referenceToken" : "string",
        "remediationMessage" : "string"
      },
      "nestedValidationChecks" : [ "..." ],
      "resultStatus" : "One among: SUCCEEDED, FAILED",
      "severity" : "One among: WARNING, ERROR, INFO"
    } ],
    "resultStatus" : "One among: SUCCEEDED, FAILED",
    "severity" : "One among: WARNING, ERROR, INFO"
  } ]
}
Response 400
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 404
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 500
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.17. Get the Credentials

GET /v1/credentials

3.17.1. Description

Get the Credentials

3.17.2. Parameters

Type Name Description Schema

Header

privileged-password
required

The privileged user password

string

Header

privileged-username
required

The privileged user name

string

Query

domainName
optional

The name of the domain to which the resource belongs to (may be null in case there is no associated domain)

string

Query

resourceIp
optional

The IP address of the resource

string

Query

resourceName
optional

The name of the resource

string

Query

resourceType
optional

The type of the resource. One among: ESXI, SDDC_MANAGER, VCENTER, PSC, NSX_MANAGER, NSX_CONTROLLER, NSX_EDGE, NSXT_MANAGER, NSXT_CONTROLLER, NSXT_EDGE, VRLI, VROPS, LCM_REPO, VRA, VRSLCM, DEPOT_USER, VXRAIL_MANAGER, AD, BACKUP

string

3.17.3. Responses

HTTP Code Description Schema

200

OK

PageOfCredential

400

Bad Request

Error

401

Unauthorized

Error

403

Forbidden

Error

500

Internal Server Error

Error

3.17.4. Consumes

  • application/json

3.17.5. Produces

  • application/json

3.17.6. Tags

  • Credentials

3.17.7. Security

Type Name

basic

basicAuth

3.17.8. Example HTTP request

Request path
/v1/credentials
Request header
privileged-username:"string"

3.17.9. Example HTTP response

Response 200
{
  "elements" : [ {
    "credentialType" : "One among: SSO, SSH, API, BASIC_AUTH, ADMINISTRATOR, FTP, JDBC, LDAP_DOMAIN_ADMIN, LDAP_READ_WRITE_ACCOUNT, VDI_ADMIN, SQL_SUPER_USER, SQL_DB_OWNER, SERVICE_ACCOUNT",
    "id" : "string",
    "password" : "string",
    "resource" : {
      "domainName" : "string",
      "resourceId" : "string",
      "resourceIp" : "string",
      "resourceName" : "string",
      "resourceType" : "One among: ESXI, SDDC_MANAGER, VCENTER, PSC, NSX_MANAGER, NSX_CONTROLLER, NSX_EDGE, NSXT_MANAGER, NSXT_CONTROLLER, NSXT_EDGE, VRLI, VROPS, LCM_REPO, VRA, VRSLCM, DEPOT_USER, VXRAIL_MANAGER, AD, BACKUP",
      "serviceType" : "One among: ESXI, SDDC_MANAGER, VCENTER, PSC, NSX_MANAGER, NSX_CONTROLLER, NSX_EDGE, NSXT_MANAGER, NSXT_CONTROLLER, NSXT_EDGE, VRLI, VROPS, LCM_REPO, VRA, VRSLCM, DEPOT_USER, VXRAIL_MANAGER, AD, BACKUP",
      "targetType" : "One among: ESXI, SDDC_MANAGER, VCENTER, PSC, NSX_MANAGER, NSX_CONTROLLER, NSX_EDGE, NSXT_MANAGER, NSXT_CONTROLLER, NSXT_EDGE, VRLI, VROPS, LCM_REPO, VRA, VRSLCM, DEPOT_USER, VXRAIL_MANAGER, AD, BACKUP"
    },
    "username" : "string"
  } ]
}
Response 400
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 401
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 403
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 500
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.18. Update or rotate passwords for a list of resources

PATCH /v1/credentials

3.18.1. Description

Update passwords for given list of resources by supplying new passwords or rotate the passwords using system generated passwords

3.18.2. Parameters

Type Name Description Schema

Header

privileged-password
required

The privileged user password

string

Header

privileged-username
required

The privileged user name

string

Body

credentialsUpdateSpec
required

credentialsUpdateSpec

CredentialsUpdateSpec

3.18.3. Responses

HTTP Code Description Schema

200

OK

Task

202

Accepted

Task

400

Bad Request

Error

401

Unauthorized

Error

403

Forbidden

Error

500

Internal Server Error

Error

3.18.4. Consumes

  • application/json

3.18.5. Produces

  • application/json

3.18.6. Tags

  • Credentials

3.18.7. Security

Type Name

basic

basicAuth

3.18.8. Example HTTP request

Request path
/v1/credentials
Request header
privileged-username:"string"
Request body
{
  "elements" : [ {
    "credentials" : [ {
      "credentialType" : "One among: SSO, SSH, API, BASIC_AUTH, ADMINISTRATOR, FTP, JDBC, LDAP_DOMAIN_ADMIN, LDAP_READ_WRITE_ACCOUNT, VDI_ADMIN, SQL_SUPER_USER, SQL_DB_OWNER, SERVICE_ACCOUNT",
      "password" : "string",
      "username" : "string"
    } ],
    "resourceId" : "string",
    "resourceName" : "string",
    "resourceType" : "One among: ESXI, SDDC_MANAGER, VCENTER, PSC, NSX_MANAGER, NSX_CONTROLLER, NSX_EDGE, NSXT_MANAGER, NSXT_CONTROLLER, NSXT_EDGE, VRLI, VROPS, LCM_REPO, VRA, VRSLCM, DEPOT_USER, VXRAIL_MANAGER, AD, BACKUP"
  } ],
  "operationType" : "One among: UPDATE, ROTATE"
}

3.18.9. Example HTTP response

Response 200
{
  "completionTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "creationTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "errors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "id" : "string",
  "isCancellable" : true,
  "name" : "string",
  "resources" : [ {
    "fqdn" : "string",
    "name" : "string",
    "resourceId" : "string",
    "type" : "string"
  } ],
  "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
  "subTasks" : [ {
    "completionTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "creationTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "description" : "string",
    "errors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "name" : "string",
    "resources" : [ {
      "fqdn" : "string",
      "name" : "string",
      "resourceId" : "string",
      "type" : "string"
    } ],
    "stages" : [ {
      "completionTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "creationTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "description" : "string",
      "name" : "string",
      "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
      "type" : "string"
    } ],
    "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
    "type" : "string"
  } ],
  "type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}
Response 202
{
  "completionTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "creationTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "errors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "id" : "string",
  "isCancellable" : true,
  "name" : "string",
  "resources" : [ {
    "fqdn" : "string",
    "name" : "string",
    "resourceId" : "string",
    "type" : "string"
  } ],
  "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
  "subTasks" : [ {
    "completionTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "creationTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "description" : "string",
    "errors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "name" : "string",
    "resources" : [ {
      "fqdn" : "string",
      "name" : "string",
      "resourceId" : "string",
      "type" : "string"
    } ],
    "stages" : [ {
      "completionTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "creationTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "description" : "string",
      "name" : "string",
      "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
      "type" : "string"
    } ],
    "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
    "type" : "string"
  } ],
  "type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}
Response 400
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 401
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 403
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 500
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.19. Fetch the credentials tasks

GET /v1/credentials/tasks

3.19.1. Description

Fetch all credentials tasks in reverse chronological order

3.19.2. Parameters

Type Name Description Schema

Query

limit
optional

The number of elements to be returned in the result

integer (int32)

3.19.3. Responses

HTTP Code Description Schema

200

OK

PageOfCredentialsTask

400

Bad Request

Error

500

Internal Server Error

Error

3.19.4. Consumes

  • application/json

3.19.5. Produces

  • application/json

3.19.6. Tags

  • Credentials

3.19.7. Security

Type Name

basic

basicAuth

3.19.8. Example HTTP request

Request path
/v1/credentials/tasks

3.19.9. Example HTTP response

Response 200
{
  "elements" : [ {
    "creationTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "errors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ {
        "arguments" : [ "string" ],
        "causes" : [ {
          "message" : "string",
          "type" : "string"
        } ],
        "context" : {
          "string" : "string"
        },
        "errorCode" : "string",
        "message" : "string",
        "nestedErrors" : [ "..." ],
        "referenceToken" : "string",
        "remediationMessage" : "string"
      } ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "id" : "string",
    "name" : "string",
    "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, USER_CANCELLED, INCONSISTENT",
    "subTasks" : [ {
      "creationTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "dependentSubTasks" : [ {
        "creationTimestamp" : {
          "epochSecond" : 0,
          "nano" : 0
        },
        "dependentSubTasks" : [ "..." ],
        "description" : "string",
        "errors" : [ {
          "arguments" : [ "string" ],
          "causes" : [ {
            "message" : "string",
            "type" : "string"
          } ],
          "context" : {
            "string" : "string"
          },
          "errorCode" : "string",
          "message" : "string",
          "nestedErrors" : [ "..." ],
          "referenceToken" : "string",
          "remediationMessage" : "string"
        } ],
        "name" : "string",
        "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, USER_CANCELLED, INCONSISTENT"
      } ],
      "description" : "string",
      "errors" : [ "..." ],
      "name" : "string",
      "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, USER_CANCELLED, INCONSISTENT"
    } ]
  } ]
}
Response 400
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 500
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.20. Fetch a credentials task

GET /v1/credentials/tasks/{id}

3.20.1. Description

Fetch credentials task for a given ID

3.20.2. Parameters

Type Name Description Schema

Path

id
required

The ID of the credentials task

string

3.20.3. Responses

HTTP Code Description Schema

200

OK

CredentialsTask

400

Bad Request

Error

500

Internal Server Error

Error

3.20.4. Consumes

  • application/json

3.20.5. Produces

  • application/json

3.20.6. Tags

  • Credentials

3.20.7. Security

Type Name

basic

basicAuth

3.20.8. Example HTTP request

Request path
/v1/credentials/tasks/string

3.20.9. Example HTTP response

Response 200
{
  "creationTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "errors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "id" : "string",
  "name" : "string",
  "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, USER_CANCELLED, INCONSISTENT",
  "subTasks" : [ {
    "creationTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "dependentSubTasks" : [ {
      "creationTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "dependentSubTasks" : [ "..." ],
      "description" : "string",
      "errors" : [ {
        "arguments" : [ "string" ],
        "causes" : [ {
          "message" : "string",
          "type" : "string"
        } ],
        "context" : {
          "string" : "string"
        },
        "errorCode" : "string",
        "message" : "string",
        "nestedErrors" : [ "..." ],
        "referenceToken" : "string",
        "remediationMessage" : "string"
      } ],
      "name" : "string",
      "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, USER_CANCELLED, INCONSISTENT"
    } ],
    "description" : "string",
    "errors" : [ "..." ],
    "name" : "string",
    "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, USER_CANCELLED, INCONSISTENT"
  } ]
}
Response 400
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 500
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.21. Cancel a failed credentials task for a given ID

DELETE /v1/credentials/tasks/{id}

3.21.1. Description

Cancel a failed credentials task for a given ID

3.21.2. Parameters

Type Name Description Schema

Path

id
required

Task ID of the failed operation required to be cancelled

string

3.21.3. Responses

HTTP Code Description Schema

200

OK

Task

204

No content

Task

400

Bad Request

Error

500

Internal Server Error

Error

3.21.4. Consumes

  • application/json

3.21.5. Produces

  • application/json

3.21.6. Tags

  • Credentials

3.21.7. Security

Type Name

basic

basicAuth

3.21.8. Example HTTP request

Request path
/v1/credentials/tasks/string

3.21.9. Example HTTP response

Response 200
{
  "completionTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "creationTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "errors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "id" : "string",
  "isCancellable" : true,
  "name" : "string",
  "resources" : [ {
    "fqdn" : "string",
    "name" : "string",
    "resourceId" : "string",
    "type" : "string"
  } ],
  "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
  "subTasks" : [ {
    "completionTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "creationTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "description" : "string",
    "errors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "name" : "string",
    "resources" : [ {
      "fqdn" : "string",
      "name" : "string",
      "resourceId" : "string",
      "type" : "string"
    } ],
    "stages" : [ {
      "completionTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "creationTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "description" : "string",
      "name" : "string",
      "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
      "type" : "string"
    } ],
    "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
    "type" : "string"
  } ],
  "type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}
Response 204
{
  "completionTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "creationTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "errors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "id" : "string",
  "isCancellable" : true,
  "name" : "string",
  "resources" : [ {
    "fqdn" : "string",
    "name" : "string",
    "resourceId" : "string",
    "type" : "string"
  } ],
  "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
  "subTasks" : [ {
    "completionTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "creationTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "description" : "string",
    "errors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "name" : "string",
    "resources" : [ {
      "fqdn" : "string",
      "name" : "string",
      "resourceId" : "string",
      "type" : "string"
    } ],
    "stages" : [ {
      "completionTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "creationTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "description" : "string",
      "name" : "string",
      "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
      "type" : "string"
    } ],
    "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
    "type" : "string"
  } ],
  "type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}
Response 400
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 500
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.22. Retry a failed credentials task for a given ID

PATCH /v1/credentials/tasks/{id}

3.22.1. Description

Retry a failed credentials task for a given ID

3.22.2. Parameters

Type Name Description Schema

Header

privileged-password
required

The privileged user password

string

Header

privileged-username
required

The privileged user name

string

Path

id
required

Task ID of the failed operation that is to be retried

string

Body

credentialsUpdateSpec
required

credentialsUpdateSpec

CredentialsUpdateSpec

3.22.3. Responses

HTTP Code Description Schema

200

OK

Task

202

Accepted

Task

400

Bad Request

Error

401

Unauthorized

Error

403

Forbidden

Error

500

Internal Server Error

Error

3.22.4. Consumes

  • application/json

3.22.5. Produces

  • application/json

3.22.6. Tags

  • Credentials

3.22.7. Security

Type Name

basic

basicAuth

3.22.8. Example HTTP request

Request path
/v1/credentials/tasks/string
Request header
privileged-username:"string"
Request body
{
  "elements" : [ {
    "credentials" : [ {
      "credentialType" : "One among: SSO, SSH, API, BASIC_AUTH, ADMINISTRATOR, FTP, JDBC, LDAP_DOMAIN_ADMIN, LDAP_READ_WRITE_ACCOUNT, VDI_ADMIN, SQL_SUPER_USER, SQL_DB_OWNER, SERVICE_ACCOUNT",
      "password" : "string",
      "username" : "string"
    } ],
    "resourceId" : "string",
    "resourceName" : "string",
    "resourceType" : "One among: ESXI, SDDC_MANAGER, VCENTER, PSC, NSX_MANAGER, NSX_CONTROLLER, NSX_EDGE, NSXT_MANAGER, NSXT_CONTROLLER, NSXT_EDGE, VRLI, VROPS, LCM_REPO, VRA, VRSLCM, DEPOT_USER, VXRAIL_MANAGER, AD, BACKUP"
  } ],
  "operationType" : "One among: UPDATE, ROTATE"
}

3.22.9. Example HTTP response

Response 200
{
  "completionTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "creationTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "errors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "id" : "string",
  "isCancellable" : true,
  "name" : "string",
  "resources" : [ {
    "fqdn" : "string",
    "name" : "string",
    "resourceId" : "string",
    "type" : "string"
  } ],
  "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
  "subTasks" : [ {
    "completionTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "creationTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "description" : "string",
    "errors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "name" : "string",
    "resources" : [ {
      "fqdn" : "string",
      "name" : "string",
      "resourceId" : "string",
      "type" : "string"
    } ],
    "stages" : [ {
      "completionTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "creationTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "description" : "string",
      "name" : "string",
      "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
      "type" : "string"
    } ],
    "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
    "type" : "string"
  } ],
  "type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}
Response 202
{
  "completionTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "creationTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "errors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "id" : "string",
  "isCancellable" : true,
  "name" : "string",
  "resources" : [ {
    "fqdn" : "string",
    "name" : "string",
    "resourceId" : "string",
    "type" : "string"
  } ],
  "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
  "subTasks" : [ {
    "completionTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "creationTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "description" : "string",
    "errors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "name" : "string",
    "resources" : [ {
      "fqdn" : "string",
      "name" : "string",
      "resourceId" : "string",
      "type" : "string"
    } ],
    "stages" : [ {
      "completionTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "creationTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "description" : "string",
      "name" : "string",
      "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
      "type" : "string"
    } ],
    "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
    "type" : "string"
  } ],
  "type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}
Response 400
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 401
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 403
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 500
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.23. Fetch resource credentials for a given credentials task ID

GET /v1/credentials/tasks/{id}/resource-credentials

3.23.1. Description

Fetch resource credentials for a given credentials task ID

3.23.2. Parameters

Type Name Description Schema

Path

id
required

The ID of the credentials task

string

3.23.3. Responses

HTTP Code Description Schema

200

OK

< ResourceCredentials > array

400

Bad Request

Error

500

Internal Server Error

Error

3.23.4. Consumes

  • application/json

3.23.5. Produces

  • application/json

3.23.6. Tags

  • Credentials

3.23.7. Security

Type Name

basic

basicAuth

3.23.8. Example HTTP request

Request path
/v1/credentials/tasks/string/resource-credentials

3.23.9. Example HTTP response

Response 200
[ {
  "credentials" : [ {
    "credentialType" : "One among: SSO, SSH, API, BASIC_AUTH, ADMINISTRATOR, FTP, JDBC, LDAP_DOMAIN_ADMIN, LDAP_READ_WRITE_ACCOUNT, VDI_ADMIN, SQL_SUPER_USER, SQL_DB_OWNER, SERVICE_ACCOUNT",
    "password" : "string",
    "username" : "string"
  } ],
  "resourceId" : "string",
  "resourceName" : "string",
  "resourceType" : "One among: ESXI, SDDC_MANAGER, VCENTER, PSC, NSX_MANAGER, NSX_CONTROLLER, NSX_EDGE, NSXT_MANAGER, NSXT_CONTROLLER, NSXT_EDGE, VRLI, VROPS, LCM_REPO, VRA, VRSLCM, DEPOT_USER, VXRAIL_MANAGER, AD, BACKUP"
} ]
Response 400
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 500
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.24. Get a Credential

GET /v1/credentials/{id}

3.24.1. Description

Get a Credential

3.24.2. Parameters

Type Name Description Schema

Header

privileged-password
required

The privileged user password

string

Header

privileged-username
required

The privileged user name

string

Path

id
required

The ID of the credential

string

3.24.3. Responses

HTTP Code Description Schema

200

OK

Credential

400

Bad Request

Error

401

Unauthorized

Error

403

Forbidden

Error

404

Not Found

Error

500

Internal Server Error

Error

3.24.4. Consumes

  • application/json

3.24.5. Produces

  • application/json

3.24.6. Tags

  • Credentials

3.24.7. Security

Type Name

basic

basicAuth

3.24.8. Example HTTP request

Request path
/v1/credentials/string
Request header
privileged-username:"string"

3.24.9. Example HTTP response

Response 200
{
  "credentialType" : "One among: SSO, SSH, API, BASIC_AUTH, ADMINISTRATOR, FTP, JDBC, LDAP_DOMAIN_ADMIN, LDAP_READ_WRITE_ACCOUNT, VDI_ADMIN, SQL_SUPER_USER, SQL_DB_OWNER, SERVICE_ACCOUNT",
  "id" : "string",
  "password" : "string",
  "resource" : {
    "domainName" : "string",
    "resourceId" : "string",
    "resourceIp" : "string",
    "resourceName" : "string",
    "resourceType" : "One among: ESXI, SDDC_MANAGER, VCENTER, PSC, NSX_MANAGER, NSX_CONTROLLER, NSX_EDGE, NSXT_MANAGER, NSXT_CONTROLLER, NSXT_EDGE, VRLI, VROPS, LCM_REPO, VRA, VRSLCM, DEPOT_USER, VXRAIL_MANAGER, AD, BACKUP",
    "serviceType" : "One among: ESXI, SDDC_MANAGER, VCENTER, PSC, NSX_MANAGER, NSX_CONTROLLER, NSX_EDGE, NSXT_MANAGER, NSXT_CONTROLLER, NSXT_EDGE, VRLI, VROPS, LCM_REPO, VRA, VRSLCM, DEPOT_USER, VXRAIL_MANAGER, AD, BACKUP",
    "targetType" : "One among: ESXI, SDDC_MANAGER, VCENTER, PSC, NSX_MANAGER, NSX_CONTROLLER, NSX_EDGE, NSXT_MANAGER, NSXT_CONTROLLER, NSXT_EDGE, VRLI, VROPS, LCM_REPO, VRA, VRSLCM, DEPOT_USER, VXRAIL_MANAGER, AD, BACKUP"
  },
  "username" : "string"
}
Response 400
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 401
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 403
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 404
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 500
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.25. Create a Domain

POST /v1/domains

3.25.1. Parameters

Type Name Description Schema

Body

domainCreationSpec
required

Domain creation data

DomainCreationSpec

3.25.2. Responses

HTTP Code Description Schema

200

OK

Task

202

Accepted

Task

400

Bad Request

Error

500

InternalServerError

Error

3.25.3. Consumes

  • application/json

3.25.4. Produces

  • application/json

3.25.5. Tags

  • Domains

3.25.6. Security

Type Name

basic

basicAuth

3.25.7. Example HTTP request

Request path
/v1/domains
Request body
{
  "computeSpec" : {
    "clusterSpecs" : [ {
      "advancedOptions" : {
        "evcMode" : "One among: INTEL_MEROM, INTEL_PENRYN, INTEL_NEALEM, INTEL_WESTMERE, INTEL_SANDYBRIDGE, INTEL_IVYBRIDGE, INTEL_HASWELL, INTEL_BROADWELL, INTEL_SKYLAKE, AMD_REV_E, AMD_REV_F, AMD_GREYHOUND_NO3DNOW, AMD_GREYHOUND, AMD_BULLDOZER, AMD_PILEDRIVER, AMD_STREAMROLLER, AMD_ZEN",
        "highAvailability" : {
          "enabled" : true
        }
      },
      "datastoreSpec" : {
        "nfsDatastoreSpecs" : [ {
          "datastoreName" : "string",
          "nasVolume" : {
            "path" : "string",
            "readOnly" : true,
            "serverName" : [ "string" ],
            "userTag" : "string"
          }
        } ],
        "vmfsDatastoreSpec" : {
          "fcSpec" : [ {
            "datastoreName" : "string"
          } ]
        },
        "vsanDatastoreSpec" : {
          "datastoreName" : "string",
          "dedupAndCompressionEnabled" : true,
          "failuresToTolerate" : 0,
          "licenseKey" : "string"
        }
      },
      "hostSpecs" : [ {
        "hostNetworkSpec" : {
          "vmNics" : [ {
            "id" : "string",
            "vdsName" : "string"
          } ]
        },
        "id" : "string",
        "licenseKey" : "string"
      } ],
      "name" : "string",
      "networkSpec" : {
        "nsxClusterSpec" : {
          "nsxTClusterSpec" : {
            "geneveVlanId" : 0
          },
          "nsxVClusterSpec" : {
            "licenseKey" : "string",
            "vdsNameForVxlanConfig" : "string",
            "vlanId" : 0
          }
        },
        "vdsSpecs" : [ {
          "name" : "string",
          "niocBandwidthAllocationSpecs" : [ {
            "niocTrafficResourceAllocation" : {
              "limit" : 0,
              "reservation" : 0
            },
            "type" : "string"
          } ],
          "portGroupSpecs" : [ {
            "name" : "string",
            "transportType" : "One among: VSAN, VMOTION, MANAGEMENT, PUBLIC, NFS"
          } ]
        } ]
      }
    } ]
  },
  "domainName" : "string",
  "nsxTSpec" : {
    "licenseKey" : "string",
    "nsxManagerAdminPassword" : "string",
    "nsxManagerSpecs" : [ {
      "name" : "string",
      "networkDetailsSpec" : {
        "dnsName" : "string",
        "gateway" : "string",
        "ipAddress" : "string",
        "subnetMask" : "string"
      }
    } ],
    "vip" : "string",
    "vipFqdn" : "string"
  },
  "nsxVSpec" : {
    "licenseKey" : "string",
    "nsxManagerAdminPassword" : "string",
    "nsxManagerEnablePassword" : "string",
    "nsxManagerSpec" : {
      "name" : "string",
      "networkDetailsSpec" : {
        "dnsName" : "string",
        "gateway" : "string",
        "ipAddress" : "string",
        "subnetMask" : "string"
      }
    },
    "nsxVControllerSpec" : {
      "nsxControllerGateway" : "string",
      "nsxControllerIps" : [ "string" ],
      "nsxControllerPassword" : "string",
      "nsxControllerSubnetMask" : "string"
    }
  },
  "vcenterSpec" : {
    "datacenterName" : "string",
    "licenseKey" : "string",
    "name" : "string",
    "networkDetailsSpec" : {
      "dnsName" : "string",
      "gateway" : "string",
      "ipAddress" : "string",
      "subnetMask" : "string"
    },
    "rootPassword" : "string"
  }
}

3.25.8. Example HTTP response

Response 200
{
  "completionTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "creationTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "errors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "id" : "string",
  "isCancellable" : true,
  "name" : "string",
  "resources" : [ {
    "fqdn" : "string",
    "name" : "string",
    "resourceId" : "string",
    "type" : "string"
  } ],
  "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
  "subTasks" : [ {
    "completionTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "creationTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "description" : "string",
    "errors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "name" : "string",
    "resources" : [ {
      "fqdn" : "string",
      "name" : "string",
      "resourceId" : "string",
      "type" : "string"
    } ],
    "stages" : [ {
      "completionTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "creationTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "description" : "string",
      "name" : "string",
      "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
      "type" : "string"
    } ],
    "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
    "type" : "string"
  } ],
  "type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}
Response 202
{
  "completionTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "creationTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "errors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "id" : "string",
  "isCancellable" : true,
  "name" : "string",
  "resources" : [ {
    "fqdn" : "string",
    "name" : "string",
    "resourceId" : "string",
    "type" : "string"
  } ],
  "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
  "subTasks" : [ {
    "completionTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "creationTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "description" : "string",
    "errors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "name" : "string",
    "resources" : [ {
      "fqdn" : "string",
      "name" : "string",
      "resourceId" : "string",
      "type" : "string"
    } ],
    "stages" : [ {
      "completionTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "creationTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "description" : "string",
      "name" : "string",
      "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
      "type" : "string"
    } ],
    "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
    "type" : "string"
  } ],
  "type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}
Response 400
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 500
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.26. Get the Domains

GET /v1/domains

3.26.1. Responses

HTTP Code Description Schema

200

Ok

Domain

400

Bad Request

Error

500

InternalServerError

Error

3.26.2. Consumes

  • application/json

3.26.3. Produces

  • application/json

3.26.4. Tags

  • Domains

3.26.5. Security

Type Name

basic

basicAuth

3.26.6. Example HTTP request

Request path
/v1/domains

3.26.7. Example HTTP response

Response 200
{
  "clusters" : [ {
    "id" : "string"
  } ],
  "id" : "string",
  "name" : "string",
  "vcenters" : [ {
    "fqdn" : "string",
    "id" : "string"
  } ]
}
Response 400
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 500
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.27. Validate the input spec for domains operations

POST /v1/domains/validations

3.27.1. Parameters

Type Name Description Schema

Body

domainsOperationSpecValidation
required

Domains Operation Spec Validation

DomainsOperationSpecValidation

3.27.2. Responses

HTTP Code Description Schema

200

Ok

Validation

400

Bad Request

Error

500

InternalServerError

Error

3.27.3. Consumes

  • application/json

3.27.4. Produces

  • application/json

3.27.5. Tags

  • Domains

3.27.6. Security

Type Name

basic

basicAuth

3.27.7. Example HTTP request

Request path
/v1/domains/validations
Request body
{
  "domainCreationSpec" : {
    "computeSpec" : {
      "clusterSpecs" : [ {
        "advancedOptions" : {
          "evcMode" : "One among: INTEL_MEROM, INTEL_PENRYN, INTEL_NEALEM, INTEL_WESTMERE, INTEL_SANDYBRIDGE, INTEL_IVYBRIDGE, INTEL_HASWELL, INTEL_BROADWELL, INTEL_SKYLAKE, AMD_REV_E, AMD_REV_F, AMD_GREYHOUND_NO3DNOW, AMD_GREYHOUND, AMD_BULLDOZER, AMD_PILEDRIVER, AMD_STREAMROLLER, AMD_ZEN",
          "highAvailability" : {
            "enabled" : true
          }
        },
        "datastoreSpec" : {
          "nfsDatastoreSpecs" : [ {
            "datastoreName" : "string",
            "nasVolume" : {
              "path" : "string",
              "readOnly" : true,
              "serverName" : [ "string" ],
              "userTag" : "string"
            }
          } ],
          "vmfsDatastoreSpec" : {
            "fcSpec" : [ {
              "datastoreName" : "string"
            } ]
          },
          "vsanDatastoreSpec" : {
            "datastoreName" : "string",
            "dedupAndCompressionEnabled" : true,
            "failuresToTolerate" : 0,
            "licenseKey" : "string"
          }
        },
        "hostSpecs" : [ {
          "hostNetworkSpec" : {
            "vmNics" : [ {
              "id" : "string",
              "vdsName" : "string"
            } ]
          },
          "id" : "string",
          "licenseKey" : "string"
        } ],
        "name" : "string",
        "networkSpec" : {
          "nsxClusterSpec" : {
            "nsxTClusterSpec" : {
              "geneveVlanId" : 0
            },
            "nsxVClusterSpec" : {
              "licenseKey" : "string",
              "vdsNameForVxlanConfig" : "string",
              "vlanId" : 0
            }
          },
          "vdsSpecs" : [ {
            "name" : "string",
            "niocBandwidthAllocationSpecs" : [ {
              "niocTrafficResourceAllocation" : {
                "limit" : 0,
                "reservation" : 0
              },
              "type" : "string"
            } ],
            "portGroupSpecs" : [ {
              "name" : "string",
              "transportType" : "One among: VSAN, VMOTION, MANAGEMENT, PUBLIC, NFS"
            } ]
          } ]
        }
      } ]
    },
    "domainName" : "string",
    "nsxTSpec" : {
      "licenseKey" : "string",
      "nsxManagerAdminPassword" : "string",
      "nsxManagerSpecs" : [ {
        "name" : "string",
        "networkDetailsSpec" : {
          "dnsName" : "string",
          "gateway" : "string",
          "ipAddress" : "string",
          "subnetMask" : "string"
        }
      } ],
      "vip" : "string",
      "vipFqdn" : "string"
    },
    "nsxVSpec" : {
      "licenseKey" : "string",
      "nsxManagerAdminPassword" : "string",
      "nsxManagerEnablePassword" : "string",
      "nsxManagerSpec" : {
        "name" : "string",
        "networkDetailsSpec" : {
          "dnsName" : "string",
          "gateway" : "string",
          "ipAddress" : "string",
          "subnetMask" : "string"
        }
      },
      "nsxVControllerSpec" : {
        "nsxControllerGateway" : "string",
        "nsxControllerIps" : [ "string" ],
        "nsxControllerPassword" : "string",
        "nsxControllerSubnetMask" : "string"
      }
    },
    "vcenterSpec" : {
      "datacenterName" : "string",
      "licenseKey" : "string",
      "name" : "string",
      "networkDetailsSpec" : {
        "dnsName" : "string",
        "gateway" : "string",
        "ipAddress" : "string",
        "subnetMask" : "string"
      },
      "rootPassword" : "string"
    }
  }
}

3.27.8. Example HTTP response

Response 200
{
  "description" : "string",
  "executionStatus" : "One among: IN_PROGRESS, FAILED, COMPLETED, SKIPPED, CANCELLED",
  "id" : "string",
  "resultStatus" : "One among: SUCCEEDED, FAILED, FAILED_WITH_WARNINGS",
  "validationChecks" : [ {
    "description" : "string",
    "errorResponse" : {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ {
        "arguments" : [ "string" ],
        "causes" : [ {
          "message" : "string",
          "type" : "string"
        } ],
        "context" : {
          "string" : "string"
        },
        "errorCode" : "string",
        "message" : "string",
        "nestedErrors" : [ "..." ],
        "referenceToken" : "string",
        "remediationMessage" : "string"
      } ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    },
    "nestedValidationChecks" : [ {
      "description" : "string",
      "errorResponse" : {
        "arguments" : [ "string" ],
        "causes" : [ {
          "message" : "string",
          "type" : "string"
        } ],
        "context" : {
          "string" : "string"
        },
        "errorCode" : "string",
        "message" : "string",
        "nestedErrors" : [ "..." ],
        "referenceToken" : "string",
        "remediationMessage" : "string"
      },
      "nestedValidationChecks" : [ "..." ],
      "resultStatus" : "One among: SUCCEEDED, FAILED",
      "severity" : "One among: WARNING, ERROR, INFO"
    } ],
    "resultStatus" : "One among: SUCCEEDED, FAILED",
    "severity" : "One among: WARNING, ERROR, INFO"
  } ]
}
Response 400
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 500
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.28. Generate certificate(s) for the selected resource(s) in a domain

PUT /v1/domains/{domainName}/certificates

3.28.1. Description

Generate certificate(s) for the selected resource(s) in a domain. CA must be configured and CSR must be generated beforehand.

3.28.2. Parameters

Type Name Description Schema

Path

domainName
required

The domain name

string

Body

certificateGenerationSpec
required

certificateGenerationSpec

CertificatesGenerationSpec

3.28.3. Responses

HTTP Code Description Schema

200

OK

Task

202

Accepted

Task

400

Bad request

Error

404

Not Found

Error

500

Internal server error

Error

3.28.4. Consumes

  • application/json

3.28.5. Produces

  • application/json

3.28.6. Tags

  • Certificates

3.28.7. Security

Type Name

basic

basicAuth

3.28.8. Example HTTP request

Request path
/v1/domains/string/certificates
Request body
{
  "caType" : "One among: OpenSSL, Microsoft",
  "resources" : [ {
    "fqdn" : "string",
    "name" : "string",
    "resourceId" : "string",
    "type" : "string"
  } ]
}

3.28.9. Example HTTP response

Response 200
{
  "completionTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "creationTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "errors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "id" : "string",
  "isCancellable" : true,
  "name" : "string",
  "resources" : [ {
    "fqdn" : "string",
    "name" : "string",
    "resourceId" : "string",
    "type" : "string"
  } ],
  "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
  "subTasks" : [ {
    "completionTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "creationTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "description" : "string",
    "errors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "name" : "string",
    "resources" : [ {
      "fqdn" : "string",
      "name" : "string",
      "resourceId" : "string",
      "type" : "string"
    } ],
    "stages" : [ {
      "completionTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "creationTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "description" : "string",
      "name" : "string",
      "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
      "type" : "string"
    } ],
    "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
    "type" : "string"
  } ],
  "type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}
Response 202
{
  "completionTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "creationTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "errors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "id" : "string",
  "isCancellable" : true,
  "name" : "string",
  "resources" : [ {
    "fqdn" : "string",
    "name" : "string",
    "resourceId" : "string",
    "type" : "string"
  } ],
  "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
  "subTasks" : [ {
    "completionTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "creationTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "description" : "string",
    "errors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "name" : "string",
    "resources" : [ {
      "fqdn" : "string",
      "name" : "string",
      "resourceId" : "string",
      "type" : "string"
    } ],
    "stages" : [ {
      "completionTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "creationTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "description" : "string",
      "name" : "string",
      "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
      "type" : "string"
    } ],
    "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
    "type" : "string"
  } ],
  "type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}
Response 400
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 404
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 500
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.29. Replace certificate(s) for the selected resource(s) in a domain

PATCH /v1/domains/{domainName}/certificates

3.29.1. Description

Replace certificate(s) for the selected resource(s) in a domain

3.29.2. Parameters

Type Name Description Schema

Path

domainName
required

The domain name

string

Body

certificateOperationSpec
required

certificateOperationSpec

CertificateOperationSpec

3.29.3. Responses

HTTP Code Description Schema

200

OK

Task

202

Accepted

Task

400

Bad request

Error

403

Forbidden

Error

404

Not Found

Error

500

Internal server error

Error

3.29.4. Consumes

  • application/json

3.29.5. Produces

  • application/json

3.29.6. Tags

  • Certificates

3.29.7. Security

Type Name

basic

basicAuth

3.29.8. Example HTTP request

Request path
/v1/domains/string/certificates
Request body
{
  "operationType" : "One among: INSTALL",
  "resources" : [ {
    "fqdn" : "string",
    "name" : "string",
    "resourceId" : "string",
    "type" : "string"
  } ]
}

3.29.9. Example HTTP response

Response 200
{
  "completionTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "creationTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "errors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "id" : "string",
  "isCancellable" : true,
  "name" : "string",
  "resources" : [ {
    "fqdn" : "string",
    "name" : "string",
    "resourceId" : "string",
    "type" : "string"
  } ],
  "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
  "subTasks" : [ {
    "completionTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "creationTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "description" : "string",
    "errors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "name" : "string",
    "resources" : [ {
      "fqdn" : "string",
      "name" : "string",
      "resourceId" : "string",
      "type" : "string"
    } ],
    "stages" : [ {
      "completionTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "creationTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "description" : "string",
      "name" : "string",
      "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
      "type" : "string"
    } ],
    "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
    "type" : "string"
  } ],
  "type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}
Response 202
{
  "completionTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "creationTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "errors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "id" : "string",
  "isCancellable" : true,
  "name" : "string",
  "resources" : [ {
    "fqdn" : "string",
    "name" : "string",
    "resourceId" : "string",
    "type" : "string"
  } ],
  "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
  "subTasks" : [ {
    "completionTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "creationTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "description" : "string",
    "errors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "name" : "string",
    "resources" : [ {
      "fqdn" : "string",
      "name" : "string",
      "resourceId" : "string",
      "type" : "string"
    } ],
    "stages" : [ {
      "completionTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "creationTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "description" : "string",
      "name" : "string",
      "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
      "type" : "string"
    } ],
    "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
    "type" : "string"
  } ],
  "type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}
Response 400
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 403
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 404
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 500
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.30. Upload certificates to the certificate store

PUT /v1/domains/{domainName}/certificates/uploads

3.30.1. Description

Upload certificates to the certificate store

3.30.2. Parameters

Type Name Description Schema

Path

domainName
required

The domain name

string

FormData

file
required

file

file

3.30.3. Responses

HTTP Code Description Schema

200

OK

object

400

Bad request.

Error

404

Not Found

Error

500

Internal server error

Error

3.30.4. Consumes

  • multipart/form-data

3.30.5. Produces

  • application/json

3.30.6. Tags

  • Certificates

3.30.7. Security

Type Name

basic

basicAuth

3.30.8. Example HTTP request

Request path
/v1/domains/string/certificates/uploads
Request formData
"file"

3.30.9. Example HTTP response

Response 200
{ }
Response 400
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 404
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 500
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.31. Get available CSR(s) in json format

GET /v1/domains/{domainName}/csrs

3.31.1. Description

Get available CSR(s) in json format

3.31.2. Parameters

Type Name Description Schema

Path

domainName
required

The domain name

string

3.31.3. Responses

HTTP Code Description Schema

200

OK

PageOfCsr

404

Not Found

Error

500

Internal server error

Error

3.31.4. Consumes

  • application/json

3.31.5. Produces

  • application/json

3.31.6. Tags

  • Certificates

3.31.7. Security

Type Name

basic

basicAuth

3.31.8. Example HTTP request

Request path
/v1/domains/string/csrs

3.31.9. Example HTTP response

Response 200
{
  "elements" : [ {
    "csrEncodedContent" : "string",
    "resource" : {
      "fqdn" : "string",
      "name" : "string",
      "resourceId" : "string",
      "type" : "string"
    }
  } ]
}
Response 404
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 500
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.32. Generate CSR(s)

PUT /v1/domains/{domainName}/csrs

3.32.1. Description

Generate CSR(s) for the selected resource(s) in the domain

3.32.2. Parameters

Type Name Description Schema

Path

domainName
required

The domain name

string

Body

csrsGenerationSpec
required

csrsGenerationSpec

CsrsGenerationSpec

3.32.3. Responses

HTTP Code Description Schema

200

OK

Task

202

Accepted

Task

400

Bad request

Error

404

Not Found

Error

500

Internal server error

Error

3.32.4. Consumes

  • application/json

3.32.5. Produces

  • application/json

3.32.6. Tags

  • Certificates

3.32.7. Security

Type Name

basic

basicAuth

3.32.8. Example HTTP request

Request path
/v1/domains/string/csrs
Request body
{
  "csrGenerationSpec" : {
    "country" : "string",
    "email" : "string",
    "keyAlgorithm" : "One among: RSA",
    "keySize" : "One among: 2048, 3072, 4096",
    "locality" : "string",
    "organization" : "string",
    "organizationUnit" : "string",
    "state" : "string"
  },
  "resources" : [ {
    "fqdn" : "string",
    "name" : "string",
    "resourceId" : "string",
    "type" : "string"
  } ]
}

3.32.9. Example HTTP response

Response 200
{
  "completionTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "creationTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "errors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "id" : "string",
  "isCancellable" : true,
  "name" : "string",
  "resources" : [ {
    "fqdn" : "string",
    "name" : "string",
    "resourceId" : "string",
    "type" : "string"
  } ],
  "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
  "subTasks" : [ {
    "completionTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "creationTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "description" : "string",
    "errors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "name" : "string",
    "resources" : [ {
      "fqdn" : "string",
      "name" : "string",
      "resourceId" : "string",
      "type" : "string"
    } ],
    "stages" : [ {
      "completionTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "creationTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "description" : "string",
      "name" : "string",
      "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
      "type" : "string"
    } ],
    "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
    "type" : "string"
  } ],
  "type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}
Response 202
{
  "completionTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "creationTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "errors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "id" : "string",
  "isCancellable" : true,
  "name" : "string",
  "resources" : [ {
    "fqdn" : "string",
    "name" : "string",
    "resourceId" : "string",
    "type" : "string"
  } ],
  "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
  "subTasks" : [ {
    "completionTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "creationTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "description" : "string",
    "errors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "name" : "string",
    "resources" : [ {
      "fqdn" : "string",
      "name" : "string",
      "resourceId" : "string",
      "type" : "string"
    } ],
    "stages" : [ {
      "completionTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "creationTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "description" : "string",
      "name" : "string",
      "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
      "type" : "string"
    } ],
    "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
    "type" : "string"
  } ],
  "type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}
Response 400
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 404
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 500
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.33. Download available CSR(s) in tar.gz format

GET /v1/domains/{domainName}/csrs/downloads

3.33.1. Description

Download available CSR(s) in tar.gz format

3.33.2. Parameters

Type Name Description Schema

Path

domainName
required

The domain name

string

3.33.3. Responses

HTTP Code Description Schema

200

OK

string (byte)

404

Not Found

Error

500

Internal server error

Error

3.33.4. Consumes

  • application/json

3.33.5. Produces

  • application/octet-stream

3.33.6. Tags

  • Certificates

3.33.7. Security

Type Name

basic

basicAuth

3.33.8. Example HTTP request

Request path
/v1/domains/string/csrs/downloads

3.33.9. Example HTTP response

Response 200
"Ynl0ZQ=="
Response 404
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 500
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.34. View certificate of all the resources in a domain

GET /v1/domains/{domainName}/resource-certificates

3.34.1. Description

View detailed metadata about the certificate(s) of all the resources in a domain

3.34.2. Parameters

Type Name Description Schema

Path

domainName
required

The domain name

string

3.34.3. Responses

HTTP Code Description Schema

200

OK

PageOfCertificate

404

Not Found

Error

500

Internal server error

Error

3.34.4. Consumes

  • application/json

3.34.5. Produces

  • application/json

3.34.6. Tags

  • Certificates

3.34.7. Security

Type Name

basic

basicAuth

3.34.8. Example HTTP request

Request path
/v1/domains/string/resource-certificates

3.34.9. Example HTTP response

Response 200
{
  "elements" : [ {
    "expirationStatus" : "One among: ACTIVE, ABOUT_TO_EXPIRE, EXPIRED",
    "getCertificateError" : "string",
    "isInstalled" : true,
    "issuedBy" : "string",
    "issuedTo" : "string",
    "keySize" : "One among: 2048, 3072, 4096",
    "notAfter" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "notBefore" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "numberOfDaysToExpire" : 0,
    "pemEncoded" : "string",
    "publicKey" : "string",
    "publicKeyAlgorithm" : "One among: RSA",
    "serialNumber" : "string",
    "signatureAlgorithm" : "string",
    "subject" : "string",
    "subjectAlternativeName" : [ "string" ],
    "thumbprint" : "string",
    "thumbprintAlgorithm" : "string",
    "version" : "string"
  } ]
}
Response 404
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 500
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.35. Get a Domain

GET /v1/domains/{id}

3.35.1. Parameters

Type Name Description Schema

Path

id
required

Domain ID

string

3.35.2. Responses

HTTP Code Description Schema

200

Ok

Domain

404

Domain not found

Error

500

InternalServerError

Error

3.35.3. Consumes

  • application/json

3.35.4. Produces

  • application/json

3.35.5. Tags

  • Domains

3.35.6. Security

Type Name

basic

basicAuth

3.35.7. Example HTTP request

Request path
/v1/domains/string

3.35.8. Example HTTP response

Response 200
{
  "clusters" : [ {
    "id" : "string"
  } ],
  "id" : "string",
  "name" : "string",
  "vcenters" : [ {
    "fqdn" : "string",
    "id" : "string"
  } ]
}
Response 404
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 500
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.36. Delete a Domain if it has been previously initialized for deletion

DELETE /v1/domains/{id}

3.36.1. Parameters

Type Name Description Schema

Path

id
required

Domain ID

string

3.36.2. Responses

HTTP Code Description Schema

200

OK

Task

202

Accepted

Task

400

Bad Request

Error

404

Not Found

Error

500

InternalServerError

Error

3.36.3. Consumes

  • application/json

3.36.4. Produces

  • application/json

3.36.5. Tags

  • Domains

3.36.6. Security

Type Name

basic

basicAuth

3.36.7. Example HTTP request

Request path
/v1/domains/string

3.36.8. Example HTTP response

Response 200
{
  "completionTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "creationTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "errors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "id" : "string",
  "isCancellable" : true,
  "name" : "string",
  "resources" : [ {
    "fqdn" : "string",
    "name" : "string",
    "resourceId" : "string",
    "type" : "string"
  } ],
  "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
  "subTasks" : [ {
    "completionTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "creationTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "description" : "string",
    "errors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "name" : "string",
    "resources" : [ {
      "fqdn" : "string",
      "name" : "string",
      "resourceId" : "string",
      "type" : "string"
    } ],
    "stages" : [ {
      "completionTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "creationTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "description" : "string",
      "name" : "string",
      "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
      "type" : "string"
    } ],
    "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
    "type" : "string"
  } ],
  "type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}
Response 202
{
  "completionTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "creationTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "errors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "id" : "string",
  "isCancellable" : true,
  "name" : "string",
  "resources" : [ {
    "fqdn" : "string",
    "name" : "string",
    "resourceId" : "string",
    "type" : "string"
  } ],
  "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
  "subTasks" : [ {
    "completionTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "creationTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "description" : "string",
    "errors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "name" : "string",
    "resources" : [ {
      "fqdn" : "string",
      "name" : "string",
      "resourceId" : "string",
      "type" : "string"
    } ],
    "stages" : [ {
      "completionTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "creationTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "description" : "string",
      "name" : "string",
      "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
      "type" : "string"
    } ],
    "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
    "type" : "string"
  } ],
  "type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}
Response 400
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 404
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 500
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.37. Update a Domain by marking for deletion

PATCH /v1/domains/{id}

3.37.1. Parameters

Type Name Description Schema

Path

id
required

Domain ID

string

Body

domainUpdateSpec
required

Domain Update Data

DomainUpdateSpec

3.37.2. Responses

HTTP Code Description Schema

200

Ok

Task

400

Bad Request

Error

404

Not Found

Error

500

InternalServerError

Error

3.37.3. Consumes

  • application/json

3.37.4. Produces

  • application/json

3.37.5. Tags

  • Domains

3.37.6. Security

Type Name

basic

basicAuth

3.37.7. Example HTTP request

Request path
/v1/domains/string
Request body
{
  "markForDeletion" : true
}

3.37.8. Example HTTP response

Response 200
{
  "completionTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "creationTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "errors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "id" : "string",
  "isCancellable" : true,
  "name" : "string",
  "resources" : [ {
    "fqdn" : "string",
    "name" : "string",
    "resourceId" : "string",
    "type" : "string"
  } ],
  "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
  "subTasks" : [ {
    "completionTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "creationTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "description" : "string",
    "errors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "name" : "string",
    "resources" : [ {
      "fqdn" : "string",
      "name" : "string",
      "resourceId" : "string",
      "type" : "string"
    } ],
    "stages" : [ {
      "completionTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "creationTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "description" : "string",
      "name" : "string",
      "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
      "type" : "string"
    } ],
    "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
    "type" : "string"
  } ],
  "type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}
Response 400
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 404
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 500
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.38. Get Endpoints of a Domain

GET /v1/domains/{id}/endpoints

3.38.1. Parameters

Type Name Description Schema

Path

id
required

Domain ID

string

3.38.2. Responses

HTTP Code Description Schema

200

Ok

Endpoint

404

Domain not found

Error

500

InternalServerError

Error

3.38.3. Consumes

  • application/json

3.38.4. Produces

  • application/json

3.38.5. Tags

  • Domains

3.38.6. Security

Type Name

basic

basicAuth

3.38.7. Example HTTP request

Request path
/v1/domains/string/endpoints

3.38.8. Example HTTP response

Response 200
{
  "type" : "One among: PSC, VCENTER, NSX_MANAGER, NSX_T_MANAGER, VRLI, VRA, VROPS, VRSLCM",
  "url" : "string"
}
Response 404
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 500
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.39. Deploy Horizon Suite

POST /v1/horizons

3.39.1. Parameters

Type Name Description Schema

Body

horizonSpec
required

Horizon specification

Horizon

3.39.2. Responses

HTTP Code Description Schema

200

OK

Task

202

Accepted

Task

400

Bad Request

Error

409

Conflict

Error

500

Internal server error

Error

3.39.3. Consumes

  • application/json

3.39.4. Produces

  • application/json

3.39.5. Tags

  • HorizonManager

3.39.6. Security

Type Name

basic

basicAuth

3.39.7. Example HTTP request

Request path
/v1/horizons
Request body
{
  "appVolumesDetails" : {
    "adminGroupName" : "string",
    "appVolumes" : [ {
      "deployDetails" : {
        "computerName" : "string",
        "gateway" : "string",
        "ipAddress" : "string",
        "subnetMask" : "string",
        "vmName" : "string"
      },
      "fqdn" : "string",
      "state" : "NEW"
    } ],
    "datastores" : [ {
      "id" : "string",
      "isPrimary" : true
    } ],
    "dbName" : "string",
    "lbFqdn" : "string",
    "license" : "string",
    "sqlId" : "string"
  },
  "horizon" : {
    "adminGroupName" : "string",
    "externalLbFqdn" : "string",
    "internalLbFqdn" : "string",
    "license" : "string",
    "pods" : [ {
      "composerServers" : [ {
        "certificatePassword" : "string",
        "certificatePath" : "string",
        "composerServiceAccount" : "string",
        "composerServicePassword" : "string",
        "dbName" : "string",
        "deployDetails" : {
          "computerName" : "string",
          "gateway" : "string",
          "ipAddress" : "string",
          "subnetMask" : "string",
          "vmName" : "string"
        },
        "fqdn" : "string",
        "internalDbPassword" : "string",
        "internalDbUsername" : "string",
        "sqlId" : "string",
        "state" : "NEW",
        "vcFqdn" : "string"
      } ],
      "connectionServers" : [ {
        "certificatePassword" : "string",
        "certificatePath" : "string",
        "deployDetails" : {
          "computerName" : "string",
          "gateway" : "string",
          "ipAddress" : "string",
          "subnetMask" : "string",
          "vmName" : "string"
        },
        "fqdn" : "string",
        "state" : "NEW"
      } ],
      "eventDbName" : "string",
      "sqlId" : "string",
      "uagAppliances" : [ {
        "administratorPassword" : "string",
        "defaultGateway" : "string",
        "externalIpAddress" : "string",
        "externalSubnetMask" : "string",
        "internalIpAddress" : "string",
        "internalSubnetMask" : "string",
        "mgmtIpAddress" : "string",
        "mgmtSubnetMask" : "string",
        "state" : "NEW",
        "vmName" : "string"
      } ],
      "vcFqdns" : [ "string" ]
    } ],
    "uemDetails" : {
      "license" : "string",
      "uems" : [ {
        "configurationShare" : "string",
        "deployDetails" : {
          "computerName" : "string",
          "configurationShareLocation" : "string",
          "dataDriveSizeGb" : 0,
          "gateway" : "string",
          "ipAddress" : "string",
          "profileArchiveShareLocation" : "string",
          "subnetMask" : "string",
          "vmName" : "string"
        },
        "fqdn" : "string",
        "profileArchiveShare" : "string",
        "state" : "NEW"
      } ]
    }
  },
  "id" : "string",
  "managementVcenters" : [ {
    "clusterName" : "string",
    "datacenterName" : "string",
    "datastoreName" : "string",
    "dmzPortgroup" : "string",
    "host" : "string",
    "interconnectPortgroup" : "string",
    "managementPortgroup" : "string",
    "nsx" : {
      "host" : "string",
      "password" : "string"
    },
    "password" : "string",
    "psc" : {
      "host" : "string"
    },
    "uagManagementPortgroup" : "string",
    "username" : "string"
  } ],
  "name" : "string",
  "peripheralServices" : {
    "activeDirectory" : {
      "adminPassword" : "string",
      "adminUsername" : "string",
      "domainControllers" : [ {
        "fqdn" : "string",
        "ipAddress" : "string",
        "sslThumbprint" : "string",
        "state" : "NEW"
      } ],
      "fqdn" : "string",
      "netBiosName" : "string",
      "ouRwPassword" : "string",
      "ouRwUsername" : "string",
      "securedAD" : true,
      "vdiAdminPassword" : "string",
      "vdiAdminUsername" : "string",
      "vdiServerOu" : "string"
    },
    "installDetails" : {
      "appVolumesServerBinaryPath" : "string",
      "appVolumesServerVersion" : "string",
      "composerServerBinaryPath" : "string",
      "composerServerVersion" : "string",
      "connectionServerBinaryPath" : "string",
      "connectionServerVersion" : "string",
      "dotNet462BinaryPath" : "string",
      "imagePath" : "string",
      "ova" : {
        "administratorPassword" : "string",
        "administratorUsername" : "string"
      },
      "sqlExpressPath" : "string",
      "sqlExpressVersion" : "string",
      "uagOvaPath" : "string",
      "uagOvaVersion" : "string",
      "uemBinaryPath" : "string",
      "uemVersion" : "string",
      "updateKb2919355BinaryPath" : "string",
      "updateKb2919442BinaryPath" : "string"
    },
    "loadBalancers" : [ {
      "certificatePassword" : "string",
      "certificatePath" : "string",
      "deployDetails" : {
        "cliPassword" : "string",
        "gateway" : "string",
        "portgroup" : "string",
        "subnetMask" : "string",
        "vmName" : "string"
      },
      "fqdn" : "string",
      "ipAddress" : "string",
      "state" : "NEW"
    } ],
    "sqlConnections" : [ {
      "dbPassword" : "string",
      "dbUsername" : "string",
      "fqdn" : "string",
      "id" : "string",
      "sqlInstanceName" : "string",
      "sqlPort" : 0,
      "state" : "NEW"
    } ]
  },
  "resourceVcenters" : [ {
    "datacenters" : [ {
      "clusters" : [ {
        "hosts" : [ {
          "fqdn" : "string",
          "id" : "string",
          "password" : "string",
          "username" : "string"
        } ],
        "name" : "string"
      } ],
      "datastores" : [ {
        "hostIds" : [ "string" ],
        "id" : "string",
        "name" : "string"
      } ],
      "name" : "string"
    } ],
    "host" : "string",
    "password" : "string",
    "psc" : {
      "host" : "string"
    },
    "state" : "NEW",
    "username" : "string"
  } ]
}

3.39.8. Example HTTP response

Response 200
{
  "completionTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "creationTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "errors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "id" : "string",
  "isCancellable" : true,
  "name" : "string",
  "resources" : [ {
    "fqdn" : "string",
    "name" : "string",
    "resourceId" : "string",
    "type" : "string"
  } ],
  "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
  "subTasks" : [ {
    "completionTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "creationTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "description" : "string",
    "errors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "name" : "string",
    "resources" : [ {
      "fqdn" : "string",
      "name" : "string",
      "resourceId" : "string",
      "type" : "string"
    } ],
    "stages" : [ {
      "completionTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "creationTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "description" : "string",
      "name" : "string",
      "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
      "type" : "string"
    } ],
    "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
    "type" : "string"
  } ],
  "type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}
Response 202
{
  "completionTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "creationTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "errors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "id" : "string",
  "isCancellable" : true,
  "name" : "string",
  "resources" : [ {
    "fqdn" : "string",
    "name" : "string",
    "resourceId" : "string",
    "type" : "string"
  } ],
  "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
  "subTasks" : [ {
    "completionTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "creationTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "description" : "string",
    "errors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "name" : "string",
    "resources" : [ {
      "fqdn" : "string",
      "name" : "string",
      "resourceId" : "string",
      "type" : "string"
    } ],
    "stages" : [ {
      "completionTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "creationTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "description" : "string",
      "name" : "string",
      "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
      "type" : "string"
    } ],
    "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
    "type" : "string"
  } ],
  "type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}
Response 400
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 409
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 500
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.40. Get Horizon Suite configuration specs

GET /v1/horizons

3.40.1. Parameters

Type Name Description Schema

Query

id
optional

id

< string > array(multi)

3.40.2. Responses

HTTP Code Description Schema

200

OK

PageOfHorizon

400

Bad Request

Error

404

Not Found

Error

409

Conflict

Error

500

Internal server error

Error

3.40.3. Consumes

  • application/json

3.40.4. Produces

  • application/json

3.40.5. Tags

  • HorizonManager

3.40.6. Security

Type Name

basic

basicAuth

3.40.7. Example HTTP request

Request path
/v1/horizons

3.40.8. Example HTTP response

Response 200
{
  "elements" : [ {
    "appVolumesDetails" : {
      "adminGroupName" : "string",
      "appVolumes" : [ {
        "deployDetails" : {
          "computerName" : "string",
          "gateway" : "string",
          "ipAddress" : "string",
          "subnetMask" : "string",
          "vmName" : "string"
        },
        "fqdn" : "string",
        "state" : "NEW"
      } ],
      "datastores" : [ {
        "id" : "string",
        "isPrimary" : true
      } ],
      "dbName" : "string",
      "lbFqdn" : "string",
      "license" : "string",
      "sqlId" : "string"
    },
    "horizon" : {
      "adminGroupName" : "string",
      "externalLbFqdn" : "string",
      "internalLbFqdn" : "string",
      "license" : "string",
      "pods" : [ {
        "composerServers" : [ {
          "certificatePassword" : "string",
          "certificatePath" : "string",
          "composerServiceAccount" : "string",
          "composerServicePassword" : "string",
          "dbName" : "string",
          "deployDetails" : {
            "computerName" : "string",
            "gateway" : "string",
            "ipAddress" : "string",
            "subnetMask" : "string",
            "vmName" : "string"
          },
          "fqdn" : "string",
          "internalDbPassword" : "string",
          "internalDbUsername" : "string",
          "sqlId" : "string",
          "state" : "NEW",
          "vcFqdn" : "string"
        } ],
        "connectionServers" : [ {
          "certificatePassword" : "string",
          "certificatePath" : "string",
          "deployDetails" : {
            "computerName" : "string",
            "gateway" : "string",
            "ipAddress" : "string",
            "subnetMask" : "string",
            "vmName" : "string"
          },
          "fqdn" : "string",
          "state" : "NEW"
        } ],
        "eventDbName" : "string",
        "sqlId" : "string",
        "uagAppliances" : [ {
          "administratorPassword" : "string",
          "defaultGateway" : "string",
          "externalIpAddress" : "string",
          "externalSubnetMask" : "string",
          "internalIpAddress" : "string",
          "internalSubnetMask" : "string",
          "mgmtIpAddress" : "string",
          "mgmtSubnetMask" : "string",
          "state" : "NEW",
          "vmName" : "string"
        } ],
        "vcFqdns" : [ "string" ]
      } ],
      "uemDetails" : {
        "license" : "string",
        "uems" : [ {
          "configurationShare" : "string",
          "deployDetails" : {
            "computerName" : "string",
            "configurationShareLocation" : "string",
            "dataDriveSizeGb" : 0,
            "gateway" : "string",
            "ipAddress" : "string",
            "profileArchiveShareLocation" : "string",
            "subnetMask" : "string",
            "vmName" : "string"
          },
          "fqdn" : "string",
          "profileArchiveShare" : "string",
          "state" : "NEW"
        } ]
      }
    },
    "id" : "string",
    "managementVcenters" : [ {
      "clusterName" : "string",
      "datacenterName" : "string",
      "datastoreName" : "string",
      "dmzPortgroup" : "string",
      "host" : "string",
      "interconnectPortgroup" : "string",
      "managementPortgroup" : "string",
      "nsx" : {
        "host" : "string",
        "password" : "string"
      },
      "password" : "string",
      "psc" : {
        "host" : "string"
      },
      "uagManagementPortgroup" : "string",
      "username" : "string"
    } ],
    "name" : "string",
    "peripheralServices" : {
      "activeDirectory" : {
        "adminPassword" : "string",
        "adminUsername" : "string",
        "domainControllers" : [ {
          "fqdn" : "string",
          "ipAddress" : "string",
          "sslThumbprint" : "string",
          "state" : "NEW"
        } ],
        "fqdn" : "string",
        "netBiosName" : "string",
        "ouRwPassword" : "string",
        "ouRwUsername" : "string",
        "securedAD" : true,
        "vdiAdminPassword" : "string",
        "vdiAdminUsername" : "string",
        "vdiServerOu" : "string"
      },
      "installDetails" : {
        "appVolumesServerBinaryPath" : "string",
        "appVolumesServerVersion" : "string",
        "composerServerBinaryPath" : "string",
        "composerServerVersion" : "string",
        "connectionServerBinaryPath" : "string",
        "connectionServerVersion" : "string",
        "dotNet462BinaryPath" : "string",
        "imagePath" : "string",
        "ova" : {
          "administratorPassword" : "string",
          "administratorUsername" : "string"
        },
        "sqlExpressPath" : "string",
        "sqlExpressVersion" : "string",
        "uagOvaPath" : "string",
        "uagOvaVersion" : "string",
        "uemBinaryPath" : "string",
        "uemVersion" : "string",
        "updateKb2919355BinaryPath" : "string",
        "updateKb2919442BinaryPath" : "string"
      },
      "loadBalancers" : [ {
        "certificatePassword" : "string",
        "certificatePath" : "string",
        "deployDetails" : {
          "cliPassword" : "string",
          "gateway" : "string",
          "portgroup" : "string",
          "subnetMask" : "string",
          "vmName" : "string"
        },
        "fqdn" : "string",
        "ipAddress" : "string",
        "state" : "NEW"
      } ],
      "sqlConnections" : [ {
        "dbPassword" : "string",
        "dbUsername" : "string",
        "fqdn" : "string",
        "id" : "string",
        "sqlInstanceName" : "string",
        "sqlPort" : 0,
        "state" : "NEW"
      } ]
    },
    "resourceVcenters" : [ {
      "datacenters" : [ {
        "clusters" : [ {
          "hosts" : [ {
            "fqdn" : "string",
            "id" : "string",
            "password" : "string",
            "username" : "string"
          } ],
          "name" : "string"
        } ],
        "datastores" : [ {
          "hostIds" : [ "string" ],
          "id" : "string",
          "name" : "string"
        } ],
        "name" : "string"
      } ],
      "host" : "string",
      "password" : "string",
      "psc" : {
        "host" : "string"
      },
      "state" : "NEW",
      "username" : "string"
    } ]
  } ]
}
Response 400
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 404
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 409
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 500
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.41. Validates Horizon configuration

POST /v1/horizons/validations

3.41.1. Parameters

Type Name Description Schema

Body

horizonValidationSpec
required

Validation specification

HorizonValidationSpec

3.41.2. Responses

HTTP Code Description Schema

200

OK

Validation

202

Accepted

Validation

400

Bad Request

Error

409

Conflict

Error

500

Internal server error

Error

3.41.3. Consumes

  • application/json

3.41.4. Produces

  • application/json

3.41.5. Tags

  • HorizonManager

3.41.6. Security

Type Name

basic

basicAuth

3.41.7. Example HTTP request

Request path
/v1/horizons/validations
Request body
{
  "horizon" : {
    "appVolumesDetails" : {
      "adminGroupName" : "string",
      "appVolumes" : [ {
        "deployDetails" : {
          "computerName" : "string",
          "gateway" : "string",
          "ipAddress" : "string",
          "subnetMask" : "string",
          "vmName" : "string"
        },
        "fqdn" : "string",
        "state" : "NEW"
      } ],
      "datastores" : [ {
        "id" : "string",
        "isPrimary" : true
      } ],
      "dbName" : "string",
      "lbFqdn" : "string",
      "license" : "string",
      "sqlId" : "string"
    },
    "horizon" : {
      "adminGroupName" : "string",
      "externalLbFqdn" : "string",
      "internalLbFqdn" : "string",
      "license" : "string",
      "pods" : [ {
        "composerServers" : [ {
          "certificatePassword" : "string",
          "certificatePath" : "string",
          "composerServiceAccount" : "string",
          "composerServicePassword" : "string",
          "dbName" : "string",
          "deployDetails" : {
            "computerName" : "string",
            "gateway" : "string",
            "ipAddress" : "string",
            "subnetMask" : "string",
            "vmName" : "string"
          },
          "fqdn" : "string",
          "internalDbPassword" : "string",
          "internalDbUsername" : "string",
          "sqlId" : "string",
          "state" : "NEW",
          "vcFqdn" : "string"
        } ],
        "connectionServers" : [ {
          "certificatePassword" : "string",
          "certificatePath" : "string",
          "deployDetails" : {
            "computerName" : "string",
            "gateway" : "string",
            "ipAddress" : "string",
            "subnetMask" : "string",
            "vmName" : "string"
          },
          "fqdn" : "string",
          "state" : "NEW"
        } ],
        "eventDbName" : "string",
        "sqlId" : "string",
        "uagAppliances" : [ {
          "administratorPassword" : "string",
          "defaultGateway" : "string",
          "externalIpAddress" : "string",
          "externalSubnetMask" : "string",
          "internalIpAddress" : "string",
          "internalSubnetMask" : "string",
          "mgmtIpAddress" : "string",
          "mgmtSubnetMask" : "string",
          "state" : "NEW",
          "vmName" : "string"
        } ],
        "vcFqdns" : [ "string" ]
      } ],
      "uemDetails" : {
        "license" : "string",
        "uems" : [ {
          "configurationShare" : "string",
          "deployDetails" : {
            "computerName" : "string",
            "configurationShareLocation" : "string",
            "dataDriveSizeGb" : 0,
            "gateway" : "string",
            "ipAddress" : "string",
            "profileArchiveShareLocation" : "string",
            "subnetMask" : "string",
            "vmName" : "string"
          },
          "fqdn" : "string",
          "profileArchiveShare" : "string",
          "state" : "NEW"
        } ]
      }
    },
    "id" : "string",
    "managementVcenters" : [ {
      "clusterName" : "string",
      "datacenterName" : "string",
      "datastoreName" : "string",
      "dmzPortgroup" : "string",
      "host" : "string",
      "interconnectPortgroup" : "string",
      "managementPortgroup" : "string",
      "nsx" : {
        "host" : "string",
        "password" : "string"
      },
      "password" : "string",
      "psc" : {
        "host" : "string"
      },
      "uagManagementPortgroup" : "string",
      "username" : "string"
    } ],
    "name" : "string",
    "peripheralServices" : {
      "activeDirectory" : {
        "adminPassword" : "string",
        "adminUsername" : "string",
        "domainControllers" : [ {
          "fqdn" : "string",
          "ipAddress" : "string",
          "sslThumbprint" : "string",
          "state" : "NEW"
        } ],
        "fqdn" : "string",
        "netBiosName" : "string",
        "ouRwPassword" : "string",
        "ouRwUsername" : "string",
        "securedAD" : true,
        "vdiAdminPassword" : "string",
        "vdiAdminUsername" : "string",
        "vdiServerOu" : "string"
      },
      "installDetails" : {
        "appVolumesServerBinaryPath" : "string",
        "appVolumesServerVersion" : "string",
        "composerServerBinaryPath" : "string",
        "composerServerVersion" : "string",
        "connectionServerBinaryPath" : "string",
        "connectionServerVersion" : "string",
        "dotNet462BinaryPath" : "string",
        "imagePath" : "string",
        "ova" : {
          "administratorPassword" : "string",
          "administratorUsername" : "string"
        },
        "sqlExpressPath" : "string",
        "sqlExpressVersion" : "string",
        "uagOvaPath" : "string",
        "uagOvaVersion" : "string",
        "uemBinaryPath" : "string",
        "uemVersion" : "string",
        "updateKb2919355BinaryPath" : "string",
        "updateKb2919442BinaryPath" : "string"
      },
      "loadBalancers" : [ {
        "certificatePassword" : "string",
        "certificatePath" : "string",
        "deployDetails" : {
          "cliPassword" : "string",
          "gateway" : "string",
          "portgroup" : "string",
          "subnetMask" : "string",
          "vmName" : "string"
        },
        "fqdn" : "string",
        "ipAddress" : "string",
        "state" : "NEW"
      } ],
      "sqlConnections" : [ {
        "dbPassword" : "string",
        "dbUsername" : "string",
        "fqdn" : "string",
        "id" : "string",
        "sqlInstanceName" : "string",
        "sqlPort" : 0,
        "state" : "NEW"
      } ]
    },
    "resourceVcenters" : [ {
      "datacenters" : [ {
        "clusters" : [ {
          "hosts" : [ {
            "fqdn" : "string",
            "id" : "string",
            "password" : "string",
            "username" : "string"
          } ],
          "name" : "string"
        } ],
        "datastores" : [ {
          "hostIds" : [ "string" ],
          "id" : "string",
          "name" : "string"
        } ],
        "name" : "string"
      } ],
      "host" : "string",
      "password" : "string",
      "psc" : {
        "host" : "string"
      },
      "state" : "NEW",
      "username" : "string"
    } ]
  },
  "horizonValidationOperation" : {
    "type" : "PRE_VALIDATION_CREATION, PRE_VALIDATION_EXPANSION"
  }
}

3.41.8. Example HTTP response

Response 200
{
  "description" : "string",
  "executionStatus" : "One among: IN_PROGRESS, FAILED, COMPLETED, SKIPPED, CANCELLED",
  "id" : "string",
  "resultStatus" : "One among: SUCCEEDED, FAILED, FAILED_WITH_WARNINGS",
  "validationChecks" : [ {
    "description" : "string",
    "errorResponse" : {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ {
        "arguments" : [ "string" ],
        "causes" : [ {
          "message" : "string",
          "type" : "string"
        } ],
        "context" : {
          "string" : "string"
        },
        "errorCode" : "string",
        "message" : "string",
        "nestedErrors" : [ "..." ],
        "referenceToken" : "string",
        "remediationMessage" : "string"
      } ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    },
    "nestedValidationChecks" : [ {
      "description" : "string",
      "errorResponse" : {
        "arguments" : [ "string" ],
        "causes" : [ {
          "message" : "string",
          "type" : "string"
        } ],
        "context" : {
          "string" : "string"
        },
        "errorCode" : "string",
        "message" : "string",
        "nestedErrors" : [ "..." ],
        "referenceToken" : "string",
        "remediationMessage" : "string"
      },
      "nestedValidationChecks" : [ "..." ],
      "resultStatus" : "One among: SUCCEEDED, FAILED",
      "severity" : "One among: WARNING, ERROR, INFO"
    } ],
    "resultStatus" : "One among: SUCCEEDED, FAILED",
    "severity" : "One among: WARNING, ERROR, INFO"
  } ]
}
Response 202
{
  "description" : "string",
  "executionStatus" : "One among: IN_PROGRESS, FAILED, COMPLETED, SKIPPED, CANCELLED",
  "id" : "string",
  "resultStatus" : "One among: SUCCEEDED, FAILED, FAILED_WITH_WARNINGS",
  "validationChecks" : [ {
    "description" : "string",
    "errorResponse" : {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ {
        "arguments" : [ "string" ],
        "causes" : [ {
          "message" : "string",
          "type" : "string"
        } ],
        "context" : {
          "string" : "string"
        },
        "errorCode" : "string",
        "message" : "string",
        "nestedErrors" : [ "..." ],
        "referenceToken" : "string",
        "remediationMessage" : "string"
      } ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    },
    "nestedValidationChecks" : [ {
      "description" : "string",
      "errorResponse" : {
        "arguments" : [ "string" ],
        "causes" : [ {
          "message" : "string",
          "type" : "string"
        } ],
        "context" : {
          "string" : "string"
        },
        "errorCode" : "string",
        "message" : "string",
        "nestedErrors" : [ "..." ],
        "referenceToken" : "string",
        "remediationMessage" : "string"
      },
      "nestedValidationChecks" : [ "..." ],
      "resultStatus" : "One among: SUCCEEDED, FAILED",
      "severity" : "One among: WARNING, ERROR, INFO"
    } ],
    "resultStatus" : "One among: SUCCEEDED, FAILED",
    "severity" : "One among: WARNING, ERROR, INFO"
  } ]
}
Response 400
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 409
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 500
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.42. Get Horizon Validation

GET /v1/horizons/validations/{id}

3.42.1. Parameters

Type Name Description Schema

Path

id
required

Validation ID

string

3.42.2. Responses

HTTP Code Description Schema

200

Accepted

Validation

400

Bad Request

Error

404

Not Found

Error

409

Conflict

Error

500

Internal server error

Error

3.42.3. Consumes

  • application/json

3.42.4. Produces

  • application/json

3.42.5. Tags

  • HorizonManager

3.42.6. Security

Type Name

basic

basicAuth

3.42.7. Example HTTP request

Request path
/v1/horizons/validations/string

3.42.8. Example HTTP response

Response 200
{
  "description" : "string",
  "executionStatus" : "One among: IN_PROGRESS, FAILED, COMPLETED, SKIPPED, CANCELLED",
  "id" : "string",
  "resultStatus" : "One among: SUCCEEDED, FAILED, FAILED_WITH_WARNINGS",
  "validationChecks" : [ {
    "description" : "string",
    "errorResponse" : {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ {
        "arguments" : [ "string" ],
        "causes" : [ {
          "message" : "string",
          "type" : "string"
        } ],
        "context" : {
          "string" : "string"
        },
        "errorCode" : "string",
        "message" : "string",
        "nestedErrors" : [ "..." ],
        "referenceToken" : "string",
        "remediationMessage" : "string"
      } ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    },
    "nestedValidationChecks" : [ {
      "description" : "string",
      "errorResponse" : {
        "arguments" : [ "string" ],
        "causes" : [ {
          "message" : "string",
          "type" : "string"
        } ],
        "context" : {
          "string" : "string"
        },
        "errorCode" : "string",
        "message" : "string",
        "nestedErrors" : [ "..." ],
        "referenceToken" : "string",
        "remediationMessage" : "string"
      },
      "nestedValidationChecks" : [ "..." ],
      "resultStatus" : "One among: SUCCEEDED, FAILED",
      "severity" : "One among: WARNING, ERROR, INFO"
    } ],
    "resultStatus" : "One among: SUCCEEDED, FAILED",
    "severity" : "One among: WARNING, ERROR, INFO"
  } ]
}
Response 400
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 404
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 409
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 500
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.43. Get Horizon Suite configuration spec

GET /v1/horizons/{id}

3.43.1. Parameters

Type Name Description Schema

Path

id
required

Horizon ID

string

3.43.2. Responses

HTTP Code Description Schema

200

OK

Horizon

400

Bad Request

Error

404

Not Found

Error

409

Conflict

Error

500

Internal server error

Error

3.43.3. Consumes

  • application/json

3.43.4. Produces

  • application/json

3.43.5. Tags

  • HorizonManager

3.43.6. Security

Type Name

basic

basicAuth

3.43.7. Example HTTP request

Request path
/v1/horizons/string

3.43.8. Example HTTP response

Response 200
{
  "appVolumesDetails" : {
    "adminGroupName" : "string",
    "appVolumes" : [ {
      "deployDetails" : {
        "computerName" : "string",
        "gateway" : "string",
        "ipAddress" : "string",
        "subnetMask" : "string",
        "vmName" : "string"
      },
      "fqdn" : "string",
      "state" : "NEW"
    } ],
    "datastores" : [ {
      "id" : "string",
      "isPrimary" : true
    } ],
    "dbName" : "string",
    "lbFqdn" : "string",
    "license" : "string",
    "sqlId" : "string"
  },
  "horizon" : {
    "adminGroupName" : "string",
    "externalLbFqdn" : "string",
    "internalLbFqdn" : "string",
    "license" : "string",
    "pods" : [ {
      "composerServers" : [ {
        "certificatePassword" : "string",
        "certificatePath" : "string",
        "composerServiceAccount" : "string",
        "composerServicePassword" : "string",
        "dbName" : "string",
        "deployDetails" : {
          "computerName" : "string",
          "gateway" : "string",
          "ipAddress" : "string",
          "subnetMask" : "string",
          "vmName" : "string"
        },
        "fqdn" : "string",
        "internalDbPassword" : "string",
        "internalDbUsername" : "string",
        "sqlId" : "string",
        "state" : "NEW",
        "vcFqdn" : "string"
      } ],
      "connectionServers" : [ {
        "certificatePassword" : "string",
        "certificatePath" : "string",
        "deployDetails" : {
          "computerName" : "string",
          "gateway" : "string",
          "ipAddress" : "string",
          "subnetMask" : "string",
          "vmName" : "string"
        },
        "fqdn" : "string",
        "state" : "NEW"
      } ],
      "eventDbName" : "string",
      "sqlId" : "string",
      "uagAppliances" : [ {
        "administratorPassword" : "string",
        "defaultGateway" : "string",
        "externalIpAddress" : "string",
        "externalSubnetMask" : "string",
        "internalIpAddress" : "string",
        "internalSubnetMask" : "string",
        "mgmtIpAddress" : "string",
        "mgmtSubnetMask" : "string",
        "state" : "NEW",
        "vmName" : "string"
      } ],
      "vcFqdns" : [ "string" ]
    } ],
    "uemDetails" : {
      "license" : "string",
      "uems" : [ {
        "configurationShare" : "string",
        "deployDetails" : {
          "computerName" : "string",
          "configurationShareLocation" : "string",
          "dataDriveSizeGb" : 0,
          "gateway" : "string",
          "ipAddress" : "string",
          "profileArchiveShareLocation" : "string",
          "subnetMask" : "string",
          "vmName" : "string"
        },
        "fqdn" : "string",
        "profileArchiveShare" : "string",
        "state" : "NEW"
      } ]
    }
  },
  "id" : "string",
  "managementVcenters" : [ {
    "clusterName" : "string",
    "datacenterName" : "string",
    "datastoreName" : "string",
    "dmzPortgroup" : "string",
    "host" : "string",
    "interconnectPortgroup" : "string",
    "managementPortgroup" : "string",
    "nsx" : {
      "host" : "string",
      "password" : "string"
    },
    "password" : "string",
    "psc" : {
      "host" : "string"
    },
    "uagManagementPortgroup" : "string",
    "username" : "string"
  } ],
  "name" : "string",
  "peripheralServices" : {
    "activeDirectory" : {
      "adminPassword" : "string",
      "adminUsername" : "string",
      "domainControllers" : [ {
        "fqdn" : "string",
        "ipAddress" : "string",
        "sslThumbprint" : "string",
        "state" : "NEW"
      } ],
      "fqdn" : "string",
      "netBiosName" : "string",
      "ouRwPassword" : "string",
      "ouRwUsername" : "string",
      "securedAD" : true,
      "vdiAdminPassword" : "string",
      "vdiAdminUsername" : "string",
      "vdiServerOu" : "string"
    },
    "installDetails" : {
      "appVolumesServerBinaryPath" : "string",
      "appVolumesServerVersion" : "string",
      "composerServerBinaryPath" : "string",
      "composerServerVersion" : "string",
      "connectionServerBinaryPath" : "string",
      "connectionServerVersion" : "string",
      "dotNet462BinaryPath" : "string",
      "imagePath" : "string",
      "ova" : {
        "administratorPassword" : "string",
        "administratorUsername" : "string"
      },
      "sqlExpressPath" : "string",
      "sqlExpressVersion" : "string",
      "uagOvaPath" : "string",
      "uagOvaVersion" : "string",
      "uemBinaryPath" : "string",
      "uemVersion" : "string",
      "updateKb2919355BinaryPath" : "string",
      "updateKb2919442BinaryPath" : "string"
    },
    "loadBalancers" : [ {
      "certificatePassword" : "string",
      "certificatePath" : "string",
      "deployDetails" : {
        "cliPassword" : "string",
        "gateway" : "string",
        "portgroup" : "string",
        "subnetMask" : "string",
        "vmName" : "string"
      },
      "fqdn" : "string",
      "ipAddress" : "string",
      "state" : "NEW"
    } ],
    "sqlConnections" : [ {
      "dbPassword" : "string",
      "dbUsername" : "string",
      "fqdn" : "string",
      "id" : "string",
      "sqlInstanceName" : "string",
      "sqlPort" : 0,
      "state" : "NEW"
    } ]
  },
  "resourceVcenters" : [ {
    "datacenters" : [ {
      "clusters" : [ {
        "hosts" : [ {
          "fqdn" : "string",
          "id" : "string",
          "password" : "string",
          "username" : "string"
        } ],
        "name" : "string"
      } ],
      "datastores" : [ {
        "hostIds" : [ "string" ],
        "id" : "string",
        "name" : "string"
      } ],
      "name" : "string"
    } ],
    "host" : "string",
    "password" : "string",
    "psc" : {
      "host" : "string"
    },
    "state" : "NEW",
    "username" : "string"
  } ]
}
Response 400
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 404
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 409
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 500
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.44. Expand Horizon Suite

PUT /v1/horizons/{id}

3.44.1. Parameters

Type Name Description Schema

Path

id
required

Horizon ID

string

Body

horizonSpec
required

Horizon expand specification

Horizon

3.44.2. Responses

HTTP Code Description Schema

200

OK

Task

202

Accepted

Task

400

Bad Request

Error

409

Conflict

Error

500

Internal server error

Error

3.44.3. Consumes

  • application/json

3.44.4. Produces

  • application/json

3.44.5. Tags

  • HorizonManager

3.44.6. Security

Type Name

basic

basicAuth

3.44.7. Example HTTP request

Request path
/v1/horizons/string
Request body
{
  "appVolumesDetails" : {
    "adminGroupName" : "string",
    "appVolumes" : [ {
      "deployDetails" : {
        "computerName" : "string",
        "gateway" : "string",
        "ipAddress" : "string",
        "subnetMask" : "string",
        "vmName" : "string"
      },
      "fqdn" : "string",
      "state" : "NEW"
    } ],
    "datastores" : [ {
      "id" : "string",
      "isPrimary" : true
    } ],
    "dbName" : "string",
    "lbFqdn" : "string",
    "license" : "string",
    "sqlId" : "string"
  },
  "horizon" : {
    "adminGroupName" : "string",
    "externalLbFqdn" : "string",
    "internalLbFqdn" : "string",
    "license" : "string",
    "pods" : [ {
      "composerServers" : [ {
        "certificatePassword" : "string",
        "certificatePath" : "string",
        "composerServiceAccount" : "string",
        "composerServicePassword" : "string",
        "dbName" : "string",
        "deployDetails" : {
          "computerName" : "string",
          "gateway" : "string",
          "ipAddress" : "string",
          "subnetMask" : "string",
          "vmName" : "string"
        },
        "fqdn" : "string",
        "internalDbPassword" : "string",
        "internalDbUsername" : "string",
        "sqlId" : "string",
        "state" : "NEW",
        "vcFqdn" : "string"
      } ],
      "connectionServers" : [ {
        "certificatePassword" : "string",
        "certificatePath" : "string",
        "deployDetails" : {
          "computerName" : "string",
          "gateway" : "string",
          "ipAddress" : "string",
          "subnetMask" : "string",
          "vmName" : "string"
        },
        "fqdn" : "string",
        "state" : "NEW"
      } ],
      "eventDbName" : "string",
      "sqlId" : "string",
      "uagAppliances" : [ {
        "administratorPassword" : "string",
        "defaultGateway" : "string",
        "externalIpAddress" : "string",
        "externalSubnetMask" : "string",
        "internalIpAddress" : "string",
        "internalSubnetMask" : "string",
        "mgmtIpAddress" : "string",
        "mgmtSubnetMask" : "string",
        "state" : "NEW",
        "vmName" : "string"
      } ],
      "vcFqdns" : [ "string" ]
    } ],
    "uemDetails" : {
      "license" : "string",
      "uems" : [ {
        "configurationShare" : "string",
        "deployDetails" : {
          "computerName" : "string",
          "configurationShareLocation" : "string",
          "dataDriveSizeGb" : 0,
          "gateway" : "string",
          "ipAddress" : "string",
          "profileArchiveShareLocation" : "string",
          "subnetMask" : "string",
          "vmName" : "string"
        },
        "fqdn" : "string",
        "profileArchiveShare" : "string",
        "state" : "NEW"
      } ]
    }
  },
  "id" : "string",
  "managementVcenters" : [ {
    "clusterName" : "string",
    "datacenterName" : "string",
    "datastoreName" : "string",
    "dmzPortgroup" : "string",
    "host" : "string",
    "interconnectPortgroup" : "string",
    "managementPortgroup" : "string",
    "nsx" : {
      "host" : "string",
      "password" : "string"
    },
    "password" : "string",
    "psc" : {
      "host" : "string"
    },
    "uagManagementPortgroup" : "string",
    "username" : "string"
  } ],
  "name" : "string",
  "peripheralServices" : {
    "activeDirectory" : {
      "adminPassword" : "string",
      "adminUsername" : "string",
      "domainControllers" : [ {
        "fqdn" : "string",
        "ipAddress" : "string",
        "sslThumbprint" : "string",
        "state" : "NEW"
      } ],
      "fqdn" : "string",
      "netBiosName" : "string",
      "ouRwPassword" : "string",
      "ouRwUsername" : "string",
      "securedAD" : true,
      "vdiAdminPassword" : "string",
      "vdiAdminUsername" : "string",
      "vdiServerOu" : "string"
    },
    "installDetails" : {
      "appVolumesServerBinaryPath" : "string",
      "appVolumesServerVersion" : "string",
      "composerServerBinaryPath" : "string",
      "composerServerVersion" : "string",
      "connectionServerBinaryPath" : "string",
      "connectionServerVersion" : "string",
      "dotNet462BinaryPath" : "string",
      "imagePath" : "string",
      "ova" : {
        "administratorPassword" : "string",
        "administratorUsername" : "string"
      },
      "sqlExpressPath" : "string",
      "sqlExpressVersion" : "string",
      "uagOvaPath" : "string",
      "uagOvaVersion" : "string",
      "uemBinaryPath" : "string",
      "uemVersion" : "string",
      "updateKb2919355BinaryPath" : "string",
      "updateKb2919442BinaryPath" : "string"
    },
    "loadBalancers" : [ {
      "certificatePassword" : "string",
      "certificatePath" : "string",
      "deployDetails" : {
        "cliPassword" : "string",
        "gateway" : "string",
        "portgroup" : "string",
        "subnetMask" : "string",
        "vmName" : "string"
      },
      "fqdn" : "string",
      "ipAddress" : "string",
      "state" : "NEW"
    } ],
    "sqlConnections" : [ {
      "dbPassword" : "string",
      "dbUsername" : "string",
      "fqdn" : "string",
      "id" : "string",
      "sqlInstanceName" : "string",
      "sqlPort" : 0,
      "state" : "NEW"
    } ]
  },
  "resourceVcenters" : [ {
    "datacenters" : [ {
      "clusters" : [ {
        "hosts" : [ {
          "fqdn" : "string",
          "id" : "string",
          "password" : "string",
          "username" : "string"
        } ],
        "name" : "string"
      } ],
      "datastores" : [ {
        "hostIds" : [ "string" ],
        "id" : "string",
        "name" : "string"
      } ],
      "name" : "string"
    } ],
    "host" : "string",
    "password" : "string",
    "psc" : {
      "host" : "string"
    },
    "state" : "NEW",
    "username" : "string"
  } ]
}

3.44.8. Example HTTP response

Response 200
{
  "completionTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "creationTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "errors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "id" : "string",
  "isCancellable" : true,
  "name" : "string",
  "resources" : [ {
    "fqdn" : "string",
    "name" : "string",
    "resourceId" : "string",
    "type" : "string"
  } ],
  "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
  "subTasks" : [ {
    "completionTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "creationTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "description" : "string",
    "errors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "name" : "string",
    "resources" : [ {
      "fqdn" : "string",
      "name" : "string",
      "resourceId" : "string",
      "type" : "string"
    } ],
    "stages" : [ {
      "completionTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "creationTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "description" : "string",
      "name" : "string",
      "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
      "type" : "string"
    } ],
    "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
    "type" : "string"
  } ],
  "type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}
Response 202
{
  "completionTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "creationTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "errors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "id" : "string",
  "isCancellable" : true,
  "name" : "string",
  "resources" : [ {
    "fqdn" : "string",
    "name" : "string",
    "resourceId" : "string",
    "type" : "string"
  } ],
  "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
  "subTasks" : [ {
    "completionTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "creationTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "description" : "string",
    "errors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "name" : "string",
    "resources" : [ {
      "fqdn" : "string",
      "name" : "string",
      "resourceId" : "string",
      "type" : "string"
    } ],
    "stages" : [ {
      "completionTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "creationTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "description" : "string",
      "name" : "string",
      "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
      "type" : "string"
    } ],
    "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
    "type" : "string"
  } ],
  "type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}
Response 400
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 409
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 500
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.45. Delete Horizon Suite

DELETE /v1/horizons/{id}

3.45.1. Parameters

Type Name Description Schema

Path

id
required

Horizon ID

string

3.45.2. Responses

HTTP Code Description Schema

200

OK

Task

202

Accepted

Task

400

Bad Request

Error

404

Not Found

Error

409

Conflict

Error

500

Internal server error

Error

3.45.3. Consumes

  • application/json

3.45.4. Produces

  • application/json

3.45.5. Tags

  • HorizonManager

3.45.6. Security

Type Name

basic

basicAuth

3.45.7. Example HTTP request

Request path
/v1/horizons/string

3.45.8. Example HTTP response

Response 200
{
  "completionTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "creationTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "errors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "id" : "string",
  "isCancellable" : true,
  "name" : "string",
  "resources" : [ {
    "fqdn" : "string",
    "name" : "string",
    "resourceId" : "string",
    "type" : "string"
  } ],
  "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
  "subTasks" : [ {
    "completionTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "creationTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "description" : "string",
    "errors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "name" : "string",
    "resources" : [ {
      "fqdn" : "string",
      "name" : "string",
      "resourceId" : "string",
      "type" : "string"
    } ],
    "stages" : [ {
      "completionTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "creationTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "description" : "string",
      "name" : "string",
      "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
      "type" : "string"
    } ],
    "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
    "type" : "string"
  } ],
  "type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}
Response 202
{
  "completionTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "creationTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "errors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "id" : "string",
  "isCancellable" : true,
  "name" : "string",
  "resources" : [ {
    "fqdn" : "string",
    "name" : "string",
    "resourceId" : "string",
    "type" : "string"
  } ],
  "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
  "subTasks" : [ {
    "completionTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "creationTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "description" : "string",
    "errors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "name" : "string",
    "resources" : [ {
      "fqdn" : "string",
      "name" : "string",
      "resourceId" : "string",
      "type" : "string"
    } ],
    "stages" : [ {
      "completionTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "creationTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "description" : "string",
      "name" : "string",
      "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
      "type" : "string"
    } ],
    "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
    "type" : "string"
  } ],
  "type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}
Response 400
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 404
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 409
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 500
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.46. Initialize Horizon Suite deletion

PATCH /v1/horizons/{id}

3.46.1. Parameters

Type Name Description Schema

Path

id
required

Horizon ID

string

Body

horizonUpdateSpec
required

horizonUpdateSpec

HorizonUpdateSpec

3.46.2. Responses

HTTP Code Description Schema

200

Ok

No Content

400

Bad Request

Error

409

Conflict

Error

500

Internal server error

Error

3.46.3. Consumes

  • application/json

3.46.4. Produces

  • application/json

3.46.5. Tags

  • HorizonManager

3.46.6. Security

Type Name

basic

basicAuth

3.46.7. Example HTTP request

Request path
/v1/horizons/string
Request body
{
  "markForDeletion" : true
}

3.46.8. Example HTTP response

Response 400
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 409
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 500
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.47. Validates Horizon configuration

POST /v1/horizons/{id}/validations

3.47.1. Parameters

Type Name Description Schema

Path

id
required

Horizon ID

string

Body

horizonValidationSpec
required

Validation specification

HorizonValidationSpec

3.47.2. Responses

HTTP Code Description Schema

200

OK

Validation

202

Accepted

Validation

400

Bad Request

Error

409

Conflict

Error

500

Internal server error

Error

3.47.3. Consumes

  • application/json

3.47.4. Produces

  • application/json

3.47.5. Tags

  • HorizonManager

3.47.6. Security

Type Name

basic

basicAuth

3.47.7. Example HTTP request

Request path
/v1/horizons/string/validations
Request body
{
  "horizon" : {
    "appVolumesDetails" : {
      "adminGroupName" : "string",
      "appVolumes" : [ {
        "deployDetails" : {
          "computerName" : "string",
          "gateway" : "string",
          "ipAddress" : "string",
          "subnetMask" : "string",
          "vmName" : "string"
        },
        "fqdn" : "string",
        "state" : "NEW"
      } ],
      "datastores" : [ {
        "id" : "string",
        "isPrimary" : true
      } ],
      "dbName" : "string",
      "lbFqdn" : "string",
      "license" : "string",
      "sqlId" : "string"
    },
    "horizon" : {
      "adminGroupName" : "string",
      "externalLbFqdn" : "string",
      "internalLbFqdn" : "string",
      "license" : "string",
      "pods" : [ {
        "composerServers" : [ {
          "certificatePassword" : "string",
          "certificatePath" : "string",
          "composerServiceAccount" : "string",
          "composerServicePassword" : "string",
          "dbName" : "string",
          "deployDetails" : {
            "computerName" : "string",
            "gateway" : "string",
            "ipAddress" : "string",
            "subnetMask" : "string",
            "vmName" : "string"
          },
          "fqdn" : "string",
          "internalDbPassword" : "string",
          "internalDbUsername" : "string",
          "sqlId" : "string",
          "state" : "NEW",
          "vcFqdn" : "string"
        } ],
        "connectionServers" : [ {
          "certificatePassword" : "string",
          "certificatePath" : "string",
          "deployDetails" : {
            "computerName" : "string",
            "gateway" : "string",
            "ipAddress" : "string",
            "subnetMask" : "string",
            "vmName" : "string"
          },
          "fqdn" : "string",
          "state" : "NEW"
        } ],
        "eventDbName" : "string",
        "sqlId" : "string",
        "uagAppliances" : [ {
          "administratorPassword" : "string",
          "defaultGateway" : "string",
          "externalIpAddress" : "string",
          "externalSubnetMask" : "string",
          "internalIpAddress" : "string",
          "internalSubnetMask" : "string",
          "mgmtIpAddress" : "string",
          "mgmtSubnetMask" : "string",
          "state" : "NEW",
          "vmName" : "string"
        } ],
        "vcFqdns" : [ "string" ]
      } ],
      "uemDetails" : {
        "license" : "string",
        "uems" : [ {
          "configurationShare" : "string",
          "deployDetails" : {
            "computerName" : "string",
            "configurationShareLocation" : "string",
            "dataDriveSizeGb" : 0,
            "gateway" : "string",
            "ipAddress" : "string",
            "profileArchiveShareLocation" : "string",
            "subnetMask" : "string",
            "vmName" : "string"
          },
          "fqdn" : "string",
          "profileArchiveShare" : "string",
          "state" : "NEW"
        } ]
      }
    },
    "id" : "string",
    "managementVcenters" : [ {
      "clusterName" : "string",
      "datacenterName" : "string",
      "datastoreName" : "string",
      "dmzPortgroup" : "string",
      "host" : "string",
      "interconnectPortgroup" : "string",
      "managementPortgroup" : "string",
      "nsx" : {
        "host" : "string",
        "password" : "string"
      },
      "password" : "string",
      "psc" : {
        "host" : "string"
      },
      "uagManagementPortgroup" : "string",
      "username" : "string"
    } ],
    "name" : "string",
    "peripheralServices" : {
      "activeDirectory" : {
        "adminPassword" : "string",
        "adminUsername" : "string",
        "domainControllers" : [ {
          "fqdn" : "string",
          "ipAddress" : "string",
          "sslThumbprint" : "string",
          "state" : "NEW"
        } ],
        "fqdn" : "string",
        "netBiosName" : "string",
        "ouRwPassword" : "string",
        "ouRwUsername" : "string",
        "securedAD" : true,
        "vdiAdminPassword" : "string",
        "vdiAdminUsername" : "string",
        "vdiServerOu" : "string"
      },
      "installDetails" : {
        "appVolumesServerBinaryPath" : "string",
        "appVolumesServerVersion" : "string",
        "composerServerBinaryPath" : "string",
        "composerServerVersion" : "string",
        "connectionServerBinaryPath" : "string",
        "connectionServerVersion" : "string",
        "dotNet462BinaryPath" : "string",
        "imagePath" : "string",
        "ova" : {
          "administratorPassword" : "string",
          "administratorUsername" : "string"
        },
        "sqlExpressPath" : "string",
        "sqlExpressVersion" : "string",
        "uagOvaPath" : "string",
        "uagOvaVersion" : "string",
        "uemBinaryPath" : "string",
        "uemVersion" : "string",
        "updateKb2919355BinaryPath" : "string",
        "updateKb2919442BinaryPath" : "string"
      },
      "loadBalancers" : [ {
        "certificatePassword" : "string",
        "certificatePath" : "string",
        "deployDetails" : {
          "cliPassword" : "string",
          "gateway" : "string",
          "portgroup" : "string",
          "subnetMask" : "string",
          "vmName" : "string"
        },
        "fqdn" : "string",
        "ipAddress" : "string",
        "state" : "NEW"
      } ],
      "sqlConnections" : [ {
        "dbPassword" : "string",
        "dbUsername" : "string",
        "fqdn" : "string",
        "id" : "string",
        "sqlInstanceName" : "string",
        "sqlPort" : 0,
        "state" : "NEW"
      } ]
    },
    "resourceVcenters" : [ {
      "datacenters" : [ {
        "clusters" : [ {
          "hosts" : [ {
            "fqdn" : "string",
            "id" : "string",
            "password" : "string",
            "username" : "string"
          } ],
          "name" : "string"
        } ],
        "datastores" : [ {
          "hostIds" : [ "string" ],
          "id" : "string",
          "name" : "string"
        } ],
        "name" : "string"
      } ],
      "host" : "string",
      "password" : "string",
      "psc" : {
        "host" : "string"
      },
      "state" : "NEW",
      "username" : "string"
    } ]
  },
  "horizonValidationOperation" : {
    "type" : "PRE_VALIDATION_CREATION, PRE_VALIDATION_EXPANSION"
  }
}

3.47.8. Example HTTP response

Response 200
{
  "description" : "string",
  "executionStatus" : "One among: IN_PROGRESS, FAILED, COMPLETED, SKIPPED, CANCELLED",
  "id" : "string",
  "resultStatus" : "One among: SUCCEEDED, FAILED, FAILED_WITH_WARNINGS",
  "validationChecks" : [ {
    "description" : "string",
    "errorResponse" : {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ {
        "arguments" : [ "string" ],
        "causes" : [ {
          "message" : "string",
          "type" : "string"
        } ],
        "context" : {
          "string" : "string"
        },
        "errorCode" : "string",
        "message" : "string",
        "nestedErrors" : [ "..." ],
        "referenceToken" : "string",
        "remediationMessage" : "string"
      } ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    },
    "nestedValidationChecks" : [ {
      "description" : "string",
      "errorResponse" : {
        "arguments" : [ "string" ],
        "causes" : [ {
          "message" : "string",
          "type" : "string"
        } ],
        "context" : {
          "string" : "string"
        },
        "errorCode" : "string",
        "message" : "string",
        "nestedErrors" : [ "..." ],
        "referenceToken" : "string",
        "remediationMessage" : "string"
      },
      "nestedValidationChecks" : [ "..." ],
      "resultStatus" : "One among: SUCCEEDED, FAILED",
      "severity" : "One among: WARNING, ERROR, INFO"
    } ],
    "resultStatus" : "One among: SUCCEEDED, FAILED",
    "severity" : "One among: WARNING, ERROR, INFO"
  } ]
}
Response 202
{
  "description" : "string",
  "executionStatus" : "One among: IN_PROGRESS, FAILED, COMPLETED, SKIPPED, CANCELLED",
  "id" : "string",
  "resultStatus" : "One among: SUCCEEDED, FAILED, FAILED_WITH_WARNINGS",
  "validationChecks" : [ {
    "description" : "string",
    "errorResponse" : {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ {
        "arguments" : [ "string" ],
        "causes" : [ {
          "message" : "string",
          "type" : "string"
        } ],
        "context" : {
          "string" : "string"
        },
        "errorCode" : "string",
        "message" : "string",
        "nestedErrors" : [ "..." ],
        "referenceToken" : "string",
        "remediationMessage" : "string"
      } ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    },
    "nestedValidationChecks" : [ {
      "description" : "string",
      "errorResponse" : {
        "arguments" : [ "string" ],
        "causes" : [ {
          "message" : "string",
          "type" : "string"
        } ],
        "context" : {
          "string" : "string"
        },
        "errorCode" : "string",
        "message" : "string",
        "nestedErrors" : [ "..." ],
        "referenceToken" : "string",
        "remediationMessage" : "string"
      },
      "nestedValidationChecks" : [ "..." ],
      "resultStatus" : "One among: SUCCEEDED, FAILED",
      "severity" : "One among: WARNING, ERROR, INFO"
    } ],
    "resultStatus" : "One among: SUCCEEDED, FAILED",
    "severity" : "One among: WARNING, ERROR, INFO"
  } ]
}
Response 400
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 409
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 500
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.48. Commission the Hosts

POST /v1/hosts

3.48.1. Parameters

Type Name Description Schema

Body

hostCommissionSpecs
required

hostCommissionSpecs

< HostCommissionSpec > array

3.48.2. Responses

HTTP Code Description Schema

200

OK

Task

202

Accepted

Task

400

Bad Request

Error

500

Internal server error

Error

3.48.3. Consumes

  • application/json

3.48.4. Produces

  • application/json

3.48.5. Tags

  • Hosts

3.48.6. Security

Type Name

basic

basicAuth

3.48.7. Example HTTP request

Request path
/v1/hosts
Request body
[ {
  "fqdn" : "string",
  "networkPoolId" : "string",
  "networkPoolName" : "string",
  "password" : "string",
  "storageType" : "One among: VSAN, NFS, VMFS_FC",
  "username" : "string"
} ]

3.48.8. Example HTTP response

Response 200
{
  "completionTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "creationTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "errors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "id" : "string",
  "isCancellable" : true,
  "name" : "string",
  "resources" : [ {
    "fqdn" : "string",
    "name" : "string",
    "resourceId" : "string",
    "type" : "string"
  } ],
  "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
  "subTasks" : [ {
    "completionTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "creationTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "description" : "string",
    "errors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "name" : "string",
    "resources" : [ {
      "fqdn" : "string",
      "name" : "string",
      "resourceId" : "string",
      "type" : "string"
    } ],
    "stages" : [ {
      "completionTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "creationTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "description" : "string",
      "name" : "string",
      "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
      "type" : "string"
    } ],
    "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
    "type" : "string"
  } ],
  "type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}
Response 202
{
  "completionTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "creationTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "errors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "id" : "string",
  "isCancellable" : true,
  "name" : "string",
  "resources" : [ {
    "fqdn" : "string",
    "name" : "string",
    "resourceId" : "string",
    "type" : "string"
  } ],
  "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
  "subTasks" : [ {
    "completionTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "creationTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "description" : "string",
    "errors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "name" : "string",
    "resources" : [ {
      "fqdn" : "string",
      "name" : "string",
      "resourceId" : "string",
      "type" : "string"
    } ],
    "stages" : [ {
      "completionTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "creationTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "description" : "string",
      "name" : "string",
      "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
      "type" : "string"
    } ],
    "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
    "type" : "string"
  } ],
  "type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}
Response 400
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 500
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.49. Get the Hosts

GET /v1/hosts

3.49.1. Parameters

Type Name Description Schema

Query

clusterId
optional

ID of the Cluster

string

Query

datastoreName
optional

Name of the datastore

string

Query

domainId
optional

ID of the Domain

string

Query

networkpoolId
optional

ID of the Network pool

string

Query

status
optional

Status of the Host.One among: ASSIGNED, UNASSIGNED_USEABLE, UNASSIGNED_UNUSEABLE

string

Query

storageType
optional

Type of the Storage.VMFS_FC

string

3.49.2. Responses

HTTP Code Description Schema

200

Ok

PageOfHost

400

Bad Request

Error

500

Internal Server Error

Error

3.49.3. Consumes

  • application/json

3.49.4. Produces

  • application/json

3.49.5. Tags

  • Hosts

3.49.6. Security

Type Name

basic

basicAuth

3.49.7. Example HTTP request

Request path
/v1/hosts

3.49.8. Example HTTP response

Response 200
{
  "elements" : [ {
    "cluster" : {
      "id" : "string"
    },
    "compatibleStorageType" : "string",
    "cpu" : {
      "cores" : 0,
      "cpuCores" : [ {
        "frequencyMHz" : 0.0,
        "manufacturer" : "string",
        "model" : "string"
      } ],
      "frequencyMHz" : 0.0
    },
    "domain" : {
      "id" : "string"
    },
    "esxiVersion" : "string",
    "fqdn" : "string",
    "hardwareModel" : "string",
    "hardwareVendor" : "string",
    "id" : "string",
    "ipAddresses" : [ {
      "ipAddress" : "string",
      "type" : "One among: MANAGEMENT, VSAN, VMOTION, NFS"
    } ],
    "memory" : {
      "totalCapacityMB" : 0.0
    },
    "networkpool" : {
      "id" : "string"
    },
    "physicalNics" : [ {
      "deviceName" : "string",
      "macAddress" : "string"
    } ],
    "status" : "One among: ASSIGNED, UNASSIGNED_USEABLE, UNASSIGNED_UNUSEABLE",
    "storage" : {
      "disks" : [ {
        "capacityMB" : 0.0,
        "diskType" : "One among: HDD, FLASH",
        "manufacturer" : "string",
        "model" : "string"
      } ],
      "totalCapacityMB" : 0.0
    }
  } ]
}
Response 400
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 500
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.50. Decommission the Hosts

DELETE /v1/hosts

3.50.1. Parameters

Type Name Description Schema

Body

hostDecommissionSpecs
required

hostDecommissionSpecs

< HostDecommissionSpec > array

3.50.2. Responses

HTTP Code Description Schema

200

OK

Task

202

Accepted

Task

400

Bad Request

Error

500

Internal server error

No Content

3.50.3. Consumes

  • application/json

3.50.4. Produces

  • application/json

3.50.5. Tags

  • Hosts

3.50.6. Security

Type Name

basic

basicAuth

3.50.7. Example HTTP request

Request path
/v1/hosts
Request body
[ {
  "fqdn" : "string"
} ]

3.50.8. Example HTTP response

Response 200
{
  "completionTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "creationTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "errors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "id" : "string",
  "isCancellable" : true,
  "name" : "string",
  "resources" : [ {
    "fqdn" : "string",
    "name" : "string",
    "resourceId" : "string",
    "type" : "string"
  } ],
  "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
  "subTasks" : [ {
    "completionTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "creationTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "description" : "string",
    "errors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "name" : "string",
    "resources" : [ {
      "fqdn" : "string",
      "name" : "string",
      "resourceId" : "string",
      "type" : "string"
    } ],
    "stages" : [ {
      "completionTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "creationTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "description" : "string",
      "name" : "string",
      "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
      "type" : "string"
    } ],
    "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
    "type" : "string"
  } ],
  "type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}
Response 202
{
  "completionTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "creationTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "errors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "id" : "string",
  "isCancellable" : true,
  "name" : "string",
  "resources" : [ {
    "fqdn" : "string",
    "name" : "string",
    "resourceId" : "string",
    "type" : "string"
  } ],
  "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
  "subTasks" : [ {
    "completionTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "creationTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "description" : "string",
    "errors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "name" : "string",
    "resources" : [ {
      "fqdn" : "string",
      "name" : "string",
      "resourceId" : "string",
      "type" : "string"
    } ],
    "stages" : [ {
      "completionTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "creationTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "description" : "string",
      "name" : "string",
      "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
      "type" : "string"
    } ],
    "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
    "type" : "string"
  } ],
  "type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}
Response 400
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.51. Validate the input spec for hosts operations

POST /v1/hosts/validations

3.51.1. Parameters

Type Name Description Schema

Body

hostsOperationSpecValidation
required

hostsOperationSpecValidation

HostsOperationSpecValidation

3.51.2. Responses

HTTP Code Description Schema

200

OK

Validation

202

Accepted

Validation

400

Bad Request

Error

500

Internal server error

No Content

3.51.3. Consumes

  • application/json

3.51.4. Produces

  • application/json

3.51.5. Tags

  • Hosts

3.51.6. Security

Type Name

basic

basicAuth

3.51.7. Example HTTP request

Request path
/v1/hosts/validations
Request body
{
  "hostCommissionSpecs" : [ {
    "fqdn" : "string",
    "networkPoolId" : "string",
    "networkPoolName" : "string",
    "password" : "string",
    "storageType" : "One among: VSAN, NFS, VMFS_FC",
    "username" : "string"
  } ]
}

3.51.8. Example HTTP response

Response 200
{
  "description" : "string",
  "executionStatus" : "One among: IN_PROGRESS, FAILED, COMPLETED, SKIPPED, CANCELLED",
  "id" : "string",
  "resultStatus" : "One among: SUCCEEDED, FAILED, FAILED_WITH_WARNINGS",
  "validationChecks" : [ {
    "description" : "string",
    "errorResponse" : {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ {
        "arguments" : [ "string" ],
        "causes" : [ {
          "message" : "string",
          "type" : "string"
        } ],
        "context" : {
          "string" : "string"
        },
        "errorCode" : "string",
        "message" : "string",
        "nestedErrors" : [ "..." ],
        "referenceToken" : "string",
        "remediationMessage" : "string"
      } ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    },
    "nestedValidationChecks" : [ {
      "description" : "string",
      "errorResponse" : {
        "arguments" : [ "string" ],
        "causes" : [ {
          "message" : "string",
          "type" : "string"
        } ],
        "context" : {
          "string" : "string"
        },
        "errorCode" : "string",
        "message" : "string",
        "nestedErrors" : [ "..." ],
        "referenceToken" : "string",
        "remediationMessage" : "string"
      },
      "nestedValidationChecks" : [ "..." ],
      "resultStatus" : "One among: SUCCEEDED, FAILED",
      "severity" : "One among: WARNING, ERROR, INFO"
    } ],
    "resultStatus" : "One among: SUCCEEDED, FAILED",
    "severity" : "One among: WARNING, ERROR, INFO"
  } ]
}
Response 202
{
  "description" : "string",
  "executionStatus" : "One among: IN_PROGRESS, FAILED, COMPLETED, SKIPPED, CANCELLED",
  "id" : "string",
  "resultStatus" : "One among: SUCCEEDED, FAILED, FAILED_WITH_WARNINGS",
  "validationChecks" : [ {
    "description" : "string",
    "errorResponse" : {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ {
        "arguments" : [ "string" ],
        "causes" : [ {
          "message" : "string",
          "type" : "string"
        } ],
        "context" : {
          "string" : "string"
        },
        "errorCode" : "string",
        "message" : "string",
        "nestedErrors" : [ "..." ],
        "referenceToken" : "string",
        "remediationMessage" : "string"
      } ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    },
    "nestedValidationChecks" : [ {
      "description" : "string",
      "errorResponse" : {
        "arguments" : [ "string" ],
        "causes" : [ {
          "message" : "string",
          "type" : "string"
        } ],
        "context" : {
          "string" : "string"
        },
        "errorCode" : "string",
        "message" : "string",
        "nestedErrors" : [ "..." ],
        "referenceToken" : "string",
        "remediationMessage" : "string"
      },
      "nestedValidationChecks" : [ "..." ],
      "resultStatus" : "One among: SUCCEEDED, FAILED",
      "severity" : "One among: WARNING, ERROR, INFO"
    } ],
    "resultStatus" : "One among: SUCCEEDED, FAILED",
    "severity" : "One among: WARNING, ERROR, INFO"
  } ]
}
Response 400
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.52. Get the status of the validation of the input specification to commission the Hosts

GET /v1/hosts/validations/{id}

3.52.1. Parameters

Type Name Description Schema

Path

id
required

The validation ID

string

3.52.2. Responses

HTTP Code Description Schema

200

OK

Validation

400

Bad Request

Error

500

Internal server error

No Content

3.52.3. Consumes

  • application/json

3.52.4. Produces

  • application/json

3.52.5. Tags

  • Hosts

3.52.6. Security

Type Name

basic

basicAuth

3.52.7. Example HTTP request

Request path
/v1/hosts/validations/string

3.52.8. Example HTTP response

Response 200
{
  "description" : "string",
  "executionStatus" : "One among: IN_PROGRESS, FAILED, COMPLETED, SKIPPED, CANCELLED",
  "id" : "string",
  "resultStatus" : "One among: SUCCEEDED, FAILED, FAILED_WITH_WARNINGS",
  "validationChecks" : [ {
    "description" : "string",
    "errorResponse" : {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ {
        "arguments" : [ "string" ],
        "causes" : [ {
          "message" : "string",
          "type" : "string"
        } ],
        "context" : {
          "string" : "string"
        },
        "errorCode" : "string",
        "message" : "string",
        "nestedErrors" : [ "..." ],
        "referenceToken" : "string",
        "remediationMessage" : "string"
      } ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    },
    "nestedValidationChecks" : [ {
      "description" : "string",
      "errorResponse" : {
        "arguments" : [ "string" ],
        "causes" : [ {
          "message" : "string",
          "type" : "string"
        } ],
        "context" : {
          "string" : "string"
        },
        "errorCode" : "string",
        "message" : "string",
        "nestedErrors" : [ "..." ],
        "referenceToken" : "string",
        "remediationMessage" : "string"
      },
      "nestedValidationChecks" : [ "..." ],
      "resultStatus" : "One among: SUCCEEDED, FAILED",
      "severity" : "One among: WARNING, ERROR, INFO"
    } ],
    "resultStatus" : "One among: SUCCEEDED, FAILED",
    "severity" : "One among: WARNING, ERROR, INFO"
  } ]
}
Response 400
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.53. Get a Host

GET /v1/hosts/{id}

3.53.1. Parameters

Type Name Description Schema

Path

id
required

id

string

3.53.2. Responses

HTTP Code Description Schema

200

Ok

Host

400

Bad Request

Error

404

Host Not Found

Error

500

Internal Server Error

Error

3.53.3. Consumes

  • application/json

3.53.4. Produces

  • application/json

3.53.5. Tags

  • Hosts

3.53.6. Security

Type Name

basic

basicAuth

3.53.7. Example HTTP request

Request path
/v1/hosts/string

3.53.8. Example HTTP response

Response 200
{
  "cluster" : {
    "id" : "string"
  },
  "compatibleStorageType" : "string",
  "cpu" : {
    "cores" : 0,
    "cpuCores" : [ {
      "frequencyMHz" : 0.0,
      "manufacturer" : "string",
      "model" : "string"
    } ],
    "frequencyMHz" : 0.0
  },
  "domain" : {
    "id" : "string"
  },
  "esxiVersion" : "string",
  "fqdn" : "string",
  "hardwareModel" : "string",
  "hardwareVendor" : "string",
  "id" : "string",
  "ipAddresses" : [ {
    "ipAddress" : "string",
    "type" : "One among: MANAGEMENT, VSAN, VMOTION, NFS"
  } ],
  "memory" : {
    "totalCapacityMB" : 0.0
  },
  "networkpool" : {
    "id" : "string"
  },
  "physicalNics" : [ {
    "deviceName" : "string",
    "macAddress" : "string"
  } ],
  "status" : "One among: ASSIGNED, UNASSIGNED_USEABLE, UNASSIGNED_UNUSEABLE",
  "storage" : {
    "disks" : [ {
      "capacityMB" : 0.0,
      "diskType" : "One among: HDD, FLASH",
      "manufacturer" : "string",
      "model" : "string"
    } ],
    "totalCapacityMB" : 0.0
  }
}
Response 400
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 404
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 500
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.54. Add a License Key

POST /v1/license-keys

3.54.1. Parameters

Type Name Description Schema

Body

licenseKey
required

License key with other attributes

LicenseKey

3.54.2. Responses

HTTP Code Description Schema

200

OK

LicenseKey

201

Created

LicenseKey

500

Internal server error

Error

3.54.3. Consumes

  • application/json

3.54.4. Produces

  • */*

3.54.5. Tags

  • License Keys

3.54.6. Security

Type Name

basic

basicAuth

3.54.7. Example HTTP request

Request path
/v1/license-keys
Request body
{
  "description" : "string",
  "id" : "string",
  "isUnlimited" : true,
  "key" : "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
  "licenseKeyUsage" : {
    "licenseUnit" : "One among: CPUPACKAGE, INSTANCE, VMS, CCU, PLU, DESKTOPVM, SERVERVM, VM, SERVER, CORES, CONCURRENTUSER, NAMEDUSER",
    "remaining" : 0,
    "total" : 0,
    "used" : 0
  },
  "licenseKeyValidity" : {
    "expiryDate" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "licenseKeyStatus" : "One among: EXPIRED, ACTIVE, NEVER_EXPIRES"
  },
  "productType" : "One among: VCENTER, VSAN, NSXV, SDDC_MANAGER, ESXI, VRA, VROPS, NSXT"
}

3.54.8. Example HTTP response

Response 200
{
  "description" : "string",
  "id" : "string",
  "isUnlimited" : true,
  "key" : "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
  "licenseKeyUsage" : {
    "licenseUnit" : "One among: CPUPACKAGE, INSTANCE, VMS, CCU, PLU, DESKTOPVM, SERVERVM, VM, SERVER, CORES, CONCURRENTUSER, NAMEDUSER",
    "remaining" : 0,
    "total" : 0,
    "used" : 0
  },
  "licenseKeyValidity" : {
    "expiryDate" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "licenseKeyStatus" : "One among: EXPIRED, ACTIVE, NEVER_EXPIRES"
  },
  "productType" : "One among: VCENTER, VSAN, NSXV, SDDC_MANAGER, ESXI, VRA, VROPS, NSXT"
}
Response 201
{
  "description" : "string",
  "id" : "string",
  "isUnlimited" : true,
  "key" : "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
  "licenseKeyUsage" : {
    "licenseUnit" : "One among: CPUPACKAGE, INSTANCE, VMS, CCU, PLU, DESKTOPVM, SERVERVM, VM, SERVER, CORES, CONCURRENTUSER, NAMEDUSER",
    "remaining" : 0,
    "total" : 0,
    "used" : 0
  },
  "licenseKeyValidity" : {
    "expiryDate" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "licenseKeyStatus" : "One among: EXPIRED, ACTIVE, NEVER_EXPIRES"
  },
  "productType" : "One among: VCENTER, VSAN, NSXV, SDDC_MANAGER, ESXI, VRA, VROPS, NSXT"
}
Response 500
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.55. Get the License Keys

GET /v1/license-keys

3.55.1. Parameters

Type Name Description Schema

Query

licenseKeyStatus
optional

Status of a License Key

< string > array(multi)

Query

productType
optional

Type of a Product

< string > array(multi)

3.55.2. Responses

HTTP Code Description Schema

200

Successful

PageOfLicenseKey

500

Internal server error

Error

3.55.3. Consumes

  • application/json

3.55.4. Produces

  • */*

3.55.5. Tags

  • License Keys

3.55.6. Security

Type Name

basic

basicAuth

3.55.7. Example HTTP request

Request path
/v1/license-keys

3.55.8. Example HTTP response

Response 200
{
  "elements" : [ {
    "description" : "string",
    "id" : "string",
    "isUnlimited" : true,
    "key" : "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
    "licenseKeyUsage" : {
      "licenseUnit" : "One among: CPUPACKAGE, INSTANCE, VMS, CCU, PLU, DESKTOPVM, SERVERVM, VM, SERVER, CORES, CONCURRENTUSER, NAMEDUSER",
      "remaining" : 0,
      "total" : 0,
      "used" : 0
    },
    "licenseKeyValidity" : {
      "expiryDate" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "licenseKeyStatus" : "One among: EXPIRED, ACTIVE, NEVER_EXPIRES"
    },
    "productType" : "One among: VCENTER, VSAN, NSXV, SDDC_MANAGER, ESXI, VRA, VROPS, NSXT"
  } ]
}
Response 500
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.56. Get a License Key by key

GET /v1/license-keys/{key}

3.56.1. Parameters

Type Name Description Schema

Path

key
required

The 29 alpha numeric character license key with hyphens

string

3.56.2. Responses

HTTP Code Description Schema

200

Successful

LicenseKey

404

License key not found

Error

500

Internal server error

Error

3.56.3. Consumes

  • application/json

3.56.4. Produces

  • */*

3.56.5. Tags

  • License Keys

3.56.6. Security

Type Name

basic

basicAuth

3.56.7. Example HTTP request

Request path
/v1/license-keys/string

3.56.8. Example HTTP response

Response 200
{
  "description" : "string",
  "id" : "string",
  "isUnlimited" : true,
  "key" : "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
  "licenseKeyUsage" : {
    "licenseUnit" : "One among: CPUPACKAGE, INSTANCE, VMS, CCU, PLU, DESKTOPVM, SERVERVM, VM, SERVER, CORES, CONCURRENTUSER, NAMEDUSER",
    "remaining" : 0,
    "total" : 0,
    "used" : 0
  },
  "licenseKeyValidity" : {
    "expiryDate" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "licenseKeyStatus" : "One among: EXPIRED, ACTIVE, NEVER_EXPIRES"
  },
  "productType" : "One among: VCENTER, VSAN, NSXV, SDDC_MANAGER, ESXI, VRA, VROPS, NSXT"
}
Response 404
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 500
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.57. Delete a License Key

DELETE /v1/license-keys/{key}

3.57.1. Parameters

Type Name Description Schema

Path

key
required

The 29 alpha numeric character license key with hyphens

string

3.57.2. Responses

HTTP Code Description Schema

200

OK

No Content

204

No content

No Content

404

License key not found

No Content

500

Internal server error

Error

3.57.3. Consumes

  • application/json

3.57.4. Produces

  • */*

3.57.5. Tags

  • License Keys

3.57.6. Security

Type Name

basic

basicAuth

3.57.7. Example HTTP request

Request path
/v1/license-keys/string

3.57.8. Example HTTP response

Response 500
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.58. Create a Network Pool

POST /v1/network-pools

3.58.1. Description

Create a Network Pool

3.58.2. Parameters

Type Name Description Schema

Body

networkPool
required

Specification of the Network pool to create

NetworkPool

3.58.3. Responses

HTTP Code Description Schema

200

OK

NetworkPool

201

The newly created network pool

NetworkPool

400

Errors due to network pool validations failures

Error

500

Unexpected error

Error

3.58.4. Consumes

  • application/json

3.58.5. Produces

  • application/json

3.58.6. Tags

  • Network Pools

3.58.7. Security

Type Name

basic

basicAuth

3.58.8. Example HTTP request

Request path
/v1/network-pools
Request body
{
  "id" : "string",
  "name" : "string",
  "networks" : [ {
    "freeIps" : [ "string" ],
    "gateway" : "string",
    "id" : "string",
    "ipPools" : [ {
      "end" : "string",
      "start" : "string"
    } ],
    "mask" : "string",
    "mtu" : 0,
    "subnet" : "string",
    "type" : "string",
    "usedIps" : [ "string" ],
    "vlanId" : 0
  } ]
}

3.58.9. Example HTTP response

Response 200
{
  "id" : "string",
  "name" : "string",
  "networks" : [ {
    "freeIps" : [ "string" ],
    "gateway" : "string",
    "id" : "string",
    "ipPools" : [ {
      "end" : "string",
      "start" : "string"
    } ],
    "mask" : "string",
    "mtu" : 0,
    "subnet" : "string",
    "type" : "string",
    "usedIps" : [ "string" ],
    "vlanId" : 0
  } ]
}
Response 201
{
  "id" : "string",
  "name" : "string",
  "networks" : [ {
    "freeIps" : [ "string" ],
    "gateway" : "string",
    "id" : "string",
    "ipPools" : [ {
      "end" : "string",
      "start" : "string"
    } ],
    "mask" : "string",
    "mtu" : 0,
    "subnet" : "string",
    "type" : "string",
    "usedIps" : [ "string" ],
    "vlanId" : 0
  } ]
}
Response 400
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 500
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.59. Get the Network Pools

GET /v1/network-pools

3.59.1. Description

Get the Network Pools

3.59.2. Responses

HTTP Code Description Schema

200

Referenced network pool

PageOfNetworkPool

404

Referenced network pool not found

Error

500

Unexpected error

Error

3.59.3. Consumes

  • application/json

3.59.4. Produces

  • application/json

3.59.5. Tags

  • Network Pools

3.59.6. Security

Type Name

basic

basicAuth

3.59.7. Example HTTP request

Request path
/v1/network-pools

3.59.8. Example HTTP response

Response 200
{
  "elements" : [ {
    "id" : "string",
    "name" : "string",
    "networks" : [ {
      "freeIps" : [ "string" ],
      "gateway" : "string",
      "id" : "string",
      "ipPools" : [ {
        "end" : "string",
        "start" : "string"
      } ],
      "mask" : "string",
      "mtu" : 0,
      "subnet" : "string",
      "type" : "string",
      "usedIps" : [ "string" ],
      "vlanId" : 0
    } ]
  } ]
}
Response 404
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 500
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.60. Get a Network Pool

GET /v1/network-pools/{id}

3.60.1. Description

Get a Network Pool by ID, if it exists

3.60.2. Parameters

Type Name Description Schema

Path

id
required

ID of the network pool to fetch

string

3.60.3. Responses

HTTP Code Description Schema

200

Referenced network pool

NetworkPool

404

Referenced network pool not found

Error

500

Unexpected error

Error

3.60.4. Consumes

  • application/json

3.60.5. Produces

  • application/json

3.60.6. Tags

  • Network Pools

3.60.7. Security

Type Name

basic

basicAuth

3.60.8. Example HTTP request

Request path
/v1/network-pools/string

3.60.9. Example HTTP response

Response 200
{
  "id" : "string",
  "name" : "string",
  "networks" : [ {
    "freeIps" : [ "string" ],
    "gateway" : "string",
    "id" : "string",
    "ipPools" : [ {
      "end" : "string",
      "start" : "string"
    } ],
    "mask" : "string",
    "mtu" : 0,
    "subnet" : "string",
    "type" : "string",
    "usedIps" : [ "string" ],
    "vlanId" : 0
  } ]
}
Response 404
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 500
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.61. Delete a Network Pool

DELETE /v1/network-pools/{id}

3.61.1. Description

Delete the Network Pool by the ID, if it exists and is unused

3.61.2. Parameters

Type Name Description Schema

Path

id
required

ID of the network pool

string

3.61.3. Responses

HTTP Code Description Schema

200

OK

No Content

204

The specification of the deleted network pool

No Content

400

Hosts are still associated with NetworkPool

Error

404

Referenced network pool not found

Error

500

Unexpected error

Error

3.61.4. Consumes

  • application/json

3.61.5. Produces

  • */*

3.61.6. Tags

  • Network Pools

3.61.7. Security

Type Name

basic

basicAuth

3.61.8. Example HTTP request

Request path
/v1/network-pools/string

3.61.9. Example HTTP response

Response 400
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 404
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 500
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.62. Get the Networks of a Network Pool

GET /v1/network-pools/{id}/networks

3.62.1. Description

Get the Networks that are part of a Network Pool

3.62.2. Parameters

Type Name Description Schema

Path

id
required

ID for Networkpool to get the networks from

string

3.62.3. Responses

HTTP Code Description Schema

200

Networks for referenced network pool

PageOfNetwork

404

Network pool not found

Error

500

Unexpected error

Error

3.62.4. Consumes

  • application/json

3.62.5. Produces

  • application/json

3.62.6. Tags

  • Network Pools

3.62.7. Security

Type Name

basic

basicAuth

3.62.8. Example HTTP request

Request path
/v1/network-pools/string/networks

3.62.9. Example HTTP response

Response 200
{
  "elements" : [ {
    "freeIps" : [ "string" ],
    "gateway" : "string",
    "id" : "string",
    "ipPools" : [ {
      "end" : "string",
      "start" : "string"
    } ],
    "mask" : "string",
    "mtu" : 0,
    "subnet" : "string",
    "type" : "string",
    "usedIps" : [ "string" ],
    "vlanId" : 0
  } ]
}
Response 404
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 500
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.63. Get a Network of a Network Pool

GET /v1/network-pools/{id}/networks/{networkId}

3.63.1. Description

Get a Network that is part of a Network Pool

3.63.2. Parameters

Type Name Description Schema

Path

id
required

Id of the Network pool

string

Path

networkId
required

Id of the Network

string

3.63.3. Responses

HTTP Code Description Schema

200

Network for referenced network pool

Network

404

Networkpool not found

Error

500

Unexpected error

Error

3.63.4. Consumes

  • application/json

3.63.5. Produces

  • application/json

3.63.6. Tags

  • Network Pools

3.63.7. Security

Type Name

basic

basicAuth

3.63.8. Example HTTP request

Request path
/v1/network-pools/string/networks/string

3.63.9. Example HTTP response

Response 200
{
  "freeIps" : [ "string" ],
  "gateway" : "string",
  "id" : "string",
  "ipPools" : [ {
    "end" : "string",
    "start" : "string"
  } ],
  "mask" : "string",
  "mtu" : 0,
  "subnet" : "string",
  "type" : "string",
  "usedIps" : [ "string" ],
  "vlanId" : 0
}
Response 404
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 500
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.64. Add an IP Pool to a Network of a Network Pool

POST /v1/network-pools/{id}/networks/{networkId}/ip-pools

3.64.1. Description

Add an IP Pool to a Network of a Network Pool

3.64.2. Parameters

Type Name Description Schema

Path

id
required

Id of the networkpoolk

string

Path

networkId
required

Id of the network

string

Body

ipPool
required

ipPool

IpPool

3.64.3. Responses

HTTP Code Description Schema

200

Add the IP Pool associated with a Network of a Network Pool

Network

400

IP range validation failed error

Error

404

Either Network Pool ID or Network ID not found

Error

500

Unexpected error

Error

3.64.4. Consumes

  • application/json

3.64.5. Produces

  • application/json

3.64.6. Tags

  • Network Pools

3.64.7. Security

Type Name

basic

basicAuth

3.64.8. Example HTTP request

Request path
/v1/network-pools/string/networks/string/ip-pools
Request body
{
  "end" : "string",
  "start" : "string"
}

3.64.9. Example HTTP response

Response 200
{
  "freeIps" : [ "string" ],
  "gateway" : "string",
  "id" : "string",
  "ipPools" : [ {
    "end" : "string",
    "start" : "string"
  } ],
  "mask" : "string",
  "mtu" : 0,
  "subnet" : "string",
  "type" : "string",
  "usedIps" : [ "string" ],
  "vlanId" : 0
}
Response 400
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 404
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 500
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.65. Delete an IP Pool from a Network of a Network Pool

DELETE /v1/network-pools/{id}/networks/{networkId}/ip-pools

3.65.1. Description

Delete an IP Pool from a Network of a Network Pool

3.65.2. Parameters

Type Name Description Schema

Path

id
required

ID of the networkpool

string

Path

networkId
required

ID of the network

string

Body

ipPool
required

ipPool

IpPool

3.65.3. Responses

HTTP Code Description Schema

200

Delete the IP Pool associated with a Network of a Network Pool

No Content

400

Errors due to network/networkpool validations failures

Error

404

Either network or Network pool not found

Error

500

Unexpected error

Error

3.65.4. Consumes

  • application/json

3.65.5. Produces

  • application/json

3.65.6. Tags

  • Network Pools

3.65.7. Security

Type Name

basic

basicAuth

3.65.8. Example HTTP request

Request path
/v1/network-pools/string/networks/string/ip-pools
Request body
{
  "end" : "string",
  "start" : "string"
}

3.65.9. Example HTTP response

Response 400
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 404
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 500
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.66. Get NsxManagers

GET /v1/nsx-managers

3.66.1. Parameters

Type Name Description Schema

Query

domainId
optional

ID of the domain

string

3.66.2. Responses

HTTP Code Description Schema

200

Ok

NsxManager

400

Bad Request

Error

500

InternalServerError

Error

3.66.3. Consumes

  • application/json

3.66.4. Produces

  • application/json

3.66.5. Tags

  • NsxManagers

3.66.6. Security

Type Name

basic

basicAuth

3.66.7. Example HTTP request

Request path
/v1/nsx-managers

3.66.8. Example HTTP response

Response 200
{
  "domain" : {
    "id" : "string"
  },
  "fqdn" : "string",
  "id" : "string",
  "ipAddress" : "string",
  "vcenter" : {
    "fqdn" : "string",
    "id" : "string"
  }
}
Response 400
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 500
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.67. Get a NsxManager

GET /v1/nsx-managers/{id}

3.67.1. Parameters

Type Name Description Schema

Path

id
required

NsxManager ID

string

3.67.2. Responses

HTTP Code Description Schema

200

Ok

NsxManager

404

NsxManager not found

Error

500

InternalServerError

Error

3.67.3. Consumes

  • application/json

3.67.4. Produces

  • application/json

3.67.5. Tags

  • NsxManagers

3.67.6. Security

Type Name

basic

basicAuth

3.67.7. Example HTTP request

Request path
/v1/nsx-managers/string

3.67.8. Example HTTP response

Response 200
{
  "domain" : {
    "id" : "string"
  },
  "fqdn" : "string",
  "id" : "string",
  "ipAddress" : "string",
  "vcenter" : {
    "fqdn" : "string",
    "id" : "string"
  }
}
Response 404
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 500
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.68. Get the NSX-T clusters

GET /v1/nsxt-clusters

3.68.1. Responses

HTTP Code Description Schema

200

Ok

NsxTCluster

400

Bad Request

Error

500

InternalServerError

Error

3.68.2. Consumes

  • application/json

3.68.3. Produces

  • application/json

3.68.4. Tags

  • NSX-T Clusters

3.68.5. Security

Type Name

basic

basicAuth

3.68.6. Example HTTP request

Request path
/v1/nsxt-clusters

3.68.7. Example HTTP response

Response 200
{
  "domains" : [ {
    "id" : "string"
  } ],
  "fqdn" : "string",
  "id" : "string",
  "ipAddress" : "string",
  "nodes" : [ {
    "fqdn" : "string",
    "vmName" : "string"
  } ]
}
Response 400
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 500
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.69. Get a NSX-T cluster

GET /v1/nsxt-clusters/{id}

3.69.1. Parameters

Type Name Description Schema

Path

id
required

NSX-T cluster ID

string

3.69.2. Responses

HTTP Code Description Schema

200

Ok

NsxTCluster

404

NSX-T cluster not found

Error

500

InternalServerError

Error

3.69.3. Consumes

  • application/json

3.69.4. Produces

  • application/json

3.69.5. Tags

  • NSX-T Clusters

3.69.6. Security

Type Name

basic

basicAuth

3.69.7. Example HTTP request

Request path
/v1/nsxt-clusters/string

3.69.8. Example HTTP response

Response 200
{
  "domains" : [ {
    "id" : "string"
  } ],
  "fqdn" : "string",
  "id" : "string",
  "ipAddress" : "string",
  "nodes" : [ {
    "fqdn" : "string",
    "vmName" : "string"
  } ]
}
Response 404
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 500
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.70. Install PKS

POST /v1/pkses

3.70.1. Parameters

Type Name Description Schema

Body

pksInstallationSpec
required

PKS install specification

PksInstallationSpec

3.70.2. Responses

HTTP Code Description Schema

200

OK

Task

202

Accepted

Task

400

Bad Request

Error

500

Internal Server Error

Error

3.70.3. Consumes

  • application/json

3.70.4. Produces

  • application/json

3.70.5. Tags

  • PKS

3.70.6. Security

Type Name

basic

basicAuth

3.70.7. Example HTTP request

Request path
/v1/pkses
Request body
{
  "adminPassword" : "string",
  "availabilityZoneSpec" : {
    "kubernetesNetwork" : {
      "cidr" : "10.255.0.0/24",
      "dnsServer" : "dns.sfo01.rainpole.local",
      "gateway" : "10.255.0.1",
      "reservedRanges" : "10.255.0.1-10.255.0.10",
      "vcenterNetwork" : "string"
    },
    "kubernetesZones" : [ {
      "clusterName" : "string",
      "name" : "string",
      "resourcePoolName" : "string"
    } ],
    "managementNetwork" : {
      "cidr" : "10.255.0.0/24",
      "dnsServer" : "dns.sfo01.rainpole.local",
      "gateway" : "10.255.0.1",
      "reservedRanges" : "10.255.0.1-10.255.0.10",
      "vcenterNetwork" : "string"
    },
    "managementZone" : {
      "clusterName" : "string",
      "name" : "string",
      "resourcePoolName" : "string"
    }
  },
  "certificateBundle" : {
    "harborRsaCert" : {
      "privateKey" : "string",
      "publicCert" : "string"
    },
    "nsxtRsaCert" : {
      "privateKey" : "string",
      "publicCert" : "string"
    },
    "pcfRsaCert" : {
      "privateKey" : "string",
      "publicCert" : "string"
    },
    "pksRsaCert" : {
      "privateKey" : "string",
      "publicCert" : "string"
    },
    "trustedCertificates" : "string"
  },
  "datastore" : "string",
  "decryptionPassphrase" : "string",
  "domainId" : "76df11e9-5c1f-4376-b913-0ea93ebda983",
  "harborHostname" : "harbor.sfo01.rainpole.local",
  "installHarbor" : true,
  "name" : "PKS-1",
  "nsxtItemsSpec" : {
    "floatingIpPoolId" : "ee7d0bc1-0cd3-4c59-8944-65a36fe35cf7",
    "nodesIpBlockId" : "b73446a0-9ffe-4291-b34f-ff0b6ee67ff3",
    "podsIpBlockId" : "6f5db6d2-30f6-47e3-a765-3ebc34390bce",
    "t0routerId" : "bc3fda31-74b9-4759-8e1f-ff72726b8d5d"
  },
  "pksApiHostname" : "pksApi.sfo01.rainpole.local",
  "pksOpsManagerVmSpec" : {
    "appliance" : {
      "hostname" : "pcf.sfo01.rainpole.local",
      "ip" : "10.255.0.10",
      "vmName" : "ops-manager"
    },
    "network" : {
      "dnsServers" : "dns.sfo01.rainpole.local, dns1.sfo01.rainpole.local",
      "dnsSuffix" : "*.sfo01.rainpole.local",
      "gateway" : "10.255.0.1",
      "netmask" : "255.255.255.0",
      "network" : "string",
      "ntpServers" : "ntp.sfo01.rainpole.local, ntp1.sfo01.rainpole.local"
    }
  }
}

3.70.8. Example HTTP response

Response 200
{
  "completionTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "creationTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "errors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "id" : "string",
  "isCancellable" : true,
  "name" : "string",
  "resources" : [ {
    "fqdn" : "string",
    "name" : "string",
    "resourceId" : "string",
    "type" : "string"
  } ],
  "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
  "subTasks" : [ {
    "completionTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "creationTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "description" : "string",
    "errors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "name" : "string",
    "resources" : [ {
      "fqdn" : "string",
      "name" : "string",
      "resourceId" : "string",
      "type" : "string"
    } ],
    "stages" : [ {
      "completionTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "creationTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "description" : "string",
      "name" : "string",
      "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
      "type" : "string"
    } ],
    "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
    "type" : "string"
  } ],
  "type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}
Response 202
{
  "completionTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "creationTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "errors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "id" : "string",
  "isCancellable" : true,
  "name" : "string",
  "resources" : [ {
    "fqdn" : "string",
    "name" : "string",
    "resourceId" : "string",
    "type" : "string"
  } ],
  "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
  "subTasks" : [ {
    "completionTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "creationTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "description" : "string",
    "errors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "name" : "string",
    "resources" : [ {
      "fqdn" : "string",
      "name" : "string",
      "resourceId" : "string",
      "type" : "string"
    } ],
    "stages" : [ {
      "completionTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "creationTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "description" : "string",
      "name" : "string",
      "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
      "type" : "string"
    } ],
    "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
    "type" : "string"
  } ],
  "type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}
Response 400
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 500
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.71. Get a list of installed PKS

GET /v1/pkses

3.71.1. Responses

HTTP Code Description Schema

200

Accepted

Page

400

Bad Request

Error

500

Internal Server Error

Error

3.71.2. Consumes

  • application/json

3.71.3. Produces

  • application/json

3.71.4. Tags

  • PKS

3.71.5. Security

Type Name

basic

basicAuth

3.71.6. Example HTTP request

Request path
/v1/pkses

3.71.7. Example HTTP response

Response 200
{
  "elements" : [ "object" ]
}
Response 400
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 500
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.72. Validate PKS specification before installation

POST /v1/pkses/validations

3.72.1. Parameters

Type Name Description Schema

Body

pksInstallationSpec
required

PKS install specification

PksInstallationSpec

3.72.2. Responses

HTTP Code Description Schema

200

OK

Task

202

Accepted

Task

400

Bad Request

Error

500

Internal Server Error

Error

3.72.3. Consumes

  • application/json

3.72.4. Produces

  • application/json

3.72.5. Tags

  • PKS

3.72.6. Security

Type Name

basic

basicAuth

3.72.7. Example HTTP request

Request path
/v1/pkses/validations
Request body
{
  "adminPassword" : "string",
  "availabilityZoneSpec" : {
    "kubernetesNetwork" : {
      "cidr" : "10.255.0.0/24",
      "dnsServer" : "dns.sfo01.rainpole.local",
      "gateway" : "10.255.0.1",
      "reservedRanges" : "10.255.0.1-10.255.0.10",
      "vcenterNetwork" : "string"
    },
    "kubernetesZones" : [ {
      "clusterName" : "string",
      "name" : "string",
      "resourcePoolName" : "string"
    } ],
    "managementNetwork" : {
      "cidr" : "10.255.0.0/24",
      "dnsServer" : "dns.sfo01.rainpole.local",
      "gateway" : "10.255.0.1",
      "reservedRanges" : "10.255.0.1-10.255.0.10",
      "vcenterNetwork" : "string"
    },
    "managementZone" : {
      "clusterName" : "string",
      "name" : "string",
      "resourcePoolName" : "string"
    }
  },
  "certificateBundle" : {
    "harborRsaCert" : {
      "privateKey" : "string",
      "publicCert" : "string"
    },
    "nsxtRsaCert" : {
      "privateKey" : "string",
      "publicCert" : "string"
    },
    "pcfRsaCert" : {
      "privateKey" : "string",
      "publicCert" : "string"
    },
    "pksRsaCert" : {
      "privateKey" : "string",
      "publicCert" : "string"
    },
    "trustedCertificates" : "string"
  },
  "datastore" : "string",
  "decryptionPassphrase" : "string",
  "domainId" : "76df11e9-5c1f-4376-b913-0ea93ebda983",
  "harborHostname" : "harbor.sfo01.rainpole.local",
  "installHarbor" : true,
  "name" : "PKS-1",
  "nsxtItemsSpec" : {
    "floatingIpPoolId" : "ee7d0bc1-0cd3-4c59-8944-65a36fe35cf7",
    "nodesIpBlockId" : "b73446a0-9ffe-4291-b34f-ff0b6ee67ff3",
    "podsIpBlockId" : "6f5db6d2-30f6-47e3-a765-3ebc34390bce",
    "t0routerId" : "bc3fda31-74b9-4759-8e1f-ff72726b8d5d"
  },
  "pksApiHostname" : "pksApi.sfo01.rainpole.local",
  "pksOpsManagerVmSpec" : {
    "appliance" : {
      "hostname" : "pcf.sfo01.rainpole.local",
      "ip" : "10.255.0.10",
      "vmName" : "ops-manager"
    },
    "network" : {
      "dnsServers" : "dns.sfo01.rainpole.local, dns1.sfo01.rainpole.local",
      "dnsSuffix" : "*.sfo01.rainpole.local",
      "gateway" : "10.255.0.1",
      "netmask" : "255.255.255.0",
      "network" : "string",
      "ntpServers" : "ntp.sfo01.rainpole.local, ntp1.sfo01.rainpole.local"
    }
  }
}

3.72.8. Example HTTP response

Response 200
{
  "completionTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "creationTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "errors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "id" : "string",
  "isCancellable" : true,
  "name" : "string",
  "resources" : [ {
    "fqdn" : "string",
    "name" : "string",
    "resourceId" : "string",
    "type" : "string"
  } ],
  "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
  "subTasks" : [ {
    "completionTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "creationTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "description" : "string",
    "errors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "name" : "string",
    "resources" : [ {
      "fqdn" : "string",
      "name" : "string",
      "resourceId" : "string",
      "type" : "string"
    } ],
    "stages" : [ {
      "completionTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "creationTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "description" : "string",
      "name" : "string",
      "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
      "type" : "string"
    } ],
    "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
    "type" : "string"
  } ],
  "type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}
Response 202
{
  "completionTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "creationTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "errors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "id" : "string",
  "isCancellable" : true,
  "name" : "string",
  "resources" : [ {
    "fqdn" : "string",
    "name" : "string",
    "resourceId" : "string",
    "type" : "string"
  } ],
  "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
  "subTasks" : [ {
    "completionTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "creationTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "description" : "string",
    "errors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "name" : "string",
    "resources" : [ {
      "fqdn" : "string",
      "name" : "string",
      "resourceId" : "string",
      "type" : "string"
    } ],
    "stages" : [ {
      "completionTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "creationTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "description" : "string",
      "name" : "string",
      "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
      "type" : "string"
    } ],
    "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
    "type" : "string"
  } ],
  "type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}
Response 400
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 500
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.73. Get validation results

GET /v1/pkses/validations/{id}

3.73.1. Parameters

Type Name Description Schema

Path

id
required

Validation ID

string

3.73.2. Responses

HTTP Code Description Schema

200

Accepted

Validation

400

Bad Request

Error

404

Not Found

Error

500

Internal Server Error

Error

3.73.3. Consumes

  • application/json

3.73.4. Produces

  • application/json

3.73.5. Tags

  • PKS

3.73.6. Security

Type Name

basic

basicAuth

3.73.7. Example HTTP request

Request path
/v1/pkses/validations/string

3.73.8. Example HTTP response

Response 200
{
  "description" : "string",
  "executionStatus" : "One among: IN_PROGRESS, FAILED, COMPLETED, SKIPPED, CANCELLED",
  "id" : "string",
  "resultStatus" : "One among: SUCCEEDED, FAILED, FAILED_WITH_WARNINGS",
  "validationChecks" : [ {
    "description" : "string",
    "errorResponse" : {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ {
        "arguments" : [ "string" ],
        "causes" : [ {
          "message" : "string",
          "type" : "string"
        } ],
        "context" : {
          "string" : "string"
        },
        "errorCode" : "string",
        "message" : "string",
        "nestedErrors" : [ "..." ],
        "referenceToken" : "string",
        "remediationMessage" : "string"
      } ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    },
    "nestedValidationChecks" : [ {
      "description" : "string",
      "errorResponse" : {
        "arguments" : [ "string" ],
        "causes" : [ {
          "message" : "string",
          "type" : "string"
        } ],
        "context" : {
          "string" : "string"
        },
        "errorCode" : "string",
        "message" : "string",
        "nestedErrors" : [ "..." ],
        "referenceToken" : "string",
        "remediationMessage" : "string"
      },
      "nestedValidationChecks" : [ "..." ],
      "resultStatus" : "One among: SUCCEEDED, FAILED",
      "severity" : "One among: WARNING, ERROR, INFO"
    } ],
    "resultStatus" : "One among: SUCCEEDED, FAILED",
    "severity" : "One among: WARNING, ERROR, INFO"
  } ]
}
Response 400
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 404
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 500
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.74. Get PKS details

GET /v1/pkses/{id}

3.74.1. Parameters

Type Name Description Schema

Path

id
required

PKS ID

string

Query

filter
optional

PKS details filter

< string > array(multi)

3.74.2. Responses

HTTP Code Description Schema

200

Accepted

Pks

400

Bad Request

Error

404

Not Found

Error

500

Internal Server Error

Error

3.74.3. Consumes

  • application/json

3.74.4. Produces

  • application/json

3.74.5. Tags

  • PKS

3.74.6. Security

Type Name

basic

basicAuth

3.74.7. Example HTTP request

Request path
/v1/pkses/string

3.74.8. Example HTTP response

Response 200
{
  "info" : {
    "domainId" : "string",
    "id" : "string",
    "name" : "string",
    "status" : "string"
  },
  "inputSpec" : {
    "adminPassword" : "string",
    "availabilityZoneSpec" : {
      "kubernetesNetwork" : {
        "cidr" : "10.255.0.0/24",
        "dnsServer" : "dns.sfo01.rainpole.local",
        "gateway" : "10.255.0.1",
        "reservedRanges" : "10.255.0.1-10.255.0.10",
        "vcenterNetwork" : "string"
      },
      "kubernetesZones" : [ {
        "clusterName" : "string",
        "name" : "string",
        "resourcePoolName" : "string"
      } ],
      "managementNetwork" : {
        "cidr" : "10.255.0.0/24",
        "dnsServer" : "dns.sfo01.rainpole.local",
        "gateway" : "10.255.0.1",
        "reservedRanges" : "10.255.0.1-10.255.0.10",
        "vcenterNetwork" : "string"
      },
      "managementZone" : {
        "clusterName" : "string",
        "name" : "string",
        "resourcePoolName" : "string"
      }
    },
    "certificateBundle" : {
      "harborRsaCert" : {
        "privateKey" : "string",
        "publicCert" : "string"
      },
      "nsxtRsaCert" : {
        "privateKey" : "string",
        "publicCert" : "string"
      },
      "pcfRsaCert" : {
        "privateKey" : "string",
        "publicCert" : "string"
      },
      "pksRsaCert" : {
        "privateKey" : "string",
        "publicCert" : "string"
      },
      "trustedCertificates" : "string"
    },
    "datastore" : "string",
    "decryptionPassphrase" : "string",
    "domainId" : "76df11e9-5c1f-4376-b913-0ea93ebda983",
    "harborHostname" : "harbor.sfo01.rainpole.local",
    "installHarbor" : true,
    "name" : "PKS-1",
    "nsxtItemsSpec" : {
      "floatingIpPoolId" : "ee7d0bc1-0cd3-4c59-8944-65a36fe35cf7",
      "nodesIpBlockId" : "b73446a0-9ffe-4291-b34f-ff0b6ee67ff3",
      "podsIpBlockId" : "6f5db6d2-30f6-47e3-a765-3ebc34390bce",
      "t0routerId" : "bc3fda31-74b9-4759-8e1f-ff72726b8d5d"
    },
    "pksApiHostname" : "pksApi.sfo01.rainpole.local",
    "pksOpsManagerVmSpec" : {
      "appliance" : {
        "hostname" : "pcf.sfo01.rainpole.local",
        "ip" : "10.255.0.10",
        "vmName" : "ops-manager"
      },
      "network" : {
        "dnsServers" : "dns.sfo01.rainpole.local, dns1.sfo01.rainpole.local",
        "dnsSuffix" : "*.sfo01.rainpole.local",
        "gateway" : "10.255.0.1",
        "netmask" : "255.255.255.0",
        "network" : "string",
        "ntpServers" : "ntp.sfo01.rainpole.local, ntp1.sfo01.rainpole.local"
      }
    }
  },
  "serviceVms" : [ {
    "ip" : "string",
    "name" : "string",
    "url" : "string"
  } ],
  "summary" : {
    "harborRegistryUrl" : "https://harbor.sfo01.rainpole.local",
    "kubernetesZonesCount" : 1,
    "managementZonesCount" : 1,
    "opsManagerUrl" : "https://pcf.sfo01.rainpole.local",
    "pksApiFqdn" : "pksApi.sfo01.rainpole.local",
    "wldName" : "string"
  }
}
Response 400
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 404
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 500
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.75. Delete PKS

DELETE /v1/pkses/{id}

3.75.1. Parameters

Type Name Description Schema

Path

id
required

PKS ID

string

3.75.2. Responses

HTTP Code Description Schema

200

OK

Task

202

Accepted

Task

400

Bad Request

Error

409

Conflict

Error

500

Internal Server Error

Error

3.75.3. Consumes

  • application/json

3.75.4. Produces

  • application/json

3.75.5. Tags

  • PKS

3.75.6. Security

Type Name

basic

basicAuth

3.75.7. Example HTTP request

Request path
/v1/pkses/string

3.75.8. Example HTTP response

Response 200
{
  "completionTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "creationTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "errors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "id" : "string",
  "isCancellable" : true,
  "name" : "string",
  "resources" : [ {
    "fqdn" : "string",
    "name" : "string",
    "resourceId" : "string",
    "type" : "string"
  } ],
  "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
  "subTasks" : [ {
    "completionTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "creationTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "description" : "string",
    "errors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "name" : "string",
    "resources" : [ {
      "fqdn" : "string",
      "name" : "string",
      "resourceId" : "string",
      "type" : "string"
    } ],
    "stages" : [ {
      "completionTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "creationTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "description" : "string",
      "name" : "string",
      "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
      "type" : "string"
    } ],
    "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
    "type" : "string"
  } ],
  "type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}
Response 202
{
  "completionTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "creationTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "errors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "id" : "string",
  "isCancellable" : true,
  "name" : "string",
  "resources" : [ {
    "fqdn" : "string",
    "name" : "string",
    "resourceId" : "string",
    "type" : "string"
  } ],
  "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
  "subTasks" : [ {
    "completionTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "creationTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "description" : "string",
    "errors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "name" : "string",
    "resources" : [ {
      "fqdn" : "string",
      "name" : "string",
      "resourceId" : "string",
      "type" : "string"
    } ],
    "stages" : [ {
      "completionTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "creationTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "description" : "string",
      "name" : "string",
      "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
      "type" : "string"
    } ],
    "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
    "type" : "string"
  } ],
  "type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}
Response 400
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 409
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 500
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.76. Initialize PKS deletion

PATCH /v1/pkses/{id}

3.76.1. Parameters

Type Name Description Schema

Path

id
required

PKS ID

string

Body

pksUpdateSpec
required

PKS update specification

PksUpdateSpec

3.76.2. Responses

HTTP Code Description Schema

200

Ok

No Content

400

Bad Request

Error

500

Internal Server Error

Error

3.76.3. Consumes

  • application/json

3.76.4. Produces

  • */*

3.76.5. Tags

  • PKS

3.76.6. Security

Type Name

basic

basicAuth

3.76.7. Example HTTP request

Request path
/v1/pkses/string
Request body
{
  "markForDeletion" : true
}

3.76.8. Example HTTP response

Response 400
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 500
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.77. Get the PSCs

GET /v1/pscs

3.77.1. Responses

HTTP Code Description Schema

200

Ok

Psc

400

Bad Request

Error

500

InternalServerError

Error

3.77.2. Consumes

  • application/json

3.77.3. Produces

  • application/json

3.77.4. Tags

  • PSCs

3.77.5. Security

Type Name

basic

basicAuth

3.77.6. Example HTTP request

Request path
/v1/pscs

3.77.7. Example HTTP response

Response 200
{
  "domain" : {
    "id" : "string"
  },
  "fqdn" : "string",
  "id" : "string",
  "ipAddress" : "string",
  "isReplica" : true,
  "ssoDomainName" : "string",
  "ssoSubDomainName" : "string"
}
Response 400
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 500
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.78. Get a PSC

GET /v1/pscs/{id}

3.78.1. Parameters

Type Name Description Schema

Path

id
required

PSC ID

string

3.78.2. Responses

HTTP Code Description Schema

200

Ok

Psc

404

Psc not found

Error

500

InternalServerError

Error

3.78.3. Consumes

  • application/json

3.78.4. Produces

  • application/json

3.78.5. Tags

  • PSCs

3.78.6. Security

Type Name

basic

basicAuth

3.78.7. Example HTTP request

Request path
/v1/pscs/string

3.78.8. Example HTTP response

Response 200
{
  "domain" : {
    "id" : "string"
  },
  "fqdn" : "string",
  "id" : "string",
  "ipAddress" : "string",
  "isReplica" : true,
  "ssoDomainName" : "string",
  "ssoSubDomainName" : "string"
}
Response 404
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 500
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.79. Trigger Restore

POST /v1/restores/tasks

3.79.1. Parameters

Type Name Description Schema

Body

restoreSpec
required

restoreSpec

RestoreSpec

3.79.2. Responses

HTTP Code Description Schema

200

OK

Task

202

Accepted

Task

400

Bad Request

Error

500

Internal server error

Error

3.79.3. Consumes

  • application/json

3.79.4. Produces

  • application/json

3.79.5. Tags

  • BackupRestore

3.79.6. Security

Type Name

basic

basicAuth

3.79.7. Example HTTP request

Request path
/v1/restores/tasks
Request body
{
  "backupFile" : "string",
  "elements" : [ {
    "resourceType" : "SDDC_MANAGER"
  } ],
  "encryption" : {
    "passphrase" : "string"
  }
}

3.79.8. Example HTTP response

Response 200
{
  "completionTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "creationTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "errors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "id" : "string",
  "isCancellable" : true,
  "name" : "string",
  "resources" : [ {
    "fqdn" : "string",
    "name" : "string",
    "resourceId" : "string",
    "type" : "string"
  } ],
  "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
  "subTasks" : [ {
    "completionTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "creationTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "description" : "string",
    "errors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "name" : "string",
    "resources" : [ {
      "fqdn" : "string",
      "name" : "string",
      "resourceId" : "string",
      "type" : "string"
    } ],
    "stages" : [ {
      "completionTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "creationTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "description" : "string",
      "name" : "string",
      "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
      "type" : "string"
    } ],
    "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
    "type" : "string"
  } ],
  "type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}
Response 202
{
  "completionTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "creationTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "errors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "id" : "string",
  "isCancellable" : true,
  "name" : "string",
  "resources" : [ {
    "fqdn" : "string",
    "name" : "string",
    "resourceId" : "string",
    "type" : "string"
  } ],
  "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
  "subTasks" : [ {
    "completionTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "creationTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "description" : "string",
    "errors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "name" : "string",
    "resources" : [ {
      "fqdn" : "string",
      "name" : "string",
      "resourceId" : "string",
      "type" : "string"
    } ],
    "stages" : [ {
      "completionTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "creationTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "description" : "string",
      "name" : "string",
      "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
      "type" : "string"
    } ],
    "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
    "type" : "string"
  } ],
  "type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}
Response 400
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 500
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.80. Fetch the restores task

GET /v1/restores/tasks/{id}

3.80.1. Parameters

Type Name Description Schema

Body

restoreTaskId
required

restoreTaskId

string

3.80.2. Responses

HTTP Code Description Schema

200

OK

Task

202

Accepted

Task

400

Bad Request

Error

500

Internal server error

Error

3.80.3. Consumes

  • application/json

3.80.4. Produces

  • application/json

3.80.5. Tags

  • BackupRestore

3.80.6. Security

Type Name

basic

basicAuth

3.80.7. Example HTTP request

Request path
/v1/restores/tasks/{id}
Request body

3.80.8. Example HTTP response

Response 200
{
  "completionTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "creationTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "errors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "id" : "string",
  "isCancellable" : true,
  "name" : "string",
  "resources" : [ {
    "fqdn" : "string",
    "name" : "string",
    "resourceId" : "string",
    "type" : "string"
  } ],
  "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
  "subTasks" : [ {
    "completionTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "creationTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "description" : "string",
    "errors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "name" : "string",
    "resources" : [ {
      "fqdn" : "string",
      "name" : "string",
      "resourceId" : "string",
      "type" : "string"
    } ],
    "stages" : [ {
      "completionTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "creationTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "description" : "string",
      "name" : "string",
      "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
      "type" : "string"
    } ],
    "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
    "type" : "string"
  } ],
  "type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}
Response 202
{
  "completionTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "creationTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "errors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "id" : "string",
  "isCancellable" : true,
  "name" : "string",
  "resources" : [ {
    "fqdn" : "string",
    "name" : "string",
    "resourceId" : "string",
    "type" : "string"
  } ],
  "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
  "subTasks" : [ {
    "completionTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "creationTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "description" : "string",
    "errors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "name" : "string",
    "resources" : [ {
      "fqdn" : "string",
      "name" : "string",
      "resourceId" : "string",
      "type" : "string"
    } ],
    "stages" : [ {
      "completionTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "creationTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "description" : "string",
      "name" : "string",
      "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
      "type" : "string"
    } ],
    "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
    "type" : "string"
  } ],
  "type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}
Response 400
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 500
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.81. Get details of a federation

GET /v1/sddc-federation

3.81.1. Responses

HTTP Code Description Schema

200

OK

< MemberInfo > array

3.81.2. Consumes

  • application/json

3.81.3. Produces

  • application/json

3.81.4. Tags

  • Federation

3.81.5. Security

Type Name

basic

basicAuth

3.81.6. Example HTTP request

Request path
/v1/sddc-federation

3.81.7. Example HTTP response

Response 200
[ {
  "memberDetails" : {
    "city" : "string",
    "coordinate" : {
      "latitude" : 0.0,
      "longitude" : 0.0
    },
    "country" : "string",
    "fqdn" : "string",
    "role" : "CONTROLLER",
    "siteName" : "string",
    "siteType" : "DATACENTER",
    "state" : "string"
  },
  "memberHealth" : {
    "healthCode" : "GREEN",
    "healthDetails" : [ "string" ]
  },
  "memberInventory" : {
    "capacity" : {
      "summary" : {
        "aggregatedCapacity" : {
          "cpu" : {
            "free" : 0.0,
            "total" : 0.0,
            "unallocated" : 0.0,
            "unit" : "GHZ",
            "used" : 0.0
          },
          "datastores" : [ {
            "capacity" : 0.0,
            "datastoreName" : "string",
            "datastoreType" : "VSAN",
            "freeSpace" : 0.0,
            "unallocated" : 0.0,
            "unit" : "GHZ",
            "used" : 0.0
          } ],
          "hostCount" : {
            "total" : 0,
            "unallocated" : 0,
            "used" : 0
          },
          "memory" : {
            "totalCapacityMB" : 0.0
          }
        },
        "domainCount" : 0,
        "domainInfo" : [ {
          "domainCapacity" : {
            "cpu" : {
              "free" : 0.0,
              "total" : 0.0,
              "unallocated" : 0.0,
              "unit" : "GHZ",
              "used" : 0.0
            },
            "datastores" : [ {
              "capacity" : 0.0,
              "datastoreName" : "string",
              "datastoreType" : "VSAN",
              "freeSpace" : 0.0,
              "unallocated" : 0.0,
              "unit" : "GHZ",
              "used" : 0.0
            } ],
            "hostCount" : {
              "total" : 0,
              "unallocated" : 0,
              "used" : 0
            },
            "memory" : {
              "totalCapacityMB" : 0.0
            }
          },
          "domainId" : "string",
          "name" : "string",
          "status" : "string",
          "type" : "string"
        } ],
        "domainTypeInfo" : [ {
          "aggregatedCapacity" : {
            "cpu" : {
              "free" : 0.0,
              "total" : 0.0,
              "unallocated" : 0.0,
              "unit" : "GHZ",
              "used" : 0.0
            },
            "datastores" : [ {
              "capacity" : 0.0,
              "datastoreName" : "string",
              "datastoreType" : "VSAN",
              "freeSpace" : 0.0,
              "unallocated" : 0.0,
              "unit" : "GHZ",
              "used" : 0.0
            } ],
            "hostCount" : {
              "total" : 0,
              "unallocated" : 0,
              "used" : 0
            },
            "memory" : {
              "totalCapacityMB" : 0.0
            }
          },
          "domainCount" : 0,
          "type" : "string"
        } ]
      }
    },
    "creationTime" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "inventoryInfo" : {
      "hostCount" : {
        "total" : 0,
        "unallocated" : 0,
        "used" : 0
      }
    },
    "softwareInfo" : {
      "pendingUpdates" : 0
    }
  },
  "memberLiveness" : {
    "livelinessCode" : "GREEN",
    "livelinessDetails" : [ "string" ]
  }
} ]

3.82. Bootstrap a VMware Cloud Foundation to form a federation

PUT /v1/sddc-federation

3.82.1. Parameters

Type Name Description Schema

Body

bootstrapSpec
required

Bootstrap Spec

BootstrapSpec

3.82.2. Responses

HTTP Code Description Schema

202

Accepted

FederationTask

3.82.3. Consumes

  • application/json

3.82.4. Produces

  • application/json

3.82.5. Tags

  • Federation

3.82.6. Security

Type Name

basic

basicAuth

3.82.7. Example HTTP request

Request path
/v1/sddc-federation
Request body
{
  "federationName" : "string",
  "memberJoinDetail" : {
    "city" : "string",
    "coordinate" : {
      "latitude" : 0.0,
      "longitude" : 0.0
    },
    "country" : "string",
    "fqdn" : "string",
    "role" : "CONTROLLER",
    "siteName" : "string",
    "siteType" : "DATACENTER",
    "state" : "string"
  }
}

3.82.8. Example HTTP response

Response 202
{
  "created" : {
    "dateTime" : "string",
    "timestamp" : 0
  },
  "errors" : [ {
    "error" : "string",
    "suggestedRemedy" : "string"
  } ],
  "lastUpdated" : {
    "dateTime" : "string",
    "timestamp" : 0
  },
  "operation" : "BOOTSTRAP",
  "payload" : {
    "assignedBrokerId" : 0,
    "assignedZkId" : 0,
    "mbServers" : {
      "messageBusServersInfo" : [ {
        "brokerId" : 0,
        "fqdn" : "string",
        "hostAddress" : "string",
        "port" : 0
      } ]
    },
    "srServers" : {
      "schemaRegistryServersInfo" : [ {
        "hostAddress" : "string",
        "port" : 0,
        "protocol" : "string"
      } ]
    },
    "zkServers" : {
      "zookeeperServersInfo" : [ {
        "clientPort" : 0,
        "electionPort" : 0,
        "fqdn" : "string",
        "hostAddress" : "string",
        "peerPort" : 0,
        "securePort" : 0,
        "zkId" : 0,
        "zkRole" : "string"
      } ]
    }
  },
  "progressDetails" : "string",
  "remoteOperationTask" : {
    "created" : {
      "dateTime" : "string",
      "timestamp" : 0
    },
    "errors" : [ {
      "error" : "string",
      "suggestedRemedy" : "string"
    } ],
    "lastUpdated" : {
      "dateTime" : "string",
      "timestamp" : 0
    },
    "operation" : "BOOTSTRAP",
    "payload" : {
      "assignedBrokerId" : 0,
      "assignedZkId" : 0,
      "mbServers" : {
        "messageBusServersInfo" : [ {
          "brokerId" : 0,
          "fqdn" : "string",
          "hostAddress" : "string",
          "port" : 0
        } ]
      },
      "srServers" : {
        "schemaRegistryServersInfo" : [ {
          "hostAddress" : "string",
          "port" : 0,
          "protocol" : "string"
        } ]
      },
      "zkServers" : {
        "zookeeperServersInfo" : [ {
          "clientPort" : 0,
          "electionPort" : 0,
          "fqdn" : "string",
          "hostAddress" : "string",
          "peerPort" : 0,
          "securePort" : 0,
          "zkId" : 0,
          "zkRole" : "string"
        } ]
      }
    },
    "progressDetails" : "string",
    "remoteOperationTask" : "...",
    "status" : "NOT_STARTED",
    "taskId" : "string"
  },
  "status" : "NOT_STARTED",
  "taskId" : "string"
}

3.83. Teardown a federation

DELETE /v1/sddc-federation

3.83.1. Responses

HTTP Code Description Schema

202

ACCEPTED

FederationTask

3.83.2. Consumes

  • application/json

3.83.3. Produces

  • application/json

3.83.4. Tags

  • Federation

3.83.5. Security

Type Name

basic

basicAuth

3.83.6. Example HTTP request

Request path
/v1/sddc-federation

3.83.7. Example HTTP response

Response 202
{
  "created" : {
    "dateTime" : "string",
    "timestamp" : 0
  },
  "errors" : [ {
    "error" : "string",
    "suggestedRemedy" : "string"
  } ],
  "lastUpdated" : {
    "dateTime" : "string",
    "timestamp" : 0
  },
  "operation" : "BOOTSTRAP",
  "payload" : {
    "assignedBrokerId" : 0,
    "assignedZkId" : 0,
    "mbServers" : {
      "messageBusServersInfo" : [ {
        "brokerId" : 0,
        "fqdn" : "string",
        "hostAddress" : "string",
        "port" : 0
      } ]
    },
    "srServers" : {
      "schemaRegistryServersInfo" : [ {
        "hostAddress" : "string",
        "port" : 0,
        "protocol" : "string"
      } ]
    },
    "zkServers" : {
      "zookeeperServersInfo" : [ {
        "clientPort" : 0,
        "electionPort" : 0,
        "fqdn" : "string",
        "hostAddress" : "string",
        "peerPort" : 0,
        "securePort" : 0,
        "zkId" : 0,
        "zkRole" : "string"
      } ]
    }
  },
  "progressDetails" : "string",
  "remoteOperationTask" : {
    "created" : {
      "dateTime" : "string",
      "timestamp" : 0
    },
    "errors" : [ {
      "error" : "string",
      "suggestedRemedy" : "string"
    } ],
    "lastUpdated" : {
      "dateTime" : "string",
      "timestamp" : 0
    },
    "operation" : "BOOTSTRAP",
    "payload" : {
      "assignedBrokerId" : 0,
      "assignedZkId" : 0,
      "mbServers" : {
        "messageBusServersInfo" : [ {
          "brokerId" : 0,
          "fqdn" : "string",
          "hostAddress" : "string",
          "port" : 0
        } ]
      },
      "srServers" : {
        "schemaRegistryServersInfo" : [ {
          "hostAddress" : "string",
          "port" : 0,
          "protocol" : "string"
        } ]
      },
      "zkServers" : {
        "zookeeperServersInfo" : [ {
          "clientPort" : 0,
          "electionPort" : 0,
          "fqdn" : "string",
          "hostAddress" : "string",
          "peerPort" : 0,
          "securePort" : 0,
          "zkId" : 0,
          "zkRole" : "string"
        } ]
      }
    },
    "progressDetails" : "string",
    "remoteOperationTask" : "...",
    "status" : "NOT_STARTED",
    "taskId" : "string"
  },
  "status" : "NOT_STARTED",
  "taskId" : "string"
}

3.84. Join a VMware Cloud Foundation to a federation

POST /v1/sddc-federation/members

3.84.1. Parameters

Type Name Description Schema

Body

joinSpec
required

Member Join Spec

MemberJoinSpec

3.84.2. Responses

HTTP Code Description Schema

202

ACCEPTED

FederationTask

3.84.3. Consumes

  • application/json

3.84.4. Produces

  • application/json

3.84.5. Tags

  • Members

3.84.6. Security

Type Name

basic

basicAuth

3.84.7. Example HTTP request

Request path
/v1/sddc-federation/members
Request body
{
  "commonName" : "string",
  "controllerFqdn" : "string",
  "joinToken" : "string",
  "memberJoinDetail" : {
    "city" : "string",
    "coordinate" : {
      "latitude" : 0.0,
      "longitude" : 0.0
    },
    "country" : "string",
    "fqdn" : "string",
    "role" : "CONTROLLER",
    "siteName" : "string",
    "siteType" : "DATACENTER",
    "state" : "string"
  }
}

3.84.8. Example HTTP response

Response 202
{
  "created" : {
    "dateTime" : "string",
    "timestamp" : 0
  },
  "errors" : [ {
    "error" : "string",
    "suggestedRemedy" : "string"
  } ],
  "lastUpdated" : {
    "dateTime" : "string",
    "timestamp" : 0
  },
  "operation" : "BOOTSTRAP",
  "payload" : {
    "assignedBrokerId" : 0,
    "assignedZkId" : 0,
    "mbServers" : {
      "messageBusServersInfo" : [ {
        "brokerId" : 0,
        "fqdn" : "string",
        "hostAddress" : "string",
        "port" : 0
      } ]
    },
    "srServers" : {
      "schemaRegistryServersInfo" : [ {
        "hostAddress" : "string",
        "port" : 0,
        "protocol" : "string"
      } ]
    },
    "zkServers" : {
      "zookeeperServersInfo" : [ {
        "clientPort" : 0,
        "electionPort" : 0,
        "fqdn" : "string",
        "hostAddress" : "string",
        "peerPort" : 0,
        "securePort" : 0,
        "zkId" : 0,
        "zkRole" : "string"
      } ]
    }
  },
  "progressDetails" : "string",
  "remoteOperationTask" : {
    "created" : {
      "dateTime" : "string",
      "timestamp" : 0
    },
    "errors" : [ {
      "error" : "string",
      "suggestedRemedy" : "string"
    } ],
    "lastUpdated" : {
      "dateTime" : "string",
      "timestamp" : 0
    },
    "operation" : "BOOTSTRAP",
    "payload" : {
      "assignedBrokerId" : 0,
      "assignedZkId" : 0,
      "mbServers" : {
        "messageBusServersInfo" : [ {
          "brokerId" : 0,
          "fqdn" : "string",
          "hostAddress" : "string",
          "port" : 0
        } ]
      },
      "srServers" : {
        "schemaRegistryServersInfo" : [ {
          "hostAddress" : "string",
          "port" : 0,
          "protocol" : "string"
        } ]
      },
      "zkServers" : {
        "zookeeperServersInfo" : [ {
          "clientPort" : 0,
          "electionPort" : 0,
          "fqdn" : "string",
          "hostAddress" : "string",
          "peerPort" : 0,
          "securePort" : 0,
          "zkId" : 0,
          "zkRole" : "string"
        } ]
      }
    },
    "progressDetails" : "string",
    "remoteOperationTask" : "...",
    "status" : "NOT_STARTED",
    "taskId" : "string"
  },
  "status" : "NOT_STARTED",
  "taskId" : "string"
}

3.85. Get fact about a VMware Cloud Foundation

GET /v1/sddc-federation/members

3.85.1. Parameters

Type Name Description Schema

Query

local
optional

Provide current member fact

boolean

3.85.2. Responses

HTTP Code Description Schema

200

OK

MemberFact

3.85.3. Consumes

  • application/json

3.85.4. Produces

  • application/json

3.85.5. Tags

  • Members

3.85.6. Security

Type Name

basic

basicAuth

3.85.7. Example HTTP request

Request path
/v1/sddc-federation/members

3.85.8. Example HTTP response

Response 200
{
  "error" : {
    "error" : "string",
    "suggestedRemedy" : "string"
  },
  "federationName" : "string",
  "memberDetail" : {
    "city" : "string",
    "coordinate" : {
      "latitude" : 0.0,
      "longitude" : 0.0
    },
    "country" : "string",
    "fqdn" : "string",
    "role" : "CONTROLLER",
    "siteName" : "string",
    "siteType" : "DATACENTER",
    "state" : "string"
  },
  "permissions" : [ "BOOTSTRAP" ]
}

3.86. Leave a VMware Cloud Foundation from a federation

DELETE /v1/sddc-federation/members/{memberId}

3.86.1. Parameters

Type Name Description Schema

Path

memberId
required

Member FQDN

string

Query

force
optional

force

boolean

3.86.2. Responses

HTTP Code Description Schema

202

ACCEPTED

FederationTask

3.86.3. Consumes

  • application/json

3.86.4. Produces

  • application/json

3.86.5. Tags

  • Members

3.86.6. Security

Type Name

basic

basicAuth

3.86.7. Example HTTP request

Request path
/v1/sddc-federation/members/string

3.86.8. Example HTTP response

Response 202
{
  "created" : {
    "dateTime" : "string",
    "timestamp" : 0
  },
  "errors" : [ {
    "error" : "string",
    "suggestedRemedy" : "string"
  } ],
  "lastUpdated" : {
    "dateTime" : "string",
    "timestamp" : 0
  },
  "operation" : "BOOTSTRAP",
  "payload" : {
    "assignedBrokerId" : 0,
    "assignedZkId" : 0,
    "mbServers" : {
      "messageBusServersInfo" : [ {
        "brokerId" : 0,
        "fqdn" : "string",
        "hostAddress" : "string",
        "port" : 0
      } ]
    },
    "srServers" : {
      "schemaRegistryServersInfo" : [ {
        "hostAddress" : "string",
        "port" : 0,
        "protocol" : "string"
      } ]
    },
    "zkServers" : {
      "zookeeperServersInfo" : [ {
        "clientPort" : 0,
        "electionPort" : 0,
        "fqdn" : "string",
        "hostAddress" : "string",
        "peerPort" : 0,
        "securePort" : 0,
        "zkId" : 0,
        "zkRole" : "string"
      } ]
    }
  },
  "progressDetails" : "string",
  "remoteOperationTask" : {
    "created" : {
      "dateTime" : "string",
      "timestamp" : 0
    },
    "errors" : [ {
      "error" : "string",
      "suggestedRemedy" : "string"
    } ],
    "lastUpdated" : {
      "dateTime" : "string",
      "timestamp" : 0
    },
    "operation" : "BOOTSTRAP",
    "payload" : {
      "assignedBrokerId" : 0,
      "assignedZkId" : 0,
      "mbServers" : {
        "messageBusServersInfo" : [ {
          "brokerId" : 0,
          "fqdn" : "string",
          "hostAddress" : "string",
          "port" : 0
        } ]
      },
      "srServers" : {
        "schemaRegistryServersInfo" : [ {
          "hostAddress" : "string",
          "port" : 0,
          "protocol" : "string"
        } ]
      },
      "zkServers" : {
        "zookeeperServersInfo" : [ {
          "clientPort" : 0,
          "electionPort" : 0,
          "fqdn" : "string",
          "hostAddress" : "string",
          "peerPort" : 0,
          "securePort" : 0,
          "zkId" : 0,
          "zkRole" : "string"
        } ]
      }
    },
    "progressDetails" : "string",
    "remoteOperationTask" : "...",
    "status" : "NOT_STARTED",
    "taskId" : "string"
  },
  "status" : "NOT_STARTED",
  "taskId" : "string"
}

3.87. Invite a VMware Cloud Foundation to be member of a federation

POST /v1/sddc-federation/membership-tokens

3.87.1. Parameters

Type Name Description Schema

Body

inviteSpec
required

Invitation Spec

InvitationSpec

3.87.2. Responses

HTTP Code Description Schema

200

OK

MembershipInvitation

3.87.3. Consumes

  • application/json

3.87.4. Produces

  • application/json

3.87.5. Tags

  • MembershipToken

3.87.6. Security

Type Name

basic

basicAuth

3.87.7. Example HTTP request

Request path
/v1/sddc-federation/membership-tokens
Request body
{
  "inviteeFqdn" : "string",
  "inviteeRole" : "CONTROLLER",
  "tokenExpiryHours" : 0.0
}

3.87.8. Example HTTP response

Response 200
{
  "controllerFqdn" : [ "string" ],
  "error" : {
    "error" : "string",
    "suggestedRemedy" : "string"
  },
  "invitationToken" : "string",
  "inviteeFqdn" : "string",
  "inviteeRole" : "CONTROLLER"
}

3.88. Get progress of an invoked operation

GET /v1/sddc-federation/tasks/{taskId}

3.88.1. Parameters

Type Name Description Schema

Path

taskId
required

Task ID

string

3.88.2. Responses

HTTP Code Description Schema

200

OK

FederationTask

3.88.3. Consumes

  • application/json

3.88.4. Produces

  • application/json

3.88.5. Tags

  • Progress

3.88.6. Security

Type Name

basic

basicAuth

3.88.7. Example HTTP request

Request path
/v1/sddc-federation/tasks/string

3.88.8. Example HTTP response

Response 200
{
  "created" : {
    "dateTime" : "string",
    "timestamp" : 0
  },
  "errors" : [ {
    "error" : "string",
    "suggestedRemedy" : "string"
  } ],
  "lastUpdated" : {
    "dateTime" : "string",
    "timestamp" : 0
  },
  "operation" : "BOOTSTRAP",
  "payload" : {
    "assignedBrokerId" : 0,
    "assignedZkId" : 0,
    "mbServers" : {
      "messageBusServersInfo" : [ {
        "brokerId" : 0,
        "fqdn" : "string",
        "hostAddress" : "string",
        "port" : 0
      } ]
    },
    "srServers" : {
      "schemaRegistryServersInfo" : [ {
        "hostAddress" : "string",
        "port" : 0,
        "protocol" : "string"
      } ]
    },
    "zkServers" : {
      "zookeeperServersInfo" : [ {
        "clientPort" : 0,
        "electionPort" : 0,
        "fqdn" : "string",
        "hostAddress" : "string",
        "peerPort" : 0,
        "securePort" : 0,
        "zkId" : 0,
        "zkRole" : "string"
      } ]
    }
  },
  "progressDetails" : "string",
  "remoteOperationTask" : {
    "created" : {
      "dateTime" : "string",
      "timestamp" : 0
    },
    "errors" : [ {
      "error" : "string",
      "suggestedRemedy" : "string"
    } ],
    "lastUpdated" : {
      "dateTime" : "string",
      "timestamp" : 0
    },
    "operation" : "BOOTSTRAP",
    "payload" : {
      "assignedBrokerId" : 0,
      "assignedZkId" : 0,
      "mbServers" : {
        "messageBusServersInfo" : [ {
          "brokerId" : 0,
          "fqdn" : "string",
          "hostAddress" : "string",
          "port" : 0
        } ]
      },
      "srServers" : {
        "schemaRegistryServersInfo" : [ {
          "hostAddress" : "string",
          "port" : 0,
          "protocol" : "string"
        } ]
      },
      "zkServers" : {
        "zookeeperServersInfo" : [ {
          "clientPort" : 0,
          "electionPort" : 0,
          "fqdn" : "string",
          "hostAddress" : "string",
          "peerPort" : 0,
          "securePort" : 0,
          "zkId" : 0,
          "zkRole" : "string"
        } ]
      }
    },
    "progressDetails" : "string",
    "remoteOperationTask" : "...",
    "status" : "NOT_STARTED",
    "taskId" : "string"
  },
  "status" : "NOT_STARTED",
  "taskId" : "string"
}

3.89. Get the Sddc Managers

GET /v1/sddc-managers

3.89.1. Responses

HTTP Code Description Schema

200

Ok

SddcManager

400

Bad Request

Error

500

InternalServerError

Error

3.89.2. Consumes

  • application/json

3.89.3. Produces

  • application/json

3.89.4. Tags

  • SddcManagers

3.89.5. Security

Type Name

basic

basicAuth

3.89.6. Example HTTP request

Request path
/v1/sddc-managers

3.89.7. Example HTTP response

Response 200
{
  "domain" : {
    "id" : "string"
  },
  "fqdn" : "string",
  "id" : "string",
  "ipAddress" : "string",
  "version" : "string"
}
Response 400
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 500
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.90. Get a Sddc Manager

GET /v1/sddc-managers/{id}

3.90.1. Parameters

Type Name Description Schema

Path

id
required

Sddc Manager ID

string

3.90.2. Responses

HTTP Code Description Schema

200

Ok

SddcManager

404

Sddc Manager not found

Error

500

InternalServerError

Error

3.90.3. Consumes

  • application/json

3.90.4. Produces

  • application/json

3.90.5. Tags

  • SddcManagers

3.90.6. Security

Type Name

basic

basicAuth

3.90.7. Example HTTP request

Request path
/v1/sddc-managers/string

3.90.8. Example HTTP response

Response 200
{
  "domain" : {
    "id" : "string"
  },
  "fqdn" : "string",
  "id" : "string",
  "ipAddress" : "string",
  "version" : "string"
}
Response 404
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 500
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.91. Create SDDC

POST /v1/sddcs

3.91.1. Parameters

Type Name Description Schema

Body

sddcSpec
required

SDDC specification

SddcSpec

3.91.2. Responses

HTTP Code Description Schema

200

OK

SddcTask

202

Success

SddcTask

400

SDDC already exists, Bad Request

Error

500

Internal Server Error

Error

3.91.3. Consumes

  • application/json

3.91.4. Produces

  • application/json

3.91.5. Tags

  • SDDC

3.91.6. Security

Type Name

basic

basicAuth

3.91.7. Example HTTP request

Request path
/v1/sddcs
Request body
{
  "adSpec" : {
    "childAdDetails" : {
      "alias" : "string",
      "baseDnGroups" : "string",
      "baseDnUsers" : "string",
      "globalCatalogPort" : 0,
      "name" : "string",
      "port" : 0,
      "serverUrl" : "string"
    },
    "domainControllers" : [ "string" ],
    "groups" : {
      "string" : "string"
    },
    "requireSsl" : true,
    "rootAdDetails" : {
      "alias" : "string",
      "baseDnGroups" : "string",
      "baseDnUsers" : "string",
      "globalCatalogPort" : 0,
      "name" : "string",
      "port" : 0,
      "serverUrl" : "string"
    },
    "skipJoinEsxi" : true,
    "useSubDomainForUsers" : true,
    "users" : {
      "string" : "<<_sddccredentials>>"
    }
  },
  "ceipEnabled" : true,
  "certificatesPassphrase" : "string",
  "clusterSpec" : {
    "clusterEvcMode" : "string",
    "clusterName" : "string",
    "hostFailuresToTolerate" : 0,
    "hostProfileComplianceCheckHour" : 0,
    "hostProfileComplianceCheckMinute" : 0,
    "hosts" : [ "string" ],
    "resourcePoolSpecs" : [ {
      "cpuLimit" : 0,
      "cpuReservationExpandable" : true,
      "cpuReservationMhz" : 0,
      "cpuReservationPercentage" : 0,
      "cpuSharesLevel" : "custom",
      "cpuSharesValue" : 0,
      "memoryLimit" : 0,
      "memoryReservationExpandable" : true,
      "memoryReservationMb" : 0,
      "memoryReservationPercentage" : 0,
      "memorySharesLevel" : "custom",
      "memorySharesValue" : 0,
      "name" : "string",
      "type" : "management"
    } ],
    "vmFolders" : {
      "string" : "string"
    }
  },
  "deploymentEndpointSpec" : {
    "cluster" : "string",
    "datacenter" : "string",
    "resourcePool" : "string",
    "storage" : "string",
    "vcenter" : {
      "address" : "string",
      "password" : "string",
      "username" : "string"
    },
    "vmFolder" : "string",
    "vmFolders" : {
      "string" : "string"
    }
  },
  "dnsSpec" : {
    "domain" : "vmware.com",
    "nameserver" : "172.0.0.4",
    "secondaryNameserver" : "172.0.0.5",
    "subdomain" : "vcf.vmware.com"
  },
  "dvSwitchVersion" : "One among:6.0.0, 6.5.0",
  "dvsSpecs" : [ {
    "dvsName" : "string",
    "mtu" : 0,
    "networks" : "One among:VSAN, VMOTION, PUBLIC, MANAGEMENT, NSX_VTEP, HOSTMANAGEMENT, CLOUD_VENDOR_API, REPLICATION, DATACENTER_NETWORK, NSX_VXLAN, NON_ROUTABLE, CLOUD_VENDOR_API, OOB, CROSS_VPC, UPLINK01, UPLINK02, STORAGE, UDLR, DLR, X_REGION, REGION_SPECIFIC, REMOTE_REGION_SPECIFIC, COMPUTE, MANAGEMENT_VM",
    "niocSpecs" : [ {
      "trafficType" : "One among:VSAN, VMOTION, VIRTUALMACHINE, MANAGEMENT, NFS, VDP, HBR, FAULTTOLERANCE, ISCSI",
      "value" : "string"
    } ],
    "vmnics" : [ "string" ]
  } ],
  "esxLicense" : "string",
  "excludedComponents" : "One among:Foundation, VsphereHostProfiles, LogInsight, NSX, VrealizeNetwork, VSAN, VSANCleanup, VROPS, VRA, DRDeployment, DRConfiguration, ConfigurationBackup, VRB, VRSLCM, Inventory, UMDS, EsxThumbprintValidation, AVN, CEIP, Backup",
  "hostSpecs" : [ {
    "association" : "string",
    "credentials" : {
      "password" : "Admin!23",
      "username" : "root"
    },
    "hostname" : "esx-1",
    "ipAddressPrivate" : {
      "cidr" : "172.0.0.0/24",
      "gateway" : "192.168.0.1",
      "ipAddress" : "192.168.0.123",
      "subnet" : "255.255.255.252"
    },
    "key" : "string",
    "serverId" : "string",
    "sshThumbprint" : "string",
    "sslThumbprint" : "string",
    "vSwitch" : "string",
    "vmknicSpecs" : [ {
      "ipAddress" : "string",
      "macAddress" : "string",
      "portgroup" : "One among:VSAN, VMOTION, PUBLIC, MANAGEMENT, NSX_VTEP, HOSTMANAGEMENT, CLOUD_VENDOR_API, REPLICATION"
    } ],
    "vswitch" : "string"
  } ],
  "managementPoolName" : "string",
  "networkSpecs" : [ {
    "activeUplinks" : [ "string" ],
    "excludeIpAddressRanges" : [ "string" ],
    "excludeIpaddresses" : [ "string" ],
    "gateway" : "string",
    "includeIpAddress" : [ "string" ],
    "includeIpAddressRanges" : [ {
      "endIpAddress" : "192.168.0.128",
      "startIpAddress" : "192.168.0.123"
    } ],
    "mtu" : "string",
    "networkType" : "One among:VSAN, VMOTION, PUBLIC, MANAGEMENT, NSX_VTEP, HOSTMANAGEMENT, CLOUD_VENDOR_API, REPLICATION, DATACENTER_NETWORK, NSX_VXLAN, NON_ROUTABLE, CLOUD_VENDOR_API, OOB, CROSS_VPC, UPLINK01, UPLINK02, STORAGE, UDLR, DLR, X_REGION, REGION_SPECIFIC, REMOTE_REGION_SPECIFIC, COMPUTE, MANAGEMENT_VM",
    "portGroupKey" : "string",
    "standbyUplinks" : [ "string" ],
    "subnet" : "string",
    "subnetMask" : "string",
    "teamingPolicy" : "One among:loadbalance_ip, loadbalance_srcmac, loadbalance_srcid, failover_explicit, loadbalance_loadbased",
    "vlanId" : "string"
  } ],
  "nfsDatastoreName" : "string",
  "nsxSpec" : {
    "adminNsxControllerPassword" : "string",
    "adminNsxManagerPassword" : "string",
    "backupFtpServerAddress" : "string",
    "controllerIPPoolSpec" : {
      "defaultGateway" : "string",
      "endIp" : "string",
      "poolName" : "string",
      "prefix" : "string",
      "startIp" : "string"
    },
    "ftpBackupFolder" : "string",
    "ftpCredentials" : {
      "password" : "Admin!23",
      "username" : "root"
    },
    "ftpPassPhrase" : "string",
    "ftpPort" : 0,
    "license" : "string",
    "logicalSwitches" : [ {
      "controlPlaneMode" : "One among:MULTICAST_MODE, HYBRID_MODE, UNICAST_MODE",
      "name" : "string",
      "networkType" : "One among:VSAN, VMOTION, PUBLIC, MANAGEMENT, NSX_VTEP, HOSTMANAGEMENT, CLOUD_VENDOR_API, REPLICATION, DATACENTER_NETWORK, NSX_VXLAN, NON_ROUTABLE, CLOUD_VENDOR_API, OOB, CROSS_VPC, UPLINK01, UPLINK02, STORAGE, UDLR, DLR, X_REGION, REGION_SPECIFIC, REMOTE_REGION_SPECIFIC, COMPUTE, MANAGEMENT_VM",
      "transportZoneId" : "string"
    } ],
    "multicastRangeBegin" : "string",
    "multicastRangeEnd" : "string",
    "nsxBgpSpec" : {
      "defaultPassword" : "string",
      "localAutonomousSystem" : 0,
      "nsxEdgeBgpSpecs" : [ {
        "edgeType" : "One among:PSC_LB, MANAGEMENT_LB, ESG, DLR, UDLR",
        "enableGracefulRestart" : true,
        "learnFrom" : [ "string" ],
        "neighbours" : [ {
          "autonomousSystem" : 0,
          "forwardingIp" : "192.168.0.123",
          "holdDownTimeSeconds" : 0,
          "keepAliveTimeSeconds" : 0,
          "neighbourIp" : "192.168.0.123",
          "password" : "string",
          "protocolIp" : "192.168.0.123",
          "weight" : 0
        } ]
      } ],
      "skipBgpValidation" : true
    },
    "nsxControllerVmNamesPrefix" : "string",
    "nsxEdgePassword" : "string",
    "nsxEdgeSpecs" : [ {
      "edgeName" : "string",
      "edgeSize" : "One among:compact, large, quadlarge, xlarge",
      "edgeType" : "One among:PSC_LB, MANAGEMENT_LB, ESG, DLR, UDLR",
      "poolSpecs" : [ {
        "memberSpecs" : [ {
          "ipAddress" : "string",
          "monitorPort" : 0,
          "name" : "string"
        } ],
        "name" : "string"
      } ],
      "shortHostname" : "string",
      "vnics" : [ {
        "attachToLogicalSwitch" : true,
        "disconnected" : true,
        "name" : "string",
        "networkType" : "One among:VSAN, VMOTION, PUBLIC, MANAGEMENT, NSX_VTEP, HOSTMANAGEMENT, CLOUD_VENDOR_API, REPLICATION, DATACENTER_NETWORK, NSX_VXLAN, NON_ROUTABLE, CLOUD_VENDOR_API, OOB, CROSS_VPC, UPLINK01, UPLINK02, STORAGE, UDLR, DLR, X_REGION, REGION_SPECIFIC, REMOTE_REGION_SPECIFIC, COMPUTE, MANAGEMENT_VM",
        "primaryIpAddress" : "string",
        "secondaryIpAddresses" : [ "string" ],
        "type" : "One among:uplink, internal",
        "useForDefaultRoute" : true,
        "useForDynamicRouterConfiguration" : true
      } ]
    } ],
    "nsxId" : "string",
    "nsxManagerHostname" : "string",
    "nsxManagerIp" : "string",
    "nsxSegmentRangeBegin" : "string",
    "nsxSegmentRangeEnd" : "string",
    "nsxVxlanSpec" : {
      "excludeIpAddressRanges" : [ "string" ],
      "gateway" : "string",
      "poolEndAddress" : "string",
      "poolStartAddress" : "string",
      "subnetWithCidr" : "string",
      "teamingPolicy" : "FAILOVER_ORDER",
      "vtepVmknicCount" : 0,
      "vxlanCluster" : "string",
      "vxlanDvs" : "string",
      "vxlanMtu" : "string",
      "vxlanPoolName" : "string",
      "vxlanVlanId" : "string"
    },
    "privilegedNsxManagerPassword" : "string",
    "transferProtocol" : "SFTP",
    "transportZones" : [ {
      "controlPlaneMode" : "One among:MULTICAST_MODE, HYBRID_MODE, UNICAST_MODE",
      "id" : "universal-transport-zone",
      "name" : "string",
      "universal" : true
    } ],
    "universalMulticastRangeBegin" : "string",
    "universalMulticastRangeEnd" : "string",
    "universalSegmentRangeBegin" : "string",
    "universalSegmentRangeEnd" : "string"
  },
  "ntpServers" : [ "string" ],
  "pscLoadBalancerHostname" : "mgmt-psc",
  "pscLoadBalancerIpAddress" : "string",
  "pscSpecs" : [ {
    "adminUserSsoPassword" : "string",
    "automationUserSsoPassword" : "string",
    "automationUserSsoUsername" : "string",
    "pscHostName" : "string",
    "pscId" : "string",
    "pscIp" : "string",
    "pscSsoSpec" : {
      "adDomain" : "string",
      "adPassword" : "string",
      "adUsername" : "string",
      "isJoinSsoDomain" : true,
      "replicationPartner" : "string",
      "ssoDomain" : "string",
      "ssoSiteName" : "string"
    },
    "rootPscPassword" : "string"
  } ],
  "remoteSiteSpec" : {
    "clusterName" : "string",
    "datacenterName" : "string",
    "logicalSwitchNames" : [ "string" ],
    "nsxCredentials" : {
      "password" : "Admin!23",
      "username" : "root"
    },
    "nsxIp" : "string",
    "placeholderDatastore" : "string",
    "pscAddress" : "string",
    "remoteRegionVmFolders" : {
      "string" : "string"
    },
    "rpoMinutes" : 0,
    "siteName" : "string",
    "srmIp" : "string",
    "vcCredentials" : {
      "password" : "Admin!23",
      "username" : "root"
    },
    "vcMgmtIp" : "string",
    "vrIp" : "string",
    "vrReplicationIp" : "string",
    "vrRootPassword" : "string",
    "vrliAdminPassword" : "string",
    "vrliLoadBalancerHostname" : "string",
    "vrliNodesAddresses" : [ "string" ],
    "vrliRootPassword" : "string"
  },
  "sddcId" : "sfo01-workflowspec-ems",
  "sddcManagerSpec" : {
    "hostname" : "string",
    "ipAddress" : "string",
    "licenseKey" : "string",
    "netmask" : "string",
    "restApiCredentials" : {
      "password" : "Admin!23",
      "username" : "root"
    },
    "rootUserCredentials" : {
      "password" : "Admin!23",
      "username" : "root"
    },
    "secondUserCredentials" : {
      "password" : "Admin!23",
      "username" : "root"
    }
  },
  "selfSignedCertificates" : "string",
  "shouldCleanupVsan" : false,
  "skipEsxThumbprintValidation" : true,
  "smtpSpec" : {
    "credentials" : {
      "password" : "Admin!23",
      "username" : "root"
    },
    "isSecureConnection" : true,
    "port" : 0,
    "requiresAuthentication" : true,
    "server" : "string",
    "useTlsEncryption" : true
  },
  "srmSpec" : {
    "dbPassword" : "string",
    "licenseKey" : "string",
    "srmAdminCredentials" : {
      "password" : "Admin!23",
      "username" : "root"
    },
    "srmHostname" : "string",
    "srmRootCredentials" : {
      "password" : "Admin!23",
      "username" : "root"
    },
    "srmVmAddress" : "string",
    "srmVmName" : "string"
  },
  "taskName" : "string",
  "umdsSpec" : {
    "address" : "string",
    "user" : "string",
    "userPassword" : "string"
  },
  "vcenterSpec" : {
    "licenseFile" : "string",
    "rootVcenterPassword" : "string",
    "vcenterHostname" : "string",
    "vcenterIp" : "string",
    "vcenterNetmask" : "string",
    "vmSize" : "One among:xlarge, large, medium, small, tiny"
  },
  "vrSpec" : {
    "ipPoolName" : "string",
    "rootPassword" : "string",
    "vrIp" : "string",
    "vrReplicationIp" : "string",
    "vrShortHostName" : "string"
  },
  "vraDeploymentSpec" : {
    "brandingSpec" : {
      "backgroundColor" : "string",
      "companyName" : "string",
      "contactLink" : "string",
      "copyright" : "string",
      "privacyPolicyLink" : "string",
      "productName" : "string",
      "textColor" : "string"
    },
    "enableVroMultiTenancy" : true,
    "fabricGroupNames" : [ "string" ],
    "iaasTemplateName" : "string",
    "localAdministratorPassword" : "string",
    "localDefaultTenantAdmin" : {
      "email" : "string",
      "firstName" : "string",
      "lastName" : "string",
      "password" : "string",
      "username" : "string"
    },
    "msLbHostName" : "string",
    "msLbIpAddress" : "string",
    "msSqlServer" : {
      "address" : "string",
      "databaseName" : "string",
      "hostname" : "string",
      "instanceName" : "string",
      "password" : "string",
      "port" : 0,
      "username" : "string",
      "vmName" : "string"
    },
    "skipWindowsVms" : true,
    "systemAdminPassword" : "string",
    "tenantSpec" : {
      "email" : "string",
      "name" : "string",
      "url" : "string",
      "vraTenantAdministratorSpec" : {
        "email" : "string",
        "firstName" : "string",
        "lastName" : "string",
        "password" : "string",
        "username" : "string"
      }
    },
    "vraEmailProviderSpecs" : [ {
      "acceptSelfSignedCertificates" : true,
      "emailAddress" : "string",
      "inboundDirection" : "One among: INBOUND, OUTBOUND",
      "name" : "string",
      "password" : "string",
      "port" : 0,
      "protocol" : "One among: IMAP, SMTP",
      "serverAddress" : "string",
      "useSsl" : true,
      "username" : "string"
    } ],
    "vraLbHostName" : "string",
    "vraLbIpAddress" : "string",
    "vraNodeLicense" : "string",
    "vraRootPassword" : "string",
    "vraVms" : [ {
      "hostname" : "string",
      "ipAddress" : "string",
      "isPrimary" : true,
      "name" : "string",
      "type" : "string"
    } ],
    "webLbHostName" : "string",
    "webLbIpAddress" : "string"
  },
  "vrbDeploymentSpec" : {
    "collectorNode" : {
      "hostname" : "string",
      "ipAddress" : "string",
      "vmName" : "string"
    },
    "currency" : "string",
    "license" : "string",
    "serverNode" : {
      "hostname" : "string",
      "ipAddress" : "string",
      "vmName" : "string"
    },
    "sshPassword" : "string"
  },
  "vrliDeploymentSpec" : {
    "adminEmail" : "string",
    "adminPassword" : "string",
    "archiveLocation" : "string",
    "eventForwardingSiteTag" : "string",
    "license" : "string",
    "loadBalancerHostname" : "string",
    "loadBalancerIpAddress" : "string",
    "networkType" : "string",
    "notificationEmails" : [ "string" ],
    "senderSpec" : {
      "email" : "string",
      "name" : "string"
    },
    "sshPassword" : "string",
    "vmSize" : "One among:large, medium, small, xsmall",
    "vrliNodeSpecs" : [ {
      "hostname" : "string",
      "ipAddress" : "string"
    } ]
  },
  "vropsDeploymentSpec" : {
    "adminPassword" : "string",
    "collectorSize" : "One among:smallrc, largerc",
    "lbHostName" : "string",
    "lbIpAddress" : "string",
    "licenseKey" : "string",
    "nodeSize" : "One among:xsmall, small, medium, large, extra_large",
    "nodeSpecs" : [ {
      "hostname" : "string",
      "ipAddress" : "string",
      "vmName" : "string",
      "vropsNodeType" : "One among:MASTER, REPLICA, DATA, REMOTE_COLLECTOR"
    } ],
    "rebootVmAfterHddExtending" : true,
    "senderSpec" : {
      "email" : "string",
      "name" : "string"
    },
    "skipHddExtending" : true,
    "snmpReadCommunity" : "string",
    "vropsRootPassword" : "string"
  },
  "vrslcmDeploymentSpec" : {
    "apiPassword" : "string",
    "fqdn" : "vrslcm.vrack.vsphere.local",
    "ipAddress" : "string",
    "sshPassword" : "string"
  },
  "vsanSpec" : {
    "datastoreName" : "string",
    "hclFile" : "string",
    "licenseFile" : "string",
    "vsanDedup" : true,
    "vsanName" : "string"
  },
  "vxManagerSpec" : {
    "defaultAdminUserCredentials" : {
      "password" : "Admin!23",
      "username" : "root"
    },
    "defaultRootUserCredentials" : {
      "password" : "Admin!23",
      "username" : "root"
    },
    "vxManagerHostName" : "string"
  },
  "vxRailSpec" : {
    "vxRailObjectNames" : {
      "string" : "string"
    }
  }
}

3.91.8. Example HTTP response

Response 200
{
  "creationTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "id" : "string",
  "localizableNamePack" : {
    "arguments" : [ "string" ],
    "component" : "string",
    "message" : "string",
    "messageKey" : "string"
  },
  "name" : "string",
  "sddcSubTasks" : [ {
    "creationTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "description" : "string",
    "errors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ {
        "arguments" : [ "string" ],
        "causes" : [ {
          "message" : "string",
          "type" : "string"
        } ],
        "context" : {
          "string" : "string"
        },
        "errorCode" : "string",
        "message" : "string",
        "nestedErrors" : [ "..." ],
        "referenceToken" : "string",
        "remediationMessage" : "string"
      } ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "localizableDescriptionPack" : {
      "arguments" : [ "string" ],
      "component" : "string",
      "message" : "string",
      "messageKey" : "string"
    },
    "localizableNamePack" : {
      "arguments" : [ "string" ],
      "component" : "string",
      "message" : "string",
      "messageKey" : "string"
    },
    "name" : "string",
    "processingStateDescription" : "string",
    "processingStateName" : "string",
    "sddcId" : "123e4567-e89b-42d3-a456-556642440000",
    "status" : "INITIALIZED, COMPLETED_WITH_SUCCESS, COMPLETED_WITH_FAILURE, PREVALIDATION_COMPLETED_WITH_SUCCESS, PREVALIDATION_COMPLETED_WITH_FAILURE, POSTVALIDATION_COMPLETED_WITH_SUCCESS, POSTVALIDATION_COMPLETED_WITH_FAILURE,IN_PROGRESS, PREVALIDATION_IN_PROGRESS, POSTVALIDATION_IN_PROGRESS, INTERNAL_ERROR",
    "updateTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    }
  } ],
  "status" : "One among: IN_PROGRESS, COMPLETED_WITH_SUCCESS, ROLLBACK_SUCCESS, COMPLETED_WITH_FAILURE"
}
Response 202
{
  "creationTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "id" : "string",
  "localizableNamePack" : {
    "arguments" : [ "string" ],
    "component" : "string",
    "message" : "string",
    "messageKey" : "string"
  },
  "name" : "string",
  "sddcSubTasks" : [ {
    "creationTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "description" : "string",
    "errors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ {
        "arguments" : [ "string" ],
        "causes" : [ {
          "message" : "string",
          "type" : "string"
        } ],
        "context" : {
          "string" : "string"
        },
        "errorCode" : "string",
        "message" : "string",
        "nestedErrors" : [ "..." ],
        "referenceToken" : "string",
        "remediationMessage" : "string"
      } ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "localizableDescriptionPack" : {
      "arguments" : [ "string" ],
      "component" : "string",
      "message" : "string",
      "messageKey" : "string"
    },
    "localizableNamePack" : {
      "arguments" : [ "string" ],
      "component" : "string",
      "message" : "string",
      "messageKey" : "string"
    },
    "name" : "string",
    "processingStateDescription" : "string",
    "processingStateName" : "string",
    "sddcId" : "123e4567-e89b-42d3-a456-556642440000",
    "status" : "INITIALIZED, COMPLETED_WITH_SUCCESS, COMPLETED_WITH_FAILURE, PREVALIDATION_COMPLETED_WITH_SUCCESS, PREVALIDATION_COMPLETED_WITH_FAILURE, POSTVALIDATION_COMPLETED_WITH_SUCCESS, POSTVALIDATION_COMPLETED_WITH_FAILURE,IN_PROGRESS, PREVALIDATION_IN_PROGRESS, POSTVALIDATION_IN_PROGRESS, INTERNAL_ERROR",
    "updateTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    }
  } ],
  "status" : "One among: IN_PROGRESS, COMPLETED_WITH_SUCCESS, ROLLBACK_SUCCESS, COMPLETED_WITH_FAILURE"
}
Response 400
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 500
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.92. Retrieve all SDDCs

GET /v1/sddcs

3.92.1. Responses

HTTP Code Description Schema

200

Accepted

SddcTask

500

Internal Server Error

Error

3.92.2. Consumes

  • application/json

3.92.3. Produces

  • application/json

3.92.4. Tags

  • SDDC

3.92.5. Security

Type Name

basic

basicAuth

3.92.6. Example HTTP request

Request path
/v1/sddcs

3.92.7. Example HTTP response

Response 200
{
  "creationTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "id" : "string",
  "localizableNamePack" : {
    "arguments" : [ "string" ],
    "component" : "string",
    "message" : "string",
    "messageKey" : "string"
  },
  "name" : "string",
  "sddcSubTasks" : [ {
    "creationTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "description" : "string",
    "errors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ {
        "arguments" : [ "string" ],
        "causes" : [ {
          "message" : "string",
          "type" : "string"
        } ],
        "context" : {
          "string" : "string"
        },
        "errorCode" : "string",
        "message" : "string",
        "nestedErrors" : [ "..." ],
        "referenceToken" : "string",
        "remediationMessage" : "string"
      } ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "localizableDescriptionPack" : {
      "arguments" : [ "string" ],
      "component" : "string",
      "message" : "string",
      "messageKey" : "string"
    },
    "localizableNamePack" : {
      "arguments" : [ "string" ],
      "component" : "string",
      "message" : "string",
      "messageKey" : "string"
    },
    "name" : "string",
    "processingStateDescription" : "string",
    "processingStateName" : "string",
    "sddcId" : "123e4567-e89b-42d3-a456-556642440000",
    "status" : "INITIALIZED, COMPLETED_WITH_SUCCESS, COMPLETED_WITH_FAILURE, PREVALIDATION_COMPLETED_WITH_SUCCESS, PREVALIDATION_COMPLETED_WITH_FAILURE, POSTVALIDATION_COMPLETED_WITH_SUCCESS, POSTVALIDATION_COMPLETED_WITH_FAILURE,IN_PROGRESS, PREVALIDATION_IN_PROGRESS, POSTVALIDATION_IN_PROGRESS, INTERNAL_ERROR",
    "updateTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    }
  } ],
  "status" : "One among: IN_PROGRESS, COMPLETED_WITH_SUCCESS, ROLLBACK_SUCCESS, COMPLETED_WITH_FAILURE"
}
Response 500
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.93. Validate SDDC specification before creation

POST /v1/sddcs/validations

3.93.1. Description

SDDC specification incorporates all the client inputs regarding VMW component parameters constituting the SDDC: NTP, DNS spec, ESXi, VC, VSAN, NSX spec et al.

3.93.2. Parameters

Type Name Description Schema

Query

redo
optional

redo

boolean

Body

sddcSpec
required

SDDC specification

SddcSpec

3.93.3. Responses

HTTP Code Description Schema

200

Accepted

Validation

202

Success

Validation

403

Forbidden

No Content

404

Not Found

Error

500

Internal Server Error

Error

3.93.4. Consumes

  • application/json

3.93.5. Produces

  • application/json

3.93.6. Tags

  • SDDC

3.93.7. Security

Type Name

basic

basicAuth

3.93.8. Example HTTP request

Request path
/v1/sddcs/validations
Request body
{
  "adSpec" : {
    "childAdDetails" : {
      "alias" : "string",
      "baseDnGroups" : "string",
      "baseDnUsers" : "string",
      "globalCatalogPort" : 0,
      "name" : "string",
      "port" : 0,
      "serverUrl" : "string"
    },
    "domainControllers" : [ "string" ],
    "groups" : {
      "string" : "string"
    },
    "requireSsl" : true,
    "rootAdDetails" : {
      "alias" : "string",
      "baseDnGroups" : "string",
      "baseDnUsers" : "string",
      "globalCatalogPort" : 0,
      "name" : "string",
      "port" : 0,
      "serverUrl" : "string"
    },
    "skipJoinEsxi" : true,
    "useSubDomainForUsers" : true,
    "users" : {
      "string" : "<<_sddccredentials>>"
    }
  },
  "ceipEnabled" : true,
  "certificatesPassphrase" : "string",
  "clusterSpec" : {
    "clusterEvcMode" : "string",
    "clusterName" : "string",
    "hostFailuresToTolerate" : 0,
    "hostProfileComplianceCheckHour" : 0,
    "hostProfileComplianceCheckMinute" : 0,
    "hosts" : [ "string" ],
    "resourcePoolSpecs" : [ {
      "cpuLimit" : 0,
      "cpuReservationExpandable" : true,
      "cpuReservationMhz" : 0,
      "cpuReservationPercentage" : 0,
      "cpuSharesLevel" : "custom",
      "cpuSharesValue" : 0,
      "memoryLimit" : 0,
      "memoryReservationExpandable" : true,
      "memoryReservationMb" : 0,
      "memoryReservationPercentage" : 0,
      "memorySharesLevel" : "custom",
      "memorySharesValue" : 0,
      "name" : "string",
      "type" : "management"
    } ],
    "vmFolders" : {
      "string" : "string"
    }
  },
  "deploymentEndpointSpec" : {
    "cluster" : "string",
    "datacenter" : "string",
    "resourcePool" : "string",
    "storage" : "string",
    "vcenter" : {
      "address" : "string",
      "password" : "string",
      "username" : "string"
    },
    "vmFolder" : "string",
    "vmFolders" : {
      "string" : "string"
    }
  },
  "dnsSpec" : {
    "domain" : "vmware.com",
    "nameserver" : "172.0.0.4",
    "secondaryNameserver" : "172.0.0.5",
    "subdomain" : "vcf.vmware.com"
  },
  "dvSwitchVersion" : "One among:6.0.0, 6.5.0",
  "dvsSpecs" : [ {
    "dvsName" : "string",
    "mtu" : 0,
    "networks" : "One among:VSAN, VMOTION, PUBLIC, MANAGEMENT, NSX_VTEP, HOSTMANAGEMENT, CLOUD_VENDOR_API, REPLICATION, DATACENTER_NETWORK, NSX_VXLAN, NON_ROUTABLE, CLOUD_VENDOR_API, OOB, CROSS_VPC, UPLINK01, UPLINK02, STORAGE, UDLR, DLR, X_REGION, REGION_SPECIFIC, REMOTE_REGION_SPECIFIC, COMPUTE, MANAGEMENT_VM",
    "niocSpecs" : [ {
      "trafficType" : "One among:VSAN, VMOTION, VIRTUALMACHINE, MANAGEMENT, NFS, VDP, HBR, FAULTTOLERANCE, ISCSI",
      "value" : "string"
    } ],
    "vmnics" : [ "string" ]
  } ],
  "esxLicense" : "string",
  "excludedComponents" : "One among:Foundation, VsphereHostProfiles, LogInsight, NSX, VrealizeNetwork, VSAN, VSANCleanup, VROPS, VRA, DRDeployment, DRConfiguration, ConfigurationBackup, VRB, VRSLCM, Inventory, UMDS, EsxThumbprintValidation, AVN, CEIP, Backup",
  "hostSpecs" : [ {
    "association" : "string",
    "credentials" : {
      "password" : "Admin!23",
      "username" : "root"
    },
    "hostname" : "esx-1",
    "ipAddressPrivate" : {
      "cidr" : "172.0.0.0/24",
      "gateway" : "192.168.0.1",
      "ipAddress" : "192.168.0.123",
      "subnet" : "255.255.255.252"
    },
    "key" : "string",
    "serverId" : "string",
    "sshThumbprint" : "string",
    "sslThumbprint" : "string",
    "vSwitch" : "string",
    "vmknicSpecs" : [ {
      "ipAddress" : "string",
      "macAddress" : "string",
      "portgroup" : "One among:VSAN, VMOTION, PUBLIC, MANAGEMENT, NSX_VTEP, HOSTMANAGEMENT, CLOUD_VENDOR_API, REPLICATION"
    } ],
    "vswitch" : "string"
  } ],
  "managementPoolName" : "string",
  "networkSpecs" : [ {
    "activeUplinks" : [ "string" ],
    "excludeIpAddressRanges" : [ "string" ],
    "excludeIpaddresses" : [ "string" ],
    "gateway" : "string",
    "includeIpAddress" : [ "string" ],
    "includeIpAddressRanges" : [ {
      "endIpAddress" : "192.168.0.128",
      "startIpAddress" : "192.168.0.123"
    } ],
    "mtu" : "string",
    "networkType" : "One among:VSAN, VMOTION, PUBLIC, MANAGEMENT, NSX_VTEP, HOSTMANAGEMENT, CLOUD_VENDOR_API, REPLICATION, DATACENTER_NETWORK, NSX_VXLAN, NON_ROUTABLE, CLOUD_VENDOR_API, OOB, CROSS_VPC, UPLINK01, UPLINK02, STORAGE, UDLR, DLR, X_REGION, REGION_SPECIFIC, REMOTE_REGION_SPECIFIC, COMPUTE, MANAGEMENT_VM",
    "portGroupKey" : "string",
    "standbyUplinks" : [ "string" ],
    "subnet" : "string",
    "subnetMask" : "string",
    "teamingPolicy" : "One among:loadbalance_ip, loadbalance_srcmac, loadbalance_srcid, failover_explicit, loadbalance_loadbased",
    "vlanId" : "string"
  } ],
  "nfsDatastoreName" : "string",
  "nsxSpec" : {
    "adminNsxControllerPassword" : "string",
    "adminNsxManagerPassword" : "string",
    "backupFtpServerAddress" : "string",
    "controllerIPPoolSpec" : {
      "defaultGateway" : "string",
      "endIp" : "string",
      "poolName" : "string",
      "prefix" : "string",
      "startIp" : "string"
    },
    "ftpBackupFolder" : "string",
    "ftpCredentials" : {
      "password" : "Admin!23",
      "username" : "root"
    },
    "ftpPassPhrase" : "string",
    "ftpPort" : 0,
    "license" : "string",
    "logicalSwitches" : [ {
      "controlPlaneMode" : "One among:MULTICAST_MODE, HYBRID_MODE, UNICAST_MODE",
      "name" : "string",
      "networkType" : "One among:VSAN, VMOTION, PUBLIC, MANAGEMENT, NSX_VTEP, HOSTMANAGEMENT, CLOUD_VENDOR_API, REPLICATION, DATACENTER_NETWORK, NSX_VXLAN, NON_ROUTABLE, CLOUD_VENDOR_API, OOB, CROSS_VPC, UPLINK01, UPLINK02, STORAGE, UDLR, DLR, X_REGION, REGION_SPECIFIC, REMOTE_REGION_SPECIFIC, COMPUTE, MANAGEMENT_VM",
      "transportZoneId" : "string"
    } ],
    "multicastRangeBegin" : "string",
    "multicastRangeEnd" : "string",
    "nsxBgpSpec" : {
      "defaultPassword" : "string",
      "localAutonomousSystem" : 0,
      "nsxEdgeBgpSpecs" : [ {
        "edgeType" : "One among:PSC_LB, MANAGEMENT_LB, ESG, DLR, UDLR",
        "enableGracefulRestart" : true,
        "learnFrom" : [ "string" ],
        "neighbours" : [ {
          "autonomousSystem" : 0,
          "forwardingIp" : "192.168.0.123",
          "holdDownTimeSeconds" : 0,
          "keepAliveTimeSeconds" : 0,
          "neighbourIp" : "192.168.0.123",
          "password" : "string",
          "protocolIp" : "192.168.0.123",
          "weight" : 0
        } ]
      } ],
      "skipBgpValidation" : true
    },
    "nsxControllerVmNamesPrefix" : "string",
    "nsxEdgePassword" : "string",
    "nsxEdgeSpecs" : [ {
      "edgeName" : "string",
      "edgeSize" : "One among:compact, large, quadlarge, xlarge",
      "edgeType" : "One among:PSC_LB, MANAGEMENT_LB, ESG, DLR, UDLR",
      "poolSpecs" : [ {
        "memberSpecs" : [ {
          "ipAddress" : "string",
          "monitorPort" : 0,
          "name" : "string"
        } ],
        "name" : "string"
      } ],
      "shortHostname" : "string",
      "vnics" : [ {
        "attachToLogicalSwitch" : true,
        "disconnected" : true,
        "name" : "string",
        "networkType" : "One among:VSAN, VMOTION, PUBLIC, MANAGEMENT, NSX_VTEP, HOSTMANAGEMENT, CLOUD_VENDOR_API, REPLICATION, DATACENTER_NETWORK, NSX_VXLAN, NON_ROUTABLE, CLOUD_VENDOR_API, OOB, CROSS_VPC, UPLINK01, UPLINK02, STORAGE, UDLR, DLR, X_REGION, REGION_SPECIFIC, REMOTE_REGION_SPECIFIC, COMPUTE, MANAGEMENT_VM",
        "primaryIpAddress" : "string",
        "secondaryIpAddresses" : [ "string" ],
        "type" : "One among:uplink, internal",
        "useForDefaultRoute" : true,
        "useForDynamicRouterConfiguration" : true
      } ]
    } ],
    "nsxId" : "string",
    "nsxManagerHostname" : "string",
    "nsxManagerIp" : "string",
    "nsxSegmentRangeBegin" : "string",
    "nsxSegmentRangeEnd" : "string",
    "nsxVxlanSpec" : {
      "excludeIpAddressRanges" : [ "string" ],
      "gateway" : "string",
      "poolEndAddress" : "string",
      "poolStartAddress" : "string",
      "subnetWithCidr" : "string",
      "teamingPolicy" : "FAILOVER_ORDER",
      "vtepVmknicCount" : 0,
      "vxlanCluster" : "string",
      "vxlanDvs" : "string",
      "vxlanMtu" : "string",
      "vxlanPoolName" : "string",
      "vxlanVlanId" : "string"
    },
    "privilegedNsxManagerPassword" : "string",
    "transferProtocol" : "SFTP",
    "transportZones" : [ {
      "controlPlaneMode" : "One among:MULTICAST_MODE, HYBRID_MODE, UNICAST_MODE",
      "id" : "universal-transport-zone",
      "name" : "string",
      "universal" : true
    } ],
    "universalMulticastRangeBegin" : "string",
    "universalMulticastRangeEnd" : "string",
    "universalSegmentRangeBegin" : "string",
    "universalSegmentRangeEnd" : "string"
  },
  "ntpServers" : [ "string" ],
  "pscLoadBalancerHostname" : "mgmt-psc",
  "pscLoadBalancerIpAddress" : "string",
  "pscSpecs" : [ {
    "adminUserSsoPassword" : "string",
    "automationUserSsoPassword" : "string",
    "automationUserSsoUsername" : "string",
    "pscHostName" : "string",
    "pscId" : "string",
    "pscIp" : "string",
    "pscSsoSpec" : {
      "adDomain" : "string",
      "adPassword" : "string",
      "adUsername" : "string",
      "isJoinSsoDomain" : true,
      "replicationPartner" : "string",
      "ssoDomain" : "string",
      "ssoSiteName" : "string"
    },
    "rootPscPassword" : "string"
  } ],
  "remoteSiteSpec" : {
    "clusterName" : "string",
    "datacenterName" : "string",
    "logicalSwitchNames" : [ "string" ],
    "nsxCredentials" : {
      "password" : "Admin!23",
      "username" : "root"
    },
    "nsxIp" : "string",
    "placeholderDatastore" : "string",
    "pscAddress" : "string",
    "remoteRegionVmFolders" : {
      "string" : "string"
    },
    "rpoMinutes" : 0,
    "siteName" : "string",
    "srmIp" : "string",
    "vcCredentials" : {
      "password" : "Admin!23",
      "username" : "root"
    },
    "vcMgmtIp" : "string",
    "vrIp" : "string",
    "vrReplicationIp" : "string",
    "vrRootPassword" : "string",
    "vrliAdminPassword" : "string",
    "vrliLoadBalancerHostname" : "string",
    "vrliNodesAddresses" : [ "string" ],
    "vrliRootPassword" : "string"
  },
  "sddcId" : "sfo01-workflowspec-ems",
  "sddcManagerSpec" : {
    "hostname" : "string",
    "ipAddress" : "string",
    "licenseKey" : "string",
    "netmask" : "string",
    "restApiCredentials" : {
      "password" : "Admin!23",
      "username" : "root"
    },
    "rootUserCredentials" : {
      "password" : "Admin!23",
      "username" : "root"
    },
    "secondUserCredentials" : {
      "password" : "Admin!23",
      "username" : "root"
    }
  },
  "selfSignedCertificates" : "string",
  "shouldCleanupVsan" : false,
  "skipEsxThumbprintValidation" : true,
  "smtpSpec" : {
    "credentials" : {
      "password" : "Admin!23",
      "username" : "root"
    },
    "isSecureConnection" : true,
    "port" : 0,
    "requiresAuthentication" : true,
    "server" : "string",
    "useTlsEncryption" : true
  },
  "srmSpec" : {
    "dbPassword" : "string",
    "licenseKey" : "string",
    "srmAdminCredentials" : {
      "password" : "Admin!23",
      "username" : "root"
    },
    "srmHostname" : "string",
    "srmRootCredentials" : {
      "password" : "Admin!23",
      "username" : "root"
    },
    "srmVmAddress" : "string",
    "srmVmName" : "string"
  },
  "taskName" : "string",
  "umdsSpec" : {
    "address" : "string",
    "user" : "string",
    "userPassword" : "string"
  },
  "vcenterSpec" : {
    "licenseFile" : "string",
    "rootVcenterPassword" : "string",
    "vcenterHostname" : "string",
    "vcenterIp" : "string",
    "vcenterNetmask" : "string",
    "vmSize" : "One among:xlarge, large, medium, small, tiny"
  },
  "vrSpec" : {
    "ipPoolName" : "string",
    "rootPassword" : "string",
    "vrIp" : "string",
    "vrReplicationIp" : "string",
    "vrShortHostName" : "string"
  },
  "vraDeploymentSpec" : {
    "brandingSpec" : {
      "backgroundColor" : "string",
      "companyName" : "string",
      "contactLink" : "string",
      "copyright" : "string",
      "privacyPolicyLink" : "string",
      "productName" : "string",
      "textColor" : "string"
    },
    "enableVroMultiTenancy" : true,
    "fabricGroupNames" : [ "string" ],
    "iaasTemplateName" : "string",
    "localAdministratorPassword" : "string",
    "localDefaultTenantAdmin" : {
      "email" : "string",
      "firstName" : "string",
      "lastName" : "string",
      "password" : "string",
      "username" : "string"
    },
    "msLbHostName" : "string",
    "msLbIpAddress" : "string",
    "msSqlServer" : {
      "address" : "string",
      "databaseName" : "string",
      "hostname" : "string",
      "instanceName" : "string",
      "password" : "string",
      "port" : 0,
      "username" : "string",
      "vmName" : "string"
    },
    "skipWindowsVms" : true,
    "systemAdminPassword" : "string",
    "tenantSpec" : {
      "email" : "string",
      "name" : "string",
      "url" : "string",
      "vraTenantAdministratorSpec" : {
        "email" : "string",
        "firstName" : "string",
        "lastName" : "string",
        "password" : "string",
        "username" : "string"
      }
    },
    "vraEmailProviderSpecs" : [ {
      "acceptSelfSignedCertificates" : true,
      "emailAddress" : "string",
      "inboundDirection" : "One among: INBOUND, OUTBOUND",
      "name" : "string",
      "password" : "string",
      "port" : 0,
      "protocol" : "One among: IMAP, SMTP",
      "serverAddress" : "string",
      "useSsl" : true,
      "username" : "string"
    } ],
    "vraLbHostName" : "string",
    "vraLbIpAddress" : "string",
    "vraNodeLicense" : "string",
    "vraRootPassword" : "string",
    "vraVms" : [ {
      "hostname" : "string",
      "ipAddress" : "string",
      "isPrimary" : true,
      "name" : "string",
      "type" : "string"
    } ],
    "webLbHostName" : "string",
    "webLbIpAddress" : "string"
  },
  "vrbDeploymentSpec" : {
    "collectorNode" : {
      "hostname" : "string",
      "ipAddress" : "string",
      "vmName" : "string"
    },
    "currency" : "string",
    "license" : "string",
    "serverNode" : {
      "hostname" : "string",
      "ipAddress" : "string",
      "vmName" : "string"
    },
    "sshPassword" : "string"
  },
  "vrliDeploymentSpec" : {
    "adminEmail" : "string",
    "adminPassword" : "string",
    "archiveLocation" : "string",
    "eventForwardingSiteTag" : "string",
    "license" : "string",
    "loadBalancerHostname" : "string",
    "loadBalancerIpAddress" : "string",
    "networkType" : "string",
    "notificationEmails" : [ "string" ],
    "senderSpec" : {
      "email" : "string",
      "name" : "string"
    },
    "sshPassword" : "string",
    "vmSize" : "One among:large, medium, small, xsmall",
    "vrliNodeSpecs" : [ {
      "hostname" : "string",
      "ipAddress" : "string"
    } ]
  },
  "vropsDeploymentSpec" : {
    "adminPassword" : "string",
    "collectorSize" : "One among:smallrc, largerc",
    "lbHostName" : "string",
    "lbIpAddress" : "string",
    "licenseKey" : "string",
    "nodeSize" : "One among:xsmall, small, medium, large, extra_large",
    "nodeSpecs" : [ {
      "hostname" : "string",
      "ipAddress" : "string",
      "vmName" : "string",
      "vropsNodeType" : "One among:MASTER, REPLICA, DATA, REMOTE_COLLECTOR"
    } ],
    "rebootVmAfterHddExtending" : true,
    "senderSpec" : {
      "email" : "string",
      "name" : "string"
    },
    "skipHddExtending" : true,
    "snmpReadCommunity" : "string",
    "vropsRootPassword" : "string"
  },
  "vrslcmDeploymentSpec" : {
    "apiPassword" : "string",
    "fqdn" : "vrslcm.vrack.vsphere.local",
    "ipAddress" : "string",
    "sshPassword" : "string"
  },
  "vsanSpec" : {
    "datastoreName" : "string",
    "hclFile" : "string",
    "licenseFile" : "string",
    "vsanDedup" : true,
    "vsanName" : "string"
  },
  "vxManagerSpec" : {
    "defaultAdminUserCredentials" : {
      "password" : "Admin!23",
      "username" : "root"
    },
    "defaultRootUserCredentials" : {
      "password" : "Admin!23",
      "username" : "root"
    },
    "vxManagerHostName" : "string"
  },
  "vxRailSpec" : {
    "vxRailObjectNames" : {
      "string" : "string"
    }
  }
}

3.93.9. Example HTTP response

Response 200
{
  "description" : "string",
  "executionStatus" : "One among: IN_PROGRESS, FAILED, COMPLETED, SKIPPED, CANCELLED",
  "id" : "string",
  "resultStatus" : "One among: SUCCEEDED, FAILED, FAILED_WITH_WARNINGS",
  "validationChecks" : [ {
    "description" : "string",
    "errorResponse" : {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ {
        "arguments" : [ "string" ],
        "causes" : [ {
          "message" : "string",
          "type" : "string"
        } ],
        "context" : {
          "string" : "string"
        },
        "errorCode" : "string",
        "message" : "string",
        "nestedErrors" : [ "..." ],
        "referenceToken" : "string",
        "remediationMessage" : "string"
      } ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    },
    "nestedValidationChecks" : [ {
      "description" : "string",
      "errorResponse" : {
        "arguments" : [ "string" ],
        "causes" : [ {
          "message" : "string",
          "type" : "string"
        } ],
        "context" : {
          "string" : "string"
        },
        "errorCode" : "string",
        "message" : "string",
        "nestedErrors" : [ "..." ],
        "referenceToken" : "string",
        "remediationMessage" : "string"
      },
      "nestedValidationChecks" : [ "..." ],
      "resultStatus" : "One among: SUCCEEDED, FAILED",
      "severity" : "One among: WARNING, ERROR, INFO"
    } ],
    "resultStatus" : "One among: SUCCEEDED, FAILED",
    "severity" : "One among: WARNING, ERROR, INFO"
  } ]
}
Response 202
{
  "description" : "string",
  "executionStatus" : "One among: IN_PROGRESS, FAILED, COMPLETED, SKIPPED, CANCELLED",
  "id" : "string",
  "resultStatus" : "One among: SUCCEEDED, FAILED, FAILED_WITH_WARNINGS",
  "validationChecks" : [ {
    "description" : "string",
    "errorResponse" : {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ {
        "arguments" : [ "string" ],
        "causes" : [ {
          "message" : "string",
          "type" : "string"
        } ],
        "context" : {
          "string" : "string"
        },
        "errorCode" : "string",
        "message" : "string",
        "nestedErrors" : [ "..." ],
        "referenceToken" : "string",
        "remediationMessage" : "string"
      } ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    },
    "nestedValidationChecks" : [ {
      "description" : "string",
      "errorResponse" : {
        "arguments" : [ "string" ],
        "causes" : [ {
          "message" : "string",
          "type" : "string"
        } ],
        "context" : {
          "string" : "string"
        },
        "errorCode" : "string",
        "message" : "string",
        "nestedErrors" : [ "..." ],
        "referenceToken" : "string",
        "remediationMessage" : "string"
      },
      "nestedValidationChecks" : [ "..." ],
      "resultStatus" : "One among: SUCCEEDED, FAILED",
      "severity" : "One among: WARNING, ERROR, INFO"
    } ],
    "resultStatus" : "One among: SUCCEEDED, FAILED",
    "severity" : "One among: WARNING, ERROR, INFO"
  } ]
}
Response 404
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 500
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.94. Get all SDDC specification validations

GET /v1/sddcs/validations

3.94.1. Responses

HTTP Code Description Schema

200

Accepted

< Validation > array

404

Not Found

Error

500

Internal Server Error

Error

501

Not Implemented

Error

3.94.2. Consumes

  • application/json

3.94.3. Produces

  • application/json

3.94.4. Tags

  • SDDC

3.94.5. Security

Type Name

basic

basicAuth

3.94.6. Example HTTP request

Request path
/v1/sddcs/validations

3.94.7. Example HTTP response

Response 200
[ {
  "description" : "string",
  "executionStatus" : "One among: IN_PROGRESS, FAILED, COMPLETED, SKIPPED, CANCELLED",
  "id" : "string",
  "resultStatus" : "One among: SUCCEEDED, FAILED, FAILED_WITH_WARNINGS",
  "validationChecks" : [ {
    "description" : "string",
    "errorResponse" : {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ {
        "arguments" : [ "string" ],
        "causes" : [ {
          "message" : "string",
          "type" : "string"
        } ],
        "context" : {
          "string" : "string"
        },
        "errorCode" : "string",
        "message" : "string",
        "nestedErrors" : [ "..." ],
        "referenceToken" : "string",
        "remediationMessage" : "string"
      } ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    },
    "nestedValidationChecks" : [ {
      "description" : "string",
      "errorResponse" : {
        "arguments" : [ "string" ],
        "causes" : [ {
          "message" : "string",
          "type" : "string"
        } ],
        "context" : {
          "string" : "string"
        },
        "errorCode" : "string",
        "message" : "string",
        "nestedErrors" : [ "..." ],
        "referenceToken" : "string",
        "remediationMessage" : "string"
      },
      "nestedValidationChecks" : [ "..." ],
      "resultStatus" : "One among: SUCCEEDED, FAILED",
      "severity" : "One among: WARNING, ERROR, INFO"
    } ],
    "resultStatus" : "One among: SUCCEEDED, FAILED",
    "severity" : "One among: WARNING, ERROR, INFO"
  } ]
} ]
Response 404
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 500
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 501
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.95. Get SDDC specification validation status by ID

GET /v1/sddcs/validations/{id}

3.95.1. Parameters

Type Name Description Schema

Path

id
required

SDDC validation ID

string

3.95.2. Responses

HTTP Code Description Schema

200

Accepted

Validation

400

Bad Request

Validation

404

Not Found

Error

500

Internal Server Error

Error

501

Not Implemented

Error

3.95.3. Consumes

  • application/json

3.95.4. Produces

  • application/json

3.95.5. Tags

  • SDDC

3.95.6. Security

Type Name

basic

basicAuth

3.95.7. Example HTTP request

Request path
/v1/sddcs/validations/string

3.95.8. Example HTTP response

Response 200
{
  "description" : "string",
  "executionStatus" : "One among: IN_PROGRESS, FAILED, COMPLETED, SKIPPED, CANCELLED",
  "id" : "string",
  "resultStatus" : "One among: SUCCEEDED, FAILED, FAILED_WITH_WARNINGS",
  "validationChecks" : [ {
    "description" : "string",
    "errorResponse" : {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ {
        "arguments" : [ "string" ],
        "causes" : [ {
          "message" : "string",
          "type" : "string"
        } ],
        "context" : {
          "string" : "string"
        },
        "errorCode" : "string",
        "message" : "string",
        "nestedErrors" : [ "..." ],
        "referenceToken" : "string",
        "remediationMessage" : "string"
      } ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    },
    "nestedValidationChecks" : [ {
      "description" : "string",
      "errorResponse" : {
        "arguments" : [ "string" ],
        "causes" : [ {
          "message" : "string",
          "type" : "string"
        } ],
        "context" : {
          "string" : "string"
        },
        "errorCode" : "string",
        "message" : "string",
        "nestedErrors" : [ "..." ],
        "referenceToken" : "string",
        "remediationMessage" : "string"
      },
      "nestedValidationChecks" : [ "..." ],
      "resultStatus" : "One among: SUCCEEDED, FAILED",
      "severity" : "One among: WARNING, ERROR, INFO"
    } ],
    "resultStatus" : "One among: SUCCEEDED, FAILED",
    "severity" : "One among: WARNING, ERROR, INFO"
  } ]
}
Response 400
{
  "description" : "string",
  "executionStatus" : "One among: IN_PROGRESS, FAILED, COMPLETED, SKIPPED, CANCELLED",
  "id" : "string",
  "resultStatus" : "One among: SUCCEEDED, FAILED, FAILED_WITH_WARNINGS",
  "validationChecks" : [ {
    "description" : "string",
    "errorResponse" : {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ {
        "arguments" : [ "string" ],
        "causes" : [ {
          "message" : "string",
          "type" : "string"
        } ],
        "context" : {
          "string" : "string"
        },
        "errorCode" : "string",
        "message" : "string",
        "nestedErrors" : [ "..." ],
        "referenceToken" : "string",
        "remediationMessage" : "string"
      } ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    },
    "nestedValidationChecks" : [ {
      "description" : "string",
      "errorResponse" : {
        "arguments" : [ "string" ],
        "causes" : [ {
          "message" : "string",
          "type" : "string"
        } ],
        "context" : {
          "string" : "string"
        },
        "errorCode" : "string",
        "message" : "string",
        "nestedErrors" : [ "..." ],
        "referenceToken" : "string",
        "remediationMessage" : "string"
      },
      "nestedValidationChecks" : [ "..." ],
      "resultStatus" : "One among: SUCCEEDED, FAILED",
      "severity" : "One among: WARNING, ERROR, INFO"
    } ],
    "resultStatus" : "One among: SUCCEEDED, FAILED",
    "severity" : "One among: WARNING, ERROR, INFO"
  } ]
}
Response 404
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 500
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 501
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.96. Cancel SDDC specification validation

DELETE /v1/sddcs/validations/{id}

3.96.1. Description

Cancel the currently running SDDC specification validation

3.96.2. Parameters

Type Name Description Schema

Path

id
required

SDDC validation ID

string

3.96.3. Responses

HTTP Code Description Schema

200

Accepted

boolean

404

Not Found

Error

500

Internal Server Error

Error

3.96.4. Consumes

  • application/json

3.96.5. Produces

  • */*

3.96.6. Tags

  • SDDC

3.96.7. Security

Type Name

basic

basicAuth

3.96.8. Example HTTP request

Request path
/v1/sddcs/validations/string

3.96.9. Example HTTP response

Response 200
true
Response 404
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 500
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.97. Retry SDDC validation

PATCH /v1/sddcs/validations/{id}

3.97.1. Description

Retry a completed SDDC validation

3.97.2. Parameters

Type Name Description Schema

Path

id
required

SDDC validation ID

string

Body

tests
optional

A list of tests to be retried

< string > array

3.97.3. Responses

HTTP Code Description Schema

200

Completed

Validation

405

Method Not Allowed

No Content

500

Internal Server Error

No Content

3.97.4. Consumes

  • application/json

3.97.5. Produces

  • */*

3.97.6. Tags

  • SDDC

3.97.7. Security

Type Name

basic

basicAuth

3.97.8. Example HTTP request

Request path
/v1/sddcs/validations/string
Request body
[ "string" ]

3.97.9. Example HTTP response

Response 200
{
  "description" : "string",
  "executionStatus" : "One among: IN_PROGRESS, FAILED, COMPLETED, SKIPPED, CANCELLED",
  "id" : "string",
  "resultStatus" : "One among: SUCCEEDED, FAILED, FAILED_WITH_WARNINGS",
  "validationChecks" : [ {
    "description" : "string",
    "errorResponse" : {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ {
        "arguments" : [ "string" ],
        "causes" : [ {
          "message" : "string",
          "type" : "string"
        } ],
        "context" : {
          "string" : "string"
        },
        "errorCode" : "string",
        "message" : "string",
        "nestedErrors" : [ "..." ],
        "referenceToken" : "string",
        "remediationMessage" : "string"
      } ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    },
    "nestedValidationChecks" : [ {
      "description" : "string",
      "errorResponse" : {
        "arguments" : [ "string" ],
        "causes" : [ {
          "message" : "string",
          "type" : "string"
        } ],
        "context" : {
          "string" : "string"
        },
        "errorCode" : "string",
        "message" : "string",
        "nestedErrors" : [ "..." ],
        "referenceToken" : "string",
        "remediationMessage" : "string"
      },
      "nestedValidationChecks" : [ "..." ],
      "resultStatus" : "One among: SUCCEEDED, FAILED",
      "severity" : "One among: WARNING, ERROR, INFO"
    } ],
    "resultStatus" : "One among: SUCCEEDED, FAILED",
    "severity" : "One among: WARNING, ERROR, INFO"
  } ]
}

3.98. Retrieve a SDDC

GET /v1/sddcs/{id}

3.98.1. Parameters

Type Name Description Schema

Path

id
required

SDDC ID

string

3.98.2. Responses

HTTP Code Description Schema

200

Accepted

SddcTask

404

Not Found

Error

500

Internal Server Error

Error

3.98.3. Consumes

  • application/json

3.98.4. Produces

  • application/json

3.98.5. Tags

  • SDDC

3.98.6. Security

Type Name

basic

basicAuth

3.98.7. Example HTTP request

Request path
/v1/sddcs/string

3.98.8. Example HTTP response

Response 200
{
  "creationTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "id" : "string",
  "localizableNamePack" : {
    "arguments" : [ "string" ],
    "component" : "string",
    "message" : "string",
    "messageKey" : "string"
  },
  "name" : "string",
  "sddcSubTasks" : [ {
    "creationTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "description" : "string",
    "errors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ {
        "arguments" : [ "string" ],
        "causes" : [ {
          "message" : "string",
          "type" : "string"
        } ],
        "context" : {
          "string" : "string"
        },
        "errorCode" : "string",
        "message" : "string",
        "nestedErrors" : [ "..." ],
        "referenceToken" : "string",
        "remediationMessage" : "string"
      } ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "localizableDescriptionPack" : {
      "arguments" : [ "string" ],
      "component" : "string",
      "message" : "string",
      "messageKey" : "string"
    },
    "localizableNamePack" : {
      "arguments" : [ "string" ],
      "component" : "string",
      "message" : "string",
      "messageKey" : "string"
    },
    "name" : "string",
    "processingStateDescription" : "string",
    "processingStateName" : "string",
    "sddcId" : "123e4567-e89b-42d3-a456-556642440000",
    "status" : "INITIALIZED, COMPLETED_WITH_SUCCESS, COMPLETED_WITH_FAILURE, PREVALIDATION_COMPLETED_WITH_SUCCESS, PREVALIDATION_COMPLETED_WITH_FAILURE, POSTVALIDATION_COMPLETED_WITH_SUCCESS, POSTVALIDATION_COMPLETED_WITH_FAILURE,IN_PROGRESS, PREVALIDATION_IN_PROGRESS, POSTVALIDATION_IN_PROGRESS, INTERNAL_ERROR",
    "updateTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    }
  } ],
  "status" : "One among: IN_PROGRESS, COMPLETED_WITH_SUCCESS, ROLLBACK_SUCCESS, COMPLETED_WITH_FAILURE"
}
Response 404
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 500
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.99. Retry failed SDDC creation

PATCH /v1/sddcs/{id}

3.99.1. Parameters

Type Name Description Schema

Path

id
required

SDDC ID

string

Body

sddcSpec
optional

sddcSpec

SddcSpec

3.99.2. Responses

HTTP Code Description Schema

200

OK

SddcTask

202

Success

SddcTask

404

Not Found

Error

405

Not allowed

Error

500

Internal Server Error

Error

3.99.3. Consumes

  • application/json

3.99.4. Produces

  • application/json

3.99.5. Tags

  • SDDC

3.99.6. Security

Type Name

basic

basicAuth

3.99.7. Example HTTP request

Request path
/v1/sddcs/string
Request body
{
  "adSpec" : {
    "childAdDetails" : {
      "alias" : "string",
      "baseDnGroups" : "string",
      "baseDnUsers" : "string",
      "globalCatalogPort" : 0,
      "name" : "string",
      "port" : 0,
      "serverUrl" : "string"
    },
    "domainControllers" : [ "string" ],
    "groups" : {
      "string" : "string"
    },
    "requireSsl" : true,
    "rootAdDetails" : {
      "alias" : "string",
      "baseDnGroups" : "string",
      "baseDnUsers" : "string",
      "globalCatalogPort" : 0,
      "name" : "string",
      "port" : 0,
      "serverUrl" : "string"
    },
    "skipJoinEsxi" : true,
    "useSubDomainForUsers" : true,
    "users" : {
      "string" : "<<_sddccredentials>>"
    }
  },
  "ceipEnabled" : true,
  "certificatesPassphrase" : "string",
  "clusterSpec" : {
    "clusterEvcMode" : "string",
    "clusterName" : "string",
    "hostFailuresToTolerate" : 0,
    "hostProfileComplianceCheckHour" : 0,
    "hostProfileComplianceCheckMinute" : 0,
    "hosts" : [ "string" ],
    "resourcePoolSpecs" : [ {
      "cpuLimit" : 0,
      "cpuReservationExpandable" : true,
      "cpuReservationMhz" : 0,
      "cpuReservationPercentage" : 0,
      "cpuSharesLevel" : "custom",
      "cpuSharesValue" : 0,
      "memoryLimit" : 0,
      "memoryReservationExpandable" : true,
      "memoryReservationMb" : 0,
      "memoryReservationPercentage" : 0,
      "memorySharesLevel" : "custom",
      "memorySharesValue" : 0,
      "name" : "string",
      "type" : "management"
    } ],
    "vmFolders" : {
      "string" : "string"
    }
  },
  "deploymentEndpointSpec" : {
    "cluster" : "string",
    "datacenter" : "string",
    "resourcePool" : "string",
    "storage" : "string",
    "vcenter" : {
      "address" : "string",
      "password" : "string",
      "username" : "string"
    },
    "vmFolder" : "string",
    "vmFolders" : {
      "string" : "string"
    }
  },
  "dnsSpec" : {
    "domain" : "vmware.com",
    "nameserver" : "172.0.0.4",
    "secondaryNameserver" : "172.0.0.5",
    "subdomain" : "vcf.vmware.com"
  },
  "dvSwitchVersion" : "One among:6.0.0, 6.5.0",
  "dvsSpecs" : [ {
    "dvsName" : "string",
    "mtu" : 0,
    "networks" : "One among:VSAN, VMOTION, PUBLIC, MANAGEMENT, NSX_VTEP, HOSTMANAGEMENT, CLOUD_VENDOR_API, REPLICATION, DATACENTER_NETWORK, NSX_VXLAN, NON_ROUTABLE, CLOUD_VENDOR_API, OOB, CROSS_VPC, UPLINK01, UPLINK02, STORAGE, UDLR, DLR, X_REGION, REGION_SPECIFIC, REMOTE_REGION_SPECIFIC, COMPUTE, MANAGEMENT_VM",
    "niocSpecs" : [ {
      "trafficType" : "One among:VSAN, VMOTION, VIRTUALMACHINE, MANAGEMENT, NFS, VDP, HBR, FAULTTOLERANCE, ISCSI",
      "value" : "string"
    } ],
    "vmnics" : [ "string" ]
  } ],
  "esxLicense" : "string",
  "excludedComponents" : "One among:Foundation, VsphereHostProfiles, LogInsight, NSX, VrealizeNetwork, VSAN, VSANCleanup, VROPS, VRA, DRDeployment, DRConfiguration, ConfigurationBackup, VRB, VRSLCM, Inventory, UMDS, EsxThumbprintValidation, AVN, CEIP, Backup",
  "hostSpecs" : [ {
    "association" : "string",
    "credentials" : {
      "password" : "Admin!23",
      "username" : "root"
    },
    "hostname" : "esx-1",
    "ipAddressPrivate" : {
      "cidr" : "172.0.0.0/24",
      "gateway" : "192.168.0.1",
      "ipAddress" : "192.168.0.123",
      "subnet" : "255.255.255.252"
    },
    "key" : "string",
    "serverId" : "string",
    "sshThumbprint" : "string",
    "sslThumbprint" : "string",
    "vSwitch" : "string",
    "vmknicSpecs" : [ {
      "ipAddress" : "string",
      "macAddress" : "string",
      "portgroup" : "One among:VSAN, VMOTION, PUBLIC, MANAGEMENT, NSX_VTEP, HOSTMANAGEMENT, CLOUD_VENDOR_API, REPLICATION"
    } ],
    "vswitch" : "string"
  } ],
  "managementPoolName" : "string",
  "networkSpecs" : [ {
    "activeUplinks" : [ "string" ],
    "excludeIpAddressRanges" : [ "string" ],
    "excludeIpaddresses" : [ "string" ],
    "gateway" : "string",
    "includeIpAddress" : [ "string" ],
    "includeIpAddressRanges" : [ {
      "endIpAddress" : "192.168.0.128",
      "startIpAddress" : "192.168.0.123"
    } ],
    "mtu" : "string",
    "networkType" : "One among:VSAN, VMOTION, PUBLIC, MANAGEMENT, NSX_VTEP, HOSTMANAGEMENT, CLOUD_VENDOR_API, REPLICATION, DATACENTER_NETWORK, NSX_VXLAN, NON_ROUTABLE, CLOUD_VENDOR_API, OOB, CROSS_VPC, UPLINK01, UPLINK02, STORAGE, UDLR, DLR, X_REGION, REGION_SPECIFIC, REMOTE_REGION_SPECIFIC, COMPUTE, MANAGEMENT_VM",
    "portGroupKey" : "string",
    "standbyUplinks" : [ "string" ],
    "subnet" : "string",
    "subnetMask" : "string",
    "teamingPolicy" : "One among:loadbalance_ip, loadbalance_srcmac, loadbalance_srcid, failover_explicit, loadbalance_loadbased",
    "vlanId" : "string"
  } ],
  "nfsDatastoreName" : "string",
  "nsxSpec" : {
    "adminNsxControllerPassword" : "string",
    "adminNsxManagerPassword" : "string",
    "backupFtpServerAddress" : "string",
    "controllerIPPoolSpec" : {
      "defaultGateway" : "string",
      "endIp" : "string",
      "poolName" : "string",
      "prefix" : "string",
      "startIp" : "string"
    },
    "ftpBackupFolder" : "string",
    "ftpCredentials" : {
      "password" : "Admin!23",
      "username" : "root"
    },
    "ftpPassPhrase" : "string",
    "ftpPort" : 0,
    "license" : "string",
    "logicalSwitches" : [ {
      "controlPlaneMode" : "One among:MULTICAST_MODE, HYBRID_MODE, UNICAST_MODE",
      "name" : "string",
      "networkType" : "One among:VSAN, VMOTION, PUBLIC, MANAGEMENT, NSX_VTEP, HOSTMANAGEMENT, CLOUD_VENDOR_API, REPLICATION, DATACENTER_NETWORK, NSX_VXLAN, NON_ROUTABLE, CLOUD_VENDOR_API, OOB, CROSS_VPC, UPLINK01, UPLINK02, STORAGE, UDLR, DLR, X_REGION, REGION_SPECIFIC, REMOTE_REGION_SPECIFIC, COMPUTE, MANAGEMENT_VM",
      "transportZoneId" : "string"
    } ],
    "multicastRangeBegin" : "string",
    "multicastRangeEnd" : "string",
    "nsxBgpSpec" : {
      "defaultPassword" : "string",
      "localAutonomousSystem" : 0,
      "nsxEdgeBgpSpecs" : [ {
        "edgeType" : "One among:PSC_LB, MANAGEMENT_LB, ESG, DLR, UDLR",
        "enableGracefulRestart" : true,
        "learnFrom" : [ "string" ],
        "neighbours" : [ {
          "autonomousSystem" : 0,
          "forwardingIp" : "192.168.0.123",
          "holdDownTimeSeconds" : 0,
          "keepAliveTimeSeconds" : 0,
          "neighbourIp" : "192.168.0.123",
          "password" : "string",
          "protocolIp" : "192.168.0.123",
          "weight" : 0
        } ]
      } ],
      "skipBgpValidation" : true
    },
    "nsxControllerVmNamesPrefix" : "string",
    "nsxEdgePassword" : "string",
    "nsxEdgeSpecs" : [ {
      "edgeName" : "string",
      "edgeSize" : "One among:compact, large, quadlarge, xlarge",
      "edgeType" : "One among:PSC_LB, MANAGEMENT_LB, ESG, DLR, UDLR",
      "poolSpecs" : [ {
        "memberSpecs" : [ {
          "ipAddress" : "string",
          "monitorPort" : 0,
          "name" : "string"
        } ],
        "name" : "string"
      } ],
      "shortHostname" : "string",
      "vnics" : [ {
        "attachToLogicalSwitch" : true,
        "disconnected" : true,
        "name" : "string",
        "networkType" : "One among:VSAN, VMOTION, PUBLIC, MANAGEMENT, NSX_VTEP, HOSTMANAGEMENT, CLOUD_VENDOR_API, REPLICATION, DATACENTER_NETWORK, NSX_VXLAN, NON_ROUTABLE, CLOUD_VENDOR_API, OOB, CROSS_VPC, UPLINK01, UPLINK02, STORAGE, UDLR, DLR, X_REGION, REGION_SPECIFIC, REMOTE_REGION_SPECIFIC, COMPUTE, MANAGEMENT_VM",
        "primaryIpAddress" : "string",
        "secondaryIpAddresses" : [ "string" ],
        "type" : "One among:uplink, internal",
        "useForDefaultRoute" : true,
        "useForDynamicRouterConfiguration" : true
      } ]
    } ],
    "nsxId" : "string",
    "nsxManagerHostname" : "string",
    "nsxManagerIp" : "string",
    "nsxSegmentRangeBegin" : "string",
    "nsxSegmentRangeEnd" : "string",
    "nsxVxlanSpec" : {
      "excludeIpAddressRanges" : [ "string" ],
      "gateway" : "string",
      "poolEndAddress" : "string",
      "poolStartAddress" : "string",
      "subnetWithCidr" : "string",
      "teamingPolicy" : "FAILOVER_ORDER",
      "vtepVmknicCount" : 0,
      "vxlanCluster" : "string",
      "vxlanDvs" : "string",
      "vxlanMtu" : "string",
      "vxlanPoolName" : "string",
      "vxlanVlanId" : "string"
    },
    "privilegedNsxManagerPassword" : "string",
    "transferProtocol" : "SFTP",
    "transportZones" : [ {
      "controlPlaneMode" : "One among:MULTICAST_MODE, HYBRID_MODE, UNICAST_MODE",
      "id" : "universal-transport-zone",
      "name" : "string",
      "universal" : true
    } ],
    "universalMulticastRangeBegin" : "string",
    "universalMulticastRangeEnd" : "string",
    "universalSegmentRangeBegin" : "string",
    "universalSegmentRangeEnd" : "string"
  },
  "ntpServers" : [ "string" ],
  "pscLoadBalancerHostname" : "mgmt-psc",
  "pscLoadBalancerIpAddress" : "string",
  "pscSpecs" : [ {
    "adminUserSsoPassword" : "string",
    "automationUserSsoPassword" : "string",
    "automationUserSsoUsername" : "string",
    "pscHostName" : "string",
    "pscId" : "string",
    "pscIp" : "string",
    "pscSsoSpec" : {
      "adDomain" : "string",
      "adPassword" : "string",
      "adUsername" : "string",
      "isJoinSsoDomain" : true,
      "replicationPartner" : "string",
      "ssoDomain" : "string",
      "ssoSiteName" : "string"
    },
    "rootPscPassword" : "string"
  } ],
  "remoteSiteSpec" : {
    "clusterName" : "string",
    "datacenterName" : "string",
    "logicalSwitchNames" : [ "string" ],
    "nsxCredentials" : {
      "password" : "Admin!23",
      "username" : "root"
    },
    "nsxIp" : "string",
    "placeholderDatastore" : "string",
    "pscAddress" : "string",
    "remoteRegionVmFolders" : {
      "string" : "string"
    },
    "rpoMinutes" : 0,
    "siteName" : "string",
    "srmIp" : "string",
    "vcCredentials" : {
      "password" : "Admin!23",
      "username" : "root"
    },
    "vcMgmtIp" : "string",
    "vrIp" : "string",
    "vrReplicationIp" : "string",
    "vrRootPassword" : "string",
    "vrliAdminPassword" : "string",
    "vrliLoadBalancerHostname" : "string",
    "vrliNodesAddresses" : [ "string" ],
    "vrliRootPassword" : "string"
  },
  "sddcId" : "sfo01-workflowspec-ems",
  "sddcManagerSpec" : {
    "hostname" : "string",
    "ipAddress" : "string",
    "licenseKey" : "string",
    "netmask" : "string",
    "restApiCredentials" : {
      "password" : "Admin!23",
      "username" : "root"
    },
    "rootUserCredentials" : {
      "password" : "Admin!23",
      "username" : "root"
    },
    "secondUserCredentials" : {
      "password" : "Admin!23",
      "username" : "root"
    }
  },
  "selfSignedCertificates" : "string",
  "shouldCleanupVsan" : false,
  "skipEsxThumbprintValidation" : true,
  "smtpSpec" : {
    "credentials" : {
      "password" : "Admin!23",
      "username" : "root"
    },
    "isSecureConnection" : true,
    "port" : 0,
    "requiresAuthentication" : true,
    "server" : "string",
    "useTlsEncryption" : true
  },
  "srmSpec" : {
    "dbPassword" : "string",
    "licenseKey" : "string",
    "srmAdminCredentials" : {
      "password" : "Admin!23",
      "username" : "root"
    },
    "srmHostname" : "string",
    "srmRootCredentials" : {
      "password" : "Admin!23",
      "username" : "root"
    },
    "srmVmAddress" : "string",
    "srmVmName" : "string"
  },
  "taskName" : "string",
  "umdsSpec" : {
    "address" : "string",
    "user" : "string",
    "userPassword" : "string"
  },
  "vcenterSpec" : {
    "licenseFile" : "string",
    "rootVcenterPassword" : "string",
    "vcenterHostname" : "string",
    "vcenterIp" : "string",
    "vcenterNetmask" : "string",
    "vmSize" : "One among:xlarge, large, medium, small, tiny"
  },
  "vrSpec" : {
    "ipPoolName" : "string",
    "rootPassword" : "string",
    "vrIp" : "string",
    "vrReplicationIp" : "string",
    "vrShortHostName" : "string"
  },
  "vraDeploymentSpec" : {
    "brandingSpec" : {
      "backgroundColor" : "string",
      "companyName" : "string",
      "contactLink" : "string",
      "copyright" : "string",
      "privacyPolicyLink" : "string",
      "productName" : "string",
      "textColor" : "string"
    },
    "enableVroMultiTenancy" : true,
    "fabricGroupNames" : [ "string" ],
    "iaasTemplateName" : "string",
    "localAdministratorPassword" : "string",
    "localDefaultTenantAdmin" : {
      "email" : "string",
      "firstName" : "string",
      "lastName" : "string",
      "password" : "string",
      "username" : "string"
    },
    "msLbHostName" : "string",
    "msLbIpAddress" : "string",
    "msSqlServer" : {
      "address" : "string",
      "databaseName" : "string",
      "hostname" : "string",
      "instanceName" : "string",
      "password" : "string",
      "port" : 0,
      "username" : "string",
      "vmName" : "string"
    },
    "skipWindowsVms" : true,
    "systemAdminPassword" : "string",
    "tenantSpec" : {
      "email" : "string",
      "name" : "string",
      "url" : "string",
      "vraTenantAdministratorSpec" : {
        "email" : "string",
        "firstName" : "string",
        "lastName" : "string",
        "password" : "string",
        "username" : "string"
      }
    },
    "vraEmailProviderSpecs" : [ {
      "acceptSelfSignedCertificates" : true,
      "emailAddress" : "string",
      "inboundDirection" : "One among: INBOUND, OUTBOUND",
      "name" : "string",
      "password" : "string",
      "port" : 0,
      "protocol" : "One among: IMAP, SMTP",
      "serverAddress" : "string",
      "useSsl" : true,
      "username" : "string"
    } ],
    "vraLbHostName" : "string",
    "vraLbIpAddress" : "string",
    "vraNodeLicense" : "string",
    "vraRootPassword" : "string",
    "vraVms" : [ {
      "hostname" : "string",
      "ipAddress" : "string",
      "isPrimary" : true,
      "name" : "string",
      "type" : "string"
    } ],
    "webLbHostName" : "string",
    "webLbIpAddress" : "string"
  },
  "vrbDeploymentSpec" : {
    "collectorNode" : {
      "hostname" : "string",
      "ipAddress" : "string",
      "vmName" : "string"
    },
    "currency" : "string",
    "license" : "string",
    "serverNode" : {
      "hostname" : "string",
      "ipAddress" : "string",
      "vmName" : "string"
    },
    "sshPassword" : "string"
  },
  "vrliDeploymentSpec" : {
    "adminEmail" : "string",
    "adminPassword" : "string",
    "archiveLocation" : "string",
    "eventForwardingSiteTag" : "string",
    "license" : "string",
    "loadBalancerHostname" : "string",
    "loadBalancerIpAddress" : "string",
    "networkType" : "string",
    "notificationEmails" : [ "string" ],
    "senderSpec" : {
      "email" : "string",
      "name" : "string"
    },
    "sshPassword" : "string",
    "vmSize" : "One among:large, medium, small, xsmall",
    "vrliNodeSpecs" : [ {
      "hostname" : "string",
      "ipAddress" : "string"
    } ]
  },
  "vropsDeploymentSpec" : {
    "adminPassword" : "string",
    "collectorSize" : "One among:smallrc, largerc",
    "lbHostName" : "string",
    "lbIpAddress" : "string",
    "licenseKey" : "string",
    "nodeSize" : "One among:xsmall, small, medium, large, extra_large",
    "nodeSpecs" : [ {
      "hostname" : "string",
      "ipAddress" : "string",
      "vmName" : "string",
      "vropsNodeType" : "One among:MASTER, REPLICA, DATA, REMOTE_COLLECTOR"
    } ],
    "rebootVmAfterHddExtending" : true,
    "senderSpec" : {
      "email" : "string",
      "name" : "string"
    },
    "skipHddExtending" : true,
    "snmpReadCommunity" : "string",
    "vropsRootPassword" : "string"
  },
  "vrslcmDeploymentSpec" : {
    "apiPassword" : "string",
    "fqdn" : "vrslcm.vrack.vsphere.local",
    "ipAddress" : "string",
    "sshPassword" : "string"
  },
  "vsanSpec" : {
    "datastoreName" : "string",
    "hclFile" : "string",
    "licenseFile" : "string",
    "vsanDedup" : true,
    "vsanName" : "string"
  },
  "vxManagerSpec" : {
    "defaultAdminUserCredentials" : {
      "password" : "Admin!23",
      "username" : "root"
    },
    "defaultRootUserCredentials" : {
      "password" : "Admin!23",
      "username" : "root"
    },
    "vxManagerHostName" : "string"
  },
  "vxRailSpec" : {
    "vxRailObjectNames" : {
      "string" : "string"
    }
  }
}

3.99.8. Example HTTP response

Response 200
{
  "creationTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "id" : "string",
  "localizableNamePack" : {
    "arguments" : [ "string" ],
    "component" : "string",
    "message" : "string",
    "messageKey" : "string"
  },
  "name" : "string",
  "sddcSubTasks" : [ {
    "creationTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "description" : "string",
    "errors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ {
        "arguments" : [ "string" ],
        "causes" : [ {
          "message" : "string",
          "type" : "string"
        } ],
        "context" : {
          "string" : "string"
        },
        "errorCode" : "string",
        "message" : "string",
        "nestedErrors" : [ "..." ],
        "referenceToken" : "string",
        "remediationMessage" : "string"
      } ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "localizableDescriptionPack" : {
      "arguments" : [ "string" ],
      "component" : "string",
      "message" : "string",
      "messageKey" : "string"
    },
    "localizableNamePack" : {
      "arguments" : [ "string" ],
      "component" : "string",
      "message" : "string",
      "messageKey" : "string"
    },
    "name" : "string",
    "processingStateDescription" : "string",
    "processingStateName" : "string",
    "sddcId" : "123e4567-e89b-42d3-a456-556642440000",
    "status" : "INITIALIZED, COMPLETED_WITH_SUCCESS, COMPLETED_WITH_FAILURE, PREVALIDATION_COMPLETED_WITH_SUCCESS, PREVALIDATION_COMPLETED_WITH_FAILURE, POSTVALIDATION_COMPLETED_WITH_SUCCESS, POSTVALIDATION_COMPLETED_WITH_FAILURE,IN_PROGRESS, PREVALIDATION_IN_PROGRESS, POSTVALIDATION_IN_PROGRESS, INTERNAL_ERROR",
    "updateTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    }
  } ],
  "status" : "One among: IN_PROGRESS, COMPLETED_WITH_SUCCESS, ROLLBACK_SUCCESS, COMPLETED_WITH_FAILURE"
}
Response 202
{
  "creationTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "id" : "string",
  "localizableNamePack" : {
    "arguments" : [ "string" ],
    "component" : "string",
    "message" : "string",
    "messageKey" : "string"
  },
  "name" : "string",
  "sddcSubTasks" : [ {
    "creationTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "description" : "string",
    "errors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ {
        "arguments" : [ "string" ],
        "causes" : [ {
          "message" : "string",
          "type" : "string"
        } ],
        "context" : {
          "string" : "string"
        },
        "errorCode" : "string",
        "message" : "string",
        "nestedErrors" : [ "..." ],
        "referenceToken" : "string",
        "remediationMessage" : "string"
      } ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "localizableDescriptionPack" : {
      "arguments" : [ "string" ],
      "component" : "string",
      "message" : "string",
      "messageKey" : "string"
    },
    "localizableNamePack" : {
      "arguments" : [ "string" ],
      "component" : "string",
      "message" : "string",
      "messageKey" : "string"
    },
    "name" : "string",
    "processingStateDescription" : "string",
    "processingStateName" : "string",
    "sddcId" : "123e4567-e89b-42d3-a456-556642440000",
    "status" : "INITIALIZED, COMPLETED_WITH_SUCCESS, COMPLETED_WITH_FAILURE, PREVALIDATION_COMPLETED_WITH_SUCCESS, PREVALIDATION_COMPLETED_WITH_FAILURE, POSTVALIDATION_COMPLETED_WITH_SUCCESS, POSTVALIDATION_COMPLETED_WITH_FAILURE,IN_PROGRESS, PREVALIDATION_IN_PROGRESS, POSTVALIDATION_IN_PROGRESS, INTERNAL_ERROR",
    "updateTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    }
  } ],
  "status" : "One among: IN_PROGRESS, COMPLETED_WITH_SUCCESS, ROLLBACK_SUCCESS, COMPLETED_WITH_FAILURE"
}
Response 404
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 405
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 500
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.100. Get backup configuration used to backup NSX and SDDC manager

GET /v1/system/backup-configuration

3.100.1. Responses

HTTP Code Description Schema

200

Ok

BackupConfiguration

400

Bad Request

Error

500

Internal server error

Error

3.100.2. Consumes

  • application/json

3.100.3. Produces

  • application/json

3.100.4. Tags

  • BackupRestore

3.100.5. Security

Type Name

basic

basicAuth

3.100.6. Example HTTP request

Request path
/v1/system/backup-configuration

3.100.7. Example HTTP response

Response 200
{
  "backupLocations" : [ {
    "directoryPath" : "string",
    "password" : "string",
    "port" : 0,
    "protocol" : "SFTP",
    "server" : "string",
    "sshFingerprint" : "string",
    "username" : "string"
  } ],
  "encryption" : {
    "passphrase" : "string"
  },
  "isConfigured" : true
}
Response 400
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 500
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.101. Configure backup settings to backup NSX and SDDC manager

PUT /v1/system/backup-configuration

3.101.1. Parameters

Type Name Description Schema

Header

privileged-password
required

privileged-password

string

Header

privileged-username
required

privileged-username

string

Body

backupConfigurationSpec
required

backupConfigurationSpec

BackupConfigurationSpec

3.101.2. Responses

HTTP Code Description Schema

200

OK

Task

202

Accepted

Task

400

Bad Request

Error

500

Internal server error

Error

3.101.3. Consumes

  • application/json

3.101.4. Produces

  • application/json

3.101.5. Tags

  • BackupRestore

3.101.6. Security

Type Name

basic

basicAuth

3.101.7. Example HTTP request

Request path
/v1/system/backup-configuration
Request header
privileged-username:"string"
Request body
{
  "backupLocations" : [ {
    "directoryPath" : "string",
    "password" : "string",
    "port" : 0,
    "protocol" : "SFTP",
    "server" : "string",
    "sshFingerprint" : "string",
    "username" : "string"
  } ],
  "encryption" : {
    "passphrase" : "string"
  }
}

3.101.8. Example HTTP response

Response 200
{
  "completionTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "creationTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "errors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "id" : "string",
  "isCancellable" : true,
  "name" : "string",
  "resources" : [ {
    "fqdn" : "string",
    "name" : "string",
    "resourceId" : "string",
    "type" : "string"
  } ],
  "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
  "subTasks" : [ {
    "completionTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "creationTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "description" : "string",
    "errors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "name" : "string",
    "resources" : [ {
      "fqdn" : "string",
      "name" : "string",
      "resourceId" : "string",
      "type" : "string"
    } ],
    "stages" : [ {
      "completionTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "creationTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "description" : "string",
      "name" : "string",
      "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
      "type" : "string"
    } ],
    "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
    "type" : "string"
  } ],
  "type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}
Response 202
{
  "completionTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "creationTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "errors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "id" : "string",
  "isCancellable" : true,
  "name" : "string",
  "resources" : [ {
    "fqdn" : "string",
    "name" : "string",
    "resourceId" : "string",
    "type" : "string"
  } ],
  "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
  "subTasks" : [ {
    "completionTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "creationTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "description" : "string",
    "errors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "name" : "string",
    "resources" : [ {
      "fqdn" : "string",
      "name" : "string",
      "resourceId" : "string",
      "type" : "string"
    } ],
    "stages" : [ {
      "completionTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "creationTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "description" : "string",
      "name" : "string",
      "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
      "type" : "string"
    } ],
    "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
    "type" : "string"
  } ],
  "type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}
Response 400
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 500
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.102. Edit backup configuration to backup NSX and SDDC manager

PATCH /v1/system/backup-configuration

3.102.1. Parameters

Type Name Description Schema

Header

privileged-password
required

privileged-password

string

Header

privileged-username
required

privileged-username

string

Body

backupConfigurationSpec
required

backupConfigurationSpec

BackupConfigurationSpec

3.102.2. Responses

HTTP Code Description Schema

200

OK

Task

202

Accepted

Task

400

Bad Request

Error

500

Internal server error

Error

3.102.3. Consumes

  • application/json

3.102.4. Produces

  • application/json

3.102.5. Tags

  • BackupRestore

3.102.6. Security

Type Name

basic

basicAuth

3.102.7. Example HTTP request

Request path
/v1/system/backup-configuration
Request header
privileged-username:"string"
Request body
{
  "backupLocations" : [ {
    "directoryPath" : "string",
    "password" : "string",
    "port" : 0,
    "protocol" : "SFTP",
    "server" : "string",
    "sshFingerprint" : "string",
    "username" : "string"
  } ],
  "encryption" : {
    "passphrase" : "string"
  }
}

3.102.8. Example HTTP response

Response 200
{
  "completionTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "creationTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "errors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "id" : "string",
  "isCancellable" : true,
  "name" : "string",
  "resources" : [ {
    "fqdn" : "string",
    "name" : "string",
    "resourceId" : "string",
    "type" : "string"
  } ],
  "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
  "subTasks" : [ {
    "completionTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "creationTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "description" : "string",
    "errors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "name" : "string",
    "resources" : [ {
      "fqdn" : "string",
      "name" : "string",
      "resourceId" : "string",
      "type" : "string"
    } ],
    "stages" : [ {
      "completionTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "creationTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "description" : "string",
      "name" : "string",
      "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
      "type" : "string"
    } ],
    "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
    "type" : "string"
  } ],
  "type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}
Response 202
{
  "completionTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "creationTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "errors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "id" : "string",
  "isCancellable" : true,
  "name" : "string",
  "resources" : [ {
    "fqdn" : "string",
    "name" : "string",
    "resourceId" : "string",
    "type" : "string"
  } ],
  "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
  "subTasks" : [ {
    "completionTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "creationTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "description" : "string",
    "errors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "name" : "string",
    "resources" : [ {
      "fqdn" : "string",
      "name" : "string",
      "resourceId" : "string",
      "type" : "string"
    } ],
    "stages" : [ {
      "completionTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "creationTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "description" : "string",
      "name" : "string",
      "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
      "type" : "string"
    } ],
    "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
    "type" : "string"
  } ],
  "type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}
Response 400
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 500
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.103. Get CEIP status

GET /v1/system/ceip

3.103.1. Description

Get CEIP status and instance id

3.103.2. Responses

HTTP Code Description Schema

200

Ok

Ceip

500

InternalServerError

Error

3.103.3. Consumes

  • application/json

3.103.4. Produces

  • application/json

3.103.5. Tags

  • CEIP

  • System

3.103.6. Security

Type Name

basic

basicAuth

3.103.7. Example HTTP request

Request path
/v1/system/ceip

3.103.8. Example HTTP response

Response 200
{
  "instanceId" : "3f39d4a1-78d2-11e8-af85-f1cf26258cdc",
  "status" : "One among: ENABLED, DISABLED, ENABLING, DISABLING, ENABLING_FAILED, DISABLING_FAILED"
}
Response 500
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.104. Opt-in or Opt-out of CEIP

PATCH /v1/system/ceip

3.104.1. Description

Opt-in or Opt-out of CEIP

3.104.2. Parameters

Type Name Description Schema

Body

ceipUpdateSpec
required

Required action for CEIP.

CeipUpdateSpec

3.104.3. Responses

HTTP Code Description Schema

200

OK

Task

202

Accepted

Task

400

Bad Request

Error

409

The request could not be completed due to a conflict with the current state

Error

500

InternalServerError

Error

3.104.4. Consumes

  • application/json

3.104.5. Produces

  • application/json

3.104.6. Tags

  • CEIP

  • System

3.104.7. Security

Type Name

basic

basicAuth

3.104.8. Example HTTP request

Request path
/v1/system/ceip
Request body
{
  "status" : "One among: ENABLE, DISABLE"
}

3.104.9. Example HTTP response

Response 200
{
  "completionTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "creationTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "errors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "id" : "string",
  "isCancellable" : true,
  "name" : "string",
  "resources" : [ {
    "fqdn" : "string",
    "name" : "string",
    "resourceId" : "string",
    "type" : "string"
  } ],
  "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
  "subTasks" : [ {
    "completionTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "creationTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "description" : "string",
    "errors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "name" : "string",
    "resources" : [ {
      "fqdn" : "string",
      "name" : "string",
      "resourceId" : "string",
      "type" : "string"
    } ],
    "stages" : [ {
      "completionTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "creationTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "description" : "string",
      "name" : "string",
      "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
      "type" : "string"
    } ],
    "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
    "type" : "string"
  } ],
  "type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}
Response 202
{
  "completionTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "creationTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "errors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "id" : "string",
  "isCancellable" : true,
  "name" : "string",
  "resources" : [ {
    "fqdn" : "string",
    "name" : "string",
    "resourceId" : "string",
    "type" : "string"
  } ],
  "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
  "subTasks" : [ {
    "completionTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "creationTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "description" : "string",
    "errors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "name" : "string",
    "resources" : [ {
      "fqdn" : "string",
      "name" : "string",
      "resourceId" : "string",
      "type" : "string"
    } ],
    "stages" : [ {
      "completionTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "creationTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "description" : "string",
      "name" : "string",
      "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
      "type" : "string"
    } ],
    "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
    "type" : "string"
  } ],
  "type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}
Response 400
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 409
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 500
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.105. Precheck System

POST /v1/system/prechecks

3.105.1. Description

Perform precheck of resource(ex: Domain, Cluster). If only resource is specified, all resources/software components under it are included. If resource(Domain, Cluster etc) and specific resources/software components are provided, only those are included in precheck

3.105.2. Parameters

Type Name Description Schema

Body

precheckSpec
required

Precheck System Spec

PrecheckSpec

3.105.3. Responses

HTTP Code Description Schema

200

OK

Task

202

Accepted

Task

400

Bad Request

Error

500

Internal Server Error

Error

3.105.4. Consumes

  • application/json

3.105.5. Produces

  • application/json

3.105.6. Tags

  • SystemPrechecks

3.105.7. Security

Type Name

basic

basicAuth

3.105.8. Example HTTP request

Request path
/v1/system/prechecks
Request body
{
  "resources" : [ {
    "fqdn" : "string",
    "name" : "string",
    "resourceId" : "string",
    "type" : "string"
  } ]
}

3.105.9. Example HTTP response

Response 200
{
  "completionTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "creationTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "errors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "id" : "string",
  "isCancellable" : true,
  "name" : "string",
  "resources" : [ {
    "fqdn" : "string",
    "name" : "string",
    "resourceId" : "string",
    "type" : "string"
  } ],
  "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
  "subTasks" : [ {
    "completionTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "creationTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "description" : "string",
    "errors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "name" : "string",
    "resources" : [ {
      "fqdn" : "string",
      "name" : "string",
      "resourceId" : "string",
      "type" : "string"
    } ],
    "stages" : [ {
      "completionTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "creationTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "description" : "string",
      "name" : "string",
      "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
      "type" : "string"
    } ],
    "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
    "type" : "string"
  } ],
  "type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}
Response 202
{
  "completionTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "creationTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "errors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "id" : "string",
  "isCancellable" : true,
  "name" : "string",
  "resources" : [ {
    "fqdn" : "string",
    "name" : "string",
    "resourceId" : "string",
    "type" : "string"
  } ],
  "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
  "subTasks" : [ {
    "completionTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "creationTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "description" : "string",
    "errors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "name" : "string",
    "resources" : [ {
      "fqdn" : "string",
      "name" : "string",
      "resourceId" : "string",
      "type" : "string"
    } ],
    "stages" : [ {
      "completionTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "creationTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "description" : "string",
      "name" : "string",
      "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
      "type" : "string"
    } ],
    "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
    "type" : "string"
  } ],
  "type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}
Response 400
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 500
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.106. Get Precheck Task by ID

GET /v1/system/prechecks/tasks/{id}

3.106.1. Description

Monitor the progress of precheck task by the precheck task ID

3.106.2. Parameters

Type Name Description Schema

Path

id
required

Precheck Task ID

string

3.106.3. Responses

HTTP Code Description Schema

200

Ok

Task

404

Precheck Task Not Found

Error

500

Internal Server Error

Error

3.106.4. Consumes

  • application/json

3.106.5. Produces

  • application/json

3.106.6. Tags

  • SystemPrechecks

3.106.7. Security

Type Name

basic

basicAuth

3.106.8. Example HTTP request

Request path
/v1/system/prechecks/tasks/string

3.106.9. Example HTTP response

Response 200
{
  "completionTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "creationTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "errors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "id" : "string",
  "isCancellable" : true,
  "name" : "string",
  "resources" : [ {
    "fqdn" : "string",
    "name" : "string",
    "resourceId" : "string",
    "type" : "string"
  } ],
  "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
  "subTasks" : [ {
    "completionTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "creationTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "description" : "string",
    "errors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "name" : "string",
    "resources" : [ {
      "fqdn" : "string",
      "name" : "string",
      "resourceId" : "string",
      "type" : "string"
    } ],
    "stages" : [ {
      "completionTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "creationTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "description" : "string",
      "name" : "string",
      "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
      "type" : "string"
    } ],
    "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
    "type" : "string"
  } ],
  "type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}
Response 404
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 500
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.107. Get Depot Settings

GET /v1/system/settings/depot

3.107.1. Description

Get the Depot Settings, In a fresh setup, this would be empty

3.107.2. Responses

HTTP Code Description Schema

200

Ok

DepotSettings

500

Internal Server Error

Error

3.107.3. Consumes

  • application/json

3.107.4. Produces

  • application/json

3.107.5. Tags

  • DepotSettings

3.107.6. Security

Type Name

basic

basicAuth

3.107.7. Example HTTP request

Request path
/v1/system/settings/depot

3.107.8. Example HTTP response

Response 200
{
  "vmwareAccount" : {
    "password" : "string",
    "username" : "string"
  }
}
Response 500
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.108. Update Depot Settings

PUT /v1/system/settings/depot

3.108.1. Description

Update Depot Settings. Depot Settings can be updated with VMware Depot Account

3.108.2. Parameters

Type Name Description Schema

Body

depotSettings
required

Depot Settings

DepotSettings

3.108.3. Responses

HTTP Code Description Schema

200

Ok

DepotSettings

400

Bad Request

Error

500

Internal Server Error

Error

3.108.4. Consumes

  • application/json

3.108.5. Produces

  • application/json

3.108.6. Tags

  • DepotSettings

3.108.7. Security

Type Name

basic

basicAuth

3.108.8. Example HTTP request

Request path
/v1/system/settings/depot
Request body
{
  "vmwareAccount" : {
    "password" : "string",
    "username" : "string"
  }
}

3.108.9. Example HTTP response

Response 200
{
  "vmwareAccount" : {
    "password" : "string",
    "username" : "string"
  }
}
Response 400
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 500
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.109. Get the Upgradables

GET /v1/system/upgradables

3.109.1. Description

Fetches the list of Upgradables in the System. Only one Upgradable becomes AVAILABLE for Upgrade. The Upgradables provides information that can be use for Precheck API and also in the actual Upgrade API call.

3.109.2. Responses

HTTP Code Description Schema

200

Ok

PageOfUpgradable

500

Internal Server Error

Error

3.109.3. Consumes

  • application/json

3.109.4. Produces

  • application/json

3.109.5. Tags

  • Upgradables

3.109.6. Security

Type Name

basic

basicAuth

3.109.7. Example HTTP request

Request path
/v1/system/upgradables

3.109.8. Example HTTP response

Response 200
{
  "elements" : [ {
    "bundleId" : "string",
    "bundleType" : "string",
    "resource" : {
      "fqdn" : "string",
      "name" : "string",
      "resourceId" : "string",
      "type" : "string"
    },
    "softwareComponents" : [ {
      "id" : "string",
      "type" : "string"
    } ],
    "status" : "string"
  } ]
}
Response 500
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.110. Get the Tasks

GET /v1/tasks

3.110.1. Description

Get the Tasks

3.110.2. Parameters

Type Name Description Schema

Query

limit
optional

The number of elements to be returned in the result

integer (int32)

Query

resourceId
optional

resourceId

string

Query

resourceType
optional

resourceType

string

Query

taskStatus
optional

taskStatus

string

Query

taskType
optional

taskType

string

3.110.3. Responses

HTTP Code Description Schema

200

Returns the list of tasks.

PageOfTask

500

Unexpected error

Error

3.110.4. Consumes

  • application/json

3.110.5. Produces

  • application/json

3.110.6. Tags

  • Tasks

3.110.7. Security

Type Name

basic

basicAuth

3.110.8. Example HTTP request

Request path
/v1/tasks

3.110.9. Example HTTP response

Response 200
{
  "elements" : [ {
    "completionTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "creationTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "errors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ {
        "arguments" : [ "string" ],
        "causes" : [ {
          "message" : "string",
          "type" : "string"
        } ],
        "context" : {
          "string" : "string"
        },
        "errorCode" : "string",
        "message" : "string",
        "nestedErrors" : [ "..." ],
        "referenceToken" : "string",
        "remediationMessage" : "string"
      } ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "id" : "string",
    "isCancellable" : true,
    "name" : "string",
    "resources" : [ {
      "fqdn" : "string",
      "name" : "string",
      "resourceId" : "string",
      "type" : "string"
    } ],
    "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
    "subTasks" : [ {
      "completionTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "creationTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "description" : "string",
      "errors" : [ {
        "arguments" : [ "string" ],
        "causes" : [ {
          "message" : "string",
          "type" : "string"
        } ],
        "context" : {
          "string" : "string"
        },
        "errorCode" : "string",
        "message" : "string",
        "nestedErrors" : [ "..." ],
        "referenceToken" : "string",
        "remediationMessage" : "string"
      } ],
      "name" : "string",
      "resources" : [ {
        "fqdn" : "string",
        "name" : "string",
        "resourceId" : "string",
        "type" : "string"
      } ],
      "stages" : [ {
        "completionTimestamp" : {
          "epochSecond" : 0,
          "nano" : 0
        },
        "creationTimestamp" : {
          "epochSecond" : 0,
          "nano" : 0
        },
        "description" : "string",
        "name" : "string",
        "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
        "type" : "string"
      } ],
      "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
      "type" : "string"
    } ],
    "type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
  } ]
}
Response 500
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.111. Get a Task

GET /v1/tasks/{id}

3.111.1. Description

Get a Task by ID, if it exists

3.111.2. Parameters

Type Name Description Schema

Path

id
required

Task id to retrieve

string

3.111.3. Responses

HTTP Code Description Schema

200

A task object.

Task

404

Task not found

Error

500

Unexpected error

Error

3.111.4. Consumes

  • application/json

3.111.5. Produces

  • application/json

3.111.6. Tags

  • Tasks

3.111.7. Security

Type Name

basic

basicAuth

3.111.8. Example HTTP request

Request path
/v1/tasks/string

3.111.9. Example HTTP response

Response 200
{
  "completionTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "creationTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "errors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "id" : "string",
  "isCancellable" : true,
  "name" : "string",
  "resources" : [ {
    "fqdn" : "string",
    "name" : "string",
    "resourceId" : "string",
    "type" : "string"
  } ],
  "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
  "subTasks" : [ {
    "completionTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "creationTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "description" : "string",
    "errors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "name" : "string",
    "resources" : [ {
      "fqdn" : "string",
      "name" : "string",
      "resourceId" : "string",
      "type" : "string"
    } ],
    "stages" : [ {
      "completionTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "creationTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "description" : "string",
      "name" : "string",
      "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
      "type" : "string"
    } ],
    "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
    "type" : "string"
  } ],
  "type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}
Response 404
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 500
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.112. Cancel a Task

DELETE /v1/tasks/{id}

3.112.1. Description

Cancel a Task by ID, if it exists

3.112.2. Parameters

Type Name Description Schema

Path

id
required

Task id for cancelling

string

3.112.3. Responses

HTTP Code Description Schema

200

Task was cancelled successfully.

No Content

404

Task not found

Error

409

Task can not be cancelled. Only a IN_PROGRESS task can be cancelled.

Error

500

Unexpected error

Error

3.112.4. Consumes

  • application/json

3.112.5. Produces

  • */*

3.112.6. Tags

  • Tasks

3.112.7. Security

Type Name

basic

basicAuth

3.112.8. Example HTTP request

Request path
/v1/tasks/string

3.112.9. Example HTTP response

Response 404
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 409
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 500
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.113. Retry a Task

PATCH /v1/tasks/{id}

3.113.1. Description

Retry a failed Task by ID, if it exists

3.113.2. Parameters

Type Name Description Schema

Path

id
required

Task id retry

string

3.113.3. Responses

HTTP Code Description Schema

200

Task was retried successfully.

No Content

404

Task not found

Error

409

Task can not be retried. Only a failed Task can be retried.

Error

500

Unexpected error

Error

3.113.4. Consumes

  • application/json

3.113.5. Produces

  • */*

3.113.6. Tags

  • Tasks

3.113.7. Security

Type Name

basic

basicAuth

3.113.8. Example HTTP request

Request path
/v1/tasks/string

3.113.9. Example HTTP response

Response 404
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 409
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 500
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.114. Perform Upgrade

POST /v1/upgrades

3.114.1. Description

Schedule/Trigger Upgrade of a Resource. Ex: Resource can be DOMAIN, CLUSTER, UNMANAGED_HOST etc. Performing upgrades are supported on VMware Cloud Foundation 3.5 BOM resources and above.

3.114.2. Parameters

Type Name Description Schema

Body

upgradeSpec
required

Upgrade Specification

UpgradeSpec

3.114.3. Responses

HTTP Code Description Schema

200

OK

Task

202

Accepted

Task

400

Bad Request

Error

500

Internal Server Error

Error

3.114.4. Consumes

  • application/json

3.114.5. Produces

  • application/json

3.114.6. Tags

  • Upgrades

3.114.7. Security

Type Name

basic

basicAuth

3.114.8. Example HTTP request

Request path
/v1/upgrades
Request body
{
  "bundleId" : "string",
  "resourceType" : "One among: DOMAIN, CLUSTER, UNASSIGNED_HOST",
  "resourceUpgradeSpecs" : [ {
    "resourceId" : "string",
    "scheduledTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "shutdownVms" : true,
    "toVersion" : "string",
    "upgradeNow" : true
  } ]
}

3.114.9. Example HTTP response

Response 200
{
  "completionTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "creationTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "errors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "id" : "string",
  "isCancellable" : true,
  "name" : "string",
  "resources" : [ {
    "fqdn" : "string",
    "name" : "string",
    "resourceId" : "string",
    "type" : "string"
  } ],
  "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
  "subTasks" : [ {
    "completionTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "creationTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "description" : "string",
    "errors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "name" : "string",
    "resources" : [ {
      "fqdn" : "string",
      "name" : "string",
      "resourceId" : "string",
      "type" : "string"
    } ],
    "stages" : [ {
      "completionTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "creationTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "description" : "string",
      "name" : "string",
      "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
      "type" : "string"
    } ],
    "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
    "type" : "string"
  } ],
  "type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}
Response 202
{
  "completionTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "creationTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "errors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "id" : "string",
  "isCancellable" : true,
  "name" : "string",
  "resources" : [ {
    "fqdn" : "string",
    "name" : "string",
    "resourceId" : "string",
    "type" : "string"
  } ],
  "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
  "subTasks" : [ {
    "completionTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "creationTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "description" : "string",
    "errors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "name" : "string",
    "resources" : [ {
      "fqdn" : "string",
      "name" : "string",
      "resourceId" : "string",
      "type" : "string"
    } ],
    "stages" : [ {
      "completionTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "creationTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "description" : "string",
      "name" : "string",
      "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
      "type" : "string"
    } ],
    "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
    "type" : "string"
  } ],
  "type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}
Response 400
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 500
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.115. Get vCenters

GET /v1/vcenters

3.115.1. Parameters

Type Name Description Schema

Query

domainId
optional

ID of the domain

string

3.115.2. Responses

HTTP Code Description Schema

200

Ok

Vcenter

400

Bad Request

Error

500

InternalServerError

Error

3.115.3. Consumes

  • application/json

3.115.4. Produces

  • application/json

3.115.5. Tags

  • vCenters

3.115.6. Security

Type Name

basic

basicAuth

3.115.7. Example HTTP request

Request path
/v1/vcenters

3.115.8. Example HTTP response

Response 200
{
  "domain" : {
    "id" : "string"
  },
  "fqdn" : "string",
  "id" : "string",
  "ipAddress" : "string"
}
Response 400
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 500
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.116. Get a vCenter

GET /v1/vcenters/{id}

3.116.1. Parameters

Type Name Description Schema

Path

id
required

vCenter ID

string

3.116.2. Responses

HTTP Code Description Schema

200

Ok

Vcenter

404

vCenter not found

Error

500

InternalServerError

Error

3.116.3. Consumes

  • application/json

3.116.4. Produces

  • application/json

3.116.5. Tags

  • vCenters

3.116.6. Security

Type Name

basic

basicAuth

3.116.7. Example HTTP request

Request path
/v1/vcenters/string

3.116.8. Example HTTP response

Response 200
{
  "domain" : {
    "id" : "string"
  },
  "fqdn" : "string",
  "id" : "string",
  "ipAddress" : "string"
}
Response 404
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 500
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.117. Get the VcfServices

GET /v1/vcf-services

3.117.1. Responses

HTTP Code Description Schema

200

Ok

VcfService

400

Bad Request

Error

500

InternalServerError

Error

3.117.2. Consumes

  • application/json

3.117.3. Produces

  • application/json

3.117.4. Tags

  • VcfServices

3.117.5. Security

Type Name

basic

basicAuth

3.117.6. Example HTTP request

Request path
/v1/vcf-services

3.117.7. Example HTTP response

Response 200
{
  "id" : "string",
  "name" : "string",
  "version" : "string"
}
Response 400
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 500
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.118. Get a VcfService

GET /v1/vcf-services/{id}

3.118.1. Parameters

Type Name Description Schema

Path

id
required

VcfService ID

string

3.118.2. Responses

HTTP Code Description Schema

200

Ok

VcfService

404

VcfService not found

Error

500

InternalServerError

Error

3.118.3. Consumes

  • application/json

3.118.4. Produces

  • application/json

3.118.5. Tags

  • VcfServices

3.118.6. Security

Type Name

basic

basicAuth

3.118.7. Example HTTP request

Request path
/v1/vcf-services/string

3.118.8. Example HTTP response

Response 200
{
  "id" : "string",
  "name" : "string",
  "version" : "string"
}
Response 404
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 500
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.119. Get the existing vRealize Log Insight

GET /v1/vrli

3.119.1. Description

Gets the complete information about the existing vRealize Log Insight instance.

3.119.2. Responses

HTTP Code Description Schema

200

OK

Vrli

404

Not Found

No Content

500

Internal Server Error

Error

3.119.3. Consumes

  • application/json

3.119.4. Produces

  • application/json

3.119.5. Tags

  • vRLI

3.119.6. Security

Type Name

basic

basicAuth

3.119.7. Example HTTP request

Request path
/v1/vrli

3.119.8. Example HTTP response

Response 200
{
  "id" : "string",
  "loadBalancerFqdn" : "load-balancer.vrack.vsphere.local",
  "loadBalancerIpAddress" : "10.0.0.15",
  "nodeSize" : "SMALL, MEDIUM, LARGE",
  "nodes" : [ {
    "fqdn" : "vrops.vrack.vsphere.local",
    "id" : "string",
    "ipAddress" : "10.0.0.17",
    "type" : "MASTER, REPLICA, DATA, REMOTE_COLLECTOR, WORKER"
  } ],
  "status" : "ACTIVE, ERROR",
  "version" : "4.8.0-13036238",
  "workloadDomainConnection" : true
}
Response 500
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.120. Connects vRealize Log Insight with workload domains

PATCH /v1/vrli

3.120.1. Description

Connects vRealize Log Insight with workload domains

3.120.2. Parameters

Type Name Description Schema

Body

vrli
required

vrli

Vrli

3.120.3. Responses

HTTP Code Description Schema

202

Accepted

Vrli

405

Not Allowed

No Content

500

Internal Server Error

Error

3.120.4. Consumes

  • application/json

3.120.5. Produces

  • application/json

3.120.6. Tags

  • vRLI

3.120.7. Security

Type Name

basic

basicAuth

3.120.8. Example HTTP request

Request path
/v1/vrli
Request body
{
  "id" : "string",
  "loadBalancerFqdn" : "load-balancer.vrack.vsphere.local",
  "loadBalancerIpAddress" : "10.0.0.15",
  "nodeSize" : "SMALL, MEDIUM, LARGE",
  "nodes" : [ {
    "fqdn" : "vrops.vrack.vsphere.local",
    "id" : "string",
    "ipAddress" : "10.0.0.17",
    "type" : "MASTER, REPLICA, DATA, REMOTE_COLLECTOR, WORKER"
  } ],
  "status" : "ACTIVE, ERROR",
  "version" : "4.8.0-13036238",
  "workloadDomainConnection" : true
}

3.120.9. Example HTTP response

Response 202
{
  "id" : "string",
  "loadBalancerFqdn" : "load-balancer.vrack.vsphere.local",
  "loadBalancerIpAddress" : "10.0.0.15",
  "nodeSize" : "SMALL, MEDIUM, LARGE",
  "nodes" : [ {
    "fqdn" : "vrops.vrack.vsphere.local",
    "id" : "string",
    "ipAddress" : "10.0.0.17",
    "type" : "MASTER, REPLICA, DATA, REMOTE_COLLECTOR, WORKER"
  } ],
  "status" : "ACTIVE, ERROR",
  "version" : "4.8.0-13036238",
  "workloadDomainConnection" : true
}
Response 500
{
  "arguments" : [ "string" ],
  "causes" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.121. Get all existing vRealize Log Insight instances

GET /v1/vrlis

3.121.1. Responses

HTTP Code Description Schema

200

OK

PageOfVrli

3.121.2. Consumes

  • application/json

3.121.3. Produces

  • application/json

3.121.4. Tags

  • vRLI

3.121.5. Security

Type Name

basic

basicAuth

3.121.6. Example HTTP request

Request path
/v1/vrlis

3.121.7. Example HTTP response

Response 200
{
  "elements" : [ {
    "id" : "string",
    "loadBalancerFqdn" : "load-balancer.vrack.vsphere.local",
    "loadBalancerIpAddress" : "10.0.0.15",
    "nodeSize" : "SMALL, MEDIUM, LARGE",
    "nodes" : [ {
      "fqdn" : "vrops.vrack.vsphere.local",
      "id" : "string",
      "ipAddress" : "10.0.0.17",
      "type" : "MASTER, REPLICA, DATA, REMOTE_COLLECTOR, WORKER"
    } ],
    "status" : "ACTIVE, ERROR",
    "version" : "4.8.0-13036238",
    "workloadDomainConnection" : true
  } ]
}

3.122. Get the existing vRealize Operations

GET /v1/vrops

3.122.1. Description

Gets the complete information about the existing vRealize Operations instance.

3.122.2. Responses

HTTP Code Description Schema

200

OK

Vrops

404

Not Found

No Content

500

Internal Server Error

ErrorResponse

3.122.3. Consumes

  • application/json

3.122.4. Produces

  • application/json

3.122.5. Tags

  • vROPs

3.122.6. Security

Type Name

basic

basicAuth

3.122.7. Example HTTP request

Request path
/v1/vrops

3.122.8. Example HTTP response

Response 200
{
  "id" : "string",
  "loadBalancerFqdn" : "string",
  "loadBalancerIp" : "string",
  "nodeSize" : "string",
  "nodes" : [ {
    "fqdn" : "vrops.vrack.vsphere.local",
    "id" : "string",
    "ipAddress" : "10.0.0.17",
    "password" : "string",
    "status" : "ACTIVE",
    "type" : "MASTER, REPLICA, DATA, REMOTE_COLLECTOR, WORKER",
    "username" : "user"
  } ],
  "status" : "string",
  "version" : "string"
}
Response 500
{
  "arguments" : [ "string" ],
  "cause" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "cause" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.123. Rollback vRealize Operations

DELETE /v1/vrops

3.123.1. Description

Triggers the vRealize Operations rollback operation and returns an URL in the headers to track the operation status.

3.123.2. Responses

HTTP Code Description Schema

202

Accepted

Task

405

Method Not Allowed

ErrorResponse

500

Internal Server Error

ErrorResponse

3.123.3. Consumes

  • application/json

3.123.4. Produces

  • application/json

3.123.5. Tags

  • vROPs

3.123.6. Security

Type Name

basic

basicAuth

3.123.7. Example HTTP request

Request path
/v1/vrops

3.123.8. Example HTTP response

Response 202
{
  "completionTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "creationTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "errors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "id" : "string",
  "isCancellable" : true,
  "name" : "string",
  "resources" : [ {
    "fqdn" : "string",
    "name" : "string",
    "resourceId" : "string",
    "type" : "string"
  } ],
  "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
  "subTasks" : [ {
    "completionTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "creationTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "description" : "string",
    "errors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "name" : "string",
    "resources" : [ {
      "fqdn" : "string",
      "name" : "string",
      "resourceId" : "string",
      "type" : "string"
    } ],
    "stages" : [ {
      "completionTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "creationTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "description" : "string",
      "name" : "string",
      "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
      "type" : "string"
    } ],
    "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
    "type" : "string"
  } ],
  "type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}
Response 405
{
  "arguments" : [ "string" ],
  "cause" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "cause" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 500
{
  "arguments" : [ "string" ],
  "cause" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "cause" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.124. Get vRealize Operations connection to Workload domains

GET /v1/vrops/domains

3.124.1. Description

Retrieves all the existing workload domains and their connection status with vRealize Operations.

3.124.2. Responses

HTTP Code Description Schema

200

OK

PageOfDomainIntegration

3.124.3. Consumes

  • application/json

3.124.4. Produces

  • application/json

3.124.5. Tags

  • vROPs

3.124.6. Security

Type Name

basic

basicAuth

3.124.7. Example HTTP request

Request path
/v1/vrops/domains

3.124.8. Example HTTP response

Response 200
{
  "elements" : [ {
    "domainId" : "string",
    "status" : "ENABLED, DISABLED, IN_PROGRESS"
  } ]
}

3.125. Connect/disconnect workload domains with vRealize Operations

PUT /v1/vrops/domains

3.125.1. Description

Connects/disconnects a workload domains with vRealize Operations

3.125.2. Parameters

Type Name Description Schema

Body

domainIntegration
required

Domain Integration Specification

DomainIntegration

3.125.3. Responses

HTTP Code Description Schema

202

Accepted

Task

400

Bad Request

ErrorResponse

500

Internal Server Error

ErrorResponse

3.125.4. Consumes

  • application/json

3.125.5. Produces

  • application/json

3.125.6. Tags

  • vROPs

3.125.7. Security

Type Name

basic

basicAuth

3.125.8. Example HTTP request

Request path
/v1/vrops/domains
Request body
{
  "domainId" : "string",
  "status" : "ENABLED, DISABLED, IN_PROGRESS"
}

3.125.9. Example HTTP response

Response 202
{
  "completionTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "creationTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "errors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "id" : "string",
  "isCancellable" : true,
  "name" : "string",
  "resources" : [ {
    "fqdn" : "string",
    "name" : "string",
    "resourceId" : "string",
    "type" : "string"
  } ],
  "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
  "subTasks" : [ {
    "completionTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "creationTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "description" : "string",
    "errors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "name" : "string",
    "resources" : [ {
      "fqdn" : "string",
      "name" : "string",
      "resourceId" : "string",
      "type" : "string"
    } ],
    "stages" : [ {
      "completionTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "creationTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "description" : "string",
      "name" : "string",
      "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
      "type" : "string"
    } ],
    "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
    "type" : "string"
  } ],
  "type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}
Response 400
{
  "arguments" : [ "string" ],
  "cause" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "cause" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 500
{
  "arguments" : [ "string" ],
  "cause" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "cause" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.126. Expand vRealize Operations by adding a new DATA node

POST /v1/vrops/nodes

3.126.1. Description

Triggers the vRealize Operations expansion operation and adds a new DATA node to the existing vRealize Operations cluster.

3.126.2. Parameters

Type Name Description Schema

Body

vropsNode
required

vRealize Operations Expansion Specification

VropsNode

3.126.3. Responses

HTTP Code Description Schema

202

Accepted

Task

400

Bad Request

ErrorResponse

405

Method Not Allowed

ErrorResponse

500

Internal Server Error

ErrorResponse

3.126.4. Consumes

  • application/json

3.126.5. Produces

  • application/json

3.126.6. Tags

  • vROPs

3.126.7. Security

Type Name

basic

basicAuth

3.126.8. Example HTTP request

Request path
/v1/vrops/nodes
Request body
{
  "fqdn" : "vrops.vrack.vsphere.local",
  "id" : "string",
  "ipAddress" : "10.0.0.17",
  "password" : "string",
  "status" : "ACTIVE",
  "type" : "MASTER, REPLICA, DATA, REMOTE_COLLECTOR, WORKER",
  "username" : "user"
}

3.126.9. Example HTTP response

Response 202
{
  "completionTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "creationTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "errors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "id" : "string",
  "isCancellable" : true,
  "name" : "string",
  "resources" : [ {
    "fqdn" : "string",
    "name" : "string",
    "resourceId" : "string",
    "type" : "string"
  } ],
  "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
  "subTasks" : [ {
    "completionTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "creationTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "description" : "string",
    "errors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "name" : "string",
    "resources" : [ {
      "fqdn" : "string",
      "name" : "string",
      "resourceId" : "string",
      "type" : "string"
    } ],
    "stages" : [ {
      "completionTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "creationTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "description" : "string",
      "name" : "string",
      "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
      "type" : "string"
    } ],
    "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
    "type" : "string"
  } ],
  "type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}
Response 400
{
  "arguments" : [ "string" ],
  "cause" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "cause" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 405
{
  "arguments" : [ "string" ],
  "cause" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "cause" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 500
{
  "arguments" : [ "string" ],
  "cause" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "cause" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.127. Get all vRealize Operations nodes

GET /v1/vrops/nodes

3.127.1. Description

Retrieves all the existing vRealize Operations nodes

3.127.2. Responses

HTTP Code Description Schema

200

OK

PageOfVropsNode

3.127.3. Consumes

  • application/json

3.127.4. Produces

  • application/json

3.127.5. Tags

  • vROPs

3.127.6. Security

Type Name

basic

basicAuth

3.127.7. Example HTTP request

Request path
/v1/vrops/nodes

3.127.8. Example HTTP response

Response 200
{
  "elements" : [ {
    "fqdn" : "vrops.vrack.vsphere.local",
    "id" : "string",
    "ipAddress" : "10.0.0.17",
    "password" : "string",
    "status" : "ACTIVE",
    "type" : "MASTER, REPLICA, DATA, REMOTE_COLLECTOR, WORKER",
    "username" : "user"
  } ]
}

3.128. Rollback after failed vRealize Operations expansion

DELETE /v1/vrops/nodes/{id}

3.128.1. Description

Triggers the vRealize Operations rollback operation after the failed expansion workflow. The operation is available only if the expansion with the new node through the vRealize Suite Lifecycle Manager is not completed successfully. In order for the rollback to succeed, the vRealize Operation Cluster must be in a healthy state.

3.128.2. Parameters

Type Name Description Schema

Path

id
required

id

string

3.128.3. Responses

HTTP Code Description Schema

202

Accepted

Task

400

Bad Request

ErrorResponse

409

Conflict

ErrorResponse

500

Internal Server Error

ErrorResponse

3.128.4. Consumes

  • application/json

3.128.5. Produces

  • application/json

3.128.6. Tags

  • vROPs

3.128.7. Security

Type Name

basic

basicAuth

3.128.8. Example HTTP request

Request path
/v1/vrops/nodes/string

3.128.9. Example HTTP response

Response 202
{
  "completionTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "creationTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "errors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "id" : "string",
  "isCancellable" : true,
  "name" : "string",
  "resources" : [ {
    "fqdn" : "string",
    "name" : "string",
    "resourceId" : "string",
    "type" : "string"
  } ],
  "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
  "subTasks" : [ {
    "completionTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "creationTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "description" : "string",
    "errors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "name" : "string",
    "resources" : [ {
      "fqdn" : "string",
      "name" : "string",
      "resourceId" : "string",
      "type" : "string"
    } ],
    "stages" : [ {
      "completionTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "creationTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "description" : "string",
      "name" : "string",
      "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
      "type" : "string"
    } ],
    "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
    "type" : "string"
  } ],
  "type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}
Response 400
{
  "arguments" : [ "string" ],
  "cause" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "cause" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 409
{
  "arguments" : [ "string" ],
  "cause" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "cause" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 500
{
  "arguments" : [ "string" ],
  "cause" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "cause" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.129. Deploy vRealize Operations

POST /v1/vropses

3.129.1. Description

Triggers the vRealize Operations deployment operation and returns an URL in the headers to track the operation status.

3.129.2. Parameters

Type Name Description Schema

Body

vropsDeploymentSpec
required

vRealize Operations Deployment Specification

VropsDeploymentSpec

3.129.3. Responses

HTTP Code Description Schema

202

Accepted

Task

400

Bad Request

ErrorResponse

405

Method Not Allowed

ErrorResponse

500

Internal Server Error

ErrorResponse

3.129.4. Consumes

  • application/json

3.129.5. Produces

  • application/json

3.129.6. Tags

  • vROPs

3.129.7. Security

Type Name

basic

basicAuth

3.129.8. Example HTTP request

Request path
/v1/vropses
Request body
{
  "apiPassword" : "string",
  "enableHa" : true,
  "licenseKey" : "string",
  "loadBalancerFqdn" : "vrealize-lb.vrack.vsphere.local",
  "nodeSize" : "MEDIUM",
  "nodes" : [ {
    "fqdn" : "vrops.vrack.vsphere.local",
    "id" : "string",
    "ipAddress" : "10.0.0.17",
    "password" : "string",
    "status" : "ACTIVE",
    "type" : "MASTER, REPLICA, DATA, REMOTE_COLLECTOR, WORKER",
    "username" : "user"
  } ],
  "vrealizeEdgeFqdn" : "vrealize-edge.vrack.vsphere.local"
}

3.129.9. Example HTTP response

Response 202
{
  "completionTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "creationTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "errors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "id" : "string",
  "isCancellable" : true,
  "name" : "string",
  "resources" : [ {
    "fqdn" : "string",
    "name" : "string",
    "resourceId" : "string",
    "type" : "string"
  } ],
  "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
  "subTasks" : [ {
    "completionTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "creationTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "description" : "string",
    "errors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "name" : "string",
    "resources" : [ {
      "fqdn" : "string",
      "name" : "string",
      "resourceId" : "string",
      "type" : "string"
    } ],
    "stages" : [ {
      "completionTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "creationTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "description" : "string",
      "name" : "string",
      "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
      "type" : "string"
    } ],
    "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
    "type" : "string"
  } ],
  "type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}
Response 400
{
  "arguments" : [ "string" ],
  "cause" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "cause" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 405
{
  "arguments" : [ "string" ],
  "cause" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "cause" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 500
{
  "arguments" : [ "string" ],
  "cause" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "cause" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.130. Get all existing vRealize Operations instances

GET /v1/vropses

3.130.1. Responses

HTTP Code Description Schema

200

OK

PageOfVrops

3.130.2. Consumes

  • application/json

3.130.3. Produces

  • application/json

3.130.4. Tags

  • vROPs

3.130.5. Security

Type Name

basic

basicAuth

3.130.6. Example HTTP request

Request path
/v1/vropses

3.130.7. Example HTTP response

Response 200
{
  "elements" : [ {
    "id" : "string",
    "loadBalancerFqdn" : "string",
    "loadBalancerIp" : "string",
    "nodeSize" : "string",
    "nodes" : [ {
      "fqdn" : "vrops.vrack.vsphere.local",
      "id" : "string",
      "ipAddress" : "10.0.0.17",
      "password" : "string",
      "status" : "ACTIVE",
      "type" : "MASTER, REPLICA, DATA, REMOTE_COLLECTOR, WORKER",
      "username" : "user"
    } ],
    "status" : "string",
    "version" : "string"
  } ]
}

3.131. Validate vRealize Operations Input Specification

POST /v1/vropses/validations

3.131.1. Description

Triggers input spec validation for various vRealize Operations worflows

3.131.2. Parameters

Type Name Description Schema

Body

vropsOperationSpec
required

vRealize Operations Validation Specification

VropsOperationSpecValidation

3.131.3. Responses

HTTP Code Description Schema

200

OK

Validation

202

Accepted

Validation

400

Bad Request

ErrorResponse

3.131.4. Consumes

  • application/json

3.131.5. Produces

  • application/json

3.131.6. Tags

  • vROPs

3.131.7. Security

Type Name

basic

basicAuth

3.131.8. Example HTTP request

Request path
/v1/vropses/validations
Request body
{
  "vropsDeploymentSpec" : {
    "apiPassword" : "string",
    "enableHa" : true,
    "licenseKey" : "string",
    "loadBalancerFqdn" : "vrealize-lb.vrack.vsphere.local",
    "nodeSize" : "MEDIUM",
    "nodes" : [ {
      "fqdn" : "vrops.vrack.vsphere.local",
      "id" : "string",
      "ipAddress" : "10.0.0.17",
      "password" : "string",
      "status" : "ACTIVE",
      "type" : "MASTER, REPLICA, DATA, REMOTE_COLLECTOR, WORKER",
      "username" : "user"
    } ],
    "vrealizeEdgeFqdn" : "vrealize-edge.vrack.vsphere.local"
  },
  "vropsExpansionSpec" : {
    "fqdn" : "vrops.vrack.vsphere.local",
    "id" : "string",
    "ipAddress" : "10.0.0.17",
    "password" : "string",
    "status" : "ACTIVE",
    "type" : "MASTER, REPLICA, DATA, REMOTE_COLLECTOR, WORKER",
    "username" : "user"
  }
}

3.131.9. Example HTTP response

Response 200
{
  "description" : "string",
  "executionStatus" : "One among: IN_PROGRESS, FAILED, COMPLETED, SKIPPED, CANCELLED",
  "id" : "string",
  "resultStatus" : "One among: SUCCEEDED, FAILED, FAILED_WITH_WARNINGS",
  "validationChecks" : [ {
    "description" : "string",
    "errorResponse" : {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ {
        "arguments" : [ "string" ],
        "causes" : [ {
          "message" : "string",
          "type" : "string"
        } ],
        "context" : {
          "string" : "string"
        },
        "errorCode" : "string",
        "message" : "string",
        "nestedErrors" : [ "..." ],
        "referenceToken" : "string",
        "remediationMessage" : "string"
      } ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    },
    "nestedValidationChecks" : [ {
      "description" : "string",
      "errorResponse" : {
        "arguments" : [ "string" ],
        "causes" : [ {
          "message" : "string",
          "type" : "string"
        } ],
        "context" : {
          "string" : "string"
        },
        "errorCode" : "string",
        "message" : "string",
        "nestedErrors" : [ "..." ],
        "referenceToken" : "string",
        "remediationMessage" : "string"
      },
      "nestedValidationChecks" : [ "..." ],
      "resultStatus" : "One among: SUCCEEDED, FAILED",
      "severity" : "One among: WARNING, ERROR, INFO"
    } ],
    "resultStatus" : "One among: SUCCEEDED, FAILED",
    "severity" : "One among: WARNING, ERROR, INFO"
  } ]
}
Response 202
{
  "description" : "string",
  "executionStatus" : "One among: IN_PROGRESS, FAILED, COMPLETED, SKIPPED, CANCELLED",
  "id" : "string",
  "resultStatus" : "One among: SUCCEEDED, FAILED, FAILED_WITH_WARNINGS",
  "validationChecks" : [ {
    "description" : "string",
    "errorResponse" : {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ {
        "arguments" : [ "string" ],
        "causes" : [ {
          "message" : "string",
          "type" : "string"
        } ],
        "context" : {
          "string" : "string"
        },
        "errorCode" : "string",
        "message" : "string",
        "nestedErrors" : [ "..." ],
        "referenceToken" : "string",
        "remediationMessage" : "string"
      } ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    },
    "nestedValidationChecks" : [ {
      "description" : "string",
      "errorResponse" : {
        "arguments" : [ "string" ],
        "causes" : [ {
          "message" : "string",
          "type" : "string"
        } ],
        "context" : {
          "string" : "string"
        },
        "errorCode" : "string",
        "message" : "string",
        "nestedErrors" : [ "..." ],
        "referenceToken" : "string",
        "remediationMessage" : "string"
      },
      "nestedValidationChecks" : [ "..." ],
      "resultStatus" : "One among: SUCCEEDED, FAILED",
      "severity" : "One among: WARNING, ERROR, INFO"
    } ],
    "resultStatus" : "One among: SUCCEEDED, FAILED",
    "severity" : "One among: WARNING, ERROR, INFO"
  } ]
}
Response 400
{
  "arguments" : [ "string" ],
  "cause" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "cause" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.132. Get the status of the validations for vRealize Operations

GET /v1/vropses/validations/{id}

3.132.1. Description

Gets the status of given vRealize Operations validation workflow by given validation id

3.132.2. Parameters

Type Name Description Schema

Path

id
required

vRealize validation id

string

3.132.3. Responses

HTTP Code Description Schema

200

OK

Validation

400

Bad Request

ErrorResponse

404

Not Found

ErrorResponse

3.132.4. Consumes

  • application/json

3.132.5. Produces

  • application/json

3.132.6. Tags

  • vROPs

3.132.7. Security

Type Name

basic

basicAuth

3.132.8. Example HTTP request

Request path
/v1/vropses/validations/string

3.132.9. Example HTTP response

Response 200
{
  "description" : "string",
  "executionStatus" : "One among: IN_PROGRESS, FAILED, COMPLETED, SKIPPED, CANCELLED",
  "id" : "string",
  "resultStatus" : "One among: SUCCEEDED, FAILED, FAILED_WITH_WARNINGS",
  "validationChecks" : [ {
    "description" : "string",
    "errorResponse" : {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ {
        "arguments" : [ "string" ],
        "causes" : [ {
          "message" : "string",
          "type" : "string"
        } ],
        "context" : {
          "string" : "string"
        },
        "errorCode" : "string",
        "message" : "string",
        "nestedErrors" : [ "..." ],
        "referenceToken" : "string",
        "remediationMessage" : "string"
      } ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    },
    "nestedValidationChecks" : [ {
      "description" : "string",
      "errorResponse" : {
        "arguments" : [ "string" ],
        "causes" : [ {
          "message" : "string",
          "type" : "string"
        } ],
        "context" : {
          "string" : "string"
        },
        "errorCode" : "string",
        "message" : "string",
        "nestedErrors" : [ "..." ],
        "referenceToken" : "string",
        "remediationMessage" : "string"
      },
      "nestedValidationChecks" : [ "..." ],
      "resultStatus" : "One among: SUCCEEDED, FAILED",
      "severity" : "One among: WARNING, ERROR, INFO"
    } ],
    "resultStatus" : "One among: SUCCEEDED, FAILED",
    "severity" : "One among: WARNING, ERROR, INFO"
  } ]
}
Response 400
{
  "arguments" : [ "string" ],
  "cause" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "cause" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 404
{
  "arguments" : [ "string" ],
  "cause" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "cause" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.133. Get the existing vRealize Suite Lifecycle Manager

GET /v1/vrslcm

3.133.1. Description

Gets the complete information about the existing vRealize Suite Lifecycle Manager instance.

3.133.2. Responses

HTTP Code Description Schema

200

OK

Vrslcm

404

Not Found

No Content

3.133.3. Consumes

  • application/json

3.133.4. Produces

  • application/json

3.133.5. Tags

  • vRSLCM

3.133.6. Security

Type Name

basic

basicAuth

3.133.7. Example HTTP request

Request path
/v1/vrslcm

3.133.8. Example HTTP response

Response 200
{
  "fqdn" : "string",
  "id" : "string",
  "ipAddress" : "string",
  "status" : "string",
  "version" : "string"
}

3.134. Rollback vRealize Suite Lifecycle Manager after unsuccessful deployment

DELETE /v1/vrslcm

3.134.1. Description

Triggers the vRealize Suite Lifecycle Manager rollback operation and returns an URL in the headers to track the operation status.

3.134.2. Responses

HTTP Code Description Schema

202

Accepted

Task

405

Method Not Allowed

ErrorResponse

3.134.3. Consumes

  • application/json

3.134.4. Produces

  • application/json

3.134.5. Tags

  • vRSLCM

3.134.6. Security

Type Name

basic

basicAuth

3.134.7. Example HTTP request

Request path
/v1/vrslcm

3.134.8. Example HTTP response

Response 202
{
  "completionTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "creationTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "errors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "id" : "string",
  "isCancellable" : true,
  "name" : "string",
  "resources" : [ {
    "fqdn" : "string",
    "name" : "string",
    "resourceId" : "string",
    "type" : "string"
  } ],
  "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
  "subTasks" : [ {
    "completionTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "creationTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "description" : "string",
    "errors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "name" : "string",
    "resources" : [ {
      "fqdn" : "string",
      "name" : "string",
      "resourceId" : "string",
      "type" : "string"
    } ],
    "stages" : [ {
      "completionTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "creationTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "description" : "string",
      "name" : "string",
      "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
      "type" : "string"
    } ],
    "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
    "type" : "string"
  } ],
  "type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}
Response 405
{
  "arguments" : [ "string" ],
  "cause" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "cause" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.135. Redeploy vRealize Suite Lifecycle Manager

PATCH /v1/vrslcm

3.135.1. Description

Triggers the vRealize Suite Lifecycle Manager redeployment operation and returns an URL in the headers to track the operation status.

3.135.2. Responses

HTTP Code Description Schema

202

Accepted

Task

400

Bad Request

ErrorResponse

405

Method Not Allowed

ErrorResponse

3.135.3. Consumes

  • application/json

3.135.4. Produces

  • application/json

3.135.5. Tags

  • vRSLCM

3.135.6. Security

Type Name

basic

basicAuth

3.135.7. Example HTTP request

Request path
/v1/vrslcm

3.135.8. Example HTTP response

Response 202
{
  "completionTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "creationTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "errors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "id" : "string",
  "isCancellable" : true,
  "name" : "string",
  "resources" : [ {
    "fqdn" : "string",
    "name" : "string",
    "resourceId" : "string",
    "type" : "string"
  } ],
  "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
  "subTasks" : [ {
    "completionTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "creationTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "description" : "string",
    "errors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "name" : "string",
    "resources" : [ {
      "fqdn" : "string",
      "name" : "string",
      "resourceId" : "string",
      "type" : "string"
    } ],
    "stages" : [ {
      "completionTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "creationTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "description" : "string",
      "name" : "string",
      "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
      "type" : "string"
    } ],
    "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
    "type" : "string"
  } ],
  "type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}
Response 400
{
  "arguments" : [ "string" ],
  "cause" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "cause" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 405
{
  "arguments" : [ "string" ],
  "cause" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "cause" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.136. Get vRealize Suite Lifecycle Manager environments

GET /v1/vrslcm/environments

3.136.1. Description

Gets all the vRealize products and the corresponding vRealize Suite Lifecycle Manager environments that are managed by VMware Cloud Foundation.

3.136.2. Responses

HTTP Code Description Schema

200

OK

< VrealizeEnvironment > array

400

Bad Request

ErrorResponse

3.136.3. Consumes

  • application/json

3.136.4. Produces

  • application/json

3.136.5. Tags

  • vRSLCM

3.136.6. Security

Type Name

basic

basicAuth

3.136.7. Example HTTP request

Request path
/v1/vrslcm/environments

3.136.8. Example HTTP response

Response 200
[ {
  "environment" : "string",
  "product" : "string"
} ]
Response 400
{
  "arguments" : [ "string" ],
  "cause" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "cause" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.137. Update the vRealize Suite Lifecycle Manager environments

PUT /v1/vrslcm/environments

3.137.1. Description

Triggers the update operation of the vRealize Suite Lifecycle Manager for the specific vRealize products or for all of them if none are specified. The allowed values for the products are the following: VRLI, VRA, VROPS.

3.137.2. Parameters

Type Name Description Schema

Query

products
optional

products

< string > array(multi)

3.137.3. Responses

HTTP Code Description Schema

202

Accepted

Task

400

Bad Request

ErrorResponse

405

Method Not Allowed

ErrorResponse

3.137.4. Consumes

  • application/json

3.137.5. Produces

  • application/json

3.137.6. Tags

  • vRSLCM

3.137.7. Security

Type Name

basic

basicAuth

3.137.8. Example HTTP request

Request path
/v1/vrslcm/environments

3.137.9. Example HTTP response

Response 202
{
  "completionTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "creationTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "errors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "id" : "string",
  "isCancellable" : true,
  "name" : "string",
  "resources" : [ {
    "fqdn" : "string",
    "name" : "string",
    "resourceId" : "string",
    "type" : "string"
  } ],
  "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
  "subTasks" : [ {
    "completionTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "creationTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "description" : "string",
    "errors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "name" : "string",
    "resources" : [ {
      "fqdn" : "string",
      "name" : "string",
      "resourceId" : "string",
      "type" : "string"
    } ],
    "stages" : [ {
      "completionTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "creationTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "description" : "string",
      "name" : "string",
      "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
      "type" : "string"
    } ],
    "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
    "type" : "string"
  } ],
  "type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}
Response 400
{
  "arguments" : [ "string" ],
  "cause" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "cause" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 405
{
  "arguments" : [ "string" ],
  "cause" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "cause" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.138. Deploy vRealize Suite Lifecycle Manager

POST /v1/vrslcms

3.138.1. Description

Triggers the vRealize Suite Lifecycle Manager deployment operation and returns an URL in the headers to track the operation status.

3.138.2. Parameters

Type Name Description Schema

Body

vrslcmPublicDeploymentSpec
required

vRealize Suite Lifecycle Manager Deployment Specification

VrslcmDeploymentSpec

3.138.3. Responses

HTTP Code Description Schema

202

Accepted

Task

400

Bad Request

ErrorResponse

405

Method Not Allowed

ErrorResponse

500

Internal Server Error

ErrorResponse

3.138.4. Consumes

  • application/json

3.138.5. Produces

  • application/json

3.138.6. Tags

  • vRSLCM

3.138.7. Security

Type Name

basic

basicAuth

3.138.8. Example HTTP request

Request path
/v1/vrslcms
Request body
{
  "apiPassword" : "string",
  "fqdn" : "vrslcm.vrack.vsphere.local",
  "networkSpec" : {
    "gateway" : "10.0.1.250",
    "subnetMask" : "255.255.252.0",
    "vlanId" : "2042"
  },
  "sshPassword" : "string"
}

3.138.9. Example HTTP response

Response 202
{
  "completionTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "creationTimestamp" : {
    "epochSecond" : 0,
    "nano" : 0
  },
  "errors" : [ {
    "arguments" : [ "string" ],
    "causes" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "id" : "string",
  "isCancellable" : true,
  "name" : "string",
  "resources" : [ {
    "fqdn" : "string",
    "name" : "string",
    "resourceId" : "string",
    "type" : "string"
  } ],
  "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED",
  "subTasks" : [ {
    "completionTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "creationTimestamp" : {
      "epochSecond" : 0,
      "nano" : 0
    },
    "description" : "string",
    "errors" : [ {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ "..." ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    } ],
    "name" : "string",
    "resources" : [ {
      "fqdn" : "string",
      "name" : "string",
      "resourceId" : "string",
      "type" : "string"
    } ],
    "stages" : [ {
      "completionTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "creationTimestamp" : {
        "epochSecond" : 0,
        "nano" : 0
      },
      "description" : "string",
      "name" : "string",
      "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
      "type" : "string"
    } ],
    "status" : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED",
    "type" : "string"
  } ],
  "type" : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}
Response 400
{
  "arguments" : [ "string" ],
  "cause" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "cause" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 405
{
  "arguments" : [ "string" ],
  "cause" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "cause" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 500
{
  "arguments" : [ "string" ],
  "cause" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "cause" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.139. Get all existing vRealize Suite Lifecycle Manager instances

GET /v1/vrslcms

3.139.1. Responses

HTTP Code Description Schema

200

OK

Vrslcm

3.139.2. Consumes

  • application/json

3.139.3. Produces

  • application/json

3.139.4. Tags

  • vRSLCM

3.139.5. Security

Type Name

basic

basicAuth

3.139.6. Example HTTP request

Request path
/v1/vrslcms

3.139.7. Example HTTP response

Response 200
{
  "fqdn" : "string",
  "id" : "string",
  "ipAddress" : "string",
  "status" : "string",
  "version" : "string"
}

3.140. Validate the input specification for vRealize Suite Lifecycle Manager deployment

POST /v1/vrslcms/validations

3.140.1. Description

Triggers vRealize Suite Lifecycle Manager deployment specification validation workflow

3.140.2. Parameters

Type Name Description Schema

Body

vrslcmPublicDeploymentSpec
required

vRealize Suite Lifecycle Manager Deployment Specification

VrslcmDeploymentSpec

3.140.3. Responses

HTTP Code Description Schema

202

Accepted

Validation

400

Bad Request

ErrorResponse

3.140.4. Consumes

  • application/json

3.140.5. Produces

  • application/json

3.140.6. Tags

  • vRSLCM

3.140.7. Security

Type Name

basic

basicAuth

3.140.8. Example HTTP request

Request path
/v1/vrslcms/validations
Request body
{
  "apiPassword" : "string",
  "fqdn" : "vrslcm.vrack.vsphere.local",
  "networkSpec" : {
    "gateway" : "10.0.1.250",
    "subnetMask" : "255.255.252.0",
    "vlanId" : "2042"
  },
  "sshPassword" : "string"
}

3.140.9. Example HTTP response

Response 202
{
  "description" : "string",
  "executionStatus" : "One among: IN_PROGRESS, FAILED, COMPLETED, SKIPPED, CANCELLED",
  "id" : "string",
  "resultStatus" : "One among: SUCCEEDED, FAILED, FAILED_WITH_WARNINGS",
  "validationChecks" : [ {
    "description" : "string",
    "errorResponse" : {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ {
        "arguments" : [ "string" ],
        "causes" : [ {
          "message" : "string",
          "type" : "string"
        } ],
        "context" : {
          "string" : "string"
        },
        "errorCode" : "string",
        "message" : "string",
        "nestedErrors" : [ "..." ],
        "referenceToken" : "string",
        "remediationMessage" : "string"
      } ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    },
    "nestedValidationChecks" : [ {
      "description" : "string",
      "errorResponse" : {
        "arguments" : [ "string" ],
        "causes" : [ {
          "message" : "string",
          "type" : "string"
        } ],
        "context" : {
          "string" : "string"
        },
        "errorCode" : "string",
        "message" : "string",
        "nestedErrors" : [ "..." ],
        "referenceToken" : "string",
        "remediationMessage" : "string"
      },
      "nestedValidationChecks" : [ "..." ],
      "resultStatus" : "One among: SUCCEEDED, FAILED",
      "severity" : "One among: WARNING, ERROR, INFO"
    } ],
    "resultStatus" : "One among: SUCCEEDED, FAILED",
    "severity" : "One among: WARNING, ERROR, INFO"
  } ]
}
Response 400
{
  "arguments" : [ "string" ],
  "cause" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "cause" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

3.141. Get the status of the validations for vRealize Lifecycle Manager deployment

GET /v1/vrslcms/validations/{id}

3.141.1. Description

Gets the status of given vRealize Suite Lifecycle Manager validation workflow by given validation id

3.141.2. Parameters

Type Name Description Schema

Path

id
required

vRealize validation id

string

3.141.3. Responses

HTTP Code Description Schema

200

OK

Validation

400

Bad Request

ErrorResponse

404

Not Found

ErrorResponse

3.141.4. Consumes

  • application/json

3.141.5. Produces

  • application/json

3.141.6. Tags

  • vRSLCM

3.141.7. Security

Type Name

basic

basicAuth

3.141.8. Example HTTP request

Request path
/v1/vrslcms/validations/string

3.141.9. Example HTTP response

Response 200
{
  "description" : "string",
  "executionStatus" : "One among: IN_PROGRESS, FAILED, COMPLETED, SKIPPED, CANCELLED",
  "id" : "string",
  "resultStatus" : "One among: SUCCEEDED, FAILED, FAILED_WITH_WARNINGS",
  "validationChecks" : [ {
    "description" : "string",
    "errorResponse" : {
      "arguments" : [ "string" ],
      "causes" : [ {
        "message" : "string",
        "type" : "string"
      } ],
      "context" : {
        "string" : "string"
      },
      "errorCode" : "string",
      "message" : "string",
      "nestedErrors" : [ {
        "arguments" : [ "string" ],
        "causes" : [ {
          "message" : "string",
          "type" : "string"
        } ],
        "context" : {
          "string" : "string"
        },
        "errorCode" : "string",
        "message" : "string",
        "nestedErrors" : [ "..." ],
        "referenceToken" : "string",
        "remediationMessage" : "string"
      } ],
      "referenceToken" : "string",
      "remediationMessage" : "string"
    },
    "nestedValidationChecks" : [ {
      "description" : "string",
      "errorResponse" : {
        "arguments" : [ "string" ],
        "causes" : [ {
          "message" : "string",
          "type" : "string"
        } ],
        "context" : {
          "string" : "string"
        },
        "errorCode" : "string",
        "message" : "string",
        "nestedErrors" : [ "..." ],
        "referenceToken" : "string",
        "remediationMessage" : "string"
      },
      "nestedValidationChecks" : [ "..." ],
      "resultStatus" : "One among: SUCCEEDED, FAILED",
      "severity" : "One among: WARNING, ERROR, INFO"
    } ],
    "resultStatus" : "One among: SUCCEEDED, FAILED",
    "severity" : "One among: WARNING, ERROR, INFO"
  } ]
}
Response 400
{
  "arguments" : [ "string" ],
  "cause" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "cause" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}
Response 404
{
  "arguments" : [ "string" ],
  "cause" : [ {
    "message" : "string",
    "type" : "string"
  } ],
  "context" : {
    "string" : "string"
  },
  "errorCode" : "string",
  "message" : "string",
  "nestedErrors" : [ {
    "arguments" : [ "string" ],
    "cause" : [ {
      "message" : "string",
      "type" : "string"
    } ],
    "context" : {
      "string" : "string"
    },
    "errorCode" : "string",
    "message" : "string",
    "nestedErrors" : [ "..." ],
    "referenceToken" : "string",
    "remediationMessage" : "string"
  } ],
  "referenceToken" : "string",
  "remediationMessage" : "string"
}

4. Definitions

4.1. AdInstance

Contains parameters of Active Directory instance

Name Description Schema

alias
optional

Alias of Active Directory instance
Example : "string"

string

baseDnGroups
optional

Base Dn Groups of Active Directory instance
Example : "string"

string

baseDnUsers
optional

Base Dn Users of Active Directory instance
Example : "string"

string

globalCatalogPort
optional

Global Catalog Port of Active Directory instance
Example : 0

integer (int32)

name
optional

Name of Active Directory instance
Example : "string"

string

port
optional

Port of Active Directory instance
Example : 0

integer (int32)

serverUrl
optional

Server URL of Active Directory instance
Example : "string"

string

4.2. AdSpec

Spec contains parameters of Active Directory

Name Description Schema

childAdDetails
optional

Details for the child Active Directory
Example : AdInstance

AdInstance

domainControllers
optional

Fully Qualified Domain Name of Active Directory Domain controllers
Example : [ "string" ]

< string > array

groups
required

Groups in Active Directory
Example : {
"string" : "string"
}

< string, string > map

requireSsl
optional

Require SSL connection to Active Directory
Example : true

boolean

rootAdDetails
optional

Details for the root Active Directory
Example : AdInstance

AdInstance

skipJoinEsxi
optional

Whether to skip joining ESXi hosts to Active Directory or not (default: false)
Example : true

boolean

useSubDomainForUsers
optional

Whether to use subdomain for user names
Example : true

boolean

users
required

Users in Active Directory
Example : {
"string" : "SddcCredentials"
}

< string, SddcCredentials > map

4.3. AdvancedOptions

Advanced Options used to add Cluster

Name Description Schema

evcMode
optional

EVC mode for new cluster, if needed
Example : "One among: INTEL_MEROM, INTEL_PENRYN, INTEL_NEALEM, INTEL_WESTMERE, INTEL_SANDYBRIDGE, INTEL_IVYBRIDGE, INTEL_HASWELL, INTEL_BROADWELL, INTEL_SKYLAKE, AMD_REV_E, AMD_REV_F, AMD_GREYHOUND_NO3DNOW, AMD_GREYHOUND, AMD_BULLDOZER, AMD_PILEDRIVER, AMD_STREAMROLLER, AMD_ZEN"

string

highAvailability
optional

High availability settings for the cluster
Example : HighAvailability

HighAvailability

4.4. AuthenticatedResource

Represents the credential resource in the system

Name Description Schema

domainName
required

Domain name
Example : "string"

string

resourceId
required

Resource ID
Example : "string"

string

resourceIp
required

Resource IP address
Example : "string"

string

resourceName
required

Resource name
Example : "string"

string

resourceType
required

Resource type
Example : "One among: ESXI, SDDC_MANAGER, VCENTER, PSC, NSX_MANAGER, NSX_CONTROLLER, NSX_EDGE, NSXT_MANAGER, NSXT_CONTROLLER, NSXT_EDGE, VRLI, VROPS, LCM_REPO, VRA, VRSLCM, DEPOT_USER, VXRAIL_MANAGER, AD, BACKUP"

string

serviceType
required

Service type
Example : "One among: ESXI, SDDC_MANAGER, VCENTER, PSC, NSX_MANAGER, NSX_CONTROLLER, NSX_EDGE, NSXT_MANAGER, NSXT_CONTROLLER, NSXT_EDGE, VRLI, VROPS, LCM_REPO, VRA, VRSLCM, DEPOT_USER, VXRAIL_MANAGER, AD, BACKUP"

string

targetType
required

Target type
Example : "One among: ESXI, SDDC_MANAGER, VCENTER, PSC, NSX_MANAGER, NSX_CONTROLLER, NSX_EDGE, NSXT_MANAGER, NSXT_CONTROLLER, NSXT_EDGE, VRLI, VROPS, LCM_REPO, VRA, VRSLCM, DEPOT_USER, VXRAIL_MANAGER, AD, BACKUP"

string

4.5. BackupConfiguration

Backup configuration used to configure backup of NSX and SDDC manager

Name Description Schema

backupLocations
optional

List of backup locations
Example : [ "BackupLocation" ]

< BackupLocation > array

encryption
optional

Encryption passphrase used to encrypt and decrypt backup file
Example : Encryption

Encryption

isConfigured
optional

Backup configuration status of both FTP server and passphrase
Example : true

boolean

4.6. BackupConfigurationSpec

Backup configuration Specification

Name Description Schema

backupLocations
optional

List of backup locations
Example : [ "BackupLocation" ]

< BackupLocation > array

encryption
optional

Encryption passphrase to encrypt and decrypt backup file
Example : Encryption

Encryption

4.7. BackupLocation

Backup location to backup VCF resources

Name Description Schema

directoryPath
optional

Full directory path to save the backup files
Example : "string"

string

password
required

Backup server password
Example : "string"

string

port
optional

Port number for the backup server to connect
Example : 0

integer (int32)

protocol
required

Protocol to be used for transferring files
Example : "SFTP"

string

server
optional

IP address of the backup server
Example : "string"

string

sshFingerprint
optional

SSH fingerprint of the backup server
Example : "string"

string

username
optional

Password for backup server username
Example : "string"

string

4.8. BackupResource

Element specification to trigger backup

Name Description Schema

resourceType
required

Resource type
Example : "SDDC_MANAGER"

string

4.9. BackupSpec

Backup Specification

Name Description Schema

elements
required

List of elements to be backed up
Example : [ "BackupResource" ]

< BackupResource > array

4.10. BackupTask

Name Description Schema

errors
optional

List of errors in case of a failure
Example : [ "Error" ]

< Error > array

id
optional

Backup task ID
Example : "string"

string

name
optional

Backup task name
Example : "string"

string

resources
optional

Backup resources, to get the backup details
Example : [ "Resource" ]

< Resource > array

status
optional

Backup task status
Example : "One among: IN_PROGRESS"

string

4.11. BaseCredential

Represents credentials of a resource in the system

Name Description Schema

credentialType
required

Credential type
Example : "One among: SSO, SSH, API, BASIC_AUTH, ADMINISTRATOR, FTP, JDBC, LDAP_DOMAIN_ADMIN, LDAP_READ_WRITE_ACCOUNT, VDI_ADMIN, SQL_SUPER_USER, SQL_DB_OWNER, SERVICE_ACCOUNT"

string

password
optional

Password
Example : "string"

string

username
required

Username
Example : "string"

string

4.12. BgpNeighbour

NSX Edge BGP Neighbour Specification

Name Description Schema

autonomousSystem
optional

BGP neighbour autonomous system ID
Example : 0

integer (int32)

forwardingIp
optional

BGP forwarding IP address
Length : 7 - 15
Example : "192.168.0.123"

string

holdDownTimeSeconds
optional

BGP neighbour hold down time (in seconds)
Example : 0

integer (int32)

keepAliveTimeSeconds
optional

BGP neighbour keep alive time (in seconds)
Example : 0

integer (int32)

neighbourIp
required

BGP neighbour IP address
Length : 7 - 15
Example : "192.168.0.123"

string

password
required

BGP neighbour password
Example : "string"

string

protocolIp
optional

BGP protocol IP address
Length : 7 - 15
Example : "192.168.0.123"

string

weight
optional

BGP neighbour weight
Example : 0

integer (int32)

4.13. BootstrapSpec

Name Description Schema

federationName
optional

Example : "string"

string

memberJoinDetail
optional

Example : MemberDetail

MemberDetail

4.14. Bundle

Bundle contains bits to install/update the appropriate Cloud Foundation software components in your management domain or workload domain.

Name Description Schema

components
optional

Bundle Components
Example : [ "BundleComponent" ]

< BundleComponent > array

description
optional

Bundle Description
Example : "string"

string

downloadStatus
required

Bundle Download Status
Example : "One among: PENDING, SCHEDULED, IN_PROGRESS, SUCCESSFUL, FAILED"

string

id
optional

Bundle ID
Example : "string"

string

isCumulative
optional

Is Bundle Cumulative
Example : true

boolean

releasedDate
optional

Bundle Release Date
Example : Instant

Instant

severity
required

Bundle Severity
Example : "One among: CRITICAL, IMPORTANT, MODERATE, LOW"

string

sizeMB
optional

Bundle Size in MB
Example : 0.0

number (double)

type
required

Bundle Type
Example : "One among: SDDC_MANAGER, VMWARE_SOFTWARE, VXRAIL"

string

vendor
optional

Bundle Vendor
Example : "string"

string

version
optional

Bundle Version
Example : "string"

string

4.15. BundleComponent

Bundle Software Component

Name Description Schema

description
optional

Bundle Component Description
Example : "string"

string

fromVersion
optional

Bundle Component’s from/source version before Upgrade
Example : "string"

string

id
optional

ID of Resource/Software Component
Example : "string"

string

imageType
required

Bundle Component Image Type
Example : "One among: PATCH, INSTALL"

string

releasedDate
optional

Bundle Component Release Date
Example : Instant

Instant

toVersion
optional

Bundle Component’s to/target version after Upgrade
Example : "string"

string

type
optional

Type of Resource/Software Component
Example : "string"

string

vendor
optional

Bundle Component Vendor
Example : "string"

string

4.16. BundleDownloadSpec

Bundle Download Specification. This specification gets used in the Bundle Download API

Name Description Schema

downloadNow
optional

Flag for enabling Download Now. If true, scheduledTimestamp is ignored
Example : true

boolean

scheduledTimestamp
optional

Bundle Download Scheduled Time
Example : Instant

Instant

4.17. BundleUpdateSpec

Bundle Update Specification.

Name Description Schema

bundleDownloadSpec
optional

Bundle Download Specification.
Example : BundleDownloadSpec

BundleDownloadSpec

4.18. BundleUploadSpec

Bundle Upload Specification. This specification is used in the Bundle Upload API

Name Description Schema

bundleFilePath
required

Bundle Upload File Path
Example : "string"

string

manifestFilePath
required

Bundle Upload Manifest File Path
Example : "string"

string

signatureFilePath
optional

Bundle Upload Signature File Path
Example : "string"

string

4.19. CPU

Name Description Schema

free
optional

Example : 0.0

number (double)

total
optional

Example : 0.0

number (double)

unallocated
optional

Example : 0.0

number (double)

unit
optional

Example : "GHZ"

enum (GHZ, GB, TB, HZ, KHZ, MHZ, THZ, B)

used
optional

Example : 0.0

number (double)

4.20. CapacitySummary

Name Description Schema

aggregatedCapacity
optional

Example : ResourceCapacity

ResourceCapacity

domainCount
optional

Example : 0

integer (int32)

domainInfo
optional

Example : [ "DomainInfo" ]

< DomainInfo > array

domainTypeInfo
optional

Example : [ "DomainSummary" ]

< DomainSummary > array

4.21. Ceip

Defines VCF CEIP status and instance id

Name Description Schema

instanceId
optional

Instance Id of VCF
Example : "3f39d4a1-78d2-11e8-af85-f1cf26258cdc"

string

status
required

CEIP status
Example : "One among: ENABLED, DISABLED, ENABLING, DISABLING, ENABLING_FAILED, DISABLING_FAILED"

string

4.22. CeipUpdateSpec

Specification for CEIP state change

Name Description Schema

status
required

User provided CEIP operation
Example : "One among: ENABLE, DISABLE"

string

4.23. Certificate

Represents certificate and its attributes

Name Description Schema

expirationStatus
required

Certificate expiry status
Example : "One among: ACTIVE, ABOUT_TO_EXPIRE, EXPIRED"

string

getCertificateError
required

Error if certificate cannot be fetched
Example : "string"

string

isInstalled
required

Whether the certificate is installed or not
Example : true

boolean

issuedBy
required

The certificate authority that issued the certificate
Example : "string"

string

issuedTo
required

To whom the certificate is issued
Example : "string"

string

keySize
required

The keysize of the certificate
Example : "One among: 2048, 3072, 4096"

string

notAfter
required

The timestamp after which certificate is not valid
Example : Instant

Instant

notBefore
required

The timestamp before which certificate is not valid
Example : Instant

Instant

numberOfDaysToExpire
required

Number of days left for the certificate to expire
Example : 0

integer (int32)

pemEncoded
required

The PEM encoded certificate content
Example : "string"

string

publicKey
required

The public key of the certificate
Example : "string"

string

publicKeyAlgorithm
required

The public key algorithm of the certificate
Example : "One among: RSA"

string

serialNumber
required

The serial number of the certificate
Example : "string"

string

signatureAlgorithm
required

Algorithm used to sign the certificate
Example : "string"

string

subject
required

Complete distinguished name to which the certificate is issued
Example : "string"

string

subjectAlternativeName
required

The alternative names to which the certificate is issued
Example : [ "string" ]

< string > array

thumbprint
required

Thumbprint generated using certificate content
Example : "string"

string

thumbprintAlgorithm
required

Algorithm used to generate thumbprint
Example : "string"

string

version
required

The X.509 version of the certificate
Example : "string"

string

4.24. CertificateAuthority

The Certificate Authority (CA) details

Name Description Schema

commonName
optional

OpenSSL CA domain name
Example : "string"

string

country
optional

ISO 3166 country code where company is legally registered
Example : "string"

string

id
required

CA type. Only supports Microsoft and OpenSSL CAs
Example : "One among: OpenSSL, Microsoft"

string

locality
optional

The city or locality where company is legally registered
Example : "string"

string

organization
optional

The name under which company is legally registered
Example : "string"

string

organizationUnit
optional

Organization with which the certificate is associated
Example : "string"

string

serverUrl
optional

Microsoft CA server url
Example : "string"

string

state
optional

The full name of the state where company is legally registered
Example : "string"

string

templateName
optional

Microsoft CA server template name
Example : "string"

string

username
optional

Microsoft CA server username
Example : "string"

string

4.25. CertificateAuthorityCreationSpec

This specification contains Certificate Authority (CA) creation details

Name Description Schema

microsoftCertificateAuthoritySpec
optional

Microsoft Certificate Authority specification
Example : MicrosoftCertificateAuthoritySpec

MicrosoftCertificateAuthoritySpec

openSSLCertificateAuthoritySpec
optional

OpenSSL Certificate Authority specification
Example : OpenSSLCertificateAuthoritySpec

OpenSSLCertificateAuthoritySpec

4.26. CertificateOperationSpec

This specification contains certificate operation request details

Name Description Schema

operationType
required

The Certificates operation type
Example : "One among: INSTALL"

string

resources
optional

Resource(s) in a domain
Example : [ "Resource" ]

< Resource > array

4.27. CertificatesGenerationSpec

This specification contains certificates generation request details

Name Description Schema

caType
required

CA type. Only supports Microsoft and OpenSSL CAs
Example : "One among: OpenSSL, Microsoft"

string

resources
optional

Resource(s) in a domain
Example : [ "Resource" ]

< Resource > array

4.28. Cluster

Cluster representation

Name Description Schema

hosts
optional

List of hosts associated with the cluster
Example : [ "HostReference" ]

< HostReference > array

id
optional

ID of the cluster
Example : "string"

string

isStretched
optional

Status of the cluster if Stretched or not
Example : true

boolean

name
optional

Name of the cluster
Example : "string"

string

primaryDatastoreName
optional

Name of the primary datastore
Example : "string"

string

primaryDatastoreType
optional

Storage type of the primary datastore
Example : "One among: VSAN, NFS, FC"

string

4.29. ClusterCompactionSpec

This specification contains the parameters required to remove one or more vSphere hosts from existing cluster in a workload domain

Name Description Schema

force
optional

Force removal of vSphere host
Example : true

boolean

hosts
optional

List of vSphere hosts to be removed
Example : [ "HostReference" ]

< HostReference > array

4.30. ClusterCreationSpec

This specification contains contains the parameters required to add a cluster to an existing workload Domain

Name Description Schema

computeSpec
required

Cluster specification to be added to the domain
Example : ComputeSpec

ComputeSpec

domainId
required

ID of the domain to which the clusters will be added
Example : "string"

string

4.31. ClusterExpansionSpec

This specification contains the parameters required to add one or more vSphere hosts to an existing cluster in a workload domain

Name Description Schema

hostSpecs
required

List of vSphere host information from the free pool to consume in the workload domain
Example : [ "HostSpec" ]

< HostSpec > array

4.32. ClusterOperationSpecValidation

This validation spec contains the specs for different operations on cluster

Name Description Schema

clusterUpdateSpec
optional

Parameters required to perform cluster update
Example : ClusterUpdateSpec

ClusterUpdateSpec

4.33. ClusterReference

Represents a reference to the cluster

Name Description Schema

id
required

ID of the cluster
Example : "string"

string

4.34. ClusterSpec

This specification contains the parameters required to add a cluster to a workload domain

Name Description Schema

advancedOptions
optional

Advanced options used for cluster creation
Example : AdvancedOptions

AdvancedOptions

datastoreSpec
required

Cluster storage configuration; e.g. VSAN, NFS
Example : DatastoreSpec

DatastoreSpec

hostSpecs
required

List of vSphere host information from the free pool to consume in the workload domain
Example : [ "HostSpec" ]

< HostSpec > array

name
required

Name of the new cluster that will be added to the specified workload domain
Example : "string"

string

networkSpec
required

Network configuration for the cluster
Example : NetworkSpec

NetworkSpec

4.35. ClusterStretchSpec

This spec contains the parameters required to convert a Standard vSAN cluster to a Stretched cluster

Name Description Schema

hostSpecs
required

List of vSphere host information from the free pool to consume in the workload domain
Example : [ "HostSpec" ]

< HostSpec > array

witnessSpec
required

Witness host information
Example : WitnessSpec

WitnessSpec

4.36. ClusterUnstretchSpec

This spec contains the parameters required to convert a Stretched cluster to a Standard vSAN cluster

4.37. ClusterUpdateSpec

This specification contains the parameters required to perform update operation on cluster

Name Description Schema

clusterCompactionSpec
optional

Parameters required to perform cluster compaction, optional otherwise
Example : ClusterCompactionSpec

ClusterCompactionSpec

clusterExpansionSpec
optional

Parameters required to perform cluster expansion, optional otherwise
Example : ClusterExpansionSpec

ClusterExpansionSpec

clusterStretchSpec
optional

Parameters required to perform Stretch operation on cluster, optional otherwise
Example : ClusterStretchSpec

ClusterStretchSpec

clusterUnstretchSpec
optional

Parameters required to perform Unstretch operation on cluster, optional otherwise
Example : ClusterUnstretchSpec

ClusterUnstretchSpec

markForDeletion
optional

Prepare the cluster for deletion
Example : true

boolean

4.38. ClustersOperationSpecValidation

This validation spec contains the specs for different operations on clusters

Name Description Schema

clusterCreationSpec
optional

Parameters required to perform cluster creation
Example : ClusterCreationSpec

ClusterCreationSpec

4.39. ComputeSpec

This specification contains the parameters required to add each cluster to a workload domain

Name Description Schema

clusterSpecs
required

List of clusters to be added to workload domain
Example : [ "ClusterSpec" ]

< ClusterSpec > array

4.40. Cpu

Represents information about CPUs on a host

Name Description Schema

cores
optional

Number of CPU cores
Example : 0

integer (int32)

cpuCores
optional

Information about each of the CPU cores
Example : [ "CpuCore" ]

< CpuCore > array

frequencyMHz
optional

Total CPU frequency in MHz
Example : 0.0

number (double)

4.41. CpuCore

Represents a CPU core

Name Description Schema

frequencyMHz
optional

CPU frequency in MHz
Example : 0.0

number (double)

manufacturer
optional

Hardware manufacturer of the CPU
Example : "string"

string

model
optional

Hardware model of the CPU
Example : "string"

string

4.42. Credential

Represents a credential and the resource to which it is associated with

Name Description Schema

credentialType
required

Credential type
Example : "One among: SSO, SSH, API, BASIC_AUTH, ADMINISTRATOR, FTP, JDBC, LDAP_DOMAIN_ADMIN, LDAP_READ_WRITE_ACCOUNT, VDI_ADMIN, SQL_SUPER_USER, SQL_DB_OWNER, SERVICE_ACCOUNT"

string

id
required

Credential ID
Example : "string"

string

password
required

Password
Example : "string"

string

resource
required

The resource which owns the credential
Example : AuthenticatedResource

AuthenticatedResource

username
required

Username
Example : "string"

string

4.43. CredentialsSubTask

Represents the credentials sub-task in the system

Name Description Schema

creationTimestamp
optional

Credential sub-task creation timestamp
Example : Instant

Instant

dependentSubTasks
optional

List of dependent sub-tasks of the credential sub-task
Example : [ "CredentialsSubTask" ]

< CredentialsSubTask > array

description
optional

Credential sub-task description
Example : "string"

string

errors
optional

List of errors in case of a failure
Example : [ "Error" ]

< Error > array

name
optional

Credential sub-task name
Example : "string"

string

status
optional

Credential sub-task status
Example : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, USER_CANCELLED, INCONSISTENT"

string

4.44. CredentialsTask

Represents the credentials task in the system

Name Description Schema

creationTimestamp
optional

Credential task creation timestamp
Example : Instant

Instant

errors
optional

List of errors in case of a failure
Example : [ "Error" ]

< Error > array

id
optional

Credential task ID
Example : "string"

string

name
optional

Credential task name
Example : "string"

string

status
optional

Credential task status
Example : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, USER_CANCELLED, INCONSISTENT"

string

subTasks
optional

List of credential sub-tasks of the credential task
Example : [ "CredentialsSubTask" ]

< CredentialsSubTask > array

4.45. CredentialsUpdateSpec

This specification contains password operation request details

Name Description Schema

elements
required

List of resource credentials to be changed
Example : [ "ResourceCredentials" ]

< ResourceCredentials > array

operationType
required

Operation type
Example : "One among: UPDATE, ROTATE"

string

4.46. Csr

The Certificate Signing Request (CSR) details

Name Description Schema

csrEncodedContent
required

The CSR encoded content
Example : "string"

string

resource
required

Resource associated with CSR
Example : Resource

Resource

4.47. CsrGenerationSpec

This specification contains Certificate Signing Request (CSR) details

Name Description Schema

country
required

ISO 3166 country code where company is legally registered
Example : "string"

string

email
optional

Contact email address
Example : "string"

string

keyAlgorithm
required

The public key algorithm of the certificate
Example : "One among: RSA"

string

keySize
required

Certificate public key size
Example : "One among: 2048, 3072, 4096"

string

locality
required

The city or locality where company is legally registered
Example : "string"

string

organization
required

The name under which company is legally registered
Example : "string"

string

organizationUnit
required

Organization with which the certificate is associated
Example : "string"

string

state
required

The full name of the state where company is legally registered
Example : "string"

string

4.48. CsrsGenerationSpec

This specification contains CSR Generation request details

Name Description Schema

csrGenerationSpec
required

The CSR specification to generate CSR for resource(s)
Example : CsrGenerationSpec

CsrGenerationSpec

resources
optional

Resource(s) in a domain
Example : [ "Resource" ]

< Resource > array

4.49. Datastore

Name Description Schema

capacity
optional

Example : 0.0

number (double)

datastoreName
optional

Example : "string"

string

datastoreType
optional

Example : "VSAN"

enum (VSAN, VMFS, NFS)

freeSpace
optional

Example : 0.0

number (double)

unallocated
optional

Example : 0.0

number (double)

unit
optional

Example : "GHZ"

enum (GHZ, GB, TB, HZ, KHZ, MHZ, THZ, B)

used
optional

Example : 0.0

number (double)

4.50. DatastoreSpec

This specification contains cluster storage configuration

Name Description Schema

nfsDatastoreSpecs
optional

Cluster storage configuration for NFS
Example : [ "NfsDatastoreSpec" ]

< NfsDatastoreSpec > array

vmfsDatastoreSpec
optional

Cluster storage configuration for VMFS
Example : VmfsDatastoreSpec

VmfsDatastoreSpec

vsanDatastoreSpec
optional

Cluster storage configuration for vSAN
Example : VsanDatastoreSpec

VsanDatastoreSpec

4.51. DateTimeDetail

Name Description Schema

dateTime
optional

Example : "string"

string

timestamp
optional

Example : 0

integer (int64)

4.52. DepotAccount

VMware Depot Account Information

Name Description Schema

password
required

Depot Password for Access
Example : "string"

string

username
required

Depot Username for Access
Example : "string"

string

4.53. DepotSettings

VMware Depot Settings

Name Description Schema

vmwareAccount
required

VMware Depot Account
Example : DepotAccount

DepotAccount

4.54. Disk

Represents a disk

Name Description Schema

capacityMB
optional

Total capacity of the disk in MB
Example : 0.0

number (double)

diskType
optional

Type of the disk.
Example : "One among: HDD, FLASH"

string

manufacturer
optional

Hardware manufacturer of the disk
Example : "string"

string

model
optional

Hardware model of the disk
Example : "string"

string

4.55. DnsSpec

Spec contains parameters of Domain Name System

Name Description Schema

domain
required

Tenant domain
Example : "vmware.com"

string

nameserver
optional

Primary nameserver to be configured for vCenter/PSC/ESXi’s/NSX
Example : "172.0.0.4"

string

secondaryNameserver
optional

Secondary nameserver to be configured for vCenter/PSC/ESXi’s/NSX
Example : "172.0.0.5"

string

subdomain
required

Tenant Sub domain
Example : "vcf.vmware.com"

string

4.56. Domain

Represents a domain

Name Description Schema

clusters
optional

List of clusters associated with the workload domain
Example : [ "ClusterReference" ]

< ClusterReference > array

id
optional

ID of the workload domain
Example : "string"

string

name
optional

Name of the workload domain
Example : "string"

string

vcenters
optional

List of vCenters associated with the workload domain
Example : [ "VcenterReference" ]

< VcenterReference > array

4.57. DomainCreationSpec

This specification contains the parameters required to create a new workload domain

Name Description Schema

computeSpec
required

Specification representing the clusters to be added to the workload domain
Example : ComputeSpec

ComputeSpec

domainName
required

Name of the workload domain
Example : "string"

string

nsxTSpec
optional

Specification details for NSX-T configuration
Example : NsxTSpec

NsxTSpec

nsxVSpec
optional

Specification details for NSX-V configuration
Example : NsxVSpec

NsxVSpec

vcenterSpec
required

Specification details for vCenter
Example : VcenterSpec

VcenterSpec

4.58. DomainInfo

Name Description Schema

domainCapacity
optional

Example : ResourceCapacity

ResourceCapacity

domainId
optional

Example : "string"

string

name
optional

Example : "string"

string

status
optional

Example : "string"

string

type
optional

Example : "string"

string

4.59. DomainIntegration

This specification contains information related to the existing vRealize Operations instance deployment

Name Description Schema

domainId
optional

The ID of the workload domain
Example : "string"

string

status
required

The association status of the workload domain
Example : "ENABLED, DISABLED, IN_PROGRESS"

enum (ENABLED, DISABLED)

4.60. DomainReference

Represents a domain reference

Name Description Schema

id
required

ID of the domain
Example : "string"

string

4.61. DomainSummary

Name Description Schema

aggregatedCapacity
optional

Example : ResourceCapacity

ResourceCapacity

domainCount
optional

Example : 0

integer (int32)

type
optional

Example : "string"

string

4.62. DomainUpdateSpec

Contains the parameters required to perform update operation on domain

Name Description Schema

markForDeletion
optional

Enable deletion of domain
Example : true

boolean

4.63. DomainsOperationSpecValidation

This validation spec contains the specs for different operations on domains

Name Description Schema

domainCreationSpec
optional

Parameters required to perform domain creation
Example : DomainCreationSpec

DomainCreationSpec

4.64. DvsSpec

Spec contains parameters for DVS

Name Description Schema

dvsName
required

DVS Name
Example : "string"

string

mtu
optional

DVS MTU (default value is 9000)
Minimum value : 1500
Maximum value : 9000
Example : 0

integer (int32)

networks
required

Types of networks in this portgroup
Example : "One among:VSAN, VMOTION, PUBLIC, MANAGEMENT, NSX_VTEP, HOSTMANAGEMENT, CLOUD_VENDOR_API, REPLICATION, DATACENTER_NETWORK, NSX_VXLAN, NON_ROUTABLE, CLOUD_VENDOR_API, OOB, CROSS_VPC, UPLINK01, UPLINK02, STORAGE, UDLR, DLR, X_REGION, REGION_SPECIFIC, REMOTE_REGION_SPECIFIC, COMPUTE, MANAGEMENT_VM"

< string > array

niocSpecs
optional

List of NIOC specs for networks
Example : [ "NiocSpec" ]

< NiocSpec > array

vmnics
required

Vmnics to be attached to the DVS
Example : [ "string" ]

< string > array

4.65. Encryption

Restore Specification

Name Description Schema

passphrase
required

Passphrase
Example : "string"

string

4.66. Endpoint

Represents an Endpoint in a Domain

Name Description Schema

type
required

Type of the Endpoint
Example : "One among: PSC, VCENTER, NSX_MANAGER, NSX_T_MANAGER, VRLI, VRA, VROPS, VRSLCM"

string

url
required

Url of the Endpoint
Example : "string"

string

4.67. Error

Error response containing a minor error code, a localized error message, a localized remediation message and optionally a reference token to correlate the error with the logs

Name Description Schema

arguments
optional

The arguments used to localize the message, Can be used by scripts to automate the error processing.
Example : [ "string" ]

< string > array

causes
optional

The underlying cause exceptions.
Example : [ "ErrorCause" ]

< ErrorCause > array

context
optional

The error context (e.g. the component where it occurred).
Example : {
"string" : "string"
}

< string, string > map

errorCode
optional
read-only

The minor error code
Example : "string"

string

message
optional

The localized error message
Example : "string"

string

nestedErrors
optional

The nested errors when the error is a composite one
Example : [ "Error" ]

< Error > array

referenceToken
optional

A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.
Example : "string"

string

remediationMessage
optional

The localized remediation error message
Example : "string"

string

4.68. ErrorCause

Name Description Schema

message
optional

Example : "string"

string

type
optional

Example : "string"

string

4.69. ErrorResponse

Name Description Schema

arguments
optional

Example : [ "string" ]

< string > array

cause
optional

Example : [ "ErrorCause" ]

< ErrorCause > array

context
optional

Example : {
"string" : "string"
}

< string, string > map

errorCode
optional

Example : "string"

string

message
optional

Example : "string"

string

nestedErrors
optional

Example : [ "ErrorResponse" ]

< ErrorResponse > array

referenceToken
optional

Example : "string"

string

remediationMessage
optional

Example : "string"

string

4.70. FcSpec

Cluster storage configuration for VMFS on FC

Name Description Schema

datastoreName
required

Datastore name used for cluster creation
Example : "string"

string

4.71. FederationOperationError

Name Description Schema

error
optional

Example : "string"

string

suggestedRemedy
optional

Example : "string"

string

4.72. FederationTask

Name Description Schema

created
optional

Example : DateTimeDetail

DateTimeDetail

errors
optional

Example : [ "FederationOperationError" ]

< FederationOperationError > array

lastUpdated
optional

Example : DateTimeDetail

DateTimeDetail

operation
optional

Example : "BOOTSTRAP"

enum (BOOTSTRAP, START, STOP, TEARDOWN, INVITE_MEMBER, EVICT_MEMBER, JOIN, HANDLE_JOIN, HANDLE_CONTROLLER_JOIN, LEAVE, HANDLE_LEAVE, HANDLE_CONTROLLER_LEAVE, HANDLE_CERT_ROTATION)

payload
optional

Example : RemoteResponsePayload

RemoteResponsePayload

progressDetails
optional

Example : "string"

string

remoteOperationTask
optional

Example : FederationTask

FederationTask

status
optional

Example : "NOT_STARTED"

enum (NOT_STARTED, SUCCEEDED, FAILED, IN_PROGRESS, UNKNOWN)

taskId
optional

Example : "string"

string

4.73. HighAvailability

This specification contains high availability settings

Name Description Schema

enabled
required

Example : true

boolean

4.74. Horizon

Configuration specification, containing all attributes, required to create or expand a new Horizon deployment in an existing VCF instance.

Name Description Schema

appVolumesDetails
optional

App Volumes details configuration section. Contains information about App Volumes servers and their attributes.
Example : HorizonAppVolumesDetails

HorizonAppVolumesDetails

horizon
required

Horizon details configuration section. Contains information about Horizon pods, servers, appliances and their attributes.
Example : HorizonDetails

HorizonDetails

id
optional

A unique ID of the Horizon deployment.
Example : "string"

string

managementVcenters
required

A list of management vCenters configuration details, used for the deployment of the Horizon topology infrastructure.
Example : [ "HorizonManagementVcenter" ]

< HorizonManagementVcenter > array

name
required

A unique name, that describes the Horizon deployment.
Example : "string"

string

peripheralServices
required

Peripheral services configuration section. Contains information about load balancers, Active directory, install binaries and SQL connections.
Example : HorizonPeripheralServices

HorizonPeripheralServices

resourceVcenters
optional

A list of resource vCenters configuration details, used for the deployment of the actual Horizon deployment workload.
Example : [ "HorizonResourceVcenter" ]

< HorizonResourceVcenter > array

4.75. HorizonActiveDirectory

Active directory details required for Horiozn deployment.

Name Description Schema

adminPassword
optional

Domain administrator password (used when deploying internal Active directory).
Example : "string"

string

adminUsername
optional

Domain administrator user (used when deploying internal Active directory).
Example : "string"

string

domainControllers
required

A list of domain controller details.
Example : [ "HorizonDomainController" ]

< HorizonDomainController > array

fqdn
required

FQDN of the Active directory.
Example : "string"

string

netBiosName
optional

Net BIOS name.
Example : "string"

string

ouRwPassword
required

Horizon deployment user’s password for Organizational Unit(OU) access.
Example : "string"

string

ouRwUsername
required

Horizon deployment user for Organizational Unit(OU) access.
Example : "string"

string

securedAD
optional

Use Active directory through LDAP over SSL.
Example : true

boolean

vdiAdminPassword
required

Horizon deployment administrator password.
Example : "string"

string

vdiAdminUsername
required

Horizon deployment administrator user.
Example : "string"

string

vdiServerOu
required

Horizon servers deployment Organizational Unit(OU).
Example : "string"

string

4.76. HorizonAppVolumes

App Volumes server details required for Horizon deployment.

Name Description Schema

deployDetails
required

Deployment details of the App Volumes.
Example : HorizonDeployDetails

HorizonDeployDetails

fqdn
required

App Volumes server FQDN.
Example : "string"

string

state
optional

Virtual machine state of the App Volumes server. If not provided, NEW is default.
Example : "NEW"

enum (NEW, DEPLOYED)

4.77. HorizonAppVolumesDataStore

App Volumes datastore configuration.

Name Description Schema

id
required

App Volumes datastore ID. Should match the ID of a datastore from one of resource vCenters configuration details.
Example : "string"

string

isPrimary
required

Is this the default datastore?
Example : true

boolean

4.78. HorizonAppVolumesDetails

App Volumes details required for deployment.

Name Description Schema

adminGroupName
required

Admin Group Name from the Active directory. All members of this group will be App Volumes administrators.
Example : "string"

string

appVolumes
required

A list of App Volumes servers details.
Example : [ "HorizonAppVolumes" ]

< HorizonAppVolumes > array

datastores
optional

A list of datastores, that will be configured for use by App Volumes. The ID of every datastore, should match a datastore from a resource vCenter configuration details.
Example : [ "HorizonAppVolumesDataStore" ]

< HorizonAppVolumesDataStore > array

dbName
required

App Volumes database name.
Example : "string"

string

lbFqdn
required

FQDN of the App Volumes load balancer.
Example : "string"

string

license
optional

App Volumes license key.
Example : "string"

string

sqlId
required

SQL ID(alias) for the App Volumes database. This ID(alias) should match one of SQL connections in Peripheral services configuration section.
Example : "string"

string

4.79. HorizonCluster

Cluster configuration details for a datacenter in resource vCenter.

Name Description Schema

hosts
required

A list of Host objects, for the current cluster, as configured in the resource vCenter. All host IDs should match the ones in Datastore configuration details objects.
Example : [ "HorizonHost" ]

< HorizonHost > array

name
required

Cluster name, as configured in the resource vCenter.
Example : "string"

string

4.80. HorizonComposerServer

Horizon View Composer server details required for deployment.

Name Description Schema

certificatePassword
optional

Certificate password
Example : "string"

string

certificatePath
optional

Full path to the certificate file.
Example : "string"

string

composerServiceAccount
required

Composer service account
Example : "string"

string

composerServicePassword
required

Horizon View Composer service password
Example : "string"

string

dbName
required

Horizon View Composer database name
Example : "string"

string

deployDetails
required

Deployment details of the Horizon View Composer server.
Example : HorizonDeployDetails

HorizonDeployDetails

fqdn
required

Horizon View Composer server FQDN.
Example : "string"

string

internalDbPassword
optional

Internal database password, used when local SQL(per server) option is used. Account with this user name will be created and used by Horizon View Composer server.
Example : "string"

string

internalDbUsername
optional

Internal database username, used when local SQL(per server) option is used. Required, if local copy of SQL express will be deployed. Account with this user name will be created and used by Horizon View Composer server.
Example : "string"

string

sqlId
optional

SQL ID(alias) for the Horizon View Composer server database. This ID(alias) should match one of SQL connections in Peripheral services configuration section. If this is defined, SQL server pointed by this alias will be used as database for Horizon View Composer server. If this is null, local copy of SQL express will be deployed on Horizon View Composer machine to be used as database backend.
Example : "string"

string

state
optional

Virtual machine state of the Horizon View Composer server. If not provided, NEW is default.
Example : "NEW"

enum (NEW, DEPLOYED)

vcFqdn
optional

FQDN of the vCenter for the current Horizon View Composer server.
Example : "string"

string

4.81. HorizonConnectionServer

Horizon View Connection server details required for deployment.

Name Description Schema

certificatePassword
optional

Certificate password
Example : "string"

string

certificatePath
optional

Full path to the certificate file.
Example : "string"

string

deployDetails
required

Deployment details of the Horizon View Connection server.
Example : HorizonDeployDetails

HorizonDeployDetails

fqdn
required

Horizon View Connection server FQDN.
Example : "string"

string

state
optional

Virtual machine state of the Horizon View Connection server. If not provided, NEW is default.
Example : "NEW"

enum (NEW, DEPLOYED)

4.82. HorizonDatacenter

Datacenter configuration details for a resource vCenter. Should be aligned with the App Volumes configuration.

Name Description Schema

clusters
required

A list of cluster details objects for the datacenter.
Example : [ "HorizonCluster" ]

< HorizonCluster > array

datastores
required

A list of datstore details objects for the datacenter.
Example : [ "HorizonDatastore" ]

< HorizonDatastore > array

name
required

Datacenter name, as configured in the resource vCenter.
Example : "string"

string

4.83. HorizonDatastore

Datastore configuration details for a resource vCenter’s datacenter.

Name Description Schema

hostIds
optional

A list of host ID strings for this datastore. Every ID should match the ones in the Datacenter.cluster.hosts configuration details.
Example : [ "string" ]

< string > array

id
optional

The ID of the datastore, should be unique across all all datastores, defined in the configuration specification. It is used to identify the datastores in App Volumes configuration details, so the information in both sections should be fully aligned.
Example : "string"

string

name
required

Datastore name, as configured in the resource vCenter.
Example : "string"

string

4.84. HorizonDeployDetails

Virtual machine deployment configuration details.

Name Description Schema

computerName
required

Computer name of the virtual machine as defined in its OS.
Example : "string"

string

gateway
required

Gateway for the virtual machine.
Example : "string"

string

ipAddress
required

IP address of the virtual machine.
Example : "string"

string

subnetMask
required

Subnet mask for the virtual machine.
Example : "string"

string

vmName
required

Name of the virtual machine as defined in the vCenter.
Example : "string"

string

4.85. HorizonDetails

Horizon View details required for deployment.

Name Description Schema

adminGroupName
required

Admin Group Name from the Active directory. All members of this group will be Horizon domain administrators.
Example : "string"

string

externalLbFqdn
optional

FQDN of the external(internet) load balancer.
Example : "string"

string

internalLbFqdn
optional

FQDN of the internal(backend) load balancer.
Example : "string"

string

license
optional

Horizon View license key.
Example : "string"

string

pods
required

A list of Horizon pod details.
Example : [ "HorizonPodResources" ]

< HorizonPodResources > array

uemDetails
optional

User Environment Manager(UEM) details
Example : HorizonUemDetails

HorizonUemDetails

4.86. HorizonDomainController

Active directory domain controller details.

Name Description Schema

fqdn
optional

FQDN of the domain controller.
Example : "string"

string

ipAddress
required

IP address of the domain controller.
Example : "string"

string

sslThumbprint
optional

SSL thumbprint (SHA1) of the domain controller.
Example : "string"

string

state
optional

Virtual machine state of the domain controller. If not provided, NEW is default.
Example : "NEW"

enum (NEW, DEPLOYED)

4.87. HorizonHost

Host configuration details for a datacenter cluster definition in resource vCenter.

Name Description Schema

fqdn
required

FQDN or IP, as configured in the resource vCenter.
Example : "string"

string

id
required

The ID of the host as referenced in the relevant resource vCenter’s cluster (hosts list).
Example : "string"

string

password
required

Host password.
Example : "string"

string

username
required

Host username.
Example : "string"

string

4.88. HorizonInstallDetails

Installation executables and templates details required for Horizon deployment.

Name Description Schema

appVolumesServerBinaryPath
optional

App Volumes installation executable path.
Example : "string"

string

appVolumesServerVersion
optional

App Volumes version.
Example : "string"

string

composerServerBinaryPath
optional

Composer server installation executable path.
Example : "string"

string

composerServerVersion
optional

Composer server version.
Example : "string"

string

connectionServerBinaryPath
required

Connection server installation executable path.
Example : "string"

string

connectionServerVersion
optional

Connection server version.
Example : "string"

string

dotNet462BinaryPath
optional
NET Framework 4.6.2 installation executable path. Required if the provided Open Virtual Appliance(OVA) image is for Windows 2012 and VMware Horizon View Composers will be deployed. +

Example : "string"

string

imagePath
required

Open Virtual Appliance(OVA) teplate image path.
Example : "string"

string

ova
optional

Open Virtual Appliance(OVA) image details.
Example : HorizonOva

HorizonOva

sqlExpressPath
optional

Microsoft SQL Server Express installation executable path.
Example : "string"

string

sqlExpressVersion
optional

Microsoft SQL Server Express version.
Example : "string"

string

uagOvaPath
optional

Unified Access Gateway(UAG) Open Virtual Appliance(OVA) image path.
Example : "string"

string

uagOvaVersion
optional

Unified Access Gateway(UAG) Open Virtual Appliance(OVA) image version.
Example : "string"

string

uemBinaryPath
optional

User Environment Manager(UEM) installation executable path.
Example : "string"

string

uemVersion
optional

User Environment Manager(UEM) version.
Example : "string"

string

updateKb2919355BinaryPath
optional

Windows KB2919355 installation executable path.Required if the provided Open Virtual Appliance(OVA) image is for Windows 2012 and internal SQL server or VMware Horizon View Composers will be deployed.
Example : "string"

string

updateKb2919442BinaryPath
optional

Windows KB2919442 installation executable path. Required if the provided Open Virtual Appliance(OVA) image is for Windows 2012 and internal SQL server or VMware Horizon View Composers will be deployed.
Example : "string"

string

4.89. HorizonLbDeployDetails

Load balancer virtual machine deployment configuration details.

Name Description Schema

cliPassword
optional

Command Line Interface(CLI) password.
Example : "string"

string

gateway
required

Gateway of the load balancer
Example : "string"

string

portgroup
required

Portgroup of the load balancer
Example : "string"

string

subnetMask
required

Subnet mask of the load balancer
Example : "string"

string

vmName
required

Name of the load balancer virtual machine
Example : "string"

string

4.90. HorizonLoadBalancer

Load balancer configuration details

Name Description Schema

certificatePassword
optional

Certificate password
Example : "string"

string

certificatePath
optional

Full path to the certificate file.
Example : "string"

string

deployDetails
optional

Deployment details of the load balancer virtual machine.
Example : HorizonLbDeployDetails

HorizonLbDeployDetails

fqdn
required

FQDN of the load balancer.
Example : "string"

string

ipAddress
required

IP address of the load balancer.
Example : "string"

string

state
optional

Virtual machine state of the load balancer. If not provided, NEW is default.
Example : "NEW"

enum (NEW, DEPLOYED)

4.91. HorizonManagementVcenter

Management vCenter details required to create or expand Horizon deployment.

Name Description Schema

clusterName
required

Name of the cluster in the management vCenter.
Example : "string"

string

datacenterName
required

Name of the datacenter in the management vCenter.
Example : "string"

string

datastoreName
required

Name of the datastore in the management vCenter.
Example : "string"

string

dmzPortgroup
optional

Portgroup name, associated with the DMZ network.
Example : "string"

string

host
required

vCenter hostname or IP
Example : "string"

string

interconnectPortgroup
optional

Name of the portgroup, connecting the Unified Access Gateway (UAG) and Horizon View Connection servers.
Example : "string"

string

managementPortgroup
required

Portgroup name, associated with the Management network.
Example : "string"

string

nsx
optional

A configuration section for NSX, containing host and credentials for accessing it.
Example : HorizonNsx

HorizonNsx

password
required

Password for the vCenter
Example : "string"

string

psc
required

PSC
Example : HorizonPsc

HorizonPsc

uagManagementPortgroup
optional

Portgroup name, associated with the Unified Access Gateway (UAG) management network.
Example : "string"

string

username
required

Username for the vCenter
Example : "string"

string

4.92. HorizonNsx

Configuration section for NSX details, required to deploy a VDI domain.

Name Description Schema

host
optional

NSX hostname or IP.
Example : "string"

string

password
optional

NSX password.
Example : "string"

string

4.93. HorizonOva

OVA image details.

Name Description Schema

administratorPassword
required

Administrator password for the OVA image.
Example : "string"

string

administratorUsername
required

Administrator username for the OVA image.
Example : "string"

string

4.94. HorizonPeripheralServices

Peripheral services (load balancers, Active directory, install binaries and SQL connections) configuration section with details required for Horizon deployment.

Name Description Schema

activeDirectory
required

Active directory configuration details section.
Example : HorizonActiveDirectory

HorizonActiveDirectory

installDetails
required

Install binaries path and version definitions for the software that is being installed during a Horizon deployment.
Example : HorizonInstallDetails

HorizonInstallDetails

loadBalancers
required

A list of configuration details for all different types of load balancers needed for the Horizon deployment.
Example : [ "HorizonLoadBalancer" ]

< HorizonLoadBalancer > array

sqlConnections
optional

A list of external or internal SQL server connection configuration details.
Example : [ "HorizonSqlConnection" ]

< HorizonSqlConnection > array

4.95. HorizonPodResources

Pod resource details required for Horizon deployment.

Name Description Schema

composerServers
optional

A list of Horizon View Composer servers details.
Example : [ "HorizonComposerServer" ]

< HorizonComposerServer > array

connectionServers
required

A list of Horizon View Connection servers details. At least one server is required.
Example : [ "HorizonConnectionServer" ]

< HorizonConnectionServer > array

eventDbName
required

Events database name.
Example : "string"

string

sqlId
required

SQL ID(alias) for the Events database. This ID(alias) should match one of SQL connections in Peripheral services configuration section.
Example : "string"

string

uagAppliances
optional

A list of Unified Access Gateway(UAG) appliances details.
Example : [ "HorizonUagAppliance" ]

< HorizonUagAppliance > array

vcFqdns
optional

A list of vCenter FQDNs, relevant for current Horizon pod.
Example : [ "string" ]

< string > array

4.96. HorizonPsc

PSC details required for Horizon deployment.

Name Description Schema

host
required

PSC hostname or IP
Example : "string"

string

4.97. HorizonResourceVcenter

Resource vCenter details required for a Horizon deployment.

Name Description Schema

datacenters
optional

A list of Datacenters' details, configured in this vCenter. When present, it should be aligned with the App Volumes configuration.
Example : [ "HorizonDatacenter" ]

< HorizonDatacenter > array

host
required

vCenter hostname or IP
Example : "string"

string

password
required

Password for the vCenter
Example : "string"

string

psc
required

PSC
Example : HorizonPsc

HorizonPsc

state
optional

Virtual machine state of the resource vCenter. If not provided, NEW is default.
Example : "NEW"

enum (NEW, DEPLOYED)

username
required

Username for the vCenter
Example : "string"

string

4.98. HorizonSqlConnection

SQL server connection configuration details required to create or expand Horizon deployment.

Name Description Schema

dbPassword
required

SQL server password. When deploying an internal SQL server, an account with this user name will be automatically created (with proper permissions for creating/altering databases and tables). FOr external SQL connections, the user has to be pre-created and should have permissions for creating/altering databases and tables.
Example : "string"

string

dbUsername
required

SQL server username. When deploying an internal SQL server, an account with this user name will be automatically created (with proper permissions for creating/altering databases and tables). For external SQL connections, the user has to be pre-created and should have permissions for creating/altering databases and tables.
Example : "string"

string

fqdn
required

IP or FQDN of the SQL server.
Example : "string"

string

id
required

Unique ID(known also as SQL alias) for identifying specific Sql connection across the configuration specification. It is used for reference purposes in different configuration sections (such as Horizon pods, servers and App Volumes).
Example : "string"

string

sqlInstanceName
optional

Name of the instance on the SQL server.
Example : "string"

string

sqlPort
optional

SQL server port. Default one is 1433.
Example : 0

integer (int32)

state
optional

Virtual machine state of the SQL server. If not provided, NEW is default.
Example : "NEW"

enum (NEW, DEPLOYED)

4.99. HorizonUagAppliance

Unified Access Gateway(UAG) appliance details required for Horizon deployment.

Name Description Schema

administratorPassword
required

Administrator password
Example : "string"

string

defaultGateway
required

Default gateway. Should be in the external network(internet).
Example : "string"

string

externalIpAddress
required

External network(internet) IP
Example : "string"

string

externalSubnetMask
required

External network(internet) subnet mask
Example : "string"

string

internalIpAddress
required

Internal(backend) network IP
Example : "string"

string

internalSubnetMask
required

Internal(backend) network subnet mask
Example : "string"

string

mgmtIpAddress
required

Management network IP address
Example : "string"

string

mgmtSubnetMask
required

Management network subnet mask
Example : "string"

string

state
optional

Virtual machine state of the Unified Access Gateway(UAG). If not provided, NEW is default.
Example : "NEW"

enum (NEW, DEPLOYED)

vmName
required

Name of the Unified Access Gateway(UAG) virtual machine.
Example : "string"

string

4.100. HorizonUem

User Environment Manager(UEM) server details required for Horizon deployment.

Name Description Schema

configurationShare
required

Configuration share name(from the OS).
Example : "string"

string

deployDetails
required

Deployment details of the User Environment Manager(UEM).
Example : HorizonUemDeployDetails

HorizonUemDeployDetails

fqdn
required

User Environment Manager(UEM) server FQDN.
Example : "string"

string

profileArchiveShare
required

Profile archive share name(from the OS).
Example : "string"

string

state
optional

Virtual machine state of the User Environment Manager(UEM). If not provided, NEW is default.
Example : "NEW"

enum (NEW, DEPLOYED)

4.101. HorizonUemDeployDetails

User Environment Manager(UEM) deployment details.

Name Description Schema

computerName
required

Computer name of the virtual machine as defined in its OS.
Example : "string"

string

configurationShareLocation
required

Configuration share location.
Example : "string"

string

dataDriveSizeGb
required

Data drive size in gigabytes.
Example : 0

integer (int32)

gateway
required

Gateway for the virtual machine.
Example : "string"

string

ipAddress
required

IP address of the virtual machine.
Example : "string"

string

profileArchiveShareLocation
required

Profile archive share location.
Example : "string"

string

subnetMask
required

Subnet mask for the virtual machine.
Example : "string"

string

vmName
required

Name of the virtual machine as defined in the vCenter.
Example : "string"

string

4.102. HorizonUemDetails

User Environment Manager(UEM) server details required for Horizon deployment.

Name Description Schema

license
optional

User Environment Manager(UEM) server license key.
Example : "string"

string

uems
required

A list of User Environment Manager(UEM) server details.
Example : [ "HorizonUem" ]

< HorizonUem > array

4.103. HorizonUpdateSpec

This specification contains the parameters required to perform partial update operation on horizon

Name Description Schema

markForDeletion
optional

Prepare horizon for deletion
Example : true

boolean

4.104. HorizonValidationOperation

Horizon Validation Operation section describes single Validation.

Name Description Schema

type
required

Horizon Validation Operation type
Example : "PRE_VALIDATION_CREATION, PRE_VALIDATION_EXPANSION"

string

4.105. HorizonValidationSpec

Horizon Validation Spec, which contains details that are needed to trigger different validations

Name Description Schema

horizon
required

Horizon spec, which will be validated.
Example : Horizon

Horizon

horizonValidationOperation
required

Horizon Validation Operation details.
Example : HorizonValidationOperation

HorizonValidationOperation

4.106. Host

Represents an Esxi host in the system

Name Description Schema

cluster
optional

Information about the cluster this host is part of
Example : ClusterReference

ClusterReference

compatibleStorageType
optional

Information about the host compatible storage type
Example : "string"

string

cpu
optional

Information about CPUs on the host
Example : CPU

Cpu

domain
optional

Information about the domain this host is part of
Example : DomainReference

DomainReference

esxiVersion
optional

ESXi software version of the host
Example : "string"

string

fqdn
optional

FQDN of the host
Example : "string"

string

hardwareModel
optional

Hardware model of the host
Example : "string"

string

hardwareVendor
optional

Hardware vendor of the host
Example : "string"

string

id
optional

ID of the host
Example : "string"

string

ipAddresses
optional

Information about IP addresses assigned to the host
Example : [ "IpAddress" ]

< IpAddress > array

memory
optional

Information about memory on the host
Example : Memory

Memory

networkpool
optional

Information about the network pool this host is part of
Example : NetworkPoolReference

NetworkPoolReference

physicalNics
optional

Information about physical NICs on the host
Example : [ "PhysicalNic" ]

< PhysicalNic > array

status
optional

Status of the host
Example : "One among: ASSIGNED, UNASSIGNED_USEABLE, UNASSIGNED_UNUSEABLE"

string

storage
optional

Information about storage on the host
Example : Storage

Storage

4.107. HostCommissionSpec

This specification contains the input to commission a host to VMware Cloud Foundation

Name Description Schema

fqdn
required

FQDN of the host
Example : "string"

string

networkPoolId
required

ID of the network pool to associate the host with
Example : "string"

string

networkPoolName
optional

Name of the network pool to associate the host with
Example : "string"

string

password
required

Password of the host
Example : "string"

string

storageType
required

Storage Type
Example : "One among: VSAN, NFS, VMFS_FC"

string

username
required

Username of the host
Example : "string"

string

4.108. HostCount

Name Description Schema

total
optional

Example : 0

integer (int32)

unallocated
optional

Example : 0

integer (int32)

used
optional

Example : 0

integer (int32)

4.109. HostDecommissionSpec

This specification contains host details required to decommission a host from VMware Cloud Foundation

Name Description Schema

fqdn
required

FQDN of the host
Example : "string"

string

4.110. HostNetworkSpec

This specification contains network details required when adding a vSphere host to a cluster

Name Description Schema

vmNics
optional

List of the vSphere host vmNics
Example : [ "VmNic" ]

< VmNic > array

4.111. HostReference

Represents an ESXi host reference

Name Description Schema

id
required

ID of the host
Example : "string"

string

4.112. HostSpec

This specification contains information required to add vSphere host to a cluster

Name Description Schema

hostNetworkSpec
optional

Network Details of a vSphere host in the free pool
Example : HostNetworkSpec

HostNetworkSpec

id
required

ID of a vSphere host in the free pool
Example : "string"

string

licenseKey
optional

License key of a vSphere host in the free pool
(This is required except in cases where the ESXi host has already been licensed outside of the VMware Cloud Foundation system)
Example : "string"

string

4.113. HostVmknicSpec

Spec contains parameters for ESXi Host Vmknic

Name Description Schema

ipAddress
optional

Vmknic IP address
Length : 7 - 15
Example : "string"

string

macAddress
optional

Vmknic mac address
Length : 18
Example : "string"

string

portgroup
required

Portgroup
Example : "One among:VSAN, VMOTION, PUBLIC, MANAGEMENT, NSX_VTEP, HOSTMANAGEMENT, CLOUD_VENDOR_API, REPLICATION"

string

4.114. HostsOperationSpecValidation

This validation spec contains the specs for different operations on hosts

Name Description Schema

hostCommissionSpecs
optional

List of host commission spec
Example : [ "HostCommissionSpec" ]

< HostCommissionSpec > array

4.115. Instant

Name Description Schema

epochSecond
optional

Example : 0

integer (int64)

nano
optional

Example : 0

integer (int32)

4.116. InventoryInfo

Name Description Schema

hostCount
optional

Example : HostCount

HostCount

4.117. InvitationSpec

Name Description Schema

inviteeFqdn
optional

Example : "string"

string

inviteeRole
optional

Example : "CONTROLLER"

enum (CONTROLLER, MANAGER, MEMBER, NOT_JOINED)

tokenExpiryHours
optional

Example : 0.0

number (float)

4.118. IpAddress

Represents IP address

Name Description Schema

ipAddress
optional

IP address
Example : "string"

string

type
optional

Type of IP addresss
Example : "One among: MANAGEMENT, VSAN, VMOTION, NFS"

string

4.119. IpAllocation

Defines an IP address with gateway and subnet

Name Description Schema

cidr
optional

Classless Inter-Domain Routing (CIDR)
Length : 10 - 18
Example : "172.0.0.0/24"

string

gateway
required

Gateway
Length : 7 - 15
Example : "192.168.0.1"

string

ipAddress
required

IP Address
Length : 7 - 15
Example : "192.168.0.123"

string

subnet
optional

Subnet
Length : 7 - 15
Example : "255.255.255.252"

string

4.120. IpPool

Represents an IP Pool of a network in a network pool

Name Description Schema

end
optional

End IP address of the IP pool
Example : "string"

string

start
optional

Start IP address of the IP pool
Example : "string"

string

4.121. IpRange

Spec contains parameters for range of IP addresses

Name Description Schema

endIpAddress
required

End IP Address
Length : 7 - 15
Example : "192.168.0.128"

string

startIpAddress
required

Start IP Address
Length : 7 - 15
Example : "192.168.0.123"

string

4.122. LicenseKey

Defines a license key and its attributes

Name Description Schema

description
required

Description of the license key
Example : "string"

string

id
optional

The ID of the license key
Example : "string"

string

isUnlimited
optional

Indicates if the license key has unlimited usage
Example : true

boolean

key
required

The 29 alpha numeric character license key with hyphens
Example : "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX"

string

licenseKeyUsage
optional

License key usage details
Example : LicenseKeyUsage

LicenseKeyUsage

licenseKeyValidity
optional

License key validity details
Example : LicenseKeyValidity

LicenseKeyValidity

productType
required

The type of the product to which the license key is applicable
Example : "One among: VCENTER, VSAN, NSXV, SDDC_MANAGER, ESXI, VRA, VROPS, NSXT"

string

4.123. LicenseKeyUsage

Defines license key usage

Name Description Schema

licenseUnit
optional

Units of the license key
Example : "One among: CPUPACKAGE, INSTANCE, VMS, CCU, PLU, DESKTOPVM, SERVERVM, VM, SERVER, CORES, CONCURRENTUSER, NAMEDUSER"

string

remaining
optional

The remaining/free units of the license key
Example : 0

integer (int32)

total
optional

The total units of the license key
Example : 0

integer (int32)

used
optional

The consumed/used units of the license key
Example : 0

integer (int32)

4.124. LicenseKeyValidity

Defines license key validity details

Name Description Schema

expiryDate
optional

The license key expiry date
Example : Instant

Instant

licenseKeyStatus
optional

The validity status of the license key
Example : "One among: EXPIRED, ACTIVE, NEVER_EXPIRES"

string

4.125. MapOfstringAndSddcCredentials

Type : < string, SddcCredentials > map

4.126. MapOfstringAndstring

Type : < string, string > map

4.127. MemberCapacityInfo

Name Description Schema

summary
optional

Example : CapacitySummary

CapacitySummary

4.128. MemberDetail

Name Description Schema

city
optional

Example : "string"

string

coordinate
optional

Example : PositionCoordinate

PositionCoordinate

country
optional

Example : "string"

string

fqdn
optional

Example : "string"

string

role
optional

Example : "CONTROLLER"

enum (CONTROLLER, MANAGER, MEMBER, NOT_JOINED)

siteName
optional

Example : "string"

string

siteType
optional

Example : "DATACENTER"

enum (DATACENTER, ROBO, EDGE)

state
optional

Example : "string"

string

4.129. MemberFact

Name Description Schema

error
optional

Example : FederationOperationError

FederationOperationError

federationName
optional

Example : "string"

string

memberDetail
optional

Example : MemberDetail

MemberDetail

permissions
optional

Example : [ "BOOTSTRAP" ]

< enum (BOOTSTRAP, TEARDOWN, INVITE_MEMBER, EVICT, LIST_INVENTORY, JOIN, LEAVE) > array

4.130. MemberHealth

Name Description Schema

healthCode
optional

Example : "GREEN"

enum (GREEN, YELLOW, RED)

healthDetails
optional

Example : [ "string" ]

< string > array

4.131. MemberInfo

Name Description Schema

memberDetails
optional

Example : MemberDetail

MemberDetail

memberHealth
optional

Example : MemberHealth

MemberHealth

memberInventory
optional

Example : MemberInventory

MemberInventory

memberLiveness
optional

Example : MemberLiveliness

MemberLiveliness

4.132. MemberInventory

Name Description Schema

capacity
optional

Example : MemberCapacityInfo

MemberCapacityInfo

creationTime
optional

Example : Instant

Instant

inventoryInfo
optional

Example : InventoryInfo

InventoryInfo

softwareInfo
optional

Example : MemberSoftwareInfo

MemberSoftwareInfo

4.133. MemberJoinSpec

Name Description Schema

commonName
optional

Example : "string"

string

controllerFqdn
optional

Example : "string"

string

joinToken
optional

Example : "string"

string

memberJoinDetail
optional

Example : MemberDetail

MemberDetail

4.134. MemberLiveliness

Name Description Schema

livelinessCode
optional

Example : "GREEN"

enum (GREEN, YELLOW, RED)

livelinessDetails
optional

Example : [ "string" ]

< string > array

4.135. MemberSoftwareInfo

Name Description Schema

pendingUpdates
optional

Example : 0

integer (int32)

4.136. MemberSpec

NSX Edge pool member specification

Name Description Schema

ipAddress
required

NSX edge pool ip address
Length : 7 - 15
Example : "string"

string

monitorPort
required

NSX edge pool monitor port
Example : 0

integer (int64)

name
required

NSX edge pool member name
Example : "string"

string

4.137. MembershipInvitation

Name Description Schema

controllerFqdn
optional

Example : [ "string" ]

< string > array

error
optional

Example : FederationOperationError

FederationOperationError

invitationToken
optional

Example : "string"

string

inviteeFqdn
optional

Example : "string"

string

inviteeRole
optional

Example : "CONTROLLER"

enum (CONTROLLER, MANAGER, MEMBER, NOT_JOINED)

4.138. Memory

Represents information about memory on a host

Name Description Schema

totalCapacityMB
optional

Total memory in MB
Example : 0.0

number (double)

4.139. MessageBusServerInfo

Name Description Schema

brokerId
optional

Example : 0

integer (int32)

fqdn
optional

Example : "string"

string

hostAddress
optional

Example : "string"

string

port
optional

Example : 0

integer (int32)

4.140. MessageBusServerInfoList

Name Description Schema

messageBusServersInfo
optional

Example : [ "MessageBusServerInfo" ]

< MessageBusServerInfo > array

4.141. MessagePack

A messasge pack representing a localizable message and suitable for machine processing. Contains a message key unique in the scope of the specified component, as well as the arguments needed to generate the localized message.

Name Description Schema

arguments
optional

The arguments used to localize the message. Can be used by scripts to automate the response processing.
Example : [ "string" ]

< string > array

component
optional

The component the message belongs to
Example : "string"

string

message
optional

The localized message (if not provided by another property)
Example : "string"

string

messageKey
required

The machine-readable key of the message
Example : "string"

string

4.142. MicrosoftCertificateAuthoritySpec

This specification contains Microsoft CA configuration details

Name Description Schema

secret
required

CA server password
Example : "string"

string

serverUrl
required

CA server url
Example : "string"

string

templateName
required

CA server template name
Example : "string"

string

username
required

CA server username
Example : "string"

string

4.143. NasVolumeSpec

NAS configuration for NFS based cluster

Name Description Schema

path
required

Shared directory path used for NFS based cluster creation
Example : "string"

string

readOnly
required

Readonly is used to identify whether to mount the directory as readOnly or not
Example : true

boolean

serverName
required

NFS Server name used for cluster creation
Example : [ "string" ]

< string > array

userTag
optional

User tag used to annotate NFS share
Example : "string"

string

4.144. Network

Represents a network in a network pool

Name Description Schema

freeIps
optional

List of free IPs to use
Example : [ "string" ]

< string > array

gateway
optional

Gateway for the network
Example : "string"

string

id
optional

The ID of the network
Example : "string"

string

ipPools
optional

List of IP pool ranges to use
Example : [ "IpPool" ]

< IpPool > array

mask
optional

Subnet mask for the subnet of the network
Example : "string"

string

mtu
optional

MTU of the network
Example : 0

integer (int32)

subnet
optional

Subnet associated with the network
Example : "string"

string

type
optional

Network Type of the network
Example : "string"

string

usedIps
optional

List of used IPs
Example : [ "string" ]

< string > array

vlanId
optional

VLAN ID associated with the network
Example : 0

integer (int32)

4.145. NetworkDetailsSpec

This specification contains network parameters required for new virtual machines being added to a workload domain

Name Description Schema

dnsName
optional

DNS name of the virtual machine, e.g., vc-1.domain1.vsphere.local
Example : "string"

string

gateway
optional

IPv4 gateway the VM can use to connect to the outside world
Example : "string"

string

ipAddress
required

IPv4 address of the virtual machine
Example : "string"

string

subnetMask
optional

Subnet mask
Example : "string"

string

4.146. NetworkPool

Represents a network pool in the system

Name Description Schema

id
optional

The ID of the network pool
Example : "string"

string

name
optional

User specified name of the network pool
Example : "string"

string

networks
optional

Representing the networks associated with the network pool
Example : [ "Network" ]

< Network > array

4.147. NetworkPoolReference

Represents a network pool reference

Name Description Schema

id
required

ID of the network pool
Example : "string"

string

4.148. NetworkSpec

This specification contains cluster network configuration

Name Description Schema

nsxClusterSpec
required

NSX configuration to add to the cluster
Example : NsxClusterSpec

NsxClusterSpec

vdsSpecs
required

Distributed switches to add to the cluster
Example : [ "VdsSpec" ]

< VdsSpec > array

4.149. NfsDatastoreSpec

This specification contains cluster storage configuration for NFS

Name Description Schema

datastoreName
required

Datastore name used for cluster creation
Example : "string"

string

nasVolume
optional

NAS volume configuration for NFS based cluster
Example : NasVolumeSpec

NasVolumeSpec

4.150. NiocBandwidthAllocationSpec

This specification contains network traffic per resource type

Name Description Schema

niocTrafficResourceAllocation
optional

DvsHostInfrastructureTrafficResourceAllocation
Example : NiocTrafficResourceAllocation

NiocTrafficResourceAllocation

type
required

DvsHostInfrastructureTrafficResource resource type
Example : "string"

string

4.151. NiocSpec

Spec contains parameters for Network IO Control

Name Description Schema

trafficType
required

Traffic Type
Example : "One among:VSAN, VMOTION, VIRTUALMACHINE, MANAGEMENT, NFS, VDP, HBR, FAULTTOLERANCE, ISCSI"

string

value
required

NIOC Value
Example : "string"

string

4.152. NiocTrafficResourceAllocation

Specify network traffic for a resource

Name Description Schema

limit
required

Example : 0

integer (int64)

reservation
required

Example : 0

integer (int64)

4.153. NsxBgpSpec

Spec contains parameters for NSX BGP Routing

Name Description Schema

defaultPassword
required

Default BGP password
Example : "string"

string

localAutonomousSystem
required

BGP local autonomous system ID
Example : 0

integer (int32)

nsxEdgeBgpSpecs
required

NSX Edge BGP specifications
Example : [ "NsxEdgeBgpSpec" ]

< NsxEdgeBgpSpec > array

skipBgpValidation
optional

Whether to skip the validation of BGP routing
Example : true

boolean

4.154. NsxClusterSpec

This specification contains NSX configuration for cluster

Name Description Schema

nsxTClusterSpec
optional

NSX-T spec for the new cluster, required for NSX-T based workload domains, optional otherwise
Example : NsxTClusterSpec

NsxTClusterSpec

nsxVClusterSpec
optional

NSX-V spec for the new cluster, required for NSX-V based workload domains, optional otherwise
Example : NsxVClusterSpec

NsxVClusterSpec

4.155. NsxControllerIpPoolSpec

Spec contains required parameters for NSX Controller IP pool

Name Description Schema

defaultGateway
required

Default gateway for nsx controllers
Length : 7 - 15
Example : "string"

string

endIp
required

End IP address
Length : 7 - 15
Example : "string"

string

poolName
optional

IP pool name
Length : 3 - 63
Example : "string"

string

prefix
required

Subnet Cidr Prefix
Length : 1 - 2
Example : "string"

string

startIp
required

Start IP address
Length : 7 - 15
Example : "string"

string

4.156. NsxEdgeBgpSpec

Spec contains parameters of NSX Edge BGP

Name Description Schema

edgeType
required

NSX Edge type
Example : "One among:PSC_LB, MANAGEMENT_LB, ESG, DLR, UDLR"

string

enableGracefulRestart
optional

Whether to enable BGP graceful restart
Example : true

boolean

learnFrom
required

The protocols from which routes must be learned
Example : [ "string" ]

< string > array

neighbours
required

BGP neighbours
Example : [ "BgpNeighbour" ]

< BgpNeighbour > array

4.157. NsxEdgePoolSpec

Spec contains required parameters for NSX Edge Pool

Name Description Schema

memberSpecs
required

NSX edge pool members
Example : [ "MemberSpec" ]

< MemberSpec > array

name
required

NSX edge pool name
Example : "string"

string

4.158. NsxEdgeSpec

Spec contains required parameters for NSX Edge

Name Description Schema

edgeName
required

NSX Edge Name
Example : "string"

string

edgeSize
required

NSX Edge Size
Example : "One among:compact, large, quadlarge, xlarge"

string

edgeType
required

NSX Edge type
Example : "One among:PSC_LB, MANAGEMENT_LB, ESG, DLR, UDLR"

string

poolSpecs
optional

NSX edge pool specifications
Example : [ "NsxEdgePoolSpec" ]

< NsxEdgePoolSpec > array

shortHostname
optional

NSX Edge short hostname
Example : "string"

string

vnics
optional

NSX Edge Vnics
Example : [ "NsxEdgeVnicSpec" ]

< NsxEdgeVnicSpec > array

4.159. NsxEdgeVnicSpec

Spec contains parameters for NSX Edge Virtual Network Interface Card

Name Description Schema

attachToLogicalSwitch
optional

Attach the virtual NIC to Logical Switch instead of DV portgroup
Example : true

boolean

disconnected
optional

Leave this VNIC in disconnected state
Example : true

boolean

name
optional

NSX Edge Virtual NIC Name
Example : "string"

string

networkType
required

NSX Edge Virtual NIC Network Type
Example : "One among:VSAN, VMOTION, PUBLIC, MANAGEMENT, NSX_VTEP, HOSTMANAGEMENT, CLOUD_VENDOR_API, REPLICATION, DATACENTER_NETWORK, NSX_VXLAN, NON_ROUTABLE, CLOUD_VENDOR_API, OOB, CROSS_VPC, UPLINK01, UPLINK02, STORAGE, UDLR, DLR, X_REGION, REGION_SPECIFIC, REMOTE_REGION_SPECIFIC, COMPUTE, MANAGEMENT_VM"

string

primaryIpAddress
optional

NSX Edge Virtual NIC Primary IP Address
Length : 7 - 15
Example : "string"

string

secondaryIpAddresses
optional

NSX Edge Virtual NIC Secondary IP Addresses
Example : [ "string" ]

< string > array

type
required

NSX Edge Virtual NIC Type
Example : "One among:uplink, internal"

string

useForDefaultRoute
optional

Use this VNIC and the gateway of its network as Default Gateway
Example : true

boolean

useForDynamicRouterConfiguration
optional

Use the primary IP address of this virtual NIC as router ID in Dynamic Routing Configuration
Example : true

boolean

4.160. NsxLogicalSwitch

Spec contains parameters for NSX Logical Switch

Name Description Schema

controlPlaneMode
required

Logical switch control plane mode
Example : "One among:MULTICAST_MODE, HYBRID_MODE, UNICAST_MODE"

string

name
required

Logical switch name
Example : "string"

string

networkType
optional

Logical switch network Type
Example : "One among:VSAN, VMOTION, PUBLIC, MANAGEMENT, NSX_VTEP, HOSTMANAGEMENT, CLOUD_VENDOR_API, REPLICATION, DATACENTER_NETWORK, NSX_VXLAN, NON_ROUTABLE, CLOUD_VENDOR_API, OOB, CROSS_VPC, UPLINK01, UPLINK02, STORAGE, UDLR, DLR, X_REGION, REGION_SPECIFIC, REMOTE_REGION_SPECIFIC, COMPUTE, MANAGEMENT_VM"

string

transportZoneId
optional

ID of the transport zone in which to create the logical switch. If not specified, then only one transport zone should be available and it will be used.
Example : "string"

string

4.161. NsxManager

Nsx Manager representation

Name Description Schema

domain
optional

Information about the domain this Nsx Manager is part of
Example : DomainReference

DomainReference

fqdn
optional

FQDN of the Nsx Manager
Example : "string"

string

id
optional

ID of the Nsx Manager
Example : "string"

string

ipAddress
optional

IP address of the Nsx Manager
Example : "string"

string

vcenter
optional

Information about the vCenter this Nsx Manager associated with
Example : VcenterReference

VcenterReference

4.162. NsxManagerSpec

This specification contains the parameters required to install and configure NSX Manager in a workload domain

Name Description Schema

name
required

Name of the NSX Manager virtual machine
Example : "string"

string

networkDetailsSpec
required

Network speciication details of the NSX Manager virtual machine
Example : NetworkDetailsSpec

NetworkDetailsSpec

4.163. NsxSpec

Spec contains parameters for NSX deployment and configurations

Name Description Schema

adminNsxControllerPassword
optional

NSX Controllers admin password. Password length must be between 12-255 characters in length. It must contain at least one uppercase character, one lowercase character, one number and at-least one special character. Password must not contain the username (admin) as a substring. Any character must not consecutively repeat 3 or more times.
Example : "string"

string

adminNsxManagerPassword
required

NSX Manager admin user password. Password should have 1) At least eight characters, 2) At least one lower-case letter, 3) At least one upper-case letter 4) At least one digit 5) At least one special character, 6) At least five different characters , 7) No dictionary words, 6) No palindromes
Length : 8 - 32
Example : "string"

string

backupFtpServerAddress
optional

Hostname of FTP server that is used for NSX Manager backup
Example : "string"

string

controllerIPPoolSpec
optional

Nsx Controller Ip Pool Spec
Example : NsxControllerIpPoolSpec

NsxControllerIpPoolSpec

ftpBackupFolder
optional

Folder on the FTP server where the NSX Manager backup is stored
Example : "string"

string

ftpCredentials
optional

Credentials on the FTP server
Example : SddcCredentials

SddcCredentials

ftpPassPhrase
optional

Passphrase to encrypt and decrypt backups
Example : "string"

string

ftpPort
optional

FTP server transfer protocol port
Example : 0

integer (int32)

license
optional

NSX License
Example : "string"

string

logicalSwitches
optional

NSX logical switches
Example : [ "NsxLogicalSwitch" ]

< NsxLogicalSwitch > array

multicastRangeBegin
optional

NSX Multicast range start value
Example : "string"

string

multicastRangeEnd
optional

NSX Multicast range end value
Example : "string"

string

nsxBgpSpec
optional

NSX BGP specification
Example : NsxBgpSpec

NsxBgpSpec

nsxControllerVmNamesPrefix
optional

Prefix of the names of the NSX controller VMs
Example : "string"

string

nsxEdgePassword
optional

NSX edge password. The password must be at least 12 characters long. Must contain at-least 1 uppercase, 1 lowercase, 1 special character and 1 digit. In addition, a character cannot be repeated 3 or more times consecutively.
Example : "string"

string

nsxEdgeSpecs
optional

NSX edge specifications
Example : [ "NsxEdgeSpec" ]

< NsxEdgeSpec > array

nsxId
required

NSX config ID
Example : "string"

string

nsxManagerHostname
optional

Nsx Manager hostname
Example : "string"

string

nsxManagerIp
optional

Nsx Manager Ip Address
Length : 7 - 15
Example : "string"

string

nsxSegmentRangeBegin
required

NSX Segment range start value
Example : "string"

string

nsxSegmentRangeEnd
required

NSX Segment range end value
Example : "string"

string

nsxVxlanSpec
optional

NSX Vxlan spec
Example : NsxVxlanSpec

NsxVxlanSpec

privilegedNsxManagerPassword
optional

The password for CLI privilege mode for NSX manager. If not specified, 'adminNsxManagerPassword' will be used.Password should have 1) At least eight characters, 2) At least one lower-case letter, 3) At least one upper-case letter 4) At least one digit 5) At least one special character, 6) At least five different characters , 7) No dictionary words, 6) No palindromes
Example : "string"

string

transferProtocol
optional

FTP server transfer protocol
Example : "SFTP"

enum (SFTP, FTP)

transportZones
optional

NSX transport zones
Example : [ "NsxTransportZone" ]

< NsxTransportZone > array

universalMulticastRangeBegin
optional

Universal NSX Multicast range start value
Example : "string"

string

universalMulticastRangeEnd
optional

Universal NSX Multicast range end value
Example : "string"

string

universalSegmentRangeBegin
optional

Universal NSX Segment range start value
Example : "string"

string

universalSegmentRangeEnd
optional

Universal NSX Segment range end value
Example : "string"

string

4.164. NsxTCluster

NSX-T Cluster representation

Name Description Schema

domains
optional

Information about the domains associated with the cluster
Example : [ "DomainReference" ]

< DomainReference > array

fqdn
optional

FQDN for VIP of the cluster
Example : "string"

string

id
optional

ID of the cluster
Example : "string"

string

ipAddress
optional

VIP (Virtual IP Address) of the cluster
Example : "string"

string

nodes
optional

Information about the NSX-T managers associated with the cluster
Example : [ "NsxTManager" ]

< NsxTManager > array

4.165. NsxTClusterSpec

This specification contains NSX-T configuration for a new cluster.

Name Description Schema

geneveVlanId
optional

Vlan id of Geneve
Example : 0

integer (int32)

4.166. NsxTManager

NSX-T Manager representation

Name Description Schema

fqdn
optional

FQDN of the manager
Example : "string"

string

vmName
optional

Vm name of the manager
Example : "string"

string

4.167. NsxTSpec

This specification contains the parameters required to install and configure NSX-T in a workload domain

Name Description Schema

licenseKey
required

NSX license value
Example : "string"

string

nsxManagerAdminPassword
optional

NSX manager admin password (basic auth and SSH)
Example : "string"

string

nsxManagerSpecs
required

Specification details of the NSX Manager virtual machine
Example : [ "NsxManagerSpec" ]

< NsxManagerSpec > array

vip
required

Virtual IP address which would act as proxy/alias for NSX-T Managers
Example : "string"

string

vipFqdn
required

FQDN for VIP so that common SSL certificates can be installed across all managers
Example : "string"

string

4.168. NsxTransportZone

Spec contains parameters of NSX Transport Zone

Name Description Schema

controlPlaneMode
required

Transport zone control plane mode
Example : "One among:MULTICAST_MODE, HYBRID_MODE, UNICAST_MODE"

string

id
required

Transport zone ID
Example : "universal-transport-zone"

string

name
required

Transport zone name
Example : "string"

string

universal
optional

Whether the transport zone is universal
Example : true

boolean

4.169. NsxVClusterSpec

This specification contains NSX-V configuration spec for cluster

Name Description Schema

licenseKey
optional

NSX license key to be applied to the new cluster
Example : "string"

string

vdsNameForVxlanConfig
optional

VDS to be used for vxlan traffic/portgroup. This should belong to one of the VDS being created for the cluster
Example : "string"

string

vlanId
required

VLAN ID of the vxlan
Example : 0

integer (int32)

4.170. NsxVControllerSpec

This specification contains the parameters required to install and configure NSX-V controllers in a workload domain

Name Description Schema

nsxControllerGateway
required

NSX controller gateway
Example : "string"

string

nsxControllerIps
required

List of the IPs of NSX Controller IP Pool associated with the above NSX Manager
Example : [ "string" ]

< string > array

nsxControllerPassword
required

NSX controller password (all controllers)
Example : "string"

string

nsxControllerSubnetMask
required

NSX controller subnet mask
Example : "string"

string

4.171. NsxVSpec

This specification contains the parameters required to install and configure NSX-V in a workload domain

Name Description Schema

licenseKey
required

NSX license key
Example : "string"

string

nsxManagerAdminPassword
required

NSX Manager admin password (basic auth and SSH)
Example : "string"

string

nsxManagerEnablePassword
required

NSX manager 'enable' password
Example : "string"

string

nsxManagerSpec
required

Specification details of the NSX Manager virtual machine
Example : NsxManagerSpec

NsxManagerSpec

nsxVControllerSpec
required

NSX controller configuration
Example : NsxVControllerSpec

NsxVControllerSpec

4.172. NsxVxlanSpec

Spec contains required parameters for NSX VXLAN

Name Description Schema

excludeIpAddressRanges
optional

IP address ranges to be excluded
Example : [ "string" ]

< string > array

gateway
optional

VXLAN gateway
Example : "string"

string

poolEndAddress
optional

VXLAN pool end IP address
Example : "string"

string

poolStartAddress
optional

VXLAN pool start IP address
Example : "string"

string

subnetWithCidr
optional

VXLAN Network subnet with CIDR in the form x.x.x.x/cidr
Example : "string"

string

teamingPolicy
optional

VXLAN teaming policy
Example : "FAILOVER_ORDER"

enum (FAILOVER_ORDER, ETHER_CHANNEL, LACP_ACTIVE, LACP_PASSIVE, LOADBALANCE_LOADBASED, LOADBALANCE_SRCID, LOADBALANCE_SRCMAC, LACP_V2)

vtepVmknicCount
optional

VTEP VMK nic count
Example : 0

integer (int32)

vxlanCluster
required

vCenter Cluster name
Example : "string"

string

vxlanDvs
required

DVS name
Example : "string"

string

vxlanMtu
required

VXLAN MTU size
Example : "string"

string

vxlanPoolName
optional

VXLAN Pool Name
Example : "string"

string

vxlanVlanId
required

VXLAN Vlan ID
Example : "string"

string

4.173. OpenSSLCertificateAuthoritySpec

This specification contains OpenSSL CA configuration details

Name Description Schema

commonName
required

OpenSSL CA domain name
Example : "string"

string

country
required

ISO 3166 country code where company is legally registered
Example : "string"

string

locality
required

The city or locality where company is legally registered
Example : "string"

string

organization
required

The name under which company is legally registered
Example : "string"

string

organizationUnit
required

Organization with which the certificate is associated
Example : "string"

string

state
required

The full name of the state where company is legally registered
Example : "string"

string

4.174. Page

Represents a page of elements of a single type

Name Description Schema

elements
optional

The list of elements included in this page
Example : [ "object" ]

< object > array

4.175. PageOfBundle

Represents a page of elements of a single type

Name Description Schema

elements
optional

The list of elements included in this page
Example : [ "Bundle" ]

< Bundle > array

4.176. PageOfCertificate

Represents a page of elements of a single type

Name Description Schema

elements
optional

The list of elements included in this page
Example : [ "Certificate" ]

< Certificate > array

4.177. PageOfCertificateAuthority

Represents a page of elements of a single type

Name Description Schema

elements
optional

The list of elements included in this page
Example : [ "CertificateAuthority" ]

< CertificateAuthority > array

4.178. PageOfCluster

Represents a page of elements of a single type

Name Description Schema

elements
optional

The list of elements included in this page
Example : [ "Cluster" ]

< Cluster > array

4.179. PageOfCredential

Represents a page of elements of a single type

Name Description Schema

elements
optional

The list of elements included in this page
Example : [ "Credential" ]

< Credential > array

4.180. PageOfCredentialsTask

Represents a page of elements of a single type

Name Description Schema

elements
optional

The list of elements included in this page
Example : [ "CredentialsTask" ]

< CredentialsTask > array

4.181. PageOfCsr

Represents a page of elements of a single type

Name Description Schema

elements
optional

The list of elements included in this page
Example : [ "Csr" ]

< Csr > array

4.182. PageOfDomain

Represents a page of elements of a single type

Name Description Schema

elements
optional

The list of elements included in this page
Example : [ "Domain" ]

< Domain > array

4.183. PageOfDomainIntegration

Represents a page of elements of a single type

Name Description Schema

elements
optional

The list of elements included in this page
Example : [ "DomainIntegration" ]

< DomainIntegration > array

4.184. PageOfEndpoint

Represents a page of elements of a single type

Name Description Schema

elements
optional

The list of elements included in this page
Example : [ "Endpoint" ]

< Endpoint > array

4.185. PageOfHorizon

Represents a page of elements of a single type

Name Description Schema

elements
optional

The list of elements included in this page
Example : [ "Horizon" ]

< Horizon > array

4.186. PageOfHost

Represents a page of elements of a single type

Name Description Schema

elements
optional

The list of elements included in this page
Example : [ "Host" ]

< Host > array

4.187. PageOfLicenseKey

Represents a page of elements of a single type

Name Description Schema

elements
optional

The list of elements included in this page
Example : [ "LicenseKey" ]

< LicenseKey > array

4.188. PageOfNetwork

Represents a page of elements of a single type

Name Description Schema

elements
optional

The list of elements included in this page
Example : [ "Network" ]

< Network > array

4.189. PageOfNetworkPool

Represents a page of elements of a single type

Name Description Schema

elements
optional

The list of elements included in this page
Example : [ "NetworkPool" ]

< NetworkPool > array

4.190. PageOfNsxManager

Represents a page of elements of a single type

Name Description Schema

elements
optional

The list of elements included in this page
Example : [ "NsxManager" ]

< NsxManager > array

4.191. PageOfNsxTCluster

Represents a page of elements of a single type

Name Description Schema

elements
optional

The list of elements included in this page
Example : [ "NsxTCluster" ]

< NsxTCluster > array

4.192. PageOfPks

Represents a page of elements of a single type

Name Description Schema

elements
optional

The list of elements included in this page
Example : [ "Pks" ]

< Pks > array

4.193. PageOfPsc

Represents a page of elements of a single type

Name Description Schema

elements
optional

The list of elements included in this page
Example : [ "Psc" ]

< Psc > array

4.194. PageOfSddcManager

Represents a page of elements of a single type

Name Description Schema

elements
optional

The list of elements included in this page
Example : [ "SddcManager" ]

< SddcManager > array

4.195. PageOfSddcTask

Represents a page of elements of a single type

Name Description Schema

elements
optional

The list of elements included in this page
Example : [ "SddcTask" ]

< SddcTask > array

4.196. PageOfTask

Represents a page of elements of a single type

Name Description Schema

elements
optional

The list of elements included in this page
Example : [ "Task" ]

< Task > array

4.197. PageOfUpgradable

Represents a page of elements of a single type

Name Description Schema

elements
optional

The list of elements included in this page
Example : [ "Upgradable" ]

< Upgradable > array

4.198. PageOfValidation

Represents a page of elements of a single type

Name Description Schema

elements
optional

The list of elements included in this page
Example : [ "Validation" ]

< Validation > array

4.199. PageOfVcenter

Represents a page of elements of a single type

Name Description Schema

elements
optional

The list of elements included in this page
Example : [ "Vcenter" ]

< Vcenter > array

4.200. PageOfVcfService

Represents a page of elements of a single type

Name Description Schema

elements
optional

The list of elements included in this page
Example : [ "VcfService" ]

< VcfService > array

4.201. PageOfVrli

Represents a page of elements of a single type

Name Description Schema

elements
optional

The list of elements included in this page
Example : [ "Vrli" ]

< Vrli > array

4.202. PageOfVrops

Represents a page of elements of a single type

Name Description Schema

elements
optional

The list of elements included in this page
Example : [ "Vrops" ]

< Vrops > array

4.203. PageOfVropsNode

Represents a page of elements of a single type

Name Description Schema

elements
optional

The list of elements included in this page
Example : [ "VropsNode" ]

< VropsNode > array

4.204. PageOfVrslcm

Represents a page of elements of a single type

Name Description Schema

elements
optional

The list of elements included in this page
Example : [ "Vrslcm" ]

< Vrslcm > array

4.205. PhysicalNic

Represents a physical NIC

Name Description Schema

deviceName
optional

Device name of the physical NIC
Example : "string"

string

macAddress
optional

Mac address of the physical NIC
Example : "string"

string

4.206. Pks

PKS resource

Name Description Schema

info
optional

Represents the brief info of PKS
Example : PksInfo

PksInfo

inputSpec
optional

Installation specification that was used to install PKS
Example : PksInstallationSpec

PksInstallationSpec

serviceVms
optional

List of the virtual machines that were created during PKS installation
Example : [ "PksVm" ]

< PksVm > array

summary
optional

Represents the summary of PKS
Example : PksSummary

PksSummary

4.207. PksAvailabilityZone

PKS availability zone resource

Name Description Schema

clusterName
required

Cluster that will be mapped to the availability zone
Example : "string"

string

name
required

Availability zone name
Example : "string"

string

resourcePoolName
required

Resource pool that will be mapped to the availability zone
Example : "string"

string

4.208. PksAvailabilityZoneSpec

Availability zones that will be used during PKS installation

Name Description Schema

kubernetesNetwork
required

Kubernetes network configuration that will be used during PKS installation
Example : PksNetwork

PksNetwork

kubernetesZones
required

Availability zones that will be used for Kubernetes network setup
Example : [ "PksAvailabilityZone" ]

< PksAvailabilityZone > array

managementNetwork
required

Management network configuration that will be used during PKS installation
Example : PksNetwork

PksNetwork

managementZone
required

Availability zone that will be used for management network setup
Example : PksAvailabilityZone

PksAvailabilityZone

4.209. PksDeploymentNetwork

Network configuration to setup Ops Manager virtual machine

Name Description Schema

dnsServers
required

The list of DNS servers that will be configured on Ops Manager virtual machine
Example : "dns.sfo01.rainpole.local, dns1.sfo01.rainpole.local"

< string > array

dnsSuffix
required

DNS suffix that will be configured on Ops Manager virtual machine
Example : "*.sfo01.rainpole.local"

string

gateway
required

Gateway that will be configured on Ops Manager virtual machine
Example : "10.255.0.1"

string

netmask
required

Netmask that will be configured on Ops Manager virtual machine
Example : "255.255.255.0"

string

network
required

The name of the logical switch that Ops Manager virtual machine will be connected to
Example : "string"

string

ntpServers
required

The list of NTP servers that will be configured on Ops Manager virtual machine
Example : "ntp.sfo01.rainpole.local, ntp1.sfo01.rainpole.local"

< string > array

4.210. PksInfo

Represents the status of PKS

Name Description Schema

domainId
optional

Workload Domain ID
Example : "string"

string

id
optional

PKS ID
Example : "string"

string

name
optional

Human readable name for PKS
Example : "string"

string

status
optional

PKS status
Example : "string"

string

4.211. PksInstallationSpec

PKS installation specification

Name Description Schema

adminPassword
required

PKS admin password that will be used to login to Ops Manager
Example : "string"

string

availabilityZoneSpec
required

Availability zones that will be used during PKS installation
Example : PksAvailabilityZoneSpec

PksAvailabilityZoneSpec

certificateBundle
required

RSA Certificates that will be used during PKS installation
Example : PksRsaCertificateBundleSpec

PksRsaCertificateBundleSpec

datastore
required

vSphere data store location that will be used during PKS installation
Example : "string"

string

decryptionPassphrase
required

PKS decryption passphrase that will be used to setup internal authentication
Example : "string"

string

domainId
required

Workload Domain ID
Example : "76df11e9-5c1f-4376-b913-0ea93ebda983"

string

harborHostname
optional

PKS Harbor hostname
Example : "harbor.sfo01.rainpole.local"

string

installHarbor
optional

Install Harbor as an optional component
Example : true

boolean

name
required

Human readable name for PKS
Example : "PKS-1"

string

nsxtItemsSpec
required

NSX-T items specification that will be used during PKS installation
Example : PksNsxtItemsSpec

PksNsxtItemsSpec

pksApiHostname
required

PKS API hostname
Example : "pksApi.sfo01.rainpole.local"

string

pksOpsManagerVmSpec
required

Ops Manager virtual machine specification
Example : PksOpsManagerVmSpec

PksOpsManagerVmSpec

4.212. PksNetwork

PKS network resource

Name Description Schema

cidr
required

CIDR that defines the network
Example : "10.255.0.0/24"

string

dnsServer
required

DNS server that will be used for this network
Example : "dns.sfo01.rainpole.local"

string

gateway
required

Default gateway to be used for this network
Example : "10.255.0.1"

string

reservedRanges
required

Reserved IP ranges that will not be used by PKS
Example : "10.255.0.1-10.255.0.10"

string

vcenterNetwork
required

vCenter network that will be mapped to PKS network
Example : "string"

string

4.213. PksNsxtItemsSpec

NSX-T items specification that will be used during PKS installation

Name Description Schema

floatingIpPoolId
required

IP Pool ID that will be used for Kubernetes floating IPs
Example : "ee7d0bc1-0cd3-4c59-8944-65a36fe35cf7"

string

nodesIpBlockId
required

IP Block ID that will be used for Kubernetes nodes creation
Example : "b73446a0-9ffe-4291-b34f-ff0b6ee67ff3"

string

podsIpBlockId
required

IP Block ID that will be used for Kubernetes pods creation
Example : "6f5db6d2-30f6-47e3-a765-3ebc34390bce"

string

t0routerId
required

T0 router ID that will be used during PKS installation
Example : "bc3fda31-74b9-4759-8e1f-ff72726b8d5d"

string

4.214. PksOpsManagerVmSpec

Ops Manager virtual machine specification

Name Description Schema

appliance
required

Ops Manager virtual machine configuration
Example : PksVirtualAppliance

PksVirtualAppliance

network
required

Network configuration to setup Ops Manager virtual machine
Example : PksDeploymentNetwork

PksDeploymentNetwork

4.215. PksRsaCertificate

PKS certificate resource

Name Description Schema

privateKey
required

Private key
Example : "string"

string

publicCert
required

Public certificate
Example : "string"

string

4.216. PksRsaCertificateBundleSpec

RSA Certificates that will be used during PKS installation

Name Description Schema

harborRsaCert
optional

Public certificate and private key that will be used in Harbor registry
Example : PksRsaCertificate

PksRsaCertificate

nsxtRsaCert
required

Public certificate and private key that will be used to create NSX-T manager Principal Identity
Example : PksRsaCertificate

PksRsaCertificate

pcfRsaCert
required

Public certificate and private key that will be used in Pivotal Cloud Foundry
Example : PksRsaCertificate

PksRsaCertificate

pksRsaCert
required

Public certificate and private key that will be used in Pivotal Container Service
Example : PksRsaCertificate

PksRsaCertificate

trustedCertificates
required

Root Certificate Authority certificate that was used to sign all certificates
Example : "string"

string

4.217. PksSummary

PKS summary representation

Name Description Schema

harborRegistryUrl
optional

Harbor URL
Example : "https://harbor.sfo01.rainpole.local"

string

kubernetesZonesCount
optional

Amount of kubernetes availability zones that were installed
Example : 1

integer (int32)

managementZonesCount
optional

Amount of management availability zones that were installed
Example : 1

integer (int32)

opsManagerUrl
optional

Ops Manager URL
Example : "https://pcf.sfo01.rainpole.local"

string

pksApiFqdn
optional

PKS CLI FQDN
Example : "pksApi.sfo01.rainpole.local"

string

wldName
optional

Name of the Workload Domain that is associated with PKS installation
Example : "string"

string

4.218. PksUpdateSpec

PKS update specification

Name Description Schema

markForDeletion
required

Prepare Solution PKS for deletion
Example : true

boolean

4.219. PksVirtualAppliance

Ops Manager virtual machine configuration

Name Description Schema

hostname
required

Hostname that will be assigned to Ops Manager virtual machine
Example : "pcf.sfo01.rainpole.local"

string

ip
required

IP that will be assigned to Ops Manager virtual machine
Example : "10.255.0.10"

string

vmName
required

Name that will be assigned to Ops Manager virtual machine
Example : "ops-manager"

string

4.220. PksVm

PKS virtual machine resource

Name Description Schema

ip
optional

Virtual machine IP
Example : "string"

string

name
optional

Virtual machine name
Example : "string"

string

url
optional

Virtual machine URL
Example : "string"

string

4.221. PortgroupSpec

This specification contains vCenter port group configurations

Name Description Schema

name
required

Port group name
Example : "string"

string

transportType
required

Port group transport type
Example : "One among: VSAN, VMOTION, MANAGEMENT, PUBLIC, NFS"

string

4.222. PositionCoordinate

Name Description Schema

latitude
optional

Example : 0.0

number (double)

longitude
optional

Example : 0.0

number (double)

4.223. PrecheckSpec

Precheck Specification. This specification gets used in the Precheck API

Name Description Schema

resources
required

List of resources for Precheck supported type DOMAIN, CLUSTER
Example : [ "Resource" ]

< Resource > array

4.224. Psc

Psc representation

Name Description Schema

domain
optional

Information about the domain this PSC is part of
Example : DomainReference

DomainReference

fqdn
optional

FQDN of the Psc
Example : "string"

string

id
optional

ID of the Psc
Example : "string"

string

ipAddress
optional

IP Address of the Psc
Example : "string"

string

isReplica
optional

Indicates if the Psc is a replica
Example : true

boolean

ssoDomainName
optional

SSO Domain name of the Psc
Example : "string"

string

ssoSubDomainName
optional

SSO sub domain name of the Psc
Example : "string"

string

4.225. PscSpec

Spec contains parameters for deployment/configuration of Platform Services Controller

Name Description Schema

adminUserSsoPassword
required

Admin user sso passwordPassword needs to be a strong password with at least one Uppercase alphabet, one lowercase alphabet, one digit and one special character specified in braces [!$%^] and 8-20 characters in length,and 3 maximum identical adjacent characters!
Length : 8 - 20
Example : "string"

string

automationUserSsoPassword
optional

Automation user sso password, Password needs to be a strong password with at least one Uppercase alphabet, one lowercase alphabet, one digit and one special character specified in braces [!$%^] and 8-20 characters in length,and 3 maximum identical adjacent characters!
Length : 8 - 20
Example : "string"

string

automationUserSsoUsername
optional

Automation user sso username
Example : "string"

string

pscHostName
optional

PSC HostName
Example : "string"

string

pscId
optional

PSC Name
Example : "string"

string

pscIp
optional

PSC IP address
Length : 7 - 15
Example : "string"

string

pscSsoSpec
optional

PSC SSO Domain
Example : PscSsoSpec

PscSsoSpec

rootPscPassword
optional

Root user ssh passwordPassword needs to be a strong password with at least one Uppercase alphabet, one lowercase alphabet, one digit and one special character specified in braces [!$%^] and 8-20 characters in length,and 3 maximum identical adjacent characters!
Length : 8 - 20
Example : "string"

string

4.226. PscSsoSpec

Spec contains parameters for Platform Services Controller SSO

Name Description Schema

adDomain
optional

PSC AD Domain
Example : "string"

string

adPassword
optional

PSC AD password for joining domain
Example : "string"

string

adUsername
optional

PSC AD username for joining domain
Example : "string"

string

isJoinSsoDomain
optional

Join existing SSO domain, True - Secondary region deploymentFalse - Primary region deployment
Example : true

boolean

replicationPartner
optional

PSC Replication Partner, Its mandatory for secondary regionIf deploying 2 PSC’s, For 2nd PSC in Primary Region/Secondary Region - Its hostname of first PSCFor Secondary Region 1st PSC - User specified
Example : "string"

string

ssoDomain
optional

PSC SSO Domain,its mandatory for secondary region and if deploying 2 PSC’s
Example : "string"

string

ssoSiteName
optional

PSC Site Name
Example : "string"

string

4.227. RemoteEndpointSpec

Spec contains parameters needed to establish remote connection to Virtual appliance

Name Description Schema

address
required

Address of Virtual appliance
Example : "string"

string

password
required

Password used to connect to Virtual appliance
Example : "string"

string

username
required

Username used to connect to Virtual appliance
Example : "string"

string

4.228. RemoteResponsePayload

Name Description Schema

assignedBrokerId
optional

Example : 0

integer (int32)

assignedZkId
optional

Example : 0

integer (int32)

mbServers
optional

Example : MessageBusServerInfoList

MessageBusServerInfoList

srServers
optional

Example : SchemaRegistryServerInfoList

SchemaRegistryServerInfoList

zkServers
optional

Example : ZookeeperServerInfoList

ZookeeperServerInfoList

4.229. RemoteSiteSpec

Spec contains parameters for Remote site products

Name Description Schema

clusterName
optional

Remote region cluster name for mapping
Example : "string"

string

datacenterName
optional

Remote region datacenter name for mapping
Example : "string"

string

logicalSwitchNames
optional

Logical switch names for network mapping
Example : [ "string" ]

< string > array

nsxCredentials
optional

Remote region NSX credentials
Example : SddcCredentials

SddcCredentials

nsxIp
optional

Remote region NSX IP address
Length : 7 - 15
Example : "string"

string

placeholderDatastore
optional

Remote region placeholder datastore
Example : "string"

string

pscAddress
optional

Remote region PSC address
Example : "string"

string

remoteRegionVmFolders
optional

Remote region VM folders for explicit mapping
Example : {
"string" : "string"
}

< string, string > map

rpoMinutes
optional

RPO in minutes (should be positive number)
Minimum value : 1
Maximum value : 3600
Example : 0

integer (int32)

siteName
optional

Remote site name (used as site tag for vRLI event forwarding)
Example : "string"

string

srmIp
optional

Remote region SRM IP address
Length : 7 - 15
Example : "string"

string

vcCredentials
optional

Remote region VC/PSC credentials
Example : SddcCredentials

SddcCredentials

vcMgmtIp
optional

Remote region vC IP address
Length : 7 - 15
Example : "string"

string

vrIp
optional

Remote region VR IP address
Length : 7 - 15
Example : "string"

string

vrReplicationIp
optional

Remote region VR Replication IP address
Length : 7 - 15
Example : "string"

string

vrRootPassword
optional

Remote region VR root password
Example : "string"

string

vrliAdminPassword
optional

Remote region vRLI admin password
Example : "string"

string

vrliLoadBalancerHostname
optional

Remote region vRLI load balancer hostname
Example : "string"

string

vrliNodesAddresses
optional

Remote region vRLI nodes addresses
Example : [ "string" ]

< string > array

vrliRootPassword
optional

Remote region vRLI nodes SSH root password
Example : "string"

string

4.230. Resource

Represents the resource in the system

Name Description Schema

fqdn
optional

Resource FQDN
Example : "string"

string

name
required

Name of the resource
Example : "string"

string

resourceId
required

Resource ID
Example : "string"

string

type
required

Resource type
Example : "string"

string

4.231. ResourceCapacity

Name Description Schema

cpu
optional

Example : CPU

CPU

datastores
optional

Example : [ "Datastore" ]

< Datastore > array

hostCount
optional

Example : HostCount

HostCount

memory
optional

Example : Memory

Memory

4.232. ResourceCredentials

Represents a resource along with its list of credentials to be changed.

Name Description Schema

credentials
required

Credentials of the resource
Example : [ "BaseCredential" ]

< BaseCredential > array

resourceId
optional

Resource ID
Example : "string"

string

resourceName
optional

Resource name
Example : "string"

string

resourceType
required

Authenticated Resource Type
Example : "One among: ESXI, SDDC_MANAGER, VCENTER, PSC, NSX_MANAGER, NSX_CONTROLLER, NSX_EDGE, NSXT_MANAGER, NSXT_CONTROLLER, NSXT_EDGE, VRLI, VROPS, LCM_REPO, VRA, VRSLCM, DEPOT_USER, VXRAIL_MANAGER, AD, BACKUP"

string

4.233. ResourcePoolSpec

Spec contains parameters for Resource Pool

Name Description Schema

cpuLimit
optional

CPU limit, default -1 (unlimited)
Example : 0

integer (int64)

cpuReservationExpandable
optional

Is CPU reservation expandable, default true
Example : true

boolean

cpuReservationMhz
optional

CPU reservation in Mhz
Example : 0

integer (int64)

cpuReservationPercentage
optional

CPU reservation percentage, from 0 to 100, default 0
Minimum value : 0
Maximum value : 100
Example : 0

integer (int32)

cpuSharesLevel
optional

CPU shares level, default 'normal'
Example : "custom"

enum (custom, high, low, normal)

cpuSharesValue
optional

CPU shares value, only required when shares level is 'normal'
Example : 0

integer (int32)

memoryLimit
optional

Memory limit, default -1 (unlimited)
Example : 0

integer (int64)

memoryReservationExpandable
required

Is Memory reservation expandable, default true
Example : true

boolean

memoryReservationMb
optional

Memory reservation in MB
Example : 0

integer (int64)

memoryReservationPercentage
optional

Memory reservation percentage, from 0 to 100, default 0
Minimum value : 0
Maximum value : 100
Example : 0

integer (int32)

memorySharesLevel
optional

Memory shares level. default 'normal'
Example : "custom"

enum (custom, high, low, normal)

memorySharesValue
optional

Memory shares value, only required when shares level is '0'
Example : 0

integer (int32)

name
required

Resource Pool name
Example : "string"

string

type
optional

Type of resource pool
Example : "management"

enum (management, compute, network)

4.234. ResourceUpgradeSpec

Resource Upgrade Specification

Name Description Schema

resourceId
required

Resource ID for Upgrade
Example : "string"

string

scheduledTimestamp
optional

Upgrade Scheduled Time
Example : Instant

Instant

shutdownVms
optional

If Resource Type is UNASSIGNED_HOST, set flag for enabling shutting down VM’s before Upgrade
Example : true

boolean

toVersion
optional

If Resource Type is UNASSIGNED_HOST, set the target version for Upgrade
Example : "string"

string

upgradeNow
optional

Flag for enabling Upgrade Now. If true, scheduledTimestamp is ignored
Example : true

boolean

4.235. RestoreSpec

Restore Specification

Name Description Schema

backupFile
required

Backup file name
Example : "string"

string

elements
required

List of elements to be restored
Example : [ "BackupResource" ]

< BackupResource > array

encryption
required

Encryption
Example : Encryption

Encryption

4.236. SchemaRegistryServerInfo

Name Description Schema

hostAddress
optional

Example : "string"

string

port
optional

Example : 0

integer (int32)

protocol
optional

Example : "string"

string

4.237. SchemaRegistryServerInfoList

Name Description Schema

schemaRegistryServersInfo
optional

Example : [ "SchemaRegistryServerInfo" ]

< SchemaRegistryServerInfo > array

4.238. SddcClusterSpec

Spec contains parameters for vCenter Cluster

Name Description Schema

clusterEvcMode
optional

vCenter cluster EVC mode
Example : "string"

string

clusterName
required

vCenter Cluster Name
Example : "string"

string

hostFailuresToTolerate
optional

Host failures to tolerate
Minimum value : 0
Maximum value : 3
Example : 0

integer (int32)

hostProfileComplianceCheckHour
optional

Hour at which the scheduled compliance check runs
Minimum value : 0
Maximum value : 23
Example : 0

integer (int32)

hostProfileComplianceCheckMinute
optional

Minute at which the scheduled compliance check runs
Minimum value : 0
Maximum value : 59
Example : 0

integer (int32)

hosts
optional

vCenter Cluster Host IDs
Example : [ "string" ]

< string > array

resourcePoolSpecs
optional

Resource Pool Specs
Example : [ "ResourcePoolSpec" ]

< ResourcePoolSpec > array

vmFolders
optional

Virtual Machine folders map
Example : {
"string" : "string"
}

< string, string > map

4.239. SddcCredentials

Credentials contains the username and password

Name Description Schema

password
required

Password
Example : "Admin!23"

string

username
required

Username
Example : "root"

string

4.240. SddcHostSpec

Spec contains parameters for Host

Name Description Schema

association
required

Host Association: Location/Datacenter
Example : "string"

string

credentials
required

Host Credentials
Example : SddcCredentials

SddcCredentials

hostname
required

Host Hostname
Length : 3 - 63
Example : "esx-1"

string

ipAddressPrivate
required

Host Private Management IP
Example : IpAllocation

IpAllocation

key
optional

Host key
Example : "string"

string

serverId
optional

Host server ID
Example : "string"

string

sshThumbprint
optional

Host SSH thumbprint
Example : "string"

string

sslThumbprint
optional

Host SSL thumbprint
Example : "string"

string

vSwitch
required

Example : "string"

string

vmknicSpecs
optional

List of Host Vmknic Spec
Example : [ "HostVmknicSpec" ]

< HostVmknicSpec > array

vswitch
optional

Example : "string"

string

4.241. SddcManager

Sddc Manager representation

Name Description Schema

domain
optional

Information about the domain this Sddc Manager is part of
Example : DomainReference

DomainReference

fqdn
optional

FQDN of the Sddc Manager
Example : "string"

string

id
optional

ID of the Sddc Manager
Example : "string"

string

ipAddress
optional

IP Address of the Sddc Manager
Example : "string"

string

version
optional

Version of the Sddc Manager
Example : "string"

string

4.242. SddcManagerSpec

Client input parameters for SDDC Manager Virtual Machine

Name Description Schema

hostname
required

SddcManager Hostname
Length : 3 - 63
Example : "string"

string

ipAddress
required

Sddc manager ip address
Length : 7 - 15
Example : "string"

string

licenseKey
required

Sddc manager license key
Example : "string"

string

netmask
required

Sddc manager netmask
Example : "string"

string

restApiCredentials
required

Basic Auth Credentials for authenticating into SDDC Manager API, UserName must be adminPassword needs to be a strong password with at least one alphabet and one special character and atleast 8 characters in length.
Example : SddcCredentials

SddcCredentials

rootUserCredentials
required

Root user credentials for the SddcManager VM, UserName must be rootPassword needs to be a strong password with at least one alphabet and one special character and atleast 8 characters in length.
Example : SddcCredentials

SddcCredentials

secondUserCredentials
required

Second user credentials for the SddcManager VM, UserName must be vrackPassword needs to be a strong password with at least one alphabet and one special character and atleast 8 characters in length.
Example : SddcCredentials

SddcCredentials

4.243. SddcMsSqlServerSpec

Spec contains parameters related to vRealize Automation MS SQL Server configuration

Name Description Schema

address
required

Address of the MSSQL server
Example : "string"

string

databaseName
required

Name of the database
Example : "string"

string

hostname
optional

Hostname of the MSSQL server
Example : "string"

string

instanceName
optional

Name of the DB instance
Example : "string"

string

password
optional

Password to login to the MSSQL server
Example : "string"

string

port
optional

Port used to comunicate with the MSSQL server
Example : 0

integer (int32)

username
optional

Username to login to the MSSQL server
Example : "string"

string

vmName
optional

VM name of the MSSQL server
Example : "string"

string

4.244. SddcNetworkSpec

Defines a network spec

Name Description Schema

activeUplinks
optional

Active Uplinks for teaming policy, specify uplink1 for failover_explicit VSAN Teaming Policy
Example : [ "string" ]

< string > array

excludeIpAddressRanges
optional

IP Addresse ranges to be excluded
Example : [ "string" ]

< string > array

excludeIpaddresses
optional

IP Addresses to be excluded
Example : [ "string" ]

< string > array

gateway
optional

Gateway
Length : 7 - 15
Example : "string"

string

includeIpAddress
optional

IP Addresses to be included
Example : [ "string" ]

< string > array

includeIpAddressRanges
optional

IP Addresse ranges to be included
Example : [ "IpRange" ]

< IpRange > array

mtu
required

MTU size
Length : 4
Example : "string"

string

networkType
required

Network Type
Example : "One among:VSAN, VMOTION, PUBLIC, MANAGEMENT, NSX_VTEP, HOSTMANAGEMENT, CLOUD_VENDOR_API, REPLICATION, DATACENTER_NETWORK, NSX_VXLAN, NON_ROUTABLE, CLOUD_VENDOR_API, OOB, CROSS_VPC, UPLINK01, UPLINK02, STORAGE, UDLR, DLR, X_REGION, REGION_SPECIFIC, REMOTE_REGION_SPECIFIC, COMPUTE, MANAGEMENT_VM"

string

portGroupKey
optional

Portgroup key name
Example : "string"

string

standbyUplinks
optional

Standby Uplinks for teaming policy, specify uplink2 for failover_explicit VSAN Teaming Policy
Example : [ "string" ]

< string > array

subnet
optional

Subnet
Length : 7 - 15
Example : "string"

string

subnetMask
optional

Subnet Mask
Length : 7 - 15
Example : "string"

string

teamingPolicy
optional

Teaming Policy for VSAN and VMOTION network types, Default is loadbalance_loadbased
Example : "One among:loadbalance_ip, loadbalance_srcmac, loadbalance_srcid, failover_explicit, loadbalance_loadbased"

string

vlanId
required

VLAN Id
Length : 1 - 4
Example : "string"

string

4.245. SddcSpec

Spec contains parameters for creating/bringing up an SDDC

Name Description Schema

adSpec
optional

The active directory spec
Example : AdSpec

AdSpec

ceipEnabled
optional

Enable VCF Customer Experience Improvement Program
Example : true

boolean

certificatesPassphrase
optional

Passphrase for the PSC / vCenter / NSX / vRA / vROps certificates
Example : "string"

string

clusterSpec
required

Cluster Spec
Example : SddcClusterSpec

SddcClusterSpec

deploymentEndpointSpec
optional

Deployment endpoint
Example : VsphereDeploymentEndpointSpec

VsphereDeploymentEndpointSpec

dnsSpec
required

DNS Spec
Example : DnsSpec

DnsSpec

dvSwitchVersion
optional

The version of the distributed virtual switches to be used
Example : "One among:6.0.0, 6.5.0"

string

dvsSpecs
required

List of Dvs Specs
Example : [ "DvsSpec" ]

< DvsSpec > array

esxLicense
optional

License for the ESXi hosts
Example : "string"

string

excludedComponents
optional

Components to be excluded
Example : "One among:Foundation, VsphereHostProfiles, LogInsight, NSX, VrealizeNetwork, VSAN, VSANCleanup, VROPS, VRA, DRDeployment, DRConfiguration, ConfigurationBackup, VRB, VRSLCM, Inventory, UMDS, EsxThumbprintValidation, AVN, CEIP, Backup"

< string > array

hostSpecs
required

List of Host Specs
Example : [ "SddcHostSpec" ]

< SddcHostSpec > array

managementPoolName
optional

A String identifying the network pool associated with the management domain
Example : "string"

string

networkSpecs
required

List of Network Specs
Example : [ "SddcNetworkSpec" ]

< SddcNetworkSpec > array

nfsDatastoreName
optional

The name of the external (non-VSAN) datastore which is attached to the ESXi hosts.
Example : "string"

string

nsxSpec
optional

NSX Spec
Example : NsxSpec

NsxSpec

ntpServers
required

List of NTP servers
Example : [ "string" ]

< string > array

pscLoadBalancerHostname
optional

The short name of the PSC load-balancer
Example : "mgmt-psc"

string

pscLoadBalancerIpAddress
optional

The IP address of the PSC load-balancer
Example : "string"

string

pscSpecs
optional

PSC VM spec
Example : [ "PscSpec" ]

< PscSpec > array

remoteSiteSpec
optional

Remote site spec
Example : RemoteSiteSpec

RemoteSiteSpec

sddcId
required

Client string that identifies an SDDC by name or instance name
Example : "sfo01-workflowspec-ems"

string

sddcManagerSpec
optional

Sddc Manager Virtual Machine spec
Example : SddcManagerSpec

SddcManagerSpec

selfSignedCertificates
optional

Modules with self-signed certificates
Example : "string"

string

shouldCleanupVsan
optional

Flag indicating whether cleanup vSAN should be ran
Example : false

boolean

skipEsxThumbprintValidation
optional

Skip ESXi thumbprint validation
Example : true

boolean

smtpSpec
optional

SMTP server spec
Example : SmtpSpec

SmtpSpec

srmSpec
optional

The SRM spec
Example : SrmSpec

SrmSpec

taskName
optional

Name of the task to execute
Example : "string"

string

umdsSpec
optional

UMDS spec
Example : UmdsSpec

UmdsSpec

vcenterSpec
required

vCenter Spec
Example : SddcVcenterSpec

SddcVcenterSpec

vrSpec
optional

vSphere replication spec
Example : VsphereReplicationSpec

VsphereReplicationSpec

vraDeploymentSpec
optional

vRealize Automation deployment spec
Example : SddcVraDeploymentSpec

SddcVraDeploymentSpec

vrbDeploymentSpec
optional

vRealize Business deployment spec
Example : SddcVrbDeploymentSpec

SddcVrbDeploymentSpec

vrliDeploymentSpec
optional

vRealize Log Insight Spec
Example : SddcVrliDeploymentSpec

SddcVrliDeploymentSpec

vropsDeploymentSpec
optional

vRealize Operations deployment spec
Example : SddcVropsDeploymentSpec

SddcVropsDeploymentSpec

vrslcmDeploymentSpec
optional

vRealize Lifecyble Manager deployment spec
Example : SddcVrslcmDeploymentSpec

SddcVrslcmDeploymentSpec

vsanSpec
optional

VSAN Spec
Example : VsanSpec

VsanSpec

vxManagerSpec
optional

VxManager Spec
Example : VxManagerSpec

VxManagerSpec

vxRailSpec
optional

VxRail environment details
Example : VxRailSpec

VxRailSpec

4.246. SddcSubTask

Represents a SDDC sub-task

Name Description Schema

creationTimestamp
optional

Sub-Task Creation Time
Example : Instant

Instant

description
optional

Sub-Task Description
Example : "string"

string

errors
optional

List of errors in case of a failure
Example : [ "Error" ]

< Error > array

localizableDescriptionPack
optional

Localizable SDDC Task description
Example : MessagePack

MessagePack

localizableNamePack
optional

Localizable SDDC Task name
Example : MessagePack

MessagePack

name
optional

Sub-Task Name
Example : "string"

string

processingStateDescription
optional

Processing category description, e.g., VC Deployment, VSAN configuration etc
Example : "string"

string

processingStateName
optional

Processing category name, e.g., VC Deployment, VSAN configuration etc
Example : "string"

string

sddcId
optional

SDDC ID
Example : "123e4567-e89b-42d3-a456-556642440000"

string

status
optional

Task Status
Example : "INITIALIZED, COMPLETED_WITH_SUCCESS, COMPLETED_WITH_FAILURE, PREVALIDATION_COMPLETED_WITH_SUCCESS, PREVALIDATION_COMPLETED_WITH_FAILURE, POSTVALIDATION_COMPLETED_WITH_SUCCESS, POSTVALIDATION_COMPLETED_WITH_FAILURE,IN_PROGRESS, PREVALIDATION_IN_PROGRESS, POSTVALIDATION_IN_PROGRESS, INTERNAL_ERROR"

string

updateTimestamp
optional

Last Update Time of Sub-Task
Example : Instant

Instant

4.247. SddcTask

Represents a SDDC task

Name Description Schema

creationTimestamp
optional

SDDC Task creation timestamp
Example : Instant

Instant

id
optional

SDDC ID
Length : 3 - 256
Example : "string"

string

localizableNamePack
optional

Localizable SDDC Task name
Example : MessagePack

MessagePack

name
optional

Task name
Example : "string"

string

sddcSubTasks
optional

All SDDC Sub-Tasks
Example : [ "SddcSubTask" ]

< SddcSubTask > array

status
optional

SDDC Task status
Example : "One among: IN_PROGRESS, COMPLETED_WITH_SUCCESS, ROLLBACK_SUCCESS, COMPLETED_WITH_FAILURE"

string

4.248. SddcVcenterSpec

Spec contains parameters for vCenter

Name Description Schema

licenseFile
optional

License File
Example : "string"

string

rootVcenterPassword
required

vCenter root password. The password must be between 8 characters and 20 characters long. It must also contain at least one uppercase and lowercase letter, one number, and one character from '! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { Ι } ~' and all characters must be ASCII. Space is not allowed in password.
Length : 8 - 20
Example : "string"

string

vcenterHostname
required

vCenter hostname address
Example : "string"

string

vcenterIp
optional

vCenter IP address
Length : 7 - 15
Example : "string"

string

vcenterNetmask
optional

vCenter Netmask
Length : 7 - 15
Example : "string"

string

vmSize
optional

vCenter VM size
Example : "One among:xlarge, large, medium, small, tiny"

string

4.249. SddcVraDeploymentSpec

Spec contains parameters for vRealize Automation

Name Description Schema

brandingSpec
optional

vRealize Automation login pages branding
Example : VraBrandingSpec

VraBrandingSpec

enableVroMultiTenancy
optional

Enable vRO multi-tenancy
Example : true

boolean

fabricGroupNames
optional

vRealize Automation fabric group names
Example : [ "string" ]

< string > array

iaasTemplateName
optional

The name of the vRealize Automation IAAS template in vCenter. The vRealize Automation Windows VMs will be cloned from it.
Example : "string"

string

localAdministratorPassword
required

Local Administrator Password on the IaaS Windows VMs to set
Example : "string"

string

localDefaultTenantAdmin
required

Local default tenant administrator details
Example : VraTenantAdministratorSpec

VraTenantAdministratorSpec

msLbHostName
required

IaaS ManagerService Load Balancer hostname
Example : "string"

string

msLbIpAddress
optional

IaaS ManagerService Load Balancer IP address
Example : "string"

string

msSqlServer
required

MSSQL server details
Example : SddcMsSqlServerSpec

SddcMsSqlServerSpec

skipWindowsVms
optional

Skip deploying clones for the IaaS Windows VMs. User has to pre-deploy them manually
Example : true

boolean

systemAdminPassword
required

System administrator password of vRealize Automation
Example : "string"

string

tenantSpec
optional

vRealize Automation tenant details
Example : VraTenantSpec

VraTenantSpec

vraEmailProviderSpecs
optional

vRealize Automation email providers
Example : [ "VraEmailProviderSpec" ]

< VraEmailProviderSpec > array

vraLbHostName
required

vRealize Automation Load Balancer hostname
Example : "string"

string

vraLbIpAddress
optional

vRealize Automation Load Balancer IP address
Example : "string"

string

vraNodeLicense
required

License for the vRealize Automation nodes
Example : "string"

string

vraRootPassword
required

vRealize Automation appliance root password
Example : "string"

string

vraVms
required

vRealize Automation Virtual Machines details
Example : [ "VraVmSpec" ]

< VraVmSpec > array

webLbHostName
required

IaaS Web Load Balancer hostname
Example : "string"

string

webLbIpAddress
optional

IaaS Web Load Balancer IP address
Example : "string"

string

4.250. SddcVrbDeploymentSpec

Spec contains parameters related to vRealize Business deployment and configurations

Name Description Schema

collectorNode
optional

The collector node to be used in VRB
Example : SddcVrbVm

SddcVrbVm

currency
optional

The currency to be used in VRB
Example : "string"

string

license
optional

The vrb license to be used
Example : "string"

string

serverNode
optional

The server node to be used in VRB
Example : SddcVrbVm

SddcVrbVm

sshPassword
optional

The ssh password to be used
Example : "string"

string

4.251. SddcVrbVm

Spec contains parameters related to vRealize Business Virtual machine

Name Description Schema

hostname
optional

The hostname of the vRB node
Example : "string"

string

ipAddress
required

The IP address of the vRB node
Example : "string"

string

vmName
required

The name of the virtual machine
Example : "string"

string

4.252. SddcVrliDeploymentSpec

Spec contains parameters for deployment/configuration of vRealize Log Insight

Name Description Schema

adminEmail
required

Administrator email address
Example : "string"

string

adminPassword
required

Administrator password
Example : "string"

string

archiveLocation
optional

Archive location where to archive the data. Expected format: server/folder
Example : "string"

string

eventForwardingSiteTag
optional

Site tag (subdomain prefix) used for event forwarding between sites (if missing PSC SSO site name is used)
Example : "string"

string

license
optional

License key
Example : "string"

string

loadBalancerHostname
optional

vRealize Log Insight load-balancer hostname
Example : "string"

string

loadBalancerIpAddress
optional

vRealize Log Insight load-balancer IP address
Example : "string"

string

networkType
optional

The network to use for vRealize Log Insight
Example : "string"

string

notificationEmails
optional

Email addresses to which system notifications will be delivered
Example : [ "string" ]

< string > array

senderSpec
optional

Information of the sender of notifications
Example : SenderSpec

SenderSpec

sshPassword
optional

SSH password for the vRealize Log Insight nodes
Example : "string"

string

vmSize
optional

vRealize Log Insight VM size (default value is 'medium')
Example : "One among:large, medium, small, xsmall"

string

vrliNodeSpecs
optional

List of vRealize Log Insight node specs
Example : [ "VrliNodeSpec" ]

< VrliNodeSpec > array

4.253. SddcVropsDeploymentSpec

Spec contains parameters for vRealize Operations

Name Description Schema

adminPassword
optional

vRealize Operations admin password
Example : "string"

string

collectorSize
optional

vRealize Operations remote collector size (default value is 'smallrc')
Example : "One among:smallrc, largerc"

string

lbHostName
optional

vRealize Operations load balancer hostname
Example : "string"

string

lbIpAddress
optional

vRealize Operations load balancer address
Example : "string"

string

licenseKey
required

vRealize Operations License key
Example : "string"

string

nodeSize
required

vRealize Operations node size (default value is 'medium')
Example : "One among:xsmall, small, medium, large, extra_large"

string

nodeSpecs
optional

vRealize Operations node specs
Example : [ "SddcVropsNodeSpec" ]

< SddcVropsNodeSpec > array

rebootVmAfterHddExtending
optional

Reboot of vRealize Operations Virtual Machines after HDD extending
Example : true

boolean

senderSpec
optional

vRealize Operations sender spec
Example : SenderSpec

SenderSpec

skipHddExtending
optional

Skip the exetending of vRealize Operations Virtual Machines HDD
Example : true

boolean

snmpReadCommunity
optional

vRealize Operations SNMP Community String
Example : "string"

string

vropsRootPassword
optional

vRealize Operations root password
Example : "string"

string

4.254. SddcVropsNodeSpec

Spec contains parameters for vRealize Operations node

Name Description Schema

hostname
optional

The hostname of the vROps node
Example : "string"

string

ipAddress
required

The IP address of the vROps node
Example : "string"

string

vmName
required

The name of the node virtual machine
Example : "string"

string

vropsNodeType
required

The type of the vROps node
Example : "One among:MASTER, REPLICA, DATA, REMOTE_COLLECTOR"

string

4.255. SddcVrslcmDeploymentSpec

This specification contains parameters for creating a new vRealize suite lifecycle manager instance

Name Description Schema

apiPassword
required

The password for an admin API/UI user of vRealize Suite Lifecycle Manager
Example : "string"

string

fqdn
required

Fully Qualified Domain Name
Example : "vrslcm.vrack.vsphere.local"

string

ipAddress
required

The IP address of vRealize Suite Lifecycle Manager appliance
Length : 7 - 15
Example : "string"

string

sshPassword
required

The password for a root user of vRealize Suite Lifecycle Manager appliance
Example : "string"

string

4.256. SenderSpec

Spec contains information used when send events from vRealize Operations and vRealize Log Insight

Name Description Schema

email
required

Email of the sender
Example : "string"

string

name
optional

Name of the sender
Example : "string"

string

4.257. SmtpSpec

Spec contains parameters of SMTP server

Name Description Schema

credentials
optional

Name of the SMTP server.
Example : SddcCredentials

SddcCredentials

isSecureConnection
optional

Flag for is secure connection to SMTP server.
Example : true

boolean

port
required

Port of the SMTP server.
Minimum value : 0
Maximum value : 65535
Example : 0

integer (int32)

requiresAuthentication
optional

Flag for if SMTP server requires authentication.
Example : true

boolean

server
required

Name of the SMTP server.
Example : "string"

string

useTlsEncryption
optional

Flag for if SMTP server use TLS encryption.
Example : true

boolean

4.258. SoftwareComponent

Name Description Schema

id
optional

ID of Resource/Software Component
Example : "string"

string

type
optional

Type of Resource/Software Component
Example : "string"

string

4.259. SrmSpec

Spec contains parameters for deployment and configuration of Site Recovery Manager

Name Description Schema

dbPassword
required

DB Password
Example : "string"

string

licenseKey
optional

SRM License key
Example : "string"

string

srmAdminCredentials
required

SRM Admin credentials
Example : SddcCredentials

SddcCredentials

srmHostname
optional

SRM hostname
Example : "string"

string

srmRootCredentials
required

SRM Root credentials
Example : SddcCredentials

SddcCredentials

srmVmAddress
required

SRM VM address
Example : "string"

string

srmVmName
required

SRM VM name
Example : "string"

string

4.260. Stage

Represents a Stage

Name Description Schema

completionTimestamp
optional

Example : Instant

Instant

creationTimestamp
optional

Example : Instant

Instant

description
optional

Stage description
Example : "string"

string

name
optional

Stage name
Example : "string"

string

status
optional

Stage status
Example : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED"

string

type
optional

Stage type
Example : "string"

string

4.261. Storage

Represents information about storage on a host

Name Description Schema

disks
optional

Information about disks
Example : [ "Disk" ]

< Disk > array

totalCapacityMB
optional

Total storage capacity in MB
Example : 0.0

number (double)

4.262. SubTask

Represents a sub-task

Name Description Schema

completionTimestamp
optional

Sub-task completion timestamp
Example : Instant

Instant

creationTimestamp
optional

Sub-task creation timestamp
Example : Instant

Instant

description
optional

Sub-task description
Example : "string"

string

errors
optional

List of errors in case of a failure
Example : [ "Error" ]

< Error > array

name
optional

Sub-task name
Example : "string"

string

resources
optional

List of resources associated with sub-task
Example : [ "Resource" ]

< Resource > array

stages
optional

List of stages of the sub-task
Example : [ "Stage" ]

< Stage > array

status
optional

Sub-task status
Example : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED"

string

type
optional

Sub-task type
Example : "string"

string

4.263. Task

Represents a task

Name Description Schema

completionTimestamp
optional

Task completion timestamp
Example : Instant

Instant

creationTimestamp
optional

Task creation timestamp
Example : Instant

Instant

errors
optional

List of errors in case of a failure
Example : [ "Error" ]

< Error > array

id
optional

Task ID
Example : "string"

string

isCancellable
optional

Represents task can be cancellable or not.
Example : true

boolean

name
optional

Task name
Example : "string"

string

resources
optional

List of resources associated with task
Example : [ "Resource" ]

< Resource > array

status
optional

Task status
Example : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED"

string

subTasks
optional

List of sub-tasks of the task
Example : [ "SubTask" ]

< SubTask > array

type
optional

Operation that is represented by the Task in machine readable format. The value is controlled by the owners/producers of the Task. The convention is <resource>_<operation>
Example : "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"

string

4.264. UmdsSpec

Spec contains required parameters for VMware Update Manager Download Service

Name Description Schema

address
required

UMDS VM Address
Example : "string"

string

user
required

Username for UMDS Virtual Machine
Example : "string"

string

userPassword
required

Password for UMDS Virtual Machine
Example : "string"

string

4.265. Upgradable

Upgradable represents the upgrade capability of resources. It contains the bundle(using what), resource(on which) and its associated resources/software components that can be upgraded.

Name Description Schema

bundleId
optional

Bundle ID
Example : "string"

string

bundleType
optional

Bundle Type
Example : "string"

string

resource
optional

Resource which is upgradable
Example : Resource

Resource

softwareComponents
optional

Software Components which are Upgradable
Example : [ "SoftwareComponent" ]

< SoftwareComponent > array

status
optional

Upgradable Status
Example : "string"

string

4.266. UpgradeSpec

Upgrade Specification

Name Description Schema

bundleId
required

Bundle ID for Upgrade
Example : "string"

string

resourceType
required

Resource Type for Upgrade
Example : "One among: DOMAIN, CLUSTER, UNASSIGNED_HOST"

string

resourceUpgradeSpecs
required

Resource Upgrade Specifications
Example : [ "ResourceUpgradeSpec" ]

< ResourceUpgradeSpec > array

4.267. Validation

Represents a validation with a list of one or more validation checks that are performed as part of the validation

Name Description Schema

description
optional

Description of the validation
Example : "string"

string

executionStatus
optional

Execution status of the validation
Example : "One among: IN_PROGRESS, FAILED, COMPLETED, SKIPPED, CANCELLED"

string

id
optional

ID of the validation
Example : "string"

string

resultStatus
optional

Result status of the validation after it has completed its execution
Example : "One among: SUCCEEDED, FAILED, FAILED_WITH_WARNINGS"

string

validationChecks
optional

List of one or more validation checks that are performed as part of the validation
Example : [ "ValidationCheck" ]

< ValidationCheck > array

4.268. ValidationCheck

Represents a validation check

Name Description Schema

description
optional

Description of the validation check
Example : "string"

string

errorResponse
optional

Error response associated with the validation check
Example : Error

Error

nestedValidationChecks
optional

List of one or more validation checks that are performed as part of the validation
Example : [ "ValidationCheck" ]

< ValidationCheck > array

resultStatus
optional

Result status of the validation check after it has completed its execution
Example : "One among: SUCCEEDED, FAILED"

string

severity
optional

Severity of the validation check
Example : "One among: WARNING, ERROR, INFO"

string

4.269. Vcenter

vCenter representation

Name Description Schema

domain
optional

Information about the domain this vCenter is part of
Example : DomainReference

DomainReference

fqdn
optional

FQDN of the vCenter
Example : "string"

string

id
optional

ID of the vCenter
Example : "string"

string

ipAddress
optional

IP address of the vCenter
Example : "string"

string

4.270. VcenterReference

Represents a vCenter reference

Name Description Schema

fqdn
optional

FQDN of the vCenter
Example : "string"

string

id
required

ID of the vCenter
Example : "string"

string

4.271. VcenterSpec

This specification contains the installation and configuration of vCenter in a workload domain

Name Description Schema

datacenterName
required

vCenter datacenter name
Example : "string"

string

licenseKey
optional

vCenter license key
Example : "string"

string

name
required

Name of the vCenter virtual machine
Example : "string"

string

networkDetailsSpec
required

Network spec details of the vCenter virtual machine
Example : NetworkDetailsSpec

NetworkDetailsSpec

rootPassword
required

vCenter root shell password
Example : "string"

string

4.272. VcfService

VCF service representation

Name Description Schema

id
optional

ID of the service
Example : "string"

string

name
optional

Name of the service
Example : "string"

string

version
optional

Version of the service
Example : "string"

string

4.273. VdsSpec

This specification contains vSphere distributed switchc configurations

Name Description Schema

name
required

vSphere Distributed Switch name
Example : "string"

string

niocBandwidthAllocationSpecs
optional

List of Network I/O Control Bandwidth Allocations for System Traffic
Example : [ "NiocBandwidthAllocationSpec" ]

< NiocBandwidthAllocationSpec > array

portGroupSpecs
required

List of portgroups to be associated with the vSphere Distributed Switch
Example : [ "PortgroupSpec" ]

< PortgroupSpec > array

4.274. VmNic

This specification contains vmnic configurations for vSphere host

Name Description Schema

id
optional

VmNic ID of vSphere host to be associated with VDS, once added to cluster
Example : "string"

string

vdsName
optional

VDS name to associate with vSphere host
Example : "string"

string

4.275. VmfsDatastoreSpec

Cluster storage configuration for VMFS

Name Description Schema

fcSpec
optional

Cluster storage configuration for VMFS on FC
Example : [ "FcSpec" ]

< FcSpec > array

4.276. VraBrandingSpec

Spec contains parameters for vRealize Automation tenant login pages branding configuration

Name Description Schema

backgroundColor
optional

Background hex color
Example : "string"

string

companyName
optional

Company name
Example : "string"

string

contactLink
optional

Contact link
Example : "string"

string

copyright
optional

Copyright notice
Example : "string"

string

privacyPolicyLink
optional

Privacy policy link
Example : "string"

string

productName
optional

Product name
Example : "string"

string

textColor
optional

text hex color
Example : "string"

string

4.277. VraEmailProviderSpec

Spec contains parameters for vRealize Automation email provider

Name Description Schema

acceptSelfSignedCertificates
optional

Enable/Disable checking for certificates, if not provided checking for certificates will be disabled
Example : true

boolean

emailAddress
required

Email address
Example : "string"

string

inboundDirection
required

Inbound direction
Example : "One among: INBOUND, OUTBOUND"

string

name
required

Email provider name
Example : "string"

string

password
required

Password
Example : "string"

string

port
required

Server port
Example : 0

integer (int32)

protocol
required

Protocol
Example : "One among: IMAP, SMTP"

string

serverAddress
required

Server address
Example : "string"

string

useSsl
optional

Enable/Disable using SSL, if not provided SSL will be disabled
Example : true

boolean

username
required

Username
Example : "string"

string

4.278. VraTenantAdministratorSpec

Spec contains the parameters required for vRealize Automation Tenant Administrator configuration

Name Description Schema

email
optional

Tenant email
Example : "string"

string

firstName
optional

Tenant first name
Example : "string"

string

lastName
optional

Tenant last name
Example : "string"

string

password
required

Tenant password
Example : "string"

string

username
required

Tenant username
Example : "string"

string

4.279. VraTenantSpec

Spec contains parameters for vRealize Automation Tenant creation

Name Description Schema

email
optional

Tenant email
Example : "string"

string

name
required

Tenant name
Example : "string"

string

url
required

Tenant URL
Example : "string"

string

vraTenantAdministratorSpec
optional

vRA tenant administrator
Example : VraTenantAdministratorSpec

VraTenantAdministratorSpec

4.280. VraVmSpec

Spec contains parameters for vRealize Automation virtual machine configuration

Name Description Schema

hostname
optional

Virtual machine hostname
Example : "string"

string

ipAddress
optional

Virtual machine IP address
Example : "string"

string

isPrimary
optional

Is the Virtual machine primary
Example : true

boolean

name
required

Virtual machine name
Example : "string"

string

type
required

vRealize Automation virtual machine type
Example : "string"

string

4.281. VrealizeEnvironment

vRealize product environment

Name Description Schema

environment
required

vRealize Environment
Example : "string"

string

product
required

vRealize Product
Example : "string"

string

4.282. VrealizeNetworkSpec

This specification contains input parameters for a vRealize network.

Name Description Schema

gateway
required

The gateway address for a vRealize network
Example : "10.0.1.250"

string

subnetMask
required

The subnet mask for a vRealize network
Example : "255.255.252.0"

string

vlanId
required

The VLAN ID for a vRealize network
Example : "2042"

string

4.283. VrealizeProductNode

Spec contains information for a vRealize product node

Name Description Schema

fqdn
required

The Fully Qualified Domain Name for the vRealize node (virtual appliance)
Example : "vrops.vrack.vsphere.local"

string

id
optional

The ID of the node
Example : "string"

string

ipAddress
required

IP Address of vRealize product appliance
Example : "10.0.0.17"

string

type
required

The type of the vRealize product node
Example : "MASTER, REPLICA, DATA, REMOTE_COLLECTOR, WORKER"

enum (MASTER, REPLICA, DATA, REMOTE_COLLECTOR, WORKER)

4.284. Vrli

Spec contains parameters of a vRealize Log Insight instance

Name Description Schema

id
optional

The ID of the vRealize Log Insight instance
Example : "string"

string

loadBalancerFqdn
optional

The Fully Qualified Domain Name of the vRealize Log Insight load balancer
Example : "load-balancer.vrack.vsphere.local"

string

loadBalancerIpAddress
optional

The IP address of the vRealize Log Insight load balancer
Example : "10.0.0.15"

string

nodeSize
optional

Size of the nodes for vRealize Log Insight instance
Example : "SMALL, MEDIUM, LARGE"

string

nodes
optional

The nodes of the vRealize Log Insight instance
Example : [ "VrealizeProductNode" ]

< VrealizeProductNode > array

status
optional

The status of the vRealize Log Insight instance
Example : "ACTIVE, ERROR"

string

version
optional

The version of the vRealize Log Insight instance
Example : "4.8.0-13036238"

string

workloadDomainConnection
required

Represents if vRealize Log Insight is configured to connect with workload domains.
Example : true

boolean

4.285. VrliNodeSpec

Spec contains parameters of vRealize Log Insight node

Name Description Schema

hostname
optional

Node hostname. If a short name is provided here then a FQDN will be constructed using the DNS spec’s subdomain. If a FQDN is provided here then it will be used as is.
Example : "string"

string

ipAddress
optional

Node IP address. This address must be from the range of the network specified in the networkType field of the Log Insight spec
Length : 7 - 15
Example : "string"

string

4.286. Vrops

This specification contains information related to the existing vRealize Operations instance deployment

Name Description Schema

id
required

The ID of the vRealize Operations instance
Example : "string"

string

loadBalancerFqdn
required

Fully Qualified Domain Name for the vRealize Operations load balancer
Example : "string"

string

loadBalancerIp
required

IP for the vRealize Operations load balancer
Example : "string"

string

nodeSize
required

The node size of the vRealize Operations instance
Example : "string"

string

nodes
required

The nodes of the vRealize Operations instance
Example : [ "VropsNode" ]

< VropsNode > array

status
required

The state of the current product instance
Example : "string"

string

version
required

The version of the vRealize Operations instance
Example : "string"

string

4.287. VropsDeploymentSpec

Spec contains parameters for creating a new vRealize Operations instance

Name Description Schema

apiPassword
required

The password for API access to vRealize Operations.
Example : "string"

string

enableHa
required

Enable high availability for vRealize Operations.
Example : true

boolean

licenseKey
required

The license key for vRealize Operations.
Example : "string"

string

loadBalancerFqdn
required

The Fully Qualified Domain Name for the vRealize Operations appliance load balancer.
Example : "vrealize-lb.vrack.vsphere.local"

string

nodeSize
required

The node size for the vRealize Operations appliance.
Example : "MEDIUM"

enum (XSMALL, SMALL, MEDIUM, LARGE, EXTRA_LARGE)

nodes
required

The vRealize Operations nodes that will be deployed.
Example : [ "VropsNode" ]

< VropsNode > array

vrealizeEdgeFqdn
optional

The Fully Qualified Domain Name for vRealize Edge.
Example : "vrealize-edge.vrack.vsphere.local"

string

4.288. VropsNode

Spec contains information for a vRealize product node

Name Description Schema

fqdn
required

The Fully Qualified Domain Name for the vRealize node (virtual appliance)
Example : "vrops.vrack.vsphere.local"

string

id
optional

The ID of the node
Example : "string"

string

ipAddress
required

IP Address of vRealize product appliance
Example : "10.0.0.17"

string

password
optional

The password for a root user of vRealize appliance
Example : "string"

string

status
required

The status of the vRealize product node
Example : "ACTIVE"

string

type
required

The type of the vRealize product node
Example : "MASTER, REPLICA, DATA, REMOTE_COLLECTOR, WORKER"

enum (MASTER, REPLICA, DATA, REMOTE_COLLECTOR, WORKER)

username
optional

The username for a root user of vRealize appliance
Example : "user"

string

4.289. VropsOperationSpecValidation

Spec contains parameters for validating a new vRealize Operations instance

Name Description Schema

vropsDeploymentSpec
optional

Spec contains parameters for deploying a new vRealize Operations instance.
Example : VropsDeploymentSpec

VropsDeploymentSpec

vropsExpansionSpec
optional

Spec contains parameters for expanding vRealize Operations with new node.
Example : VropsNode

VropsNode

4.290. Vrslcm

This specification contains information related to the existing vRealize Suite Lifecycle Manager instance deployment

Name Description Schema

fqdn
required

Fully Qualified Domain Name
Example : "string"

string

id
required

The ID of the vRealize Suite Lifecycle Manager instance
Example : "string"

string

ipAddress
required

IP Address of vRealize Suite Lifecycle Manager appliance
Example : "string"

string

status
required

The state of the current product instance
Example : "string"

string

version
required

Version of the product that is currently running on the environment
Example : "string"

string

4.291. VrslcmDeploymentSpec

Spec contains parameters for creating a new vRealize Suite Lifecycle Manager instance

Name Description Schema

apiPassword
required

The password for an admin API/UI user of vRealize Suite Lifecycle Manager
Example : "string"

string

fqdn
required

Fully Qualified Domain Name
Example : "vrslcm.vrack.vsphere.local"

string

networkSpec
required

Specification for the vRealize Network that will be used for the deployment.
Example : VrealizeNetworkSpec

VrealizeNetworkSpec

sshPassword
required

The password for a root user of vRealize Suite Lifecycle Manager appliance
Example : "string"

string

4.292. VsanDatastoreSpec

This specification contains cluster storage configuration for vSAN

Name Description Schema

datastoreName
required

Datastore name used for cluster creation
Example : "string"

string

dedupAndCompressionEnabled
optional

Enable vSAN deduplication and compression
Example : true

boolean

failuresToTolerate
required

Number of vSphere host failures to tolerate in the vSAN cluster
Example : 0

integer (int32)

licenseKey
required

License key for the vSAN data store to be applied in vCenter
Example : "string"

string

4.293. VsanSpec

Spec contains parameters of Virtual SAN

Name Description Schema

datastoreName
required

Datastore Name
Example : "string"

string

hclFile
optional

HCL File
Example : "string"

string

licenseFile
optional

License File
Example : "string"

string

vsanDedup
optional

VSAN feature Deduplication and Compression flag, one flag for both features
Example : true

boolean

vsanName
required

Virtual SAN config name
Example : "string"

string

4.294. VsphereDeploymentEndpointSpec

Spec contains parameters needed for products to deploy on entered vCenter

Name Description Schema

cluster
required

Cluster where to deploy products
Example : "string"

string

datacenter
required

Datacenter used for products deployment
Example : "string"

string

resourcePool
required

Resource pool used for products deployment
Example : "string"

string

storage
required

Storage used for products deployment
Example : "string"

string

vcenter
required

Information of vCenter which is used to deploy on it
Example : RemoteEndpointSpec

RemoteEndpointSpec

vmFolder
required

Folder in vCenter where to deploy products Virtual Machines
Example : "string"

string

vmFolders
required

All existing folders in vCenter
Example : {
"string" : "string"
}

< string, string > map

4.295. VsphereReplicationSpec

Spec contains parameters for deployment and configuration of vSphere replication

Name Description Schema

ipPoolName
optional

vSphere replication IP pool (network protocol profile) name
Example : "string"

string

rootPassword
required

vSphere replication local root user ssh password.Password needs to be a strong password with at least one Uppercase alphabet, one lowercase alphabet, one digit and one special character specified in braces [!$%^] and 8-20 characters in length,and 3 maximum identical adjacent characters!
Length : 8 - 20
Example : "string"

string

vrIp
optional

vSphere replication appliance IP address
Length : 7 - 15
Example : "string"

string

vrReplicationIp
optional

vSphere replication appliance replication IP address
Length : 7 - 15
Example : "string"

string

vrShortHostName
optional

vSphere replication appliance HostName (also user as VM name)
Example : "string"

string

4.296. VxManagerSpec

Spec contains parameters for VxManager

Name Description Schema

defaultAdminUserCredentials
required

Default admin credentials VxManager
Example : SddcCredentials

SddcCredentials

defaultRootUserCredentials
required

Default root credentials VxManager
Example : SddcCredentials

SddcCredentials

vxManagerHostName
required

VxManager host name
Example : "string"

string

4.297. VxRailSpec

Spec contains parameters for VxRail

Name Description Schema

vxRailObjectNames
optional

Map of VxRail object types and names
Example : {
"string" : "string"
}

< string, string > map

4.298. WitnessSpec

Spec contains the Witness host parameters that are part of each stretched cluster

Name Description Schema

fqdn
required

Management ip of the witness host
Example : "string"

string

vsanCidr
required

vSAN subnet cidr of the witness host
Example : "string"

string

vsanIp
required

vSAN IP of the witness host
Example : "string"

string

4.299. ZookeeperServerInfo

Name Description Schema

clientPort
optional

Example : 0

integer (int32)

electionPort
optional

Example : 0

integer (int32)

fqdn
optional

Example : "string"

string

hostAddress
optional

Example : "string"

string

peerPort
optional

Example : 0

integer (int32)

securePort
optional

Example : 0

integer (int32)

zkId
optional

Example : 0

integer (int32)

zkRole
optional

Example : "string"

string

4.300. ZookeeperServerInfoList

Name Description Schema

zookeeperServersInfo
optional

Example : [ "ZookeeperServerInfo" ]

< ZookeeperServerInfo > array

5. Troubleshooting Guide

5.1. Error codes and messages

Messages having {} indicate dynamic values being set.

5.1.1. Hosts

Error code Description

POST_INTERNAL_SERVER_ERROR

Internal server error

TASK_REGISTRATION_FAILED

Failed to register task to task aggregator

TASK_REGISTRATION_FAILED.remedy

Please make sure that commonsvcs service is up and running.

FAIL_DECOMMISSION_HOST

Failed to decommission host.

HOST_VALIDATION_FOR_DECOMMISSION_FAILED

Failed to validate the host for decommission.

HOST_VALIDATION_FOR_DECOMMISSION_FAILED.remedy

Make sure that the host is not part of any cluster.

HOST_NFS_MOUNT_CLEAN_FAILED

Failed to remove NFS configuration of the host.

HOST_NFS_MOUNT_CLEAN_FAILED.remedy

Retry decommission once this issue gets resolved.

KNOWN_HOST_ENTRY_CLEANUP_FAILED

Failed to remove known hosts configuration entry of the host.

KNOWN_HOST_ENTRY_CLEANUP_FAILED.remedy

Retry decommission once this issue gets resolved.

HOST_CREDENTIAL_DELETION_FAILED

Failed to delete credentials of the host {0}.

HOST_CREDENTIAL_DELETION_FAILED.remedy

Retry decommission once this issue gets resolved.

STORAGE_SAVE_ERROR

Failed to save input data to persistent storage

STORAGE_GET_ERROR

Failed to get input data from persistent storage

FAIL_TO_CLEAR_CACHE

Failed to clear input data from cache

REMOVE_HOST_NOT_INITIALIZED

Removal for host {0} is not initialized.

REMOVE_HOST_GET_DATA_ERROR

Failed to get data for remove host. Reason: {0}

REMOVE_HOST_UPDATE_DATA_ERROR

Failed to update data for remove host. Reason: {0}

DECOMMISSION_HOST_GET_DATA_ERROR

Failed to get data for decommission host. Reason: {0}

DECOMMISSION_HOST_UPDATE_DATA_ERROR

Failed to update data for decommission host. Reason: {0}

PMM_UPDATE_ALERT_FILTER_ERROR

Failed to update alert-suppression filter for {0} to {1}

SERIALIZATION_ERROR

Failed to serialize the add host uber spec

HOST_NOT_REACHABLE

Cannot connect to host with IP address {0}

HOST_NOT_REACHABLE.remedy

Please check the connectivity to host with IP address {0}.

HOST_DNS_CONFIGURATION_FAILED

Cannot configure DNS {0} on host {1}

HOST_DNS_CONFIGURATION_FAILED.remedy

Please check the DNS {0} configuration on the host.

HOST_NTP_CONFIGURATION_FAILED

Cannot configure NTP servers {0} for host {1}

HOST_NTP_CONFIGURATION_FAILED.remedy

Please check the connectivity to host with IP address {0}.

NTP_SERVERS_NOT_REACHABLE

NTP Servers {0} are not reachable from host {1}

NTP_SERVERS_NOT_REACHABLE.remedy

Please check the connectivity of NTP servers {0} from host {1}

BLANK_PRIMARY_DNS_IP

Cannot find primary DNS IP in the inventory.

BLANK_PRIMARY_DNS_IP.remedy

Please make sure that primary DNS IP is available in the inventory (DB).

BLANK_NTP_IP

Cannot find any NTP IP in the inventory.

BLANK_NTP_IP.remedy

Please make sure that at least one NTP IP is available in the inventory (DB).

FAILED_TO_GET_DNS_NTP_IP

Failed to fetch DNS and NTP IPs from inventory.

FAILED_TO_GET_DNS_NTP_IP.remedy

Please make sure that commonsvcs service is up and running.

FAILED_TO_UPDATE_ESXIs

Failed to update given hosts : {0} into DB.

FAILED_TO_UPDATE_ESXIs.remedy

Please make sure that commonsvcs service is up and running.

FAILED_TO_UPDATE_ESXI

Failed to update given host into DB.

FAILED_TO_UPDATE_ESXI.remedy

Please make sure that commonsvcs service is up and running.

NOT_FREE_HOSTS

Hosts : {0} are still part of a cluster.

HOST_STATUS_UPDATE_FAILED

Failed to update the status of the host

HOST_STATUS_UPDATE_FAILED.remedy

Please make sure that commonsvcs service is up and running.

HOSTS_DELETE_FAILED

Failed to delete host(s) : {0}

HOST_DELETE_FAILED.remedy

Retry decommission

HOSTS_IN_DIFFERENT_CLUSTERS_ERROR

Hosts are in different clusters

NOT_ALL_HOSTS_IN_INVENTIORY_ERROR

Some ESXi hosts are not known to VCF

VDSS_SIZE_ERROR

Expected maximum {0}, but found {1} Virtual Distributed Switches.

COMMISSION_HOST_INVALID_SPEC_DUPLICATE_HOSTS

Invalid commission spec duplicate hosts - {0}:{1}.

COMMISSION_HOST_INVALID_SPEC_DUPLICATE_HOSTS.remedy

Please remove duplicate hosts - {0}:{1} from the commission spec.

COMMISSION_HOST_INVENTORY_VALIDATION_FAILED

Host {0} already present in inventory, validation failed.

COMMISSION_HOST_INVENTORY_VALIDATION_FAILED.remedy

Please make sure that you have gone through the validation check-list.

COMMISSION_HOST_INVALID_SPEC

Commission Hosts invalid spec

COMMISSION_HOST_INVALID_SPEC.remedy

Please pass a valid Commission Hosts spec.

ROTATE_HOST_SSH_KEYS_FAILED

Error rotating SSH key for the Host - [{0}].

ROTATE_HOST_SSH_KEYS_FAILED.remedy

Please make sure that commonsvcs service is up and running.

FAILED_TO_GET_SDDCMANAGER_KNOWNHOSTS

Failed to get SDDC Manager known hosts.

FAILED_TO_GET_SDDCMANAGER_KNOWNHOSTS.remedy

Please make sure that commonsvcs service is up and running.

FAILED_TO_UPDATE_SDDCMANAGER_KNOWNHOSTS

Error updating SDDC Manager known hosts.

FAILED_TO_UPDATE_SDDCMANAGER_KNOWNHOSTS.remedy

Please make sure that commonsvcs service is up and running.

HOSTS_NOT_FOUND_IN_SDDCMANAGER_KNOWNHOSTS

Post validation failed as Host(s) - {0} not found in SDDC Manager known hosts.

HOSTS_NOT_FOUND_IN_SDDCMANAGER_KNOWNHOSTS.remedy

Please initiate a fresh decommisioning workflow for these host(s) - {0}.

FAILED_TO_POST_KNOWNHOSTS_TO_APPLIANCEMANAGER

Error posting known hosts to SDDC Manager. Status: {0}

FAILED_TO_POST_KNOWNHOSTS_TO_APPLIANCEMANAGER.remedy

Please make sure that commonsvcs service is up and running.

CLUSTER_FTT_UNKNOWN_ERROR

Null value for FTT for cluster {0}.

FAILED_TO_MOUNT_NFS_DATASTORE_ON_HOST

Failed to mount NFS datastore - {0}:{1} on Host - {2}.

NFS_DATASTORE_NOT_MOUNTED_ON_HOSTS

NFS datastore - {0}:{1}:{2} not mounted on Host(s) - {3}.

VCF_HOST_CONNECTIVITY_TO_HOST_FAILED

Could not connect to Host - [{0}].

FAILED_TO_UPDATE_NFS_CONFIGURATION_ON_SDDC_MANAGER

Failed to update NFS configuration for Hosts - {0}

FAILED_TO_REFRESH_NFS_CONFIGURATION_ON_SDDC_MANAGER

Refreshing NFS configuration on SDDC Manager failed.

FAILED_TO_DETERMINE_SDDC_MANAGER_IPADDRESS

Failed to determine SDDC Manager IP address.

FAILED_TO_FETCH_HOST_ATTRIBUTES

Failed to fetch attributes from Host - {0}.

FAILED_TO_FETCH_HOST_ATTRIBUTES.remedy

Please make sure that commonsvcs service is up and running.

REMOVE_HOSTS_FROM_NOT_ACTIVE_DOMAIN_ERROR

Removal for hosts {0} from not active domain is not allowed.

REMOVE_HOSTS_FROM_NOT_ACTIVE_CLUSTER_ERROR

Removal for hosts {0} from not active cluster is not allowed.

HOSTS_ALREADY_BEING_REMOVED

Host(s) {0} already being removed.

REMOVE_HOSTS_NOT_ACTIVE_VCENTER_ERROR

Removal for hosts {0} from domain with not active vCenter is not allowed.

REMOVE_HOSTS_NOT_ACTIVE_NSX_MANAGER_ERROR

Not attempting to remove hosts {0} from cluster {1} when the NSX Manager is in a bad state. Retry after confirming NSX Manager is not reporting any errors.

REMOVE_HOSTS_NOT_ACTIVE_NSX_T_MANAGER_ERROR

Not attempting to remove hosts {0} from cluster {1} when the NSX-T Manager is in a bad state. Retry after confirming NSX-T Manager is not reporting any errors.

REMOVE_HOSTS_NOT_ACTIVE_NSX_MANAGER_ERROR.remedy

Retry after confirming NSX Manager is not reporting any errors.

COMM_FAILED_DUE_TO_MISSING_HOSTS

Failed because hosts {0} are no more in the inventory.

COMM_FAILED_DUE_TO_MISSING_HOSTS.remedy

Please initiate a new workflow with the hosts {0}.

DECOMM_FAILED_DUE_TO_MISSING_HOSTS

Failed because host(s) : {0} are no more in the inventory.

DECOMM_FAILED_DUE_TO_MISSING_HOSTS.remedy

Please verify if correct set of hosts are being decommissioned.

HOSTS_NOT_IN_EXPECTED_CLUSTERS_ERROR

Hosts {0} are not in expected cluster {1} anymore.

DECOMMISSIONING_FAILED

Decommissioning failed. Reason : {0}

SSH_LOGIN_FAILED

SSH login failed for the host: {0}

FAILED_TO_EXECUTE_COMMAND

Command {0} execution failed on the host: {1}.

NTP_SYNC_FAILED

Time synchronization of the NTP servers {0} failed on the host {1}.

NTP_SYNC_FAILED.remedy

Please check the connectivity of NTP servers {0} from host {1}.

HOST_VIB_VALIDATION_FAILED

Please uninstall VIB(s) - {0} on the Host {1}.

HOSTS_COMMISSION_SPEC_VALIDATION_FAILED

Hosts commission spec validation failed. errors: {0}.

HOSTS_VALIDATION_FOR_COMMISSION_FAILED

Hosts validation for commission failed. errors: {0}.

FAILED_TO_RAISE_EVENT

Failed to raise event.

FQDN_NULL_OR_EMPTY

FQDN cannot be null, empty or blank

HOST_USERNAME_NULL_OR_EMPTY

Host username cannot be null, empty or blank

HOST_PASSWORD_NULL_OR_EMPTY

Host password cannot be null, empty or blank

STORAGE_TYPE_NULL

Storage type cannot be null or blank

NETWORKPOOL_ID_NULL_OR_EMPTY

Network pool ID cannot be null, empty or blank

NETWORKPOOL_ID_INVALID

Invalid Network pool ID

STORAGE_TYPE_INVALID

Storage type is invalid. Allowable values: {0}

HOST_SPEC_EMPTY

Input specification must not be empty

APPLIED_ESXI_LICENSE_IS_INVALID

The ESXi license applied to host {0} is invalid

APPLIED_ESXI_LICENSE_IS_INVALID.remedy

Please assign a valid license directly to the ESXi host before retrying

5.1.2. Common

Error code Description

CLUSTERSPEC_VALIDATION_FAILED

Failed to validate cluster spec

INTERNAL_SERVER_ERROR

InternalServerError

BAD_REQUEST

Bad Request

DOMAINSPEC_VALIDATION_FAILED

Failed to validate domain spec

DOMAIN_NOT_FOUND

Domain {0} not found

CLUSTER_INVENTORY_VALIDATION_FAILED

The cluster inventory validation workflow failed with status {0}

CLUSTER_INVENTORY_VALIDATION_FAILED.remedy

Please make sure your system is in stable state with the domainmanager app running and retry workflow

5.1.3. Domains

Error code Description

REMOVE_VI_NOT_INITIALIZED

Vi removal for domain {0} is not initialized

DOMAIN_NOT_FOUND

Domain with ID {0} not found

5.1.4. Clusters

Error code Description

CLUSTER_NOT_FOUND

Cluster with ID {0} not found

5.1.5. Credentials

Error code Description

PASSWORD_MANAGER_ENTITY_TYPE_NOT_FOUND

Entity Type {0} not found

PASSWORD_MANAGER_DOMAIN_NAME_NOT_FOUND

Domain {0} doesn’t exists

PASSWORD_MANAGER_CREDENTIAL_TYPE_NOT_FOUND

Credential Type {0} not found

PASSWORD_MANAGER_ENTITY_ID_NOT_FOUND

Entity ID not found

PASSWORD_MANAGER_ENTITY_IP_ADDRESS_NOT_FOUND

Entity IP address not found

PASSWORD_MANAGER_ENTITY_NAME_NOT_FOUND

Entity name not found

PASSWORD_MANAGER_ENTITY_USER_NAME_NOT_FOUND

Entity username not found

PASSWORD_MANAGER_ENTITY_PASSWORD_NOT_FOUND

Entity password not found

PASSWORD_MANAGER_INVALID_USER_FOR_CREDENTIAL

Entity user name {0} is invalid for {1}

PASSWORD_MANAGER_CHANGER_NOT_FOUND

Invalid entity type {1} for credential {0}

PASSWORD_MANAGER_TRANSACTION_WORKFLOWID_NOT_FOUND

Could not find workflow ID {0}

PASSWORD_MANAGER_TASK_REGISTRATION_FAILED

Failed to register with Task aggregator for {0}

PASSWORD_MANAGER_TASK_CANCELLATION_FAILED

Failed to cancel task from Task aggregator for {0}

PASSWORD_MANAGER_TRANSACTION_ID_NOT_FOUND

Task ID {0} not found

PASSWORD_MANAGER_CANNOT_PATCH

Task ID {0} cannot be patched as it is already successful/cancelled

PASSWORD_MANAGER_CANNOT_BE_RESTARTED

Transaction ID {0} cannot be restarted as the supplied password became void due to another update.

PASSWORD_MANAGER_UPDATE_IN_PROGRESS

Password update task {0} is in progress/failed state, retry after sometime.

PASSWORD_MANAGER_NEW_PASSWORD_NOT_ALLOWED

Password update transaction {0} cannot have a modified password at this time

PASSWORD_MANAGER_TRANSACTION_ID_MISSING

Required parameter transactionId missing in PATCH request body

PASSWORD_MANAGER_MISC_ERROR

General error

PASSWORD_MANAGER_CANNOT_BE_CANCELLED

Task ID {0} should be in the failure state to initiate cancel operation

PASSWORD_MANAGER_ENTITY_TYPE_NOT_SUPPORTED

EntityType {0} is not supported

PASSWORD_MANAGER_PASSWORD_NOT_FOUND

Unable to find password for EntityType {0}

PASSWORD_MANAGER_UPDATE_ACTION_MISSING

Password update action is missing

PASSWORD_MANAGER_ENTITY_MISSING

Password update payload should have valid entity details

PASSWORD_MANAGER_TRANSACTIONID_MISSING

Password update operation should have valid transaction ID

PASSWORD_MANAGER_ENTITY_NOT_FOUND

Entity not found with provided information

PASSWORD_MANAGER_INVALID_IPADDRESS

Invalid entity IP address {0}

PASSWORD_MANAGER_INVALID_FQDN

Invalid entity name/FQDN {0}

PASSWORD_MANAGER_INVALID_PAGE

Invalid page number specified. It must be greater than zero.

PASSWORD_MANAGER_RESOURCE_STATE_CANNOT_BE_SET

Unable to set the status {0} for {1}

PASSWORD_MANAGER_RESOURCE_UNAVAILABLE

Resource {0} is not available/ready

PASSWORD_MANAGER_DEPENDENT_RESOURCE_UNAVAILABLE

Dependent resource {0} is not available/ready

PASSWORD_MANAGER_CSS_SYNC_ERROR

Retry this task {0} as it cannot be canceled at this stage due to storage error

PASSWORD_MANAGER_ENTITY_MISMATCH

The task {0} doesn’t match with the supplied entity

PASSWORD_MANAGER_ENTITY_LIST_NOT_FOUND

List of entities must be supplied for rotate operation

PASSWORD_MANAGER_ROTATE_CANNOT_BE_STARTED

The password rotate operation cannot be started

PASSWORD_MANAGER_TRANSACTION_TYPE_MISMATCH

Task ID {0} cannot be patched as it’s type {1} is incorrect.

PASSWORD_MANAGER_OPERATION_TYPE_MISSING

Password operation type is missing

PASSWORD_MANAGER_INVALID_OPERATION_TYPE

Operation type is invalid. Allowable values: {0}

PASSWORD_MANAGER_UNKNOWN_ACTION

Password manager bulk update/rotate feature is disabled.

PASSWORD_MANAGER_DATA_IMPORT_FAILED_NO_DATA

Missing data to import, please check data export function.

PASSWORD_MANAGER_DATA_IMPORT_FAILED

Failed to import provided data into password management data store.

PASSWORD_MANAGER_UNKNOWN_DATA_VERSION

Unknown version or version not supported by current import function.

PASSWORD_MANAGER_CREDENTIAL_ID_NOT_FOUND

Credential ID {0} not found.

PASSWORD_MANAGER_RETRY_REQUEST_PAYLOAD_MISMATCH

Task ID {0} cannot be patched as there is mismatch in request body.

PASSWORD_MANAGER_INVALID_BASIC_AUTH_CREDENTIAL

Invalid basic-auth credential in request body.

PASSWORD_MANAGER_INVALID_RESOURCE_TYPE

Resource type is invalid. Allowable values: {0}

PASSWORD_MANAGER_INVALID_CREDENTIAL_TYPE

Credential type is invalid. Allowable values: {0}

PASSWORD_MANAGER_INVALID_PAGESIZE_LIMIT

Limit must not be less than one.

PASSWORD_MANAGER_LOOKUP_FAILED

Failed to lookup passwords due to internal problem. Please try again later.

PRIVILEGED_USER_AUTHORIZATION_FAILED

Privileged user not authorized for this operation.

PRIVILEGED_USER_AUTHENTICATION_FAILED

Invalid privileged username and/or password.

PRIVILEGED_USER_USERNAME_MISSING_DOMAIN

Privileged username must be in the format user@domain.

PRIVILEGED_USER_GENERIC_ERROR

Internal error occurred during validation of privileged user credentials.

5.1.6. License keys

Error code Description

LICENSE_KEY_ALREADY_EXISTS

Unable to add license key since license key {0} already exists.

LICENSE_KEY_ALREADY_EXISTS.remedy

Add a different license key since identical license key already exists.

LICENSE_KEY_NOT_FOUND

License key with UUID {0} does not exist.

LICENSE_KEY_NOT_FOUND.remedy

Try again with proper license key

LICENSE_KEY_DOES_NOT_EXIST

License key {0} does not exist.

LICENSE_KEY_DOES_NOT_EXIST.remedy

Try again with existing license key

ADD_DLF_FAILED

Error while adding DLF

ADD_DLF_FAILED.remedy

Make sure you are passing required details, (1) Error while writing a file, may be permission issues.

LICENSE_KEY_INCORRECT_FORMAT_ERROR

License key is not in correct format.

LICENSE_KEY_INCORRECT_FORMAT_ERROR.remedy

Make sure you are adhering to License key format (1) Key should be 29 character in length. (2) Key should be hyphenated at each 5 letter word.

DLF_INVALID_PATH

Invalid DLF path

DLF_INVALID_PATH.remedy

1.Make sure you have correct DLF path.

LICENSE_KEY_CORRUPTED

License key is corrupted.

LICENSE_KEY_CORRUPTED.remedy

1. Make sure you use correct license key.

NO_VALID_DLFS_FOUND

No valid DLF found in system.

NO_VALID_DLFS_FOUND.remedy

1.Make sure you have correct licensekey 2. Use add DLF rest api to add one valid DLF in system.

LICENSE_KEY_EXPIRED

License key has expired.

LICENSE_KEY_EXPIRED.remedy

1. Make sure you use correct license key.

NO_ACTIVE_LICENSE_KEY_FOUND

Active license key not found.

NO_ACTIVE_LICENSE_KEY_FOUND.remedy

1. Make sure you add an active license key.

EXCESS_ACTIVE_LICENSE_KEYS_FOUND

More number of active license keys found.

EXCESS_ACTIVE_LICENSE_KEYS_FOUND.remedy

1. Make sure you specify the license key which needs to be used.

LICENSE_KEY_NOT_COMPATIBLE

The license key is not compatible with the current licensing mode and cannot be used.

LICENSE_KEY_NOT_COMPATIBLE.remedy

Make sure you use compatible license key for the action.

DLF_UNREADABLE_PROPERTIES

DLFs Unable to read properties.

DLF_UNREADABLE_PROPERTIES.remedy

1. Make sure you use correct license key.

DLFSERVICE_READ_FILE_AS_STRING_FAILED

Error while reading DLF file {0}

DLFSERVICE_READ_FILE_AS_STRING_FAILED.remedy

Make sure you have correct dlf stored prior attempt to read.

INVALID_LICENSE_KEY

Invalid licensekey

INVALID_LICENSE_KEY.remedy

1. Make sure you use correct license key.

NULL_LICENSE_KEY

The license key is null

NULL_LICENSE_KEY.remedy

Make sure the input is correct and the license exists.

LICENSE_KEY_NOT_SUPPORTED

Licensekey is not supported, contact administrator.

LICENSE_KEY_NOT_SUPPORTED.remedy

1.Make sure you have valid DLF in system.

LICENSE_MODE_NOT_SET

Licensing mode is not set.

LICENSE_MODE_NOT_SET.remedy

Make sure the licensing mode is set.

PSC_OR_CREDS_NOT_AVAILABLE

PSC or credential service not accessible.

PSC_OR_CREDS_NOT_AVAILABLE.remedy

1. Make sure the PSC/credential service are accessible.

INVALID_UUID

Invalid UUID given

INVALID_UUID.remedy

1.Make sure a valid UUID is given

RESOURCE_MISMATCH

Resource provided in url and payload are not matching.

RESOURCE_MISMATCH.remedy

Make sure you are passing correct and same resource details in URL and payload.

RESOURCE_NOT_FOUND

Resource with UUID {0} does not exist.

RESOURCE_NOT_FOUND.remedy

Try again with proper resource UUID.

OPERATION_NOT_SUPPORTED

Operation is not supported.

OPERATION_NOT_SUPPORTED.remedy

None.

OPERATION_NOT_SUPPORTED_WITH_CURRENT_LICENSING_MODE

Operation is not supported in current licensing mode.

OPERATION_NOT_SUPPORTED_WITH_CURRENT_LICENSING_MODE.remedy

Make sure the system is in subscription licensing mode.

LICENSE_KEY_CANNOT_BE_DELETED

The license key is in use and cannot be deleted.

LICENSE_KEY_CANNOT_BE_DELETED.remedy

Make sure that the license key is not used for licensing any resource.

LICENSE_KEY_NOT_SPECIFIED

Atleast one license key must be specified in the input.

LICENSE_KEY_NOT_SPECIFIED.remedy

Specify one or more license keys in the input.

LICENSING_MODE_SWITCH_FAILED

Failed to switch the licensing mode.

LICENSING_MODE_SWITCH_FAILED.remedy

None.

TASK_REGISTRATION_FAILED

Registering task with Task aggregator failed.

TASK_REGISTRATION_FAILED.remedy

None.

LOCK_NOT_AVAILABLE

Lock not available.

LOCK_NOT_AVAILABLE.remedy

None.

FAILED_TO_ACQUIRE_LOCK

Failed to acquire lock.

FAILED_TO_ACQUIRE_LOCK.remedy

None.

FAILED_TO_RELEASE_LOCK

Failed to release lock.

FAILED_TO_RELEASE_LOCK.remedy

None.

DOMAIN_IN_USE

Domain {0} is being used in system.

DOMAIN_IN_USE.remedy

Make sure that the domain is deleted from the system.

DOMAIN_NOT_LICENSED

Domain {0} is not licensed.

DOMAIN_NOT_LICENSED.remedy

Make sure to use a domain that has been licensed.

DOMAIN_NOT_SPECIFIED

Atleast one domain must be specified in the input.

DOMAIN_NOT_SPECIFIED.remedy

Specify one or more domains in the input.

RELICENSING_DOMAINS_FAILED

Relicensing of the domains {0} failed.

RELICENSING_DOMAINS_FAILED.remedy

Retry the operation.

EXCESS_LICENSE_KEYS_FOUND

More than one license key found for {0} in the input.

EXCESS_LICENSE_KEYS_FOUND.remedy

Retry with a single or no license key.

DOMAIN_NOT_ACTIVE

Domain(s) {0} not in active state.

DOMAIN_NOT_ACTIVE.remedy

Retry the operation after the domain(s) are in active state.

PRODUCT_TYPE_NOT_SUPPORTED

Product type {0} is not supported.

PRODUCT_TYPE_NOT_SUPPORTED.remedy

1.Make sure you add the license key for only supported product types.

LICENSING_DATA_UNKNOWN_VERSION

Licensing data version {0} not supported.

LICENSING_DATA_UNKNOWN_VERSION.remedy

Please pass the correct version of data.

LICENSING_DATA_HANDLER_NOT_FOUND

Licensing data handler not found for version {0}.

LICENSING_DATA_HANDLER_NOT_FOUND.remedy

Please pass the supported version to get data handler.

FAILED_TO_CONNECT_TO_HOST

Failed to connect to resource {0}

FAILED_TO_CONNECT_TO_HOST.remedy

Please check connection to host {0} with accurate credentials

INVALID_PRODUCT_TYPE

Product type is invalid. Allowable values: {0}

INVALID_PRODUCT_TYPE.remedy

Make sure that the product type is one among {0}

5.1.7. Network pools

Error code Description

SUCCESS

Success

NETWORKPOOL_NOT_FOUND

The network pool with ID {0} does not exist

NETWORK_NOT_FOUND

The network with ID {1} does not exist

NETWORKPOOL_IPADDRESSES_IN_USE

Deletion of network pool {0} prevented. IP Addresses in use

NETWORK_NOT_FOUND_IN_NETWORKPOOL

Specified network {0} not part of networkpool {1}

NETWORKPOOL_SPEC_VALIDATION_FAILED

Error while validating network pool parameters

NETWORKPOOL_CREATE_FAILED

Failed to create the network pool

NETWORKPOOL_GET_FAILED

Failed to get the network pool {0} with id {1}

IPPOOL_ADD_VALIDATION_FAILED

Invalid IP Pool parameters specified or overlapping IP Pool found

IPPOOL_REMOVE_VALIDATION_FAILED

No IP Pool found or IP Pool in use

IPPOOL_ADD_FAILED

Error when adding IP Pool to network

IPPOOL_REMOVE_FAILED

Error removing IP Pool from network

NOT_ENOUGH_IP_ADDRESSES_AVAILABLE

Not enough free IP addresses {2} available in chosen network {0}

IP_ADDRESS_RESERVATION_FAILED

Request to reserve {2} IP addresses not successful

UNUSED_IP_ADDRESSES_LISTED_FOR_RELEASE

Not all IP addresses are in the used IP list for this network

IP_ADDRESS_RELEASE_FAILED

The IP addresses cannot be released

INVALID_IP_COUNT_SPECIFIED

Invalid count: {2} IP addresses requested from chosen network {0}

UNKNOWN_NETWORK_SPECIFIED

Unknown Network Type specified to release IP address

INVALID_NETWORK_SPECIFIED

Invalid Network ID specified

INVENTORY_ERROR

Failed to fetch ESXi hosts associated with network pool {0} from inventory

HOSTS_ASSOCIATED_WITH_NETWORKPOOL

Deletion of network pool {0} prevented. Hosts associated with Network Pool

DUPLICATE_NETWORKPOOL_FOUND

Another networkpool {0} with the same name found

NETWORKPOOL_WITH_OVERLAPPING_NETWORK_FOUND

A network in the pool overlaps with one of the existing networks already present

INTERNAL_SERVER_ERROR

Internal Server Error

MISSING_NETWORK

The networks of type VMOTION is mandatory but was not provided.

MISSING_NETWORKPOOL_NAME

A valid network pool name must be specified

MINIMUM_NETWORKS_MISSING

At least one network should be present in the network pool

MALFORMED_NETWORK_SPEC

Malformed subnet data received

NETWORK_PARAMS_INVALID

One of VLAN ID, Subnet IP address, MTU or IP pools is invalid

DUPLICATE_NETWORKS_IN_NETWORKPOOL

The networkpool {0} has multiple networks of the same type

SUBNET_OVERLAP_IN_NETWORK

Subnet Range Overlap within same VLAN

DELETE_NETWORK_WITH_SINGLE_IPPOOL_FAILED

Ip Pool cannot be removed from a network with a single Ip Pool

DELETE_MISSING_IPPOOL_FAILED

No IP Pool {0} found in the network

DELETE_IPPOOL_IN_USE_FAILED

Ip Addresses are allocated from the IpPool {0}

NETWORKPOOL_WITH_OVERLAPPING_IPPOOLS_FOUND

Overlapping IP Pools found across networkpools

5.1.8. Tasks

Error code Description

TASK_CAN_NOT_BE_RETRIED

Task with ID {0} cannot be retried.

TASK_CAN_NOT_BE_RETRIED.remedy

Make sure the task is in failed state to retry.

5.1.9. Inventory

Error code Description

RESOURCE_VALIDATION_ERRORS

{0} validation failed with errors {1}

RESOURCE_VALIDATION_FAILED

{0} validation failed

RESOURCE_NULL

Null value found in {0}

RESOURCE_ID_NULL

{0} ID is null/empty

RESOURCE_NULL_FIELDS

{0} contains null fields

RESOURCE_NOT_FOUND

{0} not found

RESOURCE_NOT_FOUND_WITH_ID

Resource ID: {1} not found in {0}

RESOURCE_NOT_FOUND_FOR_RESOURCE

{0} not found for {1} {2}

RESOURCE_PROPERTY_NOT_FOUND

{0} {1} property not found

RESOURCE_ALREADY_EXISTS

{0} {1} already exists

RESOURCE_ASSOCIATION_ALREADY_EXISTS

{0} {1} association already exists with {2} {3}

RESOURCE_ASSOCIATION_DOES_NOT_EXIST

{0} {1} association does not exist with {2} {3}

NETWORK_TYPE_NOT_SUPPORTED

Network Type {0} is not supported

ESXI_ATTACHED_TO_CLUSTER

Esxi {1} is attached to Cluster {1}

INVALID_DATA

VCF service ID in request payload not equal to URL parameter

SERVER_ERROR

Server error, contact administrator or check logs

5.1.10. Certificates

Error code Description

CERTIFICATE_RESOURCE_DATA_NOT_FOUND

Resource data not found.

CERTIFICATE_CSR_GENERATION_FAILED

Generate CSR failed.

CERTIFICATE_GET_CSR_FAILED

Unable to get CSR.

CERTIFICATE_GENERATE_CERTIFICATE_FAILED

Generate certificate operation failed.

CERTIFICATE_GET_CERT_FAILED

Unable to get certificate.

CERTIFICATE_CSR_DOWNLOAD_FAILED

CSR download operation failed.

CERTIFICATE_GET_CA_CONFIGURATION_FAILED

Failed to get CA configuration.

CERTIFICATE_CA_CREATION_FAILED

Unable to create CA.

CERTIFICATE_CA_NOT_CONFIGURED

Unable to configure CA settings.

CERTIFICATE_REPLACE_CERT_FAILED

Replace certificate operation failed.

CERTIFICATE_GENERAL_EXCEPTION

{0}

CERTIFICATE_PLUGIN_NOT_FOUND

No plugin found for {0}.

5.1.11. Backup and Restore

Error code Description

RETRIEVE_BACKUP_CONFIGURATION_FAILED

Failed to retrieve backup configuration.

RETRIEVE_BACKUP_CONFIGURATION_FAILED.remedy

Retry after a few minutes.

INVALID_BACKUP_CONFIGURATION

Provided backup configuration is invalid.

BACKUP_FAILED

Backup failed : {0}

RESTORE_FAILED

Restore failed : {0}

INVALID_ENCRYPTION_PASSPHRASE

Provided encryption passphrase {0} is invalid.

INVALID_ENCRYPTION_PASSPHRASE.remedy

Provide a valid encryption passphrase. Criteria for passphrase: min length: 12; max length: 32; min special characters: 1, special characters allowed: [~, !, @, ^, -, _, +]; min numbers: 2; min capital letters: 2; max consecutive characters: 2.

BACKUP_LOCATION_INVALID_PROTOCOL

Backup location protocol is not supported.

BACKUP_LOCATION_PORT_NULL

Backup location port cannot be null.

BACKUP_LOCATION_USERNAME_BLANK

Backup location username cannot be null or blank.

BACKUP_LOCATION_PASSWORD_BLANK

Backup location password cannot be null or blank.

BACKUP_LOCATION_DIRECTORY_PATH_BLANK

Backup location directory path cannot be null or blank.

BACKUP_LOCATION_SERVER_BLANK

Backup location server cannot be null or blank.

BACKUP_SSH_FINGERPRINT_PATH_BLANK

Backup location SSH fingerprint cannot be null or blank.

INVALID_BACKUP_RESOURCE_INPUT

Backup input specification must contain at least one backup resource.

INVALID_BACKUP_RESOURCE

The backup specification contains an invalid backup resource {0}.

INVALID_NUMBER_OF_BACKUP_RESOURCE

Backup input specification cannot have more than one backup resource.

INVALID_ENCRYPTION_PASSPHRASE_INPUT

Backup input specification must contain encryption passphrase.