ssosnmpv3setup
- Organization of this page
Format
- To add or change an SNMPv3 definition:
ssosnmpv3setup -add unique-name user-name [authentication-type authentication-password [privacy-type privacy-password]] [-context context-name]
- To display a registered SNMPv3 definition:
ssosnmpv3setup -view [unique-name ...]
- To delete a registered SNMPv3 definition:
ssosnmpv3setup -del {-all | unique-name ...}
- To output the command usage:
ssosnmpv3setup -h
Function
The ssosnmpv3setup command is used to register, display, or delete SNMPv3 definition information.
Options
-add
Specify this option when you register a new SNMPv3 definition or change a registered definition.
-view
Outputs the information about the SNMPv3 definition registered as the specified unique name to the standard output. If you omit the unique name, the information about all registered SNMPv3 definitions is output.
-del
Deletes the SNMPv3 definition registered as the specified unique name. If you also specify -all, all registered SNMPv3 definitions are deleted.
unique-name
Specify a unique name of 1 to 80 ASCII characters. Do not include a colon (:) or hyphen (-) in the unique name.
A unique name identifies an SNMPv3 definition. The unique name you specified here is specified as a unique name in the SNMP definition file.
user-name
Specify an SNMPv3 user name of 1 to 255 ASCII characters.
authentication-type
Specify either of the following as the authentication types:
-
MD5
-
SHA
authentication-password
Specify an authentication password of 1 to 255 ASCII characters.
privacy-type
Specify one of the following as the privacy type (encryption type):
-
DES
-
3DES
-
AES128
-
AES192
-
AES256
privacy-password
Specify a privacy password (encryption password) of 1 to 255 ASCII characters.
-context context-name
If desired, use this option to specify a context name of 1 to 255 ASCII characters.
Return values
0 |
Normal termination |
-1 |
Execution error such as incorrect arguments |
-2 |
The specified unique name is not registered (This value is not returned when the -add option is specified.) |
-3 |
Error other than the above |
Note
After you add, change, or delete SNMPv3 definitions by using the ssosnmpv3setup command, perform either of the following operations:
-
Execute the ssocollectd command with the -r option specified to re-read the file.
-
Restart the ssocollectd daemon process.
Output format
The following is the output format of the -view option:
The following is an example of output of registered SNMPv3 definitions by the -view option: