Fortinet Document Library

Version:


Table of Contents

CLI Reference

6.0.0
Download PDF
Copy Link

system snmp community

Introduction.

config system snmp community
    edit {id}
    # SNMP community configuration.
        set id {integer}   Community ID. range[0-4294967295]
        set name {string}   Community name. size[35]
        set status {enable | disable}   Enable/disable this SNMP community.
        config hosts
            edit {id}
            # Configure IPv4 SNMP managers (hosts).
                set id {integer}   Host entry ID. range[0-4294967295]
                set source-ip {ipv4 address}   Source IPv4 address for SNMP traps.
                set ip {string}   IPv4 address of the SNMP manager (host).
                set ha-direct {enable | disable}   Enable/disable direct management of HA cluster members.
                set host-type {any | query | trap}   Control whether the SNMP manager sends SNMP queries, receives SNMP traps, or both.
                        any    Accept queries from and send traps to this SNMP manager.
                        query  Accept queries from this SNMP manager but do not send traps.
                        trap   Send traps to this SNMP manager but do not accept SNMP queries from this SNMP manager.
            next
        config hosts6
            edit {id}
            # Configure IPv6 SNMP managers.
                set id {integer}   Host6 entry ID. range[0-4294967295]
                set source-ipv6 {ipv6 address}   Source IPv6 address for SNMP traps.
                set ipv6 {ipv6 prefix}   SNMP manager IPv6 address prefix.
                set ha-direct {enable | disable}   Enable/disable direct management of HA cluster members.
                set host-type {any | query | trap}   Control whether the SNMP manager sends SNMP queries, receives SNMP traps, or both.
                        any    Accept queries from and send traps to this SNMP manager.
                        query  Accept queries from this SNMP manager but do not send traps.
                        trap   Send traps to this SNMP manager but do not accept SNMP queries from this SNMP manager.
            next
        set query-v1-status {enable | disable}   Enable/disable SNMP v1 queries.
        set query-v1-port {integer}   SNMP v1 query port (default = 161). range[1-65535]
        set query-v2c-status {enable | disable}   Enable/disable SNMP v2c queries.
        set query-v2c-port {integer}   SNMP v2c query port (default = 161). range[0-65535]
        set trap-v1-status {enable | disable}   Enable/disable SNMP v1 traps.
        set trap-v1-lport {integer}   SNMP v1 trap local port (default = 162). range[1-65535]
        set trap-v1-rport {integer}   SNMP v1 trap remote port (default = 162). range[1-65535]
        set trap-v2c-status {enable | disable}   Enable/disable SNMP v2c traps.
        set trap-v2c-lport {integer}   SNMP v2c trap local port (default = 162). range[1-65535]
        set trap-v2c-rport {integer}   SNMP v2c trap remote port (default = 162). range[1-65535]
        set events {option}   SNMP trap events.
                cpu-high                       Send a trap when CPU usage is high.
                mem-low                        Send a trap when available memory is low.
                log-full                       Send a trap when log disk space becomes low.
                intf-ip                        Send a trap when an interface IP address is changed.
                vpn-tun-up                     Send a trap when a VPN tunnel comes up.
                vpn-tun-down                   Send a trap when a VPN tunnel goes down.
                ha-switch                      Send a trap after an HA failover when the backup unit has taken over.
                ha-hb-failure                  Send a trap when HA heartbeats are not received.
                ips-signature                  Send a trap when IPS detects an attack.
                ips-anomaly                    Send a trap when IPS finds an anomaly.
                av-virus                       Send a trap when AntiVirus finds a virus.
                av-oversize                    Send a trap when AntiVirus finds an oversized file.
                av-pattern                     Send a trap when AntiVirus finds file matching pattern.
                av-fragmented                  Send a trap when AntiVirus finds a fragmented file.
                fm-if-change                   Send a trap when FortiManager interface changes. Send a FortiManager trap.
                fm-conf-change                 Send a trap when a configuration change is made by a FortiGate administrator and the FortiGate is managed by FortiManager.
                bgp-established                Send a trap when a BGP FSM transitions to the established state.
                bgp-backward-transition        Send a trap when a BGP FSM goes from a high numbered state to a lower numbered state.
                ha-member-up                   Send a trap when an HA cluster member goes up.
                ha-member-down                 Send a trap when an HA cluster member goes down.
                ent-conf-change                Send a trap when an entity MIB change occurs (RFC4133).
                av-conserve                    Send a trap when the FortiGate enters conserve mode.
                av-bypass                      Send a trap when the FortiGate enters bypass mode.
                av-oversize-passed             Send a trap when AntiVirus passes an oversized file.
                av-oversize-blocked            Send a trap when AntiVirus blocks an oversized file.
                ips-pkg-update                 Send a trap when the IPS signature database or engine is updated.
                ips-fail-open                  Send a trap when the IPS network buffer is full.
                temperature-high               Send a trap when a temperature sensor registers a temperature that is too high.
                voltage-alert                  Send a trap when a voltage sensor registers a voltage that is outside of the normal range.
                power-supply-failure           Send a trap when a power supply fails.
                faz-disconnect                 Send a trap when a FortiAnalyzer disconnects from the FortiGate.
                fan-failure                    Send a trap when a fan fails.
                wc-ap-up                       Send a trap when a managed FortiAP comes up.
                wc-ap-down                     Send a trap when a managed FortiAP goes down.
                fswctl-session-up              Send a trap when a FortiSwitch controller session comes up.
                fswctl-session-down            Send a trap when a FortiSwitch controller session goes down.
                load-balance-real-server-down  Send a trap when a server load balance real server goes down.
                device-new                     Send a trap when a new device is found.
                per-cpu-high                   Send a trap when per-CPU usage is high.
    next
