Documentation | Support

Go to the table of contents Go to the previous page Go to the next page View or print as PDF
Forcepoint Appliances Command Line Interface > Appliance interface configuration > SNMP traps and queries
SNMP traps and queries
CLI Guide | Forcepoint Appliances | v8.5.x
show trap config
Display SNMP trap server on/off status and version information.
show trap config
Command modes
All products. Not supported in Azure.
Usage guidelines
SNMP monitor service and SNMP trap settings are independent, but SNMP monitor service must be enabled before you activate the SNMP trap configuration.
Related commands
 
Command
Description
set snmp service
Enable or disable SNMP monitoring (polling).
show trap events
Display a table of SNMP trap events and settings.
save trap
Save SNMP trap events settings for editing or later use.
set trap service
Enable or disable SNMP traps.
show trap events
Display a table of SNMP trap events and settings.
show trap events
Command modes
All products. Not supported in Azure.
Related commands
 
Command
Description
show trap config
Display SNMP trap server on/off status and version information.
save trap
Save SNMP trap events settings for editing or later use.
set trap service
Enable or disable SNMP traps.
load trap
Load SNMP trap events configuration from a file.
save trap
Save SNMP trap events settings for editing or later use.
save trap [--location <filestore_alias> | --url <url>] [--save-path <filepath>] [--auth-required] [--default]
 
Parameter
Description
location
Predefined remote filestore alias.
default
(Optional) Saves default settings. If the --default parameter is not included, current trap settings are saved.
url
(Optional) The URL of the storage location.
auth-required
Used with URL option to specify that a password is needed.
default
Save default trap settings for editing. If not specified, save current settings.
Command modes
All products. Not supported in Azure.
Examples
(config)# save trap --location samba-fs
Related commands
 
Command
Description
set filestore
Define a remote location to host backup and configuration files.
show trap config
Display SNMP trap server on/off status and version information.
show trap events
Display a table of SNMP trap events and settings.
set trap service
Enable or disable SNMP traps.
set trap service
Enable or disable SNMP traps.
set trap service --status <enabled|disabled>
 
Parameter
Description
status
Status of SNMP trap settings; enabled or disabled.
Command modes
All products. Not supported in Azure.
Usage guidelines
SNMP monitor service and SNMP trap settings are independent, but SNMP monitor service must be enabled to activate the SNMP trap configuration.
Examples
(config)# set trap service --status enabled
Related commands
 
Command
Description
set snmp service
Enable or disable SNMP monitoring (polling).
show trap config
Display SNMP trap server on/off status and version information.
show trap events
Display a table of SNMP trap events and settings.
save trap
Save SNMP trap events settings for editing or later use.
load trap
Load SNMP trap events configuration from a file.
load trap [--location <filestore_alias>] [--url <url>]
[--file <name>] [--auth-required] [--no-cert-verification]
 
Parameter
Description
location
(Optional) Predefined remote filestore alias.
file
(Optional) Name of the file to load.
url
(Optional) The URL of the trap file to load.
auth-required
(Optional) Used with URL option to specify that a password is required.
no-cert-verification
Ignore SSL certificate checks (only valid with URL option, with scheme https.
Command modes
All products. Not supported in Azure.
Examples
(config)# load trap --location samba-fs --file list123
Related commands
 
Command
Description
show trap config
Display SNMP trap server on/off status and version information.
show trap events
Display a table of SNMP trap events and settings.
test trap event
Send a test trap to verify SNMP communication.
test trap event
Command modes
All products. Not supported in Azure.
Usage guidelines
If there is a problem sending the test trap, verify the ending ID and authentication settings and values, and verify that the network allows communication between the appliance and the SNMP manager.
Related commands
 
Command
Description
set trap service
Enable or disable SNMP traps.
show trap config
Display SNMP trap server on/off status and version information.
set trap v1
Configure SNMP v1 traps for alerting.
set trap v1 --community <name> --ip <ip_address> --port <port>
 
Parameter
Description
community
Community name. The name must be 5–64 characters long with no spaces, using alphanumeric characters and $ ( ) . _ @ = * < > - : , % [ ] | /
ip
Trap server IP address.
port
Port for traps sent by the appliance.
Command modes
All products. Not supported in Azure.
Examples
(config)# set trap v1 --community mycommunity --ip 10.0.0.14 --port 162
Related commands
 
Command
Description
set trap service
Enable or disable SNMP traps.
show trap config
Display SNMP trap server on/off status and version information.
set trap v2c
Configure SNMP v2c traps for alerting.
set trap v2c --community <name> --ip <ip_address> --port <port>
 
Parameter
Description
community
Community name. The name must be 5–64 characters long with no spaces, using alphanumeric characters and $ ( ) . _ @ = * < > - : , % [ ] | /
ip
Trap server IP address.
port
Port for traps sent by the appliance.
Command modes
All products. Not supported in Azure.
Examples
(config)# set trap v2c --community mycommunity --ip 10.0.0.13 --port 162
Related commands
 
Command
Description
set trap service
Enable or disable SNMP traps.
show trap config
Display SNMP trap server on/off status and version information.
set trap v3
Configure SNMP v3 traps for alerting.
set trap v3 --engineid <id> --ip <ip_address> --port <port> --securitylevel <noAuthNoPriv|authNoPriv|authPriv> --user <username> --authentication <md5|sha> --encrypt <des|aes>
 
Parameter
Description
engineid
Engine ID, a hexadecimal number 10–64 characters long. The number cannot be all 0 or F characters, and the length of the string must be an even number.
ip
IP address of the SNMP manager.
port
Port for communication with SNMP manager.
securitylevel
Security level for SNMP v3 trap. Three levels are available:
*
No authentication or encryption
*
Authentication only
*
Authentication and encryption
See Examples below for sample commands.
user
(Used only with security levels authNoPriv and authPriv)
Account name to use for SNMP communication. The username must be 1–15 characters long with no spaces. Only alphanumeric characters can be used.
authentication
(Used only with security levels authNoPriv and authPriv)
Authentication protocol used on the trap server; MD5 or SHA.
When you enter the authentication protocol, you are prompted for a password. The password must be 8–64 characters long with no spaces. All other ASCII characters can be used.
encrypt
(Used only with security level authPriv)
Encryption mode; DES or AES.
When you enter the encryption mode, you are prompted for an encryption key. The key must be 8–64 characters long with no spaces. All other ASCII characters can be used.
Command modes
All products. Not supported in Azure.
Examples
*
Configure SNMP v3 traps with no authentication or encryption:
(config)# set trap v3 --engineid 8000000001020304 --ip 10.0.0.13 --port 162 --securitylevel noAuthNoPriv --user trapuser
*
Configure SNMP v3 traps with authentication only:
(config)# set trap v3 --engineid 0x802a0581 --ip 10.17.32.5 --port 162 --securitylevel authNoPriv --authentication sha --user test
Password: ********
*
Configure SNMP v3 traps with authentication and encryption:
(config)# set trap v3 --engineid 8000000001020304 ip 10.0.0.25 --port 162 --securitylevel authPriv --user trapuser --authentication sha --encrypt md5
Related commands
 
Command
Description
set snmp service
Enable or disable SNMP monitoring (polling).
show trap config
Display SNMP trap server on/off status and version information.

Go to the table of contents Go to the previous page Go to the next page View or print as PDF
Forcepoint Appliances Command Line Interface > Appliance interface configuration > SNMP traps and queries
Copyright 2020 Forcepoint. All rights reserved.