fmgr_pm_pkg_adom_obj¶
New in version 2.10.
Synopsis¶
- This module is able to configure a FortiManager device by allowing the user to [add, get, set, update] the following FortiManager json-rpc urls.
- /pm/pkg/adom/{adom}
- 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.10.0
Parameters¶
- loose_validation - Do parameter validation in a loose way 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 dom
- workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock type: integer required: false default: 300
- url_params - parameters in url path type: dict required: true
- adom - the domain prefix type: str choices: none, global, custom dom
- parameters for method: [add, set, update] -
- data - No description for the parameter type: array
- 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
- 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]
- parameters for method: [get] -
- fields - No description for the parameter type: array
- {no-name} - No description for the parameter type: array
- {no-name} - No description for the parameter type: str choices: [name, obj ver, oid, scope member, type]
- {no-name} - No description for the parameter type: array
Notes¶
Note
- The module may supports multiple method, every method has different parameters definition
- One method may also have more than one parameter definition collection, each collection is dedicated to one API endpoint
- The module may include domain dependent urls, the domain can be specified in url_params as adom
- To run in workspace mode, the paremeter workspace_locking_adom must be included in the task
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: REQUESTING /PM/PKG/ADOM/{ADOM}
fmgr_pm_pkg_adom_obj:
loose_validation: False
workspace_locking_adom: <value in [global, custom adom]>
workspace_locking_timeout: 300
method: <value in [add, set, update]>
url_params:
adom: <value in [none, global, custom dom]>
params:
-
data:
-
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]>
- name: REQUESTING /PM/PKG/ADOM/{ADOM}
fmgr_pm_pkg_adom_obj:
loose_validation: False
workspace_locking_adom: <value in [global, custom adom]>
workspace_locking_timeout: 300
method: <value in [get]>
url_params:
adom: <value in [none, global, custom dom]>
params:
-
fields:
-
- <value in [name, obj ver, oid, ...]>
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:
- return values for method: [add, set, update]
- status
- No description for the parameter type: dict
- code - No description for the parameter type: int
- message - No description for the parameter type: str
- url - No description for the parameter type: str example: /pm/pkg/adom/{adom}
- return values for method: [get]
- data
- No description for the parameter type: array
- 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
- central-nat - No description for the parameter type: str
- consolidated-firewall-mode - No description for the parameter type: str
- fwpolicy-implicit-log - No description for the parameter type: str
- fwpolicy6-implicit-log - No description for the parameter type: str
- inspection-mode - No description for the parameter type: str
- ngfw-mode - No description for the parameter type: str
- 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
- status
- No description for the parameter type: dict
- code - No description for the parameter type: int
- message - No description for the parameter type: str
- url - No description for the parameter type: str example: /pm/pkg/adom/{adom}