netapp.ontap.na_ontap_ports 模块 – 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_ports

netapp.ontap 2.9.0 中的新增功能

概要

  • 为广播域和端口集添加或删除端口。

要求

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

  • 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。

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

字符串

指定广播域所需的 ipspace。

域 ipspace 在创建域后无法修改。

key_filepath

字符串

在 netapp.ontap 20.6.0 中添加

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

names

列表 / elements=字符串 / 必需

端口列表。

ontapi

整数

要使用的 ontap api 版本

password

别名: pass

字符串

指定用户的密码。

portset_type

字符串

端口集接受的协议。

选项

  • "fcp"

  • "iscsi"

  • "mixed"

resource_name

字符串 / 必需

端口集或广播域的名称。

resource_type

字符串 / 必需

要添加端口或从中删除端口的资源类型。

在端口集中添加或删除端口需要 REST 中的 ONTAP 版本 9.9 或更高版本

选项

  • "broadcast_domain"

  • "portset"

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

字符串

SVM 的名称。

在端口集上操作时指定此选项。

注释

注意

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

  • 默认启用并推荐使用 https。 要在集群上启用 http,您必须运行以下命令 'set -privilege advanced;' 'system services web modify -http-enabled true;'

示例

- name: broadcast domain remove port
  tags:
  - remove
  netapp.ontap.na_ontap_ports:
    state: absent
    names: test-vsim1:e0d-1,test-vsim1:e0d-2
    resource_type: broadcast_domain
    resource_name: ansible_domain
    hostname: "{{ hostname }}"
    username: user
    password: password
    https: False

- name: broadcast domain add port
  tags:
  - add
  netapp.ontap.na_ontap_ports:
    state: present
    names: test-vsim1:e0d-1,test-vsim1:e0d-2
    resource_type: broadcast_domain
    resource_name: ansible_domain
    ipspace: Default
    hostname: "{{ hostname }}"
    username: user
    password: password
    https: False

- name: portset remove port
  tags:
  - remove
  netapp.ontap.na_ontap_ports:
    state: absent
    names: lif_2
    resource_type: portset
    resource_name: portset_1
    vserver: "{{ vserver }}"
    hostname: "{{ hostname }}"
    username: user
    password: password
    https: False

- name: portset add port
  tags:
  - add
  netapp.ontap.na_ontap_ports:
    state: present
    names: lif_2
    resource_type: portset
    resource_name: portset_1
    portset_type: iscsi
    vserver: "{{ vserver }}"
    hostname: "{{ hostname }}"
    username: user
    password: password
    https: False

作者

  • NetApp Ansible 团队 (@carchi8py)