VMware Cloud Provider Lifecycle Manager API Data Structures
{
"productVersion": "string",
"buildNumber": "string",
"interopVersion": "string",
"interopBuildNumber": "string",
"apiVersions": [
{
"apiVersion": "string",
"deprecated": "boolean"
}
]
}
The version of the VCP LCM instance.
The build number of the VCP LCM instance.
The version of the installed interop bundle of the VCP LCM instance.
The build number of the installed interop bundle of the VCP LCM instance.
List of available API versions.
{
"apiVersion": "string",
"deprecated": "boolean"
}
The version of the API.
Flag indicating whether the API version is deprecated or fully supported.
List of integrations to configure for the product
{
"integrationId": "string",
"integrationUsername": "string",
"integrationPassword": "string",
"status": "string",
"ref": "string",
"version": "string"
}
Additional properties
ID of an integration.
Username for an integration.
Password for an integration.
Whether the declared integration matches what is actually in the environment.
Reference to the registered entity.
Version of the product or component of the integration.
{
"validFrom": "string",
"validTo": "string",
"thumbprint": "string",
"certificate": "string",
"privateKey": "string",
"keyPassword": "string"
}
The certificate's validity start date
The certificate's validity end date
The certificate thumbprint
Certificate (single or chain) in PEM format.
Private key in PEM format.
The password for the private key
{
"certificate": {
"validFrom": "string",
"validTo": "string",
"thumbprint": "string"
}
}
{
"certificate": {
"validFrom": "string",
"validTo": "string",
"thumbprint": "string"
},
"transportZones": [
{
"id": "string",
"display_name": "string"
}
],
"t0Gateways": [
{
"id": "string",
"display_name": "string"
}
]
}
{
"certificate": {
"validFrom": "string",
"validTo": "string",
"thumbprint": "string"
}
}
Certificate of the registered datacenter component. Will be discovered by VCP LCM.
{
"validFrom": "string",
"validTo": "string",
"thumbprint": "string"
}
The certificate's validity start date
The certificate's validity end date
The certificate thumbprint
{
"componentName": "string",
"version": "string",
"datacenterComponentType": "string",
"fqdn": "string",
"username": "string",
"password": "string",
"content": {
"certificate": {
"validFrom": "string",
"validTo": "string",
"thumbprint": "string"
}
},
"purpose": "string"
}
Additional properties
The component name is the identifier for the datacenter component.
The version of the datacenter component.
The type of the datacenter component.
The FQDN or IP of the datacenter component.
The username to authenticate with the datacenter component.
The username to authenticate with the datacenter component.
The specified purpose of the datacenter component, defining how this component will be used (e.g. for management or resource purposes).
{
"componentName": "string",
"version": "string",
"datacenterComponentType": "string",
"fqdn": "string",
"username": "string",
"password": "string",
"content": {
"certificate": {
"validFrom": "string",
"validTo": "string",
"thumbprint": "string"
}
},
"purpose": "string"
}
Additional properties
The component name is the identifier for the datacenter component.
The version of the datacenter component.
The type of the datacenter component.
The FQDN or IP of the datacenter component.
The username to authenticate with the datacenter component.
The username to authenticate with the datacenter component.
The specified purpose of the datacenter component, defining how this component will be used (e.g. for management or resource purposes).
Additional content of the datacenter component.
{
"certificate": {
"validFrom": "string",
"validTo": "string",
"thumbprint": "string"
}
}
Additional content of the datacenter component.
{
"certificate": {
"validFrom": "string",
"validTo": "string",
"thumbprint": "string"
}
}
Tier 0 gateways defined in NSX-T.
{
"id": "string",
"display_name": "string"
}
NSX-T t0 gateway id.
NSX-T t0 gateway name.
Transport zones defined in NSX-T.
{
"id": "string",
"display_name": "string"
}
NSX-T transport zone id.
NSX-T transport zone display name.
Additional network settings for this NIC.
{
"portGroupName": "string",
"gateway": "string",
"subnetMask": "string",
"domainName": "string",
"searchPath": [
"string"
],
"useDhcp": "boolean",
"dns": [
"string"
],
"ntp": [
"string"
]
}
vCenter port group name.
Gateway to be used for network's subnet.
Subnet mask to be used for network's subnet.
Domain name to be used for network's subnet.
Domain search path to be used for network's subnet.
Flag indicating whether to use DHCP in the subnet.
List of DNS servers for network's subnet.
List of NTP servers for network's subnet.
{
"certificate": {
"validFrom": "string",
"validTo": "string",
"thumbprint": "string"
},
"networks": [
{
"portGroupName": "string",
"gateway": "string",
"subnetMask": "string",
"domainName": "string",
"searchPath": [
"string"
],
"useDhcp": "boolean",
"dns": [
"string"
],
"ntp": [
"string"
]
}
],
"clusters": [
"string"
],
"resourcePools": [
"string"
],
"datastores": [
"string"
],
"datacenters": [
"string"
]
}
List of networks (port groups) defined in vCenter. The networks are discovered automatically by VCP LCM, but additional IP settings can be added to these networks.
List of clusters defined in vCenter. Will be auto discovered by VCP LCM.
List of resource pools defined in vCenter. Will be auto discovered by VCP LCM.
List of datastores defined in vCenter. Will be auto discovered by VCP LCM.
List of datacenters defined in vCenter. Will be auto discovered by VCP LCM.
The target vCenter to deploy the node - to be defined either on product or node level.
{
"vcenterName": "string",
"datacenterName": "string",
"clusterName": "string",
"resourcePool": "string",
"vmFolder": "string",
"datastoreNames": [
"string"
]
}
A name to identify the vCenter instance.
Datacenter to deploy in.
Cluster to deploy in.
Resource pool to deploy in.
vmFolder to deploy in.
Datastore to deploy in.
The deployment infrastructure defining the target infrastructure to deploy in.
{
"vcenter": {
"vcenterName": "string",
"vcenterHost": "string",
"vcenterUsername": "string",
"vcenterPassword": "string",
"datacenterName": "string",
"clusterName": "string",
"datastores": [
"string"
],
"folderName": "string",
"resourcePool": "string"
},
"nsxt": {
"nsxVip": "string",
"nsxManagerIp": "string",
"nsxRootPassword": "string",
"nsxCliPassword": "string"
}
}
Configuration of email notifications.
{
"enabled": "boolean",
"smtpServer": "string",
"smtpPort": "integer",
"smtpUsername": "string",
"smtpPassword": "string",
"useTls": "boolean",
"useSsl": "boolean",
"useProxy": "boolean",
"senderAddress": "string",
"emailSubjectTemplate": "string",
"emailContentTemplate": "string",
"receiverAddresses": [
"string"
]
}
Enable or disable Email notifications.
The host of the sender.
The port used for mails. Dafault: 25.
Optional. The username to authenticate with the SMTP server. If not set, no authentication will be used.
Optional. The password to authenticate with the SMTP server. If not set, no authentication will be used.
Define whether to use TLS or not.
Define whether to use SSL or not.
Enable to use the system-specified proxy for sending emails.
The email address to send notification emails with.
An email subject to use for email notifications.
The content to add to the email notifications' body.
The email addresses of recivers for notifications.
The environment specification defining the environment and products to deploy.
{
"environmentName": "string",
"environmentId": "string",
"environmentState": "string",
"products": [
{
"productType": "string",
"productId": "string",
"version": "string",
"buildNumber": "string",
"productInternalId": "string",
"license": "string",
"adminPassword": "string",
"integrations": [
{
"integrationId": "string",
"integrationUsername": "string",
"integrationPassword": "string",
"status": "string",
"ref": "string",
"version": "string"
}
],
"infraReference": "string",
"nodes": [
{
"nodeId": "integer",
"isPrimary": "boolean",
"cpuNum": "integer",
"ramMemory": "integer",
"hostName": "string",
"vmName": "string",
"deploymentOption": "string",
"datastoreName": "string",
"clusterName": "string",
"resourcePool": "string",
"datacenterName": "string",
"rootPassword": "string",
"gateway": "string",
"nics": [
{
"ipAddress": "string",
"networkName": "string",
"staticRoutes": [
"string"
]
}
]
}
]
}
]
}
Additional properties
Name of an environment. If no ID is specified, this name will be normalized and used as ID.
ID of an environment.
The state of the environment - will be discovered by VCP LCM.
The deployment infrastructure defining the target infrastructure to deploy in.
The environment specification defining the environment and products to deploy.
{
"environmentName": "string",
"environmentId": "string",
"environmentState": "string",
"products": [
{
"productType": "string",
"productId": "string",
"version": "string",
"buildNumber": "string",
"productInternalId": "string",
"license": "string",
"adminPassword": "string",
"integrations": [
{
"integrationId": "string",
"integrationUsername": "string",
"integrationPassword": "string",
"status": "string",
"ref": "string",
"version": "string"
}
],
"deployment": {
"vcenterName": "string",
"datacenterName": "string",
"clusterName": "string",
"resourcePool": "string",
"vmFolder": "string",
"datastoreNames": [
"string"
]
},
"endpointAddress": "string",
"status": {
"status": "string",
"messages": [
"string"
],
"lastDiscovery": "string"
},
"nodes": [
{
"nodeId": "integer",
"isPrimary": "boolean",
"cpuNum": "integer",
"ramMemory": "integer",
"hostName": "string",
"vmName": "string",
"deploymentOption": "string",
"datastoreName": "string",
"clusterName": "string",
"resourcePool": "string",
"datacenterName": "string",
"rootPassword": "string",
"gateway": "string",
"deployment": {
"vcenterName": "string",
"datacenterName": "string",
"clusterName": "string",
"resourcePool": "string",
"vmFolder": "string",
"datastoreNames": [
"string"
]
},
"nics": [
{
"ipAddress": "string",
"networkName": "string",
"staticRoutes": [
"string"
],
"dcVcenterNetworksSpec": {
"portGroupName": "string",
"gateway": "string",
"subnetMask": "string",
"domainName": "string",
"searchPath": [
"string"
],
"useDhcp": "boolean",
"dns": [
"string"
],
"ntp": [
"string"
]
}
}
]
}
]
}
],
"environmentType": "string"
}
Additional properties
Name of an environment. If no ID is specified, this name will be normalized and used as ID.
ID of an environment.
The state of the environment - will be discovered by VCP LCM.
The type of this environment - production or nonproduction.
The interop bundle file.
{
"bundle_file": "string"
}
bundle_file
Certificates of the product
{
"validFrom": "string",
"validTo": "string",
"thumbprint": "string",
"status": {
"status": "string",
"expirationDays": "integer"
}
}
The date that the certificate validity starts from.
The date that the certificate validity ends.
The certificate's thumbprint.
{
"fileName": "string",
"sha1checksum": "string",
"sha256checksum": "string",
"md5checksum": "string",
"buildNumber": "string",
"releaseDate": "string",
"description": "string",
"fileSize": "string",
"title": "string",
"version": "string",
"url": "string"
}
The filename of the new interop bundle
The SHA-1 checksum of the new interop bundle
The SHA-256 checksum of the new interop bundle
The MD5 checksum of the new interop bundle
The build number of the new interop bundle
The release date of the new interop bundle
The description of the new interop bundle
The file size of the new interop bundle
The name of the new interop bundle
The version of the new interop bundle
The URL to download the new interop bundle from
The expiration status of the root password.
{
"status": "string",
"expirationDays": "integer"
}
The current status of the expiring item.
Number of days left until expiration
List of nodes of the product
{
"nodeId": "integer",
"hostName": "string",
"rootPasswordExpiration": "string",
"status": {
"status": "string",
"expirationDays": "integer"
}
}
The ID of the node.
Hostname of the node.
The date that the root password expires.
Status of the product.
{
"overallStatus": "string",
"interopStatus": "string",
"passwordStatus": "string",
"certificateStatus": "string"
}
The overall status of the product.
The current status of interoperability with other products.
The current status of the product's passwords.
The current status of the product's certificates.
List of products, extensions or infrastructure components related to this product
{
"type": "string",
"endpointAddress": "string",
"versionInfo": {
"version": "string",
"buildNumber": "string",
"availableNewerVersions": [
"string"
]
},
"status": {
"overallStatus": "string",
"interopStatus": "string",
"passwordStatus": "string",
"certificateStatus": "string"
},
"relationship": "string"
}
Product or datacenter component type type, defining the type of application to integrate with (VCD, USAGE, RMQ, VROPSTA, VCENTER, NSXT, etc...).
The hostname or IP of the product (or load balancer)
Certificates of the product
The relationship to this item.
The specified product for the report.
{
"productType": "string",
"environmentId": "string",
"productId": "string",
"endpointAddress": "string",
"currentVersionInfo": {
"version": "string",
"buildNumber": "string",
"availableNewerVersions": [
"string"
]
},
"status": {
"overallStatus": "string",
"interopStatus": "string",
"passwordStatus": "string",
"certificateStatus": "string"
},
"nodes": [
{
"nodeId": "integer",
"hostName": "string",
"rootPasswordExpiration": "string",
"status": {
"status": "string",
"expirationDays": "integer"
}
}
],
"targetVersionInfo": {
"version": "string",
"buildNumber": "string",
"availableNewerVersions": [
"string"
]
},
"relations": [
{
"type": "string",
"endpointAddress": "string",
"versionInfo": {
"version": "string",
"buildNumber": "string",
"availableNewerVersions": [
"string"
]
},
"status": {
"overallStatus": "string",
"interopStatus": "string",
"passwordStatus": "string",
"certificateStatus": "string"
},
"relationship": "string"
}
]
}
Product type, defining the type of application to integrate with (VCD, USAGE, RMQ, VROPSTA).
ID of an environment that the product is part of.
Product ID used to identify the product within an environment.
The hostname or IP of the product (or load balancer)
Certificates of the product
List of products, extensions or infrastructure components related to this product
Info about the product version specified for this report.
{
"version": "string",
"buildNumber": "string",
"availableNewerVersions": [
"string"
]
}
Version of the product to deploy or import.
Build number of the product, to be set automatically during discovery.
List of versions that this product with this version can be upgraded to.
{
"token": "string"
}
The JWT token to be used for authentication in subsequent requests.
The credentials to log in to VCP LCM.
{
"username": "string",
"password": "string"
}
The username to log in with.
The password to log in with.
List of networks (defining port groups and related subnets) used for deployments.
{
"portGroupName": "string",
"gateway": "string",
"subnetMask": "string",
"domainName": "string",
"searchPath": [
"string"
],
"useDhcp": "boolean",
"dns": [
"string"
],
"ntp": [
"string"
]
}
vCenter port group name.
Gateway to be used for network's subnet.
Subnet mask to be used for network's subnet.
Domain name to be used for network's subnet.
Domain search path to be used for network's subnet.
Flag indicating whether to use DHCP in the subnet.
List of DNS servers for network's subnet.
List of NTP servers for network's subnet.
List of NICs to configure for the VM.
{
"ipAddress": "string",
"networkName": "string",
"staticRoutes": [
"string"
]
}
IP address to set for the NIC.
Name of the network defined in the deployment infrastructure's vCenter networks. Note: This is not a VC port group but refers to the definition of the network that specifies the port group.
List of static routes to configure for the NIC.
List of NICs to configure for the VM.
{
"ipAddress": "string",
"networkName": "string",
"staticRoutes": [
"string"
],
"dcVcenterNetworksSpec": {
"portGroupName": "string",
"gateway": "string",
"subnetMask": "string",
"domainName": "string",
"searchPath": [
"string"
],
"useDhcp": "boolean",
"dns": [
"string"
],
"ntp": [
"string"
]
}
}
IP address to set for the NIC.
Name of the network defined in the deployment infrastructure's vCenter networks. Note: This is not a VC port group but refers to the definition of the network that specifies the port group.
List of static routes to configure for the NIC.
{
"id": "integer",
"creationDate": "string",
"title": "string",
"content": "string",
"status": "string",
"type": "string",
"metadata": {
"environmentId": "string",
"productId": "string",
"taskId": "string",
"subProperty": [
"string"
]
}
}
The notification ID.
The notification creation date.
Title of the notification.
Content of the notification.
The notification status.
The notification type.
The new configuration for notifications.
{
"enabled": "boolean",
"enabledNotifications": [
"string"
],
"passwordExpirationThreshold": "integer",
"certificateExpirationThreshold": "integer",
"schedulerCronExpression": "string",
"emailNotification": {
"enabled": "boolean",
"smtpServer": "string",
"smtpPort": "integer",
"smtpUsername": "string",
"smtpPassword": "string",
"useTls": "boolean",
"useSsl": "boolean",
"useProxy": "boolean",
"senderAddress": "string",
"emailSubjectTemplate": "string",
"emailContentTemplate": "string",
"receiverAddresses": [
"string"
]
}
}
Enable or disable notifications.
List of enabled notification types. Possible values: TASK_COMPLETION, PASSWORD_EXPIRATION, PASSWORD_EXPIRATION_WARNING, CERTIFICATE_EXPIRATION, CERTIFICATE_EXPIRATION_WARNING
Days before expiration date of a password to send a warning notification.
Days before expiration date of a certificate to send a warning notification.
A spring cron expression to define how frequent to check for expired passwords or certificates. Default: every hour - expression: 0 0 * * * *
Metadata for identification of the notification.
{
"environmentId": "string",
"productId": "string",
"taskId": "string",
"subProperty": [
"string"
]
}
The notification metadata environment ID.
The metadata product ID.
The notification metadata task ID.
The notification metadata getSubProperty.
The NSX-T in the deployment infrastructure.
{
"nsxVip": "string",
"nsxManagerIp": "string",
"nsxRootPassword": "string",
"nsxCliPassword": "string"
}
The NSX-T VIP address.
The NSX-T manager address.
The NSX-T root user password.
The NSX-T CLI user password.
{
"environmentName": "string",
"environmentId": "string",
"reportDate": "string",
"lastDiscoveryDate": "string",
"targetVersion": "string",
"product": {
"productType": "string",
"environmentId": "string",
"productId": "string",
"endpointAddress": "string",
"currentVersionInfo": {
"version": "string",
"buildNumber": "string",
"availableNewerVersions": [
"string"
]
},
"status": {
"overallStatus": "string",
"interopStatus": "string",
"passwordStatus": "string",
"certificateStatus": "string"
},
"nodes": [
{
"nodeId": "integer",
"hostName": "string",
"rootPasswordExpiration": "string",
"status": {
"status": "string",
"expirationDays": "integer"
}
}
],
"targetVersionInfo": {
"version": "string",
"buildNumber": "string",
"availableNewerVersions": [
"string"
]
},
"relations": [
{
"type": "string",
"endpointAddress": "string",
"versionInfo": {
"version": "string",
"buildNumber": "string",
"availableNewerVersions": [
"string"
]
},
"status": {
"overallStatus": "string",
"interopStatus": "string",
"passwordStatus": "string",
"certificateStatus": "string"
},
"relationship": "string"
}
]
}
}
Name of an environment that the product is part of.
ID of an environment that the product is part of.
The creation date of this report.
The date that the product state was last updated by discovery.
The specified product version for the report.
Node spec being modified.
{
"nodeSpecs": [
{
"nodeId": "integer",
"isPrimary": "boolean",
"cpuNum": "integer",
"ramMemory": "integer",
"hostName": "string",
"vmName": "string",
"deploymentOption": "string",
"datastoreName": "string",
"clusterName": "string",
"resourcePool": "string",
"datacenterName": "string",
"rootPassword": "string",
"gateway": "string",
"deployment": {
"vcenterName": "string",
"datacenterName": "string",
"clusterName": "string",
"resourcePool": "string",
"vmFolder": "string",
"datastoreNames": [
"string"
]
},
"nics": [
{
"ipAddress": "string",
"networkName": "string",
"staticRoutes": [
"string"
],
"dcVcenterNetworksSpec": {
"portGroupName": "string",
"gateway": "string",
"subnetMask": "string",
"domainName": "string",
"searchPath": [
"string"
],
"useDhcp": "boolean",
"dns": [
"string"
],
"ntp": [
"string"
]
}
}
]
}
]
}
The node spec defining the node to be deployed
{
"nodeId": "integer",
"isPrimary": "boolean",
"cpuNum": "integer",
"ramMemory": "integer",
"hostName": "string",
"vmName": "string",
"deploymentOption": "string",
"datastoreName": "string",
"clusterName": "string",
"resourcePool": "string",
"datacenterName": "string",
"rootPassword": "string",
"gateway": "string",
"nics": [
{
"ipAddress": "string",
"networkName": "string",
"staticRoutes": [
"string"
]
}
]
}
Additional properties
The ID of the node.
Marks node as primary.
Number of CPUs to configure the VM with.
Memory size (in MB) to configure the VM with.
Hostname of the node.
VM name of the node.
Deployment option of the VM (values depend on the product's OVF properties).
Datastore to use for the VM. If not defined, the first datastore of specified deployment infrastructure vCenter will be used.
vCenter cluster name to use for the VM. If not defined, the cluster defined for specified deployment infrastructure vCenter will be used.
vCenter resource pool name to use for the VM. If not defined, the resource pool defined for specified deployment infrastructure vCenter will be used.
Datacenter name to use for the VM. If not defined, the datacenter defined for specified deployment infrastructure vCenter will be used.
The password for root user (or similar admin user depending on OS).
The gateway to configure for the VM. If not set, the value of the first NIC's network will be used.
The node spec defining the node to be deployed
{
"nodeId": "integer",
"isPrimary": "boolean",
"cpuNum": "integer",
"ramMemory": "integer",
"hostName": "string",
"vmName": "string",
"deploymentOption": "string",
"datastoreName": "string",
"clusterName": "string",
"resourcePool": "string",
"datacenterName": "string",
"rootPassword": "string",
"gateway": "string",
"deployment": {
"vcenterName": "string",
"datacenterName": "string",
"clusterName": "string",
"resourcePool": "string",
"vmFolder": "string",
"datastoreNames": [
"string"
]
},
"nics": [
{
"ipAddress": "string",
"networkName": "string",
"staticRoutes": [
"string"
],
"dcVcenterNetworksSpec": {
"portGroupName": "string",
"gateway": "string",
"subnetMask": "string",
"domainName": "string",
"searchPath": [
"string"
],
"useDhcp": "boolean",
"dns": [
"string"
],
"ntp": [
"string"
]
}
}
]
}
Additional properties
The ID of the node.
Marks node as primary.
Number of CPUs to configure the VM with.
Memory size (in MB) to configure the VM with.
Hostname of the node.
VM name of the node.
Deployment option of the VM (values depend on the product's OVF properties).
Datastore to use for the VM. If not defined, the first datastore of specified deployment infrastructure vCenter will be used.
vCenter cluster name to use for the VM. If not defined, the cluster defined for specified deployment infrastructure vCenter will be used.
vCenter resource pool name to use for the VM. If not defined, the resource pool defined for specified deployment infrastructure vCenter will be used.
Datacenter name to use for the VM. If not defined, the datacenter defined for specified deployment infrastructure vCenter will be used.
The password for root user (or similar admin user depending on OS).
The gateway to configure for the VM. If not set, the value of the first NIC's network will be used.
The products deployed in this environment.
{
"productType": "string",
"productId": "string",
"version": "string",
"buildNumber": "string",
"productInternalId": "string",
"license": "string",
"adminPassword": "string",
"integrations": [
{
"integrationId": "string",
"integrationUsername": "string",
"integrationPassword": "string",
"status": "string",
"ref": "string",
"version": "string"
}
],
"infraReference": "string",
"nodes": [
{
"nodeId": "integer",
"isPrimary": "boolean",
"cpuNum": "integer",
"ramMemory": "integer",
"hostName": "string",
"vmName": "string",
"deploymentOption": "string",
"datastoreName": "string",
"clusterName": "string",
"resourcePool": "string",
"datacenterName": "string",
"rootPassword": "string",
"gateway": "string",
"nics": [
{
"ipAddress": "string",
"networkName": "string",
"staticRoutes": [
"string"
]
}
]
}
]
}
Additional properties
Product type, defining the type of application to integrate with (VCD, USAGE, RMQ, VROPSTA).
Product ID used to identify the product within an environment.
Version of the product to deploy or import.
Build number of the product, to be set automatically during discovery.
An internal ID of the product, to be set automatically during discovery.
License for the product
Admin password for the product's administrator account
List of integrations to configure for the product
Certificates for the product
A reference to the deployment infrastructure of the environment. If not defined, the first deployment infrastructure will be used.
The products deployed in this environment.
{
"productType": "string",
"productId": "string",
"version": "string",
"buildNumber": "string",
"productInternalId": "string",
"license": "string",
"adminPassword": "string",
"integrations": [
{
"integrationId": "string",
"integrationUsername": "string",
"integrationPassword": "string",
"status": "string",
"ref": "string",
"version": "string"
}
],
"deployment": {
"vcenterName": "string",
"datacenterName": "string",
"clusterName": "string",
"resourcePool": "string",
"vmFolder": "string",
"datastoreNames": [
"string"
]
},
"endpointAddress": "string",
"status": {
"status": "string",
"messages": [
"string"
],
"lastDiscovery": "string"
},
"nodes": [
{
"nodeId": "integer",
"isPrimary": "boolean",
"cpuNum": "integer",
"ramMemory": "integer",
"hostName": "string",
"vmName": "string",
"deploymentOption": "string",
"datastoreName": "string",
"clusterName": "string",
"resourcePool": "string",
"datacenterName": "string",
"rootPassword": "string",
"gateway": "string",
"deployment": {
"vcenterName": "string",
"datacenterName": "string",
"clusterName": "string",
"resourcePool": "string",
"vmFolder": "string",
"datastoreNames": [
"string"
]
},
"nics": [
{
"ipAddress": "string",
"networkName": "string",
"staticRoutes": [
"string"
],
"dcVcenterNetworksSpec": {
"portGroupName": "string",
"gateway": "string",
"subnetMask": "string",
"domainName": "string",
"searchPath": [
"string"
],
"useDhcp": "boolean",
"dns": [
"string"
],
"ntp": [
"string"
]
}
}
]
}
]
}
Additional properties
Product type, defining the type of application to integrate with (VCD, USAGE, RMQ, VROPSTA).
Product ID used to identify the product within an environment.
Version of the product to deploy or import.
Build number of the product, to be set automatically during discovery.
An internal ID of the product, to be set automatically during discovery.
License for the product
Admin password for the product's administrator account
List of integrations to configure for the product
Certificates for the product
The hostname or IP of the product (or load balancer)
Status of the product.
{
"status": "string",
"messages": [
"string"
],
"lastDiscovery": "string"
}
The status of the product.
Messages regarding the product, e.g. information about missing details.
The date of the last discovery of the product.
The node spec defining the node details to be updated.
{
"cpuNum": "integer",
"ramMemory": "integer",
"rootPassword": "string"
}
Number of CPUs to set for the node.
The amount of memory (in MB) to set for the node.
The root password to set for the node.
The details for the product upgrade.
{
"upgradeDetails": {
"targetVersion": "string",
"productModifyNodesSpecV2": {
"nodeSpecs": [
{
"nodeId": "integer",
"isPrimary": "boolean",
"cpuNum": "integer",
"ramMemory": "integer",
"hostName": "string",
"vmName": "string",
"deploymentOption": "string",
"datastoreName": "string",
"clusterName": "string",
"resourcePool": "string",
"datacenterName": "string",
"rootPassword": "string",
"gateway": "string",
"deployment": {
"vcenterName": "string",
"datacenterName": "string",
"clusterName": "string",
"resourcePool": "string",
"vmFolder": "string",
"datastoreNames": [
"string"
]
},
"nics": [
{
"ipAddress": "string",
"networkName": "string",
"staticRoutes": [
"string"
],
"dcVcenterNetworksSpec": {
"portGroupName": "string",
"gateway": "string",
"subnetMask": "string",
"domainName": "string",
"searchPath": [
"string"
],
"useDhcp": "boolean",
"dns": [
"string"
],
"ntp": [
"string"
]
}
}
]
}
]
}
}
}
List of integrations to configure for the product
{
"integrationId": "string",
"integrationUsername": "string",
"integrationPassword": "string",
"status": "string",
"ref": "string",
"version": "string"
}
Additional properties
ID of an integration.
Username for an integration.
Password for an integration.
Whether the declared integration matches what is actually in the environment.
Reference to the registered entity.
Version of the product or component of the integration.
{
"properties": {
"diskMode": "string",
"lbName": "string",
"lbFqdn": "string",
"lbIp": "string",
"portAmqpSsl": "string",
"portRmqMgmt": "string",
"users": [
{
"username": "string",
"password": "string"
}
],
"rootPassword": "string"
},
"productType": "string",
"productId": "string",
"version": "string",
"buildNumber": "string",
"productInternalId": "string",
"license": "string",
"adminPassword": "string",
"integrations": [
{
"integrationId": "string",
"integrationUsername": "string",
"integrationPassword": "string",
"status": "string",
"ref": "string",
"version": "string"
}
],
"certificate": {
"product": {
"validFrom": "string",
"validTo": "string",
"thumbprint": "string",
"certificate": "string",
"privateKey": "string",
"keyPassword": "string"
}
},
"infraReference": "string",
"nodes": [
{
"nodeId": "integer",
"isPrimary": "boolean",
"cpuNum": "integer",
"ramMemory": "integer",
"hostName": "string",
"vmName": "string",
"deploymentOption": "string",
"datastoreName": "string",
"clusterName": "string",
"resourcePool": "string",
"datacenterName": "string",
"rootPassword": "string",
"gateway": "string",
"nics": [
{
"ipAddress": "string",
"networkName": "string",
"staticRoutes": [
"string"
]
}
]
}
]
}
Additional RMQ specific product properties.
Product type, defining the type of application to integrate with (VCD, USAGE, RMQ, VROPSTA).
Product ID used to identify the product within an environment.
Version of the product to deploy or import.
Build number of the product, to be set automatically during discovery.
An internal ID of the product, to be set automatically during discovery.
License for the product
Admin password for the product's administrator account
Definition of RMQ certificates
A reference to the deployment infrastructure of the environment. If not defined, the first deployment infrastructure will be used.
{
"properties": {
"diskMode": "string",
"lbName": "string",
"lbFqdn": "string",
"lbIp": "string",
"portAmqpSsl": "string",
"portRmqMgmt": "string",
"users": [
{
"username": "string",
"password": "string"
}
],
"rootPassword": "string"
},
"productType": "string",
"productId": "string",
"version": "string",
"buildNumber": "string",
"productInternalId": "string",
"license": "string",
"adminPassword": "string",
"integrations": [
{
"integrationId": "string",
"integrationUsername": "string",
"integrationPassword": "string",
"status": "string",
"ref": "string",
"version": "string"
}
],
"certificate": {
"product": {
"validFrom": "string",
"validTo": "string",
"thumbprint": "string",
"certificate": "string",
"privateKey": "string",
"keyPassword": "string"
}
},
"deployment": {
"vcenterName": "string",
"datacenterName": "string",
"clusterName": "string",
"resourcePool": "string",
"vmFolder": "string",
"datastoreNames": [
"string"
]
},
"endpointAddress": "string",
"status": {
"status": "string",
"messages": [
"string"
],
"lastDiscovery": "string"
},
"nodes": [
{
"nodeId": "integer",
"isPrimary": "boolean",
"cpuNum": "integer",
"ramMemory": "integer",
"hostName": "string",
"vmName": "string",
"deploymentOption": "string",
"datastoreName": "string",
"clusterName": "string",
"resourcePool": "string",
"datacenterName": "string",
"rootPassword": "string",
"gateway": "string",
"deployment": {
"vcenterName": "string",
"datacenterName": "string",
"clusterName": "string",
"resourcePool": "string",
"vmFolder": "string",
"datastoreNames": [
"string"
]
},
"nics": [
{
"ipAddress": "string",
"networkName": "string",
"staticRoutes": [
"string"
],
"dcVcenterNetworksSpec": {
"portGroupName": "string",
"gateway": "string",
"subnetMask": "string",
"domainName": "string",
"searchPath": [
"string"
],
"useDhcp": "boolean",
"dns": [
"string"
],
"ntp": [
"string"
]
}
}
]
}
]
}
Additional RMQ specific product properties.
Product type, defining the type of application to integrate with (VCD, USAGE, RMQ, VROPSTA).
Product ID used to identify the product within an environment.
Version of the product to deploy or import.
Build number of the product, to be set automatically during discovery.
An internal ID of the product, to be set automatically during discovery.
License for the product
Admin password for the product's administrator account
Definition of RMQ certificates
The hostname or IP of the product (or load balancer)
{
"JSESSIONID": "string"
}
The JSESSIONID to be used for subsequent requests.
The sub tasks executed as part of this task.
{
"canBeRestarted": "boolean",
"name": "string",
"status": "string",
"ignoreStatus": "boolean",
"checkpointId": "integer",
"checkpointFK": "integer"
}
Indicate weather the subtask can be restarted.
Sub task name.
Sub task status.
Result messages of the sub task execution, listing steps and failures. Will be set after processing of the sub task.
Map of next sub tasks, defining which sub task to start next based on result status of the current one.
Flag to ignore the result status of the sub task.
If the subtask is a checkpoint, it will be by id.
Foreign key for the closest checkpoint.
Snapshots that were used to restart from the checkpoint.
{
"id": "integer",
"taskType": "string",
"totalSnapshots": [
"string"
],
"nextTaskId": "integer",
"status": "string",
"environmentId": "string",
"taskName": "string",
"next_tasks": [
"integer"
]
}
The task ID.
The type of the task.
The sub tasks executed as part of this task.
totalSnapshots
nextTaskId
The task's status based on the status of all sub tasks.
The environment ID of the environment that this task is defined for.
The task's name.
The task's result message - empty if successful, in case of error the sub task and failure messages are returned.
The list of tasks waiting for this task to finish.
{
"taskId": "string",
"precedingTasks": [
"integer"
]
}
The ID of the task that was created for the operation. Use this ID to get the state and result of the task.
List of task IDs for tasks that have to be processed before this task can start.
Upcoming status to be updated.
{
"status": "string"
}
status
The product upgrade details, defining target version and other optional parameters.
{
"targetVersion": "string",
"productModifyNodesSpecV2": {
"nodeSpecs": [
{
"nodeId": "integer",
"isPrimary": "boolean",
"cpuNum": "integer",
"ramMemory": "integer",
"hostName": "string",
"vmName": "string",
"deploymentOption": "string",
"datastoreName": "string",
"clusterName": "string",
"resourcePool": "string",
"datacenterName": "string",
"rootPassword": "string",
"gateway": "string",
"deployment": {
"vcenterName": "string",
"datacenterName": "string",
"clusterName": "string",
"resourcePool": "string",
"vmFolder": "string",
"datastoreNames": [
"string"
]
},
"nics": [
{
"ipAddress": "string",
"networkName": "string",
"staticRoutes": [
"string"
],
"dcVcenterNetworksSpec": {
"portGroupName": "string",
"gateway": "string",
"subnetMask": "string",
"domainName": "string",
"searchPath": [
"string"
],
"useDhcp": "boolean",
"dns": [
"string"
],
"ntp": [
"string"
]
}
}
]
}
]
}
}
The target version to upgrade to.
Additional properties for upgrade, e.g. keepBackup=true
List of integrations to configure for the product
{
"integrationId": "string",
"integrationUsername": "string",
"integrationPassword": "string",
"status": "string",
"ref": "string",
"version": "string"
}
Additional properties
ID of an integration.
Username for an integration.
Password for an integration.
Whether the declared integration matches what is actually in the environment.
Reference to the registered entity.
Version of the product or component of the integration.
{
"integrationId": "string",
"integrationUsername": "string",
"integrationPassword": "string",
"status": "string",
"ref": "string",
"version": "string",
"hostname": "string",
"port": "integer",
"datacenterComponentId": "string",
"datacenterComponentType": "string"
}
Additional properties
ID of an integration.
Username for an integration.
Password for an integration.
Whether the declared integration matches what is actually in the environment.
Reference to the registered entity.
Version of the product or component of the integration.
Hostname or IP address of the integration
Port to connect to the integration's endpoint.
ID of the integration.
datacenterComponentType
{
"properties": {
"diskMode": "string",
"auditorPassword": "string",
"rootPassword": "string",
"proxy": {
"type": "string",
"host": "string",
"port": "integer",
"user": "string",
"password": "string"
},
"acceptTerms": "boolean",
"registration": {
"label": "string",
"meteringMode": "string",
"connectivityMode": "string",
"contractNumber": "string",
"siteName": "string",
"token": "string"
}
},
"productType": "string",
"productId": "string",
"version": "string",
"buildNumber": "string",
"productInternalId": "string",
"license": "string",
"adminPassword": "string",
"integrations": [
{
"integrationId": "string",
"integrationUsername": "string",
"integrationPassword": "string",
"status": "string",
"ref": "string",
"version": "string"
}
],
"certificate": {
"product": {
"validFrom": "string",
"validTo": "string",
"thumbprint": "string",
"certificate": "string",
"privateKey": "string",
"keyPassword": "string"
}
},
"infraReference": "string",
"nodes": [
{
"nodeId": "integer",
"isPrimary": "boolean",
"cpuNum": "integer",
"ramMemory": "integer",
"hostName": "string",
"vmName": "string",
"deploymentOption": "string",
"datastoreName": "string",
"clusterName": "string",
"resourcePool": "string",
"datacenterName": "string",
"rootPassword": "string",
"gateway": "string",
"nics": [
{
"ipAddress": "string",
"networkName": "string",
"staticRoutes": [
"string"
]
}
]
}
]
}
Additional Usage Meter specific product properties.
Product type, defining the type of application to integrate with (VCD, USAGE, RMQ, VROPSTA).
Product ID used to identify the product within an environment.
Version of the product to deploy or import.
Build number of the product, to be set automatically during discovery.
An internal ID of the product, to be set automatically during discovery.
License for the product
Admin password for the product's administrator account
List of integrations to configure for the product
Definition of Usage Meter certificates
A reference to the deployment infrastructure of the environment. If not defined, the first deployment infrastructure will be used.
{
"properties": {
"diskMode": "string",
"auditorPassword": "string",
"rootPassword": "string",
"proxy": {
"type": "string",
"host": "string",
"port": "integer",
"user": "string",
"password": "string"
},
"acceptTerms": "boolean",
"registration": {
"label": "string",
"meteringMode": "string",
"connectivityMode": "string",
"contractNumber": "string",
"siteName": "string",
"token": "string"
}
},
"productType": "string",
"productId": "string",
"version": "string",
"buildNumber": "string",
"productInternalId": "string",
"license": "string",
"adminPassword": "string",
"integrations": [
{
"integrationId": "string",
"integrationUsername": "string",
"integrationPassword": "string",
"status": "string",
"ref": "string",
"version": "string"
}
],
"certificate": {
"product": {
"validFrom": "string",
"validTo": "string",
"thumbprint": "string",
"certificate": "string",
"privateKey": "string",
"keyPassword": "string"
}
},
"deployment": {
"vcenterName": "string",
"datacenterName": "string",
"clusterName": "string",
"resourcePool": "string",
"vmFolder": "string",
"datastoreNames": [
"string"
]
},
"endpointAddress": "string",
"status": {
"status": "string",
"messages": [
"string"
],
"lastDiscovery": "string"
},
"nodes": [
{
"nodeId": "integer",
"isPrimary": "boolean",
"cpuNum": "integer",
"ramMemory": "integer",
"hostName": "string",
"vmName": "string",
"deploymentOption": "string",
"datastoreName": "string",
"clusterName": "string",
"resourcePool": "string",
"datacenterName": "string",
"rootPassword": "string",
"gateway": "string",
"deployment": {
"vcenterName": "string",
"datacenterName": "string",
"clusterName": "string",
"resourcePool": "string",
"vmFolder": "string",
"datastoreNames": [
"string"
]
},
"nics": [
{
"ipAddress": "string",
"networkName": "string",
"staticRoutes": [
"string"
],
"dcVcenterNetworksSpec": {
"portGroupName": "string",
"gateway": "string",
"subnetMask": "string",
"domainName": "string",
"searchPath": [
"string"
],
"useDhcp": "boolean",
"dns": [
"string"
],
"ntp": [
"string"
]
}
}
]
}
]
}
Additional Usage Meter specific product properties.
Product type, defining the type of application to integrate with (VCD, USAGE, RMQ, VROPSTA).
Product ID used to identify the product within an environment.
Version of the product to deploy or import.
Build number of the product, to be set automatically during discovery.
An internal ID of the product, to be set automatically during discovery.
License for the product
Admin password for the product's administrator account
List of integrations to configure for the product
Definition of Usage Meter certificates
The hostname or IP of the product (or load balancer)
{
"integrationId": "string",
"integrationUsername": "string",
"integrationPassword": "string",
"status": "string",
"ref": "string",
"version": "string",
"hostname": "string",
"port": "integer",
"productId": "string",
"productType": "string"
}
Additional properties
ID of an integration.
Username for an integration.
Password for an integration.
Whether the declared integration matches what is actually in the environment.
Reference to the registered entity.
Version of the product or component of the integration.
Hostname or IP address of the integration
Port to connect to the integration's endpoint.
ID of the integration.
productType
{
"properties": {
"externalSSO": "boolean",
"vcfEdition": "string"
},
"integrationId": "string",
"integrationUsername": "string",
"integrationPassword": "string",
"status": "string",
"ref": "string",
"version": "string",
"hostname": "string",
"port": "integer",
"datacenterComponentId": "string",
"datacenterComponentType": "string"
}
Properties for Usage Meter vCenter integration, defining addition details, such as external SSO and VCF edition.
ID of an integration.
Username for an integration.
Password for an integration.
Whether the declared integration matches what is actually in the environment.
Reference to the registered entity.
Version of the product or component of the integration.
Hostname or IP address of the integration
Port to connect to the integration's endpoint.
ID of the integration.
datacenterComponentType
{
"properties": {
"vcReferences": [
"string"
]
},
"integrationId": "string",
"integrationUsername": "string",
"integrationPassword": "string",
"status": "string",
"ref": "string",
"version": "string",
"hostname": "string",
"port": "integer",
"datacenterComponentId": "string",
"datacenterComponentType": "string"
}
Properties for Usage Meter vROPS integration, defining addition details, e.g. reference to vCenter.
ID of an integration.
Username for an integration.
Password for an integration.
Whether the declared integration matches what is actually in the environment.
Reference to the registered entity.
Version of the product or component of the integration.
Hostname or IP address of the integration
Port to connect to the integration's endpoint.
ID of the integration.
datacenterComponentType
List of integrations to configure for the product
{
"integrationId": "string",
"integrationUsername": "string",
"integrationPassword": "string",
"status": "string",
"ref": "string",
"version": "string"
}
Additional properties
ID of an integration.
Username for an integration.
Password for an integration.
Whether the declared integration matches what is actually in the environment.
Reference to the registered entity.
Version of the product or component of the integration.
{
"properties": {
"nsxt_id": "string"
},
"integrationId": "string",
"integrationUsername": "string",
"integrationPassword": "string",
"status": "string",
"ref": "string",
"version": "string",
"hostname": "string",
"port": "integer",
"datacenterComponentId": "string",
"datacenterComponentType": "string"
}
Properties for VCD NSX-T integration, defining external networks, network pools and MSXT ID.
ID of an integration.
Username for an integration.
Password for an integration.
Whether the declared integration matches what is actually in the environment.
Reference to the registered entity.
Version of the product or component of the integration.
Hostname or IP address of the integration
Port to connect to the integration's endpoint.
ID of the integration.
datacenterComponentType
External networks
{
"subnets": [
{
"gateway": "string",
"prefixLength": "integer",
"dnsSuffix": "string",
"dnsServer1": "string",
"dnsServer2": "string",
"ipRanges": [
{
"startAddress": "string",
"endAddress": "string"
}
],
"enabled": "boolean"
}
],
"description": "string",
"tier0Name": "string",
"tier0backingId": "string",
"backingName": "string",
"backingId": "string",
"backingType": "string"
}
List of subnets for external network.
External network description.
Name of Tier 0 gateway this external network is backed by.
ID of Tier 0 gateway this external network is backed by.
Name of tier-0 router or logical switch this external network is backed by.
ID of tier-0 router or logical switch this external network is backed by.
The backing type of this external network.
List of subnets for external network.
{
"gateway": "string",
"prefixLength": "integer",
"dnsSuffix": "string",
"dnsServer1": "string",
"dnsServer2": "string",
"ipRanges": [
{
"startAddress": "string",
"endAddress": "string"
}
],
"enabled": "boolean"
}
The gateway defined for the external network.
The subnet prefix for the external network
The DNS suffix for the external network.
The first DNS server for the external network.
The second DNS server for the external network.
List of IP ranges for the external network.
Indicating whether the subnet for external network is enabled in VCD or not.
List of IP ranges for the external network.
{
"startAddress": "string",
"endAddress": "string"
}
Start address (IP v4) of IP range.
End address (IP v4) of IP range.
Details defining the public address settings of VCD.
{
"restApiBaseUri": "string",
"restApiBaseHttpUri": "string",
"tenantPortalExternalAddress": "string",
"tenantPortalExternalHttpAddress": "string",
"consoleProxyExternalAddress": "string"
}
The URL to be used for public access to VCD REST API (https)
The URL to be used for public access to VCD REST API (http)
The URL to be used for public access to tenant portal (https)
The URL to be used for public access to tenant portal (http)
The address to be configured for public access to VCD console proxy.
{
"properties": {
"installationId": "integer",
"systemName": "string",
"dbPassword": "string",
"adminEmail": "string",
"adminFullName": "string",
"adminUsername": "string",
"nfsMount": "string",
"deploymentOption": "string",
"diskMode": "string",
"enableSsh": "boolean",
"expireRootPassword": "boolean",
"clusterFailoverMode": "string",
"keystorePassword": "string",
"rootPassword": "string",
"publicAddress": {
"restApiBaseUri": "string",
"restApiBaseHttpUri": "string",
"tenantPortalExternalAddress": "string",
"tenantPortalExternalHttpAddress": "string",
"consoleProxyExternalAddress": "string"
}
},
"productType": "string",
"productId": "string",
"version": "string",
"buildNumber": "string",
"productInternalId": "string",
"license": "string",
"adminPassword": "string",
"integrations": [
{
"integrationId": "string",
"integrationUsername": "string",
"integrationPassword": "string",
"status": "string",
"ref": "string",
"version": "string"
}
],
"certificate": {
"product": {
"validFrom": "string",
"validTo": "string",
"thumbprint": "string",
"certificate": "string",
"privateKey": "string",
"keyPassword": "string"
},
"http": {
"validFrom": "string",
"validTo": "string",
"thumbprint": "string",
"certificate": "string",
"privateKey": "string",
"keyPassword": "string"
},
"consoleproxy": {
"validFrom": "string",
"validTo": "string",
"thumbprint": "string",
"certificate": "string",
"privateKey": "string",
"keyPassword": "string"
},
"management": {
"validFrom": "string",
"validTo": "string",
"thumbprint": "string",
"certificate": "string",
"privateKey": "string",
"keyPassword": "string"
},
"restApi": {
"validFrom": "string",
"validTo": "string",
"thumbprint": "string",
"certificate": "string",
"privateKey": "string",
"keyPassword": "string"
},
"tenantPortal": {
"validFrom": "string",
"validTo": "string",
"thumbprint": "string",
"certificate": "string",
"privateKey": "string",
"keyPassword": "string"
}
},
"infraReference": "string",
"nodes": [
{
"nodeId": "integer",
"isPrimary": "boolean",
"cpuNum": "integer",
"ramMemory": "integer",
"hostName": "string",
"vmName": "string",
"deploymentOption": "string",
"datastoreName": "string",
"clusterName": "string",
"resourcePool": "string",
"datacenterName": "string",
"rootPassword": "string",
"gateway": "string",
"nics": [
{
"ipAddress": "string",
"networkName": "string",
"staticRoutes": [
"string"
]
}
]
}
]
}
Additional VCD specific product properties.
Product type, defining the type of application to integrate with (VCD, USAGE, RMQ, VROPSTA).
Product ID used to identify the product within an environment.
Version of the product to deploy or import.
Build number of the product, to be set automatically during discovery.
An internal ID of the product, to be set automatically during discovery.
License for the product
Admin password for the product's administrator account
Definition of VCD certificates
A reference to the deployment infrastructure of the environment. If not defined, the first deployment infrastructure will be used.
{
"properties": {
"installationId": "integer",
"systemName": "string",
"dbPassword": "string",
"adminEmail": "string",
"adminFullName": "string",
"adminUsername": "string",
"nfsMount": "string",
"deploymentOption": "string",
"diskMode": "string",
"enableSsh": "boolean",
"expireRootPassword": "boolean",
"clusterFailoverMode": "string",
"keystorePassword": "string",
"rootPassword": "string",
"publicAddress": {
"restApiBaseUri": "string",
"restApiBaseHttpUri": "string",
"tenantPortalExternalAddress": "string",
"tenantPortalExternalHttpAddress": "string",
"consoleProxyExternalAddress": "string"
}
},
"productType": "string",
"productId": "string",
"version": "string",
"buildNumber": "string",
"productInternalId": "string",
"license": "string",
"adminPassword": "string",
"integrations": [
{
"integrationId": "string",
"integrationUsername": "string",
"integrationPassword": "string",
"status": "string",
"ref": "string",
"version": "string"
}
],
"certificate": {
"product": {
"validFrom": "string",
"validTo": "string",
"thumbprint": "string",
"certificate": "string",
"privateKey": "string",
"keyPassword": "string"
},
"http": {
"validFrom": "string",
"validTo": "string",
"thumbprint": "string",
"certificate": "string",
"privateKey": "string",
"keyPassword": "string"
},
"consoleproxy": {
"validFrom": "string",
"validTo": "string",
"thumbprint": "string",
"certificate": "string",
"privateKey": "string",
"keyPassword": "string"
},
"management": {
"validFrom": "string",
"validTo": "string",
"thumbprint": "string",
"certificate": "string",
"privateKey": "string",
"keyPassword": "string"
},
"restApi": {
"validFrom": "string",
"validTo": "string",
"thumbprint": "string",
"certificate": "string",
"privateKey": "string",
"keyPassword": "string"
},
"tenantPortal": {
"validFrom": "string",
"validTo": "string",
"thumbprint": "string",
"certificate": "string",
"privateKey": "string",
"keyPassword": "string"
}
},
"deployment": {
"vcenterName": "string",
"datacenterName": "string",
"clusterName": "string",
"resourcePool": "string",
"vmFolder": "string",
"datastoreNames": [
"string"
]
},
"endpointAddress": "string",
"status": {
"status": "string",
"messages": [
"string"
],
"lastDiscovery": "string"
},
"nodes": [
{
"nodeId": "integer",
"isPrimary": "boolean",
"cpuNum": "integer",
"ramMemory": "integer",
"hostName": "string",
"vmName": "string",
"deploymentOption": "string",
"datastoreName": "string",
"clusterName": "string",
"resourcePool": "string",
"datacenterName": "string",
"rootPassword": "string",
"gateway": "string",
"deployment": {
"vcenterName": "string",
"datacenterName": "string",
"clusterName": "string",
"resourcePool": "string",
"vmFolder": "string",
"datastoreNames": [
"string"
]
},
"nics": [
{
"ipAddress": "string",
"networkName": "string",
"staticRoutes": [
"string"
],
"dcVcenterNetworksSpec": {
"portGroupName": "string",
"gateway": "string",
"subnetMask": "string",
"domainName": "string",
"searchPath": [
"string"
],
"useDhcp": "boolean",
"dns": [
"string"
],
"ntp": [
"string"
]
}
}
]
}
]
}
Additional VCD specific product properties.
Product type, defining the type of application to integrate with (VCD, USAGE, RMQ, VROPSTA).
Product ID used to identify the product within an environment.
Version of the product to deploy or import.
Build number of the product, to be set automatically during discovery.
An internal ID of the product, to be set automatically during discovery.
License for the product
Admin password for the product's administrator account
Definition of VCD certificates
The hostname or IP of the product (or load balancer)
{
"properties": {
"amqpExchange": "string",
"amqpVHost": "string",
"amqpUseSSL": "boolean",
"amqpSslAcceptAll": "boolean",
"amqpPrefix": "string"
},
"integrationId": "string",
"integrationUsername": "string",
"integrationPassword": "string",
"status": "string",
"ref": "string",
"version": "string",
"hostname": "string",
"port": "integer",
"productId": "string",
"productType": "string"
}
Properties for VCD RMQ integration, defining additional AMQP details.
ID of an integration.
Username for an integration.
Password for an integration.
Whether the declared integration matches what is actually in the environment.
Reference to the registered entity.
Version of the product or component of the integration.
Hostname or IP address of the integration
Port to connect to the integration's endpoint.
ID of the integration.
productType
{
"properties": {
"vc_id": "string"
},
"integrationId": "string",
"integrationUsername": "string",
"integrationPassword": "string",
"status": "string",
"ref": "string",
"version": "string",
"hostname": "string",
"port": "integer",
"datacenterComponentId": "string",
"datacenterComponentType": "string"
}
Properties for VCD vCenter integration, defining PVDCs and VC ID.
ID of an integration.
Username for an integration.
Password for an integration.
Whether the declared integration matches what is actually in the environment.
Reference to the registered entity.
Version of the product or component of the integration.
Hostname or IP address of the integration
Port to connect to the integration's endpoint.
ID of the integration.
datacenterComponentType
Provider VDCs to create - key: PVDC name, value: definition of PVDC.
{
"description": "string",
"highestSupportedHardwareVersion": "string",
"clusterName": "string",
"resourcePoolname": "string",
"nsxIntegration": "string",
"storageProfile": [
"string"
],
"networkPoolname": "string",
"isEnabled": "boolean"
}
Description of the PVDC.
The hardware version to set for the PVDC. Default: vmx-14
The name of the vCenter cluster to use for PVDC creation. If not specified the resource pool will be searched in all available clusters.
The name of the vCenter resource pool to use for PVDC creation. If no cluster is specified the resource pool will be searched in all available clusters. If no resource pool is specified, the root resource pool of the cluster will be used.
The name of the NSX integration to that specifies details for network pool name. If no NSX integration is defined, PVDC will not be configured.
The list of storage profiles to be used for PVDC.
The name of the network pool to be used for PVDC. The network pool is defined in the referenced NSX integration.
Defines whether the PVDC to be created should be enabled or not. Default: true
The vCenter in the deployment infrastructure.
{
"vcenterName": "string",
"vcenterHost": "string",
"vcenterUsername": "string",
"vcenterPassword": "string",
"datacenterName": "string",
"clusterName": "string",
"datastores": [
"string"
],
"folderName": "string",
"resourcePool": "string"
}
A name to identify the vCenter instance.
Hostname or IP address of the vCenter instance.
Username to connect to the vCenter instance.
Password to connect to the vCenter instance.
Datacenter to deploy in.
Cluster to deploy in.
List of datastores to use for deployments.
List of networks (defining port groups and related subnets) used for deployments.
vCenter folder to deploy in.
Resource pool to deploy in.
List of user accounts to be created in RabbitMQ
{
"username": "string",
"password": "string"
}
Username of the user to create
Password for the user to create
Properties needed to configure a Proxy server.
{
"type": "string",
"host": "string",
"port": "integer",
"user": "string",
"password": "string"
}
Proxy protocol type: none, http and https
Proxy hostname or IP address
Proxy listening port
Proxy user
User's password
Properties needed to auto register UM.
{
"label": "string",
"meteringMode": "string",
"connectivityMode": "string",
"contractNumber": "string",
"siteName": "string",
"token": "string"
}
Label
Metering mode options: PRODUCTION, TEST. Default: PRODUCTION
Connectivity mode options: ONLINE, OFFLINE. Default: ONLINE
Contract number
Site name
Token used for auto registering UM.
List of integrations to configure for the product
{
"integrationId": "string",
"integrationUsername": "string",
"integrationPassword": "string",
"status": "string",
"ref": "string",
"version": "string"
}
Additional properties
ID of an integration.
Username for an integration.
Password for an integration.
Whether the declared integration matches what is actually in the environment.
Reference to the registered entity.
Version of the product or component of the integration.
{
"properties": {
"diskMode": "string",
"rootPassword": "string"
},
"productType": "string",
"productId": "string",
"version": "string",
"buildNumber": "string",
"productInternalId": "string",
"license": "string",
"adminPassword": "string",
"integrations": [
{
"integrationId": "string",
"integrationUsername": "string",
"integrationPassword": "string",
"status": "string",
"ref": "string",
"version": "string"
}
],
"certificate": {
"product": {
"validFrom": "string",
"validTo": "string",
"thumbprint": "string",
"certificate": "string",
"privateKey": "string",
"keyPassword": "string"
}
},
"infraReference": "string",
"nodes": [
{
"nodeId": "integer",
"isPrimary": "boolean",
"cpuNum": "integer",
"ramMemory": "integer",
"hostName": "string",
"vmName": "string",
"deploymentOption": "string",
"datastoreName": "string",
"clusterName": "string",
"resourcePool": "string",
"datacenterName": "string",
"rootPassword": "string",
"gateway": "string",
"nics": [
{
"ipAddress": "string",
"networkName": "string",
"staticRoutes": [
"string"
]
}
]
}
]
}
Additional vROPS Tenant App specific product properties.
Product type, defining the type of application to integrate with (VCD, USAGE, RMQ, VROPSTA).
Product ID used to identify the product within an environment.
Version of the product to deploy or import.
Build number of the product, to be set automatically during discovery.
An internal ID of the product, to be set automatically during discovery.
License for the product
Admin password for the product's administrator account
List of integrations to configure for the product
Definition of vROPS Tenant App certificates
A reference to the deployment infrastructure of the environment. If not defined, the first deployment infrastructure will be used.
{
"properties": {
"diskMode": "string",
"rootPassword": "string"
},
"productType": "string",
"productId": "string",
"version": "string",
"buildNumber": "string",
"productInternalId": "string",
"license": "string",
"adminPassword": "string",
"integrations": [
{
"integrationId": "string",
"integrationUsername": "string",
"integrationPassword": "string",
"status": "string",
"ref": "string",
"version": "string"
}
],
"certificate": {
"product": {
"validFrom": "string",
"validTo": "string",
"thumbprint": "string",
"certificate": "string",
"privateKey": "string",
"keyPassword": "string"
}
},
"deployment": {
"vcenterName": "string",
"datacenterName": "string",
"clusterName": "string",
"resourcePool": "string",
"vmFolder": "string",
"datastoreNames": [
"string"
]
},
"endpointAddress": "string",
"status": {
"status": "string",
"messages": [
"string"
],
"lastDiscovery": "string"
},
"nodes": [
{
"nodeId": "integer",
"isPrimary": "boolean",
"cpuNum": "integer",
"ramMemory": "integer",
"hostName": "string",
"vmName": "string",
"deploymentOption": "string",
"datastoreName": "string",
"clusterName": "string",
"resourcePool": "string",
"datacenterName": "string",
"rootPassword": "string",
"gateway": "string",
"deployment": {
"vcenterName": "string",
"datacenterName": "string",
"clusterName": "string",
"resourcePool": "string",
"vmFolder": "string",
"datastoreNames": [
"string"
]
},
"nics": [
{
"ipAddress": "string",
"networkName": "string",
"staticRoutes": [
"string"
],
"dcVcenterNetworksSpec": {
"portGroupName": "string",
"gateway": "string",
"subnetMask": "string",
"domainName": "string",
"searchPath": [
"string"
],
"useDhcp": "boolean",
"dns": [
"string"
],
"ntp": [
"string"
]
}
}
]
}
]
}
Additional vROPS Tenant App specific product properties.
Product type, defining the type of application to integrate with (VCD, USAGE, RMQ, VROPSTA).
Product ID used to identify the product within an environment.
Version of the product to deploy or import.
Build number of the product, to be set automatically during discovery.
An internal ID of the product, to be set automatically during discovery.
License for the product
Admin password for the product's administrator account
List of integrations to configure for the product
Definition of vROPS Tenant App certificates
The hostname or IP of the product (or load balancer)
{
"properties": {
"tenantAppProxy": "string",
"amqp": {
"amqpHost": "string",
"amqpPort": "string",
"amqpVHost": "string",
"amqpUseSSL": "string"
},
"credentials": {
"vcdAmqp": {
"password": "string"
},
"tenantAppAmqp": {
"username": "string",
"password": "string"
}
}
},
"integrationId": "string",
"integrationUsername": "string",
"integrationPassword": "string",
"status": "string",
"ref": "string",
"version": "string",
"hostname": "string",
"port": "integer",
"productId": "string",
"productType": "string"
}
Properties for vROPS TA VCD integration, defining Proxy and AMQP settings.
ID of an integration.
Username for an integration.
Password for an integration.
Whether the declared integration matches what is actually in the environment.
Reference to the registered entity.
Version of the product or component of the integration.
Hostname or IP address of the integration
Port to connect to the integration's endpoint.
ID of the integration.
productType
The AMQP settings for vROPS Tenant App.
{
"amqpHost": "string",
"amqpPort": "string",
"amqpVHost": "string",
"amqpUseSSL": "string"
}
The hostname or IP address of the AMQP host.
Port of the AMQP service to configure in vROPS Tenant App. Default: 5672
The AMQP virtual host path to use for AMQP service. Default: /
Definition whether to use SSL for AMQP service or plain-text. Default: false (plain-text)
Credentials to use for the VCD integration (for configuring AMQP access).
{
"vcdAmqp": {
"password": "string"
},
"tenantAppAmqp": {
"username": "string",
"password": "string"
}
}
Credentials for vROPS Tenant App AMQP
{
"username": "string",
"password": "string"
}
Username to use for vROPS Tenant App AMQP
Password for AMQP user to use vROPS Tenant App AMQP
Credentials for VCD AMQP (should match the AMQP service configured in VCD).
{
"password": "string"
}
Password for the user used for VCD AMQP integration
{
"integrationId": "string",
"integrationUsername": "string",
"integrationPassword": "string",
"status": "string",
"ref": "string",
"version": "string",
"hostname": "string",
"port": "integer",
"datacenterComponentId": "string",
"datacenterComponentType": "string"
}
Additional properties
ID of an integration.
Username for an integration.
Password for an integration.
Whether the declared integration matches what is actually in the environment.
Reference to the registered entity.
Version of the product or component of the integration.
Hostname or IP address of the integration
Port to connect to the integration's endpoint.
ID of the integration.
datacenterComponentType