fortinet.fortios.fortios_switch_controller_snmp_community (2.3.6) — module

Configure FortiSwitch SNMP v1/v2c communities globally in Fortinet's FortiOS and FortiGate.

| "added in version" 2.0.0 of fortinet.fortios"

Authors: Link Zheng (@chillancezen), Jie Xue (@JieX19), Hongbin Lu (@fgtdev-hblu), Frank Shen (@frankshen01), Miguel Angel Munoz (@mamunozgonzalez), Nicolas Thomas (@thomnico)

preview | supported by community

Install collection

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


Add to requirements.yml

  collections:
    - name: fortinet.fortios
      version: 2.3.6

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.0.0


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Configure FortiSwitch SNMP v1/v2c communities globally.
  fortinet.fortios.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: "161"
          query_v1_status: "disable"
          query_v2c_port: "161"
          query_v2c_status: "disable"
          status: "disable"
          trap_v1_lport: "162"
          trap_v1_rport: "162"
          trap_v1_status: "disable"
          trap_v2c_lport: "162"
          trap_v2c_rport: "162"
          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

enable_log:
    default: false
    description:
    - Enable/Disable logging for task.
    required: false
    type: bool

member_path:
    description:
    - Member attribute path to operate on.
    - Delimited by a slash character if there are more than one attribute.
    - Parameter marked with member_path is legitimate for doing member operation.
    type: str

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

member_state:
    choices:
    - present
    - absent
    description:
    - Add or delete a member under specified attribute path.
    - When member_state is specified, the state option is ignored.
    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.
        elements: str
        type: list
      hosts:
        description:
        - Configure IPv4 SNMP managers (hosts).
        elements: dict
        suboptions:
          id:
            description:
            - Host entry ID. see <a href='#notes'>Notes</a>.
            required: true
            type: int
          ip:
            description:
            - IPv4 address of the SNMP manager (host).
            type: str
        type: list
      id:
        description:
        - SNMP community ID. see <a href='#notes'>Notes</a>.
        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