theforeman.foreman.subnet – Управление подсетями
Примечание
Этот плагин входит в коллекцию theforeman.foreman (версия 1.5.1).
Для его установки используйте: ansible-galaxy collection install theforeman.foreman
Для использования в playbook укажите: theforeman.foreman.subnet
Добавлена в версии 1.0.0: theforeman.foreman
Обзор
- Создание, обновление и удаление подсетей
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- ipaddress
- requests
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| boot_mode строка |
| Режим загрузки, используемый хостами в этой подсети | |
| cidr целое число | Длина префикса CIDR; Требуется, если network_type=IPv4 и не указана mask | ||
| description строка | Описание подсети | ||
| dhcp_proxy строка | DHCP Smart прокси для этой подсети | ||
| discovery_proxy строка | Discovery Smart прокси для этой подсети Этот параметр доступен только при установке плагина discovery. | ||
| dns_primary строка | Основной DNS-сервер для этой подсети | ||
| dns_proxy строка | DNS Smart прокси для этой подсети | ||
| dns_secondary строка | Вторичный DNS-сервер для этой подсети | ||
| domains список / элементы=строка | Список DNS-доменов, которые должны быть назначены подсети | ||
| externalipam_group строка добавлен в 1.5.0 theforeman.foreman | Группа внешнего IPAM для этой подсети. Актуален только при ipam=Внешний IPAM. | ||
| externalipam_proxy строка | Внешний IPAM прокси для этой подсети. Актуален только при ipam=Внешний IPAM. | ||
| from_ip строка | Первый IP-адрес пула выделения IP-адресов хоста | ||
| gateway строка | IP-адрес шлюза подсети | ||
| httpboot_proxy строка | HTTP Boot Smart прокси для этой подсети | ||
| ipam строка |
| Режим IPAM для этой подсети | |
| locations список / элементы=строка | Список локаций, которым должна быть назначена сущность | ||
| mask строка | Маска подсети. Требуется, если network_type=IPv4 и не указана длина префикса cidr | ||
| mtu целое число | MTU | ||
| name строка / обязательно | Имя подсети | ||
| network строка / обязательно | IP-адрес подсети | ||
| network_type строка |
| Тип подсети | |
| organizations список / элементы=строка | Список организаций, которым должна быть назначена сущность | ||
| parameters список / элементы=словарь | Параметры подсети, специфичные для хоста | ||
| name строка / обязательно | Имя параметра | ||
| parameter_type строка |
| Тип параметра | |
| value сырые данные / обязательно | Значение параметра | ||
| password строка / обязательно | Пароль пользователя, который получает доступ к серверу Foreman. Если значение не указано в задаче, будет использовано значение переменной окружения FOREMAN_PASSWORD. | ||
| remote_execution_proxies список / элементы=строка | Smart прокси удаленного выполнения для этой подсети Этот параметр доступен только при установке плагина remote_execution. Этот параметр всегда будет сообщать changed=true при использовании с remote_execution < 4.1.0, из-за ошибки в плагине. | ||
| server_url строка / обязательно | URL сервера Foreman. Если значение не указано в задаче, будет использовано значение переменной окружения FOREMAN_SERVER_URL. | ||
| state строка |
| Состояние сущности | |
| template_proxy строка | Smart прокси шаблона для этой подсети | ||
| tftp_proxy строка | TFTP Smart прокси для этой подсети | ||
| to_ip строка | Последний IP-адрес пула выделения IP-адресов хоста | ||
| updated_name строка | Новое имя подсети. Когда этот параметр установлен, модуль не будет идемпотентным. | ||
| username строка / обязательно | Имя пользователя, который получает доступ к серверу Foreman. Если значение не указано в задаче, будет использовано значение переменной окружения FOREMAN_USERNAME. | ||
| validate_certs логическое |
| Требуется ли проверка сертификатов TLS сервера Foreman. Если значение не указано в задаче, будет использовано значение переменной окружения FOREMAN_VALIDATE_CERTS. | |
| vlanid целое число | ID VLAN | ||
Примеры
- 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 словарь | успех | Конечное состояние затронутых сущностей, сгруппированных по типу. | |
| subnets список / элементы=словарь | успех | Список подсетей. | |
Авторы
- Baptiste Agasse (@bagasse)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/theforeman/foreman/subnet_module.html