Fortinet white logo
Fortinet white logo

CLI Reference

system snmp sysinfo

system snmp sysinfo

Use this command to enable and configure basic information for the FortiWeb appliance’s SNMP agent.

Before you can use SNMP, you must activate the FortiWeb appliance’s SNMP agent and add it as a member of at least one community. For details, see system snmp community. You must also enable SNMP access on the network interface through which the SNMP manager will connect. For details, see system interface.

On the SNMP manager, you must also verify that the SNMP manager is a member of the community to which the FortiWeb appliance belongs, and compile the necessary Fortinet proprietary management information blocks (MIBs) and Fortinet-supported standard MIBs. For information on MIBs, see the FortiWeb Administration Guide:

HTTPs://docs.fortinet.com/fortiweb/admin-guides

To use this command, your administrator account’s access control profile must have either w or rw permission to the sysgrp area. For details, see Permissions.

Syntax

config system snmp sysinfo

set contact-info "<contact_str>"

set description "<description_str>"

set location "<location_str>"

set status {enable | disable}

set engine-id "<engine-id_str>"

end

Variable Description Default

contact-info "<contact_str>"

Type the contact information for the administrator or other person responsible for this FortiWeb appliance, such as a phone number or name. The contact information can contain only letters (a-z, A-Z), numbers, hyphens ( - ) and underscores ( _ ). The maximum length is 63 characters. No default.

description "<description_str>"

Type a description of the FortiWeb appliance. The string can contain only letters (a-z, A-Z), numbers, hyphens ( - ) and underscores ( _ ). The maximum length is 63 characters. No default.

location "<location_str>"

Type the physical location of the FortiWeb appliance. The string can contain only letters (a-z, A-Z), numbers, hyphens ( - ) and underscores ( _ ). The maximum length is 63 characters. No default.

status {enable | disable}

Enable to activate the SNMP agent, enabling the FortiWeb appliance to send traps and/or receive queries for the communities in which you have enabled queries and/or traps.

This setting enables queries only if SNMP administrative access is enabled on one or more network interfaces. For details, see system interface.

disable

engine-id "<engine-id_str>"

Enter the SNMP engineID string. The maximum is 24 characters.

No default

Example1234

This example enables the SNMP agent, configures it to belong to a community named public whose SNMP manager is 192.0.2.20. The SNMP manager is not directly attached, but can be reached through the network interface named port3.

This example also configures the SNMP agent to send traps using SNMP v2c for high CPU or memory usage, and when the primary appliance fails; it also enables responses to SNMP v2c queries through the network interface named port3 (along with the previously enabled administrative access protocols, ICMP ping, HTTPS, and SSH).

config system snmp sysinfo

set contact-info "admin_example_com"

set description "FortiWeb-1000E"

set location "Rack_2"

set status enable

set engine-id 246

end

config system snmp community

edit 1

set status enable

set name public

set events cpu-high

set query-v1-status disable

set query-v2c-port 161

set query-v2c-status enable

set trap-v1-status disable

set trap-v2c-lport 162

set trap-v2c-rport 162

set trap-v2c-status enable

config hosts

edit 1

set interface port3

set ip 192.0.2.20

next

end

next

end

config system interface

edit port3

set allowaccess ping HTTPs ssh snmp

next

end

Related topics

system snmp sysinfo

system snmp sysinfo

Use this command to enable and configure basic information for the FortiWeb appliance’s SNMP agent.

Before you can use SNMP, you must activate the FortiWeb appliance’s SNMP agent and add it as a member of at least one community. For details, see system snmp community. You must also enable SNMP access on the network interface through which the SNMP manager will connect. For details, see system interface.

On the SNMP manager, you must also verify that the SNMP manager is a member of the community to which the FortiWeb appliance belongs, and compile the necessary Fortinet proprietary management information blocks (MIBs) and Fortinet-supported standard MIBs. For information on MIBs, see the FortiWeb Administration Guide:

HTTPs://docs.fortinet.com/fortiweb/admin-guides

To use this command, your administrator account’s access control profile must have either w or rw permission to the sysgrp area. For details, see Permissions.

Syntax

config system snmp sysinfo

set contact-info "<contact_str>"

set description "<description_str>"

set location "<location_str>"

set status {enable | disable}

set engine-id "<engine-id_str>"

end

Variable Description Default

contact-info "<contact_str>"

Type the contact information for the administrator or other person responsible for this FortiWeb appliance, such as a phone number or name. The contact information can contain only letters (a-z, A-Z), numbers, hyphens ( - ) and underscores ( _ ). The maximum length is 63 characters. No default.

description "<description_str>"

Type a description of the FortiWeb appliance. The string can contain only letters (a-z, A-Z), numbers, hyphens ( - ) and underscores ( _ ). The maximum length is 63 characters. No default.

location "<location_str>"

Type the physical location of the FortiWeb appliance. The string can contain only letters (a-z, A-Z), numbers, hyphens ( - ) and underscores ( _ ). The maximum length is 63 characters. No default.

status {enable | disable}

Enable to activate the SNMP agent, enabling the FortiWeb appliance to send traps and/or receive queries for the communities in which you have enabled queries and/or traps.

This setting enables queries only if SNMP administrative access is enabled on one or more network interfaces. For details, see system interface.

disable

engine-id "<engine-id_str>"

Enter the SNMP engineID string. The maximum is 24 characters.

No default

Example1234

This example enables the SNMP agent, configures it to belong to a community named public whose SNMP manager is 192.0.2.20. The SNMP manager is not directly attached, but can be reached through the network interface named port3.

This example also configures the SNMP agent to send traps using SNMP v2c for high CPU or memory usage, and when the primary appliance fails; it also enables responses to SNMP v2c queries through the network interface named port3 (along with the previously enabled administrative access protocols, ICMP ping, HTTPS, and SSH).

config system snmp sysinfo

set contact-info "admin_example_com"

set description "FortiWeb-1000E"

set location "Rack_2"

set status enable

set engine-id 246

end

config system snmp community

edit 1

set status enable

set name public

set events cpu-high

set query-v1-status disable

set query-v2c-port 161

set query-v2c-status enable

set trap-v1-status disable

set trap-v2c-lport 162

set trap-v2c-rport 162

set trap-v2c-status enable

config hosts

edit 1

set interface port3

set ip 192.0.2.20

next

end

next

end

config system interface

edit port3

set allowaccess ping HTTPs ssh snmp

next

end

Related topics