VMware Cloud Foundation on Dell EMC VxRail API Reference Guide Operations Index

VMware Cloud Foundation on Dell EMC VxRail API Reference Guide Operations Index

All available VMware Cloud Foundation on Dell EMC VxRail API Reference Guide Operations

Avns

Fetches all AVNs

Validate AVN Creation Spec

Backup Restore

Get Backup Configuration

Retrieve the backup configuration for SDDC Manager and NSX Manager

Get Restore Task

Retrieve the restore task

Set Backup Configuration

Configure the backup configuration for SDDC Manager and NSX Manager

Start a backup operation

Start a restore operation

Update Backup Configuration

Update the backup configuration for SDDC Manager and NSX Manager

Bundles

Get the Bundles

Get Bundles For Skip Upgrade Using GET

Get bundles for skip upgrade a domain from current version to target version.

Update a Bundle for downloading from depot

Update Bundle Compatibility Sets

Update software compatibility sets for Bundles

Upload a Bundle

Ceip

Get Ceip Status

Get CEIP status

Set Ceip Status

Opt-in or Opt-out of CEIP

Certificates

Configure Certificate Authority

Configure existing certificate authority

Create Certificate Authority

Create a certificate authority

Delete Ca Configuration

Deletes CA configuration file

Download available CSR(s) in tar.gz format

Generate Certificates

Generate certificate(s) for the selected resource(s) in a domain

Generates CS Rs

Generate CSR(s)

Get Certificate Authorities

Get certificate authorities information

Get Certificate Authority By Id

Get certificate authority information

Get Certificates

Get latest generated certificate(s) in a domain.

Get available CSR(s) in json format

Get Resource Certificates Validation Result

Get the resource certificate validation result

Replace Certificates

Replace certificate(s) for the selected resource(s) in a domain

Replace Resource Certificates

Replace resource certificates

Upload Certificates

Upload certificates to the certificate store

Validate Resource Certificates

Validate resource certificates

View Certificate

View certificate of all the resources in a domain

Check Sets

Get Last Assessment Run Info

Get information about the last assessment run

Get the result for a given check run

Query Check Sets

Query for check-sets for the given resources

Trigger Check Run

Trigger a run of the selected checks

Trigger Partial Retry Of Check Run

Trigger partial retry of a completed check run

Clusters

Add Datastore To Cluster

Mount a datastore to a cluster

Assignable Tags To Cluster

get assignable Tags to Cluster

Assign Tags To Existing Cluster

Assign Tags to Cluster

Create a Cluster and add to an existing Domain

Delete a Cluster from a Domain if it has been previously initialized for deletion

Get Cluster Create Validation

Get the status of the validations for cluster deployment

Get Cluster Datastores

Get the list of all datastores associated with the cluster.

Get the Clusters

Get Cluster Tag Manager Url

Get Cluster Tag Manager Url

Get Cluster Update Validation

Get the status of the validations for cluster updates

Get Datastore Criterion

Get a criterion to query for datastore

Get Datastore Query Response

Get Datastore query response

Get Datastores Criteria

Get all datastore criteria

Get Host Criteria

Get all host criteria

Get Host Criterion

Get a criterion to query for host

Get Host Query Response

Get query response

Get Tags Assigned To Cluster

Get Tags assigned to Cluster

Get Tags Assigned To Clusters

Get Tags assigned to Clusters

Get the list of VDSes of a cluster.

Post Datastore Query

Post a datastore query

Post Host Query

Post a host query

Remove Datastore From Cluster

Unmount a datastore from a cluster

Remove Tags From Existing Cluster

Remove Tags From Cluster

Update a Cluster by adding or removing Hosts, Stretching a standard vSAN cluster, Unstretching a stretched cluster or by marking for deletion

Validate Cluster Operations

Validate input specification for updating given Cluster

Validate Clusters Operations

Validate the input specification for Cluster creation

Validate Vsan Remote Datastore Spec

Validate the input spec for mounting vSAN remote datastore to an existing cluster

Compatibility Matrix

Get Compatibility Matrices

Get Compatibility Matrices

Get Compatibility Matrix

Get Compatibility Matrix

Get Compatibility Matrix Content

Get Compatibility Matrix content

Get Compatibility Matrix Metadata

Get Compatibility Matrix Metadata

Update Compatibility Matrix

Update CompatibilityMatrix for a source with JSON file

Config Reconciler

Get configs associated with the given criteria

Get Reconciliation Task

Get config reconciliation task associated with the given task Id

Reconcile Configs

Reconcile configs

Credentials

Cancel Credentials Task

Cancel a failed credentials task for a given ID

Fetch Password Expiration

Fetch expiration details of passwords for a list of credentials

Get Credential for the given ID

Get Credentials

Get the Credentials

Get Credentials Sub Task

Fetch details of a subtask for a given credentials task ID and sub-task ID.

Get Credentials Task

Fetch a credentials task

Get Credentials Task Resources Credentials

Fetch resource credentials for a given credentials task ID

Get Credentials Tasks

