netapp.ontap.na_ontap_net_vlan 模块 – NetApp ONTAP 网络 VLAN

注意

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

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

要安装它，请使用：ansible-galaxy collection install netapp.ontap。您需要其他要求才能使用此模块，有关详细信息，请参见 要求。

要在剧本中使用它，请指定：netapp.ontap.na_ontap_net_vlan。

netapp.ontap 2.6.0 中的新增功能

概要

  • 创建/修改/删除网络 VLAN

  • 仅当使用 REST 时才支持修改 VLAN

  • broadcast_domain、ipspace 和 enabled 密钥支持 REST，并在使用 ZAPI 时被忽略

要求

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

  • 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 或更高版本。

参数

参数

注释

broadcast_domain

字符串

netapp.ontap 21.13.0 中新增

指定 broadcast_domain 名称。

仅支持 REST，在使用 ZAPI 时被忽略。

在 9.6 和 9.7 中是必需的，但在 9.8 或更高版本中是可选的。

cert_filepath

字符串

netapp.ontap 20.6.0 中新增

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

python 2.6 不支持。

enabled

布尔值

netapp.ontap 21.13.0 中新增

启用/禁用 Net VLAN。

仅支持 REST，在使用 ZAPI 时被忽略。

选项

  • false

  • true

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 时被忽略。

hostname

字符串 / 必需

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

http_port

整数

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

https

布尔值

启用和禁用 https。

使用 REST 时被忽略，因为只支持 https。

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

选项

  • false ← (默认)

  • true

ipspace

字符串

netapp.ontap 21.13.0 中新增

指定广播域的 ipspace。

仅支持 REST，在使用 ZAPI 时被忽略。

在 9.6 和 9.7 中是必需的，但在 9.8 或更高版本中是可选的。

key_filepath

字符串

netapp.ontap 20.6.0 中新增

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

node

字符串 / 必需

VLAN 接口的节点名称。

ontapi

整数

要使用的 ontap api 版本

parent_interface

字符串 / 必需

承载 VLAN 接口的接口。

password

别名：pass

字符串

指定用户的密码。

state

字符串

指定的网络 VLAN 是否应该存在

选项

  • "present" ← (默认)

  • "absent"

use_rest

字符串

是否使用 REST 或 ZAPI。

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

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

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 ← (默认)

vlanid

整数 / 必填

VLAN ID。取值范围为 1 到 4094。

备注

注意

  • 已移除 interface_name 选项，应将其从 playbook 中删除。

  • 以 na_ontap 为前缀的模块构建用于支持 ONTAP 存储平台。

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

示例

- name: create VLAN
  netapp.ontap.na_ontap_net_vlan:
    state: present
    vlanid: 13
    node: "{{ vlan_node }}"
    ipspace: "{{ ipspace_name }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    hostname: "{{ netapp_hostname }}"

- name: Create and add vlan to broadcast domain - REST
  netapp.ontap.na_ontap_net_vlan:
    state: present
    vlanid: 14
    node: "{{ vlan_node }}"
    parent_interface: "{{ vlan_parent_interface_name }}"
    broadcast_domain: "{{ broadcast_domain_name }}"
    ipspace: "{{ ipspace_name }}"
    enabled: true
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    hostname: "{{ netapp_hostname }}"

- name: Disable VLAN - REST
  netapp.ontap.na_ontap_net_vlan:
    state: present
    vlanid: 14
    node: "{{ vlan_node }}"
    parent_interface: "{{ vlan_parent_interface_name }}"
    enabled: false
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    hostname: "{{ netapp_hostname }}"

- name: Delete VLAN
  netapp.ontap.na_ontap_net_vlan:
    state: absent
    vlanid: 14
    node: "{{ vlan_node }}"
    parent_interface: "{{ vlan_parent_interface_name }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    hostname: "{{ netapp_hostname }}"

作者

  • NetApp Ansible 团队 (@carchi8py)