VMware Cloud Foundation on Dell EMC VxRail API Reference Guide

VMware Cloud Foundation on Dell EMC VxRail API Reference Guide

4. Definitions

4.1. AddOnInfo

AddOn contains bits to install/update the appropriate Cloud Foundation software components in your management domain or workload domain.

Name Description Schema

displayName
optional

Add On display name
Example : "string"

string

displayVersion
optional

Add On display version
Example : "string"

string

name
required

Component name
Example : "DELL-sample-Addon"

string

vendor
required

vendor
Example : "Dell"

string

version
required

Add on software version
Example : "2.0-1"

string

4.2. 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, INTEL_CASCADELAKE, 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.3. 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.4. AuthenticatedResource

Represents the credential resource in the system

Name Description Schema

domainName
required

Domain name
Example : "string"

string

resourceId
required

Resource ID
Example : "string"

string

resourceIp
required

Resource IP address
Example : "string"

string

resourceName
required

Resource name
Example : "string"

string

resourceType
required

Resource type
Example : "One among: ESXI, VCENTER, PSC, NSX_MANAGER, NSX_CONTROLLER, NSX_EDGE, NSXT_MANAGER, NSXT_EDGE, VRLI, VROPS, VRA, WSA, VRSLCM, VXRAIL_MANAGER, BACKUP"

string

4.5. AutoRotateCredentialPolicy

Represents a auto-rotate policy for a credential

Name Description Schema

frequencyInDays
optional

Frequency in days
Example : 0

integer (int32)

nextSchedule
required

The timestamp at which auto-rotate for credential will run
Example : "string"

string

4.6. AutoRotateCredentialPolicyInputSpec

Represents password auto rotate config details

Name Description Schema

enableAutoRotatePolicy
optional

Enable or disable auto rotate policy
Example : true

boolean

frequencyInDays
optional

Frequency in days
Example : 0

integer (int32)

4.7. Avn

Defines an Application virtual Network (AVN) and its attributes

Name Description Schema

domainName
optional

AVN search domain
Example : "rainpole.io"

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 : 1600

integer (int32)

name
required

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

string

portGroupName
optional

Port group name identifying the AVN on the distributed switch
Example : "sfo-m01-seg01-pg"

string

regionType
required

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

string

routerName
optional

Name of Tier-1 Gateway AVN is connected to
Example : "sfo-m01-ec01-t1-gw01"

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

vlanId
optional

VLAN ID for the VLAN backed AVN
Example : 30

integer (int32)

4.8. AvnsCreationSpec

Defines the spec to create Application virtual Networks (AVNs) and its attributes

Name Description Schema

avns
required

The list of AVNs to be created
Example : [ "Avn" ]

< Avn > array

edgeClusterId
required

The UUID of the Edge Cluster to associate AVNs
Example : "3f39d4a1-78d2-11e8-af85-f1cf26258cdc"

string

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

backupSchedules
optional

List of backup schedules
Example : [ "BackupSchedule" ]

< BackupSchedule > 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.10. BackupConfigurationSpec

Backup configuration Specification

Name Description Schema

backupLocations
optional

List of backup locations
Example : [ "BackupLocation" ]

< BackupLocation > array

backupSchedules
optional

List of backup schedules
Example : [ "BackupSchedule" ]

< BackupSchedule > array

encryption
optional

Encryption passphrase to encrypt and decrypt backup file
Example : Encryption

Encryption

4.11. 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 or FQDN 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.12. BackupResource

Element specification to trigger backup

Name Description Schema

resourceType
required

Resource type
Example : "SDDC_MANAGER"

string

4.13. BackupRetentionPolicy

Backup retention policy for SDDC Manager comprising three attributes. Backup files are deleted if they do not satisfy any of the three attributes.

Name Description Schema

numberOfDaysOfDailyBackups
optional

This attribute controls the number of daily backup files to retain, measured in days. Range 0 to 30 days. The system will filter the existing backup files, and retain one for every day for the specified number of days, counting back from the most recent backup.
Example : 20

integer (int32)

numberOfDaysOfHourlyBackups
optional

This attribute controls the number of hourly backup files to retain, measured in days. Range 0 to 14 days. The system will filter the existing backup files, and retain one for every hour for the specified number of days, counting back from the most recent backup.
Example : 10

integer (int32)

numberOfMostRecentBackups
required

This attribute controls the number of recent backup files to retain. Range 1 to 600 backup files.
Example : 15

integer (int32)

4.14. BackupSchedule

Backup schedule configuration

Name Description Schema

daysOfWeek
optional

List of days of the week to schedule backup
Example : "One among: SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY"

< string > array

frequency
required

Backup frequency
Example : "One among: WEEKLY, HOURLY"

string

hourOfDay
optional

Hour of the day to schedule backup
Example : 0

integer (int32)

minuteOfHour
optional

Minute of the hour to schedule backup
Example : 0

integer (int32)

resourceType
required

Resource type to configure backup schedule
Example : "SDDC_MANAGER"

string

retentionPolicy
optional

Backup retention policy
Example : BackupRetentionPolicy

BackupRetentionPolicy

takeBackupOnStateChange
optional

Enable/disable backups on state change. If enabled, SDDC Manager will take a backup after the successful completion of an operation that changes its state. This mode requires that scheduled backups be enabled.
Example : true

boolean

takeScheduledBackups
optional

Enable/disable scheduled backups
Example : true

boolean

4.15. BackupSpec

Backup Specification

Name Description Schema

elements
required

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

< BackupResource > array

4.16. 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.17. 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.18. BaseCredential

Represents credentials of a resource in the system

Name Description Schema

accountType
optional

Account type
Example : "One among: USER, SYSTEM, SERVICE"

string

credentialType
optional

Credential type
Example : "One among: SSO, SSH, API, FTP, AUDIT"

string

password
optional

Password
Example : "string"

string

username
required

Username
Example : "string"

string

4.19. BaseImageDetails

BaseImage contains bits to install/update the appropriate Cloud Foundation software components in your management domain or workload domain.

Name Description Schema

displayName
required

BaseImage display name
Example : "7.0.0-0.0.30340198"

string

displayVersion
required

BaseImage display version
Example : "string"

string

releaseDate
optional

BaseImage release date
Example : Calendar

Calendar

4.20. BaseImageInfo

BaseImage contains bits to install/update the appropriate Cloud Foundation software components in your management domain or workload domain.

Name Description Schema

details
optional

BaseImage details
Example : BaseImageDetails

BaseImageDetails

version
required

BaseImage Version
Example : "7.0.0-0.0.30340198"

string

4.21. BasicAuthDetails

Basic auth details

Name Description Schema

status
required

Basic auth status
Example : "One among: ENABLED, DISABLED"

string

username
optional

Basic auth username
Example : "string"

string

4.22. BgpNeighbour

NSX Edge BGP Neighbour Specification. Deprecated as of 4.3, Bringup AVN has been deprecated. Instead use DAY-N AVN workflow.

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.23. BgpPeerSpec

This specification contains configuration inputs required for BGP configuration for an uplink

Name Description Schema

asn
required

ASN of Peer
Example : 0

integer (int64)

ip
required

BGP Peer IP
Example : "string"

string

password
required

BGP Peer Password
Example : "string"

string

4.24. BootstrapSpec

Name Description Schema

federationName
optional

Example : "string"

string

memberJoinDetail
optional

Example : MemberDetail

MemberDetail

4.25. 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, RECALLED"

string

id
optional

Bundle ID
Example : "string"

string

isCompliant
optional

Is compliant with the current VCF version
Example : true

boolean

isCumulative
optional

Is Bundle Cumulative
Example : true

boolean

releasedDate
optional

Bundle Release Date
Example : "string"

string

severity
optional

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.26. 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.27. 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.28. BundleRecall

Bundle Recall model for collection of bundles that are recalled with their replacements if applicable.

Name Description Schema

recalledBundleIds
required

List of Bundle IDs that are recalled
Example : [ "string" ]

< string > array

replacementBundleIds
optional

List of Bundle IDs that act as replacement
Example : [ "string" ]

< string > array

replacementBundleStatus
required

Status of bundle replacement.
Example : "One among: NONE, PENDING, READY"

string

4.29. BundleUpdateSpec

Bundle Update Specification.

Name Description Schema

bundleDownloadSpec
optional

Bundle Download Specification.
Example : BundleDownloadSpec

BundleDownloadSpec

compatibilitySetsFilePath
optional

Path to the software compatibility sets file
Example : "string"

string

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

compatibilitySetsFilePath
optional

Path to the software compatibility sets file
Example : "string"

string

manifestFilePath
required

Bundle Upload Manifest File Path
Example : "string"

string

partnerExtensionSpec
optional

Partner extensions for bundle upload
Example : PartnerExtensionSpec

PartnerExtensionSpec

signatureFilePath
optional

Bundle Upload Signature File Path
Example : "string"

string

4.31. CPU

Name Description Schema

free
optional

Example : 0.0

number (double)

total
optional

Example : 0.0

number (double)

unallocated
optional

Example : 0.0

number (double)

unit
optional

Example : "GHZ"

enum (GHZ, GB, TB, HZ, KHZ, MHZ, THZ, B, PB)

used
optional

Example : 0.0

number (double)

4.32. Calendar

Name Description Schema

calendarType
optional

Example : "string"

string

firstDayOfWeek
optional

Example : 0

integer (int32)

lenient
optional

Example : true

boolean

minimalDaysInFirstWeek
optional

Example : 0

integer (int32)

time
optional

Example : "1970-01-01T00:00:00Z"

string (date-time)

timeInMillis
optional

Example : 0

integer (int64)

timeZone
optional

Example : TimeZone

TimeZone

weekDateSupported
optional

Example : true

boolean

weekYear
optional

Example : 0

integer (int32)

weeksInWeekYear
optional

Example : 0

integer (int32)

4.33. Capacity

Represents a usage and capacity information of a Resource

Name Description Schema

cpu
optional

Cpu metrics of the resource
Example : CpuInfo

CpuInfo

memory
optional

Memory metrics of the resource
Example : MemoryInfo

MemoryInfo

storage
optional

Storage metrics of the resource
Example : StorageInfo

StorageInfo

4.34. 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.35. 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.36. CeipUpdateSpec

Specification for CEIP state change

Name Description Schema

status
required

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

string

4.37. 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.38. 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.39. 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.40. 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.41. 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.42. ClassLoader

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

isDefault
optional

Status of the cluster if default or not
Example : true

boolean

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, VVOL_FC, VVOL_ISCSI, VVOL_NFS"

string

vdsSpecs
optional

Distributed switches to added to the cluster
Example : [ "VdsSpec" ]

< VdsSpec > array

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

forceByPassingSafeMinSize
optional

Remove dead hosts from cluster, bypassing validations. Forced removal may result in permanent data loss. Review recovery plan with VMware Support before using.
Example : true

boolean

hosts
optional

List of vSphere hosts to be removed
Example : [ "HostReference" ]

< HostReference > array

4.45. ClusterCreationSpec

This specification 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.46. ClusterCriterion

Represents a criterion for querying the cluster

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: UNMANAGED_CLUSTERS_IN_VCENTER, UNMANAGED_CLUSTER_IN_VCENTER"

string

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

forceHostAdditionInPresenceofDeadHosts
optional

