Command Line Utilities › SNMP Command Line Utilities › sysvariable Utility--Retrieve a System Value

sysvariable Utility--Retrieve a System Value

The sysvariable utility retrieves the value of a specific system value using SNMP. This utility is a snmpget with the specific OID. sysvariable is a way to retrieve system values without having to know the numeric OID name.

This utility has the following format:

sysvariable
    [-h hostname | ip_addr]
    [-p port]
    [-c community]
    [-v 1 | 2c | 3]
    [-u secName]
    [-s secLevel]
    [-n contextName]
    [-a authPassword] [-A MD5 | SHA]
    [ -x privPassword] [-X DES | AES | 3DES]
    [-m FIPS_mode]
    [-r retries]
    [-t timeout]
    [-d logLevel]
    [-f logFile]
    [-V]
    [-o Variable]

-h hostname | ipaddr

Specifies the host name or IP address of the system on which the agent is running. Accepts IPv4 and IPv6 addresses.

Default: localhost

-p port

Specifies the UDP port that the agent is running on (for example, 1691).

Default: 161

-c community

Specifies a community string that the agent uses. Valid for SNMPv1 and SNMPv2c only.

Note: Specify a read/write community string for snmpset.

Default: public

-v {1 | 2c | 3}

Indicates the version of SNMP that the agent is running. Specify 1 for SNMPv1, 2c for SNMPv2c, or 3 for SNMPv3.

Default: 1

-u secName

Specifies the User-based Security Model (USM) user name used for SNMPv3 security.

Default: none

-n contextName

Specifies the instance name for MIBMuxed agent.

Default: none

-a authPassword

Specifies the authentication password if the agent is configured for SNMPv3 with secLevel 2 (AuthNoPriv) or 3 (AuthPriv).

Note: This option is not required for SNMPv3 communication.

Default: none

-A {MD5 | SHA}

Specifies the authentication protocol to use if the agent is configured for SNMPv3 with secLevel 2 (AuthNoPriv) or 3 (AuthPriv). Currently only MD5 (Message Digest Algorithm) and SHA (Secure Hash Algorithm) are used.

Default: MD5

-x privPassword

Specifies the privacy (encryption) password if the agent is configured for SNMPv3 with secLevel 3 (AuthPriv).

Default: none

-X {DES | AES | 3DES}

Specifies the privacy protocol if the SNMPv3 user is configured with secLevel 3 (AuthPriv). Specify DES for Data Encryption Standard, AES for Advanced Encryption Standard using cryptographic keys of 128 bits (AES128), and 3DES for Triple Data Encryption Standard.

Default: none

-m FIPS_mode

Controls the FIPS mode of operation. Accepted values are 0, 1, and 2.

0

Indicates Non-FIPS mode.

1

Indicates FIPS co-existence mode.

2

Indicates FIPS only mode.

Default: 1

-r retries

Specifies the number of retries.

Default: 10

-t timeout

Specifies the duration before the SNMP receiver considers the request as timed out.

Default: 10 seconds

-d logLevel

Specifies the log level of the SNMP messages. Accepted values are 0 to 5.

0

Logs fatal messages.

1

Logs critical messages.

2

Logs warning messages.

3

Logs informational messages.

4

Logs all of the messages.

5

Logs all of the messages including debugging messages.

Default: 0

-f logfile

Specifies the name of the log file that contains error and debug information.

Default: sysedge_utility.log

-V

Generates detailed and verbose information.

Variable

Specifies the system value you want to display. This value can be any of the following:

sysuptime

Displays the system uptime.

sysnumusers

Displays the number of users.

sysprocess

Displays the number of processes.

nodename

Displays the host name.

memory

Displays the memory in kilobytes.

agentversion

Displays the SystemEDGE agent version.

systype

Displays the system release.

osversion

Displays the system version.

numcpu

Displays the number of CPUs.

virtualmemory

Displays the virtual memory in kilobytes.

totalswap

Displays the total swap space in kilobytes.

avg1

Displays the 1 minute Load Average multiplied by 100.

avg5

Displays the 5 minute Load Average multiplied by 100.

avg15

Displays the 15 minute Load Average multiplied by 100.

openfiles

Displays the number of open files.

swapcap

Displays the swap capacity.

memcap

Displays the memory capacity.

meminusecap

Displays the memoryInUse capacity.

numneti

Displays the number of network interfaces.

sysedgemode

Displays the SystemEDGE mode.

Notes: Variable must be the last argument for sysvariable.You cannot query multiple variables in a single sysvariable call.

Examples

sysvariable -o sysprocess

sysvariable -h box1.domain.com -o agentversion

sysvariable -p 2009 -c admin -v 1 -o openfiles

sysvariable -c admin -v 2c -h Ea2f:fe90:abcd:0000:230:a2f:200:ad01 -o numcpu

snmpget -p 2009 -u user3v3 -v 3 -s 1 -o memcap

snmpget -h box1.domain.com -p 2009 -u user1v3 -A SHA -a osa -v 3 -s 2 -m 2 -o numneti

snmpget -h 130.10.100.101 -p 2009 -u user2v3 -A SHA -a osa -X AES -x osp -v 3 -s 3 -t 30 -o sysuptime