Fetch the credentials tasks

Get Expirations For Passwords

Get the status of the password expiration fetch

Retry Credentials Task

Retry a failed credentials task for a given ID

Update Or Rotate Passwords

Update or rotate passwords for a list of resources

Depot Settings

Get Depot Settings

Get Depot Settings

Update Depot Settings

Update Depot Settings

Domains

Assignable Tags To Domain

get assignable Tags to Domain

Assign Tags To Existing Domain

Assign Tags to Domain

Create a Domain

Delete a Domain if it has been previously initialized for deletion

Domain Create Validation

Get the status of the validations for domain related operations

Get Cluster Criteria

Get all cluster criteria

Get Cluster Criterion

Get a criterion to query for cluster

Get Cluster Query Response

Get cluster query response

Get Clusters Query Response

Get clusters query response

Get Datastore Criterion 1

Get a criterion to query for datastore

Get Datastore Query Response 1

Get Datastore query response

Get Datastores Criteria 1

Get all datastore criteria

Get Domain Endpoints

Get Endpoints of a Domain

Get the Domains

Get Domain Tag Manager Url

Get Domain Tag Manager Url

Get Domain Update Validation

Get the status of the validations for domain related operations

Get Tags Assigned To Domain

Get Tags assigned to Domain

Get Tags Assigned To Domains

Get Tags assigned to Domains

Post Cluster Query

Post a cluster query

Post Clusters Query

Post clusters query

Post Datastore Query 1

Post a datastore query

Remove Tags From Domain

remove Tags From Domain

Update a Domain

Validate Domains Operations

Validate the input spec for domain update operations

Validate Domains Operations 1

Validate the input spec for domains operations

Fips Mode Details

Get Security Config

Get VCF security configuration

Hosts

Assignable Tags To Host

get Assignable Tags to Host

Assign Tags To Existing Host

Assign Tags to Host

Get all criteria

Get a criterion

Get Host Query Response 1

Get query response

Get Host Tag Manager Url

Get Host Tag Manager Url

Get Tags Assigned To Host

Get Tags assigned to Host

Get Tags Assigned To Hosts

Get Tags assigned to Hosts

Remove Tags From Host

Remove Tags From Host

Identity Providers

Add Embedded Identity Source

Add an embedded Identity source

Add External Identity Provider

Add an external Identity provider

Delete External Identity Provider

Delete an external Identity Provider

Delete Identity Source

Delete an Identity Source

Get all Identity Providers

Get Identity Provider By Id

Get Identity Provider By Id

Update Embedded Identity Source

Update an embedded Identity source

Update External Identity Provider

Update an external Identity provider

License Keys

Add License Key

Add a License Key

Check Resources License

Check resources license

Delete License Key

Delete a License Key

Get License Key

Get a License Key by key

Get License Keys

Get the License Keys

Get Licensing Info

Get the Licensing information

Get Resources License Check Result

Get the result of the resources license check

Update License Keys On Resources

Update license keys of resources

Manifests

Save/Load manifest

Nsx T Clusters

Get all NSX criteria

Get Criterion 1

Get a NSX criterion

Get Nsxt Cluster

Get a NSX cluster

Get Nsxt Cluster Query Response

Get NSX cluster query response

Get Nsxt Clusters

Get the NSX clusters

Get Nsxt Ip Address Pool

Get a NSX IP address pool

Get Nsxt Ip Address Pools

Get the NSX IP address pools

Get Validation Result Using GET

getValidationResult

Validate Ip Pool Using POST

Nsx Tedge Clusters

Create an Edge Cluster

Get Edge Cluster

Get an Edge Cluster

Get Edge Clusters

Get the Edge Clusters

Get Validation For Create Edge Cluster

Get the Edge Cluster spec validation

Update Edge Cluster

Expand or Shrink an NSX Edge Cluster

Validate Edge Cluster Spec

Validate an Edge Cluster spec

Validate Edge Cluster Update Spec

Validate an NSX Edge Cluster update spec

Proxy Configuration

Get Proxy Configuration

Get the current Proxy configuration

Update Proxy Configuration

Update Proxy configuration

Releases

Get Future Releases

Returns all known to the system future target versions for a domain.

Get System Release

Get System Release.

Resource Functionalities

Get Resource Functionalities

Get Resource Functionalities

Get Resources Functionalities Allowed Global

Get Resource Functionalities Allowed Global Configuration

Sddc

Convert To Json Spec

Convert SDDC specification Json/Excel File

Get All Sddc Validations

Get all SDDC specification validations

Get Bringup Detail Report

Get SDDC report by ID

Get Bringup Info

Get Bringup Info

Get Bringup Validation Report

Get validation report by ID

Get Sddc Manager Info

Retrieve SDDC Manager VM details

Get Sddc Validation

Get SDDC specification validation status by ID

Retrieve All Sddcs

Retrieve all SDDCs

Retrieve a SDDC

Retry failed SDDC creation

Retry Sddc Validation

Retry SDDC validation

Validate Sddc Spec

