cisco.aci.aci_l3out_floating_svi_secondary_ip 模块 – 管理三层外部 (L3Out) 浮动 SVI 次要 IP 地址 (l3ext:Ip)

注意

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

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

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

要在 playbook 中使用它,请指定:cisco.aci.aci_l3out_floating_svi_secondary_ip

概要

  • 管理 Cisco ACI 结构上的 L3Out 浮动 SVI 次要 IP 地址。

参数

参数

注释

注释

字符串

用于注释对象的自定义字符串。

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

encap

字符串 / 必需

接口上的封装(例如,“vlan-500”)

host

别名:hostname

字符串

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

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

interface_profile

别名:interface_profile_name, logical_interface

字符串 / 必需

接口配置文件的名称。

l3out

别名:l3out_name

字符串 / 必需

现有 L3Out 的名称。

node_id

字符串 / 必需

为端口通道和单个端口构建接口的节点。

node_profile

别名:node_profile_name, logical_node

字符串 / 必需

节点配置文件的名称。

output_level

字符串

影响此 ACI 模块的输出。

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

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

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

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

选项

  • "debug"

  • "info"

  • "normal" ← (默认)

output_path

字符串

将用于转储模块生成的 ACI JSON 配置对象的路径。

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

password

字符串

用于身份验证的密码。

此选项与 private_key 互斥。如果也提供了 private_key,则将改用它。

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

pod_id

字符串 / 必需

构建接口的Pod。

port

整数

用于REST连接的端口号。

默认值取决于参数use_ssl

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

private_key

别名:cert_key

字符串

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

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

此选项与password互斥。如果也提供了password,则会忽略它。

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

secondary_ip

别名:secondary_floating_address

字符串

辅助浮动IP地址。

state

字符串

使用presentabsent添加或删除。

使用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_USERNAMEANSIBLE_NET_USERNAME的值。

默认值为admin。

validate_certs

布尔值

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

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

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

默认值为true。

选项

  • false

  • true

注释

注意

另请参阅

另请参阅

cisco.aci.aci_tenant

管理租户 (fv:Tenant)。

cisco.aci.aci_l3out

管理三层外部 (L3Out) 对象 (l3ext:Out)。

cisco.aci.aci_l3out_logical_node_profile

管理三层外部 (L3Out) 逻辑节点配置文件 (l3ext:LNodeP)。

cisco.aci.aci_l3out_logical_interface_profile

管理三层外部 (L3Out) 逻辑接口配置文件 (l3ext:LIfP)。

cisco.aci.aci_l3out_floating_svi

管理三层外部 (L3Out) 接口 (l3ext:VirtualLIfP)。

APIC管理信息模型参考

有关内部APIC类l3ext:Ip的更多信息

Cisco ACI指南

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

开发Cisco ACI模块

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

示例

- name: Create a Floating SVI secondary IP
  cisco.aci.aci_l3out_floating_svi_secondary_ip:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: my_tenant
    l3out: my_l3out
    node_profile: my_node_profile
    interface_profile: my_interface_profile
    pod_id: 1
    node_id: 201
    encap: vlan-1
    secondary_ip: 23.45.67.90/24
    state: present
  delegate_to: localhost

- name: Remove a Floating SVI secondary IP
  cisco.aci.aci_l3out_floating_svi_secondary_ip:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: my_tenant
    l3out: my_l3out
    node_profile: my_node_profile
    interface_profile: my_interface_profile
    pod_id: 1
    node_id: 201
    encap: vlan-1
    secondary_ip: 23.45.67.90/24
    state: absent
  delegate_to: localhost

- name: Query a Floating SVI secondary IP
  cisco.aci.aci_l3out_floating_svi_secondary_ip:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: my_tenant
    l3out: my_l3out
    node_profile: my_node_profile
    interface_profile: my_interface_profile
    pod_id: 1
    node_id: 201
    encap: vlan-1
    secondary_ip: 23.45.67.90/24
    state: query
  delegate_to: localhost
  register: query_result

- name: Query all the secondary IPs under a Floating SVI
  cisco.aci.aci_l3out_floating_svi_secondary_ip:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: my_tenant
    l3out: my_l3out
    node_profile: my_node_profile
    interface_profile: my_interface_profile
    pod_id: 1
    node_id: 201
    encap: vlan-1
    state: query
  delegate_to: localhost
  register: query_results

返回值

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

描述

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>"

响应

字符串

APIC 的 HTTP 响应

返回:失败或调试

示例: "OK (30 bytes)"

已发送

列表 / 元素=字符串

实际/最小配置推送到 APIC

返回:信息

示例: {"fvTenant": {"attributes": {"descr": "Production environment"}}}

状态

整数

APIC 的 HTTP 状态

返回:失败或调试

示例: 200

URL

字符串

用于向 APIC 发出请求的 HTTP URL

返回:失败或调试

示例: "https://10.11.12.13/api/mo/uni/tn-production.json"

作者

  • Shreyas Srish (@shrsr)