Модуль dellemc.unity.smbshare – Управление SMB-разделями на хранилище Unity

Примечание

Этот модуль входит в коллекцию dellemc.unity (версия 2.0.0).

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

Для установки используйте: ansible-galaxy collection install dellemc.unity. Для использования этого модуля требуются дополнительные компоненты. Подробности см. в разделе Требования.

Для использования в книге задач, укажите: dellemc.unity.smbshare.

Новое в dellemc.unity 1.1.0

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

Описание

Управление SMB-разделями на хранилище Unity включает создание, получение, изменение и удаление SMB-разделов.

Требования

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

Устройство Dell Unity Storage версии 5.1 или более поздней.
Ansible-core версии 2.14 или более поздней.
Python 3.9, 3.10 или 3.11.
Storops Python SDK 1.2.11.

Параметры

Параметр	Комментарии
description string	Описание SMB-шары. Необязательный параметр при создании шары. Для изменения передайте новое значение в поле description.
filesystem_id string	Идентификатор файловой системы. Для создания SMB-шары для файловой системы требуется либо filesystem_name, либо filesystem_id. Если указан filesystem_name, то для однозначной идентификации файловой системы требуется nas_server_name/nas_server_id. Параметры filesystem_name и filesystem_id являются взаимоисключающими.
filesystem_name string	Имя файловой системы. Для создания SMB-шары для файловой системы требуется либо filesystem_name, либо filesystem_id. Если указан filesystem_name, то для однозначной идентификации файловой системы требуется nas_server_name/nas_server_id. Параметры filesystem_name и filesytem_id являются взаимоисключающими.
is_abe_enabled boolean	Указывает, включена ли функция Access-based Enumeration (ABE) для SMB-шары. При создании, если не указано, значение по умолчанию — `false`. Варианты: `false` `true`
is_branch_cache_enabled boolean	Указывает, включена ли оптимизация Branch Cache для SMB-шары. При создании, если не указано, значение по умолчанию — `false`. Варианты: `false` `true`
is_continuous_availability_enabled boolean	Указывает, включена ли непрерывная доступность для SMB 3.0. При создании, если не указано, значение по умолчанию — `false`. Варианты: `false` `true`
is_encryption_enabled boolean	Указывает, включено ли шифрование для SMB 3.0 на уровне общей папки. При создании, если не указано, значение по умолчанию — `false`. Варианты: `false` `true`
nas_server_id string	Идентификатор NAS-сервера. Не требуется, если используется share_id.
nas_server_name string	Имя NAS-сервера. Не требуется, если используется share_id. Параметры nas_server_name и nas_server_id являются взаимоисключающими.
offline_availability string	Определяет допустимые состояния автономной доступности. `MANUAL`- Только указанные файлы будут доступны в автономном режиме. `DOCUMENTS`- Все файлы, которые открывают пользователи, будут доступны в автономном режиме. `PROGRAMS`- Программа будет предпочтительно запускаться из автономного кэша даже при подключении к сети. Все файлы, которые открывают пользователи, будут доступны в автономном режиме. `NONE`- Предотвращает хранение клиентами документов и программ в автономном кэше. Варианты: `"MANUAL"` `"DOCUMENTS"` `"PROGRAMS"` `"NONE"`
password string / required	Пароль сервера управления Unity.
path string	Локальный путь к файловой системе/снимку или любой существующей подпапке файловой системы/снимка, которая предоставляется совместно по сети. Путь указывается относительно корня файловой системы. Требуется для создания SMB-шары.
port integer	Порт, через который осуществляется связь с сервером управления Unity. Значение по умолчанию: `443`
share_id string	Идентификатор SMB-шары. Не должен указываться при создании. Идентификатор генерируется автоматически. Для всех остальных операций требуется либо share_name, либо share_id. Если используется share_id, то нет необходимости передавать nas_server/filesystem/snapshot/path.
share_name string	Имя SMB-шары. Требуется при создании SMB-шары. Для всех остальных операций требуется либо share_name, либо share_id.
snapshot_id string	Идентификатор снимка файловой системы. Для создания SMB-шары для снимка требуется либо snapshot_name, либо snapshot_id. Если указан snapshot_name, то для однозначной идентификации снимка требуется nas_server_name/nas_server_id. Параметры snapshot_name и snapshot_id являются взаимоисключающими.
snapshot_name string	Имя снимка файловой системы. Для создания SMB-шары для снимка требуется либо snapshot_name, либо snapshot_id. Если указан snapshot_name, то для однозначной идентификации снимка требуется nas_server_name/nas_server_id. Параметры snapshot_name и snapshot_id являются взаимоисключающими.

state строка / обязательно	Определите, должно ли существовать SMB-общий ресурс или нет. Значение `present` указывает, что общий ресурс должен существовать в системе. Значение `absent` указывает, что общий ресурс не должен существовать в системе. Варианты: `"absent"` `"present"`
umask строка	Значение по умолчанию UNIX umask для новых файлов, созданных на SMB-общем ресурсе.
unispherehost строка / обязательно	IP-адрес или FQDN сервера управления Unity.
username строка / обязательно	Имя пользователя сервера управления Unity.
validate_certs псевдонимы: verifycert логическое	Логическая переменная для указания проверки SSL-сертификата. `true` - Указывает, что SSL-сертификат должен быть проверен. `false` - Указывает, что SSL-сертификат не должен быть проверен. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

