cisco.aci.aci_qos_dot1p_class 模块 – 管理 QoS Dot1P 类 (qos:Dot1PClass)

注意

此模块是 cisco.aci 集合（版本 2.10.1）的一部分。

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

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

要在 playbook 中使用它，请指定：cisco.aci.aci_qos_dot1p_class。

概要 

管理 Cisco ACI 交换矩阵上 QoS 自定义策略的 Dot1P 类级别。
Dot1P 的类级别，用于确定映射的优先级。

参数 

参数	注释
annotation 字符串	用户定义的字符串，用于注释对象。如果任务中未指定值，则将改用环境变量 `ACI_ANNOTATION` 的值。如果任务中未指定值，并且环境变量 `ACI_ANNOTATION` 也未指定，则将使用默认值。默认值： `"orchestrator:ansible"`
certificate_name 别名：cert_name 字符串	附加到用于基于签名的身份验证的 APIC AAA 用户的 X.509 证书名称。如果提供了 `private_key` 文件名，则此项默认设置为 `private_key` 的基本名称，不带扩展名。如果为 `private_key` 提供了 PEM 格式的内容，则此项默认设置为 `username` 值。如果任务中未指定值，则将改用环境变量 `ACI_CERTIFICATE_NAME` 的值。
dot1p_from 字符串	Dot1P 范围起始值。选择 `"background"` `"best_effort"` `"excellent_effort"` `"critical_applications"` `"video"` `"voice"` `"internetwork_control"` `"network_control"` `"unspecified"`
dot1p_target 别名：target 字符串	Dot1P 目标值。在创建过程中未设置时，APIC 默认为 `unspecified`。选择 `"AF11"` `"AF12"` `"AF13"` `"AF21"` `"AF22"` `"AF23"` `"AF31"` `"AF32"` `"AF33"` `"AF41"` `"AF42"` `"AF43"` `"CS0"` `"CS1"` `"CS2"` `"CS3"` `"CS4"` `"CS5"` `"CS6"` `"CS7"` `"EF"` `"VA"` `"unspecified"`
dot1p_to 字符串	Dot1P 范围结束值。选择 `"background"` `"best_effort"` `"excellent_effort"` `"critical_applications"` `"video"` `"voice"` `"internetwork_control"` `"network_control"` `"unspecified"`
host 别名：hostname 字符串	Ansible 控制主机可解析的 APIC 的 IP 地址或主机名。如果任务中未指定值，则将改用环境变量 `ACI_HOST` 的值。
output_level 字符串	影响此 ACI 模块的输出。 `normal` 表示标准输出，包括 `current` 字典 `info` 添加信息性输出，包括 `previous`、`proposed` 和 `sent` 字典 `debug` 添加调试输出，包括 `filter_string`、`method`、`response`、`status` 和 `url` 信息如果任务中未指定值，则将改用环境变量 `ACI_OUTPUT_LEVEL` 的值。选择 `"debug"` `"info"` `"normal"` ←（默认）
output_path 字符串	用于转储模块生成的 ACI JSON 配置对象的文件路径。如果任务中未指定值，则将改用环境变量 `ACI_OUTPUT_PATH` 的值。
owner_key 字符串	用户定义的字符串，用于 ACI 对象的 ownerKey 属性。此属性表示一个键，用于使客户端能够拥有其用于实体关联的数据。如果任务中未指定值，则将改用环境变量 `ACI_OWNER_KEY` 的值。
owner_tag 字符串	用户定义的字符串，用于 ACI 对象的 ownerTag 属性。此属性表示一个标签，允许客户端添加自己的数据。例如，指示谁创建了这个对象。如果任务中未指定该值，则将使用环境变量 `ACI_OWNER_TAG` 的值。
密码字符串	用于身份验证的密码。此选项与 `private_key` 互斥。如果也提供了 `private_key`，则将使用它。如果任务中未指定该值，则将使用环境变量 `ACI_PASSWORD` 或 `ANSIBLE_NET_PASSWORD` 的值。
端口整数	用于 REST 连接的端口号。默认值取决于参数 `use_ssl`。如果任务中未指定该值，则将使用环境变量 `ACI_PORT` 的值。
优先级别名: prio 字符串	要使用的所需 QoS 类级别。在创建过程中未设置时，APIC 默认为 `unspecified`。选择 `"level1"` `"level2"` `"level3"` `"level4"` `"level5"` `"level6"` `"unspecified"`
私钥别名: cert_key 字符串	用于基于签名的身份验证的 PEM 格式的私钥文件或私钥内容。此值还会影响使用的默认 `certificate_name`。此选项与 `password` 互斥。如果也提供了 `password`，则将被忽略。如果任务中未指定该值，则将使用环境变量 `ACI_PRIVATE_KEY` 或 `ANSIBLE_NET_SSH_KEYFILE` 的值。
QoS 自定义策略别名: qos_custom_policy_name 字符串	QoS 自定义策略的名称。
状态字符串	使用 `present` 或 `absent` 来添加或删除。使用 `query` 来列出一个对象或多个对象。选择 `"absent"` `"present"` ← (默认) `"query"`
抑制先前状态别名: no_previous, ignore_previous 布尔值	如果为 `true`，则在向 APIC 发送 POST 更新之前，不会发送 GET 请求来检查先前状态。如果任务中未指定该值，则将使用环境变量 `ACI_SUPPRESS_PREVIOUS` 的值。默认值为 `false`。警告 - 这会导致之前的返回值为空。将不会检查对象的先前状态，并且 POST 更新将包含所有属性。选择 `false` `true`
抑制验证别名: no_verification, no_verify, suppress_verify, ignore_verify, ignore_verification 布尔值	如果为 `true`，则在向 APIC 发送 POST 更新后，不会发送验证 GET 请求。如果任务中未指定该值，则将使用环境变量 `ACI_SUPPRESS_VERIFICATION` 的值。默认值为 `false`。警告 - 这会导致当前返回值设置为建议值。在单个任务中，包括默认值的当前对象将无法验证。选择 `false` `true`
目标 COS 字符串	要基于进入网络的 Dot1P 输入值范围驱动的目标 COS。在创建过程中未设置时，APIC 默认为 `unspecified`。选择 `"background"` `"best_effort"` `"excellent_effort"` `"critical_applications"` `"video"` `"voice"` `"internetwork_control"` `"network_control"` `"unspecified"`
租户别名: tenant_name 字符串	现有租户的名称。
超时整数	套接字级别的超时时间（秒）。如果任务中未指定该值，则将使用环境变量 `ACI_TIMEOUT` 的值。默认值为 30。
使用代理布尔值	如果为 `false`，则即使目标主机上的环境变量中定义了代理，也不会使用代理。如果任务中未指定该值，则将使用环境变量 `ACI_USE_PROXY` 的值。默认值为 true。选择 `false` `true`
使用 SSL 布尔值	如果为 `false`，则将使用 HTTP 连接而不是默认的 HTTPS 连接。如果任务中未指定该值，则将使用环境变量 `ACI_USE_SSL` 的值。当连接为本地连接时，默认值为 true。选择 `false` `true`
用户名别名: user 字符串	用于身份验证的用户名。如果任务中未指定该值，则将使用环境变量 `ACI_USERNAME` 或 `ANSIBLE_NET_USERNAME` 的值。默认值为 admin。
验证证书布尔值	如果为 `false`，则不会验证 SSL 证书。只有在使用自签名证书的个人控制站点时，才应将其设置为 `false`。如果任务中未指定该值，则将使用环境变量 `ACI_VALIDATE_CERTS` 的值。默认值为 true。选择 `false` `true`

