dellemc.unity.nfs модуль — Управление экспортом NFS на системе хранения Unity

Примечание

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

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

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

Для использования в playbook укажите: dellemc.unity.nfs.

Добавлено в dellemc.unity 1.1.0

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

Описание

Управление экспортом NFS на системе хранения Unity включает создание нового экспорта NFS, изменение атрибутов экспорта NFS, отображение деталей экспорта NFS, удаление экспорта NFS.

Требования

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

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

Параметры

Параметр	Комментарии
adv_host_mgmt_enabled boolean	Если `false`, позволяет указать хосты без их предварительной регистрации. Обязательно при добавлении хостов доступа. Варианты: `false` `true`
anonymous_gid integer	Указывает идентификатор группы анонимной учетной записи. Если не указано при создании, будет установлено значение 4294967294.
anonymous_uid integer	Указывает идентификатор пользователя анонимной учетной записи. Если не указано при создании, будет установлено значение 4294967294.
default_access string	Уровень доступа по умолчанию для всех хостов, имеющих доступ к NFS-экспорту. Для хостов, которым нужен доступ, отличающийся от значения по умолчанию, их можно настроить, добавив в список. Если default_access не указан при создании, то NFS-экспорт будет создан со значением `NO_ACCESS`. Варианты: `"NO_ACCESS"` `"READ_ONLY"` `"READ_WRITE"` `"ROOT"` `"READ_ONLY_ROOT"`
description string	Описание NFS-экспорта. Необязательный параметр при создании NFS-экспорта. Для изменения описания передайте новое значение в поле description. Для удаления описания передайте пустое значение в поле description.
filesystem_id string	Идентификатор файловой системы. Это уникальный идентификатор, сгенерированный системой Unity хранения.
filesystem_name string	Имя файловой системы, для которой будет создан NFS-экспорт. Для создания NFS необходимы либо файловая система, либо снимок. Если указано filesystem_name, то необходимо указать nas_server для уникальной идентификации файловой системы. Если указан параметр файловой системы, то снимок указывать нельзя.
host_state string	Определение возможности доступа хостов к NFS-экспорту. Требуется при добавлении или удалении доступа хостов к экспорту. Варианты: `"present-in-export"` `"absent-in-export"`
min_security string	Тип безопасности NFS, применяемый для пользователей, обращающихся к NFS-экспорту. Если не указано при создании, будет установлено значение `SYS`. Варианты: `"SYS"` `"KERBEROS"` `"KERBEROS_WITH_INTEGRITY"` `"KERBEROS_WITH_ENCRYPTION"`
nas_server_id string	Идентификатор NAS-сервера, на котором будет размещена файловая система.
nas_server_name string	Имя NAS-сервера, на котором будет размещена файловая система.
nfs_export_id string	Идентификатор NFS-экспорта. Это уникальный идентификатор, сгенерированный системой Unity хранения.
nfs_export_name string	Имя NFS-экспорта. Обязательно для операции создания. Укажите либо nfs_export_name, либо nfs_export_id (но не оба), для любой операции.
no_access_hosts list / elements=dictionary	Хосты без доступа к NFS-экспорту. Список словарей. Каждый словарь содержит любой из ключей host_name, host_id, subnet, netgroup, domain и ip_address. Если adv_host_mgmt_enabled равно `true`, то допустимы ключи host_name, host_id и ip_address. Если adv_host_mgmt_enabled равно `false`, то допустимы ключи host_name, subnet, netgroup, domain и ip_address.
domain string	Домен DNS, где все клиенты NFS в данном домене включены в список хостов.
host_id string	Идентификатор хоста.
host_name string	Имя хоста.
ip_address string	IP-адрес хоста.
netgroup string	Группа, определённая в NIS или локальном файле групп.
subnet string	Подсеть может быть в формате ‘IP-адрес/маска’ или ‘IP-адрес/длина префикса’.
password string / обязательно	Пароль сервера управления Unity.

