Host System APIs

Host System APIs

The HostSystem managed object type provides access to a virtualization host platform.

Invoking destroy on a HostSystem of standalone type throws a NotSupported fault. A standalone HostSystem can be destroyed only by invoking destroy on its parent ComputeResource. Invoking destroy on a failover host throws a DisallowedOperationOnFailoverHost fault. See ClusterFailoverHostAdmissionControlPolicy.

Operations

Host System Acquire Cim Services Ticket

Creates and returns a credential used to establish a remote connection to a Web Based Management (CIM) interface.

Host System Configure Crypto Key

Sets/changes the key to be used for coredump encryption and puts the host in *safe* state.

Host System Destroy Task

Destroys this object, deleting its contents and removing it from its parent folder (if any).

Host System Disconnect Host Task

Disconnects from a host and instructs the server to stop sending heartbeats.

Host System Enable Crypto

Sets/changes the key to be used for coredump encryption and puts the host in *safe* state Note: *HostSystem.PrepareCrypto* must be called first

Host System Enter Lockdown Mode

Modifies the permissions on the host, so that it will only be accessible through local console or an authorized centralized management application.

Host System Enter Maintenance Mode Task

Puts the host in maintenance mode.

Host System Exit Lockdown Mode

Restores Administrator permission for the local administrative account for the host that was removed by prior call to *HostSystem.EnterLockdownMode*.

Host System Exit Maintenance Mode Task

Takes the host out of maintenance mode.

Host System Get Alarm Actions Enabled

Whether alarm actions are enabled for this entity.

Host System Get Answer File Validation Result

Host answer file validation result.

Host System Get Answer File Validation State

Host answer file validation state.

Host System Get Available Field

List of custom field definitions that are valid for the object's type.

Host System Get Capability

Host capabilities.

Host System Get Compliance Check Result

The host profile compliance check result.

Host System Get Compliance Check State

The host profile compliance check state.

Host System Get Config

Host configuration information.

Host System Get Config Issue

Current configuration issues that have been detected for this entity.

Host System Get Config Manager

Host configuration systems.

Host System Get Config Status

The configStatus indicates whether or not the system has detected a configuration issue involving this entity.

Host System Get Custom Value

Custom field values.

Host System Get Datastore

A collection of references to the subset of datastore objects in the datacenter that are available in this HostSystem.

Host System Get Datastore Browser

DatastoreBrowser to browse datastores for this host.

Host System Get Declared Alarm State

A set of alarm states for alarms that apply to this managed entity.

Host System Get Disabled Method

List of operations that are disabled, given the current runtime state of the entity.

Host System Get Effective Role

Access rights the current session has to this entity.

Host System Get Hardware

Hardware configuration of the host.

Host System Get Licensable Resource

Information about all licensable resources, currently present on this host.

Host System Get Name

Name of this entity, unique relative to its parent.

Host System Get Network

A collection of references to the subset of network objects in the datacenter that are available in this HostSystem.

Host System Get Overall Status

General health of this managed entity.

Host System Get Parent

Parent of this entity.

Host System Get Permission

List of permissions defined for this entity.

Host System Get Precheck Remediation Result

The host profile precheck-remediation result.

Host System Get Recent Task

The set of recent tasks operating on this managed entity.

Host System Get Remediation Result

The host profile remediation result.

Host System Get Remediation State

The host profile remediation state.

Host System Get Runtime

Runtime state information about the host such as connection state.

Host System Get Summary

Basic information about the host, including connection state.

Host System Get System Resources

Reference for the system resource hierarchy, used for configuring the set of resources reserved to the system and unavailable to virtual machines.

Host System Get Tag

The set of tags associated with this managed entity.

Host System Get Triggered Alarm State

A set of alarm states for alarms triggered by this entity or by its descendants.

Host System Get Value

List of custom field values.

Host System Get Vm

List of virtual machines associated with this host.

Host System Power Down Host To Stand By Task

Puts the host in standby mode, a mode in which the host is in a standby state from which it can be powered up remotely.

Host System Power Up Host From Stand By Task

Takes the host out of standby mode.

Host System Prepare Crypto

Prepare the host for receiving sensitive information and puts the host in *prepared* mode Note: Must be invoked before *HostSystem.EnableCrypto*

Host System Query Host Connection Info

Connection-oriented information about a host.

Host System Query Memory Overhead

Determines the amount of memory overhead necessary to power on a virtual machine with the specified characteristics.

Host System Query Memory Overhead Ex

Determines the amount of memory overhead necessary to power on a virtual machine with the specified characteristics.

Host System Query Product Locker Location

Query the path to VMware Tools repository configured on the host.

Host System Query Tpm Attestation Report

Basic information about TPM attestation state of the host.

Host System Reboot Host Task

Reboots a host.

Host System Reconfigure Host For DAS Task

Reconfigures the host for vSphere HA.

Host System Reconnect Host Task

Reconnects to a host.

Host System Reload

Reload the entity state.

Host System Rename Task

Renames this managed entity.

Host System Retrieve Free Epc Memory

Return the amount of free EPC memory on the host in bytes.

Host System Retrieve Hardware Uptime

Return the hardware uptime of the host in seconds.

Host System Set Custom Value

Assigns a value to a custom field.

Host System Shutdown Host Task

Shuts down a host.

Host System Update Flags

Update flags that are part of the *HostFlagInfo* object.

Host System Update Ipmi

Update fields that are part of the *HostIpmiInfo* object.

Host System Update Product Locker Location Task

Change and reconfigure the VMware Tools repository on the host.

Host System Update System Resources

Update the configuration of the system resource hierarchy.

Host System Update System Swap Configuration

Update the System Swap Configuration.