注释 

注意

在使用此模块之前，您的剧本中必须存在租户和 qos_custom_policy。可以使用 cisco.aci.aci_tenant 和 cisco.aci.aci_qos_custom_policy 来实现此目的。

另请参阅 

另请参阅

cisco.aci.aci_tenant: 管理租户 (fv:Tenant)。
cisco.aci.aci_qos_custom_policy: 管理 QoS 自定义策略 (qos:CustomPol)。
APIC 管理信息模型参考: 有关内部 APIC 类 qos:Dot1PClass 的更多信息。
Cisco ACI 指南: 有关如何使用 Ansible 管理 ACI 基础架构的详细信息。
开发 Cisco ACI 模块: 有关如何编写您自己的 Cisco ACI 模块以进行贡献的详细指南。

示例 

- name: Add a new QoS dot1P Class
  cisco.aci.aci_qos_dot1p_class:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: my_tenant
    qos_custom_policy: my_qos_custom_policy
    priority: level3
    dot1p_from: best_effort
    dot1p_to: excellent_effort
    dot1p_target: unspecified
    target_cos: unspecified
    state: present
  delegate_to: localhost

- name: Query a QoS dot1P Class
  cisco.aci.aci_qos_dot1p_class:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: my_tenant
    qos_custom_policy: my_qos_custom_policy
    dot1p_from: best_effort
    dot1p_to: excellent_effort
    state: query
  delegate_to: localhost

- name: Query all QoS dot1P Classes in my_qos_custom_policy
  cisco.aci.aci_qos_dot1p_class:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: my_tenant
    qos_custom_policy: my_qos_custom_policy
    state: query
  delegate_to: localhost

