drmofu.fortimanager.fmgr_system_dm (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: Configure dm.
      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: <value of integer>
            concurrent-install-limit: <value of integer>
            concurrent-install-script-limit: <value of integer>
            discover-timeout: <value of integer>
            dpm-logsize: <value of integer>
            fgfm-sock-timeout: <value of integer>
            fgfm_keepalive_itvl: <value of integer>
            force-remote-diff: <value in [disable, enable]>
            fortiap-refresh-cnt: <value of integer>
            fortiap-refresh-itvl: <value of integer>
            fortiext-refresh-cnt: <value of integer>
            install-image-timeout: <value of integer>
            install-tunnel-retry-itvl: <value of integer>
            max-revs: <value of integer>
            nr-retry: <value of integer>
            retry: <value in [disable, enable]>
            retry-intvl: <value of integer>
            rollback-allow-reboot: <value in [disable, enable]>
            script-logsize: <value of 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: <value of integer>
            conf-merge-after-script: <value in [disable, enable]>
            log-autoupdate: <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

system_dm:
    description: the top level parameters set
    required: false
    suboptions:
      concurrent-install-image-limit:
        description: Maximum number of concurrent install image
        type: int
      concurrent-install-limit:
        description: Maximum number of concurrent installs
        type: int
      concurrent-install-script-limit:
        description: Maximum number of concurrent install scripts
        type: int
      conf-merge-after-script:
        choices:
        - disable
        - enable
        description:
        - Merge config after run script on remote device, instead of full retrieve.
        - disable - Disable.
        - enable - Enable.
        type: str
      discover-timeout:
        description: Check connection timeout when discover device
        type: int
      dpm-logsize:
        description: Maximum dpm log size per device
        type: int
      fgfm-install-refresh-count:
        description: Maximum FGFM install refresh attempt.
        type: int
      fgfm-sock-timeout:
        description: 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:
        - Always use remote diff when installing.
        - disable - Disable.
        - enable - Enable.
        type: str
      fortiap-refresh-cnt:
        description: Max auto refresh FortiAP number each time
        type: int
      fortiap-refresh-itvl:
        description: Auto refresh FortiAP status interval
        type: int
      fortiext-refresh-cnt:
        description: Max device number for FortiExtender auto refresh
        type: int
      install-image-timeout:
        description: Maximum waiting time for image transfer and device upgrade
        type: int
      install-tunnel-retry-itvl:
        description: Time to re-establish tunnel during install
        type: int
      log-autoupdate:
        choices:
        - disable
        - enable
        description:
        - Enable/disable autoupdate debug logging.
        - disable - Disable.
        - enable - Enable.
        type: str
      max-revs:
        description: Maximum number of revisions saved
        type: int
      nr-retry:
        description: Number of retries.
        type: int
      retry:
        choices:
        - disable
        - enable
        description:
        - Enable/disable configuration install retry.
        - disable - Disable.
        - enable - Enable.
        type: str
      retry-intvl:
        description: Retry interval.
        type: int
      rollback-allow-reboot:
        choices:
        - disable
        - enable
        description:
        - Enable/disable FortiGate reboot to rollback when installing script/config.
        - disable - Disable.
        - enable - Enable.
        type: str
      script-logsize:
        description: Maximum script log size per device
        type: int
      skip-scep-check:
        choices:
        - disable
        - enable
        description:
        - 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:
        - Enable/disable skip the fcp request sent from fgfm tunnel
        - disable - Disable.
        - enable - Enable.
        type: str
      verify-install:
        choices:
        - disable
        - optimal
        - enable
        description:
        - 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.
    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

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