VMware Cloud Foundation API Reference Guide

VMware Cloud Foundation API Reference Guide

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. AliasSpec

Version Alias update Specification. This specification gets used in the Version Alias Update API.

Name Description Schema

aliases
required

Aliases for bundle component type and version.
Example : [ "string" ]

< string > array

forceUpdate
optional

Flag for force update version alias configuration.
Example : true

boolean

4.5. 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, VCENTER, PSC, NSX_MANAGER, NSX_CONTROLLER, NSX_EDGE, NSXT_MANAGER, NSXT_EDGE, VRLI, VROPS, LCM_REPO, VRA, VRSLCM, DEPOT_USER, VXRAIL_MANAGER, AD, BACKUP"

string

serviceType
required

Service type
Example : "One among: ESXI, VCENTER, PSC, NSX_MANAGER, NSX_CONTROLLER, NSX_EDGE, NSXT_MANAGER, NSXT_EDGE, VRLI, VROPS, LCM_REPO, VRA, VRSLCM, DEPOT_USER, VXRAIL_MANAGER, AD, BACKUP"

string

targetType
required

Target type
Example : "One among: ESXI, VCENTER, PSC, NSX_MANAGER, NSX_CONTROLLER, NSX_EDGE, NSXT_MANAGER, NSXT_EDGE, VRLI, VROPS, LCM_REPO, VRA, VRSLCM, DEPOT_USER, VXRAIL_MANAGER, AD, BACKUP"

string

4.6. Avn

Defines an Application virtual Network (AVN) and its attributes

Name Description Schema

domainName
required

AVN search domain
Example : "sfo01.rainpole.local"

string

gateway
required

Gateway of the AVN subnet
Example : "192.168.31.1"

string

id
optional

The UUID of the AVN
Example : "3f39d4a1-78d2-11e8-af85-f1cf26258cdc"

string

mtu
required

MTU for the AVN
Example : 1500

integer (int32)

name
required

User provided name of the AVN
Example : "vRealize-AVN"

string

portGroupName
required

Port group name identifying the AVN on the distributed switch
Example : "Mgmt-RegionA-PortGroup"

string

regionType
required

The region type of AVN; X_REGION or REGION_A
Example : "REGION_A"

string

routerName
required

Name of routing NSX edge AVN is connected to
Example : "sfo01m01udlr-01"

string

subnet
required

Subnet assigned to the AVN
Example : "192.168.31.0"

string

subnetMask
required

Subnet mask for the network assigned to the AVN
Example : "255.255.255.0"

string

4.7. 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.8. 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.9. 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.10. BackupResource

Element specification to trigger backup

Name Description Schema

resourceType
required

Resource type
Example : "SDDC_MANAGER"

string

4.11. BackupSpec

Backup Specification

Name Description Schema

elements
required

List of elements to be backed up
Example : [ "BackupResource" ]

< BackupResource > array

4.12. 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.13. BaseAlias

Base Alias representation

Name Description Schema

aliases
required

List of Alias versions
Example : [ "string" ]

< string > array

version
required

Base version
Example : "string"

string

4.14. 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.15. BgpNeighbour

NSX Edge BGP Neighbour Specification

Name Description Schema

autonomousSystem
optional

BGP neighbour autonomous system ID
Example : 0

integer (int64)

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.16. BootstrapSpec

Name Description Schema

federationName
optional

Example : "string"

string

memberJoinDetail
optional

Example : MemberDetail

MemberDetail

4.17. 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 : "string"

string

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.18. 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 : "string"

string

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.19. 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 : "string"

string

4.20. BundleUpdateSpec

Bundle Update Specification.

Name Description Schema

bundleDownloadSpec
optional

Bundle Download Specification.
Example : BundleDownloadSpec

BundleDownloadSpec

4.21. 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.22. 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, PB, B, HZ, KHZ, MHZ, THZ)

used
optional

Example : 0.0

number (double)

4.23. 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.24. 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.25. CeipUpdateSpec

