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

Примечание

Этот плагин входит в состав коллекции cisco.meraki (версия 2.1.3).

Для его установки используйте: ansible-galaxy collection install cisco.meraki.

Для использования в книге задач укажите: cisco.meraki.meraki_static_route.

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

Описание

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

Параметры

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

Примечания

Примечание

Дополнительную информацию об API Meraki можно найти по адресу https://dashboard.meraki.com/api_docs.
Некоторые параметры, скорее всего, используются только для разработчиков Meraki.
Начиная с Ansible 2.9, модули Meraki выводят ключи в формате snake case. Чтобы использовать camel case, установите переменную среды ANSIBLE_MERAKI_FORMAT в значение camelcase.
Модули Meraki в Ansible прекратят поддержку вывода в формате camel case в Ansible 2.13. Обновите свои книги задач.
Режим проверки загружает текущую конфигурацию с панели управления, затем сравнивает изменения с этой загрузкой. Режим проверки сообщит о внесённых изменениях, если конфигурации отличаются, но не отправляет изменения в API для проверки изменений.

Примеры

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

Авторы

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.10/collections/cisco/meraki/meraki_static_route_module.html