cisco.aci.aci_qos_dscp_class 模块 – 管理 QoS DSCP 类 (qos:DscpClass)

注意

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

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

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

要在剧本中使用它，请指定：cisco.aci.aci_qos_dscp_class。

概要

• 管理 Cisco ACI 结构上 QoS 自定义策略的 QoS 自定义区分服务代码点 (DSCP) 类级别。

• DSCP 的类级别以确定映射的优先级。

参数

参数	注释
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 的值。
dscp_from 字符串	DSCP 范围起始值。 选择 "AF11" "AF12" "AF13" "AF21" "AF22" "AF23" "AF31" "AF32" "AF33" "AF41" "AF42" "AF43" "CS0" "CS1" "CS2" "CS3" "CS4" "CS5" "CS6" "CS7" "EF" "VA" "unspecified"
dscp_target 别名: target 字符串	DSCP 目标值。 如果在创建期间未设置，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"
dscp_to 字符串	DSCP 范围结束值。 选择 "AF11" "AF12" "AF13" "AF21" "AF22" "AF23" "AF31" "AF32" "AF33" "AF41" "AF42" "AF43" "CS0" "CS1" "CS2" "CS3" "CS4" "CS5" "CS6" "CS7" "EF" "VA" "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 的值。
password 字符串	用于身份验证的密码。 此选项与 private_key 互斥。如果也提供了 private_key，则将改用它。 如果任务中未指定该值，则将使用环境变量 ACI_PASSWORD 或 ANSIBLE_NET_PASSWORD 的值。
port integer	用于 REST 连接的端口号。 默认值取决于参数 use_ssl。 如果任务中未指定该值，则将使用环境变量 ACI_PORT 的值。
priority 别名: prio 字符串	要使用的期望 QoS 类级别。 在创建期间未设置时，APIC 默认为 level3。 选择 "level1" "level2" "level3" "level4" "level5" "level6" "unspecified"
private_key 别名: cert_key 字符串	PEM 格式的私钥文件或用于基于签名的身份验证的私钥内容。 此值还会影响使用的默认 certificate_name。 此选项与 password 互斥。如果也提供了 password，则将被忽略。 如果任务中未指定该值，则将使用环境变量 ACI_PRIVATE_KEY 或 ANSIBLE_NET_SSH_KEYFILE 的值。
qos_custom_policy 别名: qos_custom_policy_name 字符串	QoS 自定义策略的名称。
state 字符串	使用 present 或 absent 添加或删除。 使用 query 列出一个或多个对象。 选择 "absent" "present" ← (默认) "query"
suppress_previous 别名: no_previous, ignore_previous boolean	如果为 true，则在向 APIC 发送 POST 更新之前，不会发送 GET 来检查先前状态。 如果任务中未指定该值，则将使用环境变量 ACI_SUPPRESS_PREVIOUS 的值。 默认值为 false。 警告 - 这会导致先前的返回值为空。 将不会检查对象的先前状态，并且 POST 更新将包含所有属性。 选择 false true
suppress_verification 别名: no_verification, no_verify, suppress_verify, ignore_verify, ignore_verification boolean	如果为 true，则在向 APIC 发送 POST 更新后，不会发送验证 GET。 如果任务中未指定该值，则将使用环境变量 ACI_SUPPRESS_VERIFICATION 的值。 默认值为 false。 警告 - 这会导致当前返回值设置为建议的值。 在单个任务中，包括默认值在内的当前对象将无法验证。 选择 false true
target_cos 字符串	要根据进入结构的 DSCP 输入值的范围驱动的目标 COS。 如果在创建期间未设置，APIC 默认为 unspecified。 选择 "background" "best_effort" "excellent_effort" "critical_applications" "video" "voice" "internetwork_control" "network_control" "unspecified"
tenant 别名: tenant_name 字符串	现有租户的名称。
timeout integer	套接字级别的超时时间（以秒为单位）。 如果任务中未指定该值，则将使用环境变量 ACI_TIMEOUT 的值。 默认值为 30。
use_proxy boolean	如果为 false，则即使在目标主机上的环境变量中定义了代理，也不会使用代理。 如果任务中未指定该值，则将使用环境变量 ACI_USE_PROXY 的值。 默认值为 true。 选择 false true
use_ssl boolean	如果为 false，则将使用 HTTP 连接而不是默认的 HTTPS 连接。 如果任务中未指定该值，则将使用环境变量 ACI_USE_SSL 的值。 当连接为本地连接时，默认值为 true。 选择 false true
username 别名: user 字符串	用于身份验证的用户名。 如果任务中未指定该值，则将使用环境变量 ACI_USERNAME 或 ANSIBLE_NET_USERNAME 的值。 默认值为 admin。
validate_certs boolean	如果为 false，则不会验证 SSL 证书。 仅当在个人控制的站点上使用自签名证书时，才应将其设置为 false。 如果任务中未指定该值，则将使用环境变量 ACI_VALIDATE_CERTS 的值。 默认值为 true。 选择 false true

