community.vmware.vmware_guest_register_operation – Операция регистрации инвентаризации VM
Примечание
Этот плагин входит в коллекцию community.vmware (версия 1.7.0).
Для его установки используйте: ansible-galaxy collection install community.vmware.
Для использования в плейбуке укажите: community.vmware.vmware_guest_register_operation.
Обзор
- Этот модуль может регистрировать или аннулировать VM в инвентаризации.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- python >= 2.7
- PyVmomi
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| cluster строка | Укажите имя кластера для регистрации VM. | |
| datacenter строка | Целевой дата-центр для операции регистрации/удаления. Этот параметр чувствителен к регистру. | |
| esxi_hostname строка | Имя хоста ESXi, на котором будет запущена виртуальная машина. Этот параметр чувствителен к регистру. | |
| folder строка | Описание папки, абсолютный путь к целевой папке. Папка должна содержать дата-центр. Дата-центр 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 строка | Имя хоста или IP-адрес сервера vCenter vSphere или ESXi. Если значение не указано в задаче, вместо него будет использовано значение переменной среды VMWARE_HOST.Поддержка переменных среды добавлена в Ansible 2.6. | |
| name строка / обязательно | Укажите имя VM для регистрации в инвентаризации. | |
| password строка | Пароль сервера vCenter vSphere или ESXi. Если значение не указано в задаче, вместо него будет использовано значение переменной среды VMWARE_PASSWORD.Поддержка переменных среды добавлена в Ansible 2.6. Псевдонимы: pass, pwd | |
| path строка | Укажите путь к файлу vmx. Примеры: [datastore1] vm/vm.vmx [datastore1] vm/vm.vmtx | |
| port целое число | По умолчанию: 443 | Номер порта сервера vCenter vSphere или ESXi. Если значение не указано в задаче, вместо него будет использовано значение переменной среды VMWARE_PORT.Поддержка переменных среды добавлена в Ansible 2.6. |
| proxy_host строка | Адрес прокси-сервера, который будет получать все запросы HTTPS и пересылать их. Формат — имя хоста или IP-адрес. Если значение не указано в задаче, вместо него будет использовано значение переменной среды VMWARE_PROXY_HOST.Эта функция зависит от версии pyvmomi, большей чем v6.7.1.2018.12 | |
| proxy_port целое число | Порт HTTP-прокси, который будет получать все запросы HTTPS и пересылать их. Если значение не указано в задаче, вместо него будет использовано значение переменной среды VMWARE_PROXY_PORT. | |
| resource_pool строка | Укажите имя пула ресурсов для регистрации VM. Этот параметр чувствителен к регистру. Пул ресурсов должен быть дочерним по отношению к выбранному родительскому хосту. | |
| state строка |
| Укажите состояние, в котором должна находиться виртуальная машина. если установлено present, зарегистрировать VM в инвентаризации.если установлено absent, удалить VM из инвентаризации. |
| template логическое значение |
| Регистрировать ли VM как шаблон. |
| username строка | Имя пользователя сервера vCenter vSphere или ESXi. Если значение не указано в задаче, вместо него будет использовано значение переменной среды VMWARE_USER.Поддержка переменных среды добавлена в Ansible 2.6. Псевдонимы: admin, user | |
| uuid строка | UUID виртуальной машины для управления, если известен. Это уникальный идентификатор VMware. Если виртуальная машина не существует, этот параметр игнорируется. | |
| validate_certs логическое значение |
| Разрешить подключение, когда сертификаты SSL недействительны. Установите значение false при недоверенности сертификатов.Если значение не указано в задаче, вместо него будет использовано значение переменной среды VMWARE_VALIDATE_CERTS.Поддержка переменных среды добавлена в Ansible 2.6. Если установлено true, убедитесь, что на данном компьютере установлена Python >= 2.7.9. |
Примеры
- 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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/vmware/vmware_guest_register_operation_module.html