fortinet.fortimanager.fmgr_firewall_carrierendpointbwl_entries 模块 – 运营商端点黑/白名单。

注意

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

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

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

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

fortinet.fortimanager 2.0.0 中的新增功能

概要 

此模块能够配置 FortiManager 设备。
示例包括所有需要在使用前调整为数据源的参数和值。

参数 

参数	注释
access_token 字符串	在不使用用户名和密码的情况下访问 FortiManager 的令牌。
adom 字符串 / 必需	请求的 URL 中的参数 (adom)。
bypass_validation 布尔值	仅当模块架构与 FortiManager API 结构存在差异时才设置为 True，模块将继续执行而不验证参数。选项 `false` ←（默认） `true`
carrier-endpoint-bwl 字符串	已弃用，请使用“carrier_endpoint_bwl”
carrier_endpoint_bwl 字符串	请求的 URL 中的参数 (carrier-endpoint-bwl)。
enable_log 布尔值	启用/禁用任务的日志记录。选项 `false` ←（默认） `true`
firewall_carrierendpointbwl_entries 字典	设置的顶层参数。
action 列表 / elements=字符串	在此端点上执行的操作选项 `“block”` `“exempt”` `“exempt-mass-mms”`
carrier_endpoint 别名：carrier-endpoint 字符串 / 必需	要对其执行操作的端点。
log_action 别名：log-action 列表 / elements=字符串	在此端点上执行的操作选项 `“archive”` `“intercept”`
pattern_type 别名：pattern-type 字符串	通配符模式或正则表达式。选项 `“wildcard”` `“regexp”` `“simple”`
status 字符串	启用/禁用指定操作选项 `“disable”` `“enable”`
forticloud_access_token 字符串	使用 forticloud API 访问令牌验证 Ansible 客户端。
proposed_method 字符串	用于底层 Json RPC 请求的重写方法。选项 `“update”` `“set”` `“add”`
rc_failed 列表 / elements=整数	将覆盖失败条件的 rc 代码列表。
rc_succeeded 列表 / elements=整数	将覆盖成功条件的 rc 代码列表。
state 字符串 / 必需	创建、更新或删除对象的指令。选项 `“present”` `“absent”`
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 有助于完成此工作。
要创建或更新对象，请使用 state present 指令。
要删除对象，请使用 state absent 指令。
通常，当返回非零 rc 时，运行一个模块可能会失败。您还可以使用参数 rc_failed 和 rc_succeeded 来覆盖失败或成功的条件。

示例 

- name: Example playbook
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Carrier end point black/white list.
      fortinet.fortimanager.fmgr_firewall_carrierendpointbwl_entries:
        bypass_validation: false
        adom: FortiCarrier # This is FOC-only object, need a FortiCarrier adom
        carrier-endpoint-bwl: "1" # id
        state: present
        firewall_carrierendpointbwl_entries:
          action:
            - block
            - exempt
            - exempt-mass-mms
          carrier-endpoint: "string"
          log-action:
            - archive
            - intercept
          pattern-type: wildcard # <value in [wildcard, regexp, simple]>
          status: enable

- name: Gathering fortimanager facts
  hosts: fortimanagers
  gather_facts: false
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Retrieve all the carrier endpoint black/white list table
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "firewall_carrierendpointbwl_entries"
          params:
            adom: "FortiCarrier" # This is FOC-only object, need a FortiCarrier adom
            carrier-endpoint-bwl: "1" # id
            entries: "your_value"

返回值 

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

键	描述
元数据字典	请求的结果。已返回：总是
request_url 字符串	请求的完整 URL。已返回：总是示例： `"/sys/login/user"`
response_code 整数	API 请求的状态。已返回：总是示例： `0`
response_data 列表 / elements=字符串	API 响应。已返回：总是
response_message 字符串	API 响应的描述性消息。已返回：总是示例： `"OK."`
system_information 字典	目标系统的信息。已返回：总是
rc 整数	请求的状态。已返回：总是示例： `0`
version_check_warning 列表 / elements=字符串	如果剧本中使用的参数不受当前 FortiManager 版本支持，则发出警告。已返回：复杂

作者

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