vmware_guest_network – Управление сетевыми адаптерами указанной виртуальной машины в заданной инфраструктуре vCenter
Новая версия с 2.9.
Описание
- Этот модуль используется для добавления, переконфигурации и удаления сетевого адаптера заданной виртуальной машины.
- Все параметры и имена объектов VMware чувствительны к регистру.
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- python >= 2.6
- PyVmomi
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| cluster строка | Имя кластера, в котором будет запущена виртуальная машина. Этот параметр обязателен, если esxi_hostname не задан.esxi_hostname и cluster — взаимно исключающие параметры. | |
| datacenter строка | Значение по умолчанию: "ha-datacenter" | Имя дата-центра, к которому принадлежит виртуальная машина. |
| esxi_hostname строка | Имя хоста ESXi, на котором будет запущена виртуальная машина. Этот параметр обязателен, если cluster не задан.esxi_hostname и cluster — взаимно исключающие параметры. | |
| folder строка | Папка назначения, абсолютный или относительный путь для поиска существующего гостевого сервера. Этот параметр обязателен только в том случае, если найдено несколько ВМ с одинаковым именем. Папка должна включать дата-центр. Дата-центр сервера ESXi — ha-datacenter. Примеры: folder: /ha-datacenter/vm folder: ha-datacenter/vm 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 | |
| gather_network_info логическое |
| Если установлено значение True, возвращаются настройки всех сетевых адаптеров, другие параметры игнорируются.Если установлено значение False, будут добавлены, переконфигурированы или удалены сетевые адаптеры в соответствии с параметрами в networks. псевдонимы: gather_network_facts |
| hostname строка | Имя хоста или IP-адрес сервера vCenter vSphere или ESXi. Если значение не указано в задаче, используется значение переменной среды VMWARE_HOST. Поддержка переменных среды добавлена в Ansible 2.6. | |
| moid строка | Идентификатор управляемого объекта экземпляра для управления, если известен. Это уникальный идентификатор только внутри одного экземпляра vCenter. Требуется, если name или uuid не указаны. | |
| name строка | Имя виртуальной машины. Этот параметр обязателен, если параметр uuid или moid не указан. | |
| networks список | Список сетевых адаптеров. mac или label или device_type необходимы для переконфигурации или удаления существующего сетевого адаптера.Если существует несколько сетевых адаптеров с одинаковым device_type, вы должны установить label или mac для соответствия одному из них, в противном случае изменения будут применены ко всем сетевым адаптерам с указанным device_type. mac, label, device_type — порядок приоритета от наибольшего к наименьшему, если все заданы.Допустимые атрибуты: - mac (строка): MAC-адрес существующего сетевого адаптера, который необходимо переконфигурировать или удалить.- label (строка): Метка существующего сетевого адаптера, который необходимо переконфигурировать или удалить, например, «Сетевой адаптер 1».- device_type (строка): Допустимые типы виртуальных сетевых устройств: e1000, e1000e, pcnet32, vmxnet2, vmxnet3 (по умолчанию), sriov. Используется для добавления нового сетевого адаптера, переконфигурации или удаления существующего сетевого адаптера с этим типом. Если mac и label не указаны или сетевой адаптер не найден по mac или label, используется этот параметр.- name (строка): Имя группы портов или распределенной виртуальной группы портов для этого интерфейса. При указании распределенной виртуальной группы портов убедитесь, что заданный esxi_hostname или cluster ассоциирован с ней.- vlan (целое число): Номер VLAN для этого интерфейса.- dvswitch_name (строка): Имя распределенного vSwitch. Это значение требуется, если существуют несколько распределенных групп портов с одинаковым именем.- state (строка): Состояние сетевого адаптера.Если установлено значение present, выполняется переконфигурация указанного сетевого адаптера.Если установлено значение new, добавляется указанный сетевой адаптер.Если установлено значение absent, удаляется этот сетевой адаптер.- manual_mac (строка): Ручной MAC-адрес сетевого адаптера при создании или переконфигурации. Если не указан при создании нового сетевого адаптера, MAC-адрес будет сгенерирован автоматически. При переконфигурации MAC-адреса ВМ должна быть выключена.- connected (логическое): Указывает, что виртуальный сетевой адаптер подключен к связанной виртуальной машине.- start_connected (логическое): Указывает, что виртуальный сетевой адаптер запускается вместе с включением связанной виртуальной машины. | |
| password строка | Пароль сервера vCenter vSphere или ESXi. Если значение не указано в задаче, используется значение переменной среды VMWARE_PASSWORD. Поддержка переменных среды добавлена в Ansible 2.6. псевдонимы: pass, pwd | |
| port целое число добавлено в 2.5 | Значение по умолчанию: 443 | Номер порта сервера vCenter vSphere или ESXi. Если значение не указано в задаче, используется значение переменной среды 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. | |
| username строка | Имя пользователя сервера vCenter vSphere или ESXi. Если значение не указано в задаче, используется значение переменной среды 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.0, 6.5 и 6.7
Примеры
- name: Change network adapter settings of virtual machine
vmware_guest_network:
hostname: "{{ vcenter_hostname }}"
username: "{{ vcenter_username }}"
password: "{{ vcenter_password }}"
datacenter: "{{ datacenter_name }}"
validate_certs: no
name: test-vm
gather_network_info: false
networks:
- name: "VM Network"
state: new
manual_mac: "00:50:56:11:22:33"
- state: present
device_type: e1000e
manual_mac: "00:50:56:44:55:66"
- state: present
label: "Network adapter 3"
connected: false
- state: absent
mac: "00:50:56:44:55:77"
delegate_to: localhost
register: network_info
- name: Change network adapter settings of virtual machine using MoID
vmware_guest_network:
hostname: "{{ vcenter_hostname }}"
username: "{{ vcenter_username }}"
password: "{{ vcenter_password }}"
datacenter: "{{ datacenter_name }}"
validate_certs: no
moid: vm-42
gather_network_info: false
networks:
- state: absent
mac: "00:50:56:44:55:77"
delegate_to: localhost
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| network_data словарь | всегда | метаданные о сетевом адаптере виртуальной машины после управления ими Пример: {'0': {'label': 'Сетевой адаптер 1', 'name': 'Сеть ВМ', 'device_type': 'E1000E', 'mac_addr': '00:50:56:89:dc:05', 'unit_number': 7, 'wake_onlan': False, 'allow_guest_ctl': True, 'connected': True, 'start_connected': True}} |
Состояние
- Данный модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [сообщество]
Авторы
- Diane Wang (@Tomorrow9) <dianew@vmware.com>
Подсказка
Если вы обнаружите какие-либо проблемы в этой документации, вы можете изменить этот документ, чтобы улучшить его.
© 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_network_module.html
