community.vmware.vmware_guest_register_operation – Операция регистрации инвентаризации ВМ

Примечание

Этот плагин входит в коллекцию community.vmware (версия 1.6.0).

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

Для использования в плейбуке укажите: community.vmware.vmware_guest_register_operation.

Обзор
Требования
Параметры
Примеры

Обзор

Этот модуль может регистрировать или удалять ВМ в инвентаризации.

Требования

Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.

python >= 2.7
PyVmomi

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
cluster строка		Укажите имя кластера для регистрации ВМ.
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 или ESXi vSphere. Если значение не указано в задаче, будет использовано значение переменной окружения `VMWARE_HOST`. Поддержка переменных окружения добавлена в Ansible 2.6.
name строка / обязательно		Укажите имя ВМ для регистрации в инвентаризации.
password строка		Пароль сервера vCenter или ESXi vSphere. Если значение не указано в задаче, будет использовано значение переменной окружения `VMWARE_PASSWORD`. Поддержка переменных окружения добавлена в Ansible 2.6. псевдонимы: pass, pwd
path строка		Укажите путь к файлу vmx. Примеры: [datastore1] vm/vm.vmx [datastore1] vm/vm.vmtx
port целое число	По умолчанию: 443	Номер порта сервера vCenter или ESXi vSphere. Если значение не указано в задаче, будет использовано значение переменной окружения `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 строка		Укажите имя пула ресурсов для регистрации ВМ. Этот параметр чувствителен к регистру. Пул ресурсов должен быть потомком выбранного родительского хоста.
state строка	Варианты: present ← absent	Укажите состояние, в котором должна находиться виртуальная машина. Если установлено значение `present`, зарегистрировать ВМ в инвентаризации. Если установлено значение `absent`, удалить ВМ из инвентаризации.
template логический тип	Варианты: no ← yes	Регистрировать ли ВМ как шаблон.
username строка		Имя пользователя сервера vCenter или ESXi vSphere. Если значение не указано в задаче, будет использовано значение переменной окружения `VMWARE_USER`. Поддержка переменных окружения добавлена в Ansible 2.6. псевдонимы: admin, user
uuid строка		UUID виртуальной машины для управления, если известен, это уникальный идентификатор VMware. Если виртуальная машина не существует, этот параметр игнорируется.
validate_certs логический тип	Варианты: no yes ←	Разрешает подключение, когда сертификаты 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–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/vmware/vmware_guest_register_operation_module.html