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

NameTypeDescription
_thisManagedObjectReference A reference to the HostLocalAccountManager used to make the method call.
user Pxsd:string

Since null
group Pxsd:string

Since null
PRequired privilege - see tooltip for details

Return Value

Type Description
None

Faults

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



ChangePassword

Required Privileges
System.Anonymous
Since
vSphere API 6.7.2

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostLocalAccountManager used to make the method call.
user Pxsd:string

Since vSphere API 6.7.2
oldPassword Pxsd:string

Since vSphere API 6.7.2
newPassword Pxsd:string

Since vSphere API 6.7.2
PRequired privilege - see tooltip for details

Return Value

Type Description
None

Faults

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



CreateGroup

Deprecated.

Required Privileges
Host.Local.ManageUserGroups

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostLocalAccountManager used to make the method call.
group PHostAccountSpec

Since null
P Required privilege: group

Return Value

Type Description
None

Faults

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



CreateUser

Required Privileges
Host.Local.ManageUserGroups

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostLocalAccountManager used to make the method call.
user PHostAccountSpec

Since null
P Required privilege: user

Return Value

Type Description
None

Faults

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



RemoveGroup

Deprecated.

Required Privileges
Host.Local.ManageUserGroups

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostLocalAccountManager used to make the method call.
groupName Pxsd:string

Since null
P Required privilege: groupName

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



RemoveUser

Required Privileges
Host.Local.ManageUserGroups

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostLocalAccountManager used to make the method call.
userName Pxsd:string

Since null
P Required privilege: userName

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



UnassignUserFromGroup

Deprecated.

Required Privileges
Host.Local.ManageUserGroups

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostLocalAccountManager used to make the method call.
user Pxsd:string

Since null
group Pxsd:string

Since null
PRequired privilege - see tooltip for details

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



UpdateUser

Required Privileges
Host.Local.ManageUserGroups

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostLocalAccountManager used to make the method call.
user PHostAccountSpec

Since null
P Required privilege: user

Return Value

Type Description
None

Faults

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