fortinet.fortimanager.fmgr_pkg_header_shapingpolicy 模块 – 配置整形策略。

注意

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

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

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

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

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 客户端。

pkg

字符串 / 必需

请求 URL 中的参数 (pkg)。

pkg_header_shapingpolicy

字典

设置的顶级参数。

app_category

别名：app-category

任意

(列表或字符串) 应用类别。

app_group

别名：app-group

任意

(列表或字符串) 应用组。

application

任意

(列表) 应用。

class_id

别名：class-id

任意

(整数或字符串) 类 ID。

class_id_reverse

别名：class-id-reverse

整数

反向类 ID。

comment

字符串

注释。

cos

字符串

VLAN CoS 位模式。

cos_mask

别名：cos-mask

字符串

VLAN CoS 评估位。

diffserv_forward

别名：diffserv-forward

字符串

Diffserv 正向。

选项

  • "disable"

  • "enable"

diffserv_reverse

别名：diffserv-reverse

字符串

Diffserv 反向。

选项

  • "disable"

  • "enable"

diffservcode_forward

别名：diffservcode-forward

字符串

Diffservcode 正向。

diffservcode_rev

别名：diffservcode-rev

字符串

Diffservcode 反向。

dstaddr

任意

(列表或字符串) 目的地址。

dstaddr6

任意

(列表或字符串) 目的IPv6地址。

dstintf

任意

(列表或字符串) 目的接口。

groups

任意

(列表或字符串) 组。

id

整数 / 必需

ID。

internet_service

别名：internet-service

字符串

互联网服务。

选项

  • "disable"

  • "enable"

internet_service_custom

别名：internet-service-custom

任意

(列表或字符串) 自定义互联网服务。

internet_service_custom_group

别名：internet-service-custom-group

任意

(列表或字符串) 自定义互联网服务组。

internet_service_group

别名：internet-service-group

任意

(列表或字符串) 互联网服务组。

internet_service_id

别名：internet-service-id

任意

(列表或字符串) 互联网服务 ID。

internet_service_name

别名：internet-service-name

任意

(列表或字符串) 互联网服务名称。

internet_service_src

别名：internet-service-src

字符串

源互联网服务。

选项

  • "disable"

  • "enable"

internet_service_src_custom

别名：internet-service-src-custom

任意

(列表或字符串) 自定义源互联网服务。

internet_service_src_custom_group

别名：internet-service-src-custom-group

任意

(列表或字符串) 自定义源互联网服务组。

internet_service_src_group

别名：internet-service-src-group

任意

(列表或字符串) 源互联网服务组。

internet_service_src_id

别名：internet-service-src-id

任意

(列表或字符串) 源互联网服务 ID。

internet_service_src_name

别名：internet-service-src-name

任意

(列表或字符串) 源互联网服务名称。

ip_version

别名：ip-version

字符串

IP 版本。

选项

  • "4"

  • "6"

per_ip_shaper

别名: per-ip-shaper

字符串

每个 IP 的整形器。

schedule

字符串

调度。

service

任意

(列表或字符串) 服务。

service_type

别名: service-type

字符串

服务类型。

选项

  • "service"

  • "internet-service"

srcaddr

任意

(列表或字符串) 源地址。

srcaddr6

任意

(列表或字符串) 源IPv6地址。

srcintf

任意

(列表或字符串) 源接口。

status

字符串

状态。

选项

  • "disable"

  • "enable"

tos

字符串

TOS。

tos_mask

别名: tos-mask

字符串

TOS掩码。

tos_negate

别名: tos-negate

字符串

TOS取反。

选项

  • "disable"

  • "enable"

traffic_shaper

别名: traffic-shaper

字符串

流量整形器。

traffic_shaper_reverse

别名: traffic-shaper-reverse

字符串

反向流量整形器。

traffic_type

别名: traffic-type

字符串

流量类型。

选项

  • "forwarding"

  • "local-in"

  • "local-out"

url_category

别名: url-category

任意

(列表或字符串) URL 分类。

users

任意

(列表或字符串) 用户。

uuid

字符串

UUID。

uuid_idx

别名: uuid-idx

整数

UUID 索引。

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: Configure shaping policies.
      fortinet.fortimanager.fmgr_pkg_header_shapingpolicy:
        # 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, ...]
        pkg: <your own value>
        state: present # <value in [present, absent]>
        pkg_header_shapingpolicy:
          app_category: <list or string>
          app_group: <list or string>
          application: <list or integer>
          class_id: <integer or string>
          comment: <string>
          diffserv_forward: <value in [disable, enable]>
          diffserv_reverse: <value in [disable, enable]>
          diffservcode_forward: <string>
          diffservcode_rev: <string>
          dstaddr: <list or string>
          dstaddr6: <list or string>
          dstintf: <list or string>
          groups: <list or string>
          id: <integer>
          internet_service: <value in [disable, enable]>
          internet_service_custom: <list or string>
          internet_service_custom_group: <list or string>
          internet_service_group: <list or string>
          internet_service_id: <list or string>
          internet_service_src: <value in [disable, enable]>
          internet_service_src_custom: <list or string>
          internet_service_src_custom_group: <list or string>
          internet_service_src_group: <list or string>
          internet_service_src_id: <list or string>
          ip_version: <value in [4, 6]>
          per_ip_shaper: <string>
          schedule: <string>
          service: <list or string>
          srcaddr: <list or string>
          srcaddr6: <list or string>
          srcintf: <list or string>
          status: <value in [disable, enable]>
          tos: <string>
          tos_mask: <string>
          tos_negate: <value in [disable, enable]>
          traffic_shaper: <string>
          traffic_shaper_reverse: <string>
          url_category: <list or string>
          users: <list or string>
          uuid: <string>
          internet_service_name: <list or string>
          internet_service_src_name: <list or string>
          class_id_reverse: <integer>
          service_type: <value in [service, internet-service]>
          uuid_idx: <integer>
          cos: <string>
          cos_mask: <string>
          traffic_type: <value in [forwarding, local-in, local-out]>

返回值

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

键

描述

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)