drmofu.fortianalyzer.faz_cli_system_webproxy (1.3.0) — module

Install collection

Install with ansible-galaxy collection install drmofu.fortianalyzer:==1.3.0

Add to requirements.yml

  collections:
    - name: drmofu.fortianalyzer
      version: 1.3.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.

- hosts: fortianalyzer_inventory
  collections:
    - fortinet.fortianalyzer
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: True
    ansible_httpapi_validate_certs: False
    ansible_httpapi_port: 443
  tasks:
    - name: Configure system web proxy.
      faz_cli_system_webproxy:
        bypass_validation: False
        rc_succeeded: [0, -2, -3, ...]
        rc_failed: [-2, -3, ...]
        cli_system_webproxy:
          address: <value of string>
          mode: <value in [proxy, tunnel]>
          password: <value of string>
          port: <value of integer>
          status: <value in [disable, enable]>
          username: <value of string>

Inputs

    
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_webproxy:
    description: the top level parameters set
    required: false
    suboptions:
      address:
        description: web proxy address.
        type: str
      mode:
        choices:
        - proxy
        - tunnel
        description:
        - Web proxy mode (default = tunnel)
        - proxy - proxy mode
        - tunnel - tunnel mode (default)
        type: str
      password:
        description: no description
        type: str
      port:
        description: The port number of the web proxy (1 - 65535, default = 1080).
        type: int
      status:
        choices:
        - disable
        - enable
        description:
        - Enable/disable system web proxy (default = disable).
        - disable - Disable setting.
        - enable - Enable setting.
        type: str
      username:
        description: The user name used for authentication.
        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