Specification for CEIP state change

Name Description Schema

status
required

User provided CEIP operation
Example : "One among: ENABLE, DISABLE"

string

4.26. 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 : "string"

string

notBefore
required

The timestamp before which certificate is not valid
Example : "string"

string

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.27. 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.28. 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.29. 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.30. 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.31. 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.32. 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.33. 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.34. 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.35. 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.36. ClusterReference

Represents a reference to the cluster

Name Description Schema

id
required

ID of the cluster
Example : "string"

string

4.37. 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.38. 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.39. ClusterUnstretchSpec

This spec contains the parameters required to convert a Stretched cluster to a Standard vSAN cluster

4.40. 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.41. 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.42. 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.43. 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)

usedFrequencyMHz
optional

Used CPU frequency in MHz
Example : 0.0

number (double)

4.44. 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.45. 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.46. CredentialsSubTask

Represents the credentials sub-task in the system

Name Description Schema

creationTimestamp
optional

Credential sub-task creation timestamp
Example : "string"

string

credentialType
optional

Credential sub-task credential type
Example : "string"

string

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

entityType
optional

Credential sub-task entity type
Example : "string"

string

errors
optional

List of errors in case of a failure
Example : [ "Error" ]

< Error > array

id
optional

Credential sub-task ID
Example : "string"

string

name
optional

Credential sub-task name
Example : "string"

string

newPassword
optional

Credential sub-task new password
Example : "string"

string

oldPassword
optional

Credential sub-task old password
Example : "string"

string

resourceName
optional

Resource name
Example : "string"

string

status
optional

Credential sub-task status
Example : "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, USER_CANCELLED, INCONSISTENT"

string

username
optional

Credential sub-task username
Example : "string"

string

4.47. CredentialsTask

Represents the credentials task in the system

Name Description Schema

creationTimestamp
optional

Credential task creation timestamp
Example : "string"

string

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.48. 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.49. 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.50. 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.51. 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.52. 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, PB, B, HZ, KHZ, MHZ, THZ)

used
optional

Example : 0.0

number (double)

4.53. 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.54. DateTimeDetail

Name Description Schema

dateTime
optional

Example : "string"

string

timestamp
optional

Example : 0

integer (int64)

4.55. 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.56. DepotSettings

VMware Depot Settings

Name Description Schema

vmwareAccount
required

VMware Depot Account
Example : DepotAccount

DepotAccount

4.57. 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.58. 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.59. 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.60. 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.61. 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.62. 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.63. DomainReference

Represents a domain reference

Name Description Schema

id
required

ID of the domain
Example : "string"

string

4.64. DomainSummary

Name Description Schema

aggregatedCapacity
optional

Example : ResourceCapacity

ResourceCapacity

domainCount
optional

Example : 0

integer (int32)

type
optional

Example : "string"

string

4.65. DomainUpdateSpec

Contains the parameters required to perform update operation on domain

Name Description Schema

markForDeletion
optional

Enable deletion of domain
Example : true

boolean

4.66. 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.67. 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.68. Encryption

Restore Specification

Name Description Schema

passphrase
required

Passphrase
Example : "string"

string

4.69. 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.70. 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.71. ErrorCause

Name Description Schema

message
optional

Example : "string"

string

type
optional

Example : "string"

string

4.72. 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.73. FcSpec

Cluster storage configuration for VMFS on FC

Name Description Schema

datastoreName
required

Datastore name used for cluster creation
Example : "string"

string

4.74. FederationOperationError

Name Description Schema

error
optional

Example : "string"

string

errorPack
optional

Example : LocalizableErrorCodePack

LocalizableErrorCodePack

suggestedRemedy
optional

Example : "string"

string

suggestedRemedyPack
optional

Example : LocalizableErrorCodePack

LocalizableErrorCodePack

4.75. 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.76. HighAvailability

This specification contains high availability settings

Name Description Schema

enabled
required

Example : true

boolean

