Модуль community.general.proxmox_nic — Управление сетевой картой (NIC) виртуальной машины Qemu(KVM) в кластере Proxmox VE

Примечание

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

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

Для её установки используйте: ansible-galaxy collection install community.general. Для использования этого модуля потребуются дополнительные зависимости. Подробности см. в разделе Требования.

Чтобы использовать его в плейбуке, укажите: community.general.proxmox_nic.

Новая в community.general 3.1.0

Описание
Требования
Параметры
Атрибуты
Примеры
Возвращаемые значения

Описание

Позволяет создавать/обновлять/удалять сетевую карту (NIC) на виртуальных машинах Qemu(KVM) в кластере Proxmox VE.

Требования

Ниже перечислены требования к хосту, на котором выполняется этот модуль.

proxmoxer
requests

Параметры

Параметр	Комментарии
api_host строка / обязательно	Укажите целевой хост кластера Proxmox VE.
api_password строка	Укажите пароль для аутентификации. Можно использовать переменную окружения `PROXMOX_PASSWORD`.
api_port целое число добавлено в community.general 9.1.0	Укажите целевой порт кластера Proxmox VE. Используется переменная окружения `PROXMOX_PORT`, если не указана.
api_token_id строка добавлено в community.general 1.3.0	Укажите идентификатор токена. Требуется `proxmoxer>=1.1.0` для работы.
api_token_secret строка добавлено в community.general 1.3.0	Укажите секрет токена. Требуется `proxmoxer>=1.1.0` для работы.
api_user строка / обязательно	Укажите пользователя для аутентификации.
bridge строка	Добавить этот интерфейс к указанному мосту. По умолчанию в Proxmox VE мост называется `vmbr0`.
firewall булево	Подлежит ли этот интерфейс защите брандмауэром. Варианты: `false` ← (по умолчанию) `true`
interface строка / обязательно	Имя интерфейса должно быть `net[n]`, где `1 ≤ n ≤ 31`.
link_down булево	Подлежит ли этот интерфейс отключению (как выключение розетки). Варианты: `false` ← (по умолчанию) `true`
mac строка	`XX:XX:XX:XX:XX:XX` должен быть уникальным MAC-адресом. Автоматически генерируется, если не указан. Если не указан, этот модуль сохранит тот же MAC-адрес при изменении существующего интерфейса.
model строка	Модель эмулятора NIC. Варианты: `"e1000"` `"e1000-82540em"` `"e1000-82544gc"` `"e1000-82545em"` `"i82551"` `"i82557b"` `"i82559er"` `"ne2k_isa"` `"ne2k_pci"` `"pcnet"` `"rtl8139"` `"virtio"` ← (по умолчанию) `"vmxnet3"`
mtu целое число	Принудительное значение MTU, только для модели `virtio`, в противном случае настройка будет проигнорирована. Установите значение `1` для использования MTU моста. Значение должно быть `1 ≤ n ≤ 65520`.
name строка	Указывает имя виртуальной машины. Используется только в веб-интерфейсе конфигурации. Требуется только для `state=present`.
queues целое число	Количество очередей пакетов, которые будут использоваться в устройстве. Значение должно быть `0 ≤ n ≤ 16`.
rate вещественное число	Предел скорости в Мбит/с (мегабит в секунду) в виде вещественного числа.
state строка	Указывает желаемое состояние сетевой карты. Варианты: `"present"` ← (по умолчанию) `"absent"`
tag целое число	Тег VLAN для применения к пакетам на этом интерфейсе. Значение должно быть `1 ≤ n ≤ 4094`.
trunks список / элементы=целое число	Список каналов VLAN для передачи через этот интерфейс.
validate_certs булево	Если `false`, сертификаты SSL не будут проверены. Это следует использовать только на контролируемых вами сайтах с использованием самозаверяющих сертификатов. Варианты: `false` ← (по умолчанию) `true`
vmid целое число	Указывает идентификатор экземпляра.

Атрибуты

Атрибут	Поддержка	Описание
action_group	Группа действий: community.general.proxmox Добавлена в community.general 9.0.0	Используйте `group/community.general.proxmox` в `module_defaults` для установки значений по умолчанию для данного модуля.
check_mode	Поддержка: полная	Может работать в `check_mode` и возвращать прогноз статуса изменения без модификации целевого объекта.
diff_mode	Поддержка: отсутствует	Возвратит подробности о том, что изменилось (или, возможно, нуждается в изменении в `check_mode`), когда используется режим diff.

Примеры

- name: Create NIC net0 targeting the vm by name
  community.general.proxmox_nic:
    api_user: root@pam
    api_password: secret
    api_host: proxmoxhost
    name: my_vm
    interface: net0
    bridge: vmbr0
    tag: 3

- name: Create NIC net0 targeting the vm by id
  community.general.proxmox_nic:
    api_user: root@pam
    api_password: secret
    api_host: proxmoxhost
    vmid: 103
    interface: net0
    bridge: vmbr0
    mac: "12:34:56:C0:FF:EE"
    firewall: true

- name: Delete NIC net0 targeting the vm by name
  community.general.proxmox_nic:
    api_user: root@pam
    api_password: secret
    api_host: proxmoxhost
    name: my_vm
    interface: net0
    state: absent

Значения возврата

Общие значения возврата описаны здесь, следующие поля уникальны для данного модуля:

Ключ	Описание
msg строка	Короткое сообщение Возвращается: всегда Пример: `"Nic net0 unchanged on VM with vmid 103"`
vmid целое число	vmid виртуальной машины. Возвращается: успех Пример: `115`

Авторы

Lammert Hellinga (@Kogelvis)

Ссылки на сборку

© 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/general/proxmox_nic_module.html