Appliance APIs

Appliance APIs

The com.vmware.appliance namespace provides resources for managing vCenter Appliance configuration. The namespace is available starting in vSphere 6.5.

API Categories
Appliance Access Consolecli

Appliance Access Consolecli resource provides operations Get/Set enabled state of CLI.

Appliance Access Dcui

Appliance Access Dcui resource provides operations Get/Set enabled state of DCUI.

Appliance Access Shell

Appliance Access Shell resource provides operations Get/Set enabled state of BASH.

Appliance Access Ssh

Appliance Access Ssh resource provides operations Get/Set enabled state of SSH-based controlled CLI.

Appliance Cores

This resource was added in vSphere API 8.0.2.0.

Appliance Health

The Appliance Health resource provides operations to retrieve the appliance health information.

This resource was added in vSphere API 6.7.

Appliance Health Applmgmt

Appliance Health Applmgmt resource provides operations Get health status of applmgmt services.

Appliance Health Check Settings

The Appliance HealthCheckSettings resource provides operations to enable/disable health check settings in vCenter Server.

This resource was added in vSphere API 7.0.0.1.

Appliance Health Database

The Appliance Health Database resource provides operations to retrieve the health status of the vcdb.

This resource was added in vSphere API 7.0.0.1.

Appliance Health Databasestorage

Appliance Health Databasestorage resource provides operations Get database storage health.

Appliance Health Load

Appliance Health Load resource provides operations Get load health.

Appliance Health Mem

Appliance Health Mem resource provides operations Get memory health.

Appliance Health Softwarepackages

Appliance Health Softwarepackages resource provides operations Get information on available software updates available in remote VUM repository.

Appliance Health Storage

Appliance Health Storage resource provides operations Get storage health.

Appliance Health Swap

Appliance Health Swap resource provides operations Get swap health.

Appliance Health System

Appliance Health System resource provides operations Get overall health of the system.

Appliance Local Accounts

The Appliance LocalAccounts resource provides operations to manage local user account.

This resource was added in vSphere API 6.7.

Appliance Local Accounts Policy

The Appliance LocalAccounts Policy resource provides operations to manage local user accounts

This resource was added in vSphere API 6.7.

Appliance Logging Forwarding

The Appliance Logging Forwarding resource provides operations to manage forwarding of log messages to remote logging servers.

This resource was added in vSphere API 6.7.

Appliance Monitoring

Appliance Monitoring resource provides operations Get and list monitoring data for requested item.

Appliance Networking

The Appliance Networking resource provides operations Get Network configurations.

This resource was added in vSphere API 6.7.

Appliance Networking Dns Domains

Appliance Networking Dns Domains resource provides operations DNS search domains.

Appliance Networking Dns Hostname

Appliance Networking Dns Hostname resource provides operations Performs operations on Fully Qualified Doman Name.

Appliance Networking Dns Servers

Appliance Networking Dns Servers resource provides operations DNS server configuration.

Appliance Networking Firewall Inbound

The Appliance Networking Firewall Inbound resource provides operations to manage inbound firewall rules.

This resource was added in vSphere API 6.7.1.

Appliance Networking Interfaces

Appliance Networking Interfaces resource provides operations Provides information about network interface.

Appliance Networking Interfaces Ipv4

The Appliance Networking Interfaces Ipv4 resource provides operations to perform IPv4 network configuration for interfaces.

This resource was added in vSphere API 6.7.

Appliance Networking Interfaces Ipv6

The Appliance Networking Interfaces Ipv6 resource provides operations to perform IPv6 network configuration for interfaces.

This resource was added in vSphere API 6.7.

Appliance Networking No Proxy

The Appliance Networking NoProxy resource provides operations to configure a connection that does not need a proxy.

This resource was added in vSphere API 6.7.

Appliance Networking Proxy

The Appliance Networking Proxy resource provides operations Proxy configuration.

This resource was added in vSphere API 6.7.

Appliance Ntp

Appliance Ntp resource provides operations Gets NTP configuration status and tests connection to ntp servers.

This resource was added in vSphere API 6.7.

Appliance Recovery

The Appliance Recovery resource provides operations to invoke an appliance recovery (backup and restore).

This resource was added in vSphere API 6.7.

Appliance Services

The Service resource provides operations to manage a single/set of appliance services.

This resource was added in vSphere API 6.7.

Appliance Shutdown

Appliance Shutdown resource provides operations Performs reboot/shutdown operations on appliance.

This resource was added in vSphere API 6.7.

Appliance Support Bundle

The Appliance SupportBundle resource provides operations to create support bundle, list and delete generated support bundle.

This resource was added in vSphere API 7.0.1.0.

Appliance Support Bundle Components

The SupportBundleComponents resource provides operations to get the supported support bundle components.

This resource was added in vSphere API 7.0.1.0.

Appliance System Crypto Hash

The Appliance System CryptoHash resource provides operations to switch systems global crypto one-way hash algorithms.

This resource was added in vSphere API 9.0.0.0.

Appliance System Crypto Hash Options

The Appliance System CryptoHash Options resource provides operations to retrieve available crypto hash modes

This resource was added in vSphere API 9.0.0.0.

Appliance System Security Global Fips

This resource is deprecated as of vSphere API 9.0.0.0. This API is no longer needed as FIPS is enabled by default

The Appliance System Security GlobalFips resource provides operations to enable/disable appliance FIPS mode.

This resource was added in vSphere API 7.0.1.0.

Appliance System Storage

Appliance System Storage resource provides operations Appliance storage configuration

Appliance System Time

Appliance System Time resource provides operations Gets system time.

Appliance System Time Timezone

The Appliance System Time Timezone resource provides operations to get and set the appliance timezone.

This resource was added in vSphere API 6.7.

Appliance System Uptime

Appliance System Uptime resource provides operations Get the system uptime.

Appliance System Version

Appliance System Version resource provides operations Get the appliance version.

Appliance Timesync

Appliance Timesync resource provides operations Performs time synchronization configuration.

This resource was added in vSphere API 6.7.

Appliance Tls Manual Parameters Global

Appliance Tls ManualParameters Global resource provides operations APIs to configure manual/custom TLS parameters.

This resource was added in vSphere API 8.0.3.0.

Appliance Tls Manual Parameters Services

Appliance Tls ManualParameters Services resource provides operations APIs to configure manual/custom TLS parameters for a specific service.

This resource was added in vSphere API 9.0.0.0.

Appliance Tls Profiles

Appliance Tls Profiles resource provides operations APIs to list the details of available standard TLS Profiles.

This resource was added in vSphere API 8.0.3.0.

Appliance Tls Profiles Global

Appliance Tls Profiles Global resource provides operations APIs to configure standard TLS profile.

This is a profile based management for TLS usage on vCenter and the interface is for managing standard/built-in profiles globally in the appliance.

This resource was added in vSphere API 8.0.3.0.

Appliance Update

The Appliance Update resource provides operations to get the status of the appliance update.

This resource was added in vSphere API 6.7.

Appliance Update Pending

The Appliance Update Pending resource provides operations to manipulate pending updates.

This resource was added in vSphere API 6.7.

Appliance Update Policy

The Appliance Update Policy resource provides operations to set/get background check for the new updates.

This resource was added in vSphere API 6.7.

Appliance Update Staged

The Appliance Update Staged resource provides operations to get the status of the staged update.

This resource was added in vSphere API 6.7.