Validate SDDC specification before creation

Sddc Managers

Get Sddc Manager

Get a SDDC Manager

Get Sddc Managers

Get the SDDC Managers

Sos

Gethealthsummary

Fetch the progress of a Health summary task.

Gethealthsummarytasks

Fetch All Health Summary Tasks.

Getsupport Bundle

Fetch the progress of support bundle task.

Getsupport Bundle Tasks

Fetch All Support bundle Tasks.

Initiates Health Summary checks.

Healthsummarydata

Download Health Summary Bundle.

Support Bundledata

Download Support bundles.

Initiates Support bundle download

System

Configure the Dns Server

Configure the Ntp Server

Get Dns Configuration

Get the current DnsConfiguration

Get Ntp Configuration

Get the current NtpConfiguration

Get Validation Of Dns Configuration

Get the status of the validation of the input DnsConfiguration

Get Validation Of Ntp Configuration

Get the status of the validation of the input ntpServers to configure new Ntp server

Get Validations Of DNS Configuration

Get the validations of the input dnsServers to configure new DNS server

Get Validations Of Ntp Configuration

Get the validations of the input ntpServers to configure new Ntp server

Update system level configuration

Validate Dns Configuration

Validate DnsConfiguration input spec and system health before DNS configuration

Validate Ntp Configuration

Validate NtpConfiguration input spec and system health before Ntp configuration

System Prechecks

Get Precheck Task

Get Precheck Task by ID

Precheck System

Precheck System

Target Upgrade Version

Get Domain Release View

Get release view for domain.

Get Domain Release View 1

Get release view for all WLDs.

Save Domain Release View

Save/update target upgrade version for domain.

Tasks

Tokens

Create Token Pair

Invalidate Refresh Token

Invalidate Refresh Token

Refresh Access Token

Refresh Access Token

Trusted Certificates

Add Trusted Certificate

Add a trusted certificate to the SDDC Manager

Delete Trusted Certificate

Delete a trusted certificate from the SDDC Manager

Get Trusted Certificates

Get the trusted certificates from the SDDC Manager

Upgradables

Get Nsxt Upgrade Resources

Get NSX upgradable resources

Get Upgradables

Get the Upgradables

Get Upgradables And Resource Errors

Get the Upgradables and Resource Errors

Get Upgradables By Domain

Get the Upgradables

Get Upgradables Clusters

Get registered and available HSM details along with Software details

Upgrades

Commit Reschedule Upgrade

Commit/Reschedule Upgrade

Get Upgrade By Id

Get Upgrade By Id

Get Upgrade Precheck

Get Upgrade Precheck Details

Perform Upgrade

Perform Upgrade

Perform Upgrade Precheck

Perform Upgrade Prechecks

Users

Get All Ui Users Using GET

Get Local Account

Get local account details

Get SSO Domain Entities

Get all entities of SSO domain

Get SSO Domains

Get all SSO domains

Update Local User Password

Update password for local account

V Centers

V Ra

Get all existing vRealize Automation instances

V Rli

Connect Vrli With Domain

Connects vRealize Log Insight with domain

Get Integrated Domains 1

Gets vRealize Log Insight integration status for workload domains

Get all existing vRealize Log Insight instances

V Rops

Connect Vrops With Domain

Connect/disconnect workload domains with vRealize Operations

Get Integrated Domains Vrops

Gets vRealize Operations integration status for workload domains

Get all existing vRealize Operations instances

V Rslcm

Deploy vRealize Suite Lifecycle Manager

Get the existing vRealize Suite Lifecycle Manager

Get all existing vRealize Suite Lifecycle Manager instances

Get Vrslcm Validation

Get the status of the validations for vRealize Lifecycle Manager deployment

Rollback Vrslcm

Rollback vRealize Suite Lifecycle Manager after unsuccessful deployment

Update Vrslcm Version By Id In Inventory

Update vRSLCM version by ID in SDDC Manager inventory

Update Vrslcm Version In Inventory

Updates the version of VRSLCM in SDDC Manager inventory

Validate Vrslcm

Validate the input specification for vRealize Suite Lifecycle Manager deployment

V Sanhealth Check

Get Health Check Query

Get vSAN health check status

Get Health Check Status

Get vSAN health check status by Query Id

Get Health Check Status Task

Get vSAN health check update task status

Set Health Check Status

Update vSAN health check status

Vcf Services

Get Vcf Service

Get a VcfService

Get Vcf Services

Get the VcfServices

Version Aliases For Bundle Component Type

Delete Alias Versions By Software Type And Base Version

Delete Version Alias Configuration

Delete Version Alias By Software Type

Delete Version Alias for a bundle component type

Get Version Alias Configuration

Get Version Alias Configuration

Update Version Alias Configuration

Update Version Alias Configuration

Update Version Alias Configurations

Update Version Alias Configurations

Vx Rail Managers

Get Vx Rail Manager

Get a VxRail Manager

Get Vx Rail Managers

Get VxRail Managers

Wsa

Get all existing Workspace ONE Access instances