Модуль hitachivantara.vspone_object.oneobject_node.hv_kmip — управление серверами KMIP на VSP One Object

Примечание

Этот модуль входит в коллекцию 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.

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

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

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

Этот модуль управляет серверами KMIP на узле Hitachi VSP One Object.

Требования

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

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.
host string	Имя хоста или IP-адрес сервера KMIP.
https_ciphers string	Строка со списком шифров, разделённых запятыми, для HTTPS-соединений. Группа по умолчанию обеспечивает совместимость с различными коммерческими системами управления ключами.
is_tls12_enabled boolean	Включён ли TLS 1.2 для сервера KMIP. `true`, если TLS v1.2 включён, `false` в противном случае. Поддержка TLS v1.2 предусмотрена только для обратной совместимости. Варианты: `false` `true` ← (по умолчанию)
kmip_protocol string	Версия протокола KMIP, назначенная серверу. По умолчанию: `"V1_4"`
name string / обязательный	Имя сервера KMIP, назначенное пользователем и предназначенное для добавления. Укажите не более 63 символов Unicode. Имя сервера должно быть уникальным.
port integer	Номер порта сервера KMIP.
uuid string	UUID сервера.
state string / обязательный	Чтобы добавить сервер KMIP, задайте для операции значение `present` Чтобы удалить сервер KMIP, задайте для операции значение `absent` Чтобы назначить сервер KMIP основным, задайте для операции значение `promote` Чтобы изменить существующий сервер KMIP, задайте для операции значение `modify` Варианты: `"present"` `"absent"` `"promote"` `"modify"`

Атрибуты

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

Примеры

- name: Add KMIP server to VSP One Object
  hitachivantara.vspone_object.oneobject_node.hv_certificates:
    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"
    state: "present"
    spec:
      name: "test_kmip_server"
      host: "urloripaddressofkmipserver"
      port: 5696
      is_tls12_enabled: true
      kmip_protocol: "V1_3"
      https_ciphers: "TLS_RSA_WITH_AES_128_CBC_SHA256"

- name: Update a KMIP server from VSP One Object
  hitachivantara.vspone_object.oneobject_node.hv_kmip:
    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"
    state: "modify"
    spec:
      name: "test_kmip_server_update"
      host: "urloripaddressofkmipserver"
      port: 5696
      is_tls12_enabled: true
      kmip_protocol: "V1_3"
      https_ciphers: "TLS_RSA_WITH_AES_128_CBC_SHA256"
      uuid: "f2e39602-d960-4812-8c89-3b31212dfdca"

- name: Promote a KMIP server from VSP One Object
  hitachivantara.vspone_object.oneobject_node.hv_kmip:
    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"
    state: "promote"
    spec:
      name: "test_kmip_server"

- name: Delete a KMIP server from VSP One Object
  hitachivantara.vspone_object.oneobject_node.hv_kmip:
    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"
    state: "absent"
    spec:
      name: "test_kmip_server"

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

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

Ключ	Описание
kmip_server dictionary	Сервер KMIP и его атрибуты. Возвращается: при успешном выполнении
host string	Имя хоста или IP-адрес сервера KMIP. Возвращается: при успешном выполнении Пример: `"urloripaddressofkmipserver"`
https_ciphers string	Строка со списком шифров, разделённых запятыми. Возвращается: при успешном выполнении Пример: `"TLS_RSA_WITH_AES_128_CBC_SHA256"`
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_module.html