Модуль community.vmware.vmware_guest_register_operation — операция регистрации инвентаря виртуальных машин

Примечание

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

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

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

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

Описание
Параметры
Примечания
Примеры

Описание

Этот модуль может регистрировать или отменять регистрацию виртуальных машин в инвентаре.

Параметры

Параметр	Комментарии
cluster string	Укажите имя кластера для регистрации VM.
datacenter string	Центр обработки данных назначения для операции регистрации/отмены регистрации. По умолчанию: `"ha-datacenter"`
esxi_hostname string	Имя хоста ESXi, на котором будет работать виртуальная машина.
folder string	Папка описания, абсолютный путь к целевой папке. Папка должна включать центр обработки данных. Центр обработки данных ESX — ha-datacenter. Примеры: folder: /ha-datacenter/vm folder: ha-datacenter/vm folder: /datacenter1/vm folder: datacenter1/vm folder: /datacenter1/vm/folder1 folder: datacenter1/vm/folder1
hostname string	Имя хоста или IP-адрес сервера vSphere vCenter или ESXi. Если значение не указано в задаче, вместо него будет использоваться значение переменной среды `VMWARE_HOST`.
name string / required	Укажите имя VM, которое будет зарегистрировано в инвентаре.
password aliases: pass, pwd string	Пароль сервера vSphere vCenter или ESXi. Если значение не указано в задаче, вместо него будет использоваться значение переменной среды `VMWARE_PASSWORD`.
path string	Укажите путь к файлу vmx. Примеры: [datastore1] vm/vm.vmx [datastore1] vm/vm.vmtx
port integer	Номер порта сервера vSphere vCenter или ESXi. Если значение не указано в задаче, вместо него будет использоваться значение переменной среды `VMWARE_PORT`. По умолчанию: `443`
proxy_host string	Адрес прокси-сервера, который будет принимать все запросы HTTPS и передавать их. Формат — имя хоста или IP-адрес. Если значение не указано в задаче, вместо него будет использоваться значение переменной среды `VMWARE_PROXY_HOST`.
proxy_port integer	Порт HTTP-прокси, который будет принимать все запросы HTTPS и передавать их. Если значение не указано в задаче, вместо него будет использоваться значение переменной среды `VMWARE_PROXY_PORT`.
resource_pool string	Укажите имя пула ресурсов для регистрации VM. Пул ресурсов должен быть дочерним элементом выбранного родительского хоста.
state string	Укажите состояние, в котором должна находиться виртуальная машина. если установлено в `present`, зарегистрируйте VM в инвентаре. если установлено в `absent`, отмените регистрацию VM из инвентаря. Варианты: `"present"` ← (по умолчанию) `"absent"`
template boolean	Регистрировать ли VM как шаблон. Варианты: `false` ← (по умолчанию) `true`
username aliases: admin, user string	Имя пользователя сервера vSphere vCenter или ESXi. Если значение не указано в задаче, вместо него будет использоваться значение переменной среды `VMWARE_USER`.
uuid string	UUID виртуальной машины для управления, если известен, это уникальный идентификатор VMware. Если виртуальная машина не существует, этот параметр игнорируется.
validate_certs boolean	Разрешает подключение, когда SSL-сертификаты недействительны. Установите в `false`, когда сертификаты не являются доверенными. Если значение не указано в задаче, вместо него будет использоваться значение переменной среды `VMWARE_VALIDATE_CERTS`. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

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

Примеры

- name: Register VM to inventory
  community.vmware.vmware_guest_register_operation:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    datacenter: "{{ datacenter }}"
    folder: "/vm"
    esxi_hostname: "{{ esxi_hostname }}"
    name: "{{ vm_name }}"
    template: false
    path: "[datastore1] vm/vm.vmx"
    state: present

- name: Register VM in resource pool
  community.vmware.vmware_guest_register_operation:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    datacenter: "{{ datacenter }}"
    folder: "/vm"
    resource_pool: "{{ resource_pool }}"
    name: "{{ vm_name }}"
    template: false
    path: "[datastore1] vm/vm.vmx"
    state: present

- name: Register VM in Cluster
  community.vmware.vmware_guest_register_operation:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    datacenter: "{{ datacenter }}"
    folder: "/vm"
    cluster: "{{ cluster_name }}"
    name: "{{ vm_name }}"
    template: false
    path: "[datastore1] vm/vm.vmx"
    state: present

- name: UnRegister VM from inventory
  community.vmware.vmware_guest_register_operation:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    datacenter: "{{ datacenter }}"
    folder: "/vm"
    name: "{{ vm_name }}"
    state: absent

Авторы

sky-joker (@sky-joker)

Ссылки на сборку

© 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_register_operation_module.html