Use to add host to a cluster with dead host(s). Bypasses validation of disconnected hosts and vSAN cluster health. Review recovery plan VMware Support before using. False if omitted. This property is deprecated and it has no effect when using it.
Example : true

boolean

hostSpecs
required

List of vSphere host information from the free pool to consume in the workload domain
Example : [ "HostSpec" ]

< HostSpec > array

interRackExpansion
optional

Is inter-rack cluster(true for L2 non-uniform and L3 : At least one of management, uplink, Edge and host TEP networks is different for hosts of the cluster, false for L2 uniform : All hosts in cluster have identical management, uplink, Edge and host TEP networks) expansion. Required, only if Cluster contains NSX-T Edge Cluster
Example : true

boolean

skipThumbprintValidation
optional

Skip thumbprint validation for ESXi hosts during add host operation
Example : true

boolean

vsanNetworkSpecs
optional

vSAN Network Pool Spec
Example : [ "VSANNetworkSpec" ]

< VSANNetworkSpec > array

witnessSpec
optional

Witness host Info
Example : WitnessSpec

WitnessSpec

witnessTrafficSharedWithVsanTraffic
optional

Witness traffic to be shared with vSAN traffic
Example : true

boolean

4.48. ClusterProductSpec

Spec contains information for a vRealize product

Name Description Schema

adminCredentials
required

The credentials of the vRealize product Admin
Example : CredentialsSpec

CredentialsSpec

certificateChain
optional

The certificate chain of the vRealize product.
Example : "string"

string

id
optional

The ID of the product
Example : "string"

string

loadBalancerFqdn
required

Fully Qualified Domain Name for the vRealize product load balancer
Example : "string"

string

nodes
required

The nodes of the vRealize product instance
Example : [ "ProductNode" ]

< ProductNode > array

version
required

The version of the vRealize product instance
Example : "string"

string

4.49. ClusterQueryResponse

Represents a cluster query response.

Name Description Schema

queryInfo
optional

Query info
Example : QueryInfo

QueryInfo

result
optional

Query result
Example : PageOfCluster

PageOfCluster

4.50. ClusterReference

Represents a reference to the cluster

Name Description Schema

id
required

ID of the cluster
Example : "string"

string

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

clusterImageId
optional

ID of the Cluster Image to be used with the cluster
Example : "string"

string

datastoreSpec
required

Cluster storage configuration; e.g. VSAN, NFS,vVol(nfs/iscsi/fc)
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

skipThumbprintValidation
optional

Skip thumbprint validation for ESXi and VxRail Manager during add cluster/host operation
Example : true

boolean

vxRailDetails
optional

Contains the VxRail Manager details
Example : VxRailDetails

VxRailDetails

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

isEdgeClusterConfiguredForMultiAZ
optional

Edge cluster configured for multi AZ
Example : true

boolean

secondaryAzOverlayVlanId
required

Secondary AZ Overlay Vlan Id
Example : 0

integer (int32)

vsanNetworkSpecs
optional

vSAN Network Pool Specs
Example : [ "VSANNetworkSpec" ]

< VSANNetworkSpec > array

witnessSpec
required

Witness host information
Example : WitnessSpec

WitnessSpec

witnessTrafficSharedWithVsanTraffic
optional

Witness traffic to be shared with vSAN traffic
Example : true

boolean

4.53. ClusterUnstretchSpec

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

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

prepareForStretch
optional

Prepare the cluster for stretch
Example : true

boolean

4.55. ComponentDetails

Component contains bits to install/update the appropriate Cloud Foundation software components in your management domain or workload domain.

Name Description Schema

displayName
required

Component display name
Example : "string"

string

displayVersion
optional

Component display version
Example : "string"

string

vendor
required

Component vendor
Example : "intel"

string

4.56. ComponentInfo

Component contains bits to install/update the appropriate Cloud Foundation software components in your management domain or workload domain.

Name Description Schema

details
required

Component details
Example : ComponentDetails

ComponentDetails

version
required

Component Version
Example : "1.3.2.8-1OEM.650.0.0.4598673"

string

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

skipFailedHosts
optional

Skip failed ESXi Hosts and proceed with the rest of the ESXi Hosts during add Cluster. This is not supported for VCF VxRail.
Example : false

boolean

4.58. 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.59. 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.60. CpuInfo

Represents a cpu metric with used and total for a resource

Name Description Schema

total
optional

Total value
Example : FrequencyMetric

FrequencyMetric

used
optional

Used value
Example : FrequencyMetric

FrequencyMetric

4.61. Credential

Represents a credential and the resource to which it is associated with

Name Description Schema

accountType
required

Account type
Example : "One among: USER, SYSTEM, SERVICE"

string

autoRotatePolicy
optional

Configured auto-rotate policy of a credential. Empty if not configured
Example : AutoRotateCredentialPolicy

AutoRotateCredentialPolicy

creationTimestamp
required

The timestamp at which credential was created
Example : "string"

string

credentialType
required

Credential type
Example : "One among: SSO, SSH, API, FTP, AUDIT"

string

id
required

Credential ID
Example : "string"

string

modificationTimestamp
required

The timestamp at which credential was last modified
Example : "string"

string

password
optional

Password
Example : "string"

string

resource
required

The resource which owns the credential
Example : AuthenticatedResource

AuthenticatedResource

username
required

Username
Example : "string"

string

4.62. CredentialsSpec

This specification contains information about credentials.

Name Description Schema

password
required

Password
Example : "string"

string

username
required

Username
Example : "string"

string

4.63. 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.64. 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

isAutoRotate
optional

Is Credential task an auto rotate task
Example : true

boolean

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

type
optional

Credential task type
Example : "One among: UPDATE, ROTATE, REMEDIATE, UPDATE_AUTO_ROTATE_POLICY"

string

4.65. CredentialsUpdateSpec

This specification contains password operation request details

Name Description Schema

autoRotatePolicy
optional

Auto Rotate policy for set of credentials
Example : AutoRotateCredentialPolicyInputSpec

AutoRotateCredentialPolicyInputSpec

elements
required

List of resource credentials to be changed
Example : [ "ResourceCredentials" ]

< ResourceCredentials > array

operationType
required

Operation type
Example : "One among: UPDATE, ROTATE, REMEDIATE, UPDATE_AUTO_ROTATE_POLICY"

string

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

Represents a single metric representing digital data

Name Description Schema

unit
optional

Unit of the metric
Example : "B"

enum (B, KB, MB, GB, TB, PB)

value
optional

Value of the metric
Example : 0.0

number (double)

4.70. Datastore

Name Description Schema

capacity
optional

Example : 0.0

number (double)

datastoreName
optional

Example : "string"

string

datastoreType
optional

Example : "VSAN"

enum (VSAN, VMFS, NFS)

freeSpace
optional

Example : 0.0

number (double)

unallocated
optional

Example : 0.0

number (double)

unit
optional

Example : "GHZ"

enum (GHZ, GB, TB, HZ, KHZ, MHZ, THZ, B, PB)

used
optional

Example : 0.0

number (double)

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

vvolDatastoreSpecs
optional

Cluster storage configuration for VVOL
Example : [ "VvolDatastoreSpec" ]

< VvolDatastoreSpec > array

4.72. DateTimeDetail

Name Description Schema

dateTime
optional

Example : "string"

string

timestamp
optional

Example : 0

integer (int64)

4.73. DepotAccount

VMware Depot Account Information

Name Description Schema

message
optional

Message explaining depot status
Example : "string"

string

password
required

Depot Password for Access
Example : "string"

string

status
optional

Depot Status
Example : "One among: DEPOT_UNKNOWN_HOST, DEPOT_NOT_AVAILABLE, DEPOT_USER_NOT_SET, DEPOT_INVALID_CREDENTIAL, UNKNOWN_FAILURE, DEPOT_CONNECTION_SUCCESSFUL"

string

username
required

Depot Username for Access
Example : "string"

string

4.74. DepotSettings

VMware Depot Settings. At least one of vmwareAccount or dellEmcSupportAccount value must be provided

Name Description Schema

dellEmcSupportAccount
optional

Dell EMC Support Account
Example : DepotAccount

DepotAccount

vmwareAccount
optional

VMware Depot Account
Example : DepotAccount

DepotAccount

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

DNS Configuration

Name Description Schema

dnsServers
required

List of DNS servers
Example : [ "DnsServer" ]

< DnsServer > array

4.77. DnsServer

DNS server details

Name Description Schema

ipAddress
required

IP address/FQDN of DNS server
Example : "10.0.0.250"

string

isPrimary
required

Is DNS server primary
Example : true

boolean

4.78. 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.79. Domain

Represents a domain

Name Description Schema

capacity
optional

Capacity information for the workload domain
Example : Capacity

Capacity

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

nsxtCluster
optional

NSX-T cluster associated with the workload domain
Example : NsxTClusterReference

NsxTClusterReference

status
optional

Status of the workload domain
Example : "string"

string

type
optional

Type of the workload domain
Example : "string"

string

vcenters
optional

List of vCenters associated with the workload domain
Example : [ "VcenterReference" ]

< VcenterReference > array

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

vcenterSpec
required

Specification details for vCenter
Example : VcenterSpec

VcenterSpec

4.81. 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.82. 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.83. DomainReference

Represents a domain reference

Name Description Schema

id
required

ID of the domain
Example : "string"

string

name
optional

Name of the domain
Example : "string"

string

4.84. DomainSummary

Name Description Schema

aggregatedCapacity
optional

Example : ResourceCapacity

ResourceCapacity

domainCount
optional

Example : 0

integer (int32)

type
optional

Example : "string"

string

4.85. DomainUpdateSpec

Contains the parameters required to perform update operation on domain

Name Description Schema

clusterSpec
optional

Cluster Specification for the domain
Example : ClusterSpec

ClusterSpec

markForDeletion
optional

Enable deletion for the domain
Example : true

boolean

name
optional

Name of the domain
Example : "string"

string

nsxTSpec
optional

NSX-T Specification for the domain
Example : NsxTSpec

NsxTSpec

4.86. DvsSpec

Spec contains parameters for DVS

Name Description Schema

dvsName
required

DVS Name
Example : "string"

string

isUsedByNsxt
optional

Flag indicating whether the DVS is used by NSX-T
Example : true

boolean

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, MANAGEMENT, UPLINK01, UPLINK02, X_REGION, REGION_SPECIFIC, NSXT_EDGE_TEP or any custom network types defined in networkSpecs"

< 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.87. EdgeCluster

EdgeCluster representation

Name Description Schema

clusters
optional

List of clusters associated with the edge cluster
Example : [ "ClusterReference" ]

< ClusterReference > array

edgeNodes
optional

List of edge nodes associated with the edge cluster
Example : [ "EdgeNodeReference" ]

< EdgeNodeReference > array

id
optional

ID of the egde cluster
Example : "string"

string

name
optional

Name of the edge cluster
Example : "string"

string

nsxtCluster
optional

NSX-T cluster associated with the edge cluster
Example : NsxTClusterReference

NsxTClusterReference

4.88. EdgeClusterCreationSpec

This specification contains the parameters required to add a NSX-T edge cluster spanning multiple VI clusters.

Name Description Schema

asn
required

ASN to be used for the edge cluster
Example : 0

integer (int64)

edgeAdminPassword
required

Edge Password for admin user
Example : "string"

string

edgeAuditPassword
required

Edge Password for audit
Example : "string"

string

