drmofu.fortimanager.fmgr_pm_pkg_global (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: fortimanager00
   collections:
     - fortinet.fortimanager
   connection: httpapi
   vars:
      ansible_httpapi_use_ssl: True
      ansible_httpapi_validate_certs: False
      ansible_httpapi_port: 443
   tasks:
   - name: create a package in a adom
     fmgr_pm_pkg_adom:
      adom: 'ansible'
      pm_pkg_adom:
          name: 'ansible'
          type: 'pkg'

   - name: create a package in global adom
     fmgr_pm_pkg_global:
      pm_pkg_global:
          name: 'ansible'
          type: 'pkg'

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

pm_pkg_global:
    description: the top level parameters set
    required: false
    suboptions:
      name:
        description: no description
        type: str
      obj ver:
        description: no description
        type: int
      oid:
        description: no description
        type: int
      package setting:
        description: no description
        required: false
        suboptions:
          central-nat:
            choices:
            - disable
            - enable
            description: no description
            type: str
          consolidated-firewall-mode:
            choices:
            - disable
            - enable
            description: no description
            type: str
          fwpolicy-implicit-log:
            choices:
            - disable
            - enable
            description: no description
            type: str
          fwpolicy6-implicit-log:
            choices:
            - disable
            - enable
            description: no description
            type: str
          inspection-mode:
            choices:
            - proxy
            - flow
            description: no description
            type: str
          ngfw-mode:
            choices:
            - profile-based
            - policy-based
            description: no description
            type: str
          ssl-ssh-profile:
            description: no description
            type: str
        type: dict
      package settings:
        description: no description
        required: false
        suboptions:
          central-nat:
            choices:
            - disable
            - enable
            description:
            - disable -
            - enable -
            type: str
          consolidated-firewall-mode:
            choices:
            - disable
            - enable
            description:
            - For flow-based policy package.
            - disable -
            - enable -
            type: str
          fwpolicy-implicit-log:
            choices:
            - disable
            - enable
            description:
            - disable -
            - enable -
            type: str
          fwpolicy6-implicit-log:
            choices:
            - disable
            - enable
            description:
            - disable -
            - enable -
            type: str
          inspection-mode:
            choices:
            - proxy
            - flow
            description:
            - proxy -
            - flow -
            type: str
          ngfw-mode:
            choices:
            - profile-based
            - policy-based
            description:
            - For flow-based policy package.
            - profile-based -
            - policy-based -
            type: str
          policy-offload-level:
            choices:
            - disable
            - default
            - dos-offload
            - full-offload
            description:
            - disable -
            - default -
            - dos-offload -
            - full-offload -
            type: str
          ssl-ssh-profile:
            description: SSL-SSH profile required for NGFW-mode policy package.
            type: str
        type: dict
      scope member:
        description: description
        elements: dict
        suboptions:
          name:
            description: no description
            type: str
          vdom:
            description: no description
            type: str
        type: list
      type:
        choices:
        - pkg
        - folder
        description: no description
        type: str
    type: dict

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