netapp.ontap.na_ontap_interface 模块 – NetApp ONTAP LIF 配置

注意

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

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

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

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

netapp.ontap 2.6.0 中的新增功能

概要

  • 创建/删除和修改 LIF。

要求

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

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

  • Python 3 - 建议使用 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 或更高版本。

参数

参数

注释

address

字符串

指定 LIF 的 IP 地址。

ZAPI - 当 state=present 且 is_ipv4_link_local 为 false 且 subnet_name 未设置时，这是必需的。

REST - 当 state=present 且 interface_type 为 IP 时，这是必需的。

admin_status

字符串

指定 LIF 的管理状态。

选项

  • "up"

  • "down"

broadcast_domain

字符串

netapp.ontap 21.21.0 中新增

可以使用 broadcast_domain 名称来使用 REST 指定 IP 接口上的位置，作为节点或端口的替代方案。

仅在创建 IP 接口以选择节点时使用，如果接口已存在则忽略。

如果找不到广播域，请确保检查 ipspace 值。

home_port 和 broadcast_domain 是互斥的。home_node 可能会出现也可能不会出现。

不支持 FC 接口。

使用 ZAPI 时忽略。

cert_filepath

字符串

netapp.ontap 20.6.0 中新增

SSL 客户端证书文件（.pem）的路径。

不支持 python 2.6。

current_node

字符串

指定 LIF 的当前节点。

默认情况下，这是 home_node

current_port

字符串

指定 LIF 的当前端口。

data_protocol

字符串

为其配置 FC 接口的数据协议。

使用 ZAPI 或 IP 接口时忽略。

创建 FC 类型接口是必需的。

选项

  • "fcp"

  • "fc_nvme"

dns_domain_name

字符串

netapp.ontap 2.9.0 中新增

指定此 LIF 的 DNS 区域的唯一完全限定域名。

在 REST 中从 ONTAP 9.9.0 或更高版本支持。

不支持 FC 接口。

fail_if_subnet_conflicts

布尔值

netapp.ontap 22.2.0 中新增

如果指定的 IP 地址落在命名子网的地址范围内，则创建或更新 IP 接口将失败。

将此值设置为 false 以使用指定的 IP 地址并将拥有该地址的子网分配给接口。

此选项仅在 REST 中受支持，并且需要 ONTAP 9.11.1 或更高版本。

选项

  • false

  • true

failover_group

字符串

netapp.ontap 20.1.0 中新增

指定 LIF 的故障转移组。

不支持 REST。

failover_policy

字符串

指定 LIF 的故障转移策略。

使用 REST 时，这些值将映射到“home_port_only”、“default”、“home_node_only”、“sfo_partners_only”、“broadcast_domain_only”。

选项

  • "disabled"

  • "system-defined"

  • "local-only"

  • "sfo-partner-only"

  • "broadcast-domain-wide"

failover_scope

字符串

netapp.ontap 21.13.0 中新增

指定 LIF 的故障转移范围。

仅限 REST，且仅限于 IP 接口。不支持 FC 接口。

选项

  • "home_port_only"

  • "default"

  • "home_node_only"

  • "sfo_partners_only"

  • "broadcast_domain_only"

feature_flags

字典

netapp.ontap 20.5.0 中新增

启用或禁用新功能。

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

支持的键和值可能会随时更改，恕不另行通知。未知键将被忽略。

firewall_policy

字符串

指定 LIF 的防火墙策略。

此选项在 REST 中已弃用。

使用 REST 时，模块尝试导出 service_policy 并可能出错。

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

force_subnet_association

布尔值

netapp.ontap 2.9.0 中新增

将其设置为true以从指定的子网获取地址并将子网分配给LIF。

REST不支持。

选项

  • false

  • true

from_name

字符串

在netapp.ontap 21.11.0中添加

要重命名的接口名称

home_node

字符串

指定LIF的主节点。

默认情况下，集群中的第一个节点被视为主节点。

home_port

字符串

指定LIF的主端口。

使用REST时，需要ONTAP 9.8或更高版本以及FC接口。

使用REST时，创建IP接口至少需要home_port、home_node或broadcast_domain之一。

