# Managed Object - HostAccessManager

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

## Managed Object Description

Properties

Name | Type | Description
--- | --- | ---
lockdownMode P | HostLockdownMode |

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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostAccessManager used to make the method call.
principal P | xsd:string | Since vSphere API 6.0
isGroup P | xsd:boolean | Since vSphere API 6.0
accessMode P | HostAccessMode | Since vSphere API 6.0

P Required privilege - see tooltip for details

Return Value

Type | Description
--- | ---
None

Faults

Type | Description
--- | ---
AuthMinimumAdminPermission |
RuntimeFault | Thrown 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostAccessManager used to make the method call.
mode P | HostLockdownMode | Since vSphere API 6.0

P Required privilege: mode

Return Value

Type | Description
--- | ---
None

Faults

Type | Description
--- | ---
AuthMinimumAdminPermission |
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

# QueryLockdownExceptions

Required Privileges
  Global.Settings

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostAccessManager used to make the method call.

Return Value

Type | Description
--- | ---
xsd:string[] |

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

# QuerySystemUsers

Required Privileges
  Global.Settings

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostAccessManager used to make the method call.

Return Value

Type | Description
--- | ---
xsd:string[] |

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

# RetrieveHostAccessControlEntries

Required Privileges
  Global.Settings

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostAccessManager used to make the method call.

Return Value

Type | Description
--- | ---
HostAccessControlEntry[] |

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

# UpdateLockdownExceptions

Required Privileges
  Global.Settings

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostAccessManager used to make the method call.
users* P | xsd:string[] | Since vSphere API 6.0

*Need not be set P Required privilege: users

Return Value

Type | Description
--- | ---
None

Faults

Type | Description
--- | ---
AuthMinimumAdminPermission |
RuntimeFault | Thrown 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the HostAccessManager used to make the method call.
users* P | xsd:string[] | Since vSphere API 6.0

*Need not be set P Required privilege: users

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.
UserNotFound |

Events

Type
None