vmware_vmkernel – Управляет адаптером VMware VMkernel хоста ESXi
Обзор
- Этот модуль может быть использован для управления адаптерами VMKernel / сетевыми интерфейсами VMKernel хоста ESXi.
- Модуль предполагает, что хост уже настроен с группой портов в случае стандартного переключателя vSphere (vSS).
- Модуль предполагает, что хост уже настроен с распределенной группой портов в случае распределенного переключателя vSphere (vDS).
- Модуль автоматически мигрирует адаптер VMKernel из vSS в vDS или наоборот, если он присутствует.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- python >= 2.6
- PyVmomi
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| device строка добавлено в 2.8 | Поиск адаптера VMkernel по имени устройства. Параметр необходим только в случае, если type установлено в dhcp. | |
| dvswitch_name строка добавлено в 2.8 | Имя распределённого коммутатора vSphere (vDS), куда добавлять интерфейс VMKernel. Требуемый параметр только если state установлено в present.Необязательный параметр начиная с версии 2.8. псевдонимы: dvswitch | |
| enable_ft логический тип |
| Включить трафик Fault Tolerance на адаптере VMKernel. Этот параметр разрешён только при использовании стандартной TCP/IP стека. |
| enable_mgmt логический тип |
| Включить трафик управления на адаптере VMKernel. Этот параметр разрешён только при использовании стандартной TCP/IP стека. |
| enable_provisioning логический тип добавлено в 2.8 |
| Включить трафик снабжения на адаптере VMKernel. Этот параметр разрешён только при использовании стандартной TCP/IP стека. |
| enable_replication логический тип добавлено в 2.8 |
| Включить трафик vSphere Replication на адаптере VMKernel. Этот параметр разрешён только при использовании стандартной TCP/IP стека. |
| enable_replication_nfc логический тип добавлено в 2.8 |
| Включить трафик vSphere Replication NFC на адаптере VMKernel. Этот параметр разрешён только при использовании стандартной TCP/IP стека. |
| enable_vmotion логический тип |
| Включить трафик vMotion на адаптере VMKernel. Этот параметр разрешён только при использовании стандартной TCP/IP стека. Вы не можете включить vMotion на дополнительном адаптере, если у вас уже есть адаптер с настроенным TCP/IP стеком vMotion. |
| enable_vsan логический тип |
| Включить трафик VSAN на адаптере VMKernel. Этот параметр разрешён только при использовании стандартной TCP/IP стека. |
| esxi_hostname строка / обязательно добавлено в 2.5 | Имя хоста ESXi, на котором будет администрироваться VMKernel. Начиная с версии 2.5, этот параметр является обязательным. | |
| hostname строка | Имя хоста или IP-адрес сервера vSphere vCenter или ESXi. Если значение не указано в задаче, будет использовано значение переменной среды VMWARE_HOST. Поддержка переменных среды добавлена в Ansible 2.6. | |
| ip_address строка | IP-адрес для интерфейса VMKernel. Используйте параметр network с ip_address. Устаревший параметр, будет удален в версии 2.9. | |
| mtu целое число | Значение по умолчанию: 1500 | MTU для интерфейса VMKernel. Значение по умолчанию 1500 действует с версии 2.5 и далее. |
| network словарь добавлено в 2.5 | Значение по умолчанию: {"tcpip_stack": "default", "type": "static"} | Словарь с параметрами сети. Требуемый параметр: - type (строка): Тип IP-адресации (либо dhcp либо static).Следующие параметры обязательны, если type установлено в static. - ip_address (строка): Статический IP-адрес (подразумевает type: static).- subnet_mask (строка): Статическая маска сети, необходимая для ip_address.Следующий параметр необязателен, если type установлено в static:- default_gateway (строка): Шлюз по умолчанию (переопределение шлюза по умолчанию для данного адаптера).Следующий параметр необязателен: - tcpip_stack (строка): TCP/IP стек для интерфейса VMKernel. Может быть default, provisioning, vmotion или vxlan. (по умолчанию: default) |
| password строка | Пароль от сервера vSphere vCenter или ESXi. Если значение не указано в задаче, будет использовано значение переменной среды VMWARE_PASSWORD.Поддержка переменных среды добавлена в Ansible 2.6. псевдонимы: pass, pwd | |
| port целое число добавлено в 2.5 | Значение по умолчанию: 443 | Номер порта сервера vSphere vCenter или ESXi. Если значение не указано в задаче, будет использовано значение переменной среды VMWARE_PORT.Поддержка переменных среды добавлена в Ansible 2.6. |
| portgroup_name строка / обязательно | Имя группы портов для интерфейса VMKernel. псевдонимы: portgroup | |
| 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 строка добавлено в 2.5 |
| Если установлено в present, адаптер VMKernel будет создан с указанными параметрами.Если установлено в absent, адаптер VMKernel будет удалён.Если установлено в present и адаптер VMKernel существует, конфигурации будут обновлены. |
| subnet_mask строка | Маска подсети для интерфейса VMKernel. Используйте параметр network с subnet_mask вместо него.Устаревший параметр, будет удалён в версии 2.9. | |
| username строка | Имя пользователя сервера vSphere vCenter или ESXi. Если значение не указано в задаче, будет использовано значение переменной среды VMWARE_USER.Поддержка переменных среды добавлена в Ansible 2.6. псевдонимы: admin, user | |
| validate_certs логический тип |
| Разрешает подключение, когда сертификаты SSL недействительны. Установите в false, когда сертификаты ненадёжные.Если значение не указано в задаче, будет использовано значение переменной среды VMWARE_VALIDATE_CERTS.Поддержка переменных среды добавлена в Ansible 2.6. Если установлено в yes, убедитесь, что на данном компьютере установлен Python >= 2.7.9. |
| vswitch_name строка | Имя vSwitch, куда добавить интерфейс VMKernel. Обязательный параметр только если state задано значение present.Необязательный параметр начиная с версии 2.5. псевдонимы: vswitch |
Примечания
Примечание
- Параметр
deviceнужно использовать с DHCP, иначе невозможно проверить, присутствует ли устройство VMkernel. - Можно изменить способ получения IP-адреса с DHCP на статический, а также тип коммутатора с vSS на vDS или наоборот, за один шаг, без создания нового устройства, при указании
device. - Создать адаптер VMKernel на vDS можно только при авторизации на vCenter, а не при авторизации на ESXi.
- Тестировалось на vSphere 5.5 и 6.5
Примеры
- name: Add Management vmkernel port using static network type
vmware_vmkernel:
hostname: '{{ esxi_hostname }}'
username: '{{ esxi_username }}'
password: '{{ esxi_password }}'
esxi_hostname: '{{ esxi_hostname }}'
vswitch_name: vSwitch0
portgroup_name: PG_0001
network:
type: 'static'
ip_address: 192.168.127.10
subnet_mask: 255.255.255.0
state: present
enable_mgmt: True
delegate_to: localhost
- name: Add Management vmkernel port using DHCP network type
vmware_vmkernel:
hostname: '{{ esxi_hostname }}'
username: '{{ esxi_username }}'
password: '{{ esxi_password }}'
esxi_hostname: '{{ esxi_hostname }}'
vswitch_name: vSwitch0
portgroup_name: PG_0002
state: present
network:
type: 'dhcp'
enable_mgmt: True
delegate_to: localhost
- name: Change IP allocation from static to dhcp
vmware_vmkernel:
hostname: '{{ esxi_hostname }}'
username: '{{ esxi_username }}'
password: '{{ esxi_password }}'
esxi_hostname: '{{ esxi_hostname }}'
vswitch_name: vSwitch0
portgroup_name: PG_0002
state: present
device: vmk1
network:
type: 'dhcp'
enable_mgmt: True
delegate_to: localhost
- name: Delete VMkernel port
vmware_vmkernel:
hostname: '{{ esxi_hostname }}'
username: '{{ esxi_username }}'
password: '{{ esxi_password }}'
esxi_hostname: '{{ esxi_hostname }}'
vswitch_name: vSwitch0
portgroup_name: PG_0002
state: absent
delegate_to: localhost
- name: Add Management vmkernel port to Distributed Switch
vmware_vmkernel:
hostname: '{{ vcenter_hostname }}'
username: '{{ vcenter_username }}'
password: '{{ vcenter_password }}'
esxi_hostname: '{{ esxi_hostname }}'
dvswitch_name: dvSwitch1
portgroup_name: dvPG_0001
network:
type: 'static'
ip_address: 192.168.127.10
subnet_mask: 255.255.255.0
state: present
enable_mgmt: True
delegate_to: localhost
- name: Add vMotion vmkernel port with vMotion TCP/IP stack
vmware_vmkernel:
hostname: '{{ vcenter_hostname }}'
username: '{{ vcenter_username }}'
password: '{{ vcenter_password }}'
esxi_hostname: '{{ esxi_hostname }}'
dvswitch_name: dvSwitch1
portgroup_name: dvPG_0001
network:
type: 'static'
ip_address: 192.168.127.10
subnet_mask: 255.255.255.0
tcpip_stack: vmotion
state: present
delegate_to: localhost
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| result словарь | всегда | метаданные о имени VMKernel Пример: {'изменено': False, 'сообщение': 'Адаптер VMkernel уже правильно настроен', 'устройство': 'vmk1', 'ipv4': 'статический', 'ipv4_шлюз': 'Без переопределения', 'ipv4_ip': '192.168.1.15', 'ipv4_sm': '255.255.255.0', 'mtu': 9000, 'сервисы': 'vMotion', 'коммутатор': 'vDS'} |
Статус
- Этот модуль не гарантирует обратную совместимость. [превью]
- Этот модуль поддерживается сообществом Ansible. [сообщество]
Авторы
- Joseph Callen (@jcpowermac)
- Russell Teague (@mtnbikenc)
- Abhijeet Kasurde (@Akasurde)
- Christian Kotte (@ckotte)
Подсказка
Если вы заметили какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 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_vmkernel_module.html