fortinet.fortimanager.fmgr_devprof_system_snmp_community module – no description

Note

This module is part of the fortinet.fortimanager collection (version 2.1.7).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install fortinet.fortimanager.

To use it in a playbook, specify: fortinet.fortimanager.fmgr_devprof_system_snmp_community.

New in fortinet.fortimanager 1.0.0

Synopsis

  • This module is able to configure a FortiManager device.

  • Examples include all parameters and values which need to be adjusted to data sources before usage.

Parameters

Parameter

Comments

adom

string / required

the parameter (adom) in requested url

bypass_validation

boolean

only set to True when module schema diffs with FortiManager API structure,

module continues to execute without validating parameters

Choices:

  • false ← (default)

  • true

devprof

string / required

the parameter (devprof) in requested url

devprof_system_snmp_community

dictionary

the top level parameters set

events

list / elements=string

description

Choices:

  • "cpu-high"

  • "mem-low"

  • "log-full"

  • "intf-ip"

  • "vpn-tun-up"

  • "vpn-tun-down"

  • "ha-switch"

  • "ha-hb-failure"

  • "ips-signature"

  • "ips-anomaly"

  • "av-virus"

  • "av-oversize"

  • "av-pattern"

  • "av-fragmented"

  • "fm-if-change"

  • "fm-conf-change"

  • "temperature-high"

  • "voltage-alert"

  • "ha-member-up"

  • "ha-member-down"

  • "ent-conf-change"

  • "av-conserve"

  • "av-bypass"

  • "av-oversize-passed"

  • "av-oversize-blocked"

  • "ips-pkg-update"

  • "power-supply-failure"

  • "amc-bypass"

  • "faz-disconnect"

  • "fan-failure"

  • "bgp-established"

  • "bgp-backward-transition"

  • "wc-ap-up"

  • "wc-ap-down"

  • "fswctl-session-up"

  • "fswctl-session-down"

  • "ips-fail-open"

  • "load-balance-real-server-down"

  • "device-new"

  • "enter-intf-bypass"

  • "exit-intf-bypass"

  • "per-cpu-high"

  • "power-blade-down"

  • "confsync_failure"

  • "dhcp"

  • "pool-usage"

  • "power-redundancy-degrade"

  • "power-redundancy-failure"

  • "ospf-nbr-state-change"

  • "ospf-virtnbr-state-change"

  • "disk-failure"

  • "disk-overload"

hosts

list / elements=string

description

ha-direct

string

no description

Choices:

  • "disable"

  • "enable"

host-type

string

no description

Choices:

  • "any"

  • "query"

  • "trap"

id

integer

no description

ip

string

no description

source-ip

string

no description

hosts6

list / elements=string

description

ha-direct

string

no description

Choices:

  • "disable"

  • "enable"

host-type

string

no description

Choices:

  • "any"

  • "query"

  • "trap"

id

integer

no description

ipv6

string

no description

source-ipv6

string

no description

id

integer

no description

mib-view

string

no description

name

string

no description

query-v1-port

integer

no description

query-v1-status

string

no description

Choices:

  • "disable"

  • "enable"

query-v2c-port

integer

no description

query-v2c-status

string

no description

Choices:

  • "disable"

  • "enable"

status

string

no description

Choices:

  • "disable"

  • "enable"

trap-v1-lport

integer

no description

trap-v1-rport

integer

no description

trap-v1-status

string

no description

Choices:

  • "disable"

  • "enable"

trap-v2c-lport

integer

no description

trap-v2c-rport

integer

no description

trap-v2c-status

string

no description

Choices:

  • "disable"

  • "enable"

vdoms

string

description

enable_log

boolean

Enable/Disable logging for task

Choices:

  • false ← (default)

  • true

proposed_method

string

The overridden method for the underlying Json RPC request

Choices:

  • "update"

  • "set"

  • "add"

rc_failed

list / elements=string

the rc codes list with which the conditions to fail will be overriden

rc_succeeded

list / elements=string

the rc codes list with which the conditions to succeed will be overriden

state

string / required

the directive to create, update or delete an object

Choices:

  • "present"

  • "absent"

workspace_locking_adom

string

the adom to lock for FortiManager running in workspace mode, the value can be global and others including root

workspace_locking_timeout

integer

the maximum time in seconds to wait for other user to release the workspace lock

Default: 300

Notes

Note

  • Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.

  • To create or update an object, use state present directive.

  • To delete an object, use state absent directive.

  • Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded

Examples

- hosts: fortimanager00
  collections:
    - fortinet.fortimanager
  connection: httpapi
  vars:
     ansible_httpapi_use_ssl: True
     ansible_httpapi_validate_certs: False
     ansible_httpapi_port: 443
  tasks:
   - name: SNMP community configuration.
     fmgr_devprof_system_snmp_community:
        bypass_validation: False
        adom: ansible
        devprof: 'ansible-test' # system template name, could find it in FortiManager UI: Device Manager --> Provisioning Templates --> System Templates
        state: present
        devprof_system_snmp_community:
           events:
             - cpu-high
             - mem-low
             - log-full
             - intf-ip
             - vpn-tun-up
             - vpn-tun-down
             - ha-switch
             - ha-hb-failure
             - ips-signature
             - ips-anomaly
             - av-virus
             - av-oversize
             - av-pattern
             - av-fragmented
             - fm-if-change
             - fm-conf-change
             - temperature-high
             - voltage-alert
             - ha-member-up
             - ha-member-down
             - ent-conf-change
             - av-conserve
             - av-bypass
             - av-oversize-passed
             - av-oversize-blocked
             - ips-pkg-update
             - power-supply-failure
             - amc-bypass
             - faz-disconnect
             - fan-failure
             - bgp-established
             - bgp-backward-transition
             - wc-ap-up
             - wc-ap-down
             - fswctl-session-up
             - fswctl-session-down
             - ips-fail-open
             - load-balance-real-server-down
             - device-new
             - enter-intf-bypass
             - exit-intf-bypass
             - per-cpu-high
             - power-blade-down
             - confsync_failure
           hosts:
             -
                 ha-direct: enable
                 host-type: any
                 id: 1
           id: 1
           name: 'ansible-test'

- name: gathering fortimanager facts
  hosts: fortimanager00
  gather_facts: no
  connection: httpapi
  collections:
    - fortinet.fortimanager
  vars:
    ansible_httpapi_use_ssl: True
    ansible_httpapi_validate_certs: False
    ansible_httpapi_port: 443
  tasks:
   - name: retrieve all the communities in system template
     fmgr_fact:
       facts:
           selector: 'devprof_system_snmp_community'
           params:
               adom: 'ansible'
               devprof: 'ansible-test' # system template name, could find it in FortiManager UI: Device Manager --> Provisioning Templates --> System Templates
               community: 'your_value'

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

request_url

string

The full url requested

Returned: always

Sample: "/sys/login/user"

response_code

integer

The status of api request

Returned: always

Sample: 0

response_message

string

The descriptive message of the api response

Returned: always

Sample: "OK."

Authors

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)