Note
This plugin is part of the fortinet.fortimanager collection (version 2.1.3).
You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install fortinet.fortimanager.
To use it in a playbook, specify: fortinet.fortimanager.fmgr_securityconsole_import_dev_objs.
New in version 2.10: of fortinet.fortimanager
| Parameter | Choices/Defaults | Comments | |
|---|---|---|---|
| bypass_validation boolean |
| only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters | |
| enable_log boolean |
| Enable/Disable logging for task | |
| rc_failed list / elements=string | the rc codes list with which the conditions to fail will be overriden | ||
| rc_succeeded list / elements=string | the rc codes list with which the conditions to succeed will be overriden | ||
| securityconsole_import_dev_objs dictionary | the top level parameters set | ||
| add_mappings string |
| Automatically add required dynamic mappings for the device during the search stages.<br/>When used in policy_search action, ad... | |
| adom string | Source ADOM name. | ||
| dst_name string | Name of the policy package where the objects are to be imported. If the package does not already exist in the database, a new ... | ||
| dst_parent string | Path to the folder for the target package. If the package is to be placed in root, leave this field blank. | ||
| if_all_objs string |
| no description | |
| if_all_policy string |
| no description | |
| import_action string |
| do - Perform the policy and object import. policy_search - Preprocess and scan through device database to gather information about policies that need to be imported. Can automatic... obj_search - Preprocess and scan through device database to collect objects that are required to be imported. Can automatically add obje... | |
| name string | Source device name. | ||
| position string |
| no description | |
| vdom string | no description | ||
| workspace_locking_adom string | the adom to lock for FortiManager running in workspace mode, the value can be global and others including root | ||
| workspace_locking_timeout integer | Default: 300 | the maximum time in seconds to wait for other user to release the workspace lock | |
Note
- 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>
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
| request_url string | always | The full url requested Sample: /sys/login/user |
| response_code integer | always | The status of api request |
| response_message string | always | The descriptive message of the api response Sample: OK. |
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortimanager/fmgr_securityconsole_import_dev_objs_module.html