fmgr_pm_pkg¶
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.
- Tested with FortiManager v6.0.0.
Requirements¶
The below requirements are needed on the host that executes this module.
- ansible>=2.9.0
Parameters¶
- 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
- pkg_path - The parameter in requested url type: str required: true
- pm_pkg - no description type: dict
- name - No description for the parameter type: str
- obj ver - No description for the parameter type: int
- oid - No description for the parameter type: int
- package setting type: dict
- central-nat - No description for the parameter type: str choices: [disable, enable]
- consolidated-firewall-mode - No description for the parameter type: str choices: [disable, enable]
- fwpolicy-implicit-log - No description for the parameter type: str choices: [disable, enable]
- fwpolicy6-implicit-log - No description for the parameter type: str choices: [disable, enable]
- inspection-mode - No description for the parameter type: str choices: [proxy, flow]
- ngfw-mode - No description for the parameter type: str choices: [profile-based, policy-based]
- ssl-ssh-profile - No description for the parameter type: str
- scope member - No description for the parameter type: array
- name - No description for the parameter type: str
- vdom - No description for the parameter type: str
- type - No description for the parameter type: str choices: [pkg, folder]
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: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: no description
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>
pm_pkg:
name: <value of string>
obj ver: <value of integer>
oid: <value of 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: <value of string>
scope member:
-
name: <value of string>
vdom: <value of string>
type: <value in [pkg, folder]>
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