cisco.aci.aci_tenant_span_src_group 模块 – 管理 SPAN 源组 (span:SrcGrp)

注意

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

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

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

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

概要

• 管理 Cisco ACI 结构上的 SPAN 源组。

参数

参数	注释
admin_state 布尔值	启用 true 或禁用 false span 源。 在创建期间未设置时，APIC 默认值为 true。 选项 false true
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 的值。
description 别名：descr 字符串	Span 源组的描述。
dst_group 字符串	要与源组关联的 Span 目标组。
host 别名：hostname 字符串	Ansible 控制主机可以解析的 APIC 的 IP 地址或主机名。 如果任务中未指定此值，则将使用环境变量 ACI_HOST 的值。
name_alias 字符串	当前对象的别名。这与 ACI 中的 nameAlias 字段相关。
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的值。
私钥 别名：cert_key 字符串	PEM格式的私钥文件或用于基于签名的身份验证的私钥内容。 此值也会影响使用的默认certificate_name。 此选项与password互斥。如果也提供了password，则将忽略它。 如果任务中未指定此值，则将使用环境变量ACI_PRIVATE_KEY或ANSIBLE_NET_SSH_KEYFILE的值。
源组 别名：name 字符串	Span源组的名称。
状态 字符串	使用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
租户 别名：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

注释

注意

• 在您的playbook中使用此模块之前，必须存在使用的tenant。cisco.aci.aci_tenant模块可用于此目的。

另请参阅

另请参阅

cisco.aci.aci_tenant

管理租户 (fv:Tenant)。

APIC管理信息模型参考

关于内部APIC类span:SrcGrp的更多信息。

思科ACI指南

使用Ansible管理ACI基础设施的详细信息。

开发思科ACI模块

关于如何编写您自己的思科ACI模块以贡献的详细指南。

示例

- name: Create a SPAN source group
  cisco.aci.aci_tenant_span_src_group:
    host: apic
    username: admin
    password: SomeSecretPassword
    src_group: my_span_source_group
    tenant: prod
    state: present
  delegate_to: localhost

- name: Delete a SPAN source group
  cisco.aci.aci_tenant_span_src_group:
    host: apic
    username: admin
    password: SomeSecretPassword
    src_group: my_span_source_group
    tenant: prod
    state: absent
  delegate_to: localhost

- name: Query all SPAN source groups
  cisco.aci.aci_tenant_span_src_group:
    host: apic
    username: admin
    password: SomeSecretPassword
    state: query
  delegate_to: localhost
  register: query_result

- name: Query a specific SPAN source group
  cisco.aci.aci_tenant_span_src_group:
    host: apic
    username: admin
    password: SomeSecretPassword
    src_group: my_span_source_group
    tenant: prod
    state: query
  delegate_to: localhost
  register: query_result

返回值

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

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

作者

• Jacob McGill (@jmcgill298)

资源链接

• 问题追踪器
• 代码仓库