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

Примечание

Этот модуль входит в коллекцию cisco.meraki (версия 2.18.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-ID шлюза (следующий прыжок) статической маршрутизации.
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-адресов, зарезервированных для статических назначений IP.
comment строка	Описание диапазона резервации, понятное для человека.
end строка	Последний IP-адрес зарезервированного диапазона.
start строка	Первый IP-адрес зарезервированного диапазона.
route_id строка	Уникальный идентификатор статической маршрутизации.

state string	Создать или изменить организацию. Варианты: `"absent"` `"query"` `"present"` ← (по умолчанию)
subnet string	Подсеть в CIDR-нотации для статического маршрута.
timeout integer	Время ожидания для HTTP-запросов. По умолчанию: `30`
use_https boolean	Если `no`, будет использоваться HTTP. В противном случае используется HTTPS. Полезно только для внутренних разработчиков Meraki. Варианты: `false` `true` ← (по умолчанию)
use_proxy boolean	Если `no`, прокси не будет использоваться, даже если он определён в переменной среды на целевых хостах. Варианты: `false` ← (по умолчанию) `true`
validate_certs boolean	Подтверждать ли сертификаты HTTP. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

Дополнительную информацию об API Meraki можно найти по адресу https://dashboard.meraki.com/api_docs.
Некоторые параметры, вероятно, используются только разработчиками Meraki.
Начиная с Ansible 2.9, модули Meraki выдают ключи в формате snake_case. Для использования camelCase, установите переменную среды ANSIBLE_MERAKI_FORMAT в значение camelcase.
Модули Meraki от Ansible перестанут поддерживать вывод camelCase в Ansible 2.13. Пожалуйста, обновите свои playbook.
Режим проверки загружает текущую конфигурацию с панели управления, а затем сравнивает изменения с этой загрузкой. Режим проверки сообщит о изменениях, если есть различия в конфигурациях, но не отправляет изменения в 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 сложное	Информация о созданном или измененном объекте. Возвращается: информация
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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/cisco/meraki/meraki_mx_static_route_module.html