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

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install community.vmware.

Чтобы использовать её в плейбуке, укажите: community.vmware.vcenter_standard_key_provider.

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

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

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

Параметры

Параметр	Комментарии
hostname string	Имя узла или IP-адрес сервера vSphere vCenter. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `VMWARE_HOST`.
kms_info list / elements=dictionary	Сведения о внешнем сервере ключей (KMS). Для добавления стандартного поставщика ключей требуются `kms_info[].kms_name` и `kms_info[].kms_ip`. Если `kms_info[].kms_port` не указано, будет использоваться порт по умолчанию 5696. Для существующего KMS с именем `kms_info[].kms_name` можно перенастроить `kms_info[].kms_ip` и `kms_info[].kms_port`. По умолчанию: `[]`
kms_ip string	IP-адрес внешнего KMS.
kms_name string	Имя настраиваемого KMS.
kms_port integer	Порт внешнего KMS.
remove_kms boolean	Удалить настроенный KMS с именем `kms_info[].kms_name` из кластера KMIP. Варианты: `false` `true`
kms_password string	Пароль для аутентификации в KMS.
kms_username string	Имя пользователя для аутентификации в KMS.
make_kms_trust_vc dictionary	После добавления стандартного поставщика ключей на сервер 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 path	Абсолютный путь на локальном компьютере для сохранения созданного vCenter запроса CSR. Затем загрузите подписанный KMS запрос CSR в vCenter с помощью `make_kms_trust_vc.upload_kms_signed_client_csr`.
download_self_signed_cert path	Абсолютный путь на локальном компьютере для сохранения созданного vCenter самоподписанного сертификата клиента.
upload_client_cert path	Абсолютный путь к файлу сертификата клиента. Запросите сертификат и закрытый ключ у поставщика KMS. Файлы должны быть в формате X509 PEM. Сертификат может уже быть доверенным для сервера KMS.
upload_client_key path	Абсолютный путь к файлу закрытого ключа клиента, загружаемого вместе с `make_kms_trust_vc.upload_client_cert`.
upload_kms_signed_client_csr path	Абсолютный путь к подписанному KMS запросу CSR, скачанному с помощью `make_kms_trust_vc.download_client_csr`.
mark_default boolean	Назначить указанный поставщик ключей с именем `name` поставщиком ключей по умолчанию. Если новый добавленный поставщик ключей является единственным поставщиком ключей в vCenter, после добавления он будет назначен поставщиком по умолчанию. Варианты: `false` ← (по умолчанию) `true`
name string / обязательный	Имя поставщика ключей, добавляемого, перенастраиваемого или удаляемого из vCenter.
password псевдонимы: pass, pwd string	Пароль сервера vSphere vCenter. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `VMWARE_PASSWORD`.
port integer	Номер порта сервера vSphere vCenter. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `VMWARE_PORT`. По умолчанию: `443`
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. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `VMWARE_USER`.
validate_certs boolean	Разрешает подключение, если SSL-сертификаты недействительны. Установите значение `false`, если сертификаты не являются доверенными. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `VMWARE_VALIDATE_CERTS`. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

Всем модулям требуется право на запись через API, поэтому они не поддерживаются бесплатной лицензией ESXi.
Все переменные и имена объектов VMware чувствительны к регистру.
Модули могут использовать библиотеку Python ‘requests’, которая по умолчанию не использует системное хранилище сертификатов. Указать хранилище сертификатов можно с помощью переменной окружения REQUESTS_CA_BUNDLE. Обратите внимание: наличие этой переменной может в некоторых случаях привести к игнорированию значения ‘false’ параметра ‘validate_certs’. Пример: ‘export REQUESTS_CA_BUNDLE=/path/to/your/ca_bundle.pem’

Примеры

- 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 list / elements=string	сведения о кластере поставщика ключей Возвращается: всегда Пример: `[{"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

list / elements=string

сведения о кластере поставщика ключей

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

Пример: [{"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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/vmware/vcenter_standard_key_provider_module.html