Spec-Zone.ru › Ansible

netapp.ontap.na_ontap_cifs модуль — NetApp ONTAP Управление cifs-share

Примечание

Этот модуль является частью коллекции netapp.ontap (версия 22.12.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для её установки используйте: ansible-galaxy collection install netapp.ontap. Для использования данного модуля необходимы дополнительные требования, см. Требования для получения подробностей.

Для использования в плейбуке укажите: netapp.ontap.na_ontap_cifs.

Новый в netapp.ontap 2.6.0

  • Описание
  • Требования
  • Параметры
  • Примечания
  • Примеры

Описание

  • Создание, удаление или изменение (путь) cifs-share на 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 или более поздней версии

Параметры

Параметр

Комментарии

access_based_enumeration

boolean

added in netapp.ontap 22.3.0

Если включено, все папки внутри этой общей папки видны пользователю на основе его индивидуальных прав доступа; предотвращает отображение папок или других общих ресурсов, к которым пользователь не имеет доступа.

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

Варианты:

  • false
  • true

allow_unencrypted_access

boolean

added in netapp.ontap 22.3.0

Указывает, разрешен ли доступ к зашифрованной общей папке клиентам SMB2.

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

Варианты:

  • false
  • true

browsable

boolean

added in netapp.ontap 22.5.0

Указывает, могут ли клиенты Windows просматривать общую папку.

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

Варианты:

  • false
  • true

cert_filepath

string

added in netapp.ontap 20.6.0

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

не поддерживается с python 2.6.

change_notify

boolean

added in netapp.ontap 22.3.0

Указывает, могут ли клиенты CIFS запрашивать уведомления об изменениях для каталогов в этой общей папке.

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

Варианты:

  • false
  • true

comment

string

added in netapp.ontap 21.7.0

Описание общей папки CIFS.

continuously_available

boolean

added in netapp.ontap 22.3.0

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

Файлы, открытые таким образом, защищены от таких разрушительных событий, как отказ и возврат.

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

Варианты:

  • false
  • true

encryption

boolean

added in netapp.ontap 22.3.0

Указывает, что при доступе к этой общей папке необходимо использовать шифрование SMB. Клиенты, которые не поддерживают шифрование, не смогут получить доступ к этой общей папке.

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

Варианты:

  • false
  • true

feature_flags

dictionary

added in netapp.ontap 20.5.0

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

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

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

force_ontap_version

string

added in 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.

home_directory

boolean

added in netapp.ontap 22.3.0

Указывает, является ли общая папка домашней папкой, где имена общих папок и путей являются динамическими.

Функциональность домашней папки ONTAP автоматически предлагает каждому пользователю динамическую общую папку для своей домашней папки без создания отдельной общей папки SMB для каждого пользователя.

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

Вместо создания отдельных общих папок для каждого пользователя можно создать одну общую папку с параметрами домашней папки.

В общей папке домашней папки ONTAP динамически генерирует имя общей папки и путь к общей папке, заменяя переменные %w, %u и %d соответствующим именем пользователя Windows, именем пользователя UNIX и именем домена соответственно.

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

Варианты:

  • false
  • true

hostname

string / required

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

http_port

integer

Переопределить порт по умолчанию (80 или 443) этим портом

https

boolean

Включить и отключить https.

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

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

Варианты:

  • false ← (default)
  • true

key_filepath

string

added in netapp.ontap 20.6.0

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

имя

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

строка / обязательно

Имя общего ресурса CIFS. Имя общего ресурса CIFS — это строка UTF-8, в которой недопустимы следующие символы: управляющие символы с 0x00 по 0x1F включительно, 0x22 (двойные кавычки).

namespace_caching

логическое

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

Указывает, могут ли клиенты SMB, подключающиеся к этому общему ресурсу, кэшировать результаты перечисления каталогов, возвращаемые серверами CIFS.

Этот параметр требует REST и ONTAP 9.10.1 или более поздней версии.

Варианты:

  • false
  • true

offline_files

строка

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

Позволяет клиентам Windows кэшировать данные на этом общем ресурсе.

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

Варианты:

  • "none"
  • "manual"
  • "documents"
  • "programs"

ontapi

целое число

Версия API ontap для использования

oplocks

логическое

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

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

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

Варианты:

  • false
  • true

пароль

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

строка

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

путь

строка

Путь к файловой системе, который общий через этот общий ресурс CIFS. Путь — это полный, видимый для пользователя путь, относительный к корню vserver, и он может пересекать точки подключения по соединению. Путь находится в UTF8 и использует слеш в качестве разделителя каталогов.

share_properties

список / элементы=строка

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

Список свойств для общего ресурса CIFS.

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

share-properties — это отдельные поля в REST API.

Можно добиться этого, задав access_based_enumeration, change_notify, encryption, home_directory, oplocks, show_snapshot, continuously_available и namespace_caching.

show_previous_versions

логическое

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

Указывает, что предыдущую версию можно просмотреть и восстановить с клиента.

Этот параметр требует REST и ONTAP 9.13.1 или более поздней версии.

Варианты:

  • false
  • true

show_snapshot

логическое

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

Указывает, могут ли клиенты просматривать и переходить по копии моментальных снимков.

Этот параметр требует REST и ONTAP 9.10.1 или более поздней версии.

Варианты:

  • false
  • true

состояние

строка

Указывает, должен ли указанный общий ресурс CIFS существовать.

Варианты:

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

symlink_properties

список / элементы=строка

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

Список свойств символических ссылок для этого общего ресурса CIFS.

Не поддерживается с REST, этот параметр заменён на unix_symlink в REST.

unix_symlink

строка

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

Список свойств unix_symlink для этого общего ресурса CIFS.

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

Варианты:

  • "local"
  • "widelink"
  • "disable"

use_rest

строка

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

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

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

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

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

имя пользователя

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

строка

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

Для получения дополнительной информации ознакомьтесь с документацией https://mysupport.netapp.com/NOW/download/software/nmsdk/9.4/.

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

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

Для использования сертификата сертификат должен быть установлен в кластере ONTAP, а аутентификация по сертификату должна быть включена.
END_OF_DOCUMENT_MARKER

validate_certs

boolean

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

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

Варианты:

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

vscan_fileop_profile

string

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

Набор профилей файловых операций, на которые распространяется сканирование доступа vscan.

Поддержка REST требует ONTAP 9.15.1 или более поздней версии.

Варианты:

  • "no_scan"
  • "standard"
  • "strict"
  • "writes_only"

vserver

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

Vserver, содержащий CIFS-общий ресурс.

Примечания

Примечание

  • Модули с префиксом na_ontap разработаны для поддержки платформы хранения ONTAP.
  • https включен по умолчанию и рекомендуется. Для включения http на кластере необходимо выполнить следующие команды: ‘set -privilege advanced;’ ‘system services web modify -http-enabled true;’

Примеры

- name: Create CIFS share - ZAPI
  netapp.ontap.na_ontap_cifs:
    state: present
    name: cifsShareName
    path: /
    vserver: vserverName
    share_properties: browsable,oplocks
    symlink_properties: read_only,enable
    comment: CIFS share description
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

- name: Delete CIFS share - ZAPI
  netapp.ontap.na_ontap_cifs:
    state: absent
    name: cifsShareName
    vserver: vserverName
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

- name: Modify path CIFS share - ZAPI
  netapp.ontap.na_ontap_cifs:
    state: present
    name: pb_test
    vserver: vserverName
    path: /
    share_properties: show_previous_versions
    symlink_properties: disable
    vscan_fileop_profile: no_scan
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

- name: Create CIFS share - REST
  netapp.ontap.na_ontap_cifs:
    state: present
    name: cifsShareName
    path: /
    vserver: vserverName
    oplocks: true
    change_notify: true
    unix_symlink: disable
    comment: CIFS share description
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

- name: Modify CIFS share - REST
  netapp.ontap.na_ontap_cifs:
    state: present
    name: cifsShareName
    path: /
    vserver: vserverName
    oplocks: true
    change_notify: true
    unix_symlink: local
    comment: CIFS share description
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

Авторы

  • Команда NetApp Ansible (@carchi8py)

Ссылки на сборки

  • Система отслеживания задач
  • Главная страница
  • Репозиторий (исходные коды)

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/netapp/ontap/na_ontap_cifs_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API