Модуль hitachivantara.vspone_block.vsp.hv_resource_group_facts — извлекает сведения о группах ресурсов из блочных систем хранения 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_facts.
Добавлено в hitachivantara.vspone_block 3.2.0
Краткое описание
- Этот модуль извлекает сведения о группах ресурсов из блочных систем хранения VSP.
- Примеры см. по адресу https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/vsp_direct/resource_group_facts.yml
Требования
Следующие требования должны быть выполнены на узле, на котором запускается этот модуль.
- python >= 3.9
Параметры
Параметр | Комментарии |
|---|---|
connection_info dictionary / обязательный | Сведения, необходимые для установки соединения с системой хранения. |
|
address string / обязательный |
IP-адрес или имя узла системы хранения. |
|
api_token string |
Токен для выполнения операций с заблокированными ресурсами. |
|
connection_type string |
Тип соединения с системой хранения. Варианты:
|
|
password string |
Пароль для аутентификации. Это обязательное поле. |
|
username string |
Имя пользователя для аутентификации. Это обязательное поле. |
spec dictionary | Спецификация данных о группах ресурсов, которые необходимо собрать. |
|
id integer |
Идентификатор конкретной группы ресурсов, сведения о которой нужно получить. Обязателен для задачи Get Resource Group by id. |
|
is_locked boolean |
Если поле не указано, будут получены сведения обо всех группах ресурсов. Если значение поля равно true, будут получены сведения только о заблокированных группах ресурсов. Если значение поля равно false, будут получены сведения только о разблокированных группах ресурсов. Обязателен для задач Get all information about the Resource Groups that are locked /Get all information about the Resource Groups that are unlocked. Необязателен для задачи Get information about the Resource Groups that are unlocked and specified in the query. Варианты:
|
|
is_simple boolean |
Если значение поля равно true, будут получены только основные сведения обо всех группах ресурсов, включая сведения о метагруппах ресурсов. Если значение поля равно false или поле не указано, будут получены подробные сведения о группах ресурсов. Необязателен для всех задач. Если значение равно true, все остальные параметры игнорируются. Значение по умолчанию — false. Варианты:
|
|
name string |
Имя конкретной группы ресурсов, сведения о которой нужно получить. Обязательно для задачи Get Resource Group by name. |
|
query list / elements=string |
Это поле позволяет запрашивать группы ресурсов по различным типам ресурсов. Типы ресурсов: ldevs, parity_groups, ports, host_groups, iscsi_targets, nvm_subsystem_ids и storage_pool_ids. Если поле не указано, будут получены сведения обо всех ресурсах группы ресурсов, кроме storage_pool_ids. Если указано storage_pool_ids, в ответе в поле ldevs будут включены все LDEV, входящие в состав пула хранения. Необязателен для задач Get information about the Resource Groups that are specified in the query /Get information about the Resource Groups that are unlocked and specified in the query. |
storage_system_info dictionary | Сведения о системе хранения. Это необязательное поле. |
|
serial string |
Серийный номер системы хранения. |
Атрибуты
Атрибут | Поддержка | Описание |
|---|---|---|
check_mode | Поддержка: полная | Определяет, следует ли запускать модуль в режиме проверки. |
Примечания
Примечание
- Тип соединения
gatewayудален начиная с версии 3.4.0. Если вам требуется этот тип соединения, используйте более раннюю версию. - Чтобы добавить подсистемы NVM в VSM или удалить их из него, подсистема NVM не должна уже существовать или быть созданной.
Примеры
- name: Get all Resource Groups
hitachivantara.vspone_block.vsp.hv_resource_group_facts:
connection_info:
address: storage1.company.com
username: "admin"
password: "secret"
- name: Get Resource Group by name
hitachivantara.vspone_block.vsp.hv_resource_group_facts:
connection_info:
address: storage1.company.com
username: "admin"
password: "secret"
spec:
name: "my_resource_group"
- name: Get information about the Resource Groups specified in the query
hitachivantara.vspone_block.vsp.hv_resource_group_facts:
connection_info:
address: storage1.company.com
username: "admin"
password: "secret"
spec:
query:
# Logical Devices (LDEVs)
- ldevs
# Parity Groups
- parity_groups
# Ports
- ports
# Host Groups
- host_groups
# iSCSI Targets
- iscsi_targets
# Non-Volatile Memory Subsystem IDs
- nvm_subsystem_ids
Возвращаемые факты
Факты, возвращаемые этим модулем, добавляются в факты узла hostvars или обновляют их; к ним можно обращаться по имени, как и к любым другим фактам узла. Для их использования не требуется регистрировать их.
Ключ | Описание |
|---|---|
resource_groups list / elements=dictionary | Сведения о группе ресурсов. Возвращается: всегда |
|
host_groups list / elements=dictionary |
Список групп узлов в группе ресурсов. Возвращается: при успехе |
|
id integer |
Идентификатор цели iSCSI. Возвращается: при успехе Пример: |
|
name string |
Имя группы узлов. Возвращается: при успехе Пример: |
|
port string |
Устарело. Используйте вместо этого port_id. Возвращается: при успехе Пример: |
|
port_id string |
Идентификатор порта группы узлов. Возвращается: при успехе Пример: |
|
id integer |
Идентификатор группы ресурсов. Возвращается: при успехе Пример: |
|
iscsi_targets list / elements=dictionary |
Список целей iSCSI в группе ресурсов. Возвращается: при успехе |
|
id integer |
Идентификатор цели iSCSI. Возвращается: при успехе Пример: |
|
name string |
Имя цели iSCSI. Возвращается: при успехе Пример: |
|
port string |
Устарело. Используйте вместо этого port_id. Возвращается: при успехе Пример: |
|
port_id string |
Идентификатор порта цели iSCSI. Возвращается: при успехе Пример: |
|
ldevs list / elements=integer |
Список LDEV в группе ресурсов. Возвращается: при успехе Пример: |
|
ldevs_hex list / elements=string |
Список LDEV в шестнадцатеричном формате. Возвращается: при успехе Пример: |
|
lock_status string |
Статус блокировки группы ресурсов. Возвращается: при успехе Пример: |
|
name string |
Имя группы ресурсов. Возвращается: при успехе Пример: |
|
parity_groups list / elements=string |
Список групп четности в группе ресурсов. Возвращается: при успехе Пример: |
|
ports list / elements=string |
Список портов в группе ресурсов. Возвращается: при успехе Пример: |
|
storage_serial_number string |
Серийный номер системы хранения. Возвращается: при успехе Пример: |
|
virtual_model string |
Виртуальная модель системы хранения. Возвращается: при успехе Пример: |
|
virtual_serial_number string |
Виртуальный серийный номер системы хранения. Возвращается: при успехе Пример: |
|
virtual_storage_id integer |
Идентификатор виртуального хранилища. Возвращается: при успехе Пример: |
Ссылки на коллекцию
© 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_facts_module.html