edgeClusterName
required

Name for the edge cluster.
Example : "string"

string

edgeClusterProfileSpec
required

Specifications for Edge Node
Example : NsxTEdgeClusterProfileSpec

NsxTEdgeClusterProfileSpec

edgeClusterProfileType
required

Type of edge cluster profile
Example : "One among: DEFAULT, CUSTOM"

string

edgeClusterType
required

Type of edge cluster
Example : "One among: NSX-T"

string

edgeFormFactor
required

Edge Form Factor
Example : "One among: XLARGE, LARGE, MEDIUM, SMALL"

string

edgeNodeSpecs
required

Specifications for Edge Node. Number of Edge Nodes cannot exceed 8 if HA mode is ACTIVE-ACTIVE and can not exceed 2 if HA mode is ACTIVE-STANDBY
Example : [ "NsxTEdgeNodeSpec" ]

< NsxTEdgeNodeSpec > array

edgeRootPassword
required

Edge Password for root user.
Example : "string"

string

mtu
required

Maximum transmission unit
Example : 0

integer (int32)

tier0Name
required

Name for the T0 .
Example : "string"

string

tier0RoutingType
required

Tier 0 Routing type -eg eBGP, Static
Example : "One among: EBGP, STATIC"

string

tier0ServicesHighAvailability
required

High-availability Mode for Tier-0
Example : "One among: ACTIVE_ACTIVE, ACTIVE_STANDBY"

string

tier1Name
required

Name for the T1 .
Example : "string"

string

4.89. EdgeClusterExpansionSpec

This specification contains the parameters required to expand a NSX-T edge cluster.

Name Description Schema

additionalTier1Names
optional

List of names for the additional T1 to be created for expansion.
Example : [ "string" ]

< string > array

edgeNodeAdminPassword
required

Edge Password for admin user
Example : "string"

string

edgeNodeAuditPassword
required

Edge Password for audit user
Example : "string"

string

edgeNodeRootPassword
required

Edge Password for root user.
Example : "string"

string

edgeNodeSpecs
required

Specifications for Edge Node
Example : [ "NsxTEdgeNodeSpec" ]

< NsxTEdgeNodeSpec > array

4.90. EdgeClusterNsxtEntityCriterion

Represents a criterion for querying the Edge Cluster

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: TIER_0_GATEWAY_ASSOCIATED_WITH_EDGE_CLUSTER, TIER_1_GATEWAY_ASSOCIATED_WITH_EDGE_CLUSTER"

string

4.91. EdgeClusterShrinkageSpec

This specification contains the parameters required to shrink a NSX-T edge cluster.

Name Description Schema

edgeNodeIds
required

List of VCF Edge Node ID’s to be removed for shrinkage.
Example : [ "string" ]

< string > array

4.92. EdgeClusterUpdateSpec

This specification contains the parameters required to perform an update operation on an NSX-T edge cluster. The nested expansion and shrinkage specifications need to be populated in a mutually exclusive manner

Name Description Schema

edgeClusterExpansionSpec
optional

Parameters required to perform edge cluster expansion, optional otherwise
Example : EdgeClusterExpansionSpec

EdgeClusterExpansionSpec

edgeClusterShrinkageSpec
optional

Parameters required to perform edge cluster shrinkage, optional otherwise
Example : EdgeClusterShrinkageSpec

EdgeClusterShrinkageSpec

operation
required

Edge cluster operation Type.
Example : "One among: EXPANSION, SHRINKAGE"

string

4.93. EdgeNodeReference

Represents a reference to the edge node

Name Description Schema

hostName
required

Hostname of the edge node
Example : "string"

string

id
required

ID of the edge node
Example : "string"

string

4.94. Encryption

Restore Specification

Name Description Schema

passphrase
required

Passphrase
Example : "string"

string

4.95. 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, WSA, VRSLCM"

string

url
required

Url of the Endpoint
Example : "string"

string

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

errorType
optional
read-only

The error type
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.97. ErrorCause

Describes a single error cause

Name Description Schema

message
optional

The message describing the reason for the error
Example : "string"

string

type
optional

The type of the error cause
Example : "string"

string

4.98. ErrorCode

Name Description Schema

bundleName
optional

Example : "string"

string

code
optional

Example : "string"

string

component
optional

Example : "string"

string

4.99. ErrorCodePack

Name Description Schema

arguments
optional

Example : [ "object" ]

< object > array

bundleName
optional

Example : "string"

string

classLoader
optional

Example : ClassLoader

ClassLoader

code
optional

Example : "string"

string

component
optional

Example : "string"

string

errorCode
optional

Example : ErrorCode

ErrorCode

stringArguments
optional

Example : [ "string" ]

< string > array

4.100. 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.101. FcSpec

Cluster storage configuration for VMFS on FC

Name Description Schema

datastoreName
required

Datastore name used for cluster creation
Example : "string"

string

4.102. 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.103. 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.104. Fips

Represents VCF FIPS mode status (enabled/disabled)

Name Description Schema

enabled
required

VCF FIPS mode status
Example : true

boolean

4.105. FrequencyMetric

Represents a single metric representing freequency

Name Description Schema

unit
optional

Unit of the metric
Example : "Hz"

enum (Hz, KHz, MHz, GHz, THz)

value
optional

Value of the metric
Example : 0.0

number (double)

4.106. HardwareSupportInfo

Hardware support contains base os, components, hardware support, addOn metadata to install/update the appropriate Cloud Foundation software components in your management domain or workload domain.

Name Description Schema

packages
required

Hardware support packages
Example : {
"string" : "HardwareSupportPackageInfo"
}

< string, HardwareSupportPackageInfo > map

4.107. HardwareSupportPackage

Configured Hardware Support Manager details

Name Description Schema

displayName
optional

Hardware Support Manager display name
Example : "string"

string

name
required

Hardware Support Manager Name
Example : "string"

string

pkg
required

Hardware Support Package
Example : PackageSpec

PackageSpec

4.108. HardwareSupportPackageInfo

Hardware Support Package contains metadata regarding the package, version to install/update the appropriate Cloud Foundation software components in your management domain or workload domain.

Name Description Schema

pkg
required

Hardware support package name
Example : "string"

string

version
required

Hardware support package version
Example : "string"

string

4.109. HardwareSupportPackages

Available Hardware Support Manager details

Name Description Schema

displayName
required

Hardware Support Manager display name
Example : "string"

string

name
required

Hardware Support Manager Name
Example : "string"

string

packages
required

Hardware Support Packages
Example : [ "PackageSpec" ]

< PackageSpec > array

4.110. HardwareSupportSpec

Hardware Support Specification for Firmware Upgrade

Name Description Schema

name
required

Hardware Support Manager name
Example : "string"

string

packageSpec
required

Package for Hardware Support Managers
Example : PackageSpec

PackageSpec

4.111. HighAvailability

This specification contains high availability settings

Name Description Schema

enabled
required

Example : true

boolean

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

isPrimary
optional

Is the host a primary host in VxRail HCI Context
Example : true

boolean

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

serialNumber
optional

Serial Number of the host
Example : OptionalOfstring

OptionalOfstring

sshThumbprint
optional

SSH Thumbprint of the host
Example : OptionalOfstring

OptionalOfstring

sslThumbprint
optional

SSL Thumbprint of the host
Example : OptionalOfstring

OptionalOfstring

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

sshThumbprint
optional

SSH thumbprint of the host
Example : "string"

string

sslThumbprint
optional

SSL thumbprint of the host
Example : "string"

string

storageType
required

Storage Type
Example : "One among: VSAN, NFS, VMFS_FC, VVOL"

string

username
required

Username of the host
Example : "string"

string

vvolStorageProtocolType
optional

vVol Storage Protocol Type
Example : "One among: ISCSI, NFS, FC"

string

4.114. HostCount

Name Description Schema

total
optional

Example : 0

integer (int32)

unallocated
optional

Example : 0

integer (int32)

used
optional

Example : 0

integer (int32)

4.115. 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, UNMANAGED_HOSTS_IN_VCENTER, UNMANAGED_HOSTS_IN_HCIMGR"

string

4.116. 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.117. 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.118. HostQueryResponse

Represents a host query response.

Name Description Schema

queryInfo
optional

Query info
Example : QueryInfo

QueryInfo

result
optional

Query result
Example : PageOfHost

PageOfHost

4.119. HostReference

Represents an ESXi host reference

Name Description Schema

azName
optional

Fault domain name of the host
Example : "string"

string

fqdn
optional

FQDN of the host
Example : "string"

string

id
optional

ID of the host
Example : "string"

string

ipAddress
optional

IP address of the host
Example : "string"

string

vmNics
optional

VM NICs of the host
Example : [ "VMNicInfo" ]

< VMNicInfo > array

4.120. HostSpec

This specification contains information required to add vSphere host to a cluster

Name Description Schema

azName
optional

Availability Zone Name
(This is required while performing a stretched cluster expand operation)
Example : "string"

string

hostName
optional

Host name of the vSphere host
Example : "string"

string

hostNetworkSpec
optional

Network Details of the vSphere host
Example : HostNetworkSpec

HostNetworkSpec

id
required

ID of a vSphere host in the free pool
Example : "string"

string

ipAddress
optional

IP address of the vSphere host
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

password
optional

SSH password of the vSphere host
Example : "string"

string

serialNumber
optional

Serial Number of the vSphere host
Example : "string"

string

sshThumbprint
optional

SSH thumbprint of the vSphere host
Example : "string"

string

username
optional

Username of the vSphere host
Example : "string"

string

4.121. 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, MANAGEMENT"

string

4.122. InventoryInfo

Name Description Schema

hostCount
optional

Example : HostCount

HostCount

4.123. 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.124. 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.125. IpAddressPoolRangeSpec

This specification contains the parameters required to create an IP address range

Name Description Schema

end
required

The last IP Address of the IP Address Range
Example : "string"

string

start
required

The first IP Address of the IP Address Range
Example : "string"

string

4.126. IpAddressPoolSpec

This specification contains the parameters required to create or reuse an IP address pool.

Name Description Schema

description
optional

Description of the IP address pool
Example : "string"

string

ignoreUnavailableNsxtCluster
optional

Ignore unavailable NSX-T cluster(s) during IP pool spec validation
Example : true

boolean

name
required

Name of the IP address pool
Example : "string"

string

subnets
optional

List of IP address pool subnet specification
Example : [ "IpAddressPoolSubnetSpec" ]

< IpAddressPoolSubnetSpec > array

4.127. IpAddressPoolSubnetSpec

This specification contains the parameters required to create an IP address pool subnet

Name Description Schema

cidr
required

The subnet representation, contains the network address and the prefix length
Example : "string"

string

gateway
required

The default gateway address of the network
Example : "string"

string

ipAddressPoolRanges
required

List of the IP allocation ranges. Atleast 1 IP address range has to be specified
Example : [ "IpAddressPoolRangeSpec" ]

< IpAddressPoolRangeSpec > array

4.128. 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
optional

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.129. 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.130. 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.131. 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, SDDC_MANAGER, ESXI, NSXT, WCP, HORIZON_VIEW"

string

4.132. 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.133. 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.134. LocalAccountPasswordInfo

Represents local account and its attributes

Name Description Schema

newPassword
required

The new password of the local account
Example : "string"

string

oldPassword
optional

The old password of the local account
Example : "string"

string

