Managed Object - HostLocalAccountManager

Property of: HostConfigManager, ServiceContent
See also: HostAccountSpec
Since: null

Managed Object Description

Properties

Name	Type	Description
None

Methods

Methods defined in this Managed Object
AssignUserToGroup, ChangePassword, CreateGroup, CreateUser, RemoveGroup, RemoveUser, UnassignUserFromGroup, UpdateUser

AssignUserToGroup

Deprecated.

Required Privileges: Host.Local.ManageUserGroups

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

user P

xsd:string

Since null

group P

xsd:string

Since null

PRequired privilege - see tooltip for details

Return Value

Type	Description
None

Faults

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

ChangePassword

Required Privileges: System.Anonymous
Since: vSphere API 6.7.2

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the HostLocalAccountManager used to make the method call.
user P	xsd:string	*Since* vSphere API 6.7.2
oldPassword P	xsd:string	*Since* vSphere API 6.7.2
newPassword P	xsd:string	*Since* vSphere API 6.7.2

PRequired privilege - see tooltip for details

Return Value

Type	Description
None

Faults

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

CreateGroup

Deprecated.

Required Privileges: Host.Local.ManageUserGroups

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

group P

HostAccountSpec

Since null

P Required privilege: group

Return Value

Type	Description
None

Faults

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

CreateUser

Required Privileges: Host.Local.ManageUserGroups

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

user P

HostAccountSpec

Since null

P Required privilege: user

Return Value

Type	Description
None

Faults

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

RemoveGroup

Deprecated.

Required Privileges: Host.Local.ManageUserGroups

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

groupName P

xsd:string

Since null

P Required privilege: groupName

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

RemoveUser

Required Privileges: Host.Local.ManageUserGroups

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

userName P

xsd:string

Since null

P Required privilege: userName

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

UnassignUserFromGroup

Deprecated.

Required Privileges: Host.Local.ManageUserGroups

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

user P

xsd:string

Since null

group P

xsd:string

Since null

PRequired privilege - see tooltip for details

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

UpdateUser

Required Privileges: Host.Local.ManageUserGroups

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

user P

HostAccountSpec

Since null

P Required privilege: user

Return Value

Type	Description
None

Faults

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