cisco.aci.aci_bd_subnet 模块 – 管理子网 (fv:Subnet)

注意

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

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

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

要在 Playbook 中使用它，请指定：cisco.aci.aci_bd_subnet。

概要

  • 管理 Cisco ACI 架构上的子网。

参数

参数

注释

annotation

字符串

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

如果在任务中未指定值，则将使用环境变量 ACI_ANNOTATION 的值。

如果在任务中未指定值且环境变量 ACI_ANNOTATION 也未设置，则将使用默认值。

默认值: "orchestrator:ansible"

bd

别名: bd_name

字符串

桥接域的名称。

certificate_name

别名: cert_name

字符串

附加到用于基于签名的身份验证的 APIC AAA 用户的 X.509 证书名称。

如果提供了 private_key 文件名，则默认为 private_key 的基本名称，不带扩展名。

如果为 private_key 提供了 PEM 格式的内容，则默认为 username 值。

如果在任务中未指定值，则将使用环境变量 ACI_CERTIFICATE_NAME 的值。

description

别名: descr

字符串

子网的描述。

enable_vip

布尔值

确定是否应将子网视为 VIP；当 BD 扩展到多个站点时使用。

APIC 在创建时未设置时默认为 false。

选项

  • false

  • true

gateway

别名: gateway_ip

字符串

子网的 IPv4 或 IPv6 网关地址。

host

别名: hostname

字符串

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

如果在任务中未指定值，则将使用环境变量 ACI_HOST 的值。

ip_data_plane_learning

别名: ip_dataplane_learning

字符串

是否启用或禁用 IP 数据平面学习。

APIC 在创建时未设置时默认为 enabled。

选项

  • "enabled"

  • "disabled"

mask

别名: subnet_mask

整数

子网的子网掩码。

这是与 CIDR 表示法关联的数字。

对于 IPv4 地址，接受的值范围在 0 和 32 之间。

对于 IPv6 地址，接受的值范围在 0 和 128 之间。

name_alias

字符串

当前对象的别名。 这与 ACI 中的 nameAlias 字段相关。

nd_prefix_policy

字符串

要与子网关联的 IPv6 邻居发现前缀策略。

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，则将使用 private_key。

如果在任务中未指定该值，则将使用环境变量 ACI_PASSWORD 或 ANSIBLE_NET_PASSWORD 的值。

port

整数

用于 REST 连接的端口号。

默认值取决于参数 use_ssl。

如果在任务中未指定该值，则将使用环境变量 ACI_PORT 的值。

preferred

布尔值

确定是否在所有可用的子网中优先选择此子网。每个地址族（IPv4/IPv6）在桥接域中只能有一个首选子网。

APIC 在创建时未设置时默认为 false。

选项

  • false

  • true

private_key

别名: cert_key

字符串

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

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

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

如果在任务中未指定该值，则将使用环境变量 ACI_PRIVATE_KEY 或 ANSIBLE_NET_SSH_KEYFILE 的值。

route_profile

字符串

要与子网关联的路由配置文件。

route_profile_l3_out

字符串

包含关联路由配置文件的 L3 Out。

scope

列表 / 元素=字符串

确定子网的范围。

private 选项只允许与同一 VRF 中的主机通信。

public 选项允许在 ACI 结构之外通告子网，并允许与其他 VRF 中的主机通信。

shared 选项限制与同一 VRF 或共享 VRF 中的主机通信。

该值是选项列表，private 和 public 互斥，但都可以与 shared 一起使用。

APIC 在创建期间未设置时，默认使用 private。

选项

  • "private"

  • "public"

  • "shared"

state

字符串

使用 present 或 absent 添加或删除。

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

选项

  • "absent"

  • "present" ← (默认)

  • "query"

subnet_control

字符串

确定子网的控制状态。

querier_ip 选项用于将 gateway_ip 视为 IGMP 查询器源 IP。

nd_ra 选项用于将 gateway_ip 地址视为邻居发现路由器通告前缀。

no_gw 选项用于从网关地址删除默认网关功能。

APIC 在创建期间未设置时，默认使用 nd_ra。

选项

  • "nd_ra"

  • "no_gw"

  • "querier_ip"

  • "unspecified"

subnet_name

