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

Примечание

Этот модуль является частью коллекции cisco.meraki (версия 2.23.2).

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

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

Чтобы использовать модуль в плейбуке, укажите: cisco.meraki.meraki_mx_static_route.

УСТАРЕЛО
Краткое описание
Параметры
Примечания
Примеры
Возвращаемые значения
Статус

УСТАРЕЛО

Удалено в версии:: версия 3.0.0
Причина:: Выпущены обновлённые модули с расширенными возможностями
Альтернатива:: cisco.meraki.networks_appliance_static_routes

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

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

Параметры

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

Примечания

Примечание

Дополнительную информацию об API Meraki можно найти по адресу https://dashboard.meraki.com/api_docs.
Некоторые параметры, вероятно, используются только разработчиками Meraki.
Начиная с Ansible 2.9 модули Meraki выводят ключи в формате snake case. Чтобы использовать camel case, задайте для переменной окружения ANSIBLE_MERAKI_FORMAT значение camelcase.
Поддержка вывода в формате camel case в модулях Meraki Ansible будет прекращена в 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 сложный тип	Информация о созданном или изменённом объекте. Возвращается: 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 строка	Имя статического маршрута. Возвращается: при успешном выполнении Пример: `"Data Center static route"`
net_id строка	Идентификатор сети. Возвращается: запрос или обновление Пример: `"N_12345"`
reservedIpRanges сложный тип	Список диапазонов IP-адресов, зарезервированных для статического назначения. Возвращается: запрос или обновление
comment строка	Понятное человеку описание диапазона. Возвращается: запрос или обновление Пример: `"Server range"`
end строка	Последний адрес зарезервированного диапазона включительно. Возвращается: запрос или обновление Пример: `"192.0.1.10"`
start строка	Первый адрес зарезервированного диапазона включительно. Возвращается: запрос или обновление Пример: `"192.0.1.2"`
subnet строка	Подсеть статического маршрута в нотации CIDR. Возвращается: при успешном выполнении Пример: `"192.0.1.0/24"`

Статус

Этот модуль будет удалён в версии 3.0.0. [устарело]
Дополнительную информацию см. в разделе УСТАРЕЛО.

Авторы

Kevin Breit (@kbreit)

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

© 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/cisco/meraki/meraki_mx_static_route_module.html