4.77. 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.78. 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.79. 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.80. 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.81. 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.82. 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.83. 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.84. 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.85. 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.86. 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.87. 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.88. 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.89. 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.90. 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.91. 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.92. 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.93. 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.94. 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.95. 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.96. 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.97. 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.98. 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.99. HorizonPsc

PSC details required for Horizon deployment.

Name Description Schema

host
required

PSC hostname or IP
Example : "string"

string

4.100. 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.101. 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.102. 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.103. 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.104. 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.105. 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.106. 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.107. 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.108. 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.109. Host

Represents an Esxi host in the system

Name Description Schema

bundleRepoDatastore
optional

Bundle repositry datastore for this host
Example : "string"

string

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

hybrid
optional

Information about the storage type of the host, true if the host is hybrid.
Example : true

boolean

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.110. 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.111. HostCount

Name Description Schema

total
optional

Example : 0

integer (int32)

unallocated
optional

Example : 0

integer (int32)

used
optional

Example : 0

integer (int32)

4.112. HostCriterion

Represents a criterion for querying the host

Name Description Schema

arguments
optional

Arguments required for a particular criterion
Example : {
"string" : "string"
}

< string, string > map

description
optional

Description of the criterion
Example : "string"

string

name
optional

Name of the criterion
Example : "One among: HOST_COMPATIBLE_WITH_CLUSTER_USING_PNICS"

string

4.113. 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.114. 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.115. HostQueryResponse

Represents a host query response.

Name Description Schema

queryInfo
optional

Query info
Example : QueryInfo

QueryInfo

result
optional

Query result
Example : PageOfHost

PageOfHost

4.116. HostReference

Represents an ESXi host reference

Name Description Schema

id
required

ID of the host
Example : "string"

string

4.117. 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.118. 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.119. 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.120. InventoryInfo

Name Description Schema

hostCount
optional

Example : HostCount

HostCount

4.121. 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.122. 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.123. 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.124. 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.125. 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.126. 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 : "XX0XX-XX0XX-XX0XX-XX0XX-XX0XX"

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.127. 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.128. LicenseKeyValidity

Defines license key validity details

Name Description Schema

expiryDate
optional

The license key expiry date
Example : "string"

string

licenseKeyStatus
optional

The validity status of the license key
Example : "One among: EXPIRED, ACTIVE, NEVER_EXPIRES"

string

4.129. LocalizableErrorCodePack

Name Description Schema

arguments
optional

Example : [ "object" ]

< object > array

component
optional

Example : "string"

string

defaultMessage
optional

Example : "string"

string

localBundle
optional

Example : "string"

string

messageKey
optional

Example : "string"

string

4.130. MapOfstringAndSddcCredentials

Type : < string, SddcCredentials > map

4.131. MapOfstringAndstring

Type : < string, string > map

4.132. MemberCapacityInfo

Name Description Schema

summary
optional

Example : CapacitySummary

CapacitySummary

4.133. 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.134. 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.135. MemberHealth

Name Description Schema

healthCode
optional

Example : "GREEN"

enum (GREEN, YELLOW, RED)

healthDetails
optional

Example : [ "string" ]

< string > array

4.136. 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.137. MemberInventory

Name Description Schema

capacity
optional

Example : MemberCapacityInfo

MemberCapacityInfo

creationTime
optional

Example : "string"

string

inventoryInfo
optional

Example : InventoryInfo

InventoryInfo

softwareInfo
optional

Example : MemberSoftwareInfo

MemberSoftwareInfo

4.138. 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.139. MemberLiveliness

Name Description Schema

livelinessCode
optional

Example : "GREEN"

enum (GREEN, YELLOW, RED)

livelinessDetails
optional

Example : [ "string" ]

< string > array

4.140. MemberSoftwareInfo

Name Description Schema

pendingUpdates
optional

Example : 0

integer (int32)

4.141. 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.142. 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.143. Memory

Represents information about memory on a host

Name Description Schema

totalCapacityMB
optional

Total memory in MB
Example : 0.0

number (double)