путь строка	Локальный путь к экспорту относительно корня сервера NAS. При использовании NFS каждый экспорт файловой системы или моментального снимка должен иметь уникальный локальный путь. Обязательно при создании экспорта NFS.
порт целое число	Номер порта, через который происходит общение с сервером управления Unity. По умолчанию: `443`
только чтение для хостов список / элементы=словарь	Хосты с чтением только для экспорта NFS. Список словарей. Каждый словарь будет содержать любой из ключей имя_хоста, id_хоста, подсеть, группа_хостов, домен и ip_адрес. Если adv_host_mgmt_enabled равно `true`, то допустимые ключи — имя_хоста, id_хоста и ip_адрес. Если adv_host_mgmt_enabled равно `false`, то допустимые ключи — имя_хоста, подсеть, группа_хостов, домен и ip_адрес.
домен строка	Домен DNS, где все клиенты NFS в домене включены в список хостов.
id_хоста строка	ID хоста.
имя_хоста строка	Имя хоста.
ip_адрес строка	IP-адрес хоста.
группа_хостов строка	Группа хостов, определенная в NIS или локальном файле группы хостов.
подсеть строка	Подсеть может быть в формате «IP-адрес/маска» или «IP-адрес/длина префикса».
только чтение для корневого хоста список / элементы=словарь	Хосты с чтением только для доступа корневого пользователя к экспорту NFS. Список словарей. Каждый словарь будет содержать любой из ключей имя_хоста, id_хоста, подсеть, группа_хостов, домен и ip_адрес. Если adv_host_mgmt_enabled равно `true`, то допустимые ключи — имя_хоста, id_хоста и ip_адрес. Если adv_host_mgmt_enabled равно `false`, то допустимые ключи — имя_хоста, подсеть, группа_хостов, домен и ip_адрес.

END_OF_DOCUMENT_MARKER

read_write_root_hosts список / элементы=словарь	Хосты с правами чтения и записи для пользователя root на экспорте NFS. Список словарей. Каждый словарь содержит любые из ключей: host_name, host_id, subnet, netgroup, domain и ip_address. Если adv_host_mgmt_enabled равно `true`, то допустимы ключи host_name, host_id и ip_address. Если adv_host_mgmt_enabled равно `false`, то допустимы ключи host_name, subnet, netgroup, domain и ip_address.
domain строка	Домен DNS, где все клиенты NFS в домене включаются в список хостов.
host_id строка	Идентификатор хоста.
host_name строка	Имя хоста.
ip_address строка	IP-адрес хоста.
netgroup строка	Группа Netgroup, определённая в NIS или локальном файле групп.
subnet строка	Подсеть может быть в формате «IP-адрес/маска» или «IP-адрес/длина префикса».
snapshot_id строка	Идентификатор моментального снимка. Это уникальный идентификатор, сгенерированный системой хранения Unity.
snapshot_name строка	Имя моментального снимка, для которого будет создан экспорт NFS. Для создания экспорта NFS требуется либо файловая система, либо моментальный снимок. Если указан параметр моментального снимка, то файловая система не может быть указана.
state строка / обязательно	Переменная состояния, определяющая, будет ли существовать экспорт NFS. Варианты: `"absent"` `"present"`
unispherehost строка / обязательно	IP-адрес или FQDN сервера управления Unity.
username строка / обязательно	Имя пользователя сервера управления Unity.
validate_certs алиасы: verifycert логический	Логическая переменная для указания необходимости проверки сертификата SSL. `true` — указывает на проверку сертификата SSL. `false` — указывает на отказ от проверки сертификата SSL. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

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

Примеры

- name: Create nfs export from filesystem
  dellemc.unity.nfs:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    nfs_export_name: "ansible_nfs_from_fs"
    path: '/'
    filesystem_id: "fs_377"
    state: "present"

- name: Create nfs export from snapshot
  dellemc.unity.nfs:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    nfs_export_name: "ansible_nfs_from_snap"
    path: '/'
    snapshot_name: "ansible_fs_snap"
    state: "present"

- name: Modify nfs export
  dellemc.unity.nfs:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    nfs_export_name: "ansible_nfs_from_fs"
    nas_server_id: "nas_3"
    description: ""
    default_access: "READ_ONLY_ROOT"
    anonymous_gid: 4294967290
    anonymous_uid: 4294967290
    state: "present"

- name: Add host in nfs export with adv_host_mgmt_enabled as true
  dellemc.unity.nfs:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    nfs_export_name: "ansible_nfs_from_fs"
    filesystem_id: "fs_377"
    adv_host_mgmt_enabled: true
    no_access_hosts:
      - host_id: "Host_1"
    read_only_hosts:
      - host_id: "Host_2"
    read_only_root_hosts:
      - host_name: "host_name1"
    read_write_hosts:
      - host_name: "host_name2"
    read_write_root_hosts:
      - ip_address: "1.1.1.1"
    host_state: "present-in-export"
    state: "present"

