Spec-Zone.ru › Ansible

Модуль community.vmware.vmware_guest_tpm – Добавление или удаление устройства vTPM для указанной виртуальной машины.

Примечание

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

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

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

Для использования в playbook, укажите: community.vmware.vmware_guest_tpm.

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

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

  • Этот модуль используется для добавления или удаления устройства виртуального доверенного платформенного модуля (vTPM) для существующей виртуальной машины. Перед добавлением vTPM необходимо создать поставщика ключей в vCenter. Хосты ESXi, работающие в вашей среде, должны быть ESXi 6.7 или более поздней версии (гостевая ОС Windows) или 7.0 Update 2 (гостевая ОС Linux).

Параметры

Параметр

Комментарии

datacenter

string / required

Имя центра обработки данных vCenter, используемое для получения указанного кластера или хоста.

folder

string

Папка виртуальной машины, абсолютный или относительный путь для поиска существующей виртуальной машины.

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

Папка должна включать имя центра обработки данных.

Примеры:

folder: /datacenter1/vm

folder: datacenter1/vm

folder: /datacenter1/vm/folder1

folder: datacenter1/vm/folder1

folder: /folder1/datacenter1/vm

folder: folder1/datacenter1/vm

folder: /folder1/datacenter1/vm/folder2

hostname

string

Имя хоста или IP-адрес сервера vSphere vCenter или ESXi.

Если значение не указано в задаче, вместо него будет использовано значение переменной среды VMWARE_HOST.

moid

string

Идентификатор управляемого объекта экземпляра для управления, если известен; это уникальный идентификатор только в пределах одного экземпляра vCenter.

Это необходимо, если не указан name или uuid.

name

string

Имя виртуальной машины.

Это необходимо, если не указан параметр uuid или moid.

password

aliases: pass, pwd

string

Пароль сервера vSphere vCenter или ESXi.

Если значение не указано в задаче, вместо него будет использовано значение переменной среды VMWARE_PASSWORD.

port

integer

Номер порта сервера vSphere vCenter или ESXi.

Если значение не указано в задаче, вместо него будет использовано значение переменной среды VMWARE_PORT.

По умолчанию: 443

proxy_host

string

Адрес прокси-сервера, который будет принимать все запросы HTTPS и передавать их.

Формат – имя хоста или IP-адрес.

Если значение не указано в задаче, вместо него будет использовано значение переменной среды VMWARE_PROXY_HOST.

proxy_port

integer

Порт HTTP-прокси, который будет принимать все запросы HTTPS и передавать их.

Если значение не указано в задаче, вместо него будет использовано значение переменной среды VMWARE_PROXY_PORT.

state

string

Состояние устройства vTPM.

Если установлено значение «absent», устройство vTPM будет удалено из виртуальной машины.

Если установлено значение «present», устройство vTPM будет добавлено, если оно отсутствует.

Виртуальная машина должна быть выключена перед добавлением или удалением устройства vTPM.

Виртуальная машина не должна содержать снимки перед добавлением устройства vTPM.

Варианты:

  • "present" ← (по умолчанию)
  • "absent"

username

aliases: admin, user

string

Имя пользователя сервера vSphere vCenter или ESXi.

Если значение не указано в задаче, вместо него будет использовано значение переменной среды VMWARE_USER.

uuid

string

UUID экземпляра для управления, если известен; это уникальный идентификатор VMware.

Это необходимо, если не указан параметр name или moid.

validate_certs

boolean

Разрешает подключение, когда SSL-сертификаты недействительны. Установите в false, когда сертификаты не являются доверенными.

Если значение не указано в задаче, вместо него будет использовано значение переменной среды VMWARE_VALIDATE_CERTS.

Варианты:

  • false
  • true ← (по умолчанию)

Примечания

Примечание

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

Примеры

- name: Add vTPM to specified VM
  community.vmware.vmware_guest_tpm:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    datacenter: "{{ datacenter }}"
    name: "Test_VM"
    state: present
  delegate_to: localhost

- name: Remove vTPM from specified VM
  community.vmware.vmware_guest_tpm:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    datacenter: "{{ datacenter }}"
    name: "Test_VM"
    state: absent
  delegate_to: localhost

Значения возврата

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

Ключ

Описание

instance

словарь

метаданные о виртуальном устройстве vTPM

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

Пример: "None"

Авторы

  • 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/vmware_guest_tpm_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API