别名: name

字符串

子网的名称。

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

注释

注意

  • gateway 参数是用于访问子网的根键（而不是名称），因此当状态为 absent 或 present 时，需要 gateway。

  • 在您的 playbook 中使用此模块之前，必须先存在所使用的 tenant 和 bd。可以使用 cisco.aci.aci_tenant 模块和 cisco.aci.aci_bd 来实现这些操作。

另请参阅

另请参阅

cisco.aci.aci_bd

管理桥接域 (BD) 对象 (fv:BD)。

cisco.aci.aci_tenant

管理租户 (fv:Tenant)。

APIC 管理信息模型参考

有关内部 APIC 类 fv:Subnet 的更多信息。

Cisco ACI 指南

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

开发 Cisco ACI 模块

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

示例

- name: Create a tenant
  cisco.aci.aci_tenant:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    state: present
  delegate_to: localhost

- name: Create a bridge domain
  cisco.aci.aci_bd:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    bd: database
    state: present
  delegate_to: localhost

- name: Create a subnet
  cisco.aci.aci_bd_subnet:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    bd: database
    gateway: 10.1.1.1
    mask: 24
    state: present
  delegate_to: localhost

- name: Create a subnet with options
  cisco.aci.aci_bd_subnet:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    bd: database
    subnet_name: sql
    gateway: 10.1.2.1
    mask: 23
    description: SQL Servers
    scope: public
    route_profile_l3_out: corp
    route_profile: corp_route_profile
    state: present
  delegate_to: localhost

- name: Update a subnets scope to private and shared
  cisco.aci.aci_bd_subnet:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    bd: database
    gateway: 10.1.1.1
    mask: 24
    scope: [private, shared]
    state: present
  delegate_to: localhost

- name: Get all subnets
  cisco.aci.aci_bd_subnet:
    host: apic
    username: admin
    password: SomeSecretPassword
    state: query
  delegate_to: localhost

- name: Get all subnets of specific gateway in specified tenant
  cisco.aci.aci_bd_subnet:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    gateway: 10.1.1.1
    mask: 24
    state: query
  delegate_to: localhost
  register: query_result

- name: Get specific subnet
  cisco.aci.aci_bd_subnet:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    bd: database
    gateway: 10.1.1.1
    mask: 24
    state: query
  delegate_to: localhost
  register: query_result

- name: Delete a subnet
  cisco.aci.aci_bd_subnet:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    bd: database
    gateway: 10.1.1.1
    mask: 24
    state: absent
  delegate_to: localhost

返回值

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

键

描述

current

列表 / 元素=字符串

模块完成后来自 APIC 的现有配置

返回: 成功

示例: [{"fvTenant": {"attributes": {"descr": "生产环境", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]

error

字典

从 APIC 返回的错误信息

返回: 失败

示例: {"code": "122", "text": "未知管理对象类 foo"}

filter_string

字符串

用于请求的筛选字符串

返回: 失败或调试

示例: "?rsp-prop-include=config-only"

method

字符串

用于向 APIC 发出请求的 HTTP 方法

返回: 失败或调试

示例: "POST"

previous

列表 / 元素=字符串

模块启动前来自 APIC 的原始配置

返回: 信息

示例: [{"fvTenant": {"attributes": {"descr": "生产", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]

proposed

字典

从用户提供的参数组装的配置

返回: 信息

示例: {"fvTenant": {"attributes": {"descr": "生产环境", "name": "production"}}}

raw

字符串

APIC REST API 返回的原始输出（xml 或 json）

返回: 解析错误

示例: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><imdata totalCount=\"1\"><error code=\"122\" text=\"未知管理对象类 foo\"/></imdata>"

response

字符串

来自 APIC 的 HTTP 响应

返回: 失败或调试

示例: "OK (30 字节)"

sent

列表 / 元素=字符串

推送到 APIC 的实际/最小配置

返回: 信息

示例: {"fvTenant": {"attributes": {"descr": "生产环境"}}}

status

整数

来自 APIC 的 HTTP 状态

返回: 失败或调试

示例: 200

url

字符串

用于向 APIC 发出请求的 HTTP url

返回: 失败或调试

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

作者

  • Jacob McGill (@jmcgill298)