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

Примечание

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

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

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

Для использования в книге задач укажите: theforeman.foreman.subnet.

Впервые в theforeman.foreman 1.0.0

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

Обзор

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

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

Требования

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

ipaddress
requests

Параметры

Параметр	Комментарии
bmc_proxy string added in theforeman.foreman 2.1.0	Прокси BMC Smart для этой подсети
boot_mode string	Режим загрузки, используемый узлами в этой подсети Choices: `"DHCP"` ← (default) `"Static"`
cidr integer	Длина префикса CIDR; Требуется, если network_type=IPv4 и не указана mask
description string	Описание подсети
dhcp_proxy string	Прокси DHCP Smart для этой подсети
discovery_proxy string	Прокси Discovery Smart для этой подсети Эта опция доступна только при установке плагина discovery.
dns_primary string	Основной DNS-сервер для этой подсети
dns_proxy string	Прокси обратного DNS для этой подсети
dns_secondary string	Вторичный DNS-сервер для этой подсети
domains list / elements=string	Список DNS-доменов, которые должны быть назначены подсети
externalipam_group string added in 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	Прокси HTTP Boot Smart для этой подсети
ipam string	Режим IPAM для этой подсети Choices: `"DHCP"` ← (default) `"Internal DB"` `"Random DB"` `"EUI-64"` `"External IPAM"` `"None"`
locations list / elements=string	Список местоположений, которым должен быть назначен объект
mask string	Маска подсети. Требуется, если network_type=IPv4 и не указана длина префикса cidr
mtu integer	MTU
name string / required	Имя подсети
network string / required	IP-адрес подсети
network_type string	Тип подсети Choices: `"IPv4"` ← (default) `"IPv6"`
organizations list / elements=string	Список организаций, которым должен быть назначен объект
parameters list / elements=dictionary	Параметры узла, специфичные для подсети
name string / required	Имя параметра

parameter_type string	Тип параметра Варианты: `"string"` ← (по умолчанию) `"boolean"` `"integer"` `"real"` `"array"` `"hash"` `"yaml"` `"json"`
value any / обязательно	Значение параметра
password string / обязательно	Пароль пользователя, который получает доступ к серверу Foreman. Если значение не указано в задании, вместо него будет использовано значение переменной среды `FOREMAN_PASSWORD`.
remote_execution_proxies list / элементы=string	Удаленные Smart-прокси выполнения для этой подсети Этот параметр доступен только в случае установки плагина 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-прокси для этой подсети
tftp_proxy string	TFTP Smart-прокси для этой подсети
to_ip string	Последний IP-адрес пула выделения IP-адресов для хоста
updated_name string	Новое имя подсети. При установке этого параметра модуль будет не идемпотентным.
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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/theforeman/foreman/subnet_module.html