community.vmware.vcenter_standard_key_provider модуль — Добавить, переконфигурировать или удалить стандартный поставщик ключей на сервере vCenter

Примечание

Этот модуль является частью коллекции community.vmware (версия 4.7.1).

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

Для её установки используйте: ansible-galaxy collection install community.vmware.

Для использования в книге задач укажите: community.vmware.vcenter_standard_key_provider.

Описание
Параметры
Примечания
Примеры
Возвращаемые значения

Описание

Этот модуль используется для добавления, переконфигурации или удаления стандартного поставщика ключей на сервере vCenter. Обратитесь к документации VMware для получения дополнительной информации: Стандартный поставщик ключей

Параметры

Параметр	Комментарии
hostname строка	Имя хоста или IP-адрес сервера vSphere vCenter или ESXi. Если значение не указано в задаче, будет использовано значение переменной окружения `VMWARE_HOST`.
kms_info список / элементы=словарь	Информация об внешнем сервере ключей (KMS). `kms_info[].kms_name`, `kms_info[].kms_ip` необходимы при добавлении стандартного поставщика ключей. Если `kms_info[].kms_port` не указано, будет использоваться порт по умолчанию 5696. `kms_info[].kms_ip`, `kms_info[].kms_port` могут быть переконфигурированы для существующего KMS с именем `kms_info[].kms_name`. По умолчанию: `[]`
kms_ip строка	IP-адрес внешнего KMS.
kms_name строка	Имя KMS для конфигурации.
kms_port целое число	Порт внешнего KMS.
remove_kms булево	Удалить настроенный KMS с именем `kms_info[].kms_name` из кластера KMIP. Варианты: `false` `true`
kms_password строка	Пароль для аутентификации на KMS.
kms_username строка	Имя пользователя для аутентификации на KMS.
make_kms_trust_vc словарь	После добавления стандартного поставщика ключей на сервер vCenter можно установить доверенное соединение. Точный процесс зависит от сертификатов, которые принимает поставщик ключей, и политики вашей компании. Реализованы три метода: (1) загрузка клиентского сертификата и закрытого ключа через параметры `make_kms_trust_vc.upload_client_cert` и `make_kms_trust_vc.upload_client_key`, (2) генерация, обновление, загрузка самозаверяющегося сертификата vCenter через параметр `make_kms_trust_vc.download_self_signed_cert`, (3) загрузка запроса на подпись сертификата (CSR) через параметр `make_kms_trust_vc.download_client_csr`, отправка его на KMS, затем загрузка подписанного KMS CSR через параметр `make_kms_trust_vc.upload_kms_signed_client_csr`. Это не является обязательным; если не указано, необходимо вручную настроить доверенное соединение с KMS в vCenter.
download_client_csr путь	Абсолютный путь на локальной машине для хранения сгенерированного vCenter CSR. Затем загрузите подписанный KMS CSR с помощью `make_kms_trust_vc.upload_kms_signed_client_csr` в vCenter.
download_self_signed_cert путь	Абсолютный путь на локальной машине для хранения сгенерированного vCenter самозаверяющегося клиентского сертификата.
upload_client_cert путь	Абсолютный путь к файлу клиентского сертификата. Запросите сертификат и закрытый ключ у поставщика KMS. Файлы имеют формат X509 в формате PEM. Сертификат, возможно, уже доверен сервером KMS.
upload_client_key путь	Абсолютный путь к файлу закрытого ключа клиента, который необходимо загрузить вместе с `make_kms_trust_vc.upload_client_cert`.
upload_kms_signed_client_csr путь	Абсолютный путь к файлу подписанного KMS CSR, загруженного из `make_kms_trust_vc.download_client_csr`.
mark_default булево	Установить указанный поставщик ключей с именем `name` в качестве поставщика ключей по умолчанию. Если новый добавленный поставщик ключей является единственным в vCenter, то после добавления он будет отмечен как поставщик ключей по умолчанию. Варианты: `false` ← (по умолчанию) `true`
name строка / обязательно	Имя поставщика ключей, которое нужно добавить, переконфигурировать или удалить из vCenter.
password псевдонимы: pass, pwd строка	Пароль сервера vSphere vCenter или ESXi. Если значение не указано в задаче, будет использовано значение переменной окружения `VMWARE_PASSWORD`.
port целое число	Номер порта сервера vSphere vCenter или ESXi. Если значение не указано в задаче, будет использовано значение переменной окружения `VMWARE_PORT`. По умолчанию: `443`

