fortinet.fortimanager.fmgr_firewall_shapingprofile_shapingentries 模块 – 定义此整形配置文件的整形条目。

注意

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

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

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

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

fortinet.fortimanager 2.0.0 中的新功能

概要 

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

参数 

参数	注释
access_token 字符串	用于访问 FortiManager 而无需使用用户名和密码的令牌。
adom 字符串 / 必需	请求 URL 中的参数 (adom)。
bypass_validation 布尔值	仅当模块模式与 FortiManager API 结构不同时才设置为 True，模块将继续执行而不验证参数。选择 `false` ← (默认) `true`
enable_log 布尔值	启用/禁用任务日志记录。选择 `false` ← (默认) `true`
firewall_shapingprofile_shapingentries 字典	设置的顶级参数。
burst_in_msec 别名：burst-in-msec 整数	可以以最大带宽速度突发的字节数。
cburst_in_msec 别名：cburst-in-msec 整数	可以以接口可以传输的速度突发的字节数。
class_id 别名：class-id 任意	（整数或字符串）类 ID。
guaranteed_bandwidth_percentage 别名：guaranteed-bandwidth-percentage 整数	保证的带宽百分比。
id 整数 / 必需	ID 号。
limit 整数	数据包中实际队列大小的硬限制。
max 整数	RED 丢弃概率最大的数据包的平均队列大小。
maximum_bandwidth_percentage 别名：maximum-bandwidth-percentage 整数	最大带宽百分比。
min 整数	RED 丢弃成为可能的数据包的平均队列大小。
priority 字符串	优先级。选择 `"low"` `"medium"` `"high"` `"critical"` `"top"`
red_probability 别名：red-probability 整数	最大概率
forticloud_access_token 字符串	使用 forticloud API 访问令牌验证 Ansible 客户端。
proposed_method 字符串	覆盖底层 Json RPC 请求的方法。选择 `"update"` `"set"` `"add"`
rc_failed 列表 / elements=整数	将覆盖失败条件的 rc 代码列表。
rc_succeeded 列表 / elements=整数	将覆盖成功条件的 rc 代码列表。
shaping-profile 字符串	已弃用，请使用“shaping_profile”
shaping_profile 字符串	请求 URL 中的参数 (shaping-profile)。
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: Define shaping entries of this shaping profile.
      fortinet.fortimanager.fmgr_firewall_shapingprofile_shapingentries:
        bypass_validation: false
        adom: ansible
        shaping-profile: "ansible-test" # profile-name
        state: present
        firewall_shapingprofile_shapingentries:
          guaranteed-bandwidth-percentage: 50
          id: 1
          maximum-bandwidth-percentage: 70
          priority: medium # <value in [low, medium, high]>

- 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 shaping entries of this shaping profile
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "firewall_shapingprofile_shapingentries"
          params:
            adom: "ansible"
            shaping-profile: "ansible-test" # profile-name
            shaping-entries: "your_value"

返回值 

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

键	描述
元数据字典	请求的结果。返回：总是
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)