Модуль hitachivantara.vspone_block.vsp.hv_vsp_one_volume_facts — получение сведений о системах хранения VSP E series, VSP One Block 20 series и VSP One Block 80 series.
Примечание
Этот модуль входит в коллекцию 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_vsp_one_volume_facts.
Добавлено в hitachivantara.vspone_block 4.2.0
Краткое описание
- Этот модуль собирает сведения о томах в системах хранения VSP E series, VSP One Block 20 series и VSP One Block 80 series.
- Поддерживается фильтрация по пулу, серверу, псевдониму тома, емкости и идентификатору тома.
- Примеры использования см. в разделе https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/vsp_direct/vsp_one_volume_facts.yml
Требования
На узле, выполняющем этот модуль, должны быть соблюдены следующие требования.
- python >= 3.9
Параметры
Параметр | Комментарии |
|---|---|
connection_info dictionary / обязательный | Сведения, необходимые для установления соединения с системой хранения. |
|
address string / обязательный |
IP-адрес или имя хоста системы хранения. |
|
api_token string |
Токен для работы с заблокированными ресурсами. |
|
password string |
Пароль для аутентификации. Это обязательное поле. |
|
username string |
Имя пользователя для аутентификации. Это обязательное поле. |
spec dictionary | Спецификация задачи для тома. |
|
begin_volume_id псевдонимы: start_volume_id string |
Начальный идентификатор тома. Обязателен для задачи получения сведений о диапазоне томов с помощью параметров begin_volume_id и count. |
|
count integer |
Количество томов. Обязательно для задачи получения сведений о диапазоне томов с помощью параметров begin_volume_id и count. |
|
max_total_capacity string |
Максимальная общая емкость. Обязательна для задачи получения сведений о томах с фильтрами по емкости. |
|
max_used_capacity string |
Максимальная используемая емкость. Обязательна для задачи получения сведений о томах с фильтрами по емкости. |
|
min_total_capacity string |
Минимальная общая емкость. Обязательна для задачи получения сведений о томах с фильтрами по емкости. |
|
min_used_capacity string |
Минимальная используемая емкость. Обязательна для задачи получения сведений о томах с фильтрами по емкости. |
|
nickname string |
Псевдоним тома. Обязателен для задачи получения сведений о томе по псевдониму. |
|
pool_id integer |
Идентификатор пула. Обязателен для задачи получения сведений о томах в определенном пуле по идентификатору пула. |
|
pool_name string |
Имя пула. Если задан pool_id, этот параметр игнорируется. Обязателен для задачи получения сведений о томах в определенном пуле по имени пула. |
|
server_id integer |
Идентификатор сервера. Обязателен для задачи получения сведений о томах, подключенных к серверу, по идентификатору сервера. |
|
server_nickname string |
Псевдоним сервера. Если задан server_id, этот параметр игнорируется. Обязателен для задачи получения сведений о томах, подключенных к серверу, по псевдониму сервера. |
|
volume_id string |
Идентификатор тома. Обязателен для задачи получения сведений об определенном томе по volume_id. |
Атрибуты
Атрибут | Поддержка | Описание |
|---|---|---|
check_mode | Поддержка: полная | Определяет, должен ли модуль работать в режиме проверки. |
Примечания
Примечание
- С помощью одного запроса можно получить сведения максимум о 500 томах.
- Чтобы получить сведения о дополнительных томах, выполните задачу Ansible несколько раз, используя сочетание параметров count и start_volume_id.
- Указав параметр count, можно также отфильтровать необходимые сведения о томах.
- В дальнейшем поддержка параметра
start_volume_idбудет прекращена. Вместо него используйтеbegin_volume_id.
Примеры
- name: Get facts for volumes in a specific pool by pool_id
hitachivantara.vspone_block.vsp.hv_vsp_one_volume_facts:
connection_info:
address: vsp.company.com
username: "admin"
password: "password"
spec:
pool_id: 1
- name: Get facts for volumes in a specific pool by pool_name
hitachivantara.vspone_block.vsp.hv_vsp_one_volume_facts:
connection_info:
address: vsp.company.com
username: "admin"
password: "password"
spec:
pool_name: "SP01"
- name: Get facts for volumes attached to a server by server_id
hitachivantara.vspone_block.vsp.hv_vsp_one_volume_facts:
connection_info:
address: vsp.company.com
username: "admin"
password: "password"
spec:
server_id: 2001
- name: Get facts for volumes attached to a server by server_nickname
hitachivantara.vspone_block.vsp.hv_vsp_one_volume_facts:
connection_info:
address: vsp.company.com
username: "admin"
password: "password"
spec:
server_nickname: "ComputeNode-1"
- name: Get facts for a volume by nickname
hitachivantara.vspone_block.vsp.hv_vsp_one_volume_facts:
connection_info:
address: vsp.company.com
username: "admin"
password: "password"
spec:
nickname: "RD-volume-0004"
- name: Get facts for volumes with capacity filters
hitachivantara.vspone_block.vsp.hv_vsp_one_volume_facts:
connection_info:
address: vsp.company.com
username: "admin"
password: "password"
spec:
min_total_capacity: 100
max_total_capacity: 500
min_used_capacity: 50
max_used_capacity: 400
- name: Get facts for a range of volumes by start_volume_id and count
hitachivantara.vspone_block.vsp.hv_vsp_one_volume_facts:
connection_info:
address: vsp.company.com
username: "admin"
password: "password"
spec:
start_volume_id: 1000
count: 10
- name: Get facts for a specific volume by volume_id
hitachivantara.vspone_block.vsp.hv_vsp_one_volume_facts:
connection_info:
address: vsp.company.com
username: "admin"
password: "password"
spec:
volume_id: 12345
Возвращаемые факты
Факты, возвращаемые этим модулем, добавляются или обновляются в фактах узла hostvars и могут использоваться по имени, как и любые другие факты узла. Для их использования не требуется регистрация.
Ключ | Описание |
|---|---|
volumes list / elements=dictionary | Список объектов со сведениями о томах. Возвращается: при успешном выполнении |
|
capacity_saving string |
Параметр экономии емкости (например, DEDUPLICATION_AND_COMPRESSION). Возвращается: при успешном выполнении |
|
capacity_saving_progress integer |
Ход выполнения экономии емкости. Возвращается: при успешном выполнении |
|
capacity_saving_status string |
Состояние экономии емкости. Возвращается: при успешном выполнении |
|
compression_acceleration boolean |
Указывает, включено ли ускорение сжатия. Возвращается: при успешном выполнении |
|
compression_acceleration_status string |
Состояние ускорения сжатия. Возвращается: при успешном выполнении |
|
free_capacity integer |
Свободная емкость тома. Возвращается: при успешном выполнении |
|
free_capacity_in_mb integer |
Свободная емкость в МБ. Возвращается: при успешном выполнении |
|
id integer |
Идентификатор тома. Возвращается: при успешном выполнении |
|
id_hex string |
Идентификатор тома в шестнадцатеричном формате. Возвращается: при успешном выполнении |
|
boolean |
Указывает, включено ли совместное использование сокращения объема данных. Возвращается: при успешном выполнении |
|
luns list / elements=dictionary |
Список LUN, связанных с томом. Возвращается: при успешном выполнении |
|
nickname string |
Псевдоним тома. Возвращается: при успешном выполнении |
|
number_of_connecting_servers integer |
Количество серверов, подключенных к тому. Возвращается: при успешном выполнении |
|
number_of_snapshots integer |
Количество снимков тома. Возвращается: при успешном выполнении |
|
parent_volume_id integer |
Идентификатор родительского тома. Возвращается: при успешном выполнении |
|
parent_volume_id_hex string |
Идентификатор родительского тома в шестнадцатеричном формате. Возвращается: при успешном выполнении |
|
pool_id integer |
Идентификатор пула. Возвращается: при успешном выполнении |
|
pool_name string |
Имя пула. Возвращается: при успешном выполнении |
|
qos_settings dictionary |
Настройки QoS для тома. Возвращается: при успешном выполнении |
|
reserved_capacity integer |
Зарезервированная емкость тома. Возвращается: при успешном выполнении |
|
total_capacity integer |
Общая емкость тома. Возвращается: при успешном выполнении |
|
total_capacity_in_mb integer |
Общая емкость в МБ. Возвращается: при успешном выполнении |
|
used_capacity integer |
Используемая емкость тома. Возвращается: при успешном выполнении |
|
used_capacity_in_mb integer |
Используемая емкость в МБ. Возвращается: при успешном выполнении |
|
volume_types list / elements=string |
Список типов томов. Возвращается: при успешном выполнении |
Ссылки на коллекцию
© 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_vsp_one_volume_facts_module.html