History Collection › History Control Table Configuration › emphistory Utility--Manage Entries in History Control Table

emphistory Utility--Manage Entries in History Control Table

Use the emphistory utility from the command line to add, delete, set the status of, or list entries in the History Control table. You can also use it (with the dump operation) to retrieve stored data samples from the History table.

You can use the emphistory utility as follows:

emphistory [-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]
    [-o] [command]

-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

-s secLevel

Specifies one of the following security levels for SNMPv3 communication:

• 1 - noAuthNoPriv
• 2 - AuthNoPriv

3 - AuthPriv (SNMPv3 only)

-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

command

Specifies the command and associated arguments. Supported commands are the following:

• add
• setstatus
• delete
• dump
• list

Note: For more information about the above commands, see emphistory Commands for Managing Entries in History Control Table.

Important! The following usage of the emphistory utility is deprecated. The use of the above argument format is strongly recommended, because the following format will not be supported in the future:

emphistory add ipaddr[:port] commstr ctrlIndex objid interval buckets ['description']
emphistory delete ipaddr[:port] commstr ctrlIndex
emphistory list ipaddr[:port] commstr
emphistory setstatus ipaddr[:port] commstr ctrlIndex status
emphistory dump ipaddr[:port] commstr ctrlIndex