Spec-Zone.ru › Ansible

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

Примечание

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

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

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

Чтобы использовать модуль в сценарии, укажите: dellemc.unity.nfs.

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

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

Обзор

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

Требования

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

  • Устройство хранения Dell Unity версии 5.3 или более поздней.
  • Ansible-core версии 2.17 или более поздней.
  • Python 3.11, 3.12 или 3.13.
  • Python SDK Storops 1.2.12.

Параметры

Параметр

Комментарии

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.

path

string

Локальный путь к экспорту относительно корневого каталога NAS-сервера.

В NFS для каждого экспорта file_system или file_snap должен быть указан уникальный локальный путь.

Обязательный параметр при создании экспорта NFS.

port

integer

Номер порта, через который осуществляется связь с сервером управления Unity.

По умолчанию: 443

read_only_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-адрес/длина префикса».

read_only_root_hosts

list / elements=dictionary

Узлы с доступом только для чтения к экспорту NFS от имени пользователя root.

Список словарей. Каждый словарь может содержать любые из следующих ключей: 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-адрес/длина префикса».

read_write_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-адрес/длина префикса».

read_write_root_hosts

list / elements=dictionary

Узлы с доступом на чтение и запись к экспорту NFS от имени пользователя root.

Список словарей. Каждый словарь может содержать любые из следующих ключей: 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-адрес/длина префикса».

snapshot_id

string

Идентификатор снимка.

Это уникальный идентификатор, созданный системой хранения Unity.

snapshot_name

string

Имя снимка, для которого будет создан экспорт NFS.

Для создания экспорта NFS требуется указать файловую систему или снимок.

Если указан параметр снимка, указывать файловую систему нельзя.

state

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

Переменная состояния, определяющая, должен ли существовать экспорт NFS.

Варианты:

  • "absent"
  • "present"

unispherehost

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

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

username

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

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

validate_certs

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

boolean

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

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

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

Варианты:

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

Примечания

Примечание

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

Примеры

- name: Create nfs export from filesystem
  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
  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
  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
  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
  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
  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
  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
  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
  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

dictionary

Сведения об экспорте 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

integer

Идентификатор группы анонимной учётной записи

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

anonymous_uid

integer

Идентификатор пользователя анонимной учётной записи

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

default_access

string

Уровень доступа по умолчанию для всех узлов, которым разрешён доступ к экспорту

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

description

string

Описание экспорта NFS

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

export_paths

list / elements=string

Пути экспорта, которые можно использовать для подключения и доступа к экспорту

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

filesystem

dictionary

Сведения о файловой системе, в которой находится экспорт NFS

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

UnityFileSystem

dictionary

Сведения о файловой системе

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

id

string

Идентификатор файловой системы

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

name

string

Имя файловой системы

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

id

string

Идентификатор экспорта NFS

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

min_security

string

Тип безопасности NFS, обязательный для пользователей, обращающихся к экспорту

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

name

string

Имя экспорта NFS

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

nas_server

dictionary

Сведения о NAS-сервере

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

UnityNasServer

dictionary

Сведения о NAS-сервере

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

id

string

Идентификатор NAS-сервера

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

name

string

Имя NAS-сервера

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

no_access_hosts_string

string

Узлы без доступа к экспорту NFS

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

read_only_hosts_string

string

Узлы с доступом только для чтения к экспорту NFS

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

read_only_root_hosts_string

string

Узлы с доступом к экспорту NFS для пользователя root только для чтения

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

read_write_hosts_string

string

Узлы с доступом для чтения и записи к экспорту NFS

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

read_write_root_hosts_string

string

Узлы с доступом для чтения и записи к экспорту от имени пользователя root

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

type

string

Тип экспорта NFS, например файловая система или снимок

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

Авторы

  • Vivek Soni (@v-soni11)

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

  • Отслеживание проблем
  • Репозиторий (исходный код)

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

Spec-Zone.ru

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