[{"label":"Latest (5.0.0)","version":"latest"},{"version":"4.5.1"},{"version":"4.5.0"},{"version":"4.4.0"},{"version":"4.3.1"},{"link":"https://developer.vmware.com/apis/1126/vmware-cloud-foundation","version":"4.3"},{"link":"https://developer.vmware.com/apis/1077/vmware-cloud-foundation","version":"4.2"},{"link":"https://developer.vmware.com/apis/1032/vmware-cloud-foundation","version":"4.1"},{"link":"https://developer.vmware.com/apis/1002/vmware-cloud-foundation","version":"4.0.1"},{"link":"https://developer.vmware.com/apis/921/vmware-cloud-foundation","version":"4.0"},{"link":"https://developer.vmware.com/apis/925/vmware-cloud-foundation","version":"3.10"},{"link":"https://developer.vmware.com/apis/891/vmware-cloud-foundation","version":"3.9.1"},{"link":"https://developer.vmware.com/apis/723/vmware-cloud-foundation","version":"3.9.0"},{"link":"https://developer.vmware.com/apis/711/vmware-cloud-foundation","version":"3.8.1"},{"link":"https://developer.vmware.com/apis/685/vmware-cloud-foundation","version":"3.8"}]

vcf

Task

Represents a task

Properties

string

completionTimestamp Optional

Task completion timestamp

string

creationTimestamp Optional

Task creation timestamp

array of Error

errors Optional

List of errors in case of a failure

string

id Optional

Task ID

boolean

isCancellable Optional

Represents task can be cancellable or not.

MessagePack

localizableDescriptionPack Optional

Localizable Task description

string

name Optional

Task name

string

resolutionStatus Optional

Resolution state

array of Resource

resources Optional

List of resources associated with task

string

status Optional

Task status

array of SubTask

subTasks Optional

List of sub-tasks of the task

string

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 _

JSON Example

{
    "resolutionStatus": "Can have only one of the two values: RESOLVED or UNRESOLVED",
    "status": "One among: PENDING, IN_PROGRESS, SUCCESSFUL, FAILED, CANCELLED, COMPLETED_WITH_WARNING, SKIPPED",
    "type": "Sample values: HOST_COMMISSION, HOST_DECOMMISSION"
}

vcf

Property Of

PageOfTask

Returned By

Create AVNs
Create AVNs
Start Restore
Start Restore
Get Restore Task
Set Backup Configuration
Set Backup Configuration
Update Backup Configuration
Update Backup Configuration
Upload Bundle
Upload Bundle
Update Bundle
Update Bundle
Generate Certificates
Generate Certificates
Replace Certificates
Replace Certificates
Generates CSRs
Generates CSRs
Replace Resource Certificates
Create Cluster
Create Cluster
Update Cluster
Update Cluster
Delete Cluster
Delete Cluster
Add Datastore To Cluster
Add Datastore To Cluster
Remove Datastore From Cluster
Remove Datastore From Cluster
Reconcile Configs
Reconcile Configs
Get Reconciliation Task
Update Or Rotate Passwords
Update Or Rotate Passwords
Fetch Password Expiration
Retry Credentials Task
Retry Credentials Task
Cancel Credentials Task
Cancel Credentials Task
Create Domain
Create Domain
Update Domain
Update Domain
Delete Domain
Delete Domain
Create Edge
Create Edge
Update Edge Cluster
Update Edge Cluster
Commission Hosts
Commission Hosts
Decommission Hosts
Decommission Hosts
Update License Keys On Resources
Update License Keys On Resources
Upload Personality
Upload Personality
Configure DNS
Configure DNS
Configure NTP
Configure NTP
Set CEIP Status
Set CEIP Status
Trigger Check Run
Trigger Partial Retry Of Check Run
Precheck System
Precheck System
Get Precheck Task
Update Proxy Configuration
Update Proxy Configuration
Get Task
Perform Upgrade
Perform Upgrade
Commit Reschedule Upgrade
Perform Upgrade Precheck
Perform Upgrade Precheck
Get Upgrade Precheck
Connect vRLI With Domain
Connect vRLI With Domain
Connect vROPs With Domain
Connect vROPs With Domain
Rollback vRSLCM
Deploy vRSLCM

Task

Properties

JSON Example

Property Of

Returned By

Was this page helpful?