fortinet.fortimanager.fmgr_system_dm (2.4.0) — module

Install collection

Install with ansible-galaxy collection install fortinet.fortimanager:==2.4.0

Add to requirements.yml

  collections:
    - name: fortinet.fortimanager
      version: 2.4.0

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.

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure dm.
      fortinet.fortimanager.fmgr_system_dm:
        # 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_dm:
          concurrent_install_image_limit: <integer>
          concurrent_install_limit: <integer>
          concurrent_install_script_limit: <integer>
          discover_timeout: <integer>
          dpm_logsize: <integer>
          fgfm_sock_timeout: <integer>
          fgfm_keepalive_itvl: <integer>
          force_remote_diff: <value in [disable, enable]>
          fortiap_refresh_cnt: <integer>
          fortiap_refresh_itvl: <integer>
          fortiext_refresh_cnt: <integer>
          install_image_timeout: <integer>
          install_tunnel_retry_itvl: <integer>
          max_revs: <integer>
          nr_retry: <integer>
          retry: <value in [disable, enable]>
          retry_intvl: <integer>
          rollback_allow_reboot: <value in [disable, enable]>
          script_logsize: <integer>
          skip_scep_check: <value in [disable, enable]>
          skip_tunnel_fcp_req: <value in [disable, enable]>
          verify_install: <value in [disable, optimal, enable]>
          fgfm_install_refresh_count: <integer>
          conf_merge_after_script: <value in [disable, enable]>
          log_autoupdate: <value in [disable, enable]>
          fgfm_auto_retrieve_timeout: <integer>
          install_fds_timeout: <integer>

Inputs

    
rc_failed:
    description: The rc codes list with which the conditions to fail will be overriden.
    elements: int
    type: list

system_dm:
    description: The top level parameters set.
    required: false
    suboptions:
      concurrent-install-image-limit:
        description: Deprecated, please rename it to concurrent_install_image_limit. Maximum
          number of concurrent install image
        type: int
      concurrent-install-limit:
        description: Deprecated, please rename it to concurrent_install_limit. Maximum
          number of concurrent installs
        type: int
      concurrent-install-script-limit:
        description: Deprecated, please rename it to concurrent_install_script_limit.
          Maximum number of concurrent install scripts
        type: int
      conf-merge-after-script:
        choices:
        - disable
        - enable
        description:
        - Deprecated, please rename it to conf_merge_after_script.
        - Merge config after run script on remote device, instead of full retrieve.
        - disable - Disable.
        - enable - Enable.
        type: str
      discover-timeout:
        description: Deprecated, please rename it to discover_timeout. Check connection
          timeout when discover device
        type: int
      dpm-logsize:
        description: Deprecated, please rename it to dpm_logsize. Maximum dpm log size
          per device
        type: int
      fgfm-auto-retrieve-timeout:
        description: Deprecated, please rename it to fgfm_auto_retrieve_timeout. Maximum
          waiting time for auto retrieve
        type: int
      fgfm-install-refresh-count:
        description: Deprecated, please rename it to fgfm_install_refresh_count. Maximum
          FGFM install refresh attempt.
        type: int
      fgfm-sock-timeout:
        description: Deprecated, please rename it to fgfm_sock_timeout. Maximum FGFM socket
          idle time
        type: int
      fgfm_keepalive_itvl:
        description: FGFM protocol keep alive interval
        type: int
      force-remote-diff:
        choices:
        - disable
        - enable
        description:
        - Deprecated, please rename it to force_remote_diff.
        - Always use remote diff when installing.
        - disable - Disable.
        - enable - Enable.
        type: str
      fortiap-refresh-cnt:
        description: Deprecated, please rename it to fortiap_refresh_cnt. Max auto refresh
          FortiAP number each time
        type: int
      fortiap-refresh-itvl:
        description: Deprecated, please rename it to fortiap_refresh_itvl. Auto refresh
          FortiAP status interval
        type: int
      fortiext-refresh-cnt:
        description: Deprecated, please rename it to fortiext_refresh_cnt. Max device
          number for FortiExtender auto refresh
        type: int
      install-fds-timeout:
        description: Deprecated, please rename it to install_fds_timeout. Maximum waiting
          time for fgt update during install
        type: int
      install-image-timeout:
        description: Deprecated, please rename it to install_image_timeout. Maximum waiting
          time for image transfer and device upgrade
        type: int
      install-tunnel-retry-itvl:
        description: Deprecated, please rename it to install_tunnel_retry_itvl. Time to
          re-establish tunnel during install
        type: int
      log-autoupdate:
        choices:
        - disable
        - enable
        description:
        - Deprecated, please rename it to log_autoupdate.
        - Enable/disable autoupdate debug logging.
        - disable - Disable.
        - enable - Enable.
        type: str
      max-revs:
        description: Deprecated, please rename it to max_revs. Maximum number of revisions
          saved
        type: int
      nr-retry:
        description: Deprecated, please rename it to nr_retry. Number of retries.
        type: int
      retry:
        choices:
        - disable
        - enable
        description:
        - Enable/disable configuration install retry.
        - disable - Disable.
        - enable - Enable.
        type: str
      retry-intvl:
        description: Deprecated, please rename it to retry_intvl. Retry interval.
        type: int
      rollback-allow-reboot:
        choices:
        - disable
        - enable
        description:
        - Deprecated, please rename it to rollback_allow_reboot.
        - Enable/disable FortiGate reboot to rollback when installing script/config.
        - disable - Disable.
        - enable - Enable.
        type: str
      script-logsize:
        description: Deprecated, please rename it to script_logsize. Maximum script log
          size per device
        type: int
      skip-scep-check:
        choices:
        - disable
        - enable
        description:
        - Deprecated, please rename it to skip_scep_check.
        - Enable/disable installing scep related objects even if scep url is configured.
        - disable - Disable.
        - enable - Enable.
        type: str
      skip-tunnel-fcp-req:
        choices:
        - disable
        - enable
        description:
        - Deprecated, please rename it to skip_tunnel_fcp_req.
        - Enable/disable skip the fcp request sent from fgfm tunnel
        - disable - Disable.
        - enable - Enable.
        type: str
      verify-install:
        choices:
        - disable
        - optimal
        - enable
        description:
        - Deprecated, please rename it to verify_install.
        - Verify install against remote configuration.
        - disable - Disable.
        - optimal - Verify installation for command errors.
        - enable - Always verify installation.
        type: str
    type: dict

enable_log:
    default: false
    description: Enable/Disable logging for task.
    type: bool

access_token:
    description: The token to access FortiManager without using username and password.
    type: str

rc_succeeded:
    description: The rc codes list with which the conditions to succeed will be overriden.
    elements: int
    type: list

proposed_method:
    choices:
    - update
    - set
    - add
    description: The overridden method for the underlying Json RPC request.
    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.
    type: bool

workspace_locking_adom:
    description: The adom to lock for FortiManager running in workspace mode, the value
      can be global and others including root.
    type: str

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

workspace_locking_timeout:
    default: 300
    description: The maximum time in seconds to wait for other user to release the workspace
      lock.
    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