fortinet.fortimanager.fmgr_pm_config_metafields_firewall_addrgrp 模块 – 元字段防火墙地址组

注意

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

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

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

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

在 fortinet.fortimanager 2.1.0 中新增

概要

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

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

参数

参数

注释

access_token

字符串

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

bypass_validation

布尔值

仅当模块架构与 FortiManager API 结构存在差异时才设置为 True，模块将继续执行而不验证参数。

选择

  • false ← （默认）

  • true

enable_log

布尔值

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

选择

  • false ← （默认）

  • true

forticloud_access_token

字符串

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

pm_config_metafields_firewall_addrgrp

字典

设置的顶级参数。

importance

字符串

重要性。

选择

  • "可选"

  • "必需"

length

整数

长度。

name

字符串

名称。

proposed_method

字符串

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

选择

  • "更新"

  • "设置"

  • "添加"

rc_failed

列表 / 元素=整数

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

rc_succeeded

列表 / 元素=整数

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

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 有助于完成这项工作。

  • 通常，当返回非零 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: Meta fields firewall addrgrp
      fortinet.fortimanager.fmgr_pm_config_metafields_firewall_addrgrp:
        # 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, ...]
        pm_config_metafields_firewall_addrgrp:
          importance: <value in [optional, required]>
          length: <integer>
          name: <string>

返回值

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

键

描述

元数据

字典

请求的结果。

已返回：始终

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 版本不支持剧本中使用的参数，则会发出警告。

已返回：复杂

作者

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)