- name: Query all QoS dot1P Classes
  cisco.aci.aci_qos_dot1p_class:
    host: apic
    username: admin
    password: SomeSecretPassword
    state: query
  delegate_to: localhost

- name: Delete a QoS dot1P Class
  cisco.aci.aci_qos_dot1p_class:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: my_tenant
    qos_custom_policy: my_qos_custom_policy
    dot1p_from: best_effort
    dot1p_to: excellent_effort
    state: absent
  delegate_to: localhost

返回值 

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

键	描述
当前列表 / elements=string	模块完成后来自 APIC 的现有配置返回: 成功示例: `[{"fvTenant": {"attributes": {"descr": "生产环境", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]`
错误字典	从 APIC 返回的错误信息返回: 失败示例: `{"code": "122", "text": "未知的托管对象类 foo"}`
过滤器字符串字符串	用于请求的过滤器字符串返回: 失败或调试示例: `"?rsp-prop-include=config-only"`
方法字符串	用于向 APIC 发送请求的 HTTP 方法返回: 失败或调试示例: `"POST"`
先前列表 / elements=string	模块启动之前来自 APIC 的原始配置返回: 信息示例: `[{"fvTenant": {"attributes": {"descr": "生产", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]`
建议字典	根据用户提供的参数组装的配置返回: 信息示例: `{"fvTenant": {"attributes": {"descr": "生产环境", "name": "production"}}}`
原始字符串	APIC REST API 返回的原始输出 (xml 或 json) 返回: 解析错误示例: `"<?xml version=\"1.0\" encoding=\"UTF-8\"?><imdata totalCount=\"1\"><error code=\"122\" text=\"未知的托管对象类 foo\"/></imdata>"`
响应字符串	来自 APIC 的 HTTP 响应返回: 失败或调试示例: `"OK (30 字节)"`
发送列表 / elements=string	推送到 APIC 的实际/最小配置返回: 信息示例: `{"fvTenant": {"attributes": {"descr": "生产环境"}}}`
状态整数	来自 APIC 的 HTTP 状态返回: 失败或调试示例: `200`
URL 字符串	用于向 APIC 发送请求的 HTTP URL 返回: 失败或调试示例: `"https://10.11.12.13/api/mo/uni/tn-production.json"`

作者

Gaspard Micol (@gmicol)

