Package com.vmware.appliance

The com.vmware.appliance package provides interfaces for managing vCenter Appliance configuration.

See: Description

Interface Summary

Interface	Description
Health	The Health interface provides methods to retrieve the appliance health information.
HealthTypes	Defines the data types of the Health API service.
LocalAccounts	The LocalAccounts interface provides methods to manage local user account.
LocalAccountsTypes	Defines the data types of the LocalAccounts API service.
Monitoring	Monitoring interface provides methods Get and list monitoring data for requested item.
MonitoringTypes	Defines the data types of the Monitoring API service.
Networking	The Networking interface provides methods Get Network configurations.
NetworkingTypes	Defines the data types of the Networking API service.
Ntp	Ntp interface provides methods Gets NTP configuration status and tests connection to ntp servers.
NtpTypes	Defines the data types of the Ntp API service.
Recovery	The Recovery interface provides methods to invoke an appliance recovery (backup and restore).
RecoveryTypes	Defines the data types of the Recovery API service.
Services	The Service interface provides methods to manage a single/set of appliance services.
ServicesTypes	Defines the data types of the Services API service.
Shutdown	Shutdown interface provides methods Performs reboot/shutdown operations on appliance.
ShutdownTypes	Defines the data types of the Shutdown API service.
Timesync	Timesync interface provides methods Performs time synchronization configuration.
TimesyncTypes	Defines the data types of the Timesync API service.
Update	The Update interface provides methods to get the status of the appliance update.
UpdateTypes	Defines the data types of the Update API service.

Class Summary

