lix_fortinet.fortios.fortios_wireless_controller_snmp (102.2.120) — module

Configure SNMP in Fortinet's FortiOS and FortiGate.

| "added in version" 2.0.0 of lix_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 lix_fortinet.fortios:==102.2.120


Add to requirements.yml

  collections:
    - name: lix_fortinet.fortios
      version: 102.2.120

Description

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify wireless_controller feature and snmp 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.
- 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 SNMP.
    fortios_wireless_controller_snmp:
      vdom:  "{{ vdom }}"
      wireless_controller_snmp:
        community:
         -
            hosts:
             -
                id:  "5"
                ip: "<your_own_value>"
            id:  "7"
            name: "default_name_8"
            query_v1_status: "enable"
            query_v2c_status: "enable"
            status: "enable"
            trap_v1_status: "enable"
            trap_v2c_status: "enable"
        contact_info: "<your_own_value>"
        engine_id: "<your_own_value>"
        trap_high_cpu_threshold: "80"
        trap_high_mem_threshold: "80"
        user:
         -
            auth_proto: "md5"
            auth_pwd: "<your_own_value>"
            name: "default_name_21"
            notify_hosts: "<your_own_value>"
            priv_proto: "aes"
            priv_pwd: "<your_own_value>"
            queries: "enable"
            security_level: "no-auth-no-priv"
            status: "enable"
            trap_status: "enable"

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

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

wireless_controller_snmp:
    default: null
    description:
    - Configure SNMP.
    suboptions:
      community:
        description:
        - SNMP Community Configuration.
        elements: dict
        suboptions:
          hosts:
            description:
            - Configure IPv4 SNMP managers (hosts).
            elements: dict
            suboptions:
              id:
                description:
                - Host entry ID.
                type: int
              ip:
                description:
                - IPv4 address of the SNMP manager (host).
                type: str
            type: list
          id:
            description:
            - Community ID.
            type: int
          name:
            description:
            - Community name.
            type: str
          query_v1_status:
            choices:
            - enable
            - disable
            description:
            - Enable/disable SNMP v1 queries.
            type: str
          query_v2c_status:
            choices:
            - enable
            - disable
            description:
            - Enable/disable SNMP v2c queries.
            type: str
          status:
            choices:
            - enable
            - disable
            description:
            - Enable/disable this SNMP community.
            type: str
          trap_v1_status:
            choices:
            - enable
            - disable
            description:
            - Enable/disable SNMP v1 traps.
            type: str
          trap_v2c_status:
            choices:
            - enable
            - disable
            description:
            - Enable/disable SNMP v2c traps.
            type: str
        type: list
      contact_info:
        description:
        - Contact Information.
        type: str
      engine_id:
        description:
        - AC SNMP engineID string (maximum 24 characters).
        type: str
      trap_high_cpu_threshold:
        description:
        - CPU usage when trap is sent.
        type: int
      trap_high_mem_threshold:
        description:
        - Memory usage when trap is sent.
        type: int
      user:
        description:
        - SNMP User Configuration.
        elements: dict
        suboptions:
          auth_proto:
            choices:
            - md5
            - sha
            description:
            - Authentication protocol.
            type: str
          auth_pwd:
            description:
            - Password for authentication protocol.
            type: str
          name:
            description:
            - SNMP user name.
            type: str
          notify_hosts:
            description:
            - Configure SNMP User Notify Hosts.
            elements: str
            type: list
          priv_proto:
            choices:
            - aes
            - des
            - aes256
            - aes256cisco
            description:
            - Privacy (encryption) protocol.
            type: str
          priv_pwd:
            description:
            - Password for privacy (encryption) protocol.
            type: str
          queries:
            choices:
            - enable
            - disable
            description:
            - Enable/disable SNMP queries for this user.
            type: str
          security_level:
            choices:
            - no-auth-no-priv
            - auth-no-priv
            - auth-priv
            description:
            - Security level for message authentication and encryption.
            type: str
          status:
            choices:
            - enable
            - disable
            description:
            - SNMP user enable.
            type: str
          trap_status:
            choices:
            - enable
            - disable
            description:
            - Enable/disable traps for this SNMP user.
            type: str
        type: list
    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