drmofu.fortianalyzer.faz_cli_system_admin_setting (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.

- collections:
    - fortinet.fortianalyzer
  connection: httpapi
  hosts: fortianalyzer_inventory
  tasks:
    - faz_cli_system_admin_setting:
        cli_system_admin_setting:
          access-banner: disable
          admin-https-redirect: disable
          objects-force-deletion: disable
          shell-access: disable
          show-add-multiple: disable
          show-checkbox-in-table: disable
          show-device-import-export: disable
          show-fct-manager: disable
          show-hostname: disable
          show-log-forwarding: disable
      name: Admin setting.
  vars:
    ansible_httpapi_port: 443
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false

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

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

cli_system_admin_setting:
    description: the top level parameters set
    required: false
    suboptions:
      access-banner:
        choices:
        - disable
        - enable
        description:
        - Enable/disable access banner.
        - disable - Disable setting.
        - enable - Enable setting.
        type: str
      admin-https-redirect:
        choices:
        - disable
        - enable
        description:
        - Enable/disable redirection of HTTP admin traffic to HTTPS.
        - disable - Disable setting.
        - enable - Enable setting.
        type: str
      admin-login-max:
        description: Maximum number admin users logged in at one time (1 - 256).
        type: int
      admin_server_cert:
        description: HTTPS & Web Service server certificate.
        type: str
      auth-addr:
        description: IP which is used by FGT to authorize FAZ.
        type: str
      auth-port:
        description: Port which is used by FGT to authorize FAZ.
        type: int
      banner-message:
        description: Banner message.
        type: str
      firmware-upgrade-check:
        choices:
        - disable
        - enable
        description:
        - Enable/disable firmware upgrade check.
        - disable - Disable setting.
        - enable - Enable setting.
        type: str
      fsw-ignore-platform-check:
        choices:
        - disable
        - enable
        description:
        - Enable/disable FortiSwitch Manager switch platform support check.
        - disable - Disable setting.
        - enable - Enable setting.
        type: str
      gui-theme:
        choices:
        - blue
        - green
        - red
        - melongene
        - spring
        - summer
        - autumn
        - winter
        - space
        - calla-lily
        - binary-tunnel
        - diving
        - dreamy
        - technology
        - landscape
        - twilight
        - canyon
        - northern-light
        - astronomy
        - fish
        - penguin
        - panda
        - polar-bear
        - parrot
        - cave
        - mountain
        - zebra
        - contrast-dark
        - circuit-board
        - mars
        - blue-sea
        - mariner
        - jade
        - neutrino
        - dark-matter
        - forest
        - cat
        - graphite
        description:
        - Color scheme to use for the administration GUI.
        - blue - Blueberry
        - green - Kiwi
        - red - Cherry
        - melongene - Plum
        - spring - Spring
        - summer - Summer
        - autumn - Autumn
        - winter - Winter
        - space - Space
        - calla-lily - Calla Lily
        - binary-tunnel - Binary Tunnel
        - diving - Diving
        - dreamy - Dreamy
        - technology - Technology
        - landscape - Landscape
        - twilight - Twilight
        - canyon - Canyon
        - northern-light - Northern Light
        - astronomy - Astronomy
        - fish - Fish
        - penguin - Penguin
        - panda - Panda
        - polar-bear - Polar Bear
        - parrot - Parrot
        - cave - Cave
        type: str
      http_port:
        description: HTTP port.
        type: int
      https_port:
        description: HTTPS port.
        type: int
      idle_timeout:
        description: Idle timeout (1 - 480 min).
        type: int
      idle_timeout_api:
        description: Idle timeout for API sessions (1 - 28800 sec).
        type: int
      idle_timeout_gui:
        description: Idle timeout for GUI sessions (60 - 28800 sec).
        type: int
      idle_timeout_sso:
        description: Idle timeout for SSO sessions (60 - 28800 sec).
        type: int
      objects-force-deletion:
        choices:
        - disable
        - enable
        description:
        - Enable/disable used objects force deletion.
        - disable - Disable setting.
        - enable - Enable setting.
        type: str
      preferred-fgfm-intf:
        description: Preferred interface for FGFM connection.
        type: str
      shell-access:
        choices:
        - disable
        - enable
        description:
        - Enable/disable shell access.
        - disable - Disable setting.
        - enable - Enable setting.
        type: str
      shell-password:
        description: no description
        type: str
      show-add-multiple:
        choices:
        - disable
        - enable
        description:
        - Show add multiple button.
        - disable - Disable setting.
        - enable - Enable setting.
        type: str
      show-checkbox-in-table:
        choices:
        - disable
        - enable
        description:
        - Show checkboxs in tables on GUI.
        - disable - Disable setting.
        - enable - Enable setting.
        type: str
      show-device-import-export:
        choices:
        - disable
        - enable
        description:
        - Enable/disable import/export of ADOM, device, and group lists.
        - disable - Disable setting.
        - enable - Enable setting.
        type: str
      show-fct-manager:
        choices:
        - disable
        - enable
        description:
        - Enable/disable FCT manager.
        - disable - Disable setting.
        - enable - Enable setting.
        type: str
      show-hostname:
        choices:
        - disable
        - enable
        description:
        - Enable/disable hostname display in the GUI login page.
        - disable - Disable setting.
        - enable - Enable setting.
        type: str
      show-log-forwarding:
        choices:
        - disable
        - enable
        description:
        - Show log forwarding tab in regular mode.
        - disable - Disable setting.
        - enable - Enable setting.
        type: str
      unreg_dev_opt:
        choices:
        - add_no_service
        - ignore
        - add_allow_service
        description:
        - Action to take when unregistered device connects to FortiAnalyzer.
        - add_no_service - Add unregistered devices but deny service requests.
        - ignore - Ignore unregistered devices.
        - add_allow_service - Add unregistered devices and allow service requests.
        type: str
      webadmin_language:
        choices:
        - auto_detect
        - english
        - simplified_chinese
        - traditional_chinese
        - japanese
        - korean
        - spanish
        - french
        description:
        - Web admin language.
        - auto_detect - Automatically detect language.
        - english - English.
        - simplified_chinese - Simplified Chinese.
        - traditional_chinese - Traditional Chinese.
        - japanese - Japanese.
        - korean - Korean.
        - spanish - Spanish.
        type: str
    type: dict

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