Spec-Zone.ru › Ansible

community.vmware.vmware_vmkernel модуль — Управляет адаптером VMware VMkernel хоста ESXi.

Примечание

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

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

Для установки используйте: ansible-galaxy collection install community.vmware.

Для использования в плейбуке укажите: community.vmware.vmware_vmkernel.

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

Описание

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

Параметры

Параметр

Комментарии

device

строка

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

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

dvswitch_name

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

строка

Имя переключателя vSphere Distributed Switch (vDS), куда добавить интерфейс VMKernel.

Требуемый параметр только если state=present.

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

enable_backup_nfc

логическое

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

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

Этот параметр разрешен только если используется стандартный стек TCP/IP.

Варианты:

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

enable_ft

логическое

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

Этот параметр разрешен только если используется стандартный стек TCP/IP.

Варианты:

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

enable_mgmt

логическое

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

Этот параметр разрешен только если используется стандартный стек TCP/IP.

Варианты:

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

enable_provisioning

логическое

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

Этот параметр разрешен только если используется стандартный стек TCP/IP.

Варианты:

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

enable_replication

логическое

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

Этот параметр разрешен только если используется стандартный стек TCP/IP.

Варианты:

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

enable_replication_nfc

логическое

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

Этот параметр разрешен только если используется стандартный стек TCP/IP.

Варианты:

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

enable_vmotion

логическое

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

Этот параметр разрешен только если используется стандартный стек TCP/IP.

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

Варианты:

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

enable_vsan

логическое

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

Этот параметр разрешен только если используется стандартный стек TCP/IP.

Варианты:

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

esxi_hostname

строка / обязательный

Имя хоста ESXi, на котором необходимо управлять VMKernel.

hostname

строка

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

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

mtu

целое число

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

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

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

network

словарь

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

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

default_gateway

строка

Основной шлюз (переопределить основной шлюз для этого адаптера).

ip_address

строка

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

Требуется, если network.type=static.

subnet_mask

строка

Требуется статическая маска подсети.

Требуется, если network.type=static.

END_OF_DOCUMENT_MARKER

tcpip_stack

string

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

Варианты:

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

type

string

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

Варианты:

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

password

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

string

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

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

port

integer

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

Если значение не указано в задаче, будет использовано значение переменной окружения 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 или ESXi.

Если значение не указано в задаче, будет использовано значение переменной окружения 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 чувствительны к регистру.

Примеры

-  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": "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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/vmware/vmware_vmkernel_module.html

Spec-Zone.ru

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