usedCapacityMB
optional

Used memory in MB
Example : 0.0

number (double)

4.144. 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.145. MessageBusServerInfoList

Name Description Schema

messageBusServersInfo
optional

Example : [ "MessageBusServerInfo" ]

< MessageBusServerInfo > array

4.146. 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.147. 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.148. 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.149. 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.150. 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.151. 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.152. NetworkPoolReference

Represents a network pool reference

Name Description Schema

id
required

ID of the network pool
Example : "string"

string

name
optional

Name of the network pool
Example : "string"

string

4.153. 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.154. 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.155. 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.156. 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.157. NiocTrafficResourceAllocation

Specify network traffic for a resource

Name Description Schema

limit
required

Example : 0

integer (int64)

reservation
required

Example : 0

integer (int64)

4.158. 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 (int64)

nsxEdgeBgpSpecs
required

NSX Edge BGP specifications
Example : [ "NsxEdgeBgpSpec" ]

< NsxEdgeBgpSpec > array

skipBgpValidation
optional

Whether to skip the validation of BGP routing
Example : true

boolean

4.159. 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.160. 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.161. 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.162. 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.163. 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.164. 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.165. 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.166. 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.167. 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.168. 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.169. 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.170. 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.171. 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.172. 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.173. 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.174. 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.175. 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.176. 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.177. 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.178. NsxtEdgeCluster

NSX-T Edge Cluster Upgrade Resource

Name Description Schema

id
optional

Edge cluster ID
Example : "string"

string

name
optional

Edge cluster name
Example : "string"

string

resourceHealth
optional

Current resource health status
Example : "string"

string

upgradeStatus
optional

Upgrade status with respect to the bundle
Example : "string"

string

version
optional

The current version of the edge cluster.If a partial upgrade is done, this will be the least version among the edges in the edge cluster
Example : "string"

string

4.179. NsxtEdgeClusterUpgradeSpec

NSX-T Edge cluster upgrade input

Name Description Schema

edgeClusterId
required

Resource ID of the edge transport node cluster
Example : "string"

string

edgeParallelUpgrade
optional

disable/enable parallel upgrade of edges within the cluster
Example : true

boolean

4.180. NsxtHostCluster

NSX-T Host Cluster Upgrade Resource

Name Description Schema

domainId
optional

ID of the domain the transport node cluster belongs to
Example : "string"

string

id
optional

NSX-T host cluster ID
Example : "string"

string

name
optional

Cluster name
Example : "string"

string

resourceHealth
optional

Current resource health status
Example : "string"

string

totalUnits
optional

Total number of hosts in the transport node cluster
Example : 0

integer (int32)

upgradeStatus
optional

Upgrade status with respect to the bundle
Example : "string"

string

upgradedUnits
optional

Number of hosts which are already upgraded
Example : 0

integer (int32)

version
optional

The current version of the transport node cluster.If a partial upgrade is done, this will be the least version among the hosts
Example : "string"

string

4.181. NsxtHostClusterUpgradeSpec

NSX-T Host transport node cluster upgrade input

Name Description Schema

hostClusterId
required

Resource ID of the host transport node cluster
Example : "string"

string

hostParallelUpgrade
optional

Flag for disabling/enabling parallel upgrade within the cluster
Example : true

boolean

liveUpgrade
optional

Flag for disabling/enabling live upgrade of hosts in the transport node clusters
Example : true

boolean

4.182. NsxtManagerCluster

NSX-T Manager Cluster Upgrade Resource

Name Description Schema

id
optional

NSX-T manager cluster ID
Example : "string"

string

name
optional

NSX-T manager cluster name
Example : "string"

string

resourceHealth
optional

Current resource health status
Example : "string"

string

upgradeStatus
optional

Upgrade status with respect to the bundle
Example : "string"

string

version
optional

The current version of the manager cluster.If a partial upgrade is done, this will be the least version among the managers in the manager cluster
Example : "string"

string

4.183. NsxtResources

NSX-T Upgrade Resources

