fortinet.fortios.fortios_switch_controller_snmp_community (1.1.7) — module

Install collection

Install with ansible-galaxy collection install fortinet.fortios:==1.1.7

Add to requirements.yml

  collections:
    - name: fortinet.fortios
      version: 1.1.7

Description

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify switch_controller feature and snmp_community category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.4.0

Requirements

• ansible>=2.9.0

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- hosts: fortigates
  collections:
    - fortinet.fortios
  connection: httpapi
  vars:
   vdom: "root"
   ansible_httpapi_use_ssl: yes
   ansible_httpapi_validate_certs: no
   ansible_httpapi_port: 443
  tasks:
  - name: Configure FortiSwitch SNMP v1/v2c communities globally.
    fortios_switch_controller_snmp_community:
      vdom:  "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      switch_controller_snmp_community:
        events: "cpu-high"
        hosts:
         -
            id:  "5"
            ip: "<your_own_value>"
        id:  "7"
        name: "default_name_8"
        query_v1_port: "9"
        query_v1_status: "disable"
        query_v2c_port: "11"
        query_v2c_status: "disable"
        status: "disable"
        trap_v1_lport: "14"
        trap_v1_rport: "15"
        trap_v1_status: "disable"
        trap_v2c_lport: "17"
        trap_v2c_rport: "18"
        trap_v2c_status: "disable"

Inputs

    
vdom:
    default: root
    description:
    - Virtual domain, among those defined previously. A vdom is a virtual instance of
      the FortiGate that can be configured and used as a different unit.
    type: str

state:
    choices:
    - present
    - absent
    description:
    - Indicates whether to create or remove the object.
    required: true
    type: str

access_token:
    description:
    - Token-based authentication. Generated from GUI of Fortigate.
    required: false
    type: str

switch_controller_snmp_community:
    default: null
    description:
    - Configure FortiSwitch SNMP v1/v2c communities globally.
    suboptions:
      events:
        choices:
        - cpu-high
        - mem-low
        - log-full
        - intf-ip
        - ent-conf-change
        description:
        - SNMP notifications (traps) to send.
        type: str
      hosts:
        description:
        - Configure IPv4 SNMP managers (hosts).
        suboptions:
          id:
            description:
            - Host entry ID.
            required: true
            type: int
          ip:
            description:
            - IPv4 address of the SNMP manager (host).
            type: str
        type: list
      id:
        description:
        - SNMP community ID.
        required: true
        type: int
      name:
        description:
        - SNMP 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 v2c trap local port .
        type: int
      trap_v1_rport:
        description:
        - SNMP v2c 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
    type: dict

Outputs

build:
  description: Build number of the fortigate image
  returned: always
  sample: '1547'
  type: str
http_method:
  description: Last method used to provision the content into FortiGate
  returned: always
  sample: PUT
  type: str
http_status:
  description: Last result given by FortiGate on last operation applied
  returned: always
  sample: '200'
  type: str
mkey:
  description: Master key (id) used in the last call to FortiGate
  returned: success
  sample: id
  type: str
name:
  description: Name of the table used to fulfill the request
  returned: always
  sample: urlfilter
  type: str
path:
  description: Path of the table used to fulfill the request
  returned: always
  sample: webfilter
  type: str
revision:
  description: Internal revision number
  returned: always
  sample: 17.0.2.10658
  type: str
serial:
  description: Serial number of the unit
  returned: always
  sample: FGVMEVYYQT3AB5352
  type: str
status:
  description: Indication of the operation's result
  returned: always
  sample: success
  type: str
vdom:
  description: Virtual domain used
  returned: always
  sample: root
  type: str
version:
  description: Version of the FortiGate
  returned: always
  sample: v5.6.3
  type: str