4.135. LocalUser

Represents Local User and its attributes

Name Description Schema

apiKey
optional

The API key of the user
Example : "string"

string

creationTimestamp
optional

The timestamp at which the user was created
Example : "string"

string

domain
optional

The domain of the user
Example : "string"

string

id
optional

The ID of the user
Example : "string"

string

isConfigured
optional

Flag indicating whether or not local account is configured
Example : true

boolean

name
required

The name of the user
Example : "string"

string

role
required

The role of the user
Example : RoleReference

RoleReference

type
required

The type of the user
Example : "One among: USER, GROUP, SERVICE"

string

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

LCM 2.0 Manifest model that represents the metadata of the VMware Cloud foundation components and releases that Lyfe cycle manager utilises.

Name Description Schema

creationTime
required

Creation time for the manifest e.g. 2020-06-08T02:20:15.844Z, in yyyy-MM-dd’T’HH:mm:ss[.SSS]XXX ISO 8601 format
Example : "string"

string

publishedDate
required

Date of publish of the manifest e.g. 2020-06-08T02:20:15.844Z, in yyyy-MM-dd’T’HH:mm:ss[.SSS]XXX ISO 8601 format
Example : "string"

string

recalledBundles
optional

Collection of bundles that are recalled and thier replacements, if applicable
Example : [ "BundleRecall" ]

< BundleRecall > array

releases
required

Releases of VCF in the ascending order of product version
Example : [ "Release" ]

< Release > array

sequenceNumber
required

Manifest sequence number which signifies an update in manifest
Example : 0

integer (int32)

version
required

Manifest version supported by VCF
Example : 0

integer (int32)

4.138. MapOfstringAndComponentInfo

Type : < string, ComponentInfo > map

4.139. MapOfstringAndHardwareSupportPackageInfo

Type : < string, HardwareSupportPackageInfo > map

4.140. MapOfstringAndstring

Type : < string, string > map

4.141. MemberCapacityInfo

Name Description Schema

summary
optional

Example : CapacitySummary

CapacitySummary

4.142. 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.143. 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.144. MemberHealth

Name Description Schema

healthCode
optional

Example : "GREEN"

enum (GREEN, YELLOW, RED)

healthDetails
optional

Example : [ "string" ]

< string > array

4.145. 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.146. MemberInventory

Name Description Schema

capacity
optional

Example : MemberCapacityInfo

MemberCapacityInfo

createTime
optional

Example : "string"

string

creationTime
optional

Example : "string"

string

inventoryInfo
optional

Example : InventoryInfo

InventoryInfo

softwareInfo
optional

Example : MemberSoftwareInfo

MemberSoftwareInfo

4.147. 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.148. MemberLiveliness

Name Description Schema

livelinessCode
optional

Example : "GREEN"

enum (GREEN, YELLOW, RED)

livelinessDetails
optional

Example : [ "string" ]

< string > array

4.149. MemberSoftwareInfo

Name Description Schema

pendingUpdates
optional

Example : 0

integer (int32)

4.150. 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.151. 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.152. MemoryInfo

Represents a memory metric with used and total for a resource

Name Description Schema

total
optional

Total value
Example : DataMetric

DataMetric

used
optional

Used value
Example : DataMetric

DataMetric

4.153. 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.154. MessageBusServerInfoList

Name Description Schema

messageBusServersInfo
optional

Example : [ "MessageBusServerInfo" ]

< MessageBusServerInfo > array

4.155. 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.156. 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.157. 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.158. 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.159. 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.160. 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.161. 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.162. NetworkPoolUpdateSpec

Represents a network pool update spec

Name Description Schema

name
optional

Name of the Network Pool
Example : "string"

string

4.163. 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.164. 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.165. NiocBandwidthAllocation

Network traffic per resource type

Name Description Schema

niocTrafficResourceAllocation
optional

Specify network traffic allocation for a resource
Example : NiocTrafficResourceAllocation

NiocTrafficResourceAllocation

type
optional

Host infrastructure traffic type
Example : "One among: management, faultTolerance, vmotion, virtualMachine, iSCSI, nfs, hbr, vsan, vdp"

string

4.166. 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.167. 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.168. NiocTrafficResourceAllocation

Specify network traffic allocation for a resource

Name Description Schema

limit
required

Example : 0

integer (int64)

reservation
required

Example : 0

integer (int64)

sharesInfo
required

Example : SharesInfo

SharesInfo

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

4.170. 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.171. NsxTCluster

NSX-T Cluster representation

Name Description Schema

domains
optional

Information about the domains associated with the cluster
Example : [ "DomainReference" ]

< DomainReference > array

id
optional

ID of the cluster
Example : "string"

string

isShareable
optional

Boolean to identify if the NSX-T cluster can be shared to create a new workload domain
Example : true

boolean

isShared
optional

Boolean to identify if the NSX-T cluster is shared among workload domains
Example : true

boolean

isVlcmCompatible
optional

Boolean to identify if the NSX-T cluster is compatible with Vlcm
Example : true

boolean

nodes
optional

Information about the NSX-T managers associated with the cluster
Example : [ "NsxTManager" ]

< NsxTManager > array

status
optional

NSX-T cluster status. To get NSX-T cluster status invoke nsxt-clusters query API with criterion NSXT_CLUSTERS_WITH_STATUS
Example : "One among: INITIALIZING, STABLE, DEGRADED, UNSTABLE, UNAVAILABLE, UNIDENTIFIED, UNDEFINED"

string

version
optional

Version of the NSX-T managers associated with the cluster
Example : "string"

string

vip
optional

VIP (Virtual IP Address) of the cluster
Example : "string"

string

vipFqdn
optional

FQDN for VIP of the cluster
Example : "string"

string

4.172. NsxTClusterReference

Represents an NSX-T Cluster reference

Name Description Schema

id
optional

ID of the NSX-T cluster
Example : "string"

string

vip
optional

VIP (Virtual IP Address) of the NSX-T cluster
Example : "string"

string

vipFqdn
optional

FQDN for VIP of the NSX-T cluster
Example : "string"

string

4.173. NsxTClusterSpec

This specification contains NSX-T configuration for a new cluster.

Name Description Schema

geneveVlanId
optional

Vlan id of Geneve
Example : 0

integer (int32)

ipAddressPoolSpec
optional

The IP address pool specification
Example : IpAddressPoolSpec

IpAddressPoolSpec

4.174. NsxTCriterion

Represents a criterion for querying the NSX-T cluster

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

string

4.175. NsxTEdgeClusterProfileSpec

This specification contains edge cluster profile configurations

Name Description Schema

bfdAllowedHop
required

BFD allowed Hop
Example : 0

integer (int64)

bfdDeclareDeadMultiple
required

BFD Declare Dead Multiple
Example : 0

integer (int64)

bfdProbeInterval
required

BFD Probe
Example : 0

integer (int64)

edgeClusterProfileName
required

Name for the edge cluster profile.
Example : "string"

string

standbyRelocationThreshold
required

Standby Relocation Threshold
Example : 0

integer (int64)

4.176. NsxTEdgeNodeSpec

This specification contains configuration inputs required to deploy and configure an edge node

Name Description Schema

clusterId
required

Cluster on which the edge needs to be deployed
Example : "string"

string

edgeNodeName
required

Edge Node Name
Example : "string"

string

edgeTep1IP
required

Edge TEP 1 IP
Example : "string"

string

edgeTep2IP
required

Edge TEP 2 IP
Example : "string"

string

edgeTepGateway
required

Edge TEP Gateway IP
Example : "string"

string

edgeTepVlan
required

Edge TEP VLAN
Example : 0

integer (int32)

firstNsxVdsUplink
optional

First NSX enabled VDS uplink for the Edge node
Example : "One among: uplink1, uplink2, uplink3, uplink4"

string

interRackCluster
required

Is inter-rack cluster(true for L2 non-uniform and L3 : At least one of management, uplink, Edge and host TEP networks is different for hosts of the cluster, false for L2 uniform : All hosts in cluster have identical management, uplink, Edge and host TEP networks)
Example : true

boolean

managementGateway
required

Management Gateway IP
Example : "string"

string

managementIP
required

Management Interface IP
Example : "string"

string

secondNsxVdsUplink
optional

Second NSX enabled VDS uplink for the Edge node
Example : "One among: uplink1, uplink2, uplink3, uplink4"

string

uplinkNetwork
optional

Specifications of Tier0 uplinks for the Edge Node
Example : [ "NsxTEdgeUplinkNetwork" ]

< NsxTEdgeUplinkNetwork > array

4.177. NsxTEdgeUplinkNetwork

This specification contains input parameters required to configure uplink network for NSX-T edge node VM

Name Description Schema

asnPeer
optional

ASN of Peer
Example : 0

integer (int64)

bgpPeerPassword
optional

BGP Peer Password
Example : "string"

string

bgpPeers
optional

List of BGP Peer configuration
Example : [ "BgpPeerSpec" ]

< BgpPeerSpec > array

peerIP
optional

BGP Peer IP
Example : "string"

string

uplinkInterfaceIP
required

Uplink IP
Example : "string"

string

uplinkVlan
required

Uplink Vlan
Example : 0

integer (int32)

4.178. NsxTManager

NSX-T Manager representation

Name Description Schema

fqdn
optional

FQDN of the manager
Example : "string"

string

id
optional

ID of the manager
Example : "string"

string

ipAddress
optional

IP address of the manager
Example : "string"

string

name
optional

NSX-T Manager VM name in vCenter
Example : "string"

string

4.179. NsxTQueryResponse

Represents a NSX-T cluster query response.

Name Description Schema

queryInfo
optional

Query info
Example : QueryInfo

QueryInfo

result
optional

Query result
Example : PageOfNsxTCluster

PageOfNsxTCluster

4.180. NsxTSpec

This specification contains the parameters required to install and configure NSX-T in a workload domain

Name Description Schema

formFactor
optional

NSX manager form factor
Example : "string"

string

ipAddressPoolSpec
optional

The IP address pool specification
Example : IpAddressPoolSpec

IpAddressPoolSpec

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.181. NsxtEdgeCluster

Nsxt 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.182. NsxtEdgeClusterUpgradeSpec

Host transport node 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.183. NsxtEdgeSpec

NSX-T edge specification. Deprecated as of 4.3, Bringup AVN has been deprecated. Instead use DAY-N AVN workflow.

Name Description Schema

asn
required

NSX-T edge asn
Example : 0

integer (int64)

bgpNeighbours
optional

NSX-T edge bgp neighbour
Example : [ "BgpNeighbour" ]

< BgpNeighbour > array

edgeAdminPassword
required

NSX-T edge admin password
Example : "string"

string

edgeAuditPassword
required

NSX-T edge audit password
Example : "string"

string

edgeClusterName
required

NSX-T edge cluster name
Example : "string"

string

edgeFormFactor
optional

NSX-T edge form factor
Example : "Oneamong:SMALL"

enum (Oneamong:SMALL, MEDIUM, LARGE, XLARGE)

edgeNodeSpecs
optional

NSX-T edge node specification
Example : [ "SddcNsxtEdgeNodeSpec" ]

< SddcNsxtEdgeNodeSpec > array

edgeRootPassword
required

NSX-T edge root password
Example : "string"

string

edgeServicesSpecs
optional

NSX-T Edge Services specification
Example : SddcNsxtEdgeServicesSpec

