Managed Object - GuestAliasManager

Property of: GuestOperationsManager
See also: GuestAliases, GuestAuthAliasInfo, GuestAuthentication, GuestAuthSubject, GuestMappedAliases, VirtualMachine
Since: vSphere API 6.0

Managed Object Description

Properties

Name	Type	Description
None

Methods

Methods defined in this Managed Object
AddGuestAlias, ListGuestAliases, ListGuestMappedAliases, RemoveGuestAlias, RemoveGuestAliasByCert

AddGuestAlias

Required Privileges: None

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the GuestAliasManager used to make the method call.
vm P	ManagedObjectReference to a VirtualMachine	*Since* vSphere API 6.0
auth P	GuestAuthentication	*Since* vSphere API 6.0
username P	xsd:string	*Since* vSphere API 6.0
mapCert P	xsd:boolean	*Since* vSphere API 6.0
base64Cert P	xsd:string	*Since* vSphere API 6.0
aliasInfo P	GuestAuthAliasInfo	*Since* vSphere API 6.0

PRequired privilege - see tooltip for details

Return Value

Type	Description
None

Faults

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

Events

Type
None

ListGuestAliases

Required Privileges: None

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the GuestAliasManager used to make the method call.
vm P	ManagedObjectReference to a VirtualMachine	*Since* vSphere API 6.0
auth P	GuestAuthentication	*Since* vSphere API 6.0
username P	xsd:string	*Since* vSphere API 6.0

PRequired privilege - see tooltip for details

Return Value

Type	Description
GuestAliases[]

Faults

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

Events

Type
None

ListGuestMappedAliases

Required Privileges: None

Parameters

Name

Type

Description

_this

ManagedObjectReference

A reference to the GuestAliasManager used to make the method call.

vm P

ManagedObjectReference
to a VirtualMachine

Since vSphere API 6.0

auth P

GuestAuthentication

Since vSphere API 6.0

PRequired privilege - see tooltip for details

Return Value

Type	Description
GuestMappedAliases[]

Faults

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

Events

Type
None

RemoveGuestAlias

Required Privileges: None

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the GuestAliasManager used to make the method call.
vm P	ManagedObjectReference to a VirtualMachine	*Since* vSphere API 6.0
auth P	GuestAuthentication	*Since* vSphere API 6.0
username P	xsd:string	*Since* vSphere API 6.0
base64Cert P	xsd:string	*Since* vSphere API 6.0
subject P	GuestAuthSubject	*Since* vSphere API 6.0

PRequired privilege - see tooltip for details

Return Value

Type	Description
None

Faults

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

Events

Type
None

RemoveGuestAliasByCert

Required Privileges: None

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the GuestAliasManager used to make the method call.
vm P	ManagedObjectReference to a VirtualMachine	*Since* vSphere API 6.0
auth P	GuestAuthentication	*Since* vSphere API 6.0
username P	xsd:string	*Since* vSphere API 6.0
base64Cert P	xsd:string	*Since* vSphere API 6.0

PRequired privilege - see tooltip for details

Return Value

Type	Description
None

Faults

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

Events

Type
None