Managed Object - HostLocalAccountManager

Property of
ServiceContent
See also
HostAccountSpec

Managed Object Description

This managed object type provides an interface through which local accounts on a host are managed. Note that this managed object applies only to applications that use a local account database on the host to provide authentication (ESX Server, for example). POSIX and win32 hosts may impose different restrictions on the password, ID, and description formats. POSIX host implementation may restrict the user or group name to be lower case letters and less than 16 characters in total. It may also disallow characters such as ";", "\n", and so on. In short, all the platform dependent rules and restrictions regarding naming of users/groups and password apply here. An InvalidArgument fault is thrown if any of these rules are not obeyed.

Properties

Name Type Description
None

Methods

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

AssignUserToGroup

Assigns a user to a group.
Required Privileges
Host.Local.ManageUserGroups

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostLocalAccountManager used to make the method call.
userxsd:string User ID of the account whose group membership is being assigned.
groupxsd:string Destination group account to which the user is being assigned.

Return Value

Type Description
None

Faults

Type Description
AlreadyExistsThrown if the user is already a member of the target group.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
UserNotFoundThrown if the specified user or group does not exist.

Show WSDL type definition



CreateGroup

Creates a local group account using the parameters defined in the HostLocalAccountManagerAccountSpecification data object type. For POSIX hosts, passing the HostLocalAccountManagerPosixAccountSpecification data object type allows you to control the group ID format of the group account being created.
Required Privileges
Host.Local.ManageUserGroups

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostLocalAccountManager used to make the method call.
groupHostAccountSpec Specification of group being created.

Return Value

Type Description
None

Faults

Type Description
AlreadyExistsThrown if specified local group already exists.
InvalidArgumentThrown if group name is in invalid format.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Show WSDL type definition



CreateUser

Creates a local user account using the parameters defined in the HostLocalAccountManagerAccountSpecification data object type. For POSIX hosts, passing HostLocalAccountManagerPosixAccountSpecification data object type allows you to control the format of the user ID of the user account being created.
Required Privileges
Host.Local.ManageUserGroups

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostLocalAccountManager used to make the method call.
userHostAccountSpec Specification of user being created.

Return Value

Type Description
None

Faults

Type Description
AlreadyExistsThrown if the specified local user account already exists.
InvalidArgumentThrown if the user name or password has an invalid format.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Show WSDL type definition



RemoveGroup

Removes a local group account.
Required Privileges
Host.Local.ManageUserGroups

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostLocalAccountManager used to make the method call.
groupNamexsd:string Group ID of the group account being removed.

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.
UserNotFoundThrown if the specified groupName does not exist.

Show WSDL type definition



RemoveUser

Removes a local user account.
Required Privileges
Host.Local.ManageUserGroups

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostLocalAccountManager used to make the method call.
userNamexsd:string User ID of the user account being removed.

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.
UserNotFoundThrown if the specified userName does not exist.

Show WSDL type definition



UnassignUserFromGroup

Unassigns a user from a group.
Required Privileges
Host.Local.ManageUserGroups

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostLocalAccountManager used to make the method call.
userxsd:string User being unassigned from group.
groupxsd:string Group from which the user is being removed.

Return Value

Type Description
None

Faults

Type Description
NoPermissionThrown if the group is the only group to which the user belongs.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
UserNotFoundThrown if the specified user or group does not exist.

Show WSDL type definition



UpdateUser

Updates a local user account using the parameters defined in the HostLocalAccountManagerAccountSpecification data object type.
Required Privileges
Host.Local.ManageUserGroups

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostLocalAccountManager used to make the method call.
userHostAccountSpec Specification of user being updated.

Return Value

Type Description
None

Faults

Type Description
AlreadyExistsThrown if new account specification specifies an existing user's ID.
InvalidArgumentThrown if new password or description has an invalid format.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
UserNotFoundThrown if user is not found.

Show WSDL type definition