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

Deprecated. As of vSphere API 5.1, local user groups are not supported and group specific methods will throw NotSupported.

Assigns a user to a group.

Required Privileges: Host.Local.ManageUserGroups

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the HostLocalAccountManager used to make the method call.
user	xsd:string	User ID of the account whose group membership is being assigned.
group	xsd:string	Destination group account to which the user is being assigned.

Return Value

Type	Description
None

Faults

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

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="AssignUserToGroup" type="vim25:AssignUserToGroupRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="AssignUserToGroupResponse">
            <complexType/>
         </element>

CreateGroup

Deprecated. As of vSphere API 5.1, local user groups are not supported and group specific methods will throw NotSupported.

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

Name	Type	Description
_this	ManagedObjectReference	A reference to the HostLocalAccountManager used to make the method call.
group	HostAccountSpec	Specification of group being created.

Return Value

Type	Description
None

Faults

Type	Description
AlreadyExists	Thrown if specified local group already exists.
InvalidArgument	Thrown if group name is in invalid format.
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

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="CreateGroup" type="vim25:CreateGroupRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="CreateGroupResponse">
            <complexType/>
         </element>

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

Name	Type	Description
_this	ManagedObjectReference	A reference to the HostLocalAccountManager used to make the method call.
user	HostAccountSpec	Specification of user being created.

Return Value

Type	Description
None

Faults

Type	Description
AlreadyExists	Thrown if the specified local user account already exists.
InvalidArgument	Thrown if the user name or password has an invalid format.
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

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="CreateUser" type="vim25:CreateUserRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="CreateUserResponse">
            <complexType/>
         </element>

RemoveGroup

Deprecated. As of vSphere API 5.1, local user groups are not supported and group specific methods will throw NotSupported.

Removes a local group account.

Required Privileges: Host.Local.ManageUserGroups

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the HostLocalAccountManager used to make the method call.
groupName	xsd:string	Group ID of the group account being removed.

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

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="RemoveGroup" type="vim25:RemoveGroupRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="RemoveGroupResponse">
            <complexType/>
         </element>

RemoveUser

Removes a local user account.

As of vSphere API 5.1, this operation will first try to remove all permissions associated with the specifed account. The permissions of the user are removed one by one, not atomically, and the operation is not rolled back, if the removal of some permission fails.

Required Privileges: Host.Local.ManageUserGroups

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the HostLocalAccountManager used to make the method call.
userName	xsd:string	User ID of the user account being removed.

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.
SecurityError	Thrown if trying to remove the last local user with DCUI access, or if trying to remove the last local user with full administrative privileges, or if the system has encountered an error while trying to remove user's permissions. or if the account cannot be removed due to permission issues.
UserNotFound	Thrown if the specified userName does not exist.

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="RemoveUser" type="vim25:RemoveUserRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="RemoveUserResponse">
            <complexType/>
         </element>

UnassignUserFromGroup

Deprecated. As of vSphere API 5.1, local user groups are not supported and group specific methods will throw NotSupported.

Unassigns a user from a group.

Required Privileges: Host.Local.ManageUserGroups

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the HostLocalAccountManager used to make the method call.
user	xsd:string	User being unassigned from group.
group	xsd:string	Group from which the user is being removed.

Return Value

Type	Description
None

Faults

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

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="UnassignUserFromGroup" type="vim25:UnassignUserFromGroupRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="UnassignUserFromGroupResponse">
            <complexType/>
         </element>

UpdateUser

Updates a local user account using the parameters defined in the HostLocalAccountManagerAccountSpecification data object type.

Required Privileges: Host.Local.ManageUserGroups

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the HostLocalAccountManager used to make the method call.
user	HostAccountSpec	Specification of user being updated.

Return Value

Type	Description
None

Faults

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

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="UpdateUser" type="vim25:UpdateUserRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="UpdateUserResponse">
            <complexType/>
         </element>