| 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, CreateGroup, CreateUser, RemoveGroup, RemoveUser, UnassignUserFromGroup, UpdateUser |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
Top of page | Local Methods | ||
Managed Object Types | Data Object Types | All Properties | All Methods |