cisco.aci.aci_l3out_static_routes_nexthop 模块 – 管理静态路由的下一跳 (ip:NexthopP)

注意

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

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

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

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

概要 

管理静态路由的下一跳。

参数 

参数	注释
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` 的值代替。
host 别名: hostname 字符串	Ansible 控制主机可解析的 APIC 的 IP 地址或主机名。如果任务中未指定该值，则将使用环境变量 `ACI_HOST` 的值代替。
l3out 别名: l3out_name 字符串	现有 L3Out 的名称。
nexthop 字符串	前缀的下一跳
node_id 整数	现有 nodeId。
node_profile 别名: node_profile_name, logical_node 字符串	节点配置文件的名称。
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` 的值代替。
pod_id 整数	现有 podId。
port 整数	用于 REST 连接的端口号。默认值取决于参数 `use_ssl`。如果任务中未指定该值，则将使用环境变量 `ACI_PORT` 的值代替。
prefix 别名: route 字符串	IP 前缀
private_key 别名: cert_key 字符串	用于基于签名身份验证的 PEM 格式的私钥文件或私钥内容。此值还会影响使用的默认 `certificate_name`。此选项与 `password` 互斥。如果也提供了 `password`，则将忽略它。如果任务中未指定该值，则将使用环境变量 `ACI_PRIVATE_KEY` 或 `ANSIBLE_NET_SSH_KEYFILE` 的值代替。
state 字符串	使用 `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`
tenant 别名: tenant_name 字符串	现有租户的名称。
超时整数	套接字级别的超时时间（以秒为单位）。如果任务中未指定该值，则将使用环境变量 `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`

参见 

另请参阅

aci_l3out: 关于 aci_l3out 模块的官方文档。
aci_l3out_logical_node_profile: 关于 aci_l3out_logical_node_profile 模块的官方文档。
aci_l3out_logical_node_profile_to_node: 关于 aci_l3out_logical_node_profile_to_node 模块的官方文档。
aci_l3out_static_routes: 关于 aci_l3out_static_routes 模块的官方文档。
APIC 管理信息模型参考: 有关内部 APIC 类 ip:NexthopP 的更多信息
Cisco ACI 指南: 有关如何使用 Ansible 管理 ACI 基础架构的详细信息。
开发 Cisco ACI 模块: 有关如何编写自己的 Cisco ACI 模块以进行贡献的详细指南。

示例 

- name: Add a new nexthop to a prefix
  cisco.aci.aci_l3out_static_routes_nexthop:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: my_tenant
    l3out: my_l3out
    node_profile: my_node_profile
    pod_id: 1
    node_id: 111
    prefix: 10.84.90.0/24
    nexthop: 10.1.1.1
    state: present
  delegate_to: localhost

- name: Delete a nexthop from a prefix
  cisco.aci.aci_l3out_static_routes_nexthop:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: my_tenant
    l3out: my_l3out
    node_profile: my_node_profile
    pod_id: 1
    node_id: 111
    prefix: 10.84.90.0/24
    nexthop: 10.1.1.1
    state: absent
  delegate_to: localhost

- name: Query a nexthop
  cisco.aci.aci_l3out_static_routes_nexthop:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: my_tenant
    l3out: my_l3out
    node_profile: my_node_profile
    pod_id: 1
    node_id: 111
    prefix: 10.84.90.0/24
    nexthop: 10.1.1.1
    state: query
  delegate_to: localhost
  register: query_result

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

返回值 

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

键	描述
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=\"unknown managed object class 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"`

作者

Marcel Zehnder (@maercu)