fortinet.fortimanager.fmgr_fmg_device_blueprint 模块 – FMG 设备蓝图

注意

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

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

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

要在剧本中使用它，请指定： fortinet.fortimanager.fmgr_fmg_device_blueprint。

fortinet.fortimanager 2.1.0 中的新增功能

概要

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

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

参数

参数

注释

access_token

字符串

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

adom

字符串 / 必需

请求 URL 中的参数 (adom)。

bypass_validation

布尔值

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

选项

  • false ← (默认)

  • true

enable_log

布尔值

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

选项

  • false ← (默认)

  • true

fmg_device_blueprint

字典

设置的顶级参数。

auth_template

别名：auth-template

任意

(列表) 身份验证模板。

cliprofs

任意

(列表) CLI 配置文件。

description

字符串

描述。

dev_group

别名：dev-group

任意

(列表) 设备组。

enforce_device_config

别名：enforce-device-config

字符串

强制设备配置。

选项

  • "disable"

  • "enable"

folder

字符串

文件夹。

ha_config

别名：ha-config

字符串

高可用性配置。

选项

  • "disable"

  • "enable"

ha_hbdev

别名：ha-hbdev

字符串

高可用性心跳设备。

ha_monitor

别名：ha-monitor

任意

(列表) 高可用性监控。

ha_password

别名：ha-password

任意

(列表) 高可用性密码。

linked_to_model

别名：linked-to-model

字符串

链接到模型。

选项

  • "disable"

  • "enable"

name

字符串 / 必需

名称。

pkg

字符串

软件包。

platform

字符串

平台。

port_provisioning

别名：port-provisioning

整数

端口配置。

prefer_img_ver

别名：prefer-img-ver

字符串

首选镜像版本。

prerun_cliprof

别名：prerun-cliprof

任意

(列表) 预运行 CLI 配置文件。

prov_type

别名：prov-type

字符串

配置类型。

选项

  • "none"

  • "templates"

  • "template-group"

sdwan_management

别名：sdwan-management

字符串

SD-WAN 管理。

选项

  • "disable"

  • "enable"

split_switch_port

别名：split-switch-port

字符串

拆分交换机端口。

选项

  • "disable"

  • "enable"

template_group

别名：template-group

字符串

模板组。

templates

任意

(列表) 模板。

forticloud_access_token

字符串

使用 FortiCloud API 访问令牌对 Ansible 客户端进行身份验证。

proposed_method

字符串

底层 Json RPC 请求的覆盖方法。

选项

  • "update"

  • "set"

  • "add"

rc_failed

列表 / 元素=整数

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

rc_succeeded

列表 / 元素=整数

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

state

字符串 / 必需

创建、更新或删除对象的指令。

选项

  • "present"

  • "absent"

workspace_locking_adom

字符串

在工作区模式下运行 FortiManager 时要锁定的 ADOM，该值可以是全局的和其他值，包括 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 用于执行此操作。

  • 要创建或更新对象，请使用 state present 指令。

  • 要删除对象，请使用 state absent 指令。

  • 通常，当返回非零 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: Fmg device blueprint
      fortinet.fortimanager.fmgr_fmg_device_blueprint:
        # 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, ...]
        adom: <your own value>
        state: present # <value in [present, absent]>
        fmg_device_blueprint:
          cliprofs: <list or string>
          description: <string>
          dev_group: <list or string>
          folder: <string>
          name: <string>
          pkg: <string>
          platform: <string>
          prefer_img_ver: <string>
          prerun_cliprof: <list or string>
          prov_type: <value in [none, templates, template-group]>
          template_group: <string>
          templates: <list or string>
          enforce_device_config: <value in [disable, enable]>
          auth_template: <list or string>
          ha_config: <value in [disable, enable]>
          ha_hbdev: <string>
          ha_monitor: <list or string>
          ha_password: <list or string>
          linked_to_model: <value in [disable, enable]>
          port_provisioning: <integer>
          sdwan_management: <value in [disable, enable]>
          split_switch_port: <value in [disable, enable]>

返回值

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

键

描述

meta

字典

请求的结果。

返回值：始终返回

request_url

字符串

请求的完整 URL。

返回值：始终返回

示例： "/sys/login/user"

response_code

整数

API 请求的状态。

返回值：始终返回

示例： 0

response_data

列表 / 元素=字符串

API 响应。

返回值：始终返回

response_message

字符串

API 响应的描述性消息。

返回值：始终返回

示例： "OK."

system_information

字典

目标系统的信息。

返回值：始终返回

rc

整数

请求的状态。

返回值：始终返回

示例： 0

version_check_warning

列表 / 元素=字符串

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

返回值：复杂类型

作者

  • 杜欣伟 (@dux-fortinet)

  • 李兴 (@lix-fortinet)

  • 薛杰 (@JieX19)

  • 郑凌 (@chillancezen)

  • 沈芳 (@fshen01)

  • 陆洪斌 (@fgtdev-hblu)