User Management Commands

user

Syntax

[no] user user-name

Context

config>system>security

Description

This command creates a local user and a context to edit the user configuration.

If a new user-name is entered, the user is created. When an existing user-name is specified, the user parameters can be edited.

When a new user is created and the info command is entered, the system displays a password with hash2 encryption in the output screen. However, when using that username, there is no password required. The user can log in to the system by entering their username and then pressing ↵ at the password prompt.

Unless an administrator explicitly changes the password, it is null. The hashed value displayed uses the username and null password field, so when the username is changed, the displayed hashed value changes.

The no form of the command deletes the user and all configuration data. Users cannot delete themselves.

Default

n/a

Parameters

user-name

the name of the user, up to 32 characters

user-template

Syntax

user-template {tacplus_default | radius_default}

Context

config>system>security

Description

This command configures default security user template parameters.

Parameters

tacplus_default

specifies that the TACACS+ default template is used for the configuration

radius_default

specifies that the RADIUS default template is used for the configuration

access

Syntax

[no] access [ftp] [snmp] [console]

[no] access [ftp] [console]

Context

config>system>security>user

config>system>security>user-template

Description

This command grants a user permission for FTP, SNMP, or console access.

If a user requires access to more than one application, then multiple applications can be specified in a single command. Multiple commands are treated sequentially.

The no form of the command removes access for a specific application.

The no access command denies permission for all management access methods. To deny a single access method, enter the no form of the command followed by the method to be denied; for example, no access ftp denies FTP access.

Default

no access

Parameters

ftp

specifies FTP permission

snmp

specifies SNMP permission. This keyword is only configurable in the config>system>security>user context.

console

specifies console access (serial port or Telnet) permission

console

Syntax

console

Context

config>system>security>user

config>system>security>user-template

Description

This command enables the context to configure user profile membership for the console.

cannot-change-password

Syntax

[no] cannot-change-password

Context

config>system>security>user>console

Description

This command allows a user to change their password for both FTP and console login.

To disable a user’s privilege to change their password, use the cannot-change-password form of the command.

The cannot-change-password flag is not replicated when a user copy is performed. A new-password-at-login flag is created instead.

Default

no cannot-change-password

login-exec

Syntax

[no] login-exec url-prefix:source-url

Context

config>system>security>user>console

config>system>security>user-template>console

Description

This command configures a user’s login exec file, which executes whenever the user successfully logs in to a console session.

Only one exec file can be configured. If multiple login-exec commands are entered for the same user, each subsequent entry overwrites the previous entry.

The no form of the command disables the login exec file for the user.

Default

no login exec file is defined

Parameters

url-prefix: source-url

enter either a local or remote URL, up to 200 characters in length, that identifies the exec file that is executed after the user successfully logs in

member

Syntax

member user-profile-name [user-profile-name]

no member user-profile-name

Context

config>system>security>user>console

Description

This command allows the user access to a profile.

A user can participate in up to eight profiles.

The no form of this command deletes access user access to a profile.

Default

default

Parameters

user-profile-name

the user profile name

new-password-at-login

Syntax

[no] new-password-at-login

Context

config>system>security>user>console

Description

This command forces the user to change passwords at the next console or FTP login.

If the user is limited to FTP access, the administrator must create the new password.

The no form of the command does not force the user to change passwords.

Default

no new-password-at-login

home-directory

Syntax

home-directory url-prefix [directory] [directory/directory]

no home-directory

Context

config>system>security>user

config>system>security>user-template

Description

This command configures the local home directory for the user for both console and FTP access.

If the URL or the specified URL/directory structure is not present, then a warning message is issued and the default is assumed.

The no form of the command removes the configured home directory.

Default

no home-directory

Note:

If restricted-to-home has been configured, no file access is granted and no home directory is created; if restricted-to-home is not applied, root becomes the user’s home directory.

Parameters

url-prefix [directory] [directory/directory…]

the user’s local home directory URL prefix and directory structure, up to 190 characters in length

password

Syntax

password [password]

Context

config>system>security>user

Description

This command configures the user password for console and FTP access.

