Cloud Director Appliance API Operations Index
All available Cloud Director Appliance API Operations
Valid input values are:
- vcd (alias of vmware-vcd)
- vmware-vcd
- vpostgres
- repmgrd
- appliance-sync.timer
Valid input values are:
- vpostgres
- nginx
Returns current operational state for the vcd, vpostgres, repmgrd and appliance-sync.timer services running on this appliance.
Returns the list of backup bundles available in /opt/vmware/vcloud-director/data/transfer/backups/
This will create a backup of the postgresql DB of the appliance, as well as other vcd specific certificate files needed during restore process. This api endpoint should only be executed on the current postgresql HA primary appliance. The task will fail on Standby and Application-Cell appliances.
Returns the backup file details for the specified backup instance
This will delete the backup file package specified, from the backups directory in the transfer share.
This will restore the specified backup of the postgresql DB of the appliance, as well as other vcd specific files. This api endpoint should only be executed on the current postgresql HA primary appliance. The task will fail on Standby and Application-Cell appliances.
Valid values are:
- automatic
- manual
Refer to taskStatus API's Response Example tab for an example of failover mode task
Current supported input values are:
- root
- postgres
- nfs
Returns the FIPS mode of a single appliance and its Cloud Director cell
This will activate or deactivate only the appliance's FIPS mode and will not activate or deactivate the Cloud Director server group's FIPS mode.
To activate an appliance's FIPS mode, the Cloud Director server's FIPS mode must be "On Pending Restart" or "On".
To deactivate an appliance's FIPS mode, the Cloud Director server's FIPS mode must be "Off Pending Restart" or "Off".
Returns the FIPS mode of all appliances and Cloud Director cells
The value of 'current' could also be provided for the URL auth-token parameter when the request's authentication method is bearer token.
Valid response values are:
- true
- false
Returns the current NFS mount point information.
Mount or unmount nfs share specified. To unmount specify nfs parameter value as empty string.
Validates nfs parameters and mount point. Performs mount and runs diagnostic checks.
Validates nfs parameters and mount point. Performs mount and runs diagnostic checks.
Returns postgres HA state of all nodes from this appliance's point of view.
The entire URL for the task is returned in the Location header of the response.
- Note: The promote action requires that no healthy primary currently exists in the HA cluster.
- Token is valid for a minimum of 30 minutes.
- Once token is issued or used, a 30 minute timer is started. If not used within that period it will expire.
- Token is valid for a maximum of 24 hours, after which it expires.
Returns file system information for the following file systems on the appliance.
- local root file system
- local database disk file system
- nfs share file system
The entire URL for the task is returned in the Location header of the response.
- Note: The switchover action requires all nodes in the HA cluster to be healthy. Switchover causes the VMware Cloud Director database to be unavailable for 30–60 seconds. To avoid unexpected task failures, quiesce the activity on all cells in the cluster before the switchover.
Setup appliance nodes.
Setup appliance nodes.
The response code corresponds to the task list being successfully retrieved, and not to the asynchoronous operations themselves. The status of the asynchronous operation(s) can be viewed in the response body.
Tasks are per cell and remain in memory till the respective appliance node is rebooted. This means that tasks that were triggered prior to reboot are lost upon reboot.
The response code corresponds to the task being successfully retrieved, and not to the asynchoronous operation itself. The status of the asynchronous operation can be viewed in the response body.
Tasks are per cell and remain in memory till the respective appliance nodes is rebooted. This means that tasks that were triggered prior to reboot are lost upon reboot.
The response code corresponds to the task being successfully retrieved, and not to the asynchoronous operation itself. The status of the asynchronous operation can be viewed in the response body.
Tasks are per cell and remain in memory till the respective appliance nodes is rebooted. This means that tasks that were triggered prior to reboot are lost upon reboot.
The entire URL for the task is returned in the Location header of the response.
- Note: A node must be inactive in order for it to be unregistered.
Returns current appliance version