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

post Create AVNs
Create AVNs
get Get All AVNs
Fetches all AVNs
post Validate AVNs
Validate AVN Creation Spec

Backup Restore

post Backup Tasks
Trigger backup
put Configure Backup Settings
Configure backup settings to backup NSX and SDDC manager
patch Edit Backup Settings
Edit backup configuration to backup NSX and SDDC manager
get Get Backup Settings
Get backup configuration used to backup NSX and SDDC manager
post Restores Tasks
Trigger Restore
get Restores Tasks
Fetch the restores task

Bundles

get Get Bundle
Get a Bundle
get Get Bundles
Get the Bundles
patch Update Bundle
Update a Bundle for downloading from depot
patch Update Bundle Compatibility Sets
Update software compatibility sets for Bundles
post Upload Bundle
Upload a Bundle

CEIP

get Get CEIP Status
Get CEIP status
patch Update CEIP Status
Opt-in or Opt-out of CEIP

Certificates

patch Configure Certificate Authority
Configure existing certificate authority
put Create Certificate Authority
Create a certificate authority
delete Delete CA Configuration
Deletes CA configuration file
get Download CSR
Download available CSR(s) in tar.gz format
put Generate Certificates
Generate certificate(s) for the selected resource(s) in a domain
put Generates CSRs
Generate CSR(s)
get Get CSRs
Get available CSR(s) in json format
get Get Certificate Authorities
Get certificate authorities information
get Get Certificate Authority By ID
Get certificate authority information
get Get Certificates
Get latest generated certificate(s) in a domain.
patch Replace Certificates
Replace certificate(s) for the selected resource(s) in a domain
put Upload Certificates
Upload certificates to the certificate store
get VIew Certificate
View certificate of all the resources in a domain

Clusters

post Create Cluster
Create a Cluster and add to an existing Domain
delete Delete Cluster
Delete a Cluster from a Domain if it has been previously initialized for deletion
get Get Cluster
Get a Cluster
get Get Cluster Create Validation
Get the status of the validations for cluster deployment
get Get Cluster Update Validation
Get the status of the validations for cluster updates
get Get Clusters
Get the Clusters
get Get Host Criteria
Get all host criteria
get Get Host Criterion
Get a criterion to query for host
get Get Host Query Response
Get query response
get Get VDses
Get the list of VDSes of a cluster.
post Post Host Query
Post a host query
patch Update Cluster
Update a Cluster by adding or removing Hosts, Stretching a standard vSAN cluster, Unstretching a stretched cluster or by marking for deletion
post Validate Cluster Operations
Validate the input spec for operations on a cluster
post Validate Clusters Operations
Validate the input spec for clusters operations

Credentials

delete Cancel Credentials Task
Cancel a failed credentials task for a given ID
get Get Credential
Get Credential for the given ID
get Get Credentials
Get the Credentials
get Get Credentials Sub Task
Fetch details of a subtask for a given credentials task ID and sub-task ID.
get Get Credentials Task
Fetch a credentials task
get Get Credentials Task Resources Credentials
Fetch resource credentials for a given credentials task ID
get Get Credentials Tasks
Fetch the credentials tasks
patch Retry Credentials Task
Retry a failed credentials task for a given ID
patch Update Or Rotate Passwords
Update or rotate passwords for a list of resources

Depot Settings

get Get Depot Settings
Get Depot Settings
put Update Depot Settings
Update Depot Settings

Domains

post Create Domain
Create a Domain
delete Delete Domain
Delete a Domain if it has been previously initialized for deletion
get Domain Create Validation
Get the status of the validations for domain related operations
get Get Cluster Criteria
Get all cluster criteria
get Get Cluster Criterion
Get a criterion to query for cluster
get Get Cluster Query Response
Get cluster query response
get Get Clusters Query Response
Get clusters query response
get Get Domain
Get a Domain
get Get Domain Endpoints
Get Endpoints of a Domain
get Get Domain Update Validation
Get the status of the validations for domain related operations
get Get Domains
Get the Domains
post Post Cluster Query
Post a cluster query
post Post Clusters Query
Post clusters query
patch Update Domain
Update a Domain
post Validate Domains Operations
Validate the input spec for domain update operations
post Validate Domains Operations
Validate the input spec for domains operations

