⇨

SEND US FEEDBACK!

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 Methods

Managed Object - HostImageConfigManager(vim.host.ImageConfigManager)

Property of: HostConfigManager
See also: HostImageProfileSummary, SoftwarePackage
Since: vSphere API 5.0

Managed Object Description

This managed object is the interface for configuration of the ESX software image, including properties such as acceptance level. It is currently designed to be host agent specific.

Properties

Name	Type	Description
None

Methods

Methods defined in this Managed Object
fetchSoftwarePackages, HostImageConfigGetAcceptance, HostImageConfigGetProfile, installDate, UpdateHostImageAcceptanceLevel

fetchSoftwarePackages

Reports the set of software packages installed. The CLI command is: esxcli software vib get

Required Privileges: Host.Config.Image
Since: vSphere API 6.5

Parameters

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

Return Value

Type	Description
SoftwarePackage[]

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="fetchSoftwarePackages" type="vim25:fetchSoftwarePackagesRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="fetchSoftwarePackagesResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vim25:SoftwarePackage" minOccurs="0" maxOccurs="unbounded"/>
               </sequence>
            </complexType>
         </element>

HostImageConfigGetAcceptance(queryHostAcceptanceLevel)

Queries the current host acceptance level setting.
See HostImageAcceptanceLevel

Required Privileges: System.Read

Parameters

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

Return Value

Type	Description
xsd:string

Faults

Type	Description
HostConfigFault	Thrown if the host acceptance setting is invalid. See HostImageAcceptanceLevel
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="HostImageConfigGetAcceptance" type="vim25:HostImageConfigGetAcceptanceRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="HostImageConfigGetAcceptanceResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="xsd:string"/>
               </sequence>
            </complexType>
         </element>

HostImageConfigGetProfile(queryHostImageProfile)

Queries the current host image profile information.
See HostImageProfileSummary

Required Privileges: System.Read

Parameters

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

Return Value

Type	Description
HostImageProfileSummary

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="HostImageConfigGetProfile" type="vim25:HostImageConfigGetProfileRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="HostImageConfigGetProfileResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vim25:HostImageProfileSummary"/>
               </sequence>
            </complexType>
         </element>

installDate

Reports the UTC time stamp when this system was first installed. The CLI command is: esxcli system stats installtime get

Required Privileges: Host.Config.Image
Since: vSphere API 6.5

Parameters

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

Return Value

Type	Description
xsd:dateTime

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="installDate" type="vim25:installDateRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="installDateResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="xsd:dateTime"/>
               </sequence>
            </complexType>
         </element>

UpdateHostImageAcceptanceLevel(updateAcceptanceLevel)

Sets the acceptance level of the host image profile.
See HostImageAcceptanceLevel

Required Privileges: Host.Config.Image

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the HostImageConfigManager used to make the method call.
newAcceptanceLevel	xsd:string	the new AcceptanceLevel to set. See HostImageAcceptanceLevel

Return Value

Type	Description
None

Faults

Type	Description
HostConfigFault	Thrown if the acceptance level is raised and there are VIB packages that are not permitted by the higher acceptance level. See HostImageAcceptanceLevel
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="UpdateHostImageAcceptanceLevel" type="vim25:UpdateHostImageAcceptanceLevelRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="UpdateHostImageAcceptanceLevelResponse">
            <complexType/>
         </element>

Feedback

1 2 3 4 5
0 Ratings