community.vmware.vmware_vmkernel – Управляет адаптером VMware VMkernel на хосте ESXi.
Примечание
Этот плагин входит в коллекцию community.vmware (версия 1.7.0).
Для его установки используйте: ansible-galaxy collection install community.vmware.
Для использования в плейбуке укажите: community.vmware.vmware_vmkernel.
Обзор
- Этот модуль можно использовать для управления адаптерами VMKernel/сетевыми интерфейсами VMKernel на хосте ESXi.
- Модуль предполагает, что хост уже настроен с группой портов в случае стандартного переключателя vSphere (vSS).
- Модуль предполагает, что хост уже настроен с распределённой группой портов в случае распределённого переключателя vSphere (vDS).
- Модуль автоматически мигрирует адаптер VMKernel с vSS на vDS или наоборот, если он существует.
Требования
Ниже перечислены требования, необходимые на хосте, на котором будет выполняться этот модуль.
- python >= 2.6
- PyVmomi
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| device строка | Поиск адаптера VMkernel по имени устройства. Параметр требуется только в случае, если type установлено в dhcp. | ||
| dvswitch_name строка | Имя распределённого переключателя vSphere (vDS), куда добавить интерфейс VMKernel. Требуемый параметр только если state установлено в present.Необязательный параметр начиная с версии 2.8. псевдонимы: dvswitch | ||
| enable_ft логическое |
| Включить трафик отказоустойчивости на адаптере VMKernel. Этот параметр разрешен только в случае использования стандартной TCP/IP-стека. | |
| enable_mgmt логическое |
| Включить трафик управления на адаптере VMKernel. Этот параметр разрешен только в случае использования стандартной TCP/IP-стека. | |
| enable_provisioning логическое |
| Включить трафик подготовки на адаптере VMKernel. Этот параметр разрешен только в случае использования стандартной TCP/IP-стека. | |
| enable_replication логическое |
| Включить трафик vSphere Replication на адаптере VMKernel. Этот параметр разрешен только в случае использования стандартной TCP/IP-стека. | |
| enable_replication_nfc логическое |
| Включить трафик vSphere Replication NFC на адаптере VMKernel. Этот параметр разрешен только в случае использования стандартной TCP/IP-стека. | |
| enable_vmotion логическое |
| Включить трафик vMotion на адаптере VMKernel. Этот параметр разрешен только в случае использования стандартной TCP/IP-стека. Вы не можете включить vMotion на дополнительном адаптере, если у вас уже есть адаптер с настроенной TCP/IP-стеком vMotion. | |
| enable_vsan логическое |
| Включить трафик VSAN на адаптере VMKernel. Этот параметр разрешен только в случае использования стандартной TCP/IP-стека. | |
| esxi_hostname строка / обязательно | Имя хоста ESXi, к которому будет управлять VMKernel. Начиная с версии 2.5, этот параметр обязателен. | ||
| hostname строка | Имя хоста или IP-адрес сервера vSphere vCenter или ESXi. Если значение не указано в задаче, будет использовано значение переменной окружения VMWARE_HOST.Поддержка переменных окружения добавлена в Ansible 2.6. | ||
| mtu целое число | Значение по умолчанию: 1500 | MTU для интерфейса VMKernel. Значение по умолчанию 1500 действует начиная с версии 2.5. | |
| network словарь | Значение по умолчанию: {"tcpip_stack": "default", "type": "static"} | Словарь с сетевыми данными. | |
| default_gateway строка | Шлюз по умолчанию (Переопределить шлюз по умолчанию для этого адаптера). | ||
| ip_address строка | Статический IP-адрес. Требуется, если type установлено в static. | ||
| subnet_mask строка | Требуется статическая маска подсети. Требуется, если type установлено в static. | ||
| tcpip_stack строка |
| TCP/IP-стек для интерфейса VMKernel. | |
| type строка |
| Тип назначения IP-адреса. | |
| password строка | Пароль сервера vSphere vCenter или ESXi. Если значение не указано в задаче, будет использовано значение переменной окружения VMWARE_PASSWORD.Поддержка переменных окружения добавлена в Ansible 2.6. псевдонимы: pass, pwd | ||
| port целое число | Значение по умолчанию: 443 | Номер порта сервера vSphere vCenter или ESXi. Если значение не указано в задаче, будет использовано значение переменной окружения VMWARE_PORT.Поддержка переменных окружения добавлена в Ansible 2.6. | |
| portgroup_name строка / обязательно | Имя группы портов для интерфейса VMKernel. псевдонимы: portgroup | ||
| proxy_host строка | Адрес прокси-сервера, который будет получать все запросы HTTPS и перенаправлять их. Формат - имя хоста или IP-адрес. Если значение не указано в задаче, будет использовано значение переменной окружения VMWARE_PROXY_HOST.Эта функция зависит от версии pyvmomi, большей, чем v6.7.1.2018.12 | ||
| proxy_port целое число | Порт HTTP-прокси-сервера, который будет получать все запросы HTTPS и перенаправлять их. Если значение не указано в задаче, будет использовано значение переменной окружения VMWARE_PROXY_PORT. | ||
| state строка |
| Если установлено в present, адаптер VMKernel будет создан с заданными параметрами.Если установлено в absent, адаптер VMKernel будет удалён.Если установлено в present, и адаптер VMKernel существует, конфигурации будут обновлены. | |
| username строка | Имя пользователя сервера vSphere vCenter или ESXi. Если значение не указано в задаче, будет использовано значение переменной окружения VMWARE_USER.Поддержка переменных окружения добавлена в Ansible 2.6. псевдонимы: admin, user | ||
| validate_certs логическое |
| Разрешает подключение, когда SSL-сертификаты недействительны. Установите в false когда сертификаты не доверяются.Если значение не указано в задаче, будет использовано значение переменной окружения VMWARE_VALIDATE_CERTS.Поддержка переменных окружения добавлена в Ansible 2.6. Если установлено в true, убедитесь, что на данном компьютере установлен Python >= 2.7.9. | |
| vswitch_name строка | Имя переключателя vSwitch, куда добавить интерфейс VMKernel. Требуемый параметр только если state установлено в present.Необязательный параметр начиная с версии 2.5. псевдонимы: vswitch | ||
Примечания
Примечание
- Параметр
deviceнеобходимо использовать с DHCP, иначе невозможно проверить, существует ли устройство VMkernel. - Вы можете изменить только с DHCP на статический, и с vSS на vDS, или наоборот, в одном шаге, без создания нового устройства, если
deviceуказано. - Вы можете создать адаптер VMKernel только на vDS, если авторизованы на vCenter, а не на ESXi.
- Тестировалось на vSphere 5.5 и 6.5
Примеры
- name: Add Management vmkernel port using static network type
community.vmware.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
community.vmware.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
community.vmware.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
community.vmware.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
community.vmware.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
community.vmware.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 Пример: {'changed': False, 'device': 'vmk1', 'ipv4': 'static', 'ipv4_gw': 'Без переопределения', 'ipv4_ip': '192.168.1.15', 'ipv4_sm': '255.255.255.0', 'msg': 'VMkernel адаптер уже правильно сконфигурирован', 'mtu': 9000, 'services': 'vMotion', 'switch': 'vDS'} |
Авторы
- Joseph Callen (@jcpowermac)
- Russell Teague (@mtnbikenc)
- Abhijeet Kasurde (@Akasurde)
- Christian Kotte (@ckotte)
© 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_vmkernel_module.html