Модуль netapp.ontap.na_ontap_interface — настройка LIF в NetApp ONTAP

address

string

Задает IP-адрес LIF.

ZAPI — требуется, когда state=present и is_ipv4_link_local равно false, а subnet_name не задан.

REST — требуется, когда state=present и interface_type имеет значение IP.

admin_status

string

Задает административный статус LIF.

Варианты:

• "up"
• "down"

broadcast_domain

string

добавлено в netapp.ontap 21.21.0

Имя broadcast_domain можно использовать для указания местоположения IP-интерфейса в REST в качестве альтернативы node или port.

Используется только при создании IP-интерфейса для выбора узла; игнорируется, если интерфейс уже существует.

Если домен широковещания не найден, проверьте значение ipspace.

Параметры home_port и broadcast_domain являются взаимоисключающими. home_node может быть указан или отсутствовать.

Не поддерживается для интерфейса FC.

Игнорируется в ZAPI.

cert_filepath

string

добавлено в netapp.ontap 20.6.0

Путь к файлу сертификата клиента SSL (.pem).

Не поддерживается в Python 2.6.

current_node

string

Задает текущий узел LIF.

По умолчанию это home_node

current_port

string

Задает текущий порт LIF.

data_protocol

string

Протокол передачи данных, для которого настроен интерфейс FC.

Игнорируется в ZAPI или для IP-интерфейсов.

Требуется для создания интерфейса типа FC.

Варианты:

• "fcp"
• "fc_nvme"

dns_domain_name

string

добавлено в netapp.ontap 2.9.0

Задает уникальное полное доменное имя зоны DNS для этой LIF.

Поддерживается в REST начиная с ONTAP 9.9.0.

Не поддерживается для интерфейсов FC.

fail_if_subnet_conflicts

boolean

добавлено в netapp.ontap 22.2.0

Создание или обновление IP-интерфейса завершается ошибкой, если указанный IP-адрес попадает в диапазон адресов именованной подсети.

Установите для этого параметра значение false, чтобы использовать указанный IP-адрес и назначить интерфейсу подсеть, которой принадлежит этот адрес.

Этот параметр поддерживается только в REST и требует ONTAP 9.11.1 или более поздней версии.

Варианты:

• false
• true

failover_group

string

добавлено в netapp.ontap 20.1.0

Задает группу переключения при отказе для LIF.

Не поддерживается в REST.

failover_policy

string

Задает политику переключения при отказе для 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

string

добавлено в netapp.ontap 21.13.0

Задает область переключения при отказе для LIF.

Только REST и только для IP-интерфейсов. Не поддерживается для интерфейсов FC.

Варианты:

• "home_port_only"
• "default"
• "home_node_only"
• "sfo_partners_only"
• "broadcast_domain_only"

feature_flags

dictionary

добавлено в netapp.ontap 20.5.0

Включает или отключает новую функцию.

Можно использовать для включения экспериментальной функции или отключения новой функции, нарушающей обратную совместимость.

Поддерживаемые ключи и значения могут измениться без предварительного уведомления. Неизвестные ключи игнорируются.

firewall_policy

string

Задает политику брандмауэра для LIF.

Этот параметр устарел в REST.

В REST модуль пытается определить service_policy, что может привести к ошибке.

force_ontap_version

string

добавлено в netapp.ontap 21.23.0

Переопределяет версию ONTAP кластера при использовании REST.

Поведение не определено, если версия не соответствует целевому кластеру.

Этот параметр предназначен для обхода проблемы, возникающей, когда версию кластера невозможно прочитать из-за проблем с разрешениями. См. https://github.com/ansible-collections/netapp.ontap/wiki/Known-issues.

Значение должно иметь вид 9.10 или 9.10.1, где каждый компонент является целым числом.

Если для use_rest задано значение auto, это может привести к переключению на ZAPI в зависимости от версии и возможностей платформы.

Игнорируется в ZAPI.

force_subnet_association

boolean

добавлено в netapp.ontap 2.9.0

Установите значение true, чтобы получить адрес из указанной подсети и назначить эту подсеть LIF.

Не поддерживается в REST.

Варианты:

• false
• true

from_name

string

добавлено в netapp.ontap 21.11.0

Имя интерфейса, который нужно переименовать

home_node

string

Задает домашний узел LIF.

По умолчанию домашним узлом считается первый узел кластера.

home_port

string

Задает домашний порт LIF.

