fortinet.fortianalyzer.faz_cli_system_sniffer (1.4.0) — module

Install collection

Install with ansible-galaxy collection install fortinet.fortianalyzer:==1.4.0

Add to requirements.yml

  collections:
    - name: fortinet.fortianalyzer
      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: Interface sniffer.
      fortinet.fortianalyzer.faz_cli_system_sniffer:
        cli_system_sniffer:
          host: 2.3.4.53
          id: 1
          interface: port1
          ipv6: disable
          max_packet_count: 100
          non_ip: disable
          port: 22
          protocol: 1
          vlan: 0
        state: present
  vars:
    ansible_httpapi_port: 443
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false

Inputs

    
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

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

cli_system_sniffer:
    description: The top level parameters set.
    required: false
    suboptions:
      host:
        description: Hosts to filter for in sniffer traffic
        type: str
      id:
        description: Sniffer ID.
        type: int
      interface:
        description: Interface.
        type: str
      ipv6:
        choices:
        - disable
        - enable
        description:
        - Enable/disable sniffing IPv6 packets.
        - disable - Disable sniffer for IPv6 packets.
        - enable - Enable sniffer for IPv6 packets.
        type: str
      max-packet-count:
        description: Maximum packet count (1000000, default = 4000).
        type: int
      non-ip:
        choices:
        - disable
        - enable
        description:
        - Enable/disable sniffing non-IP packets.
        - disable - Disable sniffer for non-IP packets.
        - enable - Enable sniffer for non-IP packets.
        type: str
      port:
        description: 'Ports to sniff (Format examples: 10, 100-200).'
        type: str
      protocol:
        description: Integer value for the protocol type as defined by IANA (0 - 255).
        type: str
      vlan:
        description: List of VLANs to sniff.
        type: str
    type: dict

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