SddcNsxtEdgeServicesSpec

tier0ServicesHighAvailability
optional

NSX-T tier0 service high availability
Example : "string"

string

4.184. NsxtHostCluster

Nsxt Host Cluster Upgrade Resource

Name Description Schema

availableHardwareSupportManagers
optional

Available Hardware Support Managers for Firmware upgrade
Example : [ "HardwareSupportPackages" ]

< HardwareSupportPackages > array

configuredHardwareSupportManagers
optional

Configured Hardware Support Managers for Firmware upgrade
Example : [ "HardwareSupportPackage" ]

< HardwareSupportPackage > array

domainId
optional

Id of the domain the Host cluster belongs to
Example : "string"

string

id
optional

Host cluster VCF cluster id
Example : "string"

string

name
optional

Cluster name
Example : "string"

string

primaryCluster
optional

Flag to determine if primary cluster for vLCM
Example : true

boolean

resourceHealth
optional

Current resource health status
Example : "string"

string

totalUnits
optional

Total number of hosts in the Host 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 host node cluster.If a partial upgrade is done, this will be the least version among the hosts
Example : "string"

string

vlcmEnabled
optional

Example : true

boolean

4.185. NsxtHostClusterUpgradeSpec

Host trnasport 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 transportnode clusters
Example : true

boolean

4.186. NsxtInterface

NSX-T edge node interface specification. Deprecated as of 4.3, Bringup AVN has been deprecated. Instead use DAY-N AVN workflow.

Name Description Schema

interfaceCidr
required

NSX-T edge node interface CIDR
Example : "string"

string

name
required

NSX-T edge node interface name
Example : "string"

string

4.187. NsxtIpAddressPool

NSX-T IP address pool representation

Name Description Schema

availableIpAddresses
optional

The number of IP addresses available in the IP address pool
Example : 0

integer (int32)

blockSubnets
optional

The list of IP address pool block subnets
Example : [ "NsxtIpAddressPoolBlockSubnet" ]

< NsxtIpAddressPoolBlockSubnet > array

description
optional

Description of the IP address pool
Example : "string"

string

name
optional

Name of the IP address pool
Example : "string"

string

staticSubnets
optional

The list of IP address pool static subnets
Example : [ "NsxtIpAddressPoolStaticSubnet" ]

< NsxtIpAddressPoolStaticSubnet > array

totalIpAddresses
optional

The total number of IP addresses in the IP address pool
Example : 0

integer (int32)

4.188. NsxtIpAddressPoolBlockSubnet

NSX-T IP address pool block subnet representation

Name Description Schema

cidr
optional

The CIDR of the IP address subnet
Example : "string"

string

gatewayAssigned
optional

The boolean representing the state of the gateway assignment
Example : true

boolean

size
optional

The size of the IP address block
Example : 0

integer (int32)

4.189. NsxtIpAddressPoolRange

NSX-T IP address pool range representation

Name Description Schema

end
optional

The end of the IP address range
Example : "string"

string

start
optional

The start of the IP address range
Example : "string"

string

4.190. NsxtIpAddressPoolStaticSubnet

NSX-T IP address pool static subnet representation

Name Description Schema

cidr
optional

The CIDR of the IP address subnet
Example : "string"

string

gateway
optional

The gateway IP address
Example : "string"

string

ipAddressPoolRanges
optional

The list of IP address ranges
Example : [ "NsxtIpAddressPoolRange" ]

< NsxtIpAddressPoolRange > array

4.191. NsxtIpAddressPoolValidationSpec

Name Description Schema

ipAddressPoolSpec
required

Example : IpAddressPoolSpec

IpAddressPoolSpec

nsxtClusterId
required

Example : "string"

string

4.192. NsxtLogicalSegment

NSX-T edge node logical segment specification. Deprecated as of 4.3, Bringup AVN has been deprecated. Instead use DAY-N AVN workflow.

Name Description Schema

name
required

NSX-T edge node logical switch name
Example : "string"

string

networkType
required

NSX-T edge node logical segment network type
Example : "Oneamong:X_REGION"

enum (Oneamong:X_REGION, REGION_SPECIFIC)

4.193. NsxtManagerCluster

Nsxt Manager Cluster Upgrade Resource

Name Description Schema

id
optional

Manager cluster id
Example : "string"

string

name
optional

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.194. NsxtManagerSpec

Spec contains parameters for NSX-T manager

Name Description Schema

hostname
optional

NSX-T Manager hostname
Example : "string"

string

ip
optional

NSX-T Manager IP Address
Example : "string"

string

4.195. NsxtResources

Nsxt Upgrade Resources for an NSXT instance

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 clusters that are candidates for upgrade
Example : [ "NsxtEdgeCluster" ]

< NsxtEdgeCluster > array

nsxtHostClusters
optional

List of host 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.196. NsxtTransportZone

Spec contains required parameters for NSX-T Transport Zone

Name Description Schema

networkName
required

Transport zone network name
Example : "string"

string

zoneName
required

Transport zone name
Example : "string"

string

4.197. NsxtUpgradeCoordinator

NSXT 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.198. NsxtUpgradeOptions

NSXT Upgrade options

Name Description Schema

isEdgeClustersUpgradeParallel
optional

Flag for disabling/enabling parallel upgrade of edge transportnode 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 transportnode clusters
Example : true

boolean

4.199. NsxtUpgradeUserInputSpec

Nsxt 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 NSXT instance
Example : "string"

string

nsxtUpgradeOptions
optional

List of host clusters information if explicit selection is to be made
Example : NsxtUpgradeOptions

NsxtUpgradeOptions

4.200. NtpConfiguration

NTP Configuration

Name Description Schema

ntpServers
required

List of NTP servers
Example : [ "NtpServer" ]

< NtpServer > array

4.201. NtpServer

NTP server details

Name Description Schema

ipAddress
required

IP address/FQDN of NTP server
Example : "10.0.0.250"

string

4.202. 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.203. OptionalOfstring

Name Description Schema

present
optional

Example : true

boolean

4.204. Package

Hardware Support Package Specification

Name Description Schema

name
required

Package name
Example : "string"

string

version
required

Package version
Example : "string"

string

4.205. PackageSpec

Hardware Support Package Specification

Name Description Schema

name
required

Package name
Example : "string"

string

version
required

Package version
Example : "string"

string

4.206. 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.207. 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.208. 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.209. 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.210. 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.211. 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.212. PageOfClusterCriterion

Represents a page of elements of a single type

Name Description Schema

elements
optional

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

< ClusterCriterion > array

pageMetadata
optional

Pageable elements pagination metadata information
Example : PageMetadata

PageMetadata

4.213. 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.214. 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.215. 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.216. 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.217. 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.218. PageOfEdgeCluster

Represents a page of elements of a single type

Name Description Schema

elements
optional

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

< EdgeCluster > array

pageMetadata
optional

Pageable elements pagination metadata information
Example : PageMetadata

PageMetadata

4.219. PageOfEdgeClusterNsxtEntityCriterion

Represents a page of elements of a single type

Name Description Schema

elements
optional

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

< EdgeClusterNsxtEntityCriterion > array

pageMetadata
optional

Pageable elements pagination metadata information
Example : PageMetadata

PageMetadata

4.220. 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.221. 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.222. 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.223. 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.224. 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.225. 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.226. 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.227. PageOfNsxTCriterion

Represents a page of elements of a single type

Name Description Schema

elements
optional

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

< NsxTCriterion > array

pageMetadata
optional

Pageable elements pagination metadata information
Example : PageMetadata

PageMetadata

4.228. PageOfNsxtIpAddressPool

Represents a page of elements of a single type

Name Description Schema

elements
optional

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

< NsxtIpAddressPool > array

pageMetadata
optional

Pageable elements pagination metadata information
Example : PageMetadata

PageMetadata

4.229. 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.230. PageOfRelease

Represents a page of elements of a single type

Name Description Schema

elements
optional

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

< Release > array

pageMetadata
optional

Pageable elements pagination metadata information
Example : PageMetadata

PageMetadata

4.231. PageOfRole

Represents a page of elements of a single type

Name Description Schema

elements
optional

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

< Role > array

pageMetadata
optional

Pageable elements pagination metadata information
Example : PageMetadata

PageMetadata

4.232. 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.233. 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.234. PageOfSsoDomainEntity

Represents a page of elements of a single type

Name Description Schema

elements
optional

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

< SsoDomainEntity > array

pageMetadata
optional

Pageable elements pagination metadata information
Example : PageMetadata

PageMetadata

4.235. 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.236. 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.237. PageOfUpgradablesClusterResource

Represents a page of elements of a Upgradables Cluster Resource

Name Description Schema

elements
optional

The list of Upgradables Cluster Resource elements included in this page
Example : [ "UpgradablesClusterResource" ]

< UpgradablesClusterResource > array

4.238. 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.239. PageOfUser

Represents a page of elements of a single type

Name Description Schema

elements
optional

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

< User > array

pageMetadata
optional

Pageable elements pagination metadata information
Example : PageMetadata

PageMetadata

4.240. 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.241. PageOfVasaProvider

Represents a page of elements of a single type

Name Description Schema

elements
optional

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

< VasaProvider > array

pageMetadata
optional

Pageable elements pagination metadata information
Example : PageMetadata

PageMetadata

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

Represents a page of elements of a single type

Name Description Schema

elements
optional

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

< Vra > array

pageMetadata
optional

Pageable elements pagination metadata information
Example : PageMetadata

PageMetadata

4.246. 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.247. 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.248. 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.249. PageOfWsa

Represents a page of elements of a single type

Name Description Schema

elements
optional

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

< Wsa > array

pageMetadata
optional

Pageable elements pagination metadata information
Example : PageMetadata

PageMetadata

4.250. PageOfobject

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.251. PageOfstring

Represents a page of elements of a single type

Name Description Schema

elements
optional

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

< string > array

pageMetadata
optional

Pageable elements pagination metadata information
Example : PageMetadata

PageMetadata

4.252. PartnerExtensionSpec

Specification for partner extensions. This specification is used in the Bundle Upload API

Name Description Schema

partnerBundleMetadataFilePath
optional

Path to the bundle metadata file. The metadata file can have details of multiple bundles
Example : "string"

string

partnerBundleVersion
optional

Version of partner bundle to be uploaded. Should match one of the bundle versions available in the partner bundle metadata file
Example : "string"

string

4.253. PatchBundle

Model for patch bundle in a release

Name Description Schema

bundleElements
required

Bundle elements of the patch bundle
Example : [ "string" ]

< string > array

bundleId
required

Bundle ID of the patch bundle
Example : "string"

string

bundleType
required

Bundle type of the patch bundle
Example : "string"

string

cumulativeFromVcfVersion
required

Minimum VCF version that this patch bundle can be directly applied on
Example : "string"

string

4.254. Personality

Personality contains bits to install/update the appropriate Cloud Foundation software components in your management domain or workload domain.

Name Description Schema

createdBy
optional

Personality created by
Example : "string"

string

description
required

Personality description
Example : "ESXi 7.0 Dell Personality"

string

displayName
required

Personality displayName
Example : "ESXi 7.0 Dell Personality"

string

imageChecksum
required

Personality image checksum
Example : "string"

string

imageSize
required

Personality image size
Example : "string"

string

kbArticles
optional

Personality kb articles
Example : URL

URL

personalityId
required