END_OF_DOCUMENT_MARKER

proxy_host string	Адрес прокси-сервера, который будет получать все запросы HTTPS и перенаправлять их. Формат — имя хоста или IP-адрес. Если значение не указано в задаче, будет использовано значение переменной окружения `VMWARE_PROXY_HOST`.
proxy_port integer	Порт прокси-сервера.
proxy_server string	Адрес прокси-сервера для подключения к KMS.
state string	Если установлено в `absent`, указанный поставщик ключей будет удален из vCenter. Если установлено в `present`, существующий поставщик ключей с указанным именем будет переконфигурирован или будет добавлен новый поставщик ключей. Варианты: `"present"` ← (по умолчанию) `"absent"`
username псевдонимы: admin, user string	Имя пользователя сервера vSphere vCenter или ESXi. Если значение не указано в задаче, будет использовано значение переменной окружения `VMWARE_USER`.
validate_certs boolean	Разрешает подключение, когда SSL-сертификаты недействительны. Установите в `false`, если сертификаты ненадёжны. Если значение не указано в задаче, будет использовано значение переменной окружения `VMWARE_VALIDATE_CERTS`. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

Все модули требуют доступа к API для записи и поэтому не поддерживаются в бесплатной лицензии ESXi.
Все переменные и имена объектов VMware чувствительны к регистру.

Примеры

- name: Add a new Standard Key Provider with client certificate and private key
  community.vmware.vcenter_standard_key_provider:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    name: 'test_standard_kp'
    state: 'present'
    mark_default: true
    kms_info:
      - kms_name: test_kms_1
        kms_ip: 192.168.1.10
    make_kms_trust_vc:
      upload_client_cert: "/tmp/test_cert.pem"
      upload_client_key: "/tmp/test_cert_key.pem"
  register: add_skp_result

- name: Remove the KMS from the key provider cluster
  community.vmware.vcenter_standard_key_provider:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    name: 'test_standard_kp'
    state: 'present'
    kms_info:
      - kms_name: test_kms_1
        remove_kms: true
  register: remove_kms_result

- name: Remove the Standard Key Provider
  community.vmware.vcenter_standard_key_provider:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    name: 'test_standard_kp'
    state: 'absent'
  register: remove_kp_result

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

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

Ключ	Описание
key_provider_clusters список / элементы=строка	Информация о кластере поставщика ключей. Возвращается: всегда Пример: `[{"has_backup": null, "key_id": null, "key_provide_id": "test_standard", "management_type": null, "servers": [{"address": "192.168.1.10", "name": "test_kms", "port": 5696, "protocol": "", "proxy": "", "proxy_port": null, "user_name": ""}], "tpm_required": null, "use_as_default": true}]`

Ключ

Описание

key_provider_clusters

список / элементы=строка

Информация о кластере поставщика ключей.

Возвращается: всегда

Пример: [{"has_backup": null, "key_id": null, "key_provide_id": "test_standard", "management_type": null, "servers": [{"address": "192.168.1.10", "name": "test_kms", "port": 5696, "protocol": "", "proxy": "", "proxy_port": null, "user_name": ""}], "tpm_required": null, "use_as_default": true}]

Авторы

Diane Wang (@Tomorrow9)

Ссылки на коллекции

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/vmware/vcenter_standard_key_provider_module.html