Federation

put Bootstrap
Bootstrap a VMware Cloud Foundation to form a federation
get Get Federation Details
Get details of a federation
delete Teardown
Teardown a federation

Fips Mode Details

get Get Security Config
Get VCF security configuration

Hosts

get Get Criteria
Get all criteria
get Get Criterion
Get a criterion
get Get Host
Get a Host
get Get Host Query Response
Get query response
get Get Hosts
Get the Hosts
post Post Query
Post a query

License Keys

post Add License Key
Add a License Key
delete Delete License Key
Delete a License Key
get Get License Key
Get a License Key by key
get Get License Keys
Get the License Keys

Manifests

get Get Manifest
Get manifest
post Save Manifest
Save/Load manifest

Members

get Get Fact
Get fact about a VMware Cloud Foundation
post Join Federation
Join a VMware Cloud Foundation to a federation
delete Leave Federation
Leave a VMware Cloud Foundation from a federation

Membership Token

post Invite Member
Invite a VMware Cloud Foundation to be member of a federation

NSX-T Clusters

get Get Criteria
Get all NSX-T criteria
get Get Criterion
Get a NSX-T criterion
get Get NSX-T Cluster
Get a NSX-T cluster
get Get NSX-T Cluster Query Response
Get NSX-T cluster query response
get Get NSX-T Clusters
Get the NSX-T clusters
get Get NSX-T IP Address Pool
Get a NSX-T IP address pool
get Get NSX-T IP Address Pools
Get the NSX-T IP address pools
get Get Validation Result
getValidationResult
post Post Query
Post a query
post Validate IP Pool
validateIpPool

NSX-T Edge Clusters

post Create Edge
Create an Edge Cluster
get Get Edge Cluster
Get an Edge Cluster
get Get Edge Clusters
Get the Edge Clusters
get Get Validation For Create Edge Cluster
Get the Edge Cluster spec validation
patch Update Edge Cluster
Expand or Shrink an NSX-T Edge Cluster
post Validate Edge Cluster Spec
Validate an Edge Cluster spec
post Validate Edge Cluster Update Spec
Validate an NSX-T Edge Cluster update spec

Progress

get Get Progress
Get progress of an invoked operation

Releases

get Get Releases
Get Releases.

SDDC

post Convert To JSON Spec
Convert SDDC specification Json/Excel File
post Create SDDC
Create SDDC
get Get All SDDC Validations
Get all SDDC specification validations
get Get Bringup Detail Report
Get SDDC report by ID
get Get Bringup Info
Get Bringup Info
get Get Bringup Validation Report
Get validation report by ID
get Get SDDC Manager Info
Retrieve SDDC Manager VM details
get Get SDDC Validation
Get SDDC specification validation status by ID
get Retrieve All SDDCs
Retrieve all SDDCs
get Retrieve SDDC
Retrieve a SDDC
patch Retry SDDC
Retry failed SDDC creation
patch Retry SDDC Validation
Retry SDDC validation
post Validate SDDC Spec
Validate SDDC specification before creation

SDDC Managers

get Get SDDC Manager
Get a SDDC Manager
get Get SDDC Managers
Get the SDDC Managers

SOS

get Gethealthsummary
Get Health-Checks task record for an id.
get Gethealthsummarytasks
Get all Health-Checks task records.
get Getsupport Bundle
Get Support-Bundle task record for an id.
get Getsupport Bundle Tasks
Get all Support-Bundle task records.
post Health Summary
Initiates Health-Checks for SDDC.
get Healthsummarydata
Download Health-Checks bundle.
get Support Bundledata
Download Support-Bundle.
post Supportbundles
Initiates Support-Bundle collection for SDDC.

System

