Spec-Zone.ru › Ansible

Модуль netapp.ontap.na_ontap_cifs — управление общими ресурсами CIFS в NetApp ONTAP

Примечание

Этот модуль входит в коллекцию netapp.ontap (версия 23.5.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 в ONTAP.

Требования

На хосте, выполняющем этот модуль, должны быть установлены следующие компоненты.

  • Ansible 2.9 или более поздней версии — рекомендуется версия 2.12 или более поздняя.
  • Python3 — рекомендуется версия 3.9 или более поздняя.
  • netapp-lib требуется только при использовании ZAPI (установите с помощью «pip install netapp-lib»). Обратите внимание, что netapp-lib устарела и больше не поддерживается. Используйте ее на свой страх и риск.
  • Физическая или виртуальная кластерная система Data ONTAP. Модули поддерживают Data ONTAP 9.1 и более поздние версии, для работы REST требуется ONTAP 9.6 или более поздней версии.

Параметры

Параметр

Комментарии

access_based_enumeration

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

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

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

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

Варианты:

  • false
  • true

allow_unencrypted_access

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

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

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

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

Варианты:

  • false
  • true

browsable

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

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

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

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

Варианты:

  • false
  • true

cert_filepath

строка

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

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

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

change_notify

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

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

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

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

Варианты:

  • false
  • true

comment

строка

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

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

continuously_available

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

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

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

Файлы, открытые таким образом, защищены от сбоев, например от переключения при отказе и возврата управления.

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

Варианты:

  • false
  • true

encryption

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

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

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

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

Варианты:

  • false
  • true

feature_flags

словарь

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

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

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

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

force_ontap_version

строка

добавлено в 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

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

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

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

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

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

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

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

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

Варианты:

  • false
  • true

hostname

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

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

http_port

целое число

Позволяет заменить порт по умолчанию (80 или 443) указанным портом.

https

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

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

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

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

Варианты:

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

key_filepath

строка

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

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

lambda_config

словарь

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

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

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

aws_profile

строка

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

aws_region

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

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

function_name

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

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

name

псевдонимы: 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

password

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

строка

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

path

строка

Путь в файловой системе, доступ к которому предоставляется через эту общую папку CIFS. Это полный путь, видимый пользователю и заданный относительно корня vserver; он может проходить через точки монтирования junction. Путь задается в UTF-8, разделителем каталогов служит прямая косая черта.

share_properties

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

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

Список свойств общей папки CIFS.

Не поддерживается при использовании REST.

В 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

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

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

Варианты:

  • false
  • true

state

строка

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

Варианты:

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

symlink_properties

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

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

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

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

unix_symlink

строка

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

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

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

Варианты:

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

use_lambda

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

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

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

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

Варианты:

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

use_rest

строка

Определяет, использовать REST или ZAPI.

always — всегда использовать REST API, если модуль его поддерживает. Если модуль не поддерживает 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 ← (по умолчанию)

vscan_fileop_profile

строка

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

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

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

Варианты:

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

vserver

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

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

Примечания

Примечание

  • Поддерживается функция прокси-сервера AWS Lambda при использовании REST. Пример использования см. в файле README.
  • Модули с префиксом 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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/netapp/ontap/na_ontap_cifs_module.html

Spec-Zone.ru

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