meraki_static_route – Управление статическими маршрутами в облаке Meraki

Новое в версии 2.8.

Описание
Параметры
Примечания
Примеры
Возвращаемые значения
Статус

Описание

Позволяет создавать, управлять и просматривать статические маршруты в Meraki.

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
auth_key строка			Ключ аутентификации, предоставленный панелью управления. Требуется, если переменная среды MERAKI_KEY не задана.
enabled логическое		Варианты: нет да	Указывает, включен ли статический маршрут в сети.
fixed_ip_assignments список			Список статических привязок MAC к IP для DHCP.
	ip строка		IP-адрес конечной точки.
	mac строка		MAC-адрес конечной точки.
	name строка		Имя хоста конечной точки.
gateway_ip строка			IP-адрес шлюза для подсети.
host строка		По умолчанию: "api.meraki.com"	Имя хоста для панели управления Meraki. Может использоваться для доступа к региональным средам Meraki, таким как Китай.
name строка			Дескриптивное имя статического маршрута.
net_id строка			Идентификационный номер сети.
net_name строка			Название сети.
org_id строка			Идентификатор организации, связанной с сетью.
org_name строка			Название организации, связанной с сетью. псевдонимы: организация
output_level строка		Варианты: отладка обычный ←	Устанавливает объем вывода отладки во время выполнения модуля.
reserved_ip_ranges список			Список диапазонов IP-адресов, зарезервированных для статических назначений IP.
	comment строка		Описание для чтения человеком диапазона резервирования.
	end строка		Последний IP-адрес зарезервированного диапазона.
	start строка		Первый IP-адрес зарезервированного диапазона.
route_id строка			Уникальный идентификатор статического маршрута.
state строка		Варианты: отсутствует запрос присутствует ←	Создание или изменение организации.
subnet строка			Подсеть в CIDR-нотации для статического маршрута.
timeout целое число		По умолчанию: 30	Время ожидания для HTTP-запросов.
use_https логическое		Варианты: нет да ←	Если `no`, будет использоваться HTTP. В противном случае — HTTPS. Полезно только для внутренних разработчиков Meraki.
use_proxy логическое		Варианты: нет да	Если `no`, прокси не будет использоваться, даже если он определён в переменных окружения целевых узлов.
validate_certs логическое		Варианты: нет да ←	Подтверждать ли сертификаты HTTP.

Примечания

Примечание

Дополнительную информацию об API Meraki можно найти на https://dashboard.meraki.com/api_docs.
Некоторые из вариантов, вероятно, используются только разработчиками Meraki.

Примеры

- name: Create static_route
  meraki_static_route:
    auth_key: abc123
    state: present
    org_name: YourOrg
    net_name: YourNet
    name: Test Route
    subnet: 192.0.1.0/24
    gateway_ip: 192.168.128.1
  delegate_to: localhost

- name: Update static route with fixed IP assignment
  meraki_static_route:
    auth_key: abc123
    state: present
    org_name: YourOrg
    net_name: YourNet
    route_id: d6fa4821-1234-4dfa-af6b-ae8b16c20c39
    fixed_ip_assignments:
      - mac: aa:bb:cc:dd:ee:ff
        ip: 192.0.1.11
        comment: Server
  delegate_to: localhost

- name: Query static routes
  meraki_static_route:
    auth_key: abc123
    state: query
    org_name: YourOrg
    net_name: YourNet
  delegate_to: localhost

- name: Delete static routes
  meraki_static_route:
    auth_key: abc123
    state: absent
    org_name: YourOrg
    net_name: YourNet
    route_id: '{{item}}'
  delegate_to: localhost

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

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

Ключ				Возвращаемое значение	Описание
data сложный				info	Информация об созданном или изменённом объекте.
	enabled булево			запрос или обновление	Состояние включения статического маршрута. Пример: True
	fixedIpAssignments сложный			запрос или обновление	Список привязок статических MAC-адресов к IP-адресам.
		mac сложный		запрос или обновление	Ключ — MAC-адрес конечной точки.
			ip строка	запрос или обновление	IP-адрес, который нужно привязать к конечной точке. Пример: 192.0.1.11
			name строка	запрос или обновление	Имя хоста, заданное для конечной точки. Пример: JimLaptop
	gatewayIp строка			успех	IP-адрес следующей переадресации. Пример: 192.1.1.1
	id строка			успех	Уникальная строка идентификации, присвоенная каждому статическому маршруту. Пример: d6fa4821-1234-4dfa-af6b-ae8b16c20c39
	name строка			успех	Имя статического маршрута. Пример: Статический маршрут Центра обработки данных
	net_id строка			запрос или обновление	Строка идентификации сети. Пример: N_12345
	reservedIpRanges сложный			запрос или обновление	Список диапазонов IP-адресов, зарезервированных для статической привязки.
		comment строка		запрос или обновление	Описание диапазона, понятное человеку. Пример: Диапазон серверов
		end строка		запрос или обновление	Последний адрес в диапазоне резервирования (включительно). Пример: 192.0.1.10
		start строка		запрос или обновление	Первый адрес в диапазоне резервирования (включительно). Пример: 192.0.1.2
	subnet строка			успех	Подсеть в CIDR-нотации для статического маршрута. Пример: 192.0.1.0/24

Состояние

Данный модуль не гарантирует обратную совместимость интерфейса. [превью]
Данный модуль поддерживается сообществом Ansible. [сообщество]

Авторы

Kevin Breit (@kbreit)

Подсказка

Если вы заметите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/meraki_static_route_module.html