set-snmp-prop

Syntax

tadm set-snmp-prop common_options --config=config_name (property_name=property_value)+

Description

Use this command to enable and define settings for the SNMP subagents.

Options

For information about common_options, run the help command.

--config|-c: Specify the name of the configuration to set the SNMP properties.

Operands

property-name=property-value

Specify name=value pairs for one or more properties that you want to define. The name=value pairs should be separated by spaces.

You can set the following SNMP properties:

enabled: Specifies whether the SNMP agent is enabled. If enabled, the SNMP subagent gathers information about the server and passes the information to the master agent.
Values: true, false. Default: true.

description: Specifies the description of the server.
Values: Must be in a text string.

organization: Specifies the name of the organization responsible for the server.
Values: Must be in a text string.

location: Specifies the location of the server.
Values: Must be in a text string.

contact: Specifies the contact information of the person responsible for the server.
Values: Must be in a text string.

To reset a property to its default value, do not provide a property value.
For example, property-name=<empty_string>

Example

tadm set-snmp-prop --config=www.example.org description=This is snmp test

Exit Codes

The following exit values are returned:

0: command executed successfully

>0: error in executing the command

For more information about exit codes and syntax notations, run the help command.