fmgr_securityconsole_import_dev_objs – Import objects from device to ADOM, or from ADOM to Global.¶
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
- securityconsole_import_dev_objs - Import objects from device to ADOM, or from ADOM to Global. type: dict
- add_mappings - Automatically add required dynamic mappings for the device during the search stages. type: str choices: [disable, enable] default: disable
- adom - Source ADOM name. type: str
- dst_name - Name of the policy package where the objects are to be imported. type: str
- dst_parent - Path to the folder for the target package. type: str
- if_all_objs - No description for the parameter type: str choices: [none, all, filter] default: none
- if_all_policy - No description for the parameter type: str choices: [disable, enable] default: disable
- import_action - do - Perform the policy and object import. type: str choices: [do, policy_search, obj_search] default: do
- name - Source device name. type: str
- position - No description for the parameter type: str choices: [bottom, top] default: top
- vdom - No description for the parameter type: str
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: Import objects from device to ADOM, or from ADOM to Global.
fmgr_securityconsole_import_dev_objs:
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, ...]
securityconsole_import_dev_objs:
add_mappings: <value in [disable, enable]>
adom: <value of string>
dst_name: <value of string>
dst_parent: <value of string>
if_all_objs: <value in [none, all, filter]>
if_all_policy: <value in [disable, enable]>
import_action: <value in [do, policy_search, obj_search]>
name: <value of string>
position: <value in [bottom, top]>
vdom: <value of string>
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