Модуль hitachivantara.vspone_block.vsp.hv_resource_group_lock — позволяет блокировать и разблокировать группы ресурсов в блочных системах хранения данных VSP.

Примечание

Этот модуль входит в коллекцию hitachivantara.vspone_block (версия 4.8.1).

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

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

Чтобы использовать модуль в плейбуке, укажите: hitachivantara.vspone_block.vsp.hv_resource_group_lock.

Добавлено в hitachivantara.vspone_block 3.2.0

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

Краткое описание

Этот модуль позволяет блокировать и разблокировать группы ресурсов в блочных системах хранения данных VSP.
Примеры см. по адресу https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/resource_management_with_lock/vsp_direct

Требования

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

python >= 3.9

Параметры

Параметр	Описание
connection_info словарь / обязательный	Информация, необходимая для установки соединения с системой хранения данных.
address строка / обязательный	IP-адрес или имя хоста системы хранения данных.
api_token строка	Токен для выполнения операций с заблокированными ресурсами.
connection_type строка	Тип соединения с системой хранения данных. Варианты: `"direct"` ← (по умолчанию)
password строка	Пароль для аутентификации. Это обязательное поле.
username строка	Имя пользователя для аутентификации. Это обязательное поле.
secondary_connection_info словарь	Информация, необходимая для установки соединения с удалённой системой хранения данных.
address строка / обязательный	IP-адрес или имя хоста системы хранения данных.
api_token строка	Этот токен необходим для работы с заблокированными ресурсами. Укажите значение lock_token, возвращённое задачей блокировки группы ресурсов для вторичной системы хранения данных.
password строка	Пароль для аутентификации во вторичной системе хранения данных. Это обязательное поле, если api_token не указан.
username строка	Имя пользователя для аутентификации во вторичной системе хранения данных. Это обязательное поле, если api_token не указан.
spec словарь	Параметры блокировки группы ресурсов.
lock_timeout_sec целое число	Время до истечения блокировки (в секундах). Укажите значение от 0 до 7200. Значение по умолчанию — 0. Обязательный параметр для задачи блокировки групп ресурсов.
state строка	Чтобы заблокировать группу ресурсов, задайте состояние `present`. Чтобы разблокировать группу ресурсов, задайте состояние `absent`. Варианты: `"present"` ← (по умолчанию) `"absent"`
storage_system_info словарь	Информация о системе хранения данных. Это поле необязательное.
serial строка	Серийный номер системы хранения данных.

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: нет	Определяет, следует ли запускать модуль в режиме проверки.

Примечания

Примечание

Входные параметры id и name удалены в версии 3.4.0. Они устарели из-за упрощения внутреннего API и больше не поддерживаются.
Выходные параметры entitlement_status, subscriber_id и partner_id удалены в версии 3.4.0. Они также устарели из-за упрощения внутреннего API и больше не поддерживаются.
Тип соединения gateway удалён начиная с версии 3.4.0. Если вам нужен этот тип соединения, используйте более раннюю версию.
Для блокировки групп ресурсов:
1. При прямом подключении, если токен блокировки не используется задачами Ansible более 5 минут, группы ресурсов автоматически разблокируются. Чтобы этого избежать, сохраните токен блокировки и укажите его в соответствующих плейбуках либо включите задачи блокировки и разблокировки в единый сценарий плейбука.

Примеры

- name: Lock resource groups
  hitachivantara.vspone_block.vsp.hv_resource_group_lock:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "secret"
    spec:
      lock_timeout_sec: 300

- name: Unlock the Resource Groups that were locked
  hitachivantara.vspone_block.vsp.hv_resource_group_lock:
    connection_info:
      address: storage1.company.com
      api_token: lock_token_value
    state: absent

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

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

Ключ	Описание
locked_resource_groups словарь	Информация о заблокированной группе ресурсов. Если указан secondary_connection_info, в выходных данных будут заполнены remote_lock_session_id, remote_lock_token и remote_locked_resource_groups. Возвращается: всегда
lock_session_id целое число	Идентификатор сеанса, заблокировавшего локальные ресурсы. Возвращается: при успешном выполнении Пример: `26945`
lock_token строка	Токен, который следует использовать для выполнения операций с локальными ресурсами. Возвращается: при успешном выполнении Пример: `"62316257-5362-458a-8a9a-8922beaf7460"`
locked_resource_groups список / элементы=словарь	Список заблокированных локальных групп ресурсов. Возвращается: при успешном выполнении
id целое число	Идентификатор группы ресурсов. Возвращается: при успешном выполнении Пример: `1`
name строка	Имя группы ресурсов. Возвращается: при успешном выполнении Пример: `"test-rg-1"`
remote_lock_session_id целое число	Идентификатор сеанса, заблокировавшего удалённые ресурсы. Возвращается: при успешном выполнении Пример: `16945`
remote_lock_token строка	Токен, который следует использовать для выполнения операций с удалёнными ресурсами. Возвращается: при успешном выполнении Пример: `"72316257-5362-458a-8a9a-8922beaf7460"`
remote_locked_resource_groups список / элементы=словарь	Список заблокированных удалённых групп ресурсов. Возвращается: при успешном выполнении
id целое число	Идентификатор группы ресурсов. Возвращается: при успешном выполнении Пример: `2`
name строка	Имя группы ресурсов. Возвращается: при успешном выполнении Пример: `"test-rg-2"`

Авторы

Hitachi Vantara LTD (@hitachi-vantara)

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

© 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/hitachivantara/vspone_block/vsp.hv_resource_group_lock_module.html