Spec-Zone.ru › Ansible

Модуль dellemc.unity.smbshare — управление SMB-ресурсами на системе хранения Unity

Примечание

Этот модуль является частью коллекции dellemc.unity (версия 2.1.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 версии 5.3 или более поздней.
  • Ansible-core версии 2.17 или более поздней.
  • Python 3.11, 3.12 или 3.13.
  • Python SDK Storops 1.2.12.

Параметры

Параметр

Комментарии

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

Указывает, включено ли перечисление на основе доступа (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 / обязательный

Пароль сервера управления 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

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

Определяет, должен ли SMB-ресурс существовать.

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

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

Варианты:

  • "absent"
  • "present"

umask

string

Маска UNIX по умолчанию для новых файлов, создаваемых в SMB-ресурсе.

unispherehost

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

IP-адрес или FQDN сервера управления Unity.

username

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

Имя пользователя сервера управления Unity.

validate_certs

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

boolean

Логическая переменная, указывающая, нужно ли проверять SSL-сертификат.

true — указывает, что SSL-сертификат необходимо проверить.

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

Варианты:

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

Примечания

Примечание

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

Примеры

- name: Create SMB share for a filesystem
  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
  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
  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
  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
  smbshare:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    share_id: "{{smb_share_id}}"
    state: "present"
- name: Delete SMB share
  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

Включён ли Branch Cache.

Возвращается: при успешном выполнении

Пример: 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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/dellemc/unity/smbshare_module.html

Spec-Zone.ru

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