cisco.aci.aci_static_binding_to_epg 模块 – 将静态路径绑定到 EPG (fv:RsPathAtt)

注意

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

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

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

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

概要

• 将静态路径绑定到 Cisco ACI 结构上的 EPG。

参数

参数	注释
annotation 字符串	用于注释对象的自定义字符串。 如果任务中未指定此值，则将使用环境变量 ACI_ANNOTATION 的值。 如果任务中未指定此值，并且环境变量 ACI_ANNOTATION 也不存在，则将使用默认值。 默认值： "orchestrator:ansible"
ap 别名：app_profile, app_profile_name 字符串	包含 EPG 的现有应用程序网络配置文件的名称。
certificate_name 别名：cert_name 字符串	附加到用于基于签名的身份验证的 APIC AAA 用户的 X.509 证书名称。 如果提供了 private_key 文件名，则默认为 private_key 的基名（不含扩展名）。 如果为 private_key 提供了 PEM 格式的内容，则默认为 username 值。 如果任务中未指定此值，则将使用环境变量 ACI_CERTIFICATE_NAME 的值。
deploy_immediacy 字符串	PC、VPC 或接口上静态 EPG 的部署即时性。 在创建期间未设置时，APIC 默认值为 lazy。 选项 "immediate" "lazy"
description 别名：descr 字符串	静态路径到 EPG 绑定的描述。
encap_id 别名：vlan, vlan_id 整数	将 epg 与接口路径关联的封装 ID。 在使用微分段时，这充当辅助 encap_id。 可接受的值是指定封装的任何有效封装 ID，当前范围在 1 和 4096 之间。
epg 别名：epg_name 字符串	端点组的名称。
extpaths 列表 / 元素=字符串	tDn 的 extpaths 整数值部分。 只有当 interface_type 为 fex、fex_vpc 或 fex_port_channel 时，才使用 extpaths。 当 interface_type 为 fex_vpc 时，extpaths 是包含两个 fex ID 的列表。 通常类似于 1011。
host 别名：hostname 字符串	Ansible 控制主机可以解析的 APIC 的 IP 地址或主机名。 如果任务中未指定此值，则将使用环境变量 ACI_HOST 的值。
interface 字符串	tDn 的 interface 字符串值部分。 根据 interface_type，通常是策略组，例如 test-IntPolGrp 或以下格式的接口 1/7。
interface_mode 别名：interface_mode_name, mode 字符串	确定如何从帧中读取和添加到帧的第 2 层标记。 值 802.1p 和 native 相同。 值 access 和 untagged 相同。 值 regular、tagged 和 trunk 相同。 未设置时，APIC 在创建过程中默认为 trunk。 选项 “802.1p” “access” “native” “regular” “tagged” “trunk” “untagged”
interface_type 字符串	静态 EPG 部署的接口类型。 选项 “fex” “port_channel” "switch_port" ← (默认) “vpc” “fex_port_channel” “fex_vpc”
leafs 别名：leaves、nodes、paths、switches 列表 / 元素=字符串	interface所属交换机 ID。 当 interface_type 为 switch_port、port_channel 或 fex 时，leafs 是 leaf ID 的字符串。 当 interface_type 为 vpc 时，leafs 是包含两个 leaf ID 的列表。 leafs 值通常类似于 '101' 或 '101-102'，具体取决于 connection_type。
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 的值。
pod_id 别名：pod、pod_number 整数	tDn 的 pod 编号部分。 pod_id 通常是小于 10 的整数。
port 整数	用于 REST 连接的端口号。 默认值取决于参数 use_ssl。 如果任务中未指定此值，则将使用环境变量 ACI_PORT 的值。
primary_encap_id 别名：primary_vlan、primary_vlan_id 字符串	使用微分段时，确定将 epg 与接口路径关联的主要封装 ID。 可接受的值是指定封装的任何有效封装 ID，当前范围在 1 和 4096 之间，以及 unknown。 unknown 是默认值，使用 unknown 将禁用微分段。
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，则在进行 POST 更新到 APIC 后不会发送验证性 GET 请求。 如果任务中未指定此值，则将使用环境变量 ACI_SUPPRESS_VERIFICATION 的值。 默认值为 false。 警告 - 这会导致当前返回值设置为建议值。 包含默认值的当前对象在一个任务中将无法验证。 选项 false true
tenant 别名：tenant_name 字符串	现有租户的名称。
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 中使用此模块之前，必须存在使用的 tenant、ap、epg。可以使用 cisco.aci.aci_tenant、cisco.aci.aci_ap、cisco.aci.aci_epg 模块。

另请参阅

另请参阅

cisco.aci.aci_tenant

管理租户 (fv:Tenant)。

cisco.aci.aci_ap

管理顶级应用程序配置文件 (AP) 对象 (fv:Ap)。

cisco.aci.aci_epg

管理端点组 (EPG) 对象 (fv:AEPg)。

APIC 管理信息模型参考

关于内部 APIC 类fv:RsPathAtt的更多信息。

Cisco ACI 指南

使用 Ansible 管理 ACI 基础设施的详细说明。

开发 Cisco ACI 模块

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

示例

- name: Deploy Static Path binding for given EPG
  cisco.aci.aci_static_binding_to_epg:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: accessport-code-cert
    ap: accessport_code_app
    epg: accessport_epg1
    encap_id: 222
    deploy_immediacy: lazy
    interface_mode: untagged
    interface_type: switch_port
    pod_id: 1
    leafs: 101
    interface: '1/7'
    state: present
  delegate_to: localhost

- name: Remove Static Path binding for given EPG
  cisco.aci.aci_static_binding_to_epg:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: accessport-code-cert
    ap: accessport_code_app
    epg: accessport_epg1
    interface_type: switch_port
    pod: 1
    leafs: 101
    interface: '1/7'
    state: absent
  delegate_to: localhost

- name: Get specific Static Path binding for given EPG
  cisco.aci.aci_static_binding_to_epg:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: accessport-code-cert
    ap: accessport_code_app
    epg: accessport_epg1
    interface_type: switch_port
    pod: 1
    leafs: 101
    interface: '1/7'
    state: query
  delegate_to: localhost
  register: query_result

返回值

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

键	描述
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"

作者

• Bruno Calogero (@brunocalogero)

• Marcel Zehnder (@maercu)

集合链接

• 问题追踪器
• 代码库 (源代码)