| Local Methods | ||
Managed Object Types | Data Object Types | All Properties | All Methods |
Properties
Name | Type | Description |
---|---|---|
None |
Methods
Methods defined in this Managed Object |
---|
AssignUserToGroup, ChangePassword, CreateGroup, CreateUser, RemoveGroup, RemoveUser, UnassignUserFromGroup, UpdateUser |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the HostLocalAccountManager used to make the method call. |
user P | xsd:string |
User ID of the account whose group membership is
being assigned.
Since 2.0 |
group P | xsd:string |
Destination group account to which the user is
being assigned.
Since 2.0 |
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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the HostLocalAccountManager used to make the method call. |
user P | xsd:string |
the user whose password will be changed.
Since vSphere API 6.7.2 |
oldPassword P | xsd:string |
the user's current (old) password.
Since vSphere API 6.7.2 |
newPassword P | xsd:string |
the user's new password.
Since vSphere API 6.7.2 |
Return Value
Type | Description |
---|---|
None |
Faults
Type | Description |
---|---|
InvalidLogin | Thrown if the user and oldPassword combination is not valid. |
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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the HostLocalAccountManager used to make the method call. |
group P | HostAccountSpec |
Specification of group being created.
Since 2.0 |
Return Value
Type | Description |
---|---|
None |
Faults
Type | Description |
---|---|
AlreadyExists | Thrown if specified local group already exists. |
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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the HostLocalAccountManager used to make the method call. |
user P | HostAccountSpec |
Specification of user being created.
Since 2.0 |
Return Value
Type | Description |
---|---|
None |
Faults
Type | Description |
---|---|
AlreadyExists | Thrown if the specified local user account already exists. |
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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the HostLocalAccountManager used to make the method call. |
groupName P | xsd:string |
Group ID of the group account being removed.
Since 2.0 |
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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the HostLocalAccountManager used to make the method call. |
userName P | xsd:string |
User ID of the user account being removed.
Since 2.0 |
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 userName does not exist. |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the HostLocalAccountManager used to make the method call. |
user P | xsd:string |
User being unassigned from group.
Since 2.0 |
group P | xsd:string |
Group from which the user is being removed.
Since 2.0 |
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 user or group does not exist. |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the HostLocalAccountManager used to make the method call. |
user P | HostAccountSpec |
Specification of user being updated.
Since 2.0 |
Return Value
Type | Description |
---|---|
None |
Faults
Type | Description |
---|---|
AlreadyExists | Thrown if new account specification specifies an existing user's ID. |
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 |
Top of page | Local Methods | ||
Managed Object Types | Data Object Types | All Properties | All Methods |