При использовании REST для интерфейсов FC требуется ONTAP 9.8 или более поздней версии.

В 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

string / обязательный

Имя хоста или IP-адрес экземпляра ONTAP.

http_port

integer

Заменяет порт по умолчанию (80 или 443) на этот порт

https

boolean

Включает и отключает HTTPS.

Игнорируется при использовании REST, поскольку поддерживается только HTTPS.

Игнорируется при использовании аутентификации с сертификатом SSL, поскольку для нее требуется SSL.

Варианты:

• false ← (по умолчанию)
• true

ignore_zapi_options

list / элементы=string

добавлено в netapp.ontap 21.13.0

Игнорирует неподдерживаемые параметры, которые не должны иметь значения.

Игнорируется в ZAPI.

Варианты:

• "failover_group"
• "force_subnet_association" ← (по умолчанию)
• "listen_for_dns_query"

По умолчанию: ["force_subnet_association"]

interface_name

string / обязательный

Задает имя логического интерфейса (LIF).

interface_type

string

добавлено в netapp.ontap 21.13.0

Тип интерфейса.

Если указаны address или netmask, предполагается тип IP.

К IP-интерфейсам относятся интерфейсы cluster, intercluster, management, а также NFS, CIFS и iSCSI.

К интерфейсам FC относятся интерфейсы FCP и NVME-FC.

Игнорируется в ZAPI.

Обязателен в REST, но может быть определен на основе устаревших параметров, таких как role, protocols и firewall_policy.

Варианты:

• "fc"
• "ip"

ipspace

string

добавлено в netapp.ontap 21.13.0

Для интерфейсов с областью действия кластера в REST требуется имя IPspace. Для области действия SVM оно необязательно.

Игнорируется в ZAPI.

Игнорируется для интерфейса FC.

is_auto_revert

boolean

Если значение равно true, LIF данных при определенных обстоятельствах, например при запуске, возвращается на домашний узел,

а возможность миграции для балансировки нагрузки автоматически отключается

Варианты:

• false
• true

is_dns_update_enabled

boolean

добавлено в netapp.ontap 2.9.0

Указывает, включено ли обновление DNS для этой LIF. Динамические обновления будут отправляться для этой LIF, если обновления включены на уровне Vserver.

Поддерживается в REST начиная с ONTAP 9.9.1.

Не поддерживается для интерфейсов FC.

Варианты:

• false
• true

is_ipv4_link_local

boolean

добавлено в netapp.ontap 20.1.0

Указывает, что LIF должны получить локальный IPv4-адрес канала.

Этот параметр используется при создании кластерных LIF для автоматического назначения локального IPv4-адреса канала.

Не поддерживается в REST.

Варианты:

• false
• true

key_filepath

string

добавлено в netapp.ontap 20.6.0

Путь к файлу ключа клиента SSL.

lambda_config

dictionary

добавлено в netapp.ontap 23.3.0

Параметры конфигурации функции прокси-сервера AWS Lambda.

Эти параметры и вложенные параметры поддерживаются только в REST.

aws_profile

string

Имя профиля AWS, используемого для аутентификации.

aws_region

string / обязательный

Имя региона AWS.

function_name

string / обязательный

Имя вызываемой функции AWS Lambda.

listen_for_dns_query

boolean

добавлено в netapp.ontap 2.9.0

Если значение равно True, этот IP-адрес будет прослушивать DNS-запросы для указанной dnszone.

Не поддерживается в REST.

Варианты:

• false
• true

netmask

string

Задает маску подсети LIF.

ZAPI — требуется, когда state=present и is_ipv4_link_local равно false, а subnet_name не задан.

REST — требуется, когда state=present и interface_type имеет значение IP.

ontapi

integer

Версия API ONTAP, которую следует использовать

password

псевдонимы: pass

string

Пароль указанного пользователя.

probe_port

integer

добавлено в netapp.ontap 22.1.0

Порт проверки для облачного балансировщика нагрузки — допустим только в среде Azure.

Не поддерживается в ZAPI или для интерфейсов FC.

Требуется ONTAP 9.10.1 или более поздней версии.

protocols

list / элементы=string

Задает список протоколов передачи данных, настроенных для LIF. По умолчанию значения этого элемента — nfs, cifs и fcache.

Также поддерживаются протоколы iscsi и fcp. Для LIF можно отключить поддержку всех протоколов передачи данных, указав ‘none’.

