Managed Object - HostAccessManager

Property of
HostConfigManager
See also
HostAccessControlEntry, HostAccessMode, HostLockdownMode
Since
vSphere API 6.0


Managed Object Description

Properties

Name Type Description
lockdownMode PHostLockdownMode


P Required privilege: System.View

Methods

Methods defined in this Managed Object
ChangeAccessMode, ChangeLockdownMode, QueryLockdownExceptions, QuerySystemUsers, RetrieveHostAccessControlEntries, UpdateLockdownExceptions, UpdateSystemUsers

ChangeAccessMode

Required Privileges
Global.Settings

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostAccessManager used to make the method call.
principal Pxsd:string

Since vSphere API 6.0
isGroup Pxsd:boolean

Since vSphere API 6.0
accessMode PHostAccessMode

Since vSphere API 6.0
PRequired privilege - see tooltip for details

Return Value

Type Description
None

Faults

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

Events

Type
None



ChangeLockdownMode

Required Privileges
Host.Config.Settings

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostAccessManager used to make the method call.
mode PHostLockdownMode

Since vSphere API 6.0
P Required privilege: mode

Return Value

Type Description
None

Faults

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

Events

Type
None



QueryLockdownExceptions

Required Privileges
Global.Settings

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostAccessManager used to make the method call.

Return Value

Type Description
xsd:string[]

Faults

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

Events

Type
None



QuerySystemUsers

Required Privileges
Global.Settings

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostAccessManager used to make the method call.

Return Value

Type Description
xsd:string[]

Faults

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

Events

Type
None



RetrieveHostAccessControlEntries

Required Privileges
Global.Settings

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostAccessManager used to make the method call.

Return Value

Type Description
HostAccessControlEntry[]

Faults

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

Events

Type
None



UpdateLockdownExceptions

Required Privileges
Global.Settings

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostAccessManager used to make the method call.
users* Pxsd:string[]

Since vSphere API 6.0
*Need not be set P Required privilege: users

Return Value

Type Description
None

Faults

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

Events

Type
None



UpdateSystemUsers

Required Privileges
Global.Settings

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostAccessManager used to make the method call.
users* Pxsd:string[]

Since vSphere API 6.0
*Need not be set P Required privilege: users

Return Value

Type Description
None

Faults

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

Events

Type
None