drmofu / drmofu.fortimanager / 2.2.2 / module / fmgr_devprof_system_snmp_community SNMP community configuration. | "added in version" 1.0.0 of drmofu.fortimanager" Authors: Xinwei Du (@dux-fortinet), Xing Li (@lix-fortinet), Jie Xue (@JieX19), Link Zheng (@chillancezen), Frank Shen (@fshen01), Hongbin Lu (@fgtdev-hblu) preview | supported by communitydrmofu.fortimanager.fmgr_devprof_system_snmp_community (2.2.2) — module
Install with ansible-galaxy collection install drmofu.fortimanager:==2.2.2
collections: - name: drmofu.fortimanager version: 2.2.2
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.
- 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'
- 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'
adom: description: the parameter (adom) in requested url required: true type: str state: choices: - present - absent description: The directive to create, update or delete an object. required: true type: str devprof: description: the parameter (devprof) in requested url required: true type: str rc_failed: description: The rc codes list with which the conditions to fail will be overriden. elements: int required: false type: list enable_log: default: false description: Enable/Disable logging for task. required: false type: bool access_token: description: The token to access FortiManager without using username and password. required: false type: str rc_succeeded: description: The rc codes list with which the conditions to succeed will be overriden. elements: int required: false type: list proposed_method: choices: - update - set - add description: The overridden method for the underlying Json RPC request. required: false type: str bypass_validation: default: false description: Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. required: false type: bool workspace_locking_adom: description: The adom to lock for FortiManager running in workspace mode, the value can be global and others including root. required: false type: str forticloud_access_token: description: Authenticate Ansible client with forticloud API access token. required: false type: str workspace_locking_timeout: default: 300 description: The maximum time in seconds to wait for other user to release the workspace lock. required: false type: int devprof_system_snmp_community: description: the top level parameters set required: false suboptions: events: 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 - faz-main-failover - faz-alt-failover - slbc description: description elements: str type: list hosts: description: description elements: dict suboptions: ha-direct: choices: - disable - enable description: Enable/disable direct management of HA cluster members. type: str host-type: choices: - any - query - trap description: Control whether the SNMP manager sends SNMP queries, receives SNMP traps, or both. type: str id: description: Host entry ID. type: int ip: description: IPv4 address of the SNMP manager type: str source-ip: description: Source IPv4 address for SNMP traps. type: str type: list hosts6: description: description elements: dict suboptions: ha-direct: choices: - disable - enable description: Enable/disable direct management of HA cluster members. type: str host-type: choices: - any - query - trap description: Control whether the SNMP manager sends SNMP queries, receives SNMP traps, or both. type: str id: description: Host6 entry ID. type: int ipv6: description: SNMP manager IPv6 address prefix. type: str source-ipv6: description: Source IPv6 address for SNMP traps. type: str type: list id: description: Community ID. type: int mib-view: description: SNMP access control MIB view. type: str name: description: Community name. type: str query-v1-port: description: SNMP v1 query port type: int query-v1-status: choices: - disable - enable description: Enable/disable SNMP v1 queries. type: str query-v2c-port: description: SNMP v2c query port type: int query-v2c-status: choices: - disable - enable description: Enable/disable SNMP v2c queries. type: str status: choices: - disable - enable description: Enable/disable this SNMP community. type: str trap-v1-lport: description: SNMP v1 trap local port type: int trap-v1-rport: description: SNMP v1 trap remote port type: int trap-v1-status: choices: - disable - enable description: Enable/disable SNMP v1 traps. type: str trap-v2c-lport: description: SNMP v2c trap local port type: int trap-v2c-rport: description: SNMP v2c trap remote port type: int trap-v2c-status: choices: - disable - enable description: Enable/disable SNMP v2c traps. type: str vdoms: description: description type: str type: dict
meta: contains: request_url: description: The full url requested. returned: always sample: /sys/login/user type: str response_code: description: The status of api request. returned: always sample: 0 type: int response_data: description: The api response. returned: always type: list response_message: description: The descriptive message of the api response. returned: always sample: OK. type: str system_information: description: The information of the target system. returned: always type: dict description: The result of the request. returned: always type: dict rc: description: The status the request. returned: always sample: 0 type: int version_check_warning: description: Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: complex type: list