Class	Description
ApplianceFactory	ApplianceFactory is responsible for creating instances of services contained inside the com.vmware.appliance package and also has the subpackages reference to access respective subpackage services.
HealthDefinitions	Defines the type descriptors for the Health API service.
HealthStub	Remote stub implementation of the Health API service.
LocalAccountsDefinitions	Defines the type descriptors for the LocalAccounts API service.
LocalAccountsStub	Remote stub implementation of the LocalAccounts API service.
LocalAccountsTypes.Config	The Config class defines the information required for the account.
LocalAccountsTypes.Config.Builder	Builder class for LocalAccountsTypes.Config.
LocalAccountsTypes.Info	The Info class defines the local account properties.
LocalAccountsTypes.Info.Builder	Builder class for LocalAccountsTypes.Info.
LocalAccountsTypes.UpdateConfig	The UpdateConfig class defines the fields that might be updated.
LocalAccountsTypes.UpdateConfig.Builder	Builder class for LocalAccountsTypes.UpdateConfig.
MonitoringDefinitions	Defines the type descriptors for the Monitoring API service.
MonitoringStub	Remote stub implementation of the Monitoring API service.
MonitoringTypes.FunctionType	FunctionType enumeration class Defines aggregation function
MonitoringTypes.IntervalType	IntervalType enumeration class Defines interval between the values in hours and mins, for which aggregation will apply
MonitoringTypes.MonitoredItem	MonitoredItem class Structure representing requested monitored item data.
MonitoringTypes.MonitoredItem.Builder	Builder class for MonitoringTypes.MonitoredItem.
MonitoringTypes.MonitoredItemData	MonitoredItemData class Structure representing monitored item data.
MonitoringTypes.MonitoredItemData.Builder	Builder class for MonitoringTypes.MonitoredItemData.
MonitoringTypes.MonitoredItemDataRequest	MonitoredItemDataRequest class Structure representing requested monitored item data.
MonitoringTypes.MonitoredItemDataRequest.Builder	Builder class for MonitoringTypes.MonitoredItemDataRequest.
NetworkingDefinitions	Defines the type descriptors for the Networking API service.
NetworkingStub	Remote stub implementation of the Networking API service.
NetworkingTypes.ChangeSpec
NetworkingTypes.ChangeSpec.Builder	Builder class for NetworkingTypes.ChangeSpec.
NetworkingTypes.DNSInfo	The DNSInfo class contains information about the DNS configuration of a virtual appliance.
NetworkingTypes.DNSInfo.Builder	Builder class for NetworkingTypes.DNSInfo.
NetworkingTypes.DNSInfo.DNSMode	The DNSMode enumeration class describes the source of DNS servers.
NetworkingTypes.Info	The Info class contains information about the network configuration of a virtual appliance.
NetworkingTypes.Info.Builder	Builder class for NetworkingTypes.Info.
NetworkingTypes.UpdateSpec	The UpdateSpec class describes whether to enable or disable ipv6 on interfaces.
NetworkingTypes.UpdateSpec.Builder	Builder class for NetworkingTypes.UpdateSpec.
Notification	The Notification class describes a notification that can be reported by the appliance task.
Notification.Builder	Builder class for Notification.
Notifications	The Notifications class contains info/warning/error messages that can be reported be the appliance task.
Notifications.Builder	Builder class for Notifications.
NtpDefinitions	Defines the type descriptors for the Ntp API service.
NtpStub	Remote stub implementation of the Ntp API service.
NtpTypes.LocalizableMessage	LocalizableMessage class Structure representing message.
NtpTypes.LocalizableMessage.Builder	Builder class for NtpTypes.LocalizableMessage.
NtpTypes.ServerStatus	ServerStatus enumeration class Status of server during test.
NtpTypes.TestRunStatus	TestRunStatus class Status of the test.
NtpTypes.TestRunStatus.Builder	Builder class for NtpTypes.TestRunStatus.
RecoveryDefinitions	Defines the type descriptors for the Recovery API service.
RecoveryStub	Remote stub implementation of the Recovery API service.
RecoveryTypes.Info	The Info class contains the information about the appliance recovery environment.
RecoveryTypes.Info.Builder	Builder class for RecoveryTypes.Info.
ServicesDefinitions	Defines the type descriptors for the Services API service.
ServicesStub	Remote stub implementation of the Services API service.
ServicesTypes.Info	The Info class contains information about a service.
ServicesTypes.Info.Builder	Builder class for ServicesTypes.Info.
ServicesTypes.State	The State enumeration class defines valid Run State for services.
ShutdownDefinitions	Defines the type descriptors for the Shutdown API service.
ShutdownStub	Remote stub implementation of the Shutdown API service.
ShutdownTypes.ShutdownConfig	ShutdownConfig class Structure that defines shutdown configuration returned by the Shutdown.get operation.
ShutdownTypes.ShutdownConfig.Builder	Builder class for ShutdownTypes.ShutdownConfig.
StructDefinitions	Defines the type descriptors for the top-level types in com.vmware.appliance package.
SubtaskInfo	The SubtaskInfo class contains information about one of the subtasks that makes up an appliance task.
SubtaskInfo.Builder	Builder class for SubtaskInfo.
TaskInfo	The TaskInfo class contains information about an appliance task and the subtasks of which it consists.
TaskInfo.Builder	Builder class for TaskInfo.
TimesyncDefinitions	Defines the type descriptors for the Timesync API service.
TimesyncStub	Remote stub implementation of the Timesync API service.
TimesyncTypes.TimeSyncMode	The TimeSyncMode enumeration class defines time synchronization modes.
UpdateDefinitions	Defines the type descriptors for the Update API service.
UpdateStub	Remote stub implementation of the Update API service.
UpdateTypes.Info	The Info class describes the state of the appliance update.
UpdateTypes.Info.Builder	Builder class for UpdateTypes.Info.
UpdateTypes.State	The State enumeration class defines the various states the appliance update can be in.

Enum Summary

Enum	Description
MonitoringTypes.FunctionType.Values	Native Java enum representing this enumeration class.
MonitoringTypes.IntervalType.Values	Native Java enum representing this enumeration class.
NetworkingTypes._VAPI_OPERATIONS	Identifiers of the task operations
NetworkingTypes.DNSInfo.DNSMode.Values	Native Java enum representing this enumeration class.
NtpTypes.ServerStatus.Values	Native Java enum representing this enumeration class.
ServicesTypes.State.Values	Native Java enum representing this enumeration class.
TimesyncTypes.TimeSyncMode.Values	Native Java enum representing this enumeration class.
UpdateTypes.State.Values	Native Java enum representing this enumeration class.

Package com.vmware.appliance Description

The com.vmware.appliance package provides interfaces for managing vCenter Appliance configuration. The package is available starting in vSphere 6.7.