fmgr_pm_pkg_adom – Policy package or folder.

New in version 2.10.

Synopsis

  • This module is able to configure a FortiManager device.
  • Examples include all parameters and values need to be adjusted to data sources before usage.

Requirements

The below requirements are needed on the host that executes this module.

  • ansible>=2.9.0

FortiManager Version Compatibility


6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0
pm_pkg_adom yes yes yes yes yes yes yes yes yes

Parameters

  • enable_log - Enable/Disable logging for task type: bool required: false default: False
  • forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0 type: str required: false
  • proposed_method - The overridden method for the underlying Json RPC request type: str required: false choices: set, update, add
  • bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters type: bool required: false default: False
  • workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode type: str required: false choices: global, custom adom including root
  • workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock type: integer required: false default: 300
  • rc_succeeded - The rc codes list with which the conditions to succeed will be overriden type: list required: false
  • rc_failed - The rc codes list with which the conditions to fail will be overriden type: list required: false
  • adom - The parameter in requested url type: str required: true
  • pm_pkg_adom - no description type: dict
    • name - No description for the parameter type: str more...
    • obj ver - No description for the parameter type: int more...
    • oid - No description for the parameter type: int more...
    • package setting type: dict
      • central-nat - No description for the parameter type: str choices: [disable, enable] more...
      • consolidated-firewall-mode - No description for the parameter type: str choices: [disable, enable] more...
      • fwpolicy-implicit-log - No description for the parameter type: str choices: [disable, enable] more...
      • fwpolicy6-implicit-log - No description for the parameter type: str choices: [disable, enable] more...
      • inspection-mode - No description for the parameter type: str choices: [proxy, flow] more...
      • ngfw-mode - No description for the parameter type: str choices: [profile-based, policy-based] more...
      • ssl-ssh-profile - No description for the parameter type: str more...
    • scope member - No description for the parameter type: array more...
      • name - No description for the parameter type: str more...
      • vdom - No description for the parameter type: str more...
    • type - No description for the parameter type: str choices: [pkg, folder] more...
    • package settings type: dict
      • central-nat - disable - (value 0) type: str choices: [disable, enable] more...
      • consolidated-firewall-mode - For flow-based policy package. type: str choices: [disable, enable] more...
      • fwpolicy-implicit-log - disable - (value 0) type: str choices: [disable, enable] more...
      • fwpolicy6-implicit-log - disable - (value 0) type: str choices: [disable, enable] more...
      • inspection-mode - proxy - (value 0) type: str choices: [proxy, flow] more...
      • ngfw-mode - For flow-based policy package. type: str choices: [profile-based, policy-based] more...
      • policy-offload-level - disable - (value 0) type: str choices: [disable, default, dos-offload, full-offload] more...
      • ssl-ssh-profile - SSL-SSH profile required for NGFW-mode policy package. type: str more...

Notes

Note

  • Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.
  • To create or update an object, use state: present directive.
  • To delete an object, use state: absent directive
  • Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded

Examples

- 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'

Return Values

Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:

  • request_url - The full url requested returned: always type: str sample: /sys/login/user
  • response_code - The status of api request returned: always type: int sample: 0
  • response_message - The descriptive message of the api response returned: always type: str sample: OK
  • response_data - The data body of the api response returned: optional type: list or dict

Status

  • This module is not guaranteed to have a backwards compatible interface.

Authors

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Frank Shen (@fshen01)
  • Hongbin Lu (@fgtdev-hblu)

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.