使用REST时，创建FC接口需要home_port或current_port之一。

使用ZAPI时，创建IP和FC接口都需要home_port。

home_port和broadcast_domain互斥（REST和IP接口）。

hostname

字符串 / 必需

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

http_port

整数

使用此端口覆盖默认端口（80或443）。

https

布尔值

启用和禁用https。

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

使用SSL证书认证时忽略，因为它需要SSL。

选项

  • false ← (默认)

  • true

ignore_zapi_options

列表 / 元素=字符串

netapp.ontap 21.13.0 中新增

忽略不应相关的不支持的选项。

使用 ZAPI 时忽略。

选项

  • "failover_group"

  • "force_subnet_association" ← (默认)

  • "listen_for_dns_query"

默认： ["force_subnet_association"]

interface_name

字符串 / 必需

指定逻辑接口（LIF）名称。

interface_type

字符串

netapp.ontap 21.13.0 中新增

接口类型。

如果存在地址或网络掩码，则假定为IP。

IP接口包括集群、集群间、管理以及NFS、CIFS、iSCSI接口。

FC接口包括FCP和NVME-FC接口。

使用 ZAPI 时忽略。

REST必需，但可能源自已弃用的选项，例如role、protocols和firewall_policy。

选项

  • "fc"

  • "ip"

ipspace

字符串

netapp.ontap 21.13.0 中新增

对于集群范围的接口，REST需要IP空间名称。对于SVM范围，它是可选的。

使用 ZAPI 时忽略。

对于FC接口忽略。

is_auto_revert

布尔值

如果为true，则数据LIF会在某些情况下（例如启动）恢复到其主节点，

并且负载均衡迁移功能会自动禁用。

选项

  • false

  • true

is_dns_update_enabled

布尔值

netapp.ontap 2.9.0 中新增

指定是否为此LIF启用DNS更新。如果在Vserver级别启用了更新，则会为此LIF发送动态更新。

REST中从ONTAP 9.9.1或更高版本开始支持。

不支持 FC 接口。

选项

  • false

  • true

布尔值

netapp.ontap 20.1.0 中新增

指定LIF是否要获取ipv4链路本地地址。

此用例是在创建集群LIF时允许自动分配ipv4链路本地地址。

REST中不支持。

选项

  • false

  • true

key_filepath

字符串

netapp.ontap 20.6.0 中新增

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

listen_for_dns_query

布尔值

netapp.ontap 2.9.0 中新增

如果为True，则此IP地址将侦听为指定的dnszone进行的DNS查询。

不支持 REST。

选项

  • false

  • true

netmask

字符串

指定LIF的网络掩码。

ZAPI - 当 state=present 且 is_ipv4_link_local 为 false 且 subnet_name 未设置时，这是必需的。

REST - 当 state=present 且 interface_type 为 IP 时，这是必需的。

ontapi

整数

要使用的ontap api版本

password

别名：pass

字符串

指定用户的密码。

probe_port

整数

在netapp.ontap 22.1.0中添加

云负载均衡器的探测端口 - 仅在Azure环境中有效。

ZAPI或FC接口不支持。

需要ONTAP 9.10.1或更高版本。

protocols

列表 / 元素=字符串

指定在LIF上配置的数据协议列表。默认情况下，此元素中的值为nfs、cifs和fcache。

其他支持的协议为iscsi和fcp。通过指定“none”，可以将LIF配置为不支持任何数据协议。

none、iscsi、fc-nvme或fcp的协议值不能与任何其他数据协议组合。

对于“fc-nvme”选项，不支持address、netmask和firewall_policy参数。

此选项在REST中被忽略，尽管它可以用于派生interface_type或data_protocol。

role

字符串

指定LIF的角色。

将角色设置为“intercluster”或“cluster”时，不支持设置协议。

创建“cluster”角色时，节点名称将显示为LIF名称的前缀。

例如，如果指定的名称为clif，节点名称为node1，则LIF名称在ONTAP中显示为node1_clif。

可能的值为“undef”、“cluster”、“data”、“node-mgmt”、“intercluster”、“cluster-mgmt”。

当state=present时需要，除非存在service_policy且ONTAP版本为9.8或更高。

