cisco.aci.aci_node_block 模块 – 管理节点块 (infra:NodeBlk)

注意

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

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

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

要在 playbook 中使用它，请指定：cisco.aci.aci_node_block。

概要

  • 管理 Cisco ACI 交换结构上的节点块。

  • 节点块是一系列节点。每个节点块都以第一个端口开始，以最后一个端口结束。

参数

参数

注释

access_port_selector

别名：access_port_selector_name, port_selector, port_selector_name

字符串

交换结构访问策略叶/脊交换机端口选择器的名称。

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

description

别名：node_block_description

字符串

节点块的描述。

from_port

别名：from, from_port_range

字符串

节点块的端口范围块的起始位置。

host

别名：hostname

字符串

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

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

node_block

别名：node_block_name, name

字符串

节点块的名称。

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

端口

整数

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

switch_profile

别名：leaf_profile_name, leaf_profile, switch_profile_name, spine_switch_profile, spine_switch_profile_name

字符串

Fabric 访问策略叶/脊交换机配置文件的名称。

超时

整数

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

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

默认值为 30。

to_port

别名：to, to_port_range

字符串

节点块的端口范围块的末尾。

type_node

别名：type

字符串

要在各自的接入端口下创建的节点块的类型。

选项

  • "leaf"

  • "spine"

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

注释

注意

另请参阅

另请参阅

cisco.aci.aci_switch_policy_leaf_profile

管理交换机策略叶配置文件 (infra:NodeP)。

cisco.aci.aci_switch_leaf_selector

将叶选择器绑定到交换机策略叶配置文件 (infra:LeafS, infra:NodeBlk 和 infra:RsAccNodePGrp)。

cisco.aci.aci_access_spine_switch_profile

管理 Fabric 访问脊交换机配置文件 (infra:SpineP)。

cisco.aci.aci_access_spine_switch_selector

管理 Fabric 访问策略脊交换机端口选择器 (infra:SpineS)。

APIC 管理信息模型参考

有关内部 APIC 类 infra:NodeBlk 的更多信息。

Cisco ACI 指南

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

开发 Cisco ACI 模块

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

示例

- name: Add a new Node Block associated to a switch policy leaf profile selector
  cisco.aci.aci_node_block:
    host: apic
    username: admin
    password: SomeSecretPassword
    switch_profile: my_leaf_switch_profile
    access_port_selector: my_leaf_switch_selector
    node_block: my_node_block
    from_port: 1011
    to_port: 1011
    type_node: leaf
    state: present
  delegate_to: localhost

- name: Add a new Node Block associated to a switch policy spine profile selector
  cisco.aci.aci_node_block:
    host: apic
    username: admin
    password: SomeSecretPassword
    switch_profile: my_spine_switch_profile
    access_port_selector: my_spine_switch_selector
    node_block: my_node_block
    from_port: 1012
    to_port: 1012
    type_node: spine
    state: present
  delegate_to: localhost

- name: Query a Node Block associated to a switch policy leaf profile selector
  cisco.aci.aci_node_block:
    host: apic
    username: admin
    password: SomeSecretPassword
    switch_profile: my_leaf_switch_profile
    access_port_selector: my_leaf_switch_selector
    node_block: my_node_block
    state: query
  delegate_to: localhost
  register: query_result

- name: Query all Node Blocks under the switch policy leaf profile selector
  cisco.aci.aci_node_block:
    host: apic
    username: admin
    password: SomeSecretPassword
    switch_profile: my_leaf_switch_profile
    access_port_selector: my_leaf_switch_selector
    state: query
  delegate_to: localhost
  register: query_result

- name: Query all Node Blocks
  cisco.aci.aci_node_block:
    host: apic
    username: admin
    password: SomeSecretPassword
    state: query
  delegate_to: localhost
  register: query_result

- name: Remove a Node Block associated to a switch policy leaf profile selector
  cisco.aci.aci_node_block:
    host: apic
    username: admin
    password: SomeSecretPassword
    switch_profile: my_leaf_switch_profile
    access_port_selector: my_leaf_switch_selector
    node_block: my_node_block
    type_node: leaf
    state: absent
  delegate_to: localhost

返回值

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

键

描述

current

列表 / 元素=字符串

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

返回：成功

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

错误

字典

从 APIC 返回的错误信息

返回：失败

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

filter_string

字符串

用于请求的筛选字符串

返回：失败或调试

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

方法

字符串

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

返回：失败或调试

示例： "POST"

previous

列表 / 元素=字符串

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

返回：信息

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

已提议的

字典

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

返回：信息

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

原始数据

字符串

APIC REST API 返回的原始输出 (xml 或 json)

返回： 解析错误

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

响应

字符串

来自 APIC 的 HTTP 响应

返回：失败或调试

示例： "OK (30 字节)"

已发送

列表 / 元素=字符串

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

返回：信息

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

状态

整数

来自 APIC 的 HTTP 状态

返回：失败或调试

示例： 200

URL

字符串

用于向 APIC 发送请求的 HTTP URL

返回：失败或调试

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

作者

  • Gaspard Micol (@gmicol)