Модуль theforeman.foreman.subnet — управление подсетями

Примечание

Этот модуль входит в коллекцию theforeman.foreman (версия 5.11.0).

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

Чтобы установить её, используйте: ansible-galaxy collection install theforeman.foreman. Для использования этого модуля необходимы дополнительные зависимости; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: theforeman.foreman.subnet.

Добавлено в theforeman.foreman 1.0.0

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

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

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

Псевдонимы: foreman_subnet

Требования

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

requests

Параметры

Параметр	Комментарии
bmc_proxy string добавлено в theforeman.foreman 2.1.0	Прокси Smart Proxy BMC для этой подсети
boot_mode string	Режим загрузки, используемый хостами в этой подсети Варианты: `"DHCP"` ← (по умолчанию) `"Static"`
ca_path path	Файл в формате PEM, содержащий сертификат CA, который будет использоваться для проверки. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `FOREMAN_CA_PATH`.
cidr integer	Длина префикса CIDR; требуется, если network_type=IPv4 и параметр mask не указан
description string	Описание подсети
dhcp_proxy string	Прокси Smart Proxy DHCP для этой подсети
discovery_proxy string	Прокси Smart Proxy Discovery для этой подсети Этот параметр доступен только при установленном плагине discovery.
dns_primary string	Основной DNS-сервер для этой подсети
dns_proxy string	Прокси Smart Proxy обратного DNS для этой подсети
dns_secondary string	Вторичный DNS-сервер для этой подсети
domains list / элементы=string	Список DNS-доменов, которым должна быть назначена подсеть
externalipam_group string добавлено в theforeman.foreman 1.5.0	Группа внешней IPAM для этой подсети. Имеет значение только при ipam=External IPAM.
externalipam_proxy string	Прокси внешней IPAM для этой подсети. Имеет значение только при ipam=External IPAM.
from_ip string	Первый IP-адрес в пуле выделения IP-адресов хостам
gateway string	IP-адрес шлюза подсети
httpboot_proxy string	Прокси Smart Proxy HTTP Boot для этой подсети
ipam string	Режим IPAM для этой подсети Варианты: `"DHCP"` ← (по умолчанию) `"Internal DB"` `"Random DB"` `"EUI-64"` `"External IPAM"` `"None"`
locations list / элементы=string	Список расположений, которым должна быть назначена сущность
mask string	Маска подсети. Требуется, если network_type=IPv4 и длина префикса cidr не указана
mtu integer	MTU
name string / обязательный	Имя подсети
network string / обязательный	IP-адрес подсети
network_type string	Тип подсети Варианты: `"IPv4"` ← (по умолчанию) `"IPv6"`
oauth1_consumer_key string	Ключ потребителя OAuth1 для доступа к серверу Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `FOREMAN_OAUTH1_CONSUMER_KEY`.
oauth1_consumer_secret string	Секрет потребителя OAuth1 для доступа к серверу Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `FOREMAN_OAUTH1_CONSUMER_SECRET`.
organizations list / элементы=string	Список организаций, которым должна быть назначена сущность
parameters list / элементы=dictionary	Параметры хоста для конкретной подсети
hidden_value boolean	Следует ли скрывать значение Варианты: `false` `true`
name string / обязательный	Имя параметра
parameter_type string	Тип параметра Варианты: `"string"` ← (по умолчанию) `"boolean"` `"integer"` `"real"` `"array"` `"hash"` `"yaml"` `"json"`
value any / обязательный	Значение параметра
password string	Пароль пользователя, обращающегося к серверу Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `FOREMAN_PASSWORD`.
remote_execution_proxies list / элементы=string	Прокси Smart Proxy удалённого выполнения для этой подсети Этот параметр доступен только при установленном плагине remote_execution. При использовании с remote_execution < 4.1.0 всегда будет возвращаться changed=true из-за ошибки в плагине.
server_url string / обязательный	URL сервера Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `FOREMAN_SERVER_URL`.
state string	Состояние сущности Варианты: `"present"` ← (по умолчанию) `"absent"`
template_proxy string	Прокси Smart Proxy шаблонов для этой подсети
tftp_proxy string	Прокси Smart Proxy TFTP для этой подсети
to_ip string	Последний IP-адрес в пуле выделения IP-адресов хостам
updated_name string	Новое имя подсети. При задании этого параметра модуль не будет идемпотентным.
use_gssapi boolean	Использовать GSSAPI для аутентификации; обычно это Kerberos или Kerberos через аутентификацию Negotiate. Требуется установленная библиотека Python requests-gssapi. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `FOREMAN_USE_GSSAPI`. Варианты: `false` ← (по умолчанию) `true`
username string	Имя пользователя для доступа к серверу Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `FOREMAN_USERNAME`.
validate_certs boolean	Проверять ли TLS-сертификаты сервера Foreman. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `FOREMAN_VALIDATE_CERTS`. Варианты: `false` `true` ← (по умолчанию)
vlanid integer	Идентификатор VLAN

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная	Можно выполнять в режиме check_mode и возвращать прогноз изменения состояния без изменения сущности
diff_mode	Поддержка: полная	В режиме diff будут возвращены сведения об изменениях (или возможных изменениях в режиме check_mode)

Примеры

- name: My subnet
  theforeman.foreman.subnet:
    name: "My subnet"
    description: "My description"
    network: "192.168.0.0"
    mask: "255.255.255.192"
    gateway: "192.168.0.1"
    from_ip: "192.168.0.2"
    to_ip: "192.168.0.42"
    boot_mode: "Static"
    dhcp_proxy: "smart-proxy1.foo.example.com"
    tftp_proxy: "smart-proxy1.foo.example.com"
    dns_proxy: "smart-proxy2.foo.example.com"
    template_proxy: "smart-proxy2.foo.example.com"
    vlanid: 452
    mtu: 9000
    domains:
      - "foo.example.com"
      - "bar.example.com"
    organizations:
      - "Example Org"
    locations:
      - "Toulouse"
    server_url: "https://foreman.example.com"
    username: "admin"
    password: "changeme"
    state: present

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

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

Ключ	Описание
entity dictionary	Итоговое состояние затронутых сущностей, сгруппированных по типу. Возвращается: при успешном выполнении
subnets list / элементы=dictionary	Список подсетей. Возвращается: при успешном выполнении

Авторы

Baptiste Agasse (@bagasse)

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

© 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/theforeman/foreman/subnet_module.html