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

Примечание

Этот модуль входит в состав коллекции community.proxmox (версия 1.6.0).

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

Для установки используйте: ansible-galaxy collection install community.proxmox. Для работы с этим модулем необходимы дополнительные компоненты; подробную информацию см. в разделе Требования.

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

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

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

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

Требования

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

proxmoxer >= 2.0
requests

Параметры

Параметр	Комментарии
api_host string / обязательный	Укажите целевой узел кластера Proxmox VE. Если значение не указано, используется переменная окружения `PROXMOX_HOST`.
api_password string	Укажите пароль для аутентификации. Если значение не указано, используется переменная окружения `PROXMOX_PASSWORD`.
api_port integer	Укажите целевой порт кластера Proxmox VE. Если значение не указано, используется переменная окружения `PROXMOX_PORT`.
api_timeout integer	Ограничение времени для запросов к API Proxmox VE. По умолчанию: `5`
api_token_id string	Укажите ID токена. Если значение не указано, используется переменная окружения `PROXMOX_TOKEN_ID`.
api_token_secret string	Укажите секрет токена. Если значение не указано, используется переменная окружения `PROXMOX_TOKEN_SECRET`.
api_user string / обязательный	Укажите пользователя для аутентификации. Если значение не указано, используется переменная окружения `PROXMOX_USER`.
bridge string	Добавьте этот интерфейс к указанному мостовому устройству. Мост Proxmox VE по умолчанию называется `vmbr0`.
ca_path path	Путь к локальному сертификату, который будет использоваться для проверки TLS-соединений. Игнорируется, если `validate_certs=false`.
firewall boolean	Следует ли защищать этот интерфейс с помощью брандмауэра. Варианты: `false` ← (по умолчанию) `true`
interface string / обязательный	Имя интерфейса; должно быть `net[n]`, где `0 ≤ n ≤ 31`.
link_down boolean	Следует ли отключить этот интерфейс (как при отключении кабеля). Варианты: `false` ← (по умолчанию) `true`
mac string	`XX:XX:XX:XX:XX:XX` должен быть уникальным MAC-адресом. Если значение не указано, оно генерируется автоматически. Если значение не указано, при изменении существующего интерфейса этот модуль сохранит его MAC-адрес.
model string	Модель эмулятора сетевой карты. Варианты: `"e1000"` `"e1000-82540em"` `"e1000-82544gc"` `"e1000-82545em"` `"i82551"` `"i82557b"` `"i82559er"` `"ne2k_isa"` `"ne2k_pci"` `"pcnet"` `"rtl8139"` `"virtio"` ← (по умолчанию) `"vmxnet3"`
mtu integer	Принудительно задаёт MTU только для модели `virtio`; в противном случае значение игнорируется. Установите значение `1`, чтобы использовать MTU моста. Значение должно быть `1 ≤ n ≤ 65520`.
name string	Указывает имя виртуальной машины. Используется только в веб-интерфейсе настройки. Обязательный параметр только для `state=present`.
queues integer	Количество очередей пакетов, используемых устройством. Значение должно быть `0 ≤ n ≤ 16`.
rate float	Ограничение скорости в МБ/с (мегабайтах в секунду), заданное числом с плавающей точкой.
state string	Указывает желаемое состояние сетевого интерфейса. Варианты: `"present"` ← (по умолчанию) `"absent"`
tag integer	Тег VLAN, применяемый к пакетам на этом интерфейсе. Значение должно быть `1 ≤ n ≤ 4094`.
trunks list / элементы=integer	Список транков VLAN, пропускаемых через этот интерфейс.
validate_certs boolean	Проверять TLS-сертификаты, используемые для подключения к API Proxmox VE. В настоящее время по умолчанию используется `false`; в community.proxmox 2.0.0 значение по умолчанию изменится на `true`. Если значение не указано, используется переменная окружения `PROXMOX_VALIDATE_CERTS`. Варианты: `false` `true`
vmid integer	Указывает ID экземпляра.

Атрибуты

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

Примеры

- name: Create NIC net0 targeting the vm by name
  community.proxmox.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.proxmox.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.proxmox.proxmox_nic:
    api_user: root@pam
    api_password: secret
    api_host: proxmoxhost
    name: my_vm
    interface: net0
    state: absent

Возвращаемые значения

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

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

Авторы

Lammert Hellinga (@Kogelvis)

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

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