snmp-v3-add-agent-user

avcli snmp-v3-add-agent-user --username username --security-level security_level [--authentication-type type] [--authentication-pass-phrase pass_phrase] [--encryption-type type] [--encryption-pass-phrase pass_phrase]

Description

The snmp-v3-add-agent-user command adds an SNMPv3 user (username) with read-only access to the everRun system. Other SNMPv3 servers can then send an SNMPv3 request (for example, snmpwalk) to this user in order to retrieve the values of objects listed in the management information base (MIB) files.
The system supports only one SNMPv3 user. If an SNMPv3 user already exists on the system and you issue this command, the command does not add the user, but displays an error message.
Create the SNMPv3 user on both nodes.

Options

--username username The name of a user who has access to the SNMPv3 agent. username must be unique.
--security-level security-level

The user's security level. Valid values are:

  • auth for authentication and no privacy: Messages are authenticated, but not encrypted. --authentication-type and --authentication-pass-phrase are required. --encryption-type and --encryption-pass-phrase are optional.
  • noauth for no authentication and no privacy: No security is applied to messages; messages are not authenticated or encrypted. --authentication-type, --authentication-pass-phrase, --encryption-type, and --encryption-pass-phrase are optional.
  • priv for authentication and privacy: Messages are authenticated and encrypted. --authentication-type, --authentication-pass-phrase, --encryption-type, and --encryption-pass-phrase are required.
--authentication-type type

The user's type of authentication. Valid values are:

  • MD5: Configure the message digest algorithm (MD5) as the user's authentication type.
  • SHA: Configure the secure hash algorithm (SHA) as the user's authentication type.
--authentication-pass-phrase pass_phrase The user's required pass phrase, which is used to generate the secret authentication key. The pass_phrase must be a minimum of eight characters.
--encryption-type type

The user's type of encryption. Valid values are:

  • AES: Configure the Advanced Encryption Standard (AES) as the user's encryption type.
  • DES: Configure the data encryption standard (DES) as the user's encryption type.
--encryption-pass-phrase pass_phrase The user's required pass phrase, which is used to generate the secret encryption key. The pass_phrase must be a minimum of eight characters.

Examples

The following example adds the agent user agentUser1 to the system. The SNMPv3 messages that agentUser1 sends will be authenticated and encrypted.
$ avcli snmp-v3-add-agent-user --username agentUser1 --security-level priv --authentication-type MD5 --authentication-pass-phrase agentUser1AuthPassPhrase --encryption-type AES --encryption-pass-phrase agentUser1EncriptPassPhrase
The following example adds the agent user agentUser2 to the system. The SNMPv3 messages that agentUser2 sends will be authenticated, but not encrypted.
$ avcli snmp-v3-add-agent-user --username agentUser2 --security-level auth --authentication-type SHA --authentication-pass-phrase agentUser2AuthPassPhrase
The following example adds the agent user agentUser3 to the system. The SNMPv3 messages that agentUser3 sends will not be authenticated or encrypted.
$ avcli snmp-v3-add-agent-user --username agentUser3 --security-level noauth