- name: Remove host in nfs export with adv_host_mgmt_enabled as true
  dellemc.unity.nfs:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    nfs_export_name: "ansible_nfs_from_fs"
    filesystem_id: "fs_377"
    adv_host_mgmt_enabled: true
    no_access_hosts:
      - host_id: "Host_1"
    read_only_hosts:
      - host_id: "Host_2"
    read_only_root_hosts:
      - host_name: "host_name1"
    read_write_hosts:
      - host_name: "host_name2"
    read_write_root_hosts:
      - ip_address: "1.1.1.1"
    host_state: "absent-in-export"
    state: "present"

- name: Add host in nfs export with adv_host_mgmt_enabled as false
  dellemc.unity.nfs:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    nfs_export_name: "ansible_nfs_from_fs"
    filesystem_id: "fs_377"
    adv_host_mgmt_enabled: false
    no_access_hosts:
      - domain: "google.com"
    read_only_hosts:
      - netgroup: "netgroup_admin"
    read_only_root_hosts:
      - host_name: "host5"
    read_write_hosts:
      - subnet: "168.159.57.4/255.255.255.0"
    read_write_root_hosts:
      - ip_address: "10.255.2.4"
    host_state: "present-in-export"
    state: "present"

- name: Remove host in nfs export with adv_host_mgmt_enabled as false
  dellemc.unity.nfs:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    nfs_export_name: "ansible_nfs_from_fs"
    filesystem_id: "fs_377"
    adv_host_mgmt_enabled: false
    no_access_hosts:
      - domain: "google.com"
    read_only_hosts:
      - netgroup: "netgroup_admin"
    read_only_root_hosts:
      - host_name: "host5"
    read_write_hosts:
      - subnet: "168.159.57.4/255.255.255.0"
    read_write_root_hosts:
      - ip_address: "10.255.2.4"
    host_state: "absent-in-export"
    state: "present"

- name: Get nfs details
  dellemc.unity.nfs:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    nfs_export_id: "NFSShare_291"
    state: "present"

- name: Delete nfs export by nfs name
  dellemc.unity.nfs:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    nfs_export_name: "ansible_nfs_name"
    nas_server_name: "ansible_nas_name"
    state: "absent"

Возвращаемые значения

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

Ключ	Описание
changed boolean	Изменился ли ресурс. Возвращается: всегда Пример: `false`
nfs_share_details словарь	Детали nfs экспорта. Возвращается: Когда nfs экспорт существует. Пример: {"anonymous_gid": 4294967294, "anonymous_uid": 4294967294, "creation_time": "2022-03-09 15:05:34.720000+00:00", "default_access": "NFSShareDefaultAccessEnum.NO_ACCESS", "description": "", "existed": true, "export_option": 1, "export_paths": ["...:/dummy-share-123"], "filesystem": {"UnityFileSystem": {"id": "fs_id_1", "name": "fs_name_1"}}, "host_accesses": "None", "id": "NFSShare_14393", "is_read_only": "None", "min_security": "NFSShareSecurityEnum.SYS", "modification_time": "2022-04-25 08:12:28.179000+00:00", "name": "dummy-share-123", "nas_server": {"UnityNasServer": {"id": "nas_id_1", "name": "dummy_nas_server"}}, "nfs_owner_username": "None", "no_access_hosts": "None", "no_access_hosts_string": "host1,.*..*", "path": "/", "read_only_hosts": "None", "read_only_hosts_string": "", "read_only_root_access_hosts": "None", "read_only_root_hosts_string": "", "read_write_hosts": "None", "read_write_hosts_string": "", "read_write_root_hosts_string": "", "role": "NFSShareRoleEnum.PRODUCTION", "root_access_hosts": "None", "snap": "None", "type": "NFSTypeEnum.NFS_SHARE"}
anonymous_gid целое число	Идентификатор группы анонимной учетной записи Возвращается: при успехе
anonymous_uid целое число	Идентификатор пользователя анонимной учетной записи Возвращается: при успехе
default_access строка	Уровень доступа по умолчанию для всех хостов, имеющих доступ к экспорту Возвращается: при успехе
description строка	Описание nfs экспорта Возвращается: при успехе
export_paths список / элементы=строка	Пути экспорта, которые могут быть использованы для подключения и доступа к экспорту Возвращается: при успехе
...	...

END_OF_DOCUMENT_MARKER

read_write_root_hosts_string string	Хосты с правами чтения и записи для доступа root-пользователя к экспорту Возвращаемое значение: success
type string	Тип экспорта NFS. Например, файловая система или моментальный снимок Возвращаемое значение: success

Авторы

Vivek Soni (@v-soni11)

Ссылки на коллекцию

© 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/nfs_module.html