user_modify

This job modifies a given user (identified by username) and syncs the changes on all nodes.

Mandatory Parameters

Parameter Name Data Type Description
username string String containing the name of the user.

Optional Parameters

Parameter Name Data Type Description
group string, integer String containing the primary group ID or group name for the user.
login_enabled boolean Boolean value defining if login is allowed (true) or not (false).
additional_groups list Comma-separated list of group names of additional groups that the user should be a member of. Example: [root, exausers]
authorized_keys list A list of authorized keys for the user.

Substitute Parameters

There are no substitute parameters.

Allowed Users

The following users are allowed to run this job:

  • root

Allowed Groups

The following groups are allowed to run this job:

  • root
  • exaadm

Examples

The following code snippets show how to use this job using both Python (via XML-RPC) and on the command-line using confd_client.

conn.job_exec('user_modify', {'params': {'username': 'user_1'}})
confd_client user_modify username: user_1