Модуль hitachivantara.vspone_block.sds_block.hv_sds_block_license_facts — получение лицензии (лицензий) из системы хранения SDS Block

Примечание

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

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

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

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

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

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

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

Получение всех лицензий из системы хранения SDS Block.
Получение определённой лицензии по идентификатору из системы хранения SDS Block.
Примеры см. по адресу https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/sds_block_direct/sdsb_license_facts.yml

Требования

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

python >= 3.9

Параметры

Параметр	Комментарии
connection_info словарь / обязательный	Информация, необходимая для установления соединения с системой хранения.
address строка / обязательный	IP-адрес или имя хоста системы хранения.
connection_type строка	Тип соединения с системой хранения. Варианты: `"direct"` ← (по умолчанию)
password строка / обязательный	Пароль для аутентификации. Это обязательное поле.
username строка / обязательный	Имя пользователя для аутентификации. Это обязательное поле.
spec словарь	Спецификация лицензии (лицензий) для получения. Если задано spec.id, извлекается одна лицензия по идентификатору. Если spec не задан или spec.id пуст, извлекаются все лицензии.
id строка	Уникальный идентификатор извлекаемой лицензии. Если не задан, будут извлечены все лицензии.
program_product_name строка	Название программного продукта.
status строка	Статус лицензии. Без учёта регистра. Допустимые значения: ‘Active’, ‘Warning’, ‘Overwritten’, ‘GracePeriod’, ‘Invalid’.
status_summary строка	Сводка по статусам лицензий. Варианты: `"Normal"` `"Warning"` `"Error"`

Атрибуты

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

Примеры

- name: Retrieve all licenses
  hitachivantara.vspone_block.sds_block.hv_sds_block_license_facts:
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"

- name: Retrieve specific license by ID
  hitachivantara.vspone_block.sds_block.hv_sds_block_license_facts:
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"
    spec:
      id: "4a7061b0-8cc0-4379-aec1-23184d26acd7"

Возвращаемые факты

Факты, возвращаемые этим модулем, добавляются в факты узла hostvars или обновляются в них; к ним можно обращаться по имени, как и к любым другим фактам узла. Для их использования не требуется регистрировать результат.

Ключ	Описание
license словарь	Объект одной лицензии, если задано spec.id. Значение None, если лицензия не найдена. Возвращается: если задано spec.id
licenses словарь	Словарь со всеми лицензиями, если spec.id не задан. Возвращается: если spec.id не задан
data список / элементы=словарь	Список объектов лицензий. Возвращается: при успешном выполнении
capacity_rate целое число	Коэффициент использования ёмкости. Возвращает -1, если значение не задано. Возвращается: при успешном выполнении Пример: `-1`
checked_out_license_usage_in_tib число с плавающей точкой	Использование выданной лицензии в TiB. Возвращает -1.0, если значение не задано. Возвращается: при успешном выполнении Пример: `-1.0`
id строка	Идентификатор лицензии. Возвращается: при успешном выполнении Пример: `"4a7061b0-8cc0-4379-aec1-23184d26acd7"`
key_type строка	Тип лицензионного ключа. Возвращается: при успешном выполнении Пример: `"Perpetual"`
permitted_capacity_in_tib число с плавающей точкой	Допустимая ёмкость в TiB. Возвращает -1.0, если значение не задано. Возвращается: при успешном выполнении Пример: `-1.0`
program_product_name строка	Название лицензированного программного продукта. Возвращается: при успешном выполнении Пример: `"Data At Rest Encryption"`
remaining_days целое число	Количество дней до истечения срока действия лицензии. Возвращает -1, если неприменимо (бессрочная лицензия). Возвращается: при успешном выполнении Пример: `-1`
status строка	Статус лицензии. Возвращается: при успешном выполнении Пример: `"Active"`
status_summary строка	Сводка по статусу лицензии. Возвращается: при успешном выполнении Пример: `"Normal"`
total_pool_capacity_in_gib число с плавающей точкой	Общая ёмкость пула в GiB. Возвращает -1.0, если значение не задано. Возвращается: при успешном выполнении Пример: `-1.0`

Авторы

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/sds_block.hv_sds_block_license_facts_module.html