Name Description Schema

bundleId
optional

Bundle ID used to compute the upgradability
Example : "string"

string

domainId
optional

Domain ID associated with the NSX-T cluster
Example : "string"

string

nsxtEdgeClusters
optional

List of edge transport node clusters that are candidates for upgrade
Example : [ "NsxtEdgeCluster" ]

< NsxtEdgeCluster > array

nsxtHostClusters
optional

List of host transport node clusters that are candidates for upgrade
Example : [ "NsxtHostCluster" ]

< NsxtHostCluster > array

nsxtManagerCluster
optional

Manager cluster that is a candidate for upgrade
Example : NsxtManagerCluster

NsxtManagerCluster

nsxtUpgradeCoordinator
optional

Upgrade coordinator pertaining to the NSX-T instance
Example : NsxtUpgradeCoordinator

NsxtUpgradeCoordinator

4.184. NsxtUpgradeCoordinator

NSX-T Upgrade coordinator Upgrade Resource

Name Description Schema

enabledOn
optional

The IP of the manager on which UC is enabled
Example : "string"

string

id
optional

upgrade coordinator ID
Example : "string"

string

resourceHealth
optional

Current resource health status
Example : "string"

string

upgradeStatus
optional

Upgrade status with respect to the bundle
Example : "string"

string

version
optional

The current version of the UC
Example : "string"

string

4.185. NsxtUpgradeOptions

NSX-T Upgrade options

Name Description Schema

isEdgeClustersUpgradeParallel
optional

Flag for disabling/enabling parallel upgrade of edge transport node clusters
Example : true

boolean

isEdgeOnlyUpgrade
optional

Flag for performing edge-only upgrade
Example : true

boolean

isHostClustersUpgradeParallel
optional

Flag for disabling/enabling parallel upgrade of host transport node clusters
Example : true

boolean

4.186. NsxtUpgradeUserInputSpec

NSX-T Upgrade User Input Specification

Name Description Schema

nsxtEdgeClusterUpgradeSpecs
optional

List of edge clusters information if explicit selection is to be made
Example : [ "NsxtEdgeClusterUpgradeSpec" ]

< NsxtEdgeClusterUpgradeSpec > array

nsxtHostClusterUpgradeSpecs
optional

List of host clusters information if explicit selection is to be made
Example : [ "NsxtHostClusterUpgradeSpec" ]

< NsxtHostClusterUpgradeSpec > array

nsxtId
optional

Identifier of the NSX-T instance
Example : "string"

string

nsxtUpgradeOptions
optional

NSX-T Upgrade options
Example : NsxtUpgradeOptions

NsxtUpgradeOptions

4.187. 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.188. 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

pageMetadata
optional

Pageable elements pagination metadata information
Example : PageMetadata

PageMetadata

4.189. PageMetadata

Represents pageable elements pagination metadata

Name Description Schema

pageNumber
optional

Returns the current page number
Example : 0

integer (int32)

pageSize
optional

Returns the number of elements in the current page
Example : 0

integer (int32)

totalElements
optional

Returns the total number of elements
Example : 0

integer (int32)

totalPages
optional

Returns the total number of pages
Example : 0

integer (int32)

4.190. 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

pageMetadata
optional

Pageable elements pagination metadata information
Example : PageMetadata

PageMetadata

4.191. 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

pageMetadata
optional

Pageable elements pagination metadata information
Example : PageMetadata

PageMetadata

4.192. 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

pageMetadata
optional

Pageable elements pagination metadata information
Example : PageMetadata

PageMetadata

4.193. 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

pageMetadata
optional

Pageable elements pagination metadata information
Example : PageMetadata

PageMetadata

4.194. 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

pageMetadata
optional

Pageable elements pagination metadata information
Example : PageMetadata

PageMetadata

4.195. 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

pageMetadata
optional

Pageable elements pagination metadata information
Example : PageMetadata

PageMetadata

4.196. 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

pageMetadata
optional

