vicfg-user Command Syntax

The vicfg-user syntax differs from other vCLI commands.

You specify operations by using the following syntax.

vicfg-user <conn_options> -e <user> -o <add|modify|delete|list>

If you create a user without specifying the role (--role), the user has no permissions. You cannot change the user's role, you can only change the user's permission.

Important

You cannot use the vicfg-user command to modify users created with the vSphere Client in vSphere 6.0 or earlier.

Options

The vicfg-user command-specific options manipulate users. You must also specify connection options. See Connection Options for vCLI Host Management Commands.

Option	Description
`--adduser <user_list>` `-u <user_list>`	Adds the specified users. Takes a comma-separated list of users.
`--entity <user>` `-e <user>`	Entity to perform the operation on. Starting with vSphere 5.1, `entity` is always `user`.
`--login <login_id>` `-l <login_id>`	Login ID of the user.
`--newpassword <p_wd>` `-p <p_wd>`	Password for the target user.
`--newuserid <UUID>` `-i <UUID>`	New UUID for the target user.
`--newusername <name>` `-n <name>`	New user name for the target user.
`--operation` `-o`	Operation to perform. Specify `add`, `modify`, `delete`, or `list`.
`--role <admin\|read-only\|no-access>` `-r <admin\|read-only\|no-access>`	Role for the target user. Specify one of `admin`, `read-only`, or `no-access`. Users that you create without assigning permissions have no permissions.
`--shell` `-s`	Grant shell access to the target user. Default is no shell access. Use this command to change the default or to revoke shell access rights after they have been granted. Valid values are `yes` and `no`. This option is not supported against vSphere 5.0 systems. The option is supported only against ESX. The option is not supported against ESXi.