vmware_guest_custom_attributes – Управление пользовательскими атрибутами VMware для данной виртуальной машины
Новая версия 2.7.
Обзор
- Этот модуль может быть использован для добавления, удаления и обновления пользовательских атрибутов для данной виртуальной машины.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- python >= 2.6
- PyVmomi
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| attributes список | Значение по умолчанию: [] | Список имен и значений пользовательских атрибутов, которые необходимо управлять. Значение пользовательского атрибута не требуется и будет проигнорировано, если state установлено в absent. |
| datacenter строка / обязательно | Имя центра обработки данных, в котором находится виртуальная машина. | |
| folder строка | Абсолютный путь к существующему гостю. Этот параметр необходим, если name указан и найдено несколько виртуальных машин с одинаковым именем. | |
| hostname строка | Имя хоста или IP-адрес сервера vCenter или ESXi vSphere. Если значение не указано в задаче, используется значение переменной среды VMWARE_HOST. Поддержка переменных среды добавлена в Ansible 2.6. | |
| moid строка добавлено в 2.9 | Идентификатор управляемого объекта (Managed Object ID) экземпляра для управления, если известен. Это уникальный идентификатор только внутри одного экземпляра vCenter. Этот параметр необходим, если name или uuid не указаны. | |
| name строка / обязательно | Имя виртуальной машины для работы. Этот параметр необходим, если uuid или moid не указаны. | |
| password строка | Пароль сервера vCenter или ESXi vSphere. Если значение не указано в задаче, используется значение переменной среды VMWARE_PASSWORD. Поддержка переменных среды добавлена в Ansible 2.6. псевдонимы: pass, pwd | |
| port целое число добавлено в 2.5 | Значение по умолчанию: 443 | Номер порта сервера vCenter или ESXi vSphere. Если значение не указано в задаче, используется значение переменной среды VMWARE_PORT. Поддержка переменных среды добавлена в Ansible 2.6. |
| proxy_host строка добавлено в 2.9 | Адрес прокси, который получит все запросы HTTPS и перенаправит их. Формат — имя хоста или IP-адрес. Если значение не указано в задаче, используется значение переменной среды VMWARE_PROXY_HOST. Эта функция зависит от версии pyvmomi, большей чем v6.7.1.2018.12 | |
| proxy_port целое число добавлено в 2.9 | Порт HTTP-прокси, который получит все запросы HTTPS и перенаправит их. Если значение не указано в задаче, используется значение переменной среды VMWARE_PROXY_PORT. | |
| state строка |
| Действие, которое нужно выполнить. Если установлено значение present, пользовательский атрибут добавляется или обновляется.Если установлено значение absent, пользовательский атрибут удаляется. |
| use_instance_uuid булево добавлено в 2.8 |
| Использовать идентификатор VMware instance UUID вместо BIOS UUID. |
| username строка | Имя пользователя сервера vCenter или ESXi vSphere. Если значение не указано в задаче, используется значение переменной среды VMWARE_USER. Поддержка переменных среды добавлена в Ansible 2.6. псевдонимы: admin, user | |
| uuid строка | UUID виртуальной машины для управления, если известен. Это уникальный идентификатор VMware. Этот параметр необходим, если name или moid не указаны. | |
| validate_certs булево |
| Разрешает подключение, когда сертификаты SSL недействительны. Устанавливается в false при недоверенных сертификатах.Если значение не указано в задаче, используется значение переменной среды VMWARE_VALIDATE_CERTS. Поддержка переменных среды добавлена в Ansible 2.6. Если установлено значение yes, убедитесь, что на данном компьютере установлен Python >= 2.7.9. |
Примечания
Примечание
- Тестировалось на vSphere 6.5
Примеры
- name: Add virtual machine custom attributes
vmware_guest_custom_attributes:
hostname: "{{ vcenter_hostname }}"
username: "{{ vcenter_username }}"
password: "{{ vcenter_password }}"
uuid: 421e4592-c069-924d-ce20-7e7533fab926
state: present
attributes:
- name: MyAttribute
value: MyValue
delegate_to: localhost
register: attributes
- name: Add multiple virtual machine custom attributes
vmware_guest_custom_attributes:
hostname: "{{ vcenter_hostname }}"
username: "{{ vcenter_username }}"
password: "{{ vcenter_password }}"
uuid: 421e4592-c069-924d-ce20-7e7533fab926
state: present
attributes:
- name: MyAttribute
value: MyValue
- name: MyAttribute2
value: MyValue2
delegate_to: localhost
register: attributes
- name: Remove virtual machine Attribute
vmware_guest_custom_attributes:
hostname: "{{ vcenter_hostname }}"
username: "{{ vcenter_username }}"
password: "{{ vcenter_password }}"
uuid: 421e4592-c069-924d-ce20-7e7533fab926
state: absent
attributes:
- name: MyAttribute
delegate_to: localhost
register: attributes
- name: Remove virtual machine Attribute using Virtual Machine MoID
vmware_guest_custom_attributes:
hostname: "{{ vcenter_hostname }}"
username: "{{ vcenter_username }}"
password: "{{ vcenter_password }}"
moid: vm-42
state: absent
attributes:
- name: MyAttribute
delegate_to: localhost
register: attributes
Значения возврата
Общие значения возврата описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| custom_attributes словарь | всегда | метаданные об атрибутах виртуальной машины Пример: {'mycustom': 'my_custom_value', 'mycustom_2': 'my_custom_value_2', 'sample_1': 'sample_1_value', 'sample_2': 'sample_2_value', 'sample_3': 'sample_3_value'} |
Статус
- Гарантия обратной совместимости интерфейса этого модуля не предоставляется. [превью]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- Jimmy Conner (@cigamit)
- Abhijeet Kasurde (@Akasurde)
Подсказка
Если вы заметили какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/vmware_guest_custom_attributes_module.html