Значения протокола none, iscsi, fc-nvme или fcp нельзя сочетать с другими протоколами передачи данных.

Параметры address, netmask и firewall_policy не поддерживаются для варианта ‘fc-nvme’.

Этот параметр игнорируется в REST, однако его можно использовать для определения interface_type или data_protocol.

role

string

Задает роль LIF.

При указании роли “intercluster” или “cluster” задавать протокол нельзя.

При создании роли “cluster” имя узла будет использоваться в качестве префикса имени LIF.

Например, если указано имя clif, а имя узла — node1, в ONTAP имя LIF будет отображаться как node1_clif.

Возможные значения: ‘undef’, ‘cluster’, ‘data’, ‘node-mgmt’, ‘intercluster’, ‘cluster-mgmt’.

Требуется, когда state=present, если не задан service_policy и версия ONTAP не ниже 9.8.

Этот параметр устарел в REST.

В REST модуль пытается определить service_policy, что может привести к ошибке.

service_policy

string

добавлено в netapp.ontap 20.4.0

Начиная с ONTAP 9.5 можно настраивать политики обслуживания LIF, чтобы определять отдельную службу или список служб, использующих LIF.

В ONTAP 9.5 политики обслуживания можно назначать только LIF в административной SVM.

В ONTAP 9.6 политики обслуживания можно дополнительно назначать LIF в SVM данных.

При указании политики обслуживания для LIF указывать протокол передачи данных и роль LIF не требуется.

Обратите внимание: роль по-прежнему требуется из-за проблемы с ZAPI. Это ограничение устранено в ONTAP 9.8.

Также поддерживается создание LIF с указанием роли и протоколов передачи данных.

state

string

Должен ли указанный интерфейс существовать.

Варианты:

• "present" ← (по умолчанию)
• "absent"

subnet_name

string

добавлено в netapp.ontap 2.8.0

Подсеть, из которой выделяется адрес IP-интерфейса.

Если этот параметр не используется, необходимо указать IP-адрес и маску подсети.

Для REST требуется ONTAP 9.11.1 или более поздней версии.

В REST необходимо задать ipspace.

use_lambda

boolean

добавлено в netapp.ontap 23.2.0

Указывает, следует ли использовать функцию прокси-сервера AWS Lambda для подключения к системе ONTAP.

Поддерживается только в REST.

Варианты:

• false ← (по умолчанию)
• true

use_rest

string

Использовать REST или ZAPI.

always — всегда использовать REST API, если модуль поддерживает REST. Если модуль не поддерживает REST, выдается предупреждение. Если параметр модуля не поддерживается в REST, выдается ошибка.

never — всегда использовать ZAPI, если модуль поддерживает ZAPI. Если параметр REST не поддерживается в ZAPI, может быть выдана ошибка.

auto — попытаться использовать REST API, если модуль поддерживает REST и параметры модуля поддерживаются. В противном случае переключиться на ZAPI.

По умолчанию: "always"

username

псевдонимы: user

строка

Это может быть учетная запись с областью действия кластера или SVM, в зависимости от того, требуется ли API уровня кластера или уровня SVM.

Дополнительные сведения см. в документации https://docs.netapp.com/us-en/ontap/authentication/create-svm-user-accounts-task.html.

Поддерживаются два метода аутентификации

1. Базовая аутентификация с использованием имени пользователя и пароля.
2. Аутентификация по SSL-сертификату с использованием файла сертификата клиента SSL и, при необходимости, файла закрытого ключа.

Для использования сертификата его необходимо установить в кластере ONTAP и включить аутентификацию по сертификату.

validate_certs

логическое значение

Если задано значение no, SSL-сертификаты не будут проверяться.

Это следует задавать только для False при использовании самоподписанных сертификатов на сайтах, находящихся под личным контролем.

Возможные значения:

• false
• true ← (по умолчанию)

vserver

строка

Имя используемого vserver.

Обязательно при использовании ZAPI.

Обязательно при использовании REST для интерфейсов FC (vserver данных).

Обязательно при использовании REST для IP-интерфейсов с областью действия SVM (vserver данных).

Недопустимо при использовании REST для IP-интерфейсов с областью действия кластера.

Для упрощения перехода с ZAPI на REST параметр vserver игнорируется, если для роли задано значение ‘cluster’, ‘node-mgmt’, ‘intercluster’ или ‘cluster-mgmt’.

Удалите этот параметр, чтобы отключить предупреждение.