Passwords must be enclosed in double quotes (‟ ”) at the time of password creation if they contain any special characters (such as #, $, or spaces). The double quote character (‟) is not accepted inside a password. It is interpreted as the start or stop delimiter of a string.

The question mark character (?) cannot be directly inserted as input during a Telnet connection because the character is bound to the help command during a normal Telnet/console connection. To insert # or ? characters, they must be entered inside a notepad or clipboard program and then cut and pasted into the Telnet session in the password field that is encased in double quotes as delimiters for the password.

If a password is entered without any parameters, a password length of zero is implied (return key).

The password is stored in an encrypted format in the configuration file when specified.

Parameters

password

the password that must be entered by this user during the login procedure. The minimum length of the password is determined by the minimum-length command. The maximum length is as follows:

  • 56 characters if in unhashed plaintext

    The unhashed plaintext form must meet all the requirements that are defined within the complexity-rules command context.

  • 60 characters if hashed with bcrypt

  • from 87 to 92 characters if hashed with PBKDF2 SHA-2

  • from 131 to 136 characters if hashed with PBKDF2 SHA-3

public-keys

Syntax

public-keys

Context

config>system>security>user

Description

This command enables the context to configure public keys for SSH.

ecdsa

Syntax

ecdsa

Context

config>system>security>user>public-keys

Description

This command enables the context to configure ECDSA public keys.

ecdsa-key

Syntax

ecdsa-key key-id [create]

no ecdsa-key key-id

Context

config>system>security>user>public-keys>ecdsa

Description

This command creates an ECDSA public key and associates it with the specified user. Multiple public keys can be associated with the user. The key ID is used to identify these keys for the user.

Default

n/a

Parameters

key-id

the key identifier

Values

1 to 32

create

keyword required when first creating the ECDSA key. When the key is created, you can navigate into the context without the create keyword.

key-value

Syntax

key-value public-key-value

no key-value

Context

config>system>security>user>public-keys>ecdsa>ecdsa-key

config>system>security>user>public-keys>rsa>rsa-key

Description

This command configures a value for the ECDSA or RSA public key. The public key must be enclosed in quotation marks. For ECDSA, the key is between 1 and 1024 bits. For RSA, the key is between 768 and 4096 bits.

Default

no key-value

Parameters

public-key-value

the value for the ECDSA or RSA key

Values

255 characters max (ECDSA)

800 characters max (RSA)

rsa

Syntax

rsa

Context

config>system>security>user>public-keys

Description

This command enables the context to configure RSA public keys.

rsa-key

Syntax

rsa-key key-id [create]

no rsa-key key-id

Context

config>system>security>user>public-keys>rsa

Description

This command creates an RSA public key and associates it with the specified user. Multiple public keys can be associated with the user. The key ID is used to identify these keys for the user.

Parameters

key-id

the key identifier

Values

1 to 32

create

keyword required when first creating the RSA key. When the key is created, you can navigate into the context without the create keyword.

restricted-to-home

Syntax

[no] restricted-to-home

Context

config>system>security>user

config>system>security>user-template

Description

This command prevents users from navigating above their home directories for file access. A user is not allowed to navigate to a directory higher in the directory tree on the home directory device. The user is allowed to create and access subdirectories below their home directory.

If a home directory is not configured or the home directory is not available, then the user has no file access.

The no form of the command allows the user access to navigate to directories above their home directory.

Default

no restricted-to-home

snmp

Syntax

snmp

Context

config>system>security>user

Description

This command enables the context to configure SNMP group membership for a specific user and defines encryption and authentication parameters.

All SNMPv3 users must be configured with the commands available in this CLI context.

The 7705 SAR always uses the configured SNMPv3 username as the security username.

authentication

Syntax

authentication none

authentication authentication-protocol authentication-key [privacy none] [hash | hash2]

authentication authentication-protocol authentication-key privacy privacy-protocol privacy-key [hash | hash2]

no authentication

Context

config>system>security>user>snmp

Description

This command configures the SNMPv3 authentication and privacy protocols for the user to communicate with the router. The keys are stored in an encrypted format in the configuration.

The keys configured with these commands must be localized keys, which are a hash of the SNMP engine ID and a password. The password is not entered directly in this command. Use the generate-key command under the tools>perform>system>management-interface >snmp context to generate localized authentication and privacy keys. See the 7705 SAR OAM and Diagnostics Guide, ‟Tools Perform Commands” for information about this command.

If authentication none is configured, only the username is required to allow and authenticate SNMPv3 operations.

The no form of the command prevents the username used to configure the command from getting recognized by SNMP, and the same user cannot be used for any SNMP operations.

Default

authentication none — no authentication protocol is configured and privacy cannot be configured

Parameters

none

specifies that no authentication protocol is used

authentication-protocol authentication-key

specifies the SNMPv3 authentication protocol and localized authentication key

Values

hmac-md5-96 — specifies use of the HMAC-MD5-96 authentication protocol; the key must be entered as a 32-character hexadecimal string

hmac-sha1-96 — specifies use of the HMAC-SHA1-96 authentication protocol; the key must be entered as a 40-character hexadecimal string

hmac-sha2-224 — specifies use of the HMAC-SHA2-224 authentication protocol; the key must be entered as a 56-character hexadecimal string

hmac-sha2-256 — specifies use of the HMAC-SHA2-256 authentication protocol; the key must be entered as a 64-character hexadecimal string

hmac-sha2-384 — specifies use of the HMAC-SHA2-384 authentication protocol; the key must be entered as a 96-character hexadecimal string

hmac-sha2-512 — specifies use of the HMAC-SHA2-512 authentication protocol; the key must be entered as a 128-character hexadecimal string

privacy-protocol privacy-key

specifies the SNMPv3 privacy protocol and localized privacy key

Values

cbc-des — specifies use of the CBC-DES privacy protocol; the key must be entered as a 32-character hexadecimal string. This parameter is not available in FIPS-140-2 mode.

cfb128-aes-128 — specifies use of the CFB128-AES-128 privacy protocol; the key must be entered as a 32-character hexadecimal string

cfb128-aes-192 — specifies use of the CFB128-AES-192 privacy protocol; the key must be entered as a 48-character hexadecimal string

cfb128-aes-256 — specifies use of the CFB128-AES-256 privacy protocol; the key must be entered as a 64-character hexadecimal string

privacy none

specifies that a privacy protocol is not used in the communication

Default

privacy none

hash

specifies that the key is entered in an encrypted form. If the hash parameter is not used, the key is assumed to be in an unencrypted, clear text form. For security, all keys are stored in encrypted form in the configuration file with the hash parameter specified.

hash2

specifies that the key is entered in a more complex encrypted form. If the hash2 parameter is not used, the less encrypted hash form is assumed.

group

Syntax

group group-name

no group

Context

config>system>security>user>snmp

Description

This command associates (or links) a user to a group name. The access command links the group with one or more views, security models, security levels, and read, write, and notify permissions.

Default

no group name is associated with a user

Parameters

group-name

enter the group name (between 1 and 32 alphanumeric characters) that is associated with this user. A user can be associated with one group name per security model.