Модуль community.proxmox.proxmox_subnet — создание, обновление и удаление подсетей в SDN

Примечание

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

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

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

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

Добавлено в community.proxmox 1.4.0

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

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

Создание, обновление и удаление подсетей в Proxmox SDN.

Требования

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

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	Укажите идентификатор токена. Если параметр не указан, используется переменная окружения `PROXMOX_TOKEN_ID`.
api_token_secret string	Укажите секрет токена. Если параметр не указан, используется переменная окружения `PROXMOX_TOKEN_SECRET`.
api_user string / обязательно	Укажите пользователя для аутентификации. Если параметр не указан, используется переменная окружения `PROXMOX_USER`.
ca_path path	Путь к локальному сертификату, который будет использоваться для проверки TLS-соединений. Игнорируется, если `validate_certs=false`.
delete string	Список параметров, которые требуется удалить.
dhcp_dns_server string	IP-адрес DNS-сервера.
dhcp_range list / elements=dictionary	Диапазон IP-адресов для DHCP.
end string / обязательно	Последний IP-адрес диапазона DHCP.
start string / обязательно	Первый IP-адрес диапазона DHCP.
dhcp_range_update_mode string	Применяется только для `state=present`; изменения будут выполняться только при соблюдении условия `update=true` Если задано значение append и передан новый dhcp_range, он будет добавлен к существующим диапазонам. Если dhcp_range не передан, но существуют диапазоны, они будут проигнорированы; при необходимости будут обновлены только другие параметры. Если задано значение overwrite и передан новый dhcp_range, он заменит существующие диапазоны. Если dhcp_range не передан, но существуют диапазоны, все dhcp_ranges будут удалены. Варианты: `"append"` ← (по умолчанию) `"overwrite"`
dnszoneprefix string	Префикс DNS-зоны.
gateway string	Шлюз подсети. Для зон уровня 3 будет назначен на vnet.
lock_token string	Токен для разблокировки глобальной конфигурации SDN.
snat boolean	Включить трансляцию исходных адресов (SNAT) для подсети. Варианты: `false` ← (по умолчанию) `true`
state string	Требуемое состояние конфигурации подсети. Варианты: `"present"` ← (по умолчанию) `"absent"`
subnet string / обязательно	Подсеть в формате CIDR.
update boolean	Если `state=present`, модуль при необходимости обновит подсеть. Варианты: `false` `true` ← (по умолчанию)
validate_certs boolean	Проверять TLS-сертификаты, используемые при подключении к API Proxmox VE. В настоящее время по умолчанию задано `false`; в community.proxmox 2.0.0 значение по умолчанию изменится на `true`. Если параметр не указан, используется переменная окружения `PROXMOX_VALIDATE_CERTS`. Варианты: `false` `true`
vnet string / обязательно	Виртуальная сеть, к которой относится подсеть.
zone string	Зона vnet.

Атрибуты

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

Примеры

- name: Create a subnet
  community.proxmox.proxmox_subnet:
    api_user: "{{ pc.proxmox.api_user }}"
    api_token_id: "{{ pc.proxmox.api_token_id }}"
    api_token_secret: "{{ vault.proxmox.api_token_secret }}"
    api_host: "{{ pc.proxmox.api_host }}"
    validate_certs: false
    vnet: test
    subnet: 10.10.2.0/24
    zone: ans1
    state: present
    dhcp_range:
      - start: 10.10.2.5
        end: 10.10.2.50
      - start: 10.10.2.100
        end: 10.10.2.150
    snat: true

- name: Delete a subnet
  community.proxmox.proxmox_subnet:
    api_user: "{{ pc.proxmox.api_user }}"
    api_token_id: "{{ pc.proxmox.api_token_id }}"
    api_token_secret: "{{ vault.proxmox.api_token_secret }}"
    api_host: "{{ pc.proxmox.api_host }}"
    validate_certs: false
    vnet: test
    subnet: 10.10.2.0/24
    zone: ans1
    state: absent

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

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

Ключ	Описание
subnet string	Идентификатор созданной, обновлённой или удалённой подсети Возвращается: при успехе Пример: `"ans1-10.10.2.0-24"`

Авторы

Jana Hoch

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

© 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_subnet_module.html