drmofu.fortimanager.fmgr_system_admin_setting (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: fortimanager-inventory
   collections:
     - fortinet.fortimanager
   connection: httpapi
   vars:
      ansible_httpapi_use_ssl: True
      ansible_httpapi_validate_certs: False
      ansible_httpapi_port: 443
   tasks:
    - name: Admin setting.
      fmgr_system_admin_setting:
         bypass_validation: False
         workspace_locking_adom: <value in [global, custom adom including root]>
         workspace_locking_timeout: 300
         rc_succeeded: [0, -2, -3, ...]
         rc_failed: [-2, -3, ...]
         system_admin_setting:
            access-banner: <value in [disable, enable]>
            admin-https-redirect: <value in [disable, enable]>
            admin-login-max: <value of integer>
            admin_server_cert: <value of string>
            allow_register: <value in [disable, enable]>
            auto-update: <value in [disable, enable]>
            banner-message: <value of string>
            chassis-mgmt: <value in [disable, enable]>
            chassis-update-interval: <value of integer>
            device_sync_status: <value in [disable, enable]>
            gui-theme: <value in [blue, green, red, ...]>
            http_port: <value of integer>
            https_port: <value of integer>
            idle_timeout: <value of integer>
            install-ifpolicy-only: <value in [disable, enable]>
            mgmt-addr: <value of string>
            mgmt-fqdn: <value of string>
            objects-force-deletion: <value in [disable, enable]>
            offline_mode: <value in [disable, enable]>
            register_passwd: <value of string>
            sdwan-monitor-history: <value in [disable, enable]>
            shell-access: <value in [disable, enable]>
            shell-password: <value of string>
            show-add-multiple: <value in [disable, enable]>
            show-adom-devman: <value in [disable, enable]>
            show-checkbox-in-table: <value in [disable, enable]>
            show-device-import-export: <value in [disable, enable]>
            show-hostname: <value in [disable, enable]>
            show_automatic_script: <value in [disable, enable]>
            show_grouping_script: <value in [disable, enable]>
            show_schedule_script: <value in [disable, enable]>
            show_tcl_script: <value in [disable, enable]>
            unreg_dev_opt: <value in [add_no_service, ignore, add_allow_service]>
            webadmin_language: <value in [auto_detect, english, simplified_chinese, ...]>
            show-fct-manager: <value in [disable, enable]>
            sdwan-skip-unmapped-input-device: <value in [disable, enable]>
            auth-addr: <value of string>
            auth-port: <value of integer>
            idle_timeout_api: <value of integer>
            idle_timeout_gui: <value of integer>
            central-ftgd-local-cat-id: <value in [disable, enable]>
            idle_timeout_sso: <value of integer>
            preferred-fgfm-intf: <value of string>
            traffic-shaping-history: <value in [disable, enable]>
            fsw-ignore-platform-check: <value in [disable, enable]>
            rtm-max-monitor-by-days: <value of integer>
            rtm-temp-file-limit: <value of integer>
            firmware-upgrade-check: <value in [disable, enable]>

Inputs

    
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

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
        type: int
      admin_server_cert:
        description: HTTPS & Web Service server certificate.
        type: str
      allow_register:
        choices:
        - disable
        - enable
        description:
        - Enable/disable allowance of register an unregistered device.
        - disable - Disable setting.
        - enable - Enable setting.
        type: str
      auth-addr:
        description: IP which is used by FGT to authorize FMG.
        type: str
      auth-port:
        description: Port which is used by FGT to authorize FMG.
        type: int
      auto-update:
        choices:
        - disable
        - enable
        description:
        - Enable/disable FortiGate automatic update.
        - disable - Disable device automatic update.
        - enable - Enable device automatic update.
        type: str
      banner-message:
        description: Banner message.
        type: str
      central-ftgd-local-cat-id:
        choices:
        - disable
        - enable
        description:
        - Central FortiGuard local category id management, and do not auto assign id during
          installation.
        - disable - Disable setting.
        - enable - Enable setting.
        type: str
      chassis-mgmt:
        choices:
        - disable
        - enable
        description:
        - Enable or disable chassis management.
        - disable - Disable setting.
        - enable - Enable setting.
        type: str
      chassis-update-interval:
        description: Chassis background update interval
        type: int
      device_sync_status:
        choices:
        - disable
        - enable
        description:
        - Enable/disable device synchronization status indication.
        - disable - Disable setting.
        - enable - Enable setting.
        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
        type: int
      idle_timeout_api:
        description: Idle timeout for API sessions
        type: int
      idle_timeout_gui:
        description: Idle timeout for GUI sessions
        type: int
      idle_timeout_sso:
        description: Idle timeout for SSO sessions
        type: int
      install-ifpolicy-only:
        choices:
        - disable
        - enable
        description:
        - Allow install interface policy only.
        - disable - Disable setting.
        - enable - Enable setting.
        type: str
      mgmt-addr:
        description: IP of FortiManager used by FGFM.
        type: str
      mgmt-fqdn:
        description: FQDN of FortiManager used by FGFM.
        type: str
      objects-force-deletion:
        choices:
        - disable
        - enable
        description:
        - Enable/disable used objects force deletion.
        - disable - Disable setting.
        - enable - Enable setting.
        type: str
      offline_mode:
        choices:
        - disable
        - enable
        description:
        - Enable/disable offline mode.
        - disable - Disable offline mode.
        - enable - Enable offline mode.
        type: str
      preferred-fgfm-intf:
        description: Preferred interface for FGFM connection.
        type: str
      register_passwd:
        description: Password for register a device.
        type: str
      rtm-max-monitor-by-days:
        description: Maximum rtm monitor
        type: int
      rtm-temp-file-limit:
        description: Set rtm monitor temp file limit by hours.
        type: int
      sdwan-monitor-history:
        choices:
        - disable
        - enable
        description:
        - Enable/disable hostname display in the GUI login page.
        - disable - Disable setting.
        - enable - Enable setting.
        type: str
      sdwan-skip-unmapped-input-device:
        choices:
        - disable
        - enable
        description:
        - Skip unmapped interface for sdwan/rule/input-device instead of report mapping
          error.
        - disable - Disable setting.
        - enable - Enable setting.
        type: str
      shell-access:
        choices:
        - disable
        - enable
        description:
        - Enable/disable shell access.
        - disable - Disable setting.
        - enable - Enable setting.
        type: str
      shell-password:
        description: Password for shell access.
        type: str
      show-add-multiple:
        choices:
        - disable
        - enable
        description:
        - Show add multiple button.
        - disable - Disable setting.
        - enable - Enable setting.
        type: str
      show-adom-devman:
        choices:
        - disable
        - enable
        description:
        - Show ADOM device manager tools on GUI.
        - disable - Hide device manager tools on GUI.
        - enable - Show device manager tools on GUI.
        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_automatic_script:
        choices:
        - disable
        - enable
        description:
        - Enable/disable automatic script.
        - disable - Disable script option.
        - enable - Enable script option.
        type: str
      show_grouping_script:
        choices:
        - disable
        - enable
        description:
        - Enable/disable grouping script.
        - disable - Disable script option.
        - enable - Enable script option.
        type: str
      show_schedule_script:
        choices:
        - disable
        - enable
        description:
        - Enable or disable schedule script.
        - disable - Disable script option.
        - enable - Enable script option.
        type: str
      show_tcl_script:
        choices:
        - disable
        - enable
        description:
        - Enable/disable TCL script.
        - disable - Disable script option.
        - enable - Enable script option.
        type: str
      traffic-shaping-history:
        choices:
        - disable
        - enable
        description:
        - Enable/disable traffic-shaping-history.
        - 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 FortiManager.
        - 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

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

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