Try SpotterPolicy package or folder.
| "added in version" 2.0.0 of fortinet.fortimanager"
Authors: Xinwei Du (@dux-fortinet), Xing Li (@lix-fortinet), Jie Xue (@JieX19), Link Zheng (@chillancezen), Frank Shen (@fshen01), Hongbin Lu (@fgtdev-hblu)
preview | supported by community
Install with ansible-galaxy collection install fortinet.fortimanager:==2.4.0
collections:
- name: fortinet.fortimanager
version: 2.4.0This module is able to configure a FortiManager device.
Examples include all parameters and values which need to be adjusted to data sources before usage.
- 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: Policy package or folder.
fortinet.fortimanager.fmgr_pm_pkg:
# 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, ...]
adom: <your own value>
pkg_path: <your own value>
state: present # <value in [present, absent]>
pm_pkg:
name: <string>
obj_ver: <integer>
oid: <integer>
package_setting:
central_nat: <value in [disable, enable]>
consolidated_firewall_mode: <value in [disable, enable]>
fwpolicy_implicit_log: <value in [disable, enable]>
fwpolicy6_implicit_log: <value in [disable, enable]>
inspection_mode: <value in [proxy, flow]>
ngfw_mode: <value in [profile-based, policy-based]>
ssl_ssh_profile: <string>
scope_member:
-
name: <string>
vdom: <string>
type: <value in [pkg, folder]>
package_settings:
central_nat: <value in [disable, enable]>
consolidated_firewall_mode: <value in [disable, enable]>
fwpolicy_implicit_log: <value in [disable, enable]>
fwpolicy6_implicit_log: <value in [disable, enable]>
inspection_mode: <value in [proxy, flow]>
ngfw_mode: <value in [profile-based, policy-based]>
policy_offload_level: <value in [disable, default, dos-offload, ...]>
ssl_ssh_profile: <string>
adom:
description: The parameter (adom) in requested url.
required: true
type: str
state:
choices:
- present
- absent
description: The directive to create, update or delete an object.
required: true
type: str
pm_pkg:
description: The top level parameters set.
required: false
suboptions:
name:
description: No description.
required: true
type: str
obj ver:
description: Deprecated, please rename it to obj_ver.
type: int
oid:
description: No description.
type: int
package setting:
description: Deprecated, please rename it to package_setting.
suboptions:
central-nat:
choices:
- disable
- enable
description: Deprecated, please rename it to central_nat.
type: str
consolidated-firewall-mode:
choices:
- disable
- enable
description: Deprecated, please rename it to consolidated_firewall_mode.
type: str
fwpolicy-implicit-log:
choices:
- disable
- enable
description: Deprecated, please rename it to fwpolicy_implicit_log.
type: str
fwpolicy6-implicit-log:
choices:
- disable
- enable
description: Deprecated, please rename it to fwpolicy6_implicit_log.
type: str
inspection-mode:
choices:
- proxy
- flow
description: Deprecated, please rename it to inspection_mode.
type: str
ngfw-mode:
choices:
- profile-based
- policy-based
description: Deprecated, please rename it to ngfw_mode.
type: str
ssl-ssh-profile:
description: Deprecated, please rename it to ssl_ssh_profile.
type: str
type: dict
package settings:
description: Deprecated, please rename it to package_settings.
suboptions:
central-nat:
choices:
- disable
- enable
description:
- Deprecated, please rename it to central_nat.
- disable -
- enable -
type: str
consolidated-firewall-mode:
choices:
- disable
- enable
description:
- Deprecated, please rename it to consolidated_firewall_mode.
- For flow-based policy package.
- disable -
- enable -
type: str
fwpolicy-implicit-log:
choices:
- disable
- enable
description:
- Deprecated, please rename it to fwpolicy_implicit_log.
- disable -
- enable -
type: str
fwpolicy6-implicit-log:
choices:
- disable
- enable
description:
- Deprecated, please rename it to fwpolicy6_implicit_log.
- disable -
- enable -
type: str
inspection-mode:
choices:
- proxy
- flow
description:
- Deprecated, please rename it to inspection_mode.
- proxy -
- flow -
type: str
ngfw-mode:
choices:
- profile-based
- policy-based
description:
- Deprecated, please rename it to ngfw_mode.
- For flow-based policy package.
- profile-based -
- policy-based -
type: str
policy-offload-level:
choices:
- disable
- default
- dos-offload
- full-offload
description:
- Deprecated, please rename it to policy_offload_level.
- disable -
- default -
- dos-offload -
- full-offload -
type: str
ssl-ssh-profile:
description: Deprecated, please rename it to ssl_ssh_profile. SSL-SSH profile
required for NGFW-mode policy package.
type: str
type: dict
scope member:
description: Deprecated, please rename it to scope_member.
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
pkg_path:
description: The parameter (pkg_path) in requested url.
required: true
type: str
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
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
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