Модуль hitachivantara.vspone_object.oneobject_node.hv_kmip_server_facts — получение списка серверов KMIP

Примечание

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

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

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

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

Добавлено в hitachivantara.vspone_object 1.0.0

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

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

Этот модуль запрашивает список всех настроенных внешних серверов KMIP.

Требования

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

python >= 3.7

Параметры

Параметр	Комментарии
connection_info dictionary / обязательный	Данные, необходимые для установления соединения с системой.
cluster_name string / обязательный	Имя кластера системы.
http_request_retry_interval_seconds integer / обязательный	Интервал между повторными попытками HTTP-запроса.
http_request_retry_times integer / обязательный	Количество повторных попыток HTTP-запроса.
http_request_timeout integer / обязательный	Время ожидания ответа на HTTP-запрос.
oneobject_node_client_id string / обязательный	Идентификатор для аутентификации.
oneobject_node_client_secret string	Секрет для аутентификации.
oneobject_node_username string / обязательный	Имя пользователя для аутентификации.
oneobject_node_userpass string / обязательный	Пароль для аутентификации.
region string / обязательный	Регион системы.
ssl dictionary	Конфигурация SSL.
ca_certs string	Путь к файлу сертификатов CA. По умолчанию: `""`
ca_path string	Путь к файлу сертификата CA. По умолчанию: `""`
check_hostname boolean	Проверять ли имя хоста. Варианты: `false` ← (по умолчанию) `true`
client_cert string	Путь к файлу сертификата клиента. По умолчанию: `""`
client_key string	Путь к файлу ключа клиента. По умолчанию: `""`
ssl_cipher string	Используемый шифр SSL. По умолчанию: `""`
ssl_version string	Используемая версия SSL. По умолчанию: `""`
validate_certs boolean / обязательный	Проверять ли сертификаты SSL. Варианты: `false` `true`
spec dictionary	Параметры запроса для получения серверов KMIP.
name string	Имя сервера KMIP, назначенное пользователем, сведения о котором требуется получить. Укажите не более 63 символов Unicode.

Атрибуты

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

Примеры

- name: List KMIP servers
  hitachivantara.vspone_object.oneobject_node.hv_kmip_server_facts:
    connection_info:
      http_request_timeout: 300
      http_request_retry_times: 3
      http_request_retry_interval_seconds: 5
      cluster_name: "your_cluster_name"
      region: "your_region"
      oneobject_node_username: "your_username"
      oneobject_node_userpass: "your_password"
      oneobject_node_client_id: "vsp-object-external-client"

- name: Get KMIP server by name
  hitachivantara.vspone_object.oneobject_node.hv_kmip_server_facts:
    connection_info:
      http_request_timeout: 300
      http_request_retry_times: 3
      http_request_retry_interval_seconds: 5
      cluster_name: "your_cluster_name"
      region: "your_region"
      oneobject_node_username: "your_username"
      oneobject_node_userpass: "your_password"
      oneobject_node_client_id: "vsp-object-external-client"
    spec:
      name: "test_kmip_server"

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

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

Ключ	Описание
kmip_servers dictionary	Содержит подробные сведения о серверах KMIP. Возвращается: при успешном выполнении
servers dictionary	Словарь серверов KMIP, ключами которого являются их имена. Возвращается: при успешном выполнении
host string	Имя хоста или IP-адрес сервера KMIP. Возвращается: при успешном выполнении Пример: `"urloripaddressofkmipserver"`
https_ciphers string	Строка со списком шифров, разделенных запятыми. Возвращается: при успешном выполнении Пример: `"TLS_RSA_WITH_AES_128_CBC_SHA256,TLS_AES_256_GCM_SHA384"`
is_online boolean	Находится ли сервер KMIP в сети. Возвращается: при успешном выполнении Пример: `false`
is_primary boolean	Является ли сервер KMIP основным сервером. Возвращается: при успешном выполнении Пример: `true`
is_tls12_enabled boolean	Включен ли TLS v1.2 на сервере KMIP. Возвращается: при успешном выполнении Пример: `true`
kmip_protocol string	Версия протокола KMIP. Возвращается: при успешном выполнении Пример: `"V1_3"`
name string	Имя сервера KMIP. Возвращается: при успешном выполнении Пример: `"test_kmip_server"`
port integer	Номер порта сервера KMIP. Возвращается: при успешном выполнении Пример: `5696`
uuid string	UUID сервера. Возвращается: при успешном выполнении Пример: `"f2e39602-d960-4812-8c89-3b31212dfdca"`

Авторы

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_object/oneobject_node.hv_kmip_server_facts_module.html