Notes

注意

• 在剧本中使用此模块之前，租户和 qos_custom_policy 必须存在。可以使用 cisco.aci.aci_tenant 和 cisco.aci.aci_qos_custom_policy 来完成此操作。

See Also

另请参阅

cisco.aci.aci_tenant

管理租户 (fv:Tenant)。

cisco.aci.aci_qos_custom_policy

管理 QoS 自定义策略 (qos:CustomPol)。

APIC 管理信息模型参考

有关内部 APIC 类 qos:DscpClass 的更多信息。

Cisco ACI 指南

有关如何使用 Ansible 管理 ACI 基础架构的详细信息。

开发 Cisco ACI 模块

有关如何编写自己的 Cisco ACI 模块以做出贡献的详细指南。

Examples

- name: Add a new QoS DSCP Class
  cisco.aci.aci_qos_dscp_class:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: my_tenant
    qos_custom_policy: my_qos_custom_policy
    priority: level3
    dscp_from: AF11
    dscp_to: AF21
    dscp_target: unspecified
    target_cos: best_effort
    state: present
  delegate_to: localhost

- name: Query a QoS DSCP Class
  cisco.aci.aci_qos_dscp_class:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: my_tenant
    qos_custom_policy: my_qos_custom_policy
    dscp_from: AF11
    dscp_to: AF21
    state: query
  delegate_to: localhost

- name: Query all QoS DSCP Classes in my_qos_custom_policy
  cisco.aci.aci_qos_dscp_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 DSCP Classes
  cisco.aci.aci_qos_dscp_class:
    host: apic
    username: admin
    password: SomeSecretPassword
    state: query
  delegate_to: localhost

- name: Delete a QoS DSCP Class
  cisco.aci.aci_qos_dscp_class:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: my_tenant
    qos_custom_policy: my_qos_custom_policy
    dscp_from: AF11
    dscp_to: AF21
    state: absent
  delegate_to: localhost

Return Values

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

Key	描述
current list / elements=string	模块完成后，来自 APIC 的现有配置 Returned: success Sample: [{"fvTenant": {"attributes": {"descr": "Production environment", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]
error dictionary	从 APIC 返回的错误信息 Returned: failure Sample: {"code": "122", "text": "unknown managed object class foo"}
filter_string 字符串	用于请求的过滤器字符串 Returned: failure or debug Sample: "?rsp-prop-include=config-only"
method 字符串	用于向 APIC 发出请求的 HTTP 方法 Returned: failure or debug Sample: "POST"
previous list / elements=string	模块启动前来自 APIC 的原始配置 Returned: info Sample: [{"fvTenant": {"attributes": {"descr": "Production", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]
proposed dictionary	从用户提供的参数组装的配置 Returned: info Sample: {"fvTenant": {"attributes": {"descr": "Production environment", "name": "production"}}}
raw 字符串	APIC REST API 返回的原始输出（xml 或 json） 返回： 解析错误 示例： "<?xml version=\"1.0\" encoding=\"UTF-8\"?><imdata totalCount=\"1\"><error code=\"122\" text=\"unknown managed object class foo\"/></imdata>"
响应 字符串	来自 APIC 的 HTTP 响应 Returned: failure or debug 示例： "OK (30 bytes)"
发送 list / elements=string	推送到 APIC 的实际/最小配置 Returned: info 示例： {"fvTenant": {"attributes": {"descr": "Production environment"}}}
状态 integer	来自 APIC 的 HTTP 状态 Returned: failure or debug 示例： 200
url 字符串	用于向 APIC 发送请求的 HTTP url Returned: failure or debug 示例： "https://10.11.12.13/api/mo/uni/tn-production.json"

作者

• Gaspard Micol (@gmicol)

集合链接

• 问题跟踪器
• 代码仓库（源代码）