Environment variable definition file (SnmpMaster)

Organization of this page

Format
Overview
Location
Detailed description
Notes
Definition examples

Format

SNMP_MASTER_OPTIONS="[-aperror] [-apwarn] [-apverbose] [-authfail]
                     [-Contact system-contact] [-hexdump]
                     [-ip_proto [ipv4 | ipv4_ipv6 | ipv6]]
                     [-Location system-location] [-mask log-mask-value]
                     [-sysDescr description] [-tcplocal] [-vbdump]"
 
SR_SNMP_TEST_PORT=SNMP-reception-port-number
 
SR_TRAP_TEST_PORT=SNMP-trap-transmission-port-number
 
SNMP_HTC_AUTH_LOG
 
SNMP_HTC_INIT_WAIT_TIME=trap-transmission-wait-time (in seconds)
 
SR_LOG_DIR=output-directory
 
SNMP_HTC_SNMPD_LOG_SIZE=snmpd.logn-file-size
 
SNMP_HTC_SNMPD_LOG_CNT=snmpd.logn-file-count
 
PSALLOC=early
 
NODISCLAIM=true

To Page Top

Overview

The environment variable definition file (SnmpMaster) defines the following environment variables:

Environment variable name	Description
`SNMP_MASTER_OPTIONS`	This environment variable specifies startup options for the `snmpdm` process.
`SR_SNMP_TEST_PORT`	This environment variable changes SNMP Agent's SNMP reception port.
`SR_TRAP_TEST_PORT`	This environment variable sets an SNMP trap transmission port number.
`SNMP_HTC_AUTH_LOG`	This environment variable specifies whether unauthorized community names are collected.
`SNMP_HTC_INIT_WAIT_TIME`	This environment variable specifies the time period from when the `snmpdm` process completes startup processing until a `coldStart` trap is sent.
`SR_LOG_DIR`	This environment variable specifies the output directory for logs.
`SNMP_HTC_SNMPD_LOG_SIZE`	This environment variable specifies the size of the `snmpd.logn` file.
`SNMP_HTC_SNMPD_LOG_CNT`	This environment variable specifies the number of `snmpd.logn` files.
`PSALLOC`	This environment variable is specified to perform early page space allocation in AIX.
`NODISCLAIM`	This environment variable is specified to suppress memory area release in AIX.

To Page Top

Location

HP-UX (IPF) and Linux: /opt/CM2/ESA/opt/SnmpMaster
Solaris: /etc/rc.config.d/SnmpMaster
AIX: /usr/CM2/ESA/opt/SnmpMaster

To Page Top

Detailed description

SNMP_MASTER_OPTIONS

This environment variable specifies startup options for the snmpdm process.

-aperror: Specify this option if you want to collect error logs.
-apwarn: Specify this option if you want to collect error and warning logs.
-apverbose: Specify this option if you want to collect verbose logs.
-authfail (abbreviation of -authfail: -a): This option suppresses the sending of authentication failure traps from the master agent.

This option is rarely needed, because it is provided for compatibility with earlier versions of SNMP Agent.

To inhibit authentication failure traps, specify 2 for snmpEnableAuthenTraps in /etc/srconf/agt/snmpd.cnf, and then reactivate the master agent.

For details about the snmpd.cnf file, see Configuration file (snmpd.cnf) in Chapter 6. Definition Files.

When you activate the master agent with the -a option specified, the master agent changes the setting of snmpEnableAuthenTraps in /etc/srconf/agt/snmpd.cnf to 2. If you later realize that you need no longer inhibit authentication failure traps, specify 1 for snmpEnableAuthenTraps in /etc/srconf/agt/ snmpd.cnf, and then reactivate the master agent.
-Contact system-contact (abbreviation of -Contact: -C): This option changes the system contact of the master agent.
-hexdump: This option displays a hexadecimal dump of the contents of an SNMP packet. For details about how to use this option, see 7.4.1 Acquiring a master agent send/receive packet dump.
-ip_proto [ipv4 | ipv4_ipv6 | ipv6]: Specifies the IP version of the SNMP request reception port. If -ip_proto is not specified, an IPv4 and IPv6 (ipv4_ipv6) SNMP request reception port is used.

ipv4: Only an IPv4 SNMP request reception port is used.

ipv4_ipv6: Both IPv4 and IPv6 SNMP request reception ports are used.

ipv6: Only an IPv6 SNMP request reception port is used.
-Location system-location (abbreviation of -Location: -L)

This option changes the system location of the master agent.

-mask logmast-value (abbreviation -mask: -m)

This option changes the master agent's logmask value to the specified logmask value.

The logmask value can be a character string, decimal number, or hexadecimal number. The following table lists logmask values, followed by code samples:

Type of logmask value	Log suppression	Trace log output	Warning log output	Error log output
Character string	--	`FACTORY_TRACE`	`FACTORY_WARN`	`FACTORY_ERROR`
Decimal number	`0`	`8388608`	`268435456`	`536870912`
Hexadecimal number	`0x0`	`0x00800000`	`0x10000000`	`0x20000000`

Legend:: --: Not applicable

-sysDescr description (abbreviation of -sysDescr: -sys): This option changes the description of the master agent.
-tcplocal: This option enables acceptance of TCP connections from the subagents.
-vbdump: This option displays the contents of the VarBind lists in the SNMP packets. For details about how to use this option, see 7.4.1 Acquiring a master agent send/receive packet dump.

