Spec-Zone.ru › Ansible

Модуль community.vmware.vmware_vmkernel — управление адаптером VMware VMkernel узла ESXi.

Примечание

Этот модуль входит в коллекцию community.vmware (версия 6.2.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Чтобы установить её, используйте: ansible-galaxy collection install community.vmware.

Чтобы использовать её в плейбуке, укажите: community.vmware.vmware_vmkernel.

  • Краткое описание
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Краткое описание

  • Этот модуль можно использовать для управления адаптерами VMKernel / сетевыми интерфейсами VMKernel узла ESXi.
  • Модуль предполагает, что для узла уже настроена группа портов в случае стандартного коммутатора vSphere (vSS).
  • Модуль предполагает, что для узла уже настроена распределённая группа портов в случае распределённого коммутатора vSphere (vDS).
  • При наличии адаптера модуль автоматически переносит его с vSS на vDS или наоборот.

Параметры

Параметр

Комментарии

device

string

Поиск адаптера VMkernel по имени устройства.

Параметр требуется только в случае network.type=dhcp.

dvswitch_name

псевдонимы: dvswitch

string

Имя распределённого коммутатора vSphere (vDS), в который нужно добавить интерфейс VMKernel.

Обязательный параметр только в случае state=present.

Необязательный параметр начиная с версии 2.8.

enable_backup_nfc

boolean

добавлено в community.vmware 4.2.0

Включить трафик vSphere Backup NFC для адаптера VMKernel.

Этот параметр разрешено использовать только с используемым по умолчанию стеком TCP/IP.

Варианты:

  • false ← (по умолчанию)
  • true

enable_ft

boolean

Включить трафик Fault Tolerance для адаптера VMKernel.

Этот параметр разрешено использовать только с используемым по умолчанию стеком TCP/IP.

Варианты:

  • false ← (по умолчанию)
  • true

enable_mgmt

boolean

Включить трафик управления для адаптера VMKernel.

Этот параметр разрешено использовать только с используемым по умолчанию стеком TCP/IP.

Варианты:

  • false ← (по умолчанию)
  • true

enable_provisioning

boolean

Включить трафик Provisioning для адаптера VMKernel.

Этот параметр разрешено использовать только с используемым по умолчанию стеком TCP/IP.

Варианты:

  • false ← (по умолчанию)
  • true

enable_replication

boolean

Включить трафик vSphere Replication для адаптера VMKernel.

Этот параметр разрешено использовать только с используемым по умолчанию стеком TCP/IP.

Варианты:

  • false ← (по умолчанию)
  • true

enable_replication_nfc

boolean

Включить трафик vSphere Replication NFC для адаптера VMKernel.

Этот параметр разрешено использовать только с используемым по умолчанию стеком TCP/IP.

Варианты:

  • false ← (по умолчанию)
  • true

enable_vmotion

boolean

Включить трафик vMotion для адаптера VMKernel.

Этот параметр разрешено использовать только с используемым по умолчанию стеком TCP/IP.

Нельзя включить vMotion на дополнительном адаптере, если уже имеется адаптер с настроенным стеком TCP/IP vMotion.

Варианты:

  • false ← (по умолчанию)
  • true

enable_vsan

boolean

Включить трафик VSAN для адаптера VMKernel.

Этот параметр разрешено использовать только с используемым по умолчанию стеком TCP/IP.

Варианты:

  • false ← (по умолчанию)
  • true

esxi_hostname

string / обязательный

Имя узла ESXi, для которого нужно управлять VMKernel.

hostname

string

Имя хоста или IP-адрес сервера vSphere vCenter.

Если значение не указано в задаче, вместо него будет использоваться значение переменной среды VMWARE_HOST.

mtu

integer

MTU интерфейса VMKernel.

Значение по умолчанию 1500 действительно начиная с версии 2.5.

По умолчанию: 1500

network

dictionary

Словарь с параметрами сети.

По умолчанию: {"tcpip_stack": "default", "type": "static"}

default_gateway

string

Шлюз IPv4 по умолчанию (переопределяет шлюз по умолчанию для этого адаптера).

ip_address

string

Статический адрес IPv4.

Обязателен, если network.type=static и state=present.

subnet_mask

string

Статическая маска подсети IPv4.

Обязательна, если network.type=static и state=present.

tcpip_stack

string

Стек TCP/IP для интерфейса VMKernel.

Варианты:

  • "default" ← (по умолчанию)
  • "provisioning"
  • "vmotion"
  • "vxlan"

type

string

Тип назначения IP-адреса.

Варианты:

  • "static" ← (по умолчанию)
  • "dhcp"

password

псевдонимы: pass, pwd

string

Пароль сервера vSphere vCenter.

Если значение не указано в задаче, вместо него будет использоваться значение переменной среды VMWARE_PASSWORD.

port

integer

Номер порта сервера vSphere vCenter.

Если значение не указано в задаче, вместо него будет использоваться значение переменной среды VMWARE_PORT.

По умолчанию: 443

portgroup_name

псевдонимы: portgroup

string / обязательный

Имя группы портов для интерфейса VMKernel.

proxy_host

string

Адрес прокси-сервера, который будет принимать и перенаправлять все HTTPS-запросы.

Укажите имя хоста или IP-адрес.

Если значение не указано в задаче, вместо него будет использоваться значение переменной среды VMWARE_PROXY_HOST.

proxy_port

integer

Порт HTTP-прокси-сервера, который будет принимать и перенаправлять все HTTPS-запросы.

Если значение не указано в задаче, вместо него будет использоваться значение переменной среды VMWARE_PROXY_PORT.

state

string

Если задано значение present, адаптер VMKernel будет создан с указанными параметрами.

Если задано значение absent, адаптер VMKernel будет удалён.

Если задано значение present и адаптер VMKernel существует, его конфигурация будет обновлена.

Варианты:

  • "present" ← (по умолчанию)
  • "absent"

username

псевдонимы: admin, user

string

Имя пользователя сервера vSphere vCenter.

Если значение не указано в задаче, вместо него будет использоваться значение переменной среды VMWARE_USER.

validate_certs

boolean

Разрешает подключение при недействительных SSL-сертификатах. Установите значение false, если сертификаты не являются доверенными.

Если значение не указано в задаче, вместо него будет использоваться значение переменной среды VMWARE_VALIDATE_CERTS.

Варианты:

  • false
  • true ← (по умолчанию)

vswitch_name

псевдонимы: vswitch

string

Имя vSwitch, в который нужно добавить интерфейс VMKernel.

Обязательный параметр только в случае state=present.

Необязательный параметр начиная с версии 2.5.

Примечания

Примечание

  • Параметр device необходимо использовать с DHCP, поскольку в противном случае невозможно проверить, существует ли уже устройство VMkernel.
  • Можно за один шаг переключиться с DHCP на статический адрес и с vSS на vDS или наоборот, не создавая новое устройство, если указан параметр device.
  • Создать адаптер VMKernel на vDS можно только при аутентификации в vCenter, но не при аутентификации в ESXi.
  • Для всех модулей требуется доступ на запись к API, поэтому они не поддерживаются бесплатной лицензией ESXi.
  • Имена всех переменных и объектов VMware чувствительны к регистру.
  • Модули могут использовать библиотеку Python «requests», которая по умолчанию не использует системное хранилище сертификатов. Указать хранилище сертификатов можно, задав переменную среды REQUESTS_CA_BUNDLE. Обратите внимание: наличие этой переменной в некоторых случаях может привести к игнорированию значения «false» параметра «validate_certs». Пример: «export REQUESTS_CA_BUNDLE=/path/to/your/ca_bundle.pem»

Примеры

-  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

dictionary

метаданные об имени VMKernel

Возвращается: всегда

Пример: {"changed": false, "device": "vmk1", "ipv4": "static", "ipv4_gw": "No override", "ipv4_ip": "192.168.1.15", "ipv4_sm": "255.255.255.0", "msg": "VMkernel Adapter already configured properly", "mtu": 9000, "services": "vMotion", "switch": "vDS"}

Авторы

  • Joseph Callen (@jcpowermac)
  • Russell Teague (@mtnbikenc)
  • Abhijeet Kasurde (@Akasurde)
  • Christian Kotte (@ckotte)
  • Nina Loser (@Nina2244)

Ссылки на коллекцию

  • Отслеживание проблем
  • Домашняя страница
  • Репозиторий (исходный код)

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/vmware/vmware_vmkernel_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API