drmofu.fortimanager.fmgr_system_snmp_user (2.2.2) — module

Install collection

Install with ansible-galaxy collection install drmofu.fortimanager:==2.2.2

Add to requirements.yml

  collections:
    - name: drmofu.fortimanager
      version: 2.2.2

Description

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.

Usage examples

Scanned by Steampunk Spotter

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

 - 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 SNMP users
      fmgr_fact:
        facts:
            selector: 'system_snmp_user'
            params:
                user: 'your_value'

Scanned by Steampunk Spotter

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

 - 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 user configuration.
      fmgr_system_snmp_user:
         bypass_validation: False
         state: present
         system_snmp_user:
            auth-proto: md5 #<value in [md5, sha]>
            auth-pwd: fortinet
            events:
              - disk_low
              - ha_switch
              - intf_ip_chg
              - sys_reboot
              - cpu_high
              - mem_low
              - log-alert
              - log-rate
              - log-data-rate
              - lic-gbday
              - lic-dev-quota
              - cpu-high-exclude-nice
            name: ansible-test-snmpuser
            queries: disable
            security-level: no-auth-no-priv #<value in [no-auth-no-priv, auth-no-priv, auth-priv]>

Inputs

    
state:
    choices:
    - present
    - absent
    description: The directive to create, update or delete an object.
    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

system_snmp_user:
    description: the top level parameters set
    required: false
    suboptions:
      auth-proto:
        choices:
        - md5
        - sha
        description:
        - Authentication protocol.
        - md5 - HMAC-MD5-96 authentication protocol.
        - sha - HMAC-SHA-96 authentication protocol.
        type: str
      auth-pwd:
        description: Password for authentication protocol.
        type: str
      events:
        choices:
        - disk_low
        - ha_switch
        - intf_ip_chg
        - sys_reboot
        - cpu_high
        - mem_low
        - log-alert
        - log-rate
        - log-data-rate
        - lic-gbday
        - lic-dev-quota
        - cpu-high-exclude-nice
        description: SNMP notifications
        elements: str
        type: list
      name:
        description: SNMP user name.
        type: str
      notify-hosts:
        description: Hosts to send notifications
        type: str
      notify-hosts6:
        description: IPv6 hosts to send notifications
        type: str
      priv-proto:
        choices:
        - aes
        - des
        description:
        - Privacy
        - aes - CFB128-AES-128 symmetric encryption protocol.
        - des - CBC-DES symmetric encryption protocol.
        type: str
      priv-pwd:
        description: Password for privacy
        type: str
      queries:
        choices:
        - disable
        - enable
        description:
        - Enable/disable queries for this user.
        - disable - Disable setting.
        - enable - Enable setting.
        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.
        - no-auth-no-priv - Message with no authentication and no privacy
        - auth-no-priv - Message with authentication but no privacy
        - auth-priv - Message with authentication and privacy
        type: str
    type: dict

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

Outputs

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