vSphere API/SDK Documentation > vSphere Management SDK > vSphere Web Services SDK Documentation > VMware vSphere API Reference > Managed Object Types > H

1 2 3 4 5
0 Ratings

Local Properties

Local Methods

Managed Object Types

Data Object Types

All Properties

All Methods

Managed Object - HostAutoStartManager(vim.host.AutoStartManager)

Property of: HostConfigManager
See also: HostAutoStartManagerConfig

Managed Object Description

The AutoStartManager allows clients to invoke and set up the auto-start/auto-stop order of virtual machines on a single host. Virtual machines configured to use auto-start are automatically started or stopped when the host is started or shut down. The AutoStartManager is available when clients connect directly to a host, such as an ESX Server machine or through VirtualCenter.

Properties

Name	Type	Description
config	HostAutoStartManagerConfig

Methods

Methods defined in this Managed Object
AutoStartPowerOff, AutoStartPowerOn, ReconfigureAutostart

AutoStartPowerOff(autoPowerOff)

Powers-off virtual machines according to the current AutoStart configuration.

See the description of the (@link vim.host.AutoStartManager.AutoPowerInfo) data object type for more information on Auto power-off behavior.

Required Privileges: Host.Config.AutoStart

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the HostAutoStartManager used to make the method call.

Return Value

Type	Description
None

Faults

Type	Description
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="AutoStartPowerOff" type="vim25:AutoStartPowerOffRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="AutoStartPowerOffResponse">
            <complexType/>
         </element>

AutoStartPowerOn(autoPowerOn)

Powers-on virtual machines according to the current AutoStart configuration.

See the description of the (@link vim.host.AutoStartManager.AutoPowerInfo) data object type for more information on Auto power-on behavior.

Required Privileges: Host.Config.AutoStart

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the HostAutoStartManager used to make the method call.

Return Value

Type	Description
None

Faults

Type	Description
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="AutoStartPowerOn" type="vim25:AutoStartPowerOnRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="AutoStartPowerOnResponse">
            <complexType/>
         </element>

ReconfigureAutostart(reconfigure)

Changes the power-on or power-off sequence and system defaults. The specification is an incremental change to the current configuration.

If systemDefaults are included, only values that are specified in the specification are changed.

For the spec.powerInfo array, each element is interpreted as an incremental change and the changes are processed sequentially. It is not an error to remove a non-existing virtual machine. If both startAction and stopAction are set to none, then the virtual machine is removed from the configuration.

A virtual machine's position in the order can be changed either by assigning the virtual machine a different position in the order or removing the machine from the order. When a virtual machine's position changes, all other virtual machines' positions may be affected as they move to new positions relative to each other.

Required Privileges: Host.Config.AutoStart

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the HostAutoStartManager used to make the method call.
spec	HostAutoStartManagerConfig	List of changes to defaults and auto-start/auto-stop order.

Return Value

Type	Description
None

Faults

Type	Description
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="ReconfigureAutostart" type="vim25:ReconfigureAutostartRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="ReconfigureAutostartResponse">
            <complexType/>
         </element>

Feedback

1 2 3 4 5
0 Ratings