put Configure DNS
Configure the Dns Server
put Configure NTP
Configure the Ntp Server
get Get DNS Configuration
Get the current DnsConfiguration
get Get NTP Configuration
Get the current NtpConfiguration
get Get Validation Of DNS Configuration
Get the status of the validation of the input DnsConfiguration
get Get Validation Of NTP Configuration
Get the status of the validation of the input ntpServers to configure new Ntp server
get Get Validations Of DNS Configuration
Get the validations of the input dnsServers to configure new DNS server
get Get Validations Of NTP Configuration
Get the validations of the input ntpServers to configure new Ntp server
post Validate DNS Configuration
Validate DnsConfiguration input spec and system health before DNS configuration
post Validate NTP Configuration
Validate NtpConfiguration input spec and system health before Ntp configuration

System Prechecks

get Get Precheck Task
Get Precheck Task by ID
post Precheck System
Precheck System

Tasks

delete Cancel Task
Cancel a Task
get Get Task
Get a Task
get Get Tasks
Get the Tasks
patch Retry Task
Retry a Task

Tokens

post Create Token
Create Token Pair
delete Invalidate Refresh Token
Invalidate Refresh Token
patch Refresh Access Token
Refresh Access Token

Trusted Certificates

post Add Trusted Certificate
Add trusted certificate to the SDDC manager

Upgradables

get Get NSX-T Upgrade Resources
Get NSXT upgradable resources
get Get Upgradables
Get the Upgradables
get Get Upgradables By Domain
Get the Upgradables
get Get Upgradables Clusters
Get registered and available HSM details along with Software details

Upgrades

patch Commit Reschedule Upgrade
Commit/Reschedule Upgrade
get Get Precheck
getPrecheck
get Get Upgrade By ID
Get Upgrade By Id
get Get Upgrades
Get Upgrades
post Perform Prechecks
performPrechecks
post Perform Upgrade
Perform Upgrade

Users

post Add Users
Add users
delete Delete User
Delete a user
get Get All UI Users
getAllUiUsers
get Get Local Account
Get local account details
get Get Roles
Get all roles
get Get SSO Domain Entities
Get all entities of SSO domain
get Get SSO Domains
Get all SSO domains
get Get Users
Get all Users
patch Update Local User Password
Update password for local account

VCF Services

get Get VCF Service
Get a VcfService
get Get VCF Services
Get the VcfServices

Version Aliases For Bundle Component Type

delete Delete Alias Versions By Software Type And Base Version
Delete Version Alias Configuration
delete Delete Version Alias By Software Type
Delete Version Alias for a bundle component type
get Get Version Alias Configuration
Get Version Alias Configuration
put Update Version Alias Configuration
Update Version Alias Configuration
put Update Version Alias Configurations
Update Version Alias Configurations

Vx Rail Managers

get Get Vx Rail Manager
Get a VxRail Manager
get Get Vx Rail Managers
Get VxRail Managers

WSA

get Get Wsas
Get all existing Workspace ONE Access instances

vCenters

get Get vCenter
Get a vCenter
get Get vCenters
Get vCenters

vRA

get Get VRas
Get all existing vRealize Automation instances

vRLI

put Connect vRLI With Domain
Connects vRealize Log Insight with domain
get Get Integrated Domains
Gets vRealize Log Insight integration status for workload domains
get Get VRlis
Get all existing vRealize Log Insight instances

vROPs

put Connect vROPs With Domain
Connect/disconnect workload domains with vRealize Operations
get Get Integrated Domains vROPs
Gets vRealize Operations integration status for workload domains
get Get VRopses
Get all existing vRealize Operations instances

vRSLCM

post Deploy vRSLCM
Deploy vRealize Suite Lifecycle Manager
get Get vRSLCM
Get the existing vRealize Suite Lifecycle Manager
get Get vRSLCM Validation
Get the status of the validations for vRealize Lifecycle Manager deployment
get Get vRSLCMs
Get all existing vRealize Suite Lifecycle Manager instances
delete Rollback vRSLCM
Rollback vRealize Suite Lifecycle Manager after unsuccessful deployment
post Validate vRSLCM
Validate the input specification for vRealize Suite Lifecycle Manager deployment

Feedback

Was this page helpful?