参数	注释
annotation 字符串	用户定义的字符串，用于注释对象。如果任务中未指定值，则将改用环境变量 `ACI_ANNOTATION` 的值。如果任务中未指定值，并且环境变量 `ACI_ANNOTATION` 也未指定，则将使用默认值。默认值： `"orchestrator:ansible"`
certificate_name 别名：cert_name 字符串	附加到用于基于签名的身份验证的 APIC AAA 用户的 X.509 证书名称。如果提供了 `private_key` 文件名，则此项默认设置为 `private_key` 的基本名称，不带扩展名。如果为 `private_key` 提供了 PEM 格式的内容，则此项默认设置为 `username` 值。如果任务中未指定值，则将改用环境变量 `ACI_CERTIFICATE_NAME` 的值。
dot1p_from 字符串	Dot1P 范围起始值。选择 `"background"` `"best_effort"` `"excellent_effort"` `"critical_applications"` `"video"` `"voice"` `"internetwork_control"` `"network_control"` `"unspecified"`
dot1p_target 别名：target 字符串	Dot1P 目标值。在创建过程中未设置时，APIC 默认为 `unspecified`。选择 `"AF11"` `"AF12"` `"AF13"` `"AF21"` `"AF22"` `"AF23"` `"AF31"` `"AF32"` `"AF33"` `"AF41"` `"AF42"` `"AF43"` `"CS0"` `"CS1"` `"CS2"` `"CS3"` `"CS4"` `"CS5"` `"CS6"` `"CS7"` `"EF"` `"VA"` `"unspecified"`
dot1p_to 字符串	Dot1P 范围结束值。选择 `"background"` `"best_effort"` `"excellent_effort"` `"critical_applications"` `"video"` `"voice"` `"internetwork_control"` `"network_control"` `"unspecified"`
host 别名：hostname 字符串	Ansible 控制主机可解析的 APIC 的 IP 地址或主机名。如果任务中未指定值，则将改用环境变量 `ACI_HOST` 的值。
output_level 字符串	影响此 ACI 模块的输出。 `normal` 表示标准输出，包括 `current` 字典 `info` 添加信息性输出，包括 `previous`、`proposed` 和 `sent` 字典 `debug` 添加调试输出，包括 `filter_string`、`method`、`response`、`status` 和 `url` 信息如果任务中未指定值，则将改用环境变量 `ACI_OUTPUT_LEVEL` 的值。选择 `"debug"` `"info"` `"normal"` ←（默认）
output_path 字符串	用于转储模块生成的 ACI JSON 配置对象的文件路径。如果任务中未指定值，则将改用环境变量 `ACI_OUTPUT_PATH` 的值。
owner_key 字符串	用户定义的字符串，用于 ACI 对象的 ownerKey 属性。此属性表示一个键，用于使客户端能够拥有其用于实体关联的数据。如果任务中未指定值，则将改用环境变量 `ACI_OWNER_KEY` 的值。
owner_tag 字符串	用户定义的字符串，用于 ACI 对象的 ownerTag 属性。此属性表示一个标签，允许客户端添加自己的数据。例如，指示谁创建了这个对象。如果任务中未指定该值，则将使用环境变量 `ACI_OWNER_TAG` 的值。
密码字符串	用于身份验证的密码。此选项与 `private_key` 互斥。如果也提供了 `private_key`，则将使用它。如果任务中未指定该值，则将使用环境变量 `ACI_PASSWORD` 或 `ANSIBLE_NET_PASSWORD` 的值。
端口整数	用于 REST 连接的端口号。默认值取决于参数 `use_ssl`。如果任务中未指定该值，则将使用环境变量 `ACI_PORT` 的值。
优先级别名: prio 字符串	要使用的所需 QoS 类级别。在创建过程中未设置时，APIC 默认为 `unspecified`。选择 `"level1"` `"level2"` `"level3"` `"level4"` `"level5"` `"level6"` `"unspecified"`
私钥别名: cert_key 字符串	用于基于签名的身份验证的 PEM 格式的私钥文件或私钥内容。此值还会影响使用的默认 `certificate_name`。此选项与 `password` 互斥。如果也提供了 `password`，则将被忽略。如果任务中未指定该值，则将使用环境变量 `ACI_PRIVATE_KEY` 或 `ANSIBLE_NET_SSH_KEYFILE` 的值。
QoS 自定义策略别名: qos_custom_policy_name 字符串	QoS 自定义策略的名称。
状态字符串	使用 `present` 或 `absent` 来添加或删除。使用 `query` 来列出一个对象或多个对象。选择 `"absent"` `"present"` ← (默认) `"query"`
抑制先前状态别名: no_previous, ignore_previous 布尔值	如果为 `true`，则在向 APIC 发送 POST 更新之前，不会发送 GET 请求来检查先前状态。如果任务中未指定该值，则将使用环境变量 `ACI_SUPPRESS_PREVIOUS` 的值。默认值为 `false`。警告 - 这会导致之前的返回值为空。将不会检查对象的先前状态，并且 POST 更新将包含所有属性。选择 `false` `true`
抑制验证别名: no_verification, no_verify, suppress_verify, ignore_verify, ignore_verification 布尔值	如果为 `true`，则在向 APIC 发送 POST 更新后，不会发送验证 GET 请求。如果任务中未指定该值，则将使用环境变量 `ACI_SUPPRESS_VERIFICATION` 的值。默认值为 `false`。警告 - 这会导致当前返回值设置为建议值。在单个任务中，包括默认值的当前对象将无法验证。选择 `false` `true`
目标 COS 字符串	要基于进入网络的 Dot1P 输入值范围驱动的目标 COS。在创建过程中未设置时，APIC 默认为 `unspecified`。选择 `"background"` `"best_effort"` `"excellent_effort"` `"critical_applications"` `"video"` `"voice"` `"internetwork_control"` `"network_control"` `"unspecified"`
租户别名: tenant_name 字符串	现有租户的名称。
超时整数	套接字级别的超时时间（秒）。如果任务中未指定该值，则将使用环境变量 `ACI_TIMEOUT` 的值。默认值为 30。
使用代理布尔值	如果为 `false`，则即使目标主机上的环境变量中定义了代理，也不会使用代理。如果任务中未指定该值，则将使用环境变量 `ACI_USE_PROXY` 的值。默认值为 true。选择 `false` `true`
使用 SSL 布尔值	如果为 `false`，则将使用 HTTP 连接而不是默认的 HTTPS 连接。如果任务中未指定该值，则将使用环境变量 `ACI_USE_SSL` 的值。当连接为本地连接时，默认值为 true。选择 `false` `true`
用户名别名: user 字符串	用于身份验证的用户名。如果任务中未指定该值，则将使用环境变量 `ACI_USERNAME` 或 `ANSIBLE_NET_USERNAME` 的值。默认值为 admin。
验证证书布尔值	如果为 `false`，则不会验证 SSL 证书。只有在使用自签名证书的个人控制站点时，才应将其设置为 `false`。如果任务中未指定该值，则将使用环境变量 `ACI_VALIDATE_CERTS` 的值。默认值为 true。选择 `false` `true`