Appliance REST APIs Operations Index

Appliance REST APIs Operations Index

All available Appliance REST APIs Operations

Access

Consolecli

Get Access Consolecli

Get enabled state of the console-based controlled CLI (TTY1).

Set Access Consolecli

Set enabled state of the console-based controlled CLI (TTY1).

Dcui

Get Access Dcui

Get enabled state of Direct Console User Interface (DCUI TTY2).

Set Access Dcui

Set enabled state of Direct Console User Interface (DCUI TTY2).

Shell

Get Access Shell

Get enabled state of BASH, that is, access to BASH from within the controlled CLI.

Set Access Shell

Set enabled state of BASH, that is, access to BASH from within the controlled CLI.

Ssh

Get enabled state of the SSH-based controlled CLI.

Set enabled state of the SSH-based controlled CLI.

Appliance

Health

Get Item Health Messages

Get health messages.

Local Accounts

Create Username Local Accounts

Create a new local user account.

Delete Username Local Accounts

Delete a local user account.

Get Username Local Accounts

Get the local user account information.

Set Username Local Accounts

Set local user account properties.

Update Username Local Accounts

Update selected fields in local user account properties.

List Local Accounts

Get a list of the local user accounts.

Monitoring

Get Stat Id Monitoring

Get monitored item info

List Monitoring

Get monitored items list

Get Monitoring Query

Get monitoring data.

Networking

Change Networking Async

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.

Update Networking

Enable or Disable ipv6 on all interfaces

Reset Networking

Reset and restarts network configuration on all interfaces, also this will renew the DHCP lease for DHCP IP address.

Ntp

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.

Create Ntp Test

Test the connection to a list of ntp servers.

Recovery

Gets the properties of the appliance Recovery subsystem.

Services

Returns the state of a service.

Lists details of vCenter services.

Create Service Restart

Restarts a service

Create Service Start

Starts a service

Create Service Stop

Stops a service

Shutdown

Create Shutdown Cancel

Cancel pending shutdown action.

Get details about the pending shutdown action.

Create Shutdown Poweroff

Power off the appliance.

Create Shutdown Reboot

Reboot the appliance.

Timesync

Get time synchronization mode.

Set time synchronization mode.

Update

Request the cancellation the update operation that is currently in progress.

Gets the current status of the appliance update.

Health

Applmgmt

Get Health Applmgmt

Get health status of applmgmt services.

Databasestorage

Get Health Database Storage

Get database storage health.

Load

Get Health Load

Get load health.

Mem

Get memory health.

Softwarepackages

Get Health Software Packages

Get information on available software updates available in the remote vSphere Update Manager repository. Red indicates that security updates are available. Orange indicates that non-security updates are available. Green indicates that there are no updates available. Gray indicates that there was an error retreiving information on software updates.

Storage

Get Health Storage

Get storage health.

Swap

Get Health Swap

Get swap health.

System

Get Health System

Get overall health of system.

Get Health System Lastcheck

Get last check timestamp of the health of the system.

Infraprofile

Configs

Local Accounts

Policy

Get Local Accounts Global Policy

Get the global password policy.

Set Local Accounts Global Policy

Set the global password policy.

Logging

Forwarding

Get Logging Forwarding

Returns the configuration for forwarding log messages to remote logging servers.

Set Logging Forwarding

Sets the configuration for forwarding log messages to remote log servers.

Test Logging Forwarding

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."

Networking

Interfaces

Get Interface Name Networking

Get information about a particular network interface.

List Networking Interfaces

Get list of available network interfaces, including those that are not yet configured.

No Proxy

Get Networking Noproxy

Returns servers for which no proxy configuration will be applied.

Set Networking Noproxy

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).

Proxy

Delete Protocol Networking Proxy

Deletes a proxy configuration for a specific protocol.

Get Protocol Networking Proxy

Gets the proxy configuration for a specific protocol.

Set Protocol Networking Proxy

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.

List Networking Proxy

Gets proxy configuration for all configured protocols.

Test Protocol Proxy

Tests a proxy configuration by testing the connection to the proxy server and test host.

Dns Domains

Create Networking Dns Domains

Add domain to DNS search domains.

List Networking Dns Domains

Get list of DNS search domains.

Set Networking Dns Domains