Personality id
Example : "string"

string

personalityName
required

Personality name
Example : "string"

string

releaseDate
optional

Personality Release date
Example : 0

integer (int64)

softwareInfo
required

Personality software spec
Example : SoftwareInfo

SoftwareInfo

tags
optional

Personality tags
Example : [ "string" ]

< string > array

version
required

Personality Version
Example : "string"

string

vsphereExportedIsoPath
required

Personality depot path
Example : "string"

string

vsphereExportedJsonPath
required

Personality depot path
Example : "string"

string

vsphereExportedZipPath
required

Personality depot path
Example : "string"

string

4.255. PersonalitySpec

Personality Specification for vLCM based upgrade

Name Description Schema

hardwareSupportSpecs
optional

Hardware Support Specifications for Firmware upgrade
Example : [ "HardwareSupportSpec" ]

< HardwareSupportSpec > array

personalityId
required

Personality ID for vLCM based Upgrade
Example : "string"

string

4.256. PersonalityUploadSpec

Personality upload specification. This spec is used in personality upload API.

Name Description Schema

name
optional

Personality name
Example : "string"

string

uploadMode
required

Personality upload mode
Example : "RAW, RAW_WITH_FILE_UPLOAD_ID, REFERRED"

string

uploadSpecRawMode
optional

Personality upload spec for upload from RAW files
Example : PersonalityUploadSpecRaw

PersonalityUploadSpecRaw

uploadSpecRawWithFileUploadIdMode
optional

Personality upload spec for upload using file upload id
Example : PersonalityUploadSpecRawWithFileUploadId

PersonalityUploadSpecRawWithFileUploadId

uploadSpecReferredMode
optional

Personality upload spec for upload from REFERRED vcenter cluster
Example : PersonalityUploadSpecReferred

PersonalityUploadSpecReferred

4.257. PersonalityUploadSpecRaw

Personality upload specification for uploading the personality from raw files exported from avCenter cluster. This mode of uplaoding personality is useful when the source vCenter cluster isoutside the target VCF deployment.

Name Description Schema

personalityISOFilePath
optional

Personality ISO File Path
Example : "string"

string

personalityInfoJSONFilePath
required

Personality Info JSON File Path
Example : "string"

string

personalityJSONFilePath
required

Personality JSON File Path
Example : "string"

string

personalityZIPFilePath
required

Personality Zip File Path
Example : "string"

string

4.258. PersonalityUploadSpecRawWithFileUploadId

Personality upload specification for uploading the personality from raw files exported from a vCenter cluster. This mode of uploading personality is useful when the source vCenter cluster is outside the target VCF deployment. User can upload files from a source location to SDDC Manager using v1/personalities/files API, which returns a file upload id. The id is then passed in this spec with Personality Upload Mode RAW_WITH_FILE_UPLOAD_ID.

Name Description Schema

fileUploadId
optional

Personality file upload id. This id is obtained by calling v1/personalities/files and uploading files into SDDC Manager
Example : "string"

string

4.259. PersonalityUploadSpecReferred

Personality upload specification for uploading the personality from a referred vCentercluster. This mode of uplaoding personality is useful when the source vCenter cluster isinternal to the target VCF deployment.

Name Description Schema

clusterId
required

Source cluster UUID from VCF inventory
Example : "string"

string

vCenterId
required

Example : "string"

string

vcenterId
optional

Example : "string"

string

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

speed
optional

Speed in bytes of the physical NIC
Example : 0

integer (int64)

4.261. Portgroup

Portgroup associated with the vSphere Distributed Switch

Name Description Schema

activeUplinks
optional

List of active uplinks
Example : [ "string" ]

< string > array

name
required

Port group name
Example : "string"

string

portBindingType
optional

Port binding type
Example : "One among: STATIC, DYNAMIC, EPHEMERAL"

string

standbyUplinks
optional

List of standby uplinks
Example : [ "string" ]

< string > array

transportType
required

Port group transport type
Example : "One among: VSAN, VMOTION, MANAGEMENT, PUBLIC, NFS, VREALIZE, ISCSI, EDGE_INFRA_OVERLAY_UPLINK"

string

vlanId
optional

VLAN ID
Example : 0

integer (int32)

4.262. 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, VREALIZE, ISCSI, EDGE_INFRA_OVERLAY_UPLINK"

string

4.263. PositionCoordinate

Name Description Schema

latitude
optional

Example : 0.0

number (double)

longitude
optional

Example : 0.0

number (double)

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

mode
optional

If specified, indicates the mode of the execution. Supported modes are UPGRADE and RECOVERY. UPGRADE is default mode. Specify RECOVERY for the Inventory Consistency Checks
Example : "string"

string

resources
required

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

< Resource > array

4.265. ProductNode

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

password
required

The password for a root user of vRealize appliance
Example : "string"

string

type
required

The type of the vRealize product node
Example : "MASTER, REPLICA, DATA, REMOTECOLLECTOR, WORKER"

enum (Oneamong:MASTER, REPLICA, DATA, REMOTECOLLECTOR, WORKER, PRIMARY, SECONDARY)

username
required

The username for a root user of vRealize appliance
Example : "string"

string

4.266. ProductVersion

Details of the product/component for the release.

Name Description Schema

additionalMetadata
optional

any additional metadata
Example : "string"

string

name
required

Name of the product. e.g ESX
Example : "string"

string

publicName
required

Public name of the product, e.g VMware ESXi
Example : "string"

string

releaseURL
optional

URL for the release.
Example : URL

URL

version
required

Version for the product, e.g 6.7.0-11675023
Example : "string"

string

4.267. 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.268. 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

pscId
optional

PSC Name
Example : "string"

string

pscSsoSpec
optional

PSC SSO Domain
Example : PscSsoSpec

PscSsoSpec

4.269. PscSsoSpec

Spec contains parameters for Platform Services Controller SSO

Name Description Schema

ssoDomain
optional

PSC SSO Domain,its mandatory for secondary region and if deploying 2 PSC’s
Example : "string"

string

4.270. QueryInfo

Represents the query info.

Name Description Schema

completed
optional

Example : true

boolean

errorResponse
optional

Error response if the query has failed
Example : Error

Error

failure
optional

Example : true

boolean

processing
optional

Example : true

boolean

status
optional

Status of the query
Example : "string"

string

4.271. QueryResponseOfobject

Represents the concrete query response.

Name Description Schema

queryInfo
optional

Query info
Example : QueryInfo

QueryInfo

result
optional

Query result
Example : PageOfobject

PageOfobject

4.272. RefreshToken

This contains refresh token id for the user API access.

Name Description Schema

id
optional

Refresh token id that can be used to request new access token
Example : "string"

string

4.273. Release

Model for releases with their description and product version

Name Description Schema

bom
required

Release bill of materials
Example : [ "ProductVersion" ]

< ProductVersion > array

description
required

Release description with all major features.
Example : "string"

string

eol
optional

Release eol information e.g. 2020-06-08T02:20:15.844Z in yyyy-MM-dd’T’HH:mm:ss[.SSS]XXX ISO 8601 format
Example : "string"

string

minCompatibleVcfVersion
required

Minimum compatible VCF version, used to represent compatibility of SDDC Manager and VMware BOM components
Example : "string"

string

patchBundles
optional

List of patch bundles in this release
Example : [ "PatchBundle" ]

< PatchBundle > array

product
required

Name of the product e.g. "VCF"
Example : "string"

string

releaseDate
required

Release date e.g. 2020-06-08T02:20:15.844Z in yyyy-MM-dd’T’HH:mm:ss[.SSS]XXX ISO 8601 format
Example : "string"

string

updates
optional

Collection of release updates
Example : [ "ReleaseUpdate" ]

< ReleaseUpdate > array

version
required

Version of the release
Example : "string"

string

4.274. ReleaseUpdate

Update to a given release

Name Description Schema

baseProductVersion
required

Base product version for the release
Example : "string"

string

description
required

Description of the release update
Example : "string"

string

id
required

Release version
Example : "string"

string

productName
required

Product name for which the release update is provided
Example : "string"

string

releaseDate
required

Release date e.g. 2020-06-08T02:20:15.844Z in yyyy-MM-dd’T’HH:mm:ss[.SSS]XXX ISO 8601 format
Example : "string"

string

releaseUpdateURL
optional

URL to the release update
Example : URL

URL

4.275. 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.276. RemoteSiteSpec

Spec contains parameters for Remote site products

Name Description Schema

pscAddress
optional

Remote region vCenter address
Example : "string"

string

sslThumbprint
optional

Remote region vCenter SSL thumbprint (SHA256)
Example : "string"

string

vcCredentials
optional

Remote region vCenter credentials
Example : SddcCredentials

SddcCredentials

4.277. Resource

Represents the resource in the system

Name Description Schema

fqdn
optional

Resource FQDN
Example : "string"

string

name
optional

Name of the resource
Example : "string"

string

resourceId
required

Resource ID
Example : "string"

string

sans
optional

Subject alternative name(s)
Example : [ "string" ]

< string > array

type
required

Resource type
Example : "string"

string

4.278. 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.279. 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, VRA, WSA, VRSLCM, VXRAIL_MANAGER, BACKUP"

string

4.280. 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.281. ResourceUpgradeSpec

Resource Upgrade Specification

Name Description Schema

enableQuickboot
optional

Flag for requesting Quick Boot for ESXi upgrade
Example : true

boolean

personalitySpec
optional

Personality Specifications for vLCM based upgrade
Example : PersonalitySpec

PersonalitySpec

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.282. 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.283. Role

Represents role and its attributes

Name Description Schema

description
required

The description of the role
Example : "string"

string

id
required

The ID of the role
Example : "string"

string

name
required

The name of the role
Example : "string"

string

4.284. RoleReference

Represents a role reference

Name Description Schema

id
required

ID of the role
Example : "string"

string

4.285. RootCaCerts

Spec contains Root Certificate Authority parameters

Name Description Schema

alias
optional

Certificate alias
Example : "string"

string

certChain
optional

List of Base64 encoded certificates
Example : [ "string" ]

< string > array

4.286. SchemaRegistryServerInfo

Name Description Schema

hostAddress
optional

Example : "string"

string

port
optional

Example : 0

integer (int32)

protocol
optional

Example : "string"

string

4.287. SchemaRegistryServerInfoList

Name Description Schema

schemaRegistryServersInfo
optional

Example : [ "SchemaRegistryServerInfo" ]

< SchemaRegistryServerInfo > array

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

personalityName
optional

Cluster Personality Name
Example : "string"

string

resourcePoolSpecs
optional

Resource Pool Specs
Example : [ "ResourcePoolSpec" ]

< ResourcePoolSpec > array

vmFolders
optional

Virtual Machine folders map
Example : "One among:MANAGEMENT, NETWORKING, EDGENODES"

< string, string > map

4.289. SddcCredentials

Credentials contains the username and password

Name Description Schema

password
required

Password
Example : "Admin!23"

string

username
required

Username
Example : "root"

string

4.290. 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 (RSA SHA256)
Example : "string"

string

sslThumbprint
optional

Host SSL thumbprint (SHA256)
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.291. SddcManager

SDDC Manager representation

Name Description Schema

basicAuthDetails
optional

Basic auth details
Example : BasicAuthDetails

BasicAuthDetails

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.292. SddcManagerInfo

SDDC Manager Information