end

system snmp community

Introduction.

config system snmp community
    edit {id}
    # SNMP community configuration.
        set id {integer}   Community ID. range[0-4294967295]
        set name {string}   Community name. size[35]
        set status {enable | disable}   Enable/disable this SNMP community.
        config hosts
            edit {id}
            # Configure IPv4 SNMP managers (hosts).
                set id {integer}   Host entry ID. range[0-4294967295]
                set source-ip {ipv4 address}   Source IPv4 address for SNMP traps.
                set ip {string}   IPv4 address of the SNMP manager (host).
                set ha-direct {enable | disable}   Enable/disable direct management of HA cluster members.
                set host-type {any | query | trap}   Control whether the SNMP manager sends SNMP queries, receives SNMP traps, or both.
                        any    Accept queries from and send traps to this SNMP manager.
                        query  Accept queries from this SNMP manager but do not send traps.
                        trap   Send traps to this SNMP manager but do not accept SNMP queries from this SNMP manager.
            next
        config hosts6
            edit {id}
            # Configure IPv6 SNMP managers.
                set id {integer}   Host6 entry ID. range[0-4294967295]
                set source-ipv6 {ipv6 address}   Source IPv6 address for SNMP traps.
                set ipv6 {ipv6 prefix}   SNMP manager IPv6 address prefix.
                set ha-direct {enable | disable}   Enable/disable direct management of HA cluster members.
                set host-type {any | query | trap}   Control whether the SNMP manager sends SNMP queries, receives SNMP traps, or both.
                        any    Accept queries from and send traps to this SNMP manager.
                        query  Accept queries from this SNMP manager but do not send traps.
                        trap   Send traps to this SNMP manager but do not accept SNMP queries from this SNMP manager.
            next
        set query-v1-status {enable | disable}   Enable/disable SNMP v1 queries.
        set query-v1-port {integer}   SNMP v1 query port (default = 161). range[1-65535]
        set query-v2c-status {enable | disable}   Enable/disable SNMP v2c queries.
        set query-v2c-port {integer}   SNMP v2c query port (default = 161). range[0-65535]
        set trap-v1-status {enable | disable}   Enable/disable SNMP v1 traps.
        set trap-v1-lport {integer}   SNMP v1 trap local port (default = 162). range[1-65535]
        set trap-v1-rport {integer}   SNMP v1 trap remote port (default = 162). range[1-65535]
        set trap-v2c-status {enable | disable}   Enable/disable SNMP v2c traps.
        set trap-v2c-lport {integer}   SNMP v2c trap local port (default = 162). range[1-65535]
        set trap-v2c-rport {integer}   SNMP v2c trap remote port (default = 162). range[1-65535]
        set events {option}   SNMP trap events.
                cpu-high                       Send a trap when CPU usage is high.
                mem-low                        Send a trap when available memory is low.
                log-full                       Send a trap when log disk space becomes low.
                intf-ip                        Send a trap when an interface IP address is changed.
                vpn-tun-up                     Send a trap when a VPN tunnel comes up.
                vpn-tun-down                   Send a trap when a VPN tunnel goes down.
                ha-switch                      Send a trap after an HA failover when the backup unit has taken over.
                ha-hb-failure                  Send a trap when HA heartbeats are not received.
                ips-signature                  Send a trap when IPS detects an attack.
                ips-anomaly                    Send a trap when IPS finds an anomaly.
                av-virus                       Send a trap when AntiVirus finds a virus.
                av-oversize                    Send a trap when AntiVirus finds an oversized file.
                av-pattern                     Send a trap when AntiVirus finds file matching pattern.
                av-fragmented                  Send a trap when AntiVirus finds a fragmented file.
                fm-if-change                   Send a trap when FortiManager interface changes. Send a FortiManager trap.
                fm-conf-change                 Send a trap when a configuration change is made by a FortiGate administrator and the FortiGate is managed by FortiManager.
                bgp-established                Send a trap when a BGP FSM transitions to the established state.
                bgp-backward-transition        Send a trap when a BGP FSM goes from a high numbered state to a lower numbered state.
                ha-member-up                   Send a trap when an HA cluster member goes up.
                ha-member-down                 Send a trap when an HA cluster member goes down.
                ent-conf-change                Send a trap when an entity MIB change occurs (RFC4133).
                av-conserve                    Send a trap when the FortiGate enters conserve mode.
                av-bypass                      Send a trap when the FortiGate enters bypass mode.
                av-oversize-passed             Send a trap when AntiVirus passes an oversized file.
                av-oversize-blocked            Send a trap when AntiVirus blocks an oversized file.
                ips-pkg-update                 Send a trap when the IPS signature database or engine is updated.
                ips-fail-open                  Send a trap when the IPS network buffer is full.
                temperature-high               Send a trap when a temperature sensor registers a temperature that is too high.
                voltage-alert                  Send a trap when a voltage sensor registers a voltage that is outside of the normal range.
                power-supply-failure           Send a trap when a power supply fails.
                faz-disconnect                 Send a trap when a FortiAnalyzer disconnects from the FortiGate.
                fan-failure                    Send a trap when a fan fails.
                wc-ap-up                       Send a trap when a managed FortiAP comes up.
                wc-ap-down                     Send a trap when a managed FortiAP goes down.
                fswctl-session-up              Send a trap when a FortiSwitch controller session comes up.
                fswctl-session-down            Send a trap when a FortiSwitch controller session goes down.
                load-balance-real-server-down  Send a trap when a server load balance real server goes down.
                device-new                     Send a trap when a new device is found.
                per-cpu-high                   Send a trap when per-CPU usage is high.
    next
end