fortinet.fortimanager.fmgr_system_docker (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: Docker host.
      fortinet.fortimanager.fmgr_system_docker:
        # 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_docker:
          fortiportal: <value in [disable, enable]>
          fortiwlm: <value in [disable, enable]>
          sdwancontroller: <value in [disable, enable]>
          status: <value in [disable, enable, qa, ...]>
          cpu: <integer>
          default_address_pool_base: <string>
          default_address_pool_size: <integer>
          fortiauthenticator: <value in [disable, enable]>
          fortisigconverter: <value in [disable, enable]>
          mem: <integer>
          docker_user_login_max: <integer>
          fortisoar: <value in [disable, enable]>
          fortiaiops: <value in [disable, enable]>
          policyanalyzer: <value in [disable, enable]>
          universalconnector: <value in [disable, enable]>
          fsmcollector: <value in [disable, enable]>

Inputs

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

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

system_docker:
    description: The top level parameters set.
    required: false
    suboptions:
      cpu:
        description: Cpu.
        type: int
      default-address-pool_base:
        description: Deprecated, please rename it to default_address_pool_base. Set default-address-pool
          CIDR.
        type: str
      default-address-pool_size:
        description: Deprecated, please rename it to default_address_pool_size. Set default-address-pool
          size.
        type: int
      docker-user-login-max:
        description: Deprecated, please rename it to docker_user_login_max. Max login
          session for docker users.
        type: int
      fortiaiops:
        choices:
        - disable
        - enable
        description:
        - Enable/disable container.
        - disable - Disable setting.
        - enable - Enable setting.
        type: str
      fortiauthenticator:
        choices:
        - disable
        - enable
        description:
        - Enable/disable container.
        - disable - Disable setting.
        - enable - Enable setting.
        type: str
      fortiportal:
        choices:
        - disable
        - enable
        description:
        - Enable/disable container.
        - disable - Disable setting.
        - enable - Enable setting.
        type: str
      fortisigconverter:
        choices:
        - disable
        - enable
        description:
        - Enable/disable container.
        - disable - Disable setting.
        - enable - Enable setting.
        type: str
      fortisoar:
        choices:
        - disable
        - enable
        description:
        - Enable/disable container.
        - disable - Disable setting.
        - enable - Enable setting.
        type: str
      fortiwlm:
        choices:
        - disable
        - enable
        description:
        - Enable/disable container.
        - disable - Disable setting.
        - enable - Enable setting.
        type: str
      fsmcollector:
        choices:
        - disable
        - enable
        description:
        - Enable/disable container.
        - disable - Disable setting.
        - enable - Enable setting.
        type: str
      mem:
        description: Max % RAM usage.
        type: int
      policyanalyzer:
        choices:
        - disable
        - enable
        description:
        - Enable/disable container.
        - disable - Disable setting.
        - enable - Enable setting.
        type: str
      sdwancontroller:
        choices:
        - disable
        - enable
        description:
        - Enable/disable container.
        - disable - Disable setting.
        - enable - Enable setting.
        type: str
      status:
        choices:
        - disable
        - enable
        - qa
        - dev
        description:
        - Enable and set registry.
        - disable - Disable docker host service.
        - enable - Enable production registry.
        - qa - Enable QA test registry.
        - dev - Enable QA test registry
        type: str
      universalconnector:
        choices:
        - disable
        - enable
        description:
        - Enable/disable container.
        - disable - Disable setting.
        - enable - Enable setting.
        type: str
    type: dict

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