cisco.aci.aci_domain_to_vlan_pool 模块 – 将域绑定到 VLAN 池 (infra:RsVlanNs)

注意

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

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

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

要在剧本中使用它，请指定： cisco.aci.aci_domain_to_vlan_pool。

概要

  • 在 Cisco ACI 结构上将域绑定到 VLAN 池。

参数

参数

注释

annotation

字符串

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

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

domain

别名：domain_name, domain_profile

字符串

与 VLAN 池关联的域的名称。

domain_type

字符串 / 必填

确定域是物理域 (phys) 还是虚拟域 (vmm)。

选项

  • "fc"

  • "l2dom"

  • "l3dom"

  • "phys"

  • "vmm"

host

别名：hostname

字符串

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

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

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 的值。

pool

别名：pool_name, vlan_pool

字符串

池的名称。

pool_allocation_mode

别名：allocation_mode, mode

字符串 / 必填

用于将 VLAN 分配给资源的方法。

选项

  • "dynamic"

  • "static"

port

整数

用于 REST 连接的端口号。

默认值取决于参数 use_ssl。

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

private_key

别名：cert_key

字符串

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

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

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

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

状态

字符串

使用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

超时

整数

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

如果在任务中未指定值，则会改用环境变量ACI_TIMEOUT的值。

默认值为30。

use_proxy

布尔值

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

如果在任务中未指定值，则会改用环境变量ACI_USE_PROXY的值。

默认值为true。

选项

  • false

  • true

use_ssl

布尔值

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

如果在任务中未指定值，则会改用环境变量ACI_USE_SSL的值。

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

选项

  • false

  • true

用户名

别名：user

字符串

用于身份验证的用户名。

如果在任务中未指定值，则会改用环境变量ACI_USERNAME或ANSIBLE_NET_USERNAME的值。

默认值为admin。

validate_certs

布尔值

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

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

如果在任务中未指定值，则会改用环境变量ACI_VALIDATE_CERTS的值。

默认值为true。

选项

  • false

  • true

vm_provider

字符串

VMM域的虚拟机平台。

在ACI v3.0中添加了对Kubernetes的支持。

在ACI v3.1中添加了对CloudFoundry、OpenShift和Red Hat的支持。

选项

  • “cloudfoundry”

  • “kubernetes”

  • “microsoft”

  • “openshift”

  • “openstack”

  • “redhat”

  • “vmware”

注释

注意

另请参阅

另请参阅

cisco.aci.aci_domain

管理物理、虚拟、桥接、路由或FC域配置文件 (phys:DomP, vmm:DomP, l2ext:DomP, l3ext:DomP和fc:DomP)。

cisco.aci.aci_vlan_pool

管理VLAN池 (fvns:VlanInstP)。

APIC管理信息模型参考

关于内部APIC类infra:RsVlanNs的更多信息。

Cisco ACI指南

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

开发Cisco ACI模块

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

示例

- name: Bind a VMM domain to VLAN pool
  cisco.aci.aci_domain_to_vlan_pool:
    host: apic
    username: admin
    password: SomeSecretPassword
    domain: vmw_dom
    domain_type: vmm
    pool: vmw_pool
    pool_allocation_mode: dynamic
    vm_provider: vmware
    state: present
  delegate_to: localhost

- name: Remove a VMM domain to VLAN pool binding
  cisco.aci.aci_domain_to_vlan_pool:
    host: apic
    username: admin
    password: SomeSecretPassword
    domain: vmw_dom
    domain_type: vmm
    pool: vmw_pool
    pool_allocation_mode: dynamic
    vm_provider: vmware
    state: absent
  delegate_to: localhost

- name: Bind a physical domain to VLAN pool
  cisco.aci.aci_domain_to_vlan_pool:
    host: apic
    username: admin
    password: SomeSecretPassword
    domain: phys_dom
    domain_type: phys
    pool: phys_pool
    pool_allocation_mode: static
    state: present
  delegate_to: localhost

- name: Bind a physical domain to VLAN pool
  cisco.aci.aci_domain_to_vlan_pool:
    host: apic
    username: admin
    password: SomeSecretPassword
    domain: phys_dom
    domain_type: phys
    pool: phys_pool
    pool_allocation_mode: static
    state: absent
  delegate_to: localhost

- name: Query an domain to VLAN pool binding
  cisco.aci.aci_domain_to_vlan_pool:
    host: apic
    username: admin
    password: SomeSecretPassword
    domain: phys_dom
    domain_type: phys
    pool: phys_pool
    pool_allocation_mode: static
    state: query
  delegate_to: localhost
  register: query_result

- name: Query all domain to VLAN pool bindings
  cisco.aci.aci_domain_to_vlan_pool:
    host: apic
    username: admin
    password: SomeSecretPassword
    domain_type: phys
    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"

作者

  • Dag Wieers (@dagwieers)