cisco.aci.aci_cloud_external_epg_selector 模块 – 管理外部 EPG 的云端点选择器 (cloud:ExtEPSelector)

注意

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

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

要安装它,请使用: ansible-galaxy collection install cisco.aci

要在剧本中使用它,请指定: cisco.aci.aci_cloud_external_epg_selector

概要

  • 根据多个参数确定哪些端点属于 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 的值。

cloud_external_epg

字符串

cloud_external_epg 对象的名称。

host

别名:hostname

字符串

Ansible 控制主机可以解析的 APIC 的 IP 地址或主机名。

如果任务中未指定此值,则将改为使用环境变量 ACI_HOST 的值。

name

别名:selector, cloud_external_epg_selector, external_epg_selector, extepg_selector, selector_name

字符串

云端点选择器的名称。

output_level

字符串

影响此 ACI 模块的输出。

normal 表示标准输出,包括 current 字典

info 添加信息输出,包括 previousproposedsent 字典

debug 添加调试输出,包括 filter_stringmethodresponsestatusurl 信息

如果任务中未指定此值,则将改为使用环境变量 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_PASSWORDANSIBLE_NET_PASSWORD的值。

端口

整数

用于REST连接的端口号。

默认值取决于参数use_ssl

如果任务中未指定此值,则将改用环境变量ACI_PORT的值。

private_key

别名:cert_key

字符串

PEM 格式的私钥文件或用于基于签名的身份验证的私钥内容。

此值还会影响使用的默认certificate_name

此选项与password互斥。如果同时提供password,则将忽略它。

如果任务中未指定此值,则将改用环境变量ACI_PRIVATE_KEYANSIBLE_NET_SSH_KEYFILE的值。

状态

字符串

使用presentabsent添加或删除。

使用query列出单个或多个对象。

选项

  • "absent"

  • "present" ← (默认)

  • "query"

子网

别名:ip

字符串

云子网的IP地址。

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

租户

字符串

租户名称。

超时

整数

以秒为单位的套接字级别超时。

如果任务中未指定此值,则将改用环境变量ACI_TIMEOUT的值。

默认值为30。

使用代理

布尔值

如果为false,即使目标主机上的环境变量中定义了代理,也不会使用代理。

如果任务中未指定此值,则将改用环境变量ACI_USE_PROXY的值。

默认值为true。

选项

  • false

  • true

使用SSL

布尔值

如果为false,将使用HTTP连接而不是默认的HTTPS连接。

如果任务中未指定此值,则将改用环境变量ACI_USE_SSL的值。

当连接为本地连接时,默认值为true。

选项

  • false

  • true

用户名

别名:user

字符串

用于身份验证的用户名。

如果任务中未指定此值,则将改用环境变量ACI_USERNAMEANSIBLE_NET_USERNAME的值。

默认值为admin。

验证证书

布尔值

如果为false,则不会验证SSL证书。

只有在使用自签名证书的个人控制站点上时,才应将其设置为false

如果任务中未指定此值,则将改用环境变量ACI_VALIDATE_CERTS的值。

默认值为true。

选项

  • false

  • true

备注

注意

另请参阅

另请参阅

Cisco ACI 指南

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

开发 Cisco ACI 模块

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

示例

- name: Add a new cloud external EPG selector
  cisco.aci.aci_cloud_external_epg_selector:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: tenant1
    ap: ap1
    cloud_external_epg: ext_epg
    name: subnet_name
    subnet: 10.0.0.0/16
    state: present
  delegate_to: localhost

- name: Remove a cloud external EPG selector
  cisco.aci.aci_cloud_external_epg_selector:
    host: apic
    username: admin
    password: SomeSecretPassword
    validate_certs: false
    tenant: tenant1
    ap: ap1
    cloud_external_epg: ext_epg
    name: subnet_name
    subnet: 10.0.0.0/16
    state: absent
  delegate_to: localhost

- name: Query all cloud external EPG selectors
  cisco.aci.aci_cloud_external_epg_selector:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: tenant1
    ap: ap1
    cloud_external_epg: ext_epg
    state: query
  delegate_to: localhost

作者

  • Anvitha Jain (@anvitha-jain)