cisco.aci.aci_bulk_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_bulk_static_binding_to-epg。

概要

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

参数

参数	注释
annotation 字符串	用于注释对象的自定义字符串。 如果任务中未指定值，则将改为使用环境变量 ACI_ANNOTATION 的值。 如果任务中未指定值且未设置环境变量 ACI_ANNOTATION，则将使用默认值。 默认值： "orchestrator:ansible"
ap 别名：app_profile, app_profile_name 字符串	应用程序配置文件的名称。
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 字符串	端点组的名称。
host 别名：hostname 字符串	Ansible 控制主机可解析的 APIC 的 IP 地址或主机名。 如果任务中未指定值，则将改为使用环境变量 ACI_HOST 的值。
interface_configs 列表 / 元素=字典	接口配置列表，元素采用字典形式。 模块级属性将被路径级属性覆盖。
deploy_immediacy 字符串	PC、VPC 或接口上静态 EPG 的部署即时性。 在创建期间未设置时，APIC 默认值为 lazy。 选项 "immediate" "lazy"
description 别名：descr 字符串	静态路径到 EPG 绑定的描述。
encap_id 别名：vlan, vlan_id 整数	将 epg 与接口路径关联的封装 ID。 在使用微细分时，这充当次要 encap_id。 接受的值是指定封装的任何有效封装 ID，当前范围在 1 和 4096 之间。
extpaths 列表 / 元素=字符串	tDn 的 extpaths 整数值部分。 仅当 interface_type 为 fex、fex_vpc 或 fex_port_channel 时才使用 extpaths。 当 interface_type 为 fex_vpc 时，extpaths 是包含两个 fex ID 的列表。 通常类似于 1011。
interface 字符串 / 必需	tDn 的 interface 字符串值部分。 通常是策略组，例如 test-IntPolGrp 或取决于 interface_type 的以下格式的接口 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。
pod_id 别名：pod, pod_number 整数 / 必填	tDn的Pod编号部分。 pod_id通常是一个小于10的整数。
primary_encap_id 别名：primary_vlan, primary_vlan_id 字符串	使用微分段时，确定将epg与接口路径关联的主封装ID。 可接受的值是指定封装的任何有效封装ID，目前范围在1到4096之间，以及unknown。 unknown是默认值，使用unknown将禁用微分段。
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"
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的值。
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，则在向APIC发送POST更新之前，不会发送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
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: Create list of interfaces using module level attributes
  cisco.aci.aci_bulk_static_binding_to_epg:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: accessport-code-cert
    ap: accessport_code_app
    epg: accessport_epg1
    encap_id: 221
    interface_mode: trunk
    deploy_immediacy: lazy
    description: "Module level attributes used to create interfaces"
    interface_configs:
      - interface: 1/7
        leafs: 101
        pod: 1
      - interface: 1/7
        leafs: 107
        pod: 7
      - interface: 1/8
        leafs: 108
        pod: 8
        encap_id: 108
    state: present
  delegate_to: localhost

- name: Create/Update list of interfaces using path level attributes
  cisco.aci.aci_bulk_static_binding_to_epg:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: accessport-code-cert
    ap: accessport_code_app
    epg: accessport_epg1
    interface_configs:
      - interface: 1/7
        leafs: 101
        pod: 1
        encap_id: 221
        interface_mode: trunk
        deploy_immediacy: lazy
        description: "Path level attributes used to create/update interfaces"
      - interface: 1/7
        leafs: 107
        pod: 7
        encap_id: 221
        interface_mode: trunk
        deploy_immediacy: lazy
        description: "Path level attributes used to create/update interfaces"
      - interface: 1/8
        leafs: 108
        pod: 8
        encap_id: 108
        interface_mode: trunk
        deploy_immediacy: lazy
        description: "Path level attributes used to create/update interfaces"
    state: present
  delegate_to: localhost

- name: Query all interfaces of an EPG
  cisco.aci.aci_bulk_static_binding_to_epg:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: accessport-code-cert
    ap: accessport_code_app
    epg: accessport_epg1
    state: query
  delegate_to: localhost

- name: Query all interfaces
  cisco.aci.aci_bulk_static_binding_to_epg:
    host: apic
    username: admin
    password: SomeSecretPassword
    state: query
  delegate_to: localhost

- name: Remove list of interfaces
  cisco.aci.aci_bulk_static_binding_to_epg:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: accessport-code-cert
    ap: accessport_code_app
    epg: accessport_epg1
    encap_id: 221
    interface_mode: trunk
    deploy_immediacy: lazy
    interface_configs:
      - interface: 1/7
        leafs: 101
        pod: 1
      - interface: 1/7
        leafs: 107
        pod: 7
      - interface: 1/8
        leafs: 108
        pod: 8
        encap_id: 108
    state: absent
  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"

作者

• Bruno Calogero (@brunocalogero)

• Marcel Zehnder (@maercu)

• Sabari Jaganathan (@sajagana)

集合链接

• 问题追踪器
• 代码仓库