netapp.ontap.na_ontap_net_routes 模块 – NetApp ONTAP 网络路由

注意

此模块是 netapp.ontap 集合 (版本 22.13.0) 的一部分。

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

要安装它,请使用:ansible-galaxy collection install netapp.ontap。您需要进一步的要求才能使用此模块,请参阅 要求 了解详细信息。

要在 playbook 中使用它,请指定:netapp.ontap.na_ontap_net_routes

netapp.ontap 2.6.0 中的新功能

概要

  • 修改 ONTAP 网络路由。

要求

执行此模块的主机需要以下要求。

  • Ansible 2.9 或更高版本 - 建议使用 2.12 或更高版本。

  • Python3 - 建议使用 3.9 或更高版本。

  • 使用 ZAPI 时,强烈建议使用 netapp-lib 2018.11.13 或更高版本(使用“pip install netapp-lib”安装),netapp-lib 2020.3.12,因为它为连接问题提供了更好的错误报告。

  • 物理或虚拟集群 Data ONTAP 系统,这些模块支持 Data ONTAP 9.1 及更高版本,REST 支持需要 ONTAP 9.6 或更高版本。

参数

参数

注释

cert_filepath

字符串

在 netapp.ontap 20.6.0 中添加

SSL 客户端证书文件 (.pem) 的路径。

不支持 python 2.6。

destination

字符串 / 必需

指定路由目标。

示例 10.7.125.5/20、fd20:13::/64。

feature_flags

字典

在 netapp.ontap 20.5.0 中添加

启用或禁用新功能。

这可以用来启用实验性功能或禁用破坏向后兼容性的新功能。

支持的键和值可能会在没有通知的情况下发生更改。 未知的键将被忽略。

force_ontap_version

字符串

在 netapp.ontap 21.23.0 中添加

在使用 REST 时覆盖集群 ONTAP 版本。

如果版本与目标集群不匹配,则行为未定义。

当由于权限问题而无法读取集群版本时,这可作为一种解决方法。 请参阅 https://github.com/ansible-collections/netapp.ontap/wiki/Known-issues

这应采用 9.10 或 9.10.1 的形式,其中每个元素都是整数。

use_rest 设置为 auto 时,这可能会强制根据版本和平台功能切换到 ZAPI。

使用 ZAPI 时忽略。

from_destination

字符串

在 netapp.ontap 2.8.0 中添加

指定应更改的路由目标。

from_gateway

字符串

在 netapp.ontap 2.8.0 中添加

指定应更改的路由网关。

from_metric

整数

在 netapp.ontap 2.8.0 中添加

指定应更改的路由度量。

此参数将被忽略,因为该值是从 ONTAP 读取的。

不支持 REST,使用 ZAPI 时忽略。

gateway

字符串 / 必需

指定路由网关。

示例 10.7.125.1、fd20:13::1。

hostname

字符串 / 必需

ONTAP 实例的主机名或 IP 地址。

http_port

整数

使用此端口覆盖默认端口(80 或 443)

https

布尔值

启用和禁用 https。

使用 REST 时忽略,因为仅支持 https。

使用 SSL 证书身份验证时忽略,因为它需要 SSL。

选项

  • false ← (默认)

  • true

key_filepath

字符串

在 netapp.ontap 20.6.0 中添加

SSL 客户端密钥文件的路径。

metric

整数

指定路由度量。 如果未提供此字段,则 ONTAP 将默认为 20。

REST 中从 ONTAP 9.11.0 开始支持。

使用 REST,尝试修改目标或网关也会在 ONTAP 9.10.1 或更早版本中将度量重置为 20。

ontapi

整数

要使用的 ontap api 版本

password

别名:pass

字符串

指定用户的密码。

state

字符串

您是否要创建或删除网络路由。

选项

  • "present" ← (默认)

  • "absent"

use_rest

字符串

是否使用 REST 或 ZAPI。

always – 如果模块支持 REST,则始终使用 REST API。如果模块不支持 REST,则会发出警告。如果 REST 中不支持模块选项,则会发出错误。

never – 如果模块支持 ZAPI,则始终使用 ZAPI。如果 ZAPI 中不支持 REST 选项,则可能会发出错误。

auto – 如果模块支持 REST 并且支持模块选项,则会尝试使用 REST API。否则会恢复为 ZAPI。

默认: "auto"

username

别名:user

字符串

这可以是集群范围或 SVM 范围的帐户,具体取决于是否需要集群级或 SVM 级 API。

欲了解更多信息,请阅读此文档:https://mysupport.netapp.com/NOW/download/software/nmsdk/9.4/

支持两种身份验证方法:

  1. 基本身份验证,使用用户名和密码;

  2. SSL 证书身份验证,使用 SSL 客户端证书文件,并可选择使用私钥文件。

要使用证书,必须先在 ONTAP 集群中安装证书,并且必须启用证书身份验证。

validate_certs

布尔值

如果设置为 no,则不会验证 SSL 证书。

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

选项

  • false

  • true ← (默认)

vserver

字符串

vserver 的名称。

使用 ZAPI 时为必填项。

使用 REST 时,对于集群范围的路由,请省略此参数,或将其设置为 NULL。

注释

注意

  • 前缀为 na_ontap 的模块旨在支持 ONTAP 存储平台。

  • 默认情况下启用 https,建议使用。 要在集群上启用 http,必须运行以下命令:‘set -privilege advanced;’ ‘system services web modify -http-enabled true;’

示例

- name: create route
  netapp.ontap.na_ontap_net_routes:
    state: present
    vserver: "{{ Vserver name }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    hostname: "{{ netapp_hostname }}"
    destination: 10.7.125.5/20
    gateway: 10.7.125.1
    metric: 30

- name: create route - cluster scope, using REST
  netapp.ontap.na_ontap_net_routes:
    state: present
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    hostname: "{{ netapp_hostname }}"
    destination: 10.7.125.5/20
    gateway: 10.7.125.1

- name: create route - vserver scope, using REST
  netapp.ontap.na_ontap_net_routes:
    state: present
    vserver: "{{ Vserver name }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    hostname: "{{ netapp_hostname }}"
    destination: 10.7.125.5/20
    gateway: 10.7.125.1

作者

  • NetApp Ansible 团队 (@carchi8py)