Pageable elements pagination metadata information
Example : PageMetadata

PageMetadata

4.197. 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

pageMetadata
optional

Pageable elements pagination metadata information
Example : PageMetadata

PageMetadata

4.198. 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

pageMetadata
optional

Pageable elements pagination metadata information
Example : PageMetadata

PageMetadata

4.199. 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

pageMetadata
optional

Pageable elements pagination metadata information
Example : PageMetadata

PageMetadata

4.200. 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

pageMetadata
optional

Pageable elements pagination metadata information
Example : PageMetadata

PageMetadata

4.201. 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

pageMetadata
optional

Pageable elements pagination metadata information
Example : PageMetadata

PageMetadata

4.202. PageOfHostCriterion

Represents a page of elements of a single type

Name Description Schema

elements
optional

The list of elements included in this page
Example : [ "HostCriterion" ]

< HostCriterion > array

pageMetadata
optional

Pageable elements pagination metadata information
Example : PageMetadata

PageMetadata

4.203. 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

pageMetadata
optional

Pageable elements pagination metadata information
Example : PageMetadata

PageMetadata

4.204. 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

pageMetadata
optional

Pageable elements pagination metadata information
Example : PageMetadata

PageMetadata

4.205. 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

pageMetadata
optional

Pageable elements pagination metadata information
Example : PageMetadata

PageMetadata

4.206. 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

pageMetadata
optional

Pageable elements pagination metadata information
Example : PageMetadata

PageMetadata

4.207. 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

pageMetadata
optional

Pageable elements pagination metadata information
Example : PageMetadata

PageMetadata

4.208. 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

pageMetadata
optional

Pageable elements pagination metadata information
Example : PageMetadata

PageMetadata

4.209. 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

pageMetadata
optional

Pageable elements pagination metadata information
Example : PageMetadata

PageMetadata

4.210. 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

pageMetadata
optional

Pageable elements pagination metadata information
Example : PageMetadata

PageMetadata

4.211. 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

pageMetadata
optional

Pageable elements pagination metadata information
Example : PageMetadata

PageMetadata

4.212. 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

pageMetadata
optional

Pageable elements pagination metadata information
Example : PageMetadata

PageMetadata

4.213. 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

pageMetadata
optional

Pageable elements pagination metadata information
Example : PageMetadata

PageMetadata

4.214. PageOfUpgrade

Represents a page of elements of a single type

Name Description Schema

elements
optional

The list of elements included in this page
Example : [ "Upgrade" ]

< Upgrade > array

pageMetadata
optional

Pageable elements pagination metadata information
Example : PageMetadata

PageMetadata

4.215. 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

pageMetadata
optional

Pageable elements pagination metadata information
Example : PageMetadata

PageMetadata

4.216. 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

pageMetadata
optional

Pageable elements pagination metadata information
Example : PageMetadata

PageMetadata

4.217. 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

pageMetadata
optional

Pageable elements pagination metadata information
Example : PageMetadata

PageMetadata

4.218. PageOfVersionAliasesForBundleComponentType

Represents a page of elements of a single type

Name Description Schema

elements
optional

The list of elements included in this page
Example : [ "VersionAliasesForBundleComponentType" ]

< VersionAliasesForBundleComponentType > array

pageMetadata
optional

Pageable elements pagination metadata information
Example : PageMetadata

PageMetadata

4.219. 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

pageMetadata
optional

Pageable elements pagination metadata information
Example : PageMetadata

PageMetadata

4.220. 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

pageMetadata
optional

Pageable elements pagination metadata information
Example : PageMetadata

PageMetadata

4.221. 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

pageMetadata
optional

Pageable elements pagination metadata information
Example : PageMetadata

PageMetadata

4.222. 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

pageMetadata
optional

Pageable elements pagination metadata information
Example : PageMetadata

PageMetadata

4.223. 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.224. 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.225. 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.226. 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.227. 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.228. 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.229. 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.230. 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.231. 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.232. 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.233. PksRsaCertificate

PKS certificate resource