При передаче идентификатора/имени файловой системы/снимка, параметр nas_server не требуется. Если он передан, то файловая система/снимок должны существовать для указанного nas_server, в противном случае задача завершится ошибкой.
Режим check_mode не поддерживается.
Модули, присутствующие в этом наборе, под названием «dellemc.unity», разработаны для поддержки платформы хранения Dell Unity.

Примеры

- name: Create SMB share for a filesystem
  dellemc.unity.smbshare:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    share_name: "sample_smb_share"
    filesystem_name: "sample_fs"
    nas_server_id: "NAS_11"
    path: "/sample_fs"
    description: "Sample SMB share created"
    is_abe_enabled: true
    is_branch_cache_enabled: true
    offline_availability: "DOCUMENTS"
    is_continuous_availability_enabled: true
    is_encryption_enabled: true
    umask: "777"
    state: "present"
- name: Modify Attributes of SMB share for a filesystem
  dellemc.unity.smbshare:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    share_name: "sample_smb_share"
    nas_server_name: "sample_nas_server"
    description: "Sample SMB share attributes updated"
    is_abe_enabled: false
    is_branch_cache_enabled: false
    offline_availability: "MANUAL"
    is_continuous_availability_enabled: "false"
    is_encryption_enabled: "false"
    umask: "022"
    state: "present"
- name: Create SMB share for a snapshot
  dellemc.unity.smbshare:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    share_name: "sample_snap_smb_share"
    snapshot_name: "sample_snapshot"
    nas_server_id: "NAS_11"
    path: "/sample_snapshot"
    description: "Sample SMB share created for snapshot"
    is_abe_enabled: true
    is_branch_cache_enabled: true
    is_continuous_availability_enabled: true
    is_encryption_enabled: true
    umask: "777"
    state: "present"
- name: Modify Attributes of SMB share for a snapshot
  dellemc.unity.smbshare:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    share_name: "sample_snap_smb_share"
    snapshot_name: "sample_snapshot"
    description: "Sample SMB share attributes updated for snapshot"
    is_abe_enabled: false
    is_branch_cache_enabled: false
    offline_availability: "MANUAL"
    is_continuous_availability_enabled: "false"
    is_encryption_enabled: "false"
    umask: "022"
    state: "present"
- name: Get details of SMB share
  dellemc.unity.smbshare:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    share_id: "{{smb_share_id}}"
    state: "present"
- name: Delete SMB share
  dellemc.unity.smbshare:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    share_id: "{{smb_share_id}}"
    state: "absent"

Значения возврата

Общие значения возврата задокументированы здесь, следующие являются полями, уникальными для данного модуля:

Ключ	Описание
changed boolean	Изменился ли ресурс. Возвращается: всегда Пример: `true`
smb_share_details dictionary	Подробности SMB-совместимой папки. Возвращается: когда папка существует. Пример: {"creation_time": "2022-03-17 11:56:54.867000+00:00", "description": "", "existed": true, "export_paths": ["\\\\multi-prot-pie.extreme1.com\\multi-prot-hui", "\\\\10.230.24.26\\multi-prot-hui"], "filesystem": {"UnityFileSystem": {"hash": 8748426746492}}, "filesystem_id": "fs_140", "filesystem_name": "multi-prot-hui", "hash": 8748426746588, "id": "SMBShare_20", "is_abe_enabled": false, "is_ace_enabled": false, "is_branch_cache_enabled": false, "is_continuous_availability_enabled": false, "is_dfs_enabled": false, "is_encryption_enabled": false, "is_read_only": null, "modified_time": "2022-03-17 11:56:54.867000+00:00", "name": "multi-prot-hui", "nas_server_id": "nas_5", "nas_server_name": "multi-prot", "offline_availability": "CifsShareOfflineAvailabilityEnum.NONE", "path": "/", "snap": null, "type": "CIFSTypeEnum.CIFS_SHARE", "umask": "022"}
description string	Дополнительная информация о папке. Возвращается: успех Пример: `"This share is created for demo purpose only."`
filesystem_id string	Идентификатор файловой системы. Возвращается: успех
filesystem_name string	Имя файловой системы Возвращается: успех
id string	Идентификатор SMB-совместимой папки. Возвращается: успех
is_abe_enabled boolean	Включено ли перечисление на основе доступа. Возвращается: успех Пример: `false`
is_branch_cache_enabled boolean	Включен ли кэш ветвей. Возвращается: успех Пример: `false`
is_continuous_availability_enabled boolean	Будет ли папка доступна непрерывно. Возвращается: успех Пример: `false`
is_encryption_enabled boolean	Включено ли шифрование. Возвращается: успех Пример: `false`
name string	Имя SMB-совместимой папки. Возвращается: успех Пример: `"sample_smb_share"`
nas_server_id string	Идентификатор nas_server. Возвращается: успех
nas_server_name string	Имя nas_server. Возвращается: успех
snapshot_id string	Идентификатор моментального снимка. Возвращается: успех
snapshot_name string	Имя моментального снимка. Возвращается: успех
umask string	Маска Unix для SMB-совместимой папки. Возвращается: успех

Авторы

P Srinivas Rao (@srinivas-rao5)

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

© 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/dellemc/unity/smbshare_module.html