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

NameTypeDescription
_thisManagedObjectReference A reference to the GuestAliasManager used to make the method call.
vm PManagedObjectReference
to a VirtualMachine

Since vSphere API 6.0
auth PGuestAuthentication

Since vSphere API 6.0
username Pxsd:string

Since vSphere API 6.0
mapCert Pxsd:boolean

Since vSphere API 6.0
base64Cert Pxsd:string

Since vSphere API 6.0
aliasInfo PGuestAuthAliasInfo

Since vSphere API 6.0
PRequired privilege - see tooltip for details

Return Value

Type Description
None

Faults

Type Description
GuestOperationsFault
InvalidState
RuntimeFaultThrown 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

NameTypeDescription
_thisManagedObjectReference A reference to the GuestAliasManager used to make the method call.
vm PManagedObjectReference
to a VirtualMachine

Since vSphere API 6.0
auth PGuestAuthentication

Since vSphere API 6.0
username Pxsd:string

Since vSphere API 6.0
PRequired privilege - see tooltip for details

Return Value

Type Description
GuestAliases[]

Faults

Type Description
GuestOperationsFault
InvalidState
RuntimeFaultThrown 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

NameTypeDescription
_thisManagedObjectReference A reference to the GuestAliasManager used to make the method call.
vm PManagedObjectReference
to a VirtualMachine

Since vSphere API 6.0
auth PGuestAuthentication

Since vSphere API 6.0
PRequired privilege - see tooltip for details

Return Value

Type Description
GuestMappedAliases[]

Faults

Type Description
GuestOperationsFault
InvalidState
RuntimeFaultThrown 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

NameTypeDescription
_thisManagedObjectReference A reference to the GuestAliasManager used to make the method call.
vm PManagedObjectReference
to a VirtualMachine

Since vSphere API 6.0
auth PGuestAuthentication

Since vSphere API 6.0
username Pxsd:string

Since vSphere API 6.0
base64Cert Pxsd:string

Since vSphere API 6.0
subject PGuestAuthSubject

Since vSphere API 6.0
PRequired privilege - see tooltip for details

Return Value

Type Description
None

Faults

Type Description
GuestOperationsFault
InvalidState
RuntimeFaultThrown 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

NameTypeDescription
_thisManagedObjectReference A reference to the GuestAliasManager used to make the method call.
vm PManagedObjectReference
to a VirtualMachine

Since vSphere API 6.0
auth PGuestAuthentication

Since vSphere API 6.0
username Pxsd:string

Since vSphere API 6.0
base64Cert Pxsd:string

Since vSphere API 6.0
PRequired privilege - see tooltip for details

Return Value

Type Description
None

Faults

Type Description
GuestOperationsFault
InvalidState
RuntimeFaultThrown 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