Set DNS search domains.

Dns Hostname

Get Networking Dns Hostname

Get the Fully Qualified Doman Name.

Set Networking Dns Hostname

Set the Fully Qualified Domain Name.

Create Dns Hostname Test

Test the Fully Qualified Domain Name.

Dns Servers

Create Networking Dns Servers

Add a DNS server. This method fails if mode argument is "dhcp"

Get Networking Dns Servers

Get DNS server configuration.

Set Networking Dns Servers

Set the DNS server configuration. If you set the mode argument to "DHCP", a DHCP refresh is forced.

Create Dns Servers Test

Test if dns servers are reachable.

Firewall Inbound

Get Networking Firewall Inbound

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 Networking Firewall Inbound

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: [dropped table ] 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.

Interfaces Ipv4

Get Interface Name Networking Ipv4

Get IPv4 network configuration for specific NIC.

Set Interface Name Networking Ipv4

Set IPv4 network configuration for specific network interface.

Interfaces Ipv6

Get Interface Name Networking Ipv6

Get IPv6 network configuration for specific interface.

Set Interface Name Networking Ipv6

Set IPv6 network configuration for specific interface.

Recovery

Backup

Create Recovery Backup Validate

Check for backup errors without starting backup.

Restore

Create Recovery Restore Validate

Get metadata before restore

Backup Job

Create Id Job Cancel

Cancel the backup job.

Create Recovery Backup Job

Initiate backup.

List Recovery Backup Job

Get list of backup jobs

Get Id Backup Job

See backup job progress/result.

Backup Parts

Get Id Backup Parts

Gets the size (in MB) of the part.

List Recovery Backup Parts

Gets a list of the backup parts.

Backup Schedules

Create Schedule Backup

Creates a schedule

Delete Schedule Backup

Deletes an existing schedule

Get Schedule Backup

Returns an existing schedule information based on id

List Recovery Backup Schedules

Returns a list of existing schedules with details

Initiate backup with the specified schedule

Set Schedule Backup Update

Updates a schedule

Backup System Name

List Recovery Backup System Name

Returns a list of system names for which backup archives exist under locSpec.

Backup Job Details

List Backup Job Details

Returns detailed information about the current and historical backup jobs.

Backup System Name Archive

Get System Name Archive Backup

Returns the information for backup corresponding to given backup location and system name.

List System Name Backup Archives

Returns information about backup archives corresponding to given backup location and system name, which match the Archive.FilterSpec.

Reconciliation Job

Create Recovery Reconciliation Job

Initiate reconciliation.

Get Recovery Reconciliation Job

Get reconciliation job progress/result.

Restore Job

Create Restore Job Cancel

Cancel the restore job

Create Recovery Restore Job

Initiate restore.

Get Recovery Restore Job

See restore job progress/result.

System

Storage

List System Storage

Get disk to partition mapping.

Create System Storage Resize

Resize all partitions to 100 percent of disk size.

Resize Ex System Storage

Resize all partitions to 100 percent of disk size.

Time

Get System Time

Get system time.

Uptime

Get System Uptime

Get the system uptime.

Version

Get System Version

Get the version.

Security Global Fips

Time Timezone

Get System Time Timezone

Set System Time Timezone

Update

Pending

Get Version Update Pending

Gets update information

Install Version Pending

Starts operation of installing the appliance update. Will fail is the update is not staged

List Update Pending

Checks if new updates are available.

Precheck Version Pending

Runs update precheck

Stage Version Pending

Starts staging the appliance update. The updates are searched for in the following order: staged, CDROM, URL

Stage And Install Version Pending

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

Validate Version Pending

Validates the user provided data before the update installation.

Policy

Get Update Policy

Gets the automatic update checking and staging policy.

Set Update Policy

Sets the automatic update checking and staging policy.

Staged

Delete Update Staged

Deletes the staged update

Get Update Staged

Gets the current status of the staged update

Vcenter Settings V1

Config

Config Current

Vmon

Service

Get Service Vmon

Returns the state of a service.

Update Service Vmon

Updates the properties of a service.

Get Vmon Service

Lists details of services managed by vMon.

Create Service Vmon Restart

Restarts a service

Create Service Vmon Start

Starts a service

Create Service Vmon Stop

Stops a service