drmofu.fortimanager.fmgr_devprof_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.

 - 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_devprof_system_snmp_user:
         bypass_validation: False
         adom: ansible
         devprof: 'ansible-test' # system template name, could find it in FortiManager UI: Device Manager --> Provisioning Templates --> System Templates
         state: present
         devprof_system_snmp_user:
            auth-proto: md5
            auth-pwd: 'fortinet'
            events:
              - cpu-high
              - mem-low
              - log-full
              - intf-ip
              - vpn-tun-up
              - vpn-tun-down
              - ha-switch
              - fm-conf-change
              - ips-signature
              - ips-anomaly
              - temperature-high
              - voltage-alert
              - av-virus
              - av-oversize
              - av-pattern
              - av-fragmented
              - ha-hb-failure
              - fan-failure
              - ha-member-up
              - ha-member-down
              - ent-conf-change
              - av-conserve
              - av-bypass
              - av-oversize-passed
              - av-oversize-blocked
              - ips-pkg-update
              - fm-if-change
              - power-supply-failure
              - amc-bypass
              - faz-disconnect
              - bgp-established
              - bgp-backward-transition
              - wc-ap-up
              - wc-ap-down
              - fswctl-session-up
              - fswctl-session-down
              - ips-fail-open
              - load-balance-real-server-down
              - device-new
              - enter-intf-bypass
              - exit-intf-bypass
              - per-cpu-high
              - power-blade-down
              - confsync_failure
            ha-direct: disable
            name: 'ansible-test'

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 scripts
      fmgr_fact:
        facts:
            selector: 'devprof_system_snmp_user'
            params:
                adom: 'ansible'
                devprof: 'ansible-test' # system template name, could find it in FortiManager UI: Device Manager --> Provisioning Templates --> System Templates
                user: 'your_value'

Inputs

    
adom:
    description: the parameter (adom) in requested url
    required: true
    type: str

state:
    choices:
    - present
    - absent
    description: The directive to create, update or delete an object.
    required: true
    type: str

devprof:
    description: the parameter (devprof) in requested url
    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

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

devprof_system_snmp_user:
    description: the top level parameters set
    required: false
    suboptions:
      auth-proto:
        choices:
        - md5
        - sha
        - sha224
        - sha256
        - sha384
        - sha512
        description: Authentication protocol.
        type: str
      auth-pwd:
        description: description
        type: str
      events:
        choices:
        - cpu-high
        - mem-low
        - log-full
        - intf-ip
        - vpn-tun-up
        - vpn-tun-down
        - ha-switch
        - fm-conf-change
        - ips-signature
        - ips-anomaly
        - temperature-high
        - voltage-alert
        - av-virus
        - av-oversize
        - av-pattern
        - av-fragmented
        - ha-hb-failure
        - fan-failure
        - ha-member-up
        - ha-member-down
        - ent-conf-change
        - av-conserve
        - av-bypass
        - av-oversize-passed
        - av-oversize-blocked
        - ips-pkg-update
        - fm-if-change
        - power-supply-failure
        - amc-bypass
        - faz-disconnect
        - bgp-established
        - bgp-backward-transition
        - wc-ap-up
        - wc-ap-down
        - fswctl-session-up
        - fswctl-session-down
        - ips-fail-open
        - load-balance-real-server-down
        - device-new
        - enter-intf-bypass
        - exit-intf-bypass
        - per-cpu-high
        - power-blade-down
        - confsync_failure
        - dhcp
        - pool-usage
        - power-redundancy-degrade
        - power-redundancy-failure
        - ospf-nbr-state-change
        - ospf-virtnbr-state-change
        - disk-failure
        - disk-overload
        - faz-main-failover
        - faz-alt-failover
        - slbc
        description: description
        elements: str
        type: list
      ha-direct:
        choices:
        - disable
        - enable
        description: Enable/disable direct management of HA cluster members.
        type: str
      mib-view:
        description: SNMP access control MIB view.
        type: str
      name:
        description: SNMP user name.
        type: str
      notify-hosts:
        description: description
        type: str
      notify-hosts6:
        description: IPv6 SNMP managers to send notifications
        type: str
      priv-proto:
        choices:
        - aes
        - des
        - aes256
        - aes256cisco
        description: Privacy
        type: str
      priv-pwd:
        description: description
        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
      source-ip:
        description: Source IP for SNMP trap.
        type: str
      source-ipv6:
        description: Source IPv6 for SNMP trap.
        type: str
      status:
        choices:
        - disable
        - enable
        description: Enable/disable this SNMP user.
        type: str
      trap-lport:
        description: SNMPv3 local trap port
        type: int
      trap-rport:
        description: SNMPv3 trap remote port
        type: int
      trap-status:
        choices:
        - disable
        - enable
        description: Enable/disable traps for this SNMP user.
        type: str
      vdoms:
        description: description
        type: str
    type: dict

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