SR_SNMP_TEST_PORT

This environment variable changes SNMP Agent's SNMP reception port.

SNMP-reception-port-number after the change

This environment variable sets the master agent's SNMP reception port. If this environment variable is not specified, the value in the snmp line of the /etc/services file is used. Normally, you do not need to specify this environment variable. You must specify this environment variable only if you want to change the master agent's SNMP reception port.

By default, the following values are set:

• Solaris or AIX: 161

• Linux: 22161

For details about how to change the SNMP reception port on SNMP Agent, see 3.4.1 Changing the SNMP reception port on SNMP Agent.

SR_TRAP_TEST_PORT

This environment variable sets an SNMP trap transmission port number.

SNMP trap transmission port number

This option specifies the master agent's SNMP trap notification port number. The default is 162.

SNMP_HTC_AUTH_LOG

To collect logs of unauthorized community names, specify 1. By default, this environment variable is not specified.

SNMP_HTC_INIT_WAIT_TIME

This environment variable specifies the time period from when the snmpdm process completes startup processing until a coldStart trap is sent.

trap-transmission-wait-time (in seconds)

Specify a value from 0 to 300 (in seconds) as the time period from when the snmpdm process completes startup processing until a coldStart trap is sent. SNMP requests received during this period are discarded. The default is 15 seconds.

Specifying a value of less than 15 seconds as the time set in the SNMP_HTC_INIT_WAIT_TIME environment variable increases the probability that a noSuchName error will be returned in response to a request from the SNMP manager.

SR_LOG_DIR

This environment variable specifies the output directory for logs.

output-directory

This option specifies the output directory for logs.

SNMP_HTC_SNMPD_LOG_SIZE

This environment variable specifies the size of the snmpd.logn file.

snmpd.logn-file-size

This option specifies the size of the output files for logs, hexadecimal dumps, and VarBind lists as a value from 0 to 50 (in megabytes). If 0 is specified, logs, hexadecimal dumps, and VarBind lists are not output. The default is 10 megabytes.

SNMP_HTC_SNMPD_LOG_CNT

This environment variable specifies the number of snmpd.logn files.

snmpd.logn-file-count

This option specifies the number of output files for logs, hexadecimal dumps, and VarBind lists as a value from 1 to 10. The default is 10 files.

PSALLOC=early

In the event of a shortage of OS memory in AIX, SIGKILL is issued and the process might terminate. You can avoid this by specifying PSALLOC=early.

NODISCLAIM=true

If you set early in the PSALLOC environment variable, also set the NODISCLAIM=true environment variable.

To Page Top

Notes

The following are notes about backing up the environment variable definition files:

When you back up an environment variable definition file, verify that the name of the backup file does not begin with Snmp.

The following shows an example of a name for a backup file.

Example: Backup file of /opt/CM2/ESA/opt/SnmpMaster

/opt/CM2/ESA/opt/Bak.SnmpMaster
If your OS is Solaris, do not create backup environment variable definition files under /etc/rc.config.d.

The following are notes about sending coldStart traps when the OS starts up:

By default, the snmpdm process of the master agent sends a coldStart trap 15 seconds after it starts up.

No response is sent to the manager's request during this time, because the process sends a coldStart trap without checking whether startup processing is complete for other subagents. Normally, 15 seconds are sufficient for subagents to complete their startup processing; however, some subagents might require more time depending on the environment. If this is the case, adjust the timing of coldStart transmission by specifying the appropriate time (in seconds) that elapses before the coldStart trap is sent in the SNMP_HTC_INIT_WAIT_TIME environment variable in the SnmpMaster file.

To Page Top

Definition examples

This example specifies 162 for the SNMP trap transmission port number (SR_TRAP_TEST_PORT environment variable):
```
SR_TRAP_TEST_PORT=162
export SR_TRAP_TEST_PORT
```

In the following example, the SNMP manager and SNMP Agent communicate using only IPv6:

SNMP_MASTER_OPTIONS="-ip_proto ipv6 -tcplocal -aperror -apwarn -apverbose -hexdump -vbdump"
export SNMP_MASTER_OPTIONS

This example specifies the time (in seconds) that elapses before the coldStart trap is sent:
```
SNMP_HTC_INIT_WAIT_TIME=15
export SNMP_HTC_INIT_WAIT_TIME
```
This example prevents SIGKILL from being issued when a shortage of OS memory occurs in AIX:
```
PSALLOC=early
export PSALLOC
NODISCLAIM=true
export NODISCLAIM
```
A specification example of the SNMP_HTC_SNMPD_LOG_SIZE environment variable is shown below. The unit is megabytes. The example specifies 10 megabytes.
```
SNMP_HTC_SNMPD_LOG_SIZE=10
export SNMP_HTC_SNMPD_LOG_SIZE
```
A specification example of the SNMP_HTC_SNMPD_LOG_CNT environment variable is shown below. The unit is files. The example specifies 10 files.
```
SNMP_HTC_SNMPD_LOG_CNT=10
export SNMP_HTC_SNMPD_LOG_CNT
```
This example specifies a log output destination:
```
SR_LOG_DIR=/tmp/esalog
export SR_LOG_DIR
```
This example specifies the acquisition of the sending source IP address and community name for SNMP requests when the community name is invalid:
```
SNMP_HTC_AUTH_LOG=1
export SNMP_HTC_AUTH_LOG
```

To Page Top