fortinet.fortimanager.fmgr_securityconsole_import_dev_objs 模块 – 从设备导入对象到 ADOM，或从 ADOM 导入到全局。

注意

此模块是 fortinet.fortimanager 集合 (版本 2.8.2) 的一部分。

如果您使用的是 ansible 包，则可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用： ansible-galaxy collection install fortinet.fortimanager。

要在 playbook 中使用它，请指定： fortinet.fortimanager.fmgr_securityconsole_import_dev_objs。

fortinet.fortimanager 2.0.0 中的新增功能

概要

  • 此模块能够配置 FortiManager 设备。

  • 示例包括所有需要在使用前根据数据源调整的参数和值。

参数

参数

注释

access_token

字符串

无需用户名和密码即可访问 FortiManager 的令牌。

bypass_validation

布尔值

仅当模块模式与 FortiManager API 结构不同时设置为 True，模块将继续执行而无需验证参数。

选项

  • false ← (默认)

  • true

enable_log

布尔值

启用/禁用任务日志记录。

选项

  • false ← (默认)

  • true

forticloud_access_token

字符串

使用 forticloud API 访问令牌验证 Ansible 客户端。

rc_failed

列表 / 元素=整数

将覆盖失败条件的 rc 代码列表。

rc_succeeded

列表 / 元素=整数

将覆盖成功条件的 rc 代码列表。

securityconsole_import_dev_objs

字典

设置的顶级参数。

add_mappings

字符串

在搜索阶段自动为设备添加所需的动态映射。

选项

  • "disable"

  • "enable"

adom

字符串

源 ADOM 名称。

dst_name

字符串

要导入对象的策略包的名称。

dst_parent

字符串

目标包的文件夹路径。

if_all_objs

字符串

如果所有对象。

选项

  • "none"

  • "all"

  • "filter"

if_all_policy

字符串

如果所有策略。

选项

  • "disable"

  • "enable"

import_action

字符串

do - 执行策略和对象导入。

policy_search - 预处理并扫描设备数据库以收集需要导入的策略信息。

obj_search - 预处理并扫描设备数据库以收集需要导入的对象。

选项

  • "do"

  • "policy_search"

  • "obj_search"

name

字符串

源设备名称。

position

字符串

位置。

选项

  • "bottom"

  • "top"

vdom

字符串

Vdom。

workspace_locking_adom

字符串

在工作区模式下运行 FortiManager 时要锁定的 adom，该值可以是 global 和其他值，包括 root。

workspace_locking_timeout

整数

等待其他用户释放工作区锁定的最大时间（秒）。

默认： 300

备注

注意

  • 从 2.4.0 版本开始，所有输入参数都使用下划线命名约定 (snake_case)。请将诸如“var-name”之类的参数更改为“var_name”。旧的参数名称仍然可用，但您会收到弃用警告。您可以通过在 ansible.cfg 中设置 deprecation_warnings=False 来忽略此警告。

  • 此 FortiManager 模块支持在工作区锁定模式下运行，顶级参数 workspace_locking_adom 和 workspace_locking_timeout 有助于完成这项工作。

  • 通常，当返回非零 rc 时，运行一个模块可能会失败。您还可以使用参数 rc_failed 和 rc_succeeded 来覆盖失败或成功的条件。

示例

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  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.
      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>

返回值

常见的返回值已在 此处 记录，以下是此模块特有的字段

键

描述

meta

字典

请求的结果。

返回： 始终

request_url

字符串

请求的完整 URL。

返回： 始终

示例： "/sys/login/user"

response_code

整数

API 请求的状态。

返回： 始终

示例： 0

response_data

列表 / 元素=字符串

API 响应。

返回： 始终

response_message

字符串

API 响应的描述性消息。

返回： 始终

示例： "OK."

系统信息

字典

目标系统的信息。

返回： 始终

rc

整数

请求的状态。

返回： 始终

示例： 0

版本检查警告

列表 / 元素=字符串

如果剧本中使用的参数不受当前 FortiManager 版本支持，则会发出警告。

返回： 复杂类型

作者

  • 杜欣伟 (@dux-fortinet)

  • 李星 (@lix-fortinet)

  • 薛杰 (@JieX19)

  • 郑琳 (@chillancezen)

  • 沈峰 (@fshen01)

  • 陆洪宾 (@fgtdev-hblu)