Name Description Schema

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.293. SddcManagerSpec

Client input parameters for SDDC Manager Virtual Machine

Name Description Schema

hostname
required

SDDC Manager 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

localUserPassword
optional

The local account is a built-in admin account in VCF that can be used in emergency scenarios. The password of this account must be at least 12 characters long. It also must contain at-least 1 uppercase, 1 lowercase, 1 special character specified in braces [!%@$^#?] and 1 digit. In addition, a character cannot be repeated more than 3 times consecutively.
Example : "string"

string

netmask
required

SDDC Manager netmask
Example : "string"

string

rootUserCredentials
required

Root user credentials for the SDDC Manager VM, UserName must be root. Password needs to be a strong password with at least one alphabet and one special character and at least 8 characters in length.
Example : SddcCredentials

SddcCredentials

secondUserCredentials
required

Second user credentials for the SDDC Manager VM, UserName must be vcf. Password needs to be a strong password with at least one alphabet and one special character and at least 8 characters in length.
Example : SddcCredentials

SddcCredentials

4.294. 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, MANAGEMENT, UPLINK01, UPLINK02, X_REGION, REGION_SPECIFIC, NSXT_EDGE_TEP or any custom network type"

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.295. SddcNsxtEdgeNodeSpec

NSX-T edge node specification. Deprecated as of 4.3, Bringup AVN has been deprecated. Instead use DAY-N AVN workflow.

Name Description Schema

edgeNodeHostname
required

NSX-T edge node fqdn
Example : "string"

string

edgeNodeName
required

NSX-T edge node name
Example : "string"

string

edgeVtep1Cidr
required

NSX-T edge node vtep 1 cidr
Example : "string"

string

edgeVtep2Cidr
required

NSX-T edge node vtep 2 cidr
Example : "string"

string

interfaces
required

NSX-T edge node interfaces
Example : [ "NsxtInterface" ]

< NsxtInterface > array

managementCidr
required

NSX-T edge node management cidr
Example : "string"

string

4.296. SddcNsxtEdgeServicesSpec

NSX-T Edge Services Specification. Deprecated as of 4.3, Bringup AVN has been deprecated. Instead use DAY-N AVN workflow.

Name Description Schema

tier0GatewayName
optional

NSX-T Edge Tier-0 Gateway Name
Example : "string"

string

tier1GatewayName
optional

NSX-T Edge Tier-1 Gateway Name
Example : "string"

string

4.297. SddcNsxtSpec

Spec contains parameters for NSX-T deployment and configurations

Name Description Schema

ipAddressPoolSpec
optional

NSX-T IP address pool specification
Example : IpAddressPoolSpec

IpAddressPoolSpec

logicalSegments
optional

NSX-T logical segment. Deprecated as of 4.3, Bringup AVN has been deprecated. Instead use DAY-N AVN workflow.
Example : [ "NsxtLogicalSegment" ]

< NsxtLogicalSegment > array

nsxtAdminPassword
optional

NSX-T admin 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 consectively.
Example : "string"

string

nsxtAuditPassword
optional

NSX-T audit 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 consectively.
Example : "string"

string

nsxtEdgeSpec
optional

NSX-T edge specification. Deprecated as of 4.3, Bringup AVN has been deprecated. Instead use DAY-N AVN workflow.
Example : NsxtEdgeSpec

NsxtEdgeSpec

nsxtLicense
required

NSX-T Manager license
Example : "string"

string

nsxtManagerSize
required

NSX-T Manager size
Example : "One among:medium, large"

string

nsxtManagers
required

NSX-T Managers
Example : [ "NsxtManagerSpec" ]

< NsxtManagerSpec > array

overLayTransportZone
optional

NSX-T OverLay Transport zone
Example : NsxtTransportZone

NsxtTransportZone

rootLoginEnabledForNsxtManager
optional

If true, allow root login for NSX-T Manager and deny if false
Example : true

boolean

rootNsxtManagerPassword
required

NSX-T Manager root 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
Example : "string"

string

sshEnabledForNsxtManager
optional

If true, enable SSH for NSX-T Manager and disable if false
Example : true

boolean

transportVlanId
optional

Transport VLAN ID
Example : 0

integer (int32)

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

vlanTransportZone
optional

NSX-T VLAN transport zone
Example : NsxtTransportZone

NsxtTransportZone

4.298. SddcSpec

Spec contains parameters for creating/bringing up an SDDC

Name Description Schema

ceipEnabled
optional

Enable VCF Customer Experience Improvement Program
Example : true

boolean

certificatesPassphrase
optional

Passphrase for the vCenter / NSX certificates
Example : "string"

string

clusterSpec
required

Cluster Spec
Example : SddcClusterSpec

SddcClusterSpec

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, 7.0.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, EBGP"

< string > array

fipsEnabled
optional

Enable Federal Information Processing Standards
Example : true

boolean

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

nsxtSpec
optional

NSX-T Spec
Example : SddcNsxtSpec

SddcNsxtSpec

ntpServers
required

List of NTP servers
Example : [ "string" ]

< string > array

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. Used for management domain name. Can contain only letters, numbers and the following symbols: '-'.
Length : 3 - 20
Example : "sfo01-m01"

string

sddcManagerSpec
optional

SDDC Manager Virtual Machine spec
Example : SddcManagerSpec

SddcManagerSpec

securitySpec
optional

Security spec
Example : SecuritySpec

SecuritySpec

shouldCleanupVsan
optional

Flag indicating whether cleanup vSAN should be ran
Example : false

boolean

skipEsxThumbprintValidation
optional

Skip ESXi thumbprint validation
Example : true

boolean

skipGatewayPingValidation
optional

Skip VSAN / VMOTION networks gateway connectivity validation
Example : true

boolean

taskName
required

Name of the task to execute
Example : "workflowconfig/workflowspec-ems.json"

string

vcenterSpec
required

vCenter Spec
Example : SddcVcenterSpec

SddcVcenterSpec

vsanSpec
optional

VSAN Spec
Example : VsanSpec

VsanSpec

vxManagerSpec
optional

VxManager Spec
Example : VxManagerSpec

VxManagerSpec

4.299. 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.300. 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.301. 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

sshThumbprint
optional

vCenter Server SSH thumbprint (RSA SHA256)
Example : "string"

string

sslThumbprint
optional

vCenter Server SSL thumbprint (SHA256)
Example : "string"

string

storageSize
optional

vCenter VM storage size
Example : "One among:lstorage, xlstorage"

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.302. SecuritySpec

Spec contains security settings

Name Description Schema

esxiCertsMode
optional

ESXi certificates mode
Example : "One among:Custom, VMCA"

string

rootCaCerts
optional

Root Certificate Authority certificate list
Example : [ "RootCaCerts" ]

< RootCaCerts > array

4.303. SharesInfo

Specify relative allocation between resource consumers

Name Description Schema

level
optional

The allocation level
Example : "One among: low, normal, high, custom"

string

shares
optional

The number of shares allocated
Example : 0

integer (int32)

4.304. 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.305. SoftwareInfo

SoftwareSpec contains base os, components, hardware support, addOn metadata to install/update the appropriate Cloud Foundation software components in your management domain or workload domain.

Name Description Schema

addOn
optional

Personality addOn
Example : AddOnInfo

AddOnInfo

baseImage
required

Personality base image
Example : BaseImageInfo

BaseImageInfo

components
optional

Personality components
Example : {
"string" : "ComponentInfo"
}

< string, ComponentInfo > map

hardwareSupport
optional

Personality hardware support
Example : HardwareSupportInfo

HardwareSupportInfo

4.306. SsoDomainEntity

Represents SSO domain entity

Name Description Schema

id
optional

The ID of the SSO domain entity
Example : "string"

string

name
optional

The name of the SSO domain entity
Example : "string"

string

type
required

The type of the SSO domain entity
Example : "One among: USER, GROUP"

string

4.307. StackTraceElement

Name Description Schema

className
optional

Example : "string"

string

fileName
optional

Example : "string"

string

lineNumber
optional

Example : 0

integer (int32)

methodName
optional

Example : "string"

string

nativeMethod
optional

Example : true

boolean

4.308. Stage

Represents a Stage

Name Description Schema

completionTimestamp
optional

Example : "string"

string

creationTimestamp
optional

Example : "string"

string

description
optional

Stage description
Example : "string"

string

errors
optional

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

< Error > array

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.309. 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.310. StorageContainer

Storage container representation

Name Description Schema

clusterId
optional

ID of the cluster which is using the storage container
Example : "string"

string

id
optional

ID of the storage container
Example : "string"

string

name
required

Name of the storage container
Example : "string"

string

protocolType
required

Storage protocol type
Example : "One among: ISCSI, FC, NFS"

string

4.311. StorageContainerUpdateSpec

Represents a storage container update specification

Name Description Schema

name
required

Name of the storage container
Example : "string"

string

4.312. StorageInfo

Represents a storage metric with used and total for a resource

Name Description Schema

total
optional

Total value
Example : DataMetric

DataMetric

used
optional

Used value
Example : DataMetric

DataMetric

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

subTasks
optional

List of child subtasks associated with this subtask
Example : [ "SubTask" ]

< SubTask > array

type
optional

Sub-task type
Example : "string"

string

4.314. 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.315. Throwable

Name Description Schema

localizedMessage
optional

Example : "string"

string

message
optional

Example : "string"

string

stackTrace
optional

Example : [ "StackTraceElement" ]

< StackTraceElement > array

suppressed
optional

Example : [ "Throwable" ]

< Throwable > array

4.316. TimeZone

Name Description Schema

displayName
optional

Example : "string"

string

dstsavings
optional

Example : 0

integer (int32)

id
optional

Example : "string"

string

rawOffset
optional

Example : 0

integer (int32)

4.317. TokenCreationSpec

This specification contains user details to create authentication token.

Name Description Schema

apiKey
optional

API Key
Example : "string"

string

password
optional

User Password
Example : "string"

string

username
optional

Username
Example : "string"

string

4.318. TokenPair

This contains the access token and the refresh token for the user API access.

Name Description Schema

accessToken
optional

Bearer token that can be used to make public API calls
Example : "string"

string

refreshToken
optional

Refresh token that can be used to request new access token
Example : RefreshToken

RefreshToken

4.319. TrustedCertificateSpec

This specification contains certificate & certificate usage

Name Description Schema

certificate
required

Certificate in one-line PEM format
Example : "string"

string

certificateUsageType
required

Certificate usage
Example : "One among: TRUSTED_FOR_OUTBOUND, TRUSTED_FOR_INBOUND"

string

4.320. URL

Name Description Schema

authority
optional

Example : "string"

string

content
optional

Example : "object"

object

defaultPort
optional

Example : 0

integer (int32)

file
optional

Example : "string"

string

host
optional

Example : "string"

string

path
optional

Example : "string"

string

port
optional

Example : 0

integer (int32)

protocol
optional

Example : "string"

string

query
optional

Example : "string"

string

ref
optional

Example : "string"

string

userInfo
optional

Example : "string"

string

4.321. URLStreamHandler

4.322. UnmanagedResourceCredential

Represents credentials of am unmanaged resource (i.e a resource that is not managed by VCF)

Name Description Schema

credentialType
required

Credential type
Example : "One among: SSH"

string

password
optional

Password
Example : "string"

string

username
required

Username
Example : "string"

string

4.323. 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.324. UpgradablesClusterResource

Upgradables clusters details with hardware support managers

Name Description Schema

availableHardwareSupportManagers
optional

Available Hardware Support Managers for Firmware upgrade
Example : [ "HardwareSupportPackages" ]

< HardwareSupportPackages > array

configuredHardwareSupportManagers
optional

Configured Hardware Support Managers for Firmware upgrade
Example : [ "HardwareSupportPackage" ]

< HardwareSupportPackage > array

primaryCluster
optional

Flag for primary cluster
Example : true

boolean

resourceId
required

Resource Id
Example : "string"

string

resourceType
required

Resource Type
Example : "CLUSTER"

string

softwareInfo
optional

Software Spec contains base image, addOn, and components details
Example : SoftwareInfo

SoftwareInfo

vlcmEnabled
optional

Flag to determine if vLCM enabled on the cluster
Example : true

boolean

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

NSX-T upgrade specifications
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.326. UpgradeCommitSpec

Upgrade Commit Specification

Name Description Schema

scheduledTimestamp
optional

Upgrade Scheduled Time
Example : "string"

string

upgradeNow
optional

Flag for enabling Upgrade Now. If true, scheduledTimestamp is ignored
Example : true

boolean

4.327. UpgradeSpec

Upgrade Specification

Name Description Schema

bundleId
required

Bundle ID for Upgrade
Example : "string"

string

draftMode
optional

Boolean to represent upgrade will be created in DRAFT mode. This allows to run prechecks before user confirm/commit the upgrade.
Example : true

boolean

nsxtUpgradeUserInputSpecs
optional

Resource Upgrade Specifications for NSXT 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.328. User

Represents user and its attributes

Name Description Schema

apiKey
optional

The API key of the user
Example : "string"

string

creationTimestamp
optional

The timestamp at which the user was created
Example : "string"

string

domain
optional

The domain of the user
Example : "string"

string

id
optional

The ID of the user
Example : "string"

string

name
required

The name of the user
Example : "string"

string

role
required

The role of the user
Example : RoleReference

RoleReference

type
required

The type of the user
Example : "One among: USER, GROUP, SERVICE"

string

4.329. VMNicInfo

VMNics attached to an ESXi host reference

Name Description Schema

isActive
optional

Status of VMNic if active or inactive
Example : true

boolean

isAutoNegotiateSupported
optional

Status of VMNic if auto negotiate is supported or not
Example : true

boolean

isInUse
optional

Status of VMNic if in use or available
Example : true

boolean

linkSpeedMB
optional

VMNic link speed in MB
Example : 0

integer (int32)

name
optional

Name of the VMNic
Example : "string"

string

4.330. VSANNetworkSpec

Contains the vSAN Network details

Name Description Schema

vsanCidr
optional

vSAN subnet cidr of the ESXi host
Example : "string"

string

vsanGatewayIP
optional

vSAN Gateway IP of the ESXi host
Example : "string"

string

4.331. Validation

Represents a validation with a list of one or more validation checks that are performed as part of the validation

Name Description Schema

additionalProperties
optional

Example : {
"string" : "string"
}

< string, string > map

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, CANCELLATION_IN_PROGRESS"

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, CANCELLATION_IN_PROGRESS"

string

validationChecks
optional

List of one or more validation checks that are performed as part of the validation
Example : [ "ValidationCheck" ]

< ValidationCheck > array

4.332. 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: IN_PROGRESS, SUCCEEDED, FAILED, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS"

string

severity
optional

Severity of the validation check
Example : "One among: WARNING, ERROR, INFO"

string

4.333. VasaProvider

VASA Provider representation

Name Description Schema

id
optional

ID of the VASA Provider
Example : "string"

string

name
required

Name of the VASA Provider
Example : "string"

string

storageContainers
required

List of storage containers associated with the VASA Provider
Example : [ "StorageContainer" ]

< StorageContainer > array

url
required

URL of the VASA Provider
Example : "string"

string

users
required

List of users associated with the VASA Provider
Example : [ "VasaUser" ]

< VasaUser > array

4.334. VasaProviderSpec

This specification contains cluster storage configuration for vVol

Name Description Schema

storageContainerId
required

UUID of the VASA storage container
Example : "string"

string

storageProtocolType
required

Type of the VASA storage protocol
Example : "One among: ISCSI, NFS, FC"

string

userId
required

UUID of the VASA storage user
Example : "string"

string

vasaProviderId
required

UUID of the VASA storage provider
Example : "string"

string

4.335. VasaProviderUpdateSpec

Represents a VASA Provider update specification

Name Description Schema

name
optional

Name of the VASA Provider
Example : "string"

string

url
optional

URL of the VASA Provider
Example : "string"

string

4.336. VasaUser

VASA User representation

Name Description Schema

id
optional

ID of the VASA User
Example : "string"

string

password
required

Password
Example : "string"

string

username
required

VASA User name
Example : "string"

string

4.337. VasaUserUpdateSpec

Represents a VASA User update specification

Name Description Schema

password
optional

Password
Example : "string"

string

username
optional

VASA User name
Example : "string"

string

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

version
optional

Version of the vCenter
Example : "string"

string

4.339. 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.340. 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

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

storageSize
optional

VCenter storage size
Example : "One among:lstorage, xlstorage"

string

vmSize
optional

VCenter VM size
Example : "One among:xlarge, large, medium, small, tiny"

string

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

status
optional

Status of the service
Example : "string"

string

version
optional

Version of the service
Example : "string"

string

4.342. Vds

vSphere distributed switch

Name Description Schema

id
optional

vSphere Distributed Switch id
Example : "string"

string

isUsedByNsxt
optional

Boolean to identify if the vSphere distributed switch is used by NSX-T
Example : true

boolean

mtu
optional

Maximum Transmission Unit
Example : 0

integer (int32)

name
required

vSphere Distributed Switch name
Example : "string"

string

niocBandwidthAllocations
optional

List of Network I/O Control Bandwidth Allocations for System Traffic
Example : [ "NiocBandwidthAllocation" ]

< NiocBandwidthAllocation > array

portGroups
optional

List of portgroups associated with the vSphere Distributed Switch
Example : [ "Portgroup" ]

< Portgroup > array

4.343. VdsSpec

This specification contains vSphere distributed switch configurations

Name Description Schema

isUsedByNsxt
optional

Boolean to identify if the vSphere distributed switch is used by NSX-T
Example : true

boolean

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
optional

List of portgroups to be associated with the vSphere Distributed Switch
Example : [ "PortgroupSpec" ]

< PortgroupSpec > array

4.344. 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.345. 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

targetVcfVersion
optional

If this field is set, LCM will calculate and update version aliases based on current deployment VCF version and the provided target VCF version
Example : "string"

string

versionAliasesForBundleComponentTypes
optional

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

< VersionAliasesForBundleComponentType > array

4.346. 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.347. VmfsDatastoreSpec

Cluster storage configuration for VMFS

Name Description Schema

fcSpec
optional

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

< FcSpec > array

4.348. Vra

Spec contains parameters of a vRealize Automation instance

Name Description Schema

id
optional

The ID of the vRealize Automation instance
Example : "string"

string

loadBalancerFqdn
optional

The Fully Qualified Domain Name of the vRealize Automation load balancer
Example : "vra-lb.vrack.vsphere.local"

string

loadBalancerIpAddress
optional

The IP address of the vRealize Automation load balancer
Example : "10.0.0.15"

string

nodes
optional

The nodes of the vRealize Automation instance
Example : [ "VrealizeProductNode" ]

< VrealizeProductNode > array

status
optional

The status of the vRealize Automation instance
Example : "ACTIVE, ERROR"

string

version
optional

The version of the vRealize Automation instance
Example : "8.1.0-13036238"

string

4.349. 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 : "vrealize.node.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.350. 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

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

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

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.352. 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 : "vrealize.node.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.353. 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.354. 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

nsxtStandaloneTier1Ip
required

The IP to use for deploying a new standalone Tier-1 router in NSX-T. This router will be used subsequently for vrealize load balancers.
Example : "string"

string

sshPassword
required

The password for a root user of vRealize Suite Lifecycle Manager appliance
Example : "string"

string

4.355. 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.356. 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.357. VvolDatastoreSpec

This specification contains cluster storage configuration for vVol

Name Description Schema

name
required

Name of the datastore
Example : "string"

string

vasaProviderSpec
required

Vasa Provider spec
Example : VasaProviderSpec

VasaProviderSpec

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

sshThumbprint
optional

VxRail Manager SSH thumbprint (RSA SHA256)
Example : "string"

string

sslThumbprint
optional

VxRail Manager SSL thumbprint (SHA256)
Example : "string"

string

vxManagerHostName
required

VxManager host name
Example : "string"

string

4.359. VxRailDetails

Contains the VxRail Manager details

Name Description Schema

adminCredentials
optional

VxRail Manager admin credentials
Example : UnmanagedResourceCredential

UnmanagedResourceCredential

dnsName
optional

DNS Name/Hostname of the VxRail Manager
Example : "string"

string

ipAddress
optional

IP Address of the VxRail Manager
Example : "string"

string

networks
optional

Network details of the VxRail Manager
Example : [ "Network" ]

< Network > array

nicProfile
optional

Nic Profile Type
Example : "string"

string

rootCredentials
optional

VxRail Manager root credentials
Example : UnmanagedResourceCredential

UnmanagedResourceCredential

sshThumbprint
optional

SSH thumbprint of the VxRail Manager
Example : "string"

string

sslThumbprint
optional

SSL thumbprint of the VxRail Manager
Example : "string"

string

4.360. 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.361. Wsa

Spec contains parameters of a vRealize Automation instance

Name Description Schema

id
optional

The ID of the Workspace ONE Access instance
Example : "string"

string

loadBalancerFqdn
optional

The Fully Qualified Domain Name of the Workspace ONE Access load balancer
Example : "wsa-lb.vrack.vsphere.local"

string

loadBalancerIpAddress
optional

The IP address of the Workspace ONE Access load balancer
Example : "10.0.0.15"

string

nodes
optional

The nodes of the Workspace ONE Access instance
Example : [ "VrealizeProductNode" ]

< VrealizeProductNode > array

status
optional

The status of the Workspace ONE Access instance
Example : "ACTIVE, ERROR"

string

version
optional

The version of the Workspace ONE Access instance
Example : "8.1.0-13036238"

string

4.362. WsaProductSpec

Spec contains information for a vRealize product

Name Description Schema

adminCredentials
required

The credentials of the vRealize product Admin
Example : CredentialsSpec

CredentialsSpec

certificateChain
optional

The certificate chain of the vRealize product.
Example : "string"

string

defaultAdminCredentials
required

Default admin credentials for Workspace ONE Access
Example : CredentialsSpec

CredentialsSpec

id
optional

The ID of the product
Example : "string"

string

loadBalancerFqdn
required

Fully Qualified Domain Name for the vRealize product load balancer
Example : "string"

string

nodes
required

The nodes of the vRealize product instance
Example : [ "ProductNode" ]

< ProductNode > array

type
required

The type of the Workspace ONE Access instance
Example : "string"

string

version
required

The version of the vRealize product instance
Example : "string"

string

4.363. 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.364. ZookeeperServerInfoList

Name Description Schema

zookeeperServersInfo
optional

Example : [ "ZookeeperServerInfo" ]

< ZookeeperServerInfo > array