此选项在 REST 中已弃用。

使用 REST 时，模块尝试导出 service_policy 并可能出错。

service_policy

字符串

在netapp.ontap 20.4.0中添加

从ONTAP 9.5开始，您可以配置LIF服务策略以标识将使用LIF的单个服务或服务列表。

在ONTAP 9.5中，您只能为admin SVM中的LIF分配服务策略。

在ONTAP 9.6中，您还可以为数据SVM中的LIF分配服务策略。

为LIF指定服务策略时，无需为LIF指定数据协议和角色。

请注意，由于ZAPI问题，仍然需要角色。此限制在ONTAP 9.8中已移除。

还支持通过指定角色和数据协议来创建LIF。

state

字符串

指定的接口是否存在。

选项

  • "present" ← (默认)

  • "absent"

subnet_name

字符串

在netapp.ontap 2.8.0中添加

从中分配IP接口地址的子网。

如果未使用此选项，则需要提供IP地址和网络掩码。

使用REST时，需要ONTAP 9.11.1或更高版本。

使用REST时，必须设置ipspace。

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

vserver

字符串

要使用的vserver的名称。

ZAPI必需。

REST必需（用于FC接口（数据vserver））。

REST必需（用于SVM范围的IP接口（数据vserver））。

对于集群范围的IP接口，REST无效。

为了帮助从ZAPI过渡到REST，当角色设置为“cluster”、“node-mgmt”、“intercluster”、“cluster-mgmt”时，将忽略vserver。

删除此选项可抑制警告。

注释

注意

  • REST支持需要ONTAP 9.7或更高版本。

  • 支持check_mode。

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

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

示例

- name: Create interface - ZAPI
  netapp.ontap.na_ontap_interface:
    state: present
    interface_name: data2
    home_port: e0d
    home_node: laurentn-vsim1
    role: data
    protocols:
      - nfs
      - cifs
    admin_status: up
    failover_policy: local-only
    firewall_policy: mgmt
    is_auto_revert: true
    address: 10.10.10.10
    netmask: 255.255.255.0
    force_subnet_association: false
    dns_domain_name: test.com
    listen_for_dns_query: true
    is_dns_update_enabled: true
    vserver: svm1
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

- name: Create data interface - REST - NAS
  netapp.ontap.na_ontap_interface:
    state: present
    interface_name: data2
    home_port: e0d
    home_node: laurentn-vsim1
    admin_status: up
    failover_scope: home_node_only
    service_policy: default-data-files
    is_auto_revert: true
    interface_type: ip
    address: 10.10.10.10
    netmask: 255.255.255.0
    vserver: svm1
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

- name: Create cluster interface - ZAPI
  netapp.ontap.na_ontap_interface:
    state: present
    interface_name: cluster_lif
    home_port: e0a
    home_node: cluster1-01
    role: cluster
    admin_status: up
    is_auto_revert: true
    is_ipv4_link_local: true
    vserver: Cluster
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

- name: Create cluster interface - REST
  netapp.ontap.na_ontap_interface:
    state: present
    interface_name: cluster_lif
    home_port: e0a
    home_node: cluster1-01
    service_policy: default-cluster
    admin_status: up
    is_auto_revert: true
    vserver: Cluster
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

- name: Rename interface
  netapp.ontap.na_ontap_interface:
    state: present
    from_name: ansibleSVM_lif
    interface_name: ansibleSVM_lif01
    vserver: ansibleSVM
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

- name: Migrate an interface
  netapp.ontap.na_ontap_interface:
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    vserver: ansible
    https: true
    validate_certs: false
    state: present
    interface_name: carchi_interface3
    home_port: e0d
    home_node: ansdev-stor-1
    current_node: ansdev-stor-2
    role: data
    failover_policy: local-only
    firewall_policy: mgmt
    is_auto_revert: true
    address: 10.10.10.12
    netmask: 255.255.255.0
    force_subnet_association: false
    admin_status: up

- name: Delete interface
  netapp.ontap.na_ontap_interface:
    state: absent
    interface_name: data2
    vserver: svm1
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

作者

  • NetApp Ansible团队 (@carchi8py)