dux_fortinet.fortianalyzer_dev.faz_dvmdb_group (1.4.0) — module

Install collection

Install with ansible-galaxy collection install dux_fortinet.fortianalyzer_dev:==1.4.0

Add to requirements.yml

  collections:
    - name: dux_fortinet.fortianalyzer_dev
      version: 1.4.0

Description

This module is able to configure a FortiAnalyzer 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: Example playbook
  connection: httpapi
  hosts: fortianalyzers
  tasks:
    - name: Device group table.
      fortinet.fortianalyzer.faz_dvmdb_group:
        adom: root
        dvmdb_group:
          # desc: <value of string>
          # meta fields: <value of dict>
          name: foogroup
          os_type: unknown
          type: normal
        state: present
  vars:
    ansible_httpapi_port: 443
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false

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

log_path:
    default: /tmp/fortianalyzer.ansible.log
    description:
    - The path to save log. Used if enable_log is true.
    - Please use absolute path instead of relative path.
    - If the log_path setting is incorrect, the log will be saved in /tmp/fortianalyzer.ansible.log
    required: false
    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

dvmdb_group:
    description: The top level parameters set.
    required: false
    suboptions:
      cluster_type:
        choices:
        - unknown
        - vwan
        - sase
        description: no description
        type: str
      desc:
        description: no description
        type: str
      id:
        description: no description
        type: str
      meta fields:
        description: no description
        type: dict
      name:
        description: no description
        type: str
      os_type:
        choices:
        - unknown
        - fos
        - fsw
        - foc
        - fml
        - faz
        - fwb
        - fch
        - fct
        - log
        - fmg
        - fsa
        - fdd
        - fac
        - fpx
        - fna
        - fdc
        - ffw
        - fsr
        - fad
        - fts
        - fap
        - fxt
        - fai
        - fwc
        - fis
        - fed
        - fpa
        - fca
        - ftc
        description: no description
        type: str
      type:
        choices:
        - normal
        - default
        - auto
        - cluster
        - fabric
        description: no description
        type: str
    type: dict

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:
    - set
    - update
    - 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 FortiAnalyzer API structure,
      module continues to execute without validating parameters
    required: false
    type: bool

forticloud_access_token:
    description: Authenticate Ansible client with forticloud API access token.
    required: false
    type: str

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 fortianalyzer version.
  returned: complex
  type: list