Appliance REST APIs Operations Index
All available Appliance REST APIs Operations
Get enabled state of the console-based controlled CLI (TTY1).
Set enabled state of the console-based controlled CLI (TTY1).
Get enabled state of Direct Console User Interface (DCUI TTY2).
Set enabled state of Direct Console User Interface (DCUI TTY2).
Get health settings for vCenter Server.
Set health settings based on provided healthSpec
Create a new local user account.
Get a list of the local user accounts.
Delete a local user account.
Get the local user account information.
Set local user account properties.
Update selected fields in local user account properties.
Get monitored item info
Get monitored items list
Get monitoring data.
Changes the Hostname/IP of the management network of vCenter appliance. The Hostname/IP change invokes the PNID change process which involves LDAP entry modification, updating registry entries, configuration files modification and network configuration changes. vCenter server is expected to be down for few minutes during these changes
Get Networking information for all configured interfaces.
Enable or Disable ipv6 on all interfaces
Reset and restarts network configuration on all interfaces, also this will renew the DHCP lease for DHCP IP address.
Get the NTP configuration status. If you run the 'timesync.get' command, you can retrieve the current time synchronization method (NTP- or VMware Tools-based). The 'ntp' command always returns the NTP server information, even when the time synchronization mode is not set to NTP. If the time synchronization mode is not NTP-based, the NTP server status is displayed as down.
Set NTP servers. This method updates old NTP servers from configuration and sets the input NTP servers in the configuration. If NTP based time synchronization is used internally, the NTP daemon will be restarted to reload given NTP configuration. In case NTP based time synchronization is not used, this method only replaces servers in the NTP configuration.
Test the connection to a list of ntp servers.
Returns the state of a service.
Lists details of vCenter services.
Restarts a service
Starts a service
Stops a service
Cancel pending shutdown action.
Get details about the pending shutdown action.
Power off the appliance.
Reboot the appliance.
Create a support bundle.
Deletes the support bundle.
Get list of support-bundles generated.
Get database storage health.
Exports the desired profile specification. if you do not have all of the privileges described as follows:
- Operation execution requires Infraprofile.Read.
Imports the desired profile specification.
List all the profiles which are registered. if you do not have all of the privileges described as follows:
- Operation execution requires Infraprofile.Read.
Validates the desired profile specification.
Returns the configuration for forwarding log messages to remote logging servers.
Sets the configuration for forwarding log messages to remote log servers.
Validates the current log forwarding configuration by checking the liveness of the remote machine and optionally sending a test diagnostic log message from the appliance to all configured logging servers to allow manual end-to-end validation. The message that is sent is: "This is a diagnostic log test message from vCenter Server."
Add domain to DNS search domains.
Get list of DNS search domains.
Set DNS search domains.
Get the Fully Qualified Doman Name.
Set the Fully Qualified Domain Name.
Test the Fully Qualified Domain Name.
Add a DNS server. This method fails if mode argument is "dhcp"
Get DNS server configuration.
Set the DNS server configuration. If you set the mode argument to "DHCP", a DHCP refresh is forced.
Test if dns servers are reachable.
Get the ordered list of firewall rules. Within the list of traffic rules, rules are processed in order of appearance, from top to bottom. When a connection matches a firewall rule, further processing for the connection stops, and the appliance ignores any additional firewall rules you have set.
Set the ordered list of firewall rules to allow or deny traffic from one or more incoming IP addresses. This overwrites the existing firewall rules and creates a new rule list. Within the list of traffic rules, rules are processed in order of appearance, from top to bottom. For example, the list of rules can be as follows: AddressPrefixInterface NamePolicy 10.112.0.10*REJECT 10.112.0.10nic0ACCEPT In the above example, the first rule drops all packets originating from 10.112.0.1 and the second rule accepts all packets originating from 10.112.0.1 only on nic0. In effect, the second rule is always ignored which is not desired, hence the order has to be swapped. When a connection matches a firewall rule, further processing for the connection stops, and the appliance ignores any additional firewall rules you have set.
Get information about a particular network interface.
Get list of available network interfaces, including those that are not yet configured.
Get IPv4 network configuration for specific NIC.
Set IPv4 network configuration for specific network interface.
Get IPv6 network configuration for specific interface.
Set IPv6 network configuration for specific interface.
Returns servers for which no proxy configuration will be applied.
Sets servers for which no proxy configuration should be applied. This operation sets environment variables. In order for this operation to take effect, a logout from appliance or a service restart is required. If IPv4 is enabled, "127.0.0.1" and "localhost" will always bypass the proxy (even if they are not explicitly configured).
Deletes a proxy configuration for a specific protocol.
Gets the proxy configuration for a specific protocol.
Configures which proxy server to use for the specified protocol. This operation sets environment variables for using proxy. In order for this configuration to take effect a logout / service restart is required.
Gets proxy configuration for all configured protocols.
Tests a proxy configuration by testing the connection to the proxy server and test host.
Cancel the backup job.
Initiate backup.
Get list of backup jobs
See backup job progress/result.
Gets the size (in MB) of the part.
Gets a list of the backup parts.
Creates a schedule
Returns a list of existing schedules with details
Deletes an existing schedule
Returns an existing schedule information based on id
Updates a schedule
Initiate backup with the specified schedule
Returns the information for backup corresponding to given backup location and system name.
Returns information about backup archives corresponding to given backup location and system name, which match the Archive.FilterSpec.
Get current appliance FIPS settings.
Enable/Disable Global FIPS mode for the appliance. Caution: Changing the value of this setting will reboot the Appliance.
Gets the TLS parameters of a particular profile.
Gets the list of all the available standard TLS Profiles and their configuration.
Gets the name of the current TLS Profile configured globally.
Sets any one of the standard profiles globally in the appliance. The result of this operation can be queried by calling the cis/tasks/{task-id} with the task-id in the response of this call. In case of a VCHA enabled cluster, setting a profile expects the VCHA cluster to be healthy and in maintenance or disabled mode before proceeding with the operation.
Gets update information
Starts operation of installing the appliance update. Will fail is the update is not staged
Checks if there are any eligible updates.
List of all upgradeable components eligible for update within specified version. An upgradeable component can be upgraded to new version individually without upgrading the whole vCenter to it.
Runs update precheck
Starts the update rollback operation such that the vCenter is reverted to a state before update installation. It will remove any changes done by update-install operation on the vCenter. Caution: This operation will perform a reboot of appliance.
Starts staging the appliance update. The updates are searched for in the following order: staged, CDROM, URL
Starts operation of installing the appliance update. Will stage update if not already staged The updates are searched for in the following order: staged, CDROM, URL
Validates the user provided data before the update installation.
Apply the specified DesiredState spec to the vCenter. The result of this operation can be queried by calling the cis/tasks/{task-id} where the task-id is the response of this operation. Warning: This operation is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
Validate (Check) the specified DesiredState spec containing configurations, and verify if it can be applied to the vCenter. The result of this operation can be queried by calling the cis/tasks/{task-id} where the task-id is the response of this operation. Warning: This operation is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
Creates a Profile. Warning: This operation is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. if you do not have all of the privileges described as follows:
- Operation execution requires Infraprofile.Write.
Deletes a profile. Warning: This operation is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. if you do not have all of the privileges described as follows:
- Operation execution requires Infraprofile.Write.
Returns information about a profile. Warning: This operation is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. if you do not have all of the privileges described as follows:
- Operation execution requires Infraprofile.Read.
Scans all the components in the desired state against the applied profile. result of this operation can be queried by calling the api cis/tasks/{task-id} where the task-id is the response of this operation. Warning: This operation is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
Scans all the components in the profiles against the applied profile. result of this operation can be queried by calling the api cis/tasks/{task-id} where the task-id is the response of this operation. Warning: This operation is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.