Name Description Schema

privateKey
required

Private key
Example : "string"

string

publicCert
required

Public certificate
Example : "string"

string

4.234. 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.235. 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.236. PksUpdateSpec

PKS update specification

Name Description Schema

markForDeletion
required

Prepare Solution PKS for deletion
Example : true

boolean

4.237. 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.238. 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.239. 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.240. PositionCoordinate

Name Description Schema

latitude
optional

Example : 0.0

number (double)

longitude
optional

Example : 0.0

number (double)

4.241. PrecheckSpec

Precheck Specification. This specification gets used in the Precheck API

Name Description Schema

bundleId
optional

If specified, indicate the bundle applicability in the result
Example : "string"

string

resources
required

List of resources for Precheck supported type DOMAIN, CLUSTER
Example : [ "Resource" ]

< Resource > array

4.242. 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.243. 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.244. 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.245. QueryInfo

Represents the query info.

Name Description Schema

completed
optional

Example : true

boolean

failure
optional

Example : true

boolean

processing
optional

Example : true

boolean

status
optional

Status of the query
Example : "string"

string

4.246. 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.247. 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.248. 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.249. 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.250. 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.251. 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, VCENTER, PSC, NSX_MANAGER, NSX_CONTROLLER, NSX_EDGE, NSXT_MANAGER, NSXT_EDGE, VRLI, VROPS, LCM_REPO, VRA, VRSLCM, DEPOT_USER, VXRAIL_MANAGER, AD, BACKUP"

string

4.252. 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.253. ResourceUpgradeSpec

Resource Upgrade Specification

Name Description Schema

resourceId
required

Resource ID for Upgrade
Example : "string"

string

scheduledTimestamp
optional

Upgrade Scheduled Time
Example : "string"

string

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.254. 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.255. SchemaRegistryServerInfo

Name Description Schema

hostAddress
optional

Example : "string"

string

port
optional

Example : 0

integer (int32)

protocol
optional

Example : "string"

string

4.256. SchemaRegistryServerInfoList

Name Description Schema

schemaRegistryServersInfo
optional

Example : [ "SchemaRegistryServerInfo" ]

< SchemaRegistryServerInfo > array

4.257. 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.258. SddcCredentials

Credentials contains the username and password

Name Description Schema

password
required

Password
Example : "Admin!23"

string

username
required

Username
Example : "root"

string

4.259. 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.260. 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.261. 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.262. 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.263. 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.264. 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.265. SddcSubTask

Represents a SDDC sub-task

Name Description Schema

creationTimestamp
optional

Sub-Task Creation Time
Example : "string"

string

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 : "string"

string

4.266. SddcTask

Represents a SDDC task

Name Description Schema

creationTimestamp
optional

SDDC Task creation timestamp
Example : "string"

string

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.267. 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.268. 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.269. 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.270. 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.271. 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.272. 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.273. 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.274. 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.275. 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.276. 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.277. 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.278. 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.279. Stage

Represents a Stage

Name Description Schema

completionTimestamp
optional

Example : "string"

string

creationTimestamp
optional

Example : "string"

string

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.280. 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)

usedCapacityMB
optional

Used storage capacity in MB
Example : 0.0

number (double)

4.281. SubTask

Represents a sub-task

Name Description Schema

completionTimestamp
optional

Sub-task completion timestamp
Example : "string"

string

creationTimestamp
optional

Sub-task creation timestamp
Example : "string"

string

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.282. Task

Represents a task

Name Description Schema

completionTimestamp
optional

Task completion timestamp
Example : "string"

string

creationTimestamp
optional

Task creation timestamp
Example : "string"

string

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

resolutionStatus
optional

Resolution state
Example : "Can have only one of the two values: RESOLVED or UNRESOLVED"

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.283. 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.284. 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.285. Upgrade

Upgrade object which contain details regarding the upgrade

Name Description Schema

bundleId
required

Bundle ID for Upgrade
Example : "string"

string

id
required

