cisco.aci.aci_tag 模块 – ACI 对象的标记 (tag:Annotation、tag:Inst 和 tag:Tag)

注意

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

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

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

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

概要

• 在 Cisco ACI 结构上标记对象。

参数

参数	注释
certificate_name 别名：cert_name 字符串	附加到用于基于签名的身份验证的 APIC AAA 用户的 X.509 证书名称。 如果提供了 private_key 文件名，则默认为 private_key 基名，不带扩展名。 如果为 private_key 提供了 PEM 格式的内容，则默认为 username 值。 如果任务中未指定该值，则将改用环境变量 ACI_CERTIFICATE_NAME 的值。
dn 字符串	来自 ACI 对象模型的唯一区分名称 (DN)。
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 的值。
password 字符串	用于身份验证的密码。 此选项与 private_key 互斥。如果也提供了 private_key，则将改用它。 如果任务中未指定该值，则将改用环境变量 ACI_PASSWORD 或 ANSIBLE_NET_PASSWORD 的值。
port 整数	用于 REST 连接的端口号。 默认值取决于参数 use_ssl。 如果任务中未指定该值，则将改用环境变量 ACI_PORT 的值。
private_key 别名：cert_key 字符串	用于基于签名的身份验证的 PEM 格式的私钥文件或私钥内容。 此值还会影响使用的默认 certificate_name。 此选项与 password 互斥。如果也提供了 password，则将忽略它。 如果任务中未指定该值，则将改用环境变量 ACI_PRIVATE_KEY 或 ANSIBLE_NET_SSH_KEYFILE 的值。
state 字符串	使用 present 或 absent 来添加或删除。 使用 query 来列出对象或多个对象。 选项 "absent" "present" ← (默认) "query"
suppress_previous 别名：no_previous、ignore_previous 布尔值	如果为 true，则在进行 POST 更新到 APIC 之前不会发送 GET 来检查先前状态。 如果任务中未指定该值，则将改用环境变量 ACI_SUPPRESS_PREVIOUS 的值。 默认值为 false。 警告 - 这会导致先前的返回值为空。 不会检查对象的先前状态，并且 POST 更新将包含所有属性。 选项 false true
suppress_verification 别名：no_verification、no_verify、suppress_verify、ignore_verify、ignore_verification 布尔值	如果值为true，则在向APIC执行POST更新后，不会发送验证GET请求。 如果任务中未指定此值，则将使用环境变量ACI_SUPPRESS_VERIFICATION的值。 默认值为 false。 警告 - 这会导致当前返回值设置为建议值。 包含默认值的当前对象在一个任务中将无法验证。 选项 false true
tag_key 字符串	标签对象的唯一标识符。
tag_type 字符串 / 必填	标签对象的类型。 选项 "annotation" "instance" "tag"
tag_value 字符串	属性的值。 默认值： ""
timeout 整数	套接字级别的超时时间（秒）。 如果任务中未指定此值，则将使用环境变量ACI_TIMEOUT的值。 默认值为30。
use_proxy 布尔值	如果值为false，则即使目标主机上的环境变量中定义了代理，也不会使用代理。 如果任务中未指定此值，则将使用环境变量ACI_USE_PROXY的值。 默认值为true。 选项 false true
use_ssl 布尔值	如果值为false，则将使用HTTP连接而不是默认的HTTPS连接。 如果任务中未指定此值，则将使用环境变量ACI_USE_SSL的值。 当连接为本地连接时，默认值为true。 选项 false true
username 别名：user 字符串	用于身份验证的用户名。 如果任务中未指定此值，则将使用环境变量ACI_USERNAME或ANSIBLE_NET_USERNAME的值。 默认值为admin。
validate_certs 布尔值	如果值为false，则不会验证SSL证书。 只有在使用自签名证书的个人控制站点上才应将其设置为false。 如果任务中未指定此值，则将使用环境变量ACI_VALIDATE_CERTS的值。 默认值为true。 选项 false true

注释

注意

• 在您的playbook中使用此模块之前，必须存在ACI对象。

• 警告 - 由于“tagInst”对象的弃用，“tag_type”为“instance”的标签创建会自动生成一个值为“空”的“annotation”类型的标签。删除“tag_type”为“instance”的标签时，“tagAnnotation”对象将保留，需要单独删除。

另请参阅

另请参阅

APIC管理信息模型参考

有关内部APIC类tag:Annotation、tag:Inst和tag:Tag的更多信息。

Cisco APIC系统管理配置指南

有关标签的更多信息，请参阅Cisco APIC系统管理配置指南。

Cisco ACI指南

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

开发Cisco ACI模块

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

示例

- name: Add a new annotation tag
  cisco.aci.aci_tag:
    host: apic
    username: admin
    password: SomeSecretPassword
    dn: SomeValidAciDN
    tag_key: foo
    tag_value: bar
    tag_type: annotation
    state: present
  delegate_to: localhost
- name: Delete annotation tag
  cisco.aci.aci_tag:
    host: apic
    username: admin
    password: SomeSecretPassword
    dn: SomeValidAciDN
    tag_key: foo
    tag_type: annotation
    state: absent
  delegate_to: localhost
- name: Query annotation tag
  cisco.aci.aci_tag:
    host: apic
    username: admin
    password: SomeSecretPassword
    dn: SomeValidAciDN
    tag_key: foo
    tag_type: annotation
    state: query
  delegate_to: localhost
- name: Query annotation tags
  cisco.aci.aci_tag:
    host: apic
    username: admin
    password: SomeSecretPassword
    tag_type: annotation
    state: query
  delegate_to: localhost

返回值

公共返回值已在此处记录，以下是此模块独有的字段

键	描述
current 列表 / 元素=字符串	模块完成后APIC中的现有配置 返回：成功 示例： [{"fvTenant": {"attributes": {"descr": "Production environment", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]
error 字典	APIC返回的错误信息 返回：失败 示例： {"code": "122", "text": "unknown managed object class foo"}
filter_string 字符串	用于请求的过滤器字符串 返回：失败或调试 示例： "?rsp-prop-include=config-only"
method 字符串	用于向APIC发出请求的HTTP方法 返回：失败或调试 示例： "POST"
previous 列表 / 元素=字符串	模块启动之前APIC中的原始配置 返回：信息 示例： [{"fvTenant": {"attributes": {"descr": "Production", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]
proposed 字典	根据用户提供的参数组装的配置 返回：信息 示例： {"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>"
response 字符串	来自APIC的HTTP响应 返回：失败或调试 示例： "OK (30 bytes)"
sent 列表 / 元素=字符串	实际/最小推送到APIC的配置 返回：信息 示例： {"fvTenant": {"attributes": {"descr": "Production environment"}}}
status 整数	来自APIC的HTTP状态 返回：失败或调试 示例： 200
url 字符串	用于向APIC发出请求的HTTP URL 返回：失败或调试 示例： "https://10.11.12.13/api/mo/uni/tn-production.json"

作者

• Akini Ross (@akinross)

集合链接

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