lix_fortinet.fortios.fortios_switch_controller_snmp_user (102.2.120) — module

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 switch_controller feature and snmp_user category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0

Requirements

• ansible>=2.9

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 v3 users globally.
    fortios_switch_controller_snmp_user:
      vdom:  "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      switch_controller_snmp_user:
        auth_proto: "md5"
        auth_pwd: "<your_own_value>"
        name: "default_name_5"
        priv_proto: "aes128"
        priv_pwd: "<your_own_value>"
        queries: "disable"
        query_port: "161"
        security_level: "no-auth-no-priv"

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_user:
    default: null
    description:
    - Configure FortiSwitch SNMP v3 users globally.
    suboptions:
      auth_proto:
        choices:
        - md5
        - sha1
        - sha224
        - sha256
        - sha384
        - sha512
        - sha
        description:
        - Authentication protocol.
        type: str
      auth_pwd:
        description:
        - Password for authentication protocol.
        type: str
      name:
        description:
        - SNMP user name.
        required: true
        type: str
      priv_proto:
        choices:
        - aes128
        - aes192
        - aes192c
        - aes256
        - aes256c
        - des
        - aes
        description:
        - Privacy (encryption) protocol.
        type: str
      priv_pwd:
        description:
        - Password for privacy (encryption) protocol.
        type: str
      queries:
        choices:
        - disable
        - enable
        description:
        - Enable/disable SNMP queries for this user.
        type: str
      query_port:
        description:
        - SNMPv3 query port .
        type: int
      security_level:
        choices:
        - no-auth-no-priv
        - auth-no-priv
        - auth-priv
        description:
        - Security level for message authentication and encryption.
        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