W3cubDocs

/Ansible

fortinet.fortimanager.fmgr_securityconsole_import_dev_objs module – Import objects from device to ADOM, or from ADOM to Global.

Note

This module is part of the fortinet.fortimanager collection (version 2.10.0).

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 fortinet.fortimanager 2.0.0

Synopsis

  • This module is able to configure a FortiManager device.
  • Examples include all parameters and values which need to be adjusted to data sources before usage.

Parameters

Parameter

Comments

access_token

string

The token to access FortiManager without using username and password.

bypass_validation

boolean

Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters.

Choices:

  • false ← (default)
  • true

enable_log

boolean

Enable/Disable logging for task.

Choices:

  • false ← (default)
  • true

forticloud_access_token

string

Authenticate Ansible client with forticloud API access token.

rc_failed

list / elements=integer

The rc codes list with which the conditions to fail will be overriden.

rc_succeeded

list / elements=integer

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.

Choices:

  • "disable"
  • "enable"

adom

string

Source ADOM name.

dst_name

string

Name of the policy package where the objects are to be imported.

dst_parent

string

Path to the folder for the target package.

if_all_objs

string

If all objs.

Choices:

  • "none"
  • "all"
  • "filter"

if_all_policy

string

If all policy.

Choices:

  • "disable"
  • "enable"

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.

obj_search - Preprocess and scan through device database to collect objects that are required to be imported.

Choices:

  • "do"
  • "policy_search"
  • "obj_search"

name

string

Source device name.

position

string

Position.

Choices:

  • "bottom"
  • "top"

vdom

string

Vdom.

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

The maximum time in seconds to wait for other user to release the workspace lock.

Default: 300

Notes

Note

  • Starting in version 2.4.0, all input arguments are named using the underscore naming convention (snake_case). Please change the arguments such as “var-name” to “var_name”. Old argument names are still available yet you will receive deprecation warnings. You can ignore this warning by setting deprecation_warnings=False in ansible.cfg.
  • 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.
  • 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

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  gather_facts: false
  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.
      fortinet.fortimanager.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: <string>
          # dst_name: <string>
          # dst_parent: <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: <string>
          # position: <value in [bottom, top]>
          # vdom: <string>

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

meta

dictionary

The result of the request.

Returned: always

request_url

string

The full url requested.

Returned: always

Sample: "/sys/login/user"

response_code

integer

The status of api request.

Returned: always

Sample: 0

response_data

list / elements=string

The api response.

Returned: always

response_message

string

The descriptive message of the api response.

Returned: always

Sample: "OK."

system_information

dictionary

The information of the target system.

Returned: always

rc

integer

The status the request.

Returned: always

Sample: 0

version_check_warning

list / elements=string

Warning if the parameters used in the playbook are not supported by the current FortiManager version.

Returned: complex

Authors

  • Xinwei Du (@dux-fortinet)
  • Xing Li (@lix-fortinet)
  • Jie Xue (@JieX19)
  • Link Zheng (@chillancezen)
  • Frank Shen (@fshen01)
  • Hongbin Lu (@fgtdev-hblu)

© 2012–2018 Michael DeHaan
© 2018–2025 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