ID for Upgrade
Example : "string"

string

nsxtUpgradeUserInputSpec
optional

Resource Upgrade Specification for NSX-T upgrade
Example : NsxtUpgradeUserInputSpec

NsxtUpgradeUserInputSpec

parallelUpgrade
optional

Boolean to represent components will be upgraded in parallel on not
Example : true

boolean

resourceType
required

Resource Type for Upgrade
Example : "One among: DOMAIN, CLUSTER, UNASSIGNED_HOST"

string

resourceUpgradeSpecs
required

Resource Upgrade Specifications
Example : [ "ResourceUpgradeSpec" ]

< ResourceUpgradeSpec > array

status
required

Overall upgrade status
Example : "string"

string

taskId
required

Task ID associated with upgrade
Example : "string"

string

4.286. UpgradeSpec

Upgrade Specification

Name Description Schema

bundleId
required

Bundle ID for Upgrade
Example : "string"

string

nsxtUpgradeUserInputSpecs
optional

Resource Upgrade Specifications for NSX-T upgrade
Example : [ "NsxtUpgradeUserInputSpec" ]

< NsxtUpgradeUserInputSpec > array

parallelUpgrade
optional

Boolean to represent components will be upgraded in parallel on not
Example : true

boolean

resourceType
required

Resource Type for Upgrade
Example : "One among: DOMAIN, CLUSTER, UNASSIGNED_HOST"

string

resourceUpgradeSpecs
required

Resource Upgrade Specifications
Example : [ "ResourceUpgradeSpec" ]

< ResourceUpgradeSpec > array

4.287. 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.288. 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.289. 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.290. 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.291. 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.292. 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.293. 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.294. VersionAliasesForBundleComponentType

Version Alias representation

Name Description Schema

bundleComponentType
required

Bundle Component Type
Example : "One among: VCENTER, PSC, NSX_T_MANAGER, NSX_MANAGER, ESX_HOST, VCF_VRA_UPGRADE, VCF_VRLI_UPGRADE, VCF_VROPS_UPGRADE, VCF_VRSLCM_UPGRADE, SDDC_MANAGER_VCF, LCM, SDDC_MANAGER, SDDC_MANAGER_UI, OPERATIONS_MANAGER, COMMON_SERVICES, SOLUTIONS_MANAGER, MULTI_SITE_SERVICE, "

string

versionAliases
required

Version Aliases
Example : [ "BaseAlias" ]

< BaseAlias > array

4.295. VersionAliasesForBundleComponentTypeSpec

Version Alias update Specification. This specification gets used in the Version Alias Update API.

Name Description Schema

forceUpdate
optional

Flag for force update version alias configuration.
Example : true

boolean

versionAliasesForBundleComponentTypes
required

List of version aliases for bundle component types.
Example : [ "VersionAliasesForBundleComponentType" ]

< VersionAliasesForBundleComponentType > array

4.296. 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

moveToNvds
optional

This flag determines if the vmnic must be on N-VDS
Example : true

boolean

vdsName
optional

VDS name to associate with vSphere host
Example : "string"

string

4.297. VmfsDatastoreSpec

Cluster storage configuration for VMFS

Name Description Schema

fcSpec
optional

Cluster storage configuration for VMFS on FC
Example : [ "FcSpec" ]

< FcSpec > array

4.298. 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.299. 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.300. 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.301. 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.302. 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.303. VrealizeEnvironment

vRealize product environment

Name Description Schema

environment
required

vRealize Environment
Example : "string"

string

product
required

vRealize Product
Example : "string"

string

4.304. 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.305. 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.306. 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.307. 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.308. 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.309. 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.310. 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.311. 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.312. 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.313. 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
optional

Deprecated: 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.314. 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.315. 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.316. 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.317. 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.318. 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.319. 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.320. 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.321. 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.322. ZookeeperServerInfoList

Name Description Schema

zookeeperServersInfo
optional

Example : [ "ZookeeperServerInfo" ]

< ZookeeperServerInfo > array