Модуль cisco.meraki.networks_appliance_static_routes — Модуль ресурсов для статических маршрутов на устройствах сети
Примечание
Этот модуль является частью коллекции cisco.meraki (версия 2.18.2).
Эта коллекция может быть уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install cisco.meraki. Для использования этого модуля требуются дополнительные компоненты, см. Требования для деталей.
Для использования в playbook, укажите: cisco.meraki.networks_appliance_static_routes.
Новая функция в cisco.meraki 2.16.0
Описание
- Управление операциями создания, обновления и удаления ресурсов статических маршрутов сети.
- Добавление статического маршрута для сети MX или удалённого пользователя.
- Удаление статического маршрута из сети MX или сети удалённого пользователя.
- Обновление статического маршрута для сети MX или сети удалённого пользователя.
Примечание
Этот модуль имеет соответствующий плагин действия.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- meraki >= 2.4.9
- python >= 3.5
Параметры
Параметр | Комментарии |
|---|---|
enabled boolean | Включенное состояние статического маршрута. Варианты:
|
fixedIpAssignments dictionary | Назначения фиксированных IP-адресов DHCP на статическом маршруте. Это должен быть объект, содержащий сопоставления между MAC-адресами и объектами, каждый из которых содержит поля «ip» и «name» строкового типа. См. пример запроса/ответа для получения более подробной информации. |
gatewayIp string | IP-адрес шлюза (следующий узел) статического маршрута. |
gatewayVlanId string | Идентификатор VLAN IP-адреса шлюза (следующий узел) статического маршрута. |
meraki_action_batch_retry_wait_time integer | meraki_action_batch_retry_wait_time (integer), время ожидания повтора попытки при ошибке параллельной обработки действий По умолчанию: |
meraki_api_key string / required | meraki_api_key (string), API-ключ, сгенерированный на панели управления; может быть также установлен как переменная среды MERAKI_DASHBOARD_API_KEY |
meraki_base_url string | meraki_base_url (string), предшествует всем конечным ресурсам По умолчанию: |
meraki_be_geo_id string | meraki_be_geo_id (string), необязательный идентификатор партнера для отслеживания использования API; может быть также установлен как переменная среды BE_GEO_ID По умолчанию: |
meraki_caller string | meraki_caller (string), необязательный идентификатор для отслеживания использования API; может быть также установлен как переменная среды MERAKI_PYTHON_SDK_CALLER По умолчанию: |
meraki_certificate_path string | meraki_certificate_path (string), путь для проверки сертификата TLS/SSL, если используется локальный прокси-сервер По умолчанию: |
meraki_inherit_logging_config boolean | meraki_inherit_logging_config (boolean), наследует собственный экземпляр регистратора Варианты:
|
meraki_log_file_prefix string | meraki_log_file_prefix (string), имя файла журнала с добавлением даты и времени По умолчанию: |
meraki_log_path string | log_path (string), путь к выходному журналу; по умолчанию, рабочий каталог скрипта, если не указан По умолчанию: |
meraki_maximum_retries integer | meraki_maximum_retries (integer), повторить до этого количества раз при возникновении ошибок 429 или других ошибок на стороне сервера По умолчанию: |
meraki_nginx_429_retry_wait_time integer | meraki_nginx_429_retry_wait_time (integer), время ожидания повтора попытки при ошибке 429 Nginx По умолчанию: |
meraki_output_log boolean | meraki_output_log (boolean), создать файл выходного журнала? Варианты:
|
meraki_print_console boolean | meraki_print_console (boolean), выводить выходные данные журнала на консоль? Варианты:
|
meraki_requests_proxy string | meraki_requests_proxy (string), прокси-сервер и порт, если необходимо, для HTTPS По умолчанию: |
meraki_retry_4xx_error boolean | meraki_retry_4xx_error (boolean), повторить попытку при возникновении других ошибок 4XX (кроме 429)? Варианты:
|
meraki_retry_4xx_error_wait_time integer | meraki_retry_4xx_error_wait_time (integer), время ожидания повторной попытки при ошибке 4XX По умолчанию: |
meraki_simulate boolean | meraki_simulate (boolean), имитировать вызовы POST/PUT/DELETE для предотвращения изменений? Значения:
|
meraki_single_request_timeout integer | meraki_single_request_timeout (integer), максимальное время в секундах для каждого API-вызова По умолчанию: |
meraki_suppress_logging boolean | meraki_suppress_logging (boolean), отключить всю запись в журналы? Вам придется самим разбираться со всем! Значения:
|
meraki_use_iterator_for_get_pages boolean | meraki_use_iterator_for_get_pages (boolean), методы list* будут возвращать итератор с каждым объектом вместо полного списка со всеми элементами Значения:
|
meraki_wait_on_rate_limit boolean | meraki_wait_on_rate_limit (boolean), повторить попытку при ошибке ограничения скорости 429? Значения:
|
name string | Название новой статической маршрутизации. |
networkId string | Параметр пути networkId. Идентификатор сети. |
reservedIpRanges list / elements=dictionary | Диапазоны DHCP-зарезервированных IP-адресов на статической маршрутизации. |
|
comment string |
Текстовый комментарий к зарезервированному диапазону. |
|
end string |
Последний IP-адрес в зарезервированном диапазоне. |
|
start string |
Первый IP-адрес в зарезервированном диапазоне. |
staticRouteId string | Параметр пути staticRouteId. Идентификатор статической маршрутизации. |
subnet string | Подсеть статической маршрутизации. |
Примечания
Примечание
- Используемые методы SDK: appliance.Appliance.create_network_appliance_static_route, appliance.Appliance.delete_network_appliance_static_route, appliance.Appliance.update_network_appliance_static_route,
- Используемые пути: post /networks/{networkId}/appliance/staticRoutes, delete /networks/{networkId}/appliance/staticRoutes/{staticRouteId}, put /networks/{networkId}/appliance/staticRoutes/{staticRouteId},
- Не поддерживает
check_mode - Плагин работает на узле управления и не использует плагины подключения ansible, а вместо этого использует встроенный менеджер подключений из Cisco DNAC SDK
- Параметры, начинающиеся с dnac_, используются Cisco DNAC Python SDK для установления подключения
См. также
См. также
- Документация Cisco Meraki для appliance createNetworkApplianceStaticRoute
-
Полное описание API createNetworkApplianceStaticRoute.
- Документация Cisco Meraki для appliance deleteNetworkApplianceStaticRoute
-
Полное описание API deleteNetworkApplianceStaticRoute.
- Документация Cisco Meraki для appliance updateNetworkApplianceStaticRoute
-
Полное описание API updateNetworkApplianceStaticRoute.
Примеры
- name: Create
cisco.meraki.networks_appliance_static_routes:
meraki_api_key: "{{meraki_api_key}}"
meraki_base_url: "{{meraki_base_url}}"
meraki_single_request_timeout: "{{meraki_single_request_timeout}}"
meraki_certificate_path: "{{meraki_certificate_path}}"
meraki_requests_proxy: "{{meraki_requests_proxy}}"
meraki_wait_on_rate_limit: "{{meraki_wait_on_rate_limit}}"
meraki_nginx_429_retry_wait_time: "{{meraki_nginx_429_retry_wait_time}}"
meraki_action_batch_retry_wait_time: "{{meraki_action_batch_retry_wait_time}}"
meraki_retry_4xx_error: "{{meraki_retry_4xx_error}}"
meraki_retry_4xx_error_wait_time: "{{meraki_retry_4xx_error_wait_time}}"
meraki_maximum_retries: "{{meraki_maximum_retries}}"
meraki_output_log: "{{meraki_output_log}}"
meraki_log_file_prefix: "{{meraki_log_file_prefix}}"
meraki_log_path: "{{meraki_log_path}}"
meraki_print_console: "{{meraki_print_console}}"
meraki_suppress_logging: "{{meraki_suppress_logging}}"
meraki_simulate: "{{meraki_simulate}}"
meraki_be_geo_id: "{{meraki_be_geo_id}}"
meraki_caller: "{{meraki_caller}}"
meraki_use_iterator_for_get_pages: "{{meraki_use_iterator_for_get_pages}}"
meraki_inherit_logging_config: "{{meraki_inherit_logging_config}}"
state: present
gatewayIp: 1.2.3.5
name: My route
networkId: string
subnet: 192.168.1.0/24
- name: Update by id
cisco.meraki.networks_appliance_static_routes:
meraki_api_key: "{{meraki_api_key}}"
meraki_base_url: "{{meraki_base_url}}"
meraki_single_request_timeout: "{{meraki_single_request_timeout}}"
meraki_certificate_path: "{{meraki_certificate_path}}"
meraki_requests_proxy: "{{meraki_requests_proxy}}"
meraki_wait_on_rate_limit: "{{meraki_wait_on_rate_limit}}"
meraki_nginx_429_retry_wait_time: "{{meraki_nginx_429_retry_wait_time}}"
meraki_action_batch_retry_wait_time: "{{meraki_action_batch_retry_wait_time}}"
meraki_retry_4xx_error: "{{meraki_retry_4xx_error}}"
meraki_retry_4xx_error_wait_time: "{{meraki_retry_4xx_error_wait_time}}"
meraki_maximum_retries: "{{meraki_maximum_retries}}"
meraki_output_log: "{{meraki_output_log}}"
meraki_log_file_prefix: "{{meraki_log_file_prefix}}"
meraki_log_path: "{{meraki_log_path}}"
meraki_print_console: "{{meraki_print_console}}"
meraki_suppress_logging: "{{meraki_suppress_logging}}"
meraki_simulate: "{{meraki_simulate}}"
meraki_be_geo_id: "{{meraki_be_geo_id}}"
meraki_caller: "{{meraki_caller}}"
meraki_use_iterator_for_get_pages: "{{meraki_use_iterator_for_get_pages}}"
meraki_inherit_logging_config: "{{meraki_inherit_logging_config}}"
state: present
fixedIpAssignments:
22:33:44:55:66:77:
ip: 1.2.3.4
name: Some client name
name: My route
networkId: string
reservedIpRanges:
- comment: A reserved IP range
end: 192.168.1.1
start: 192.168.1.0
staticRouteId: string
subnet: 192.168.1.0/24
- name: Delete by id
cisco.meraki.networks_appliance_static_routes:
meraki_api_key: "{{meraki_api_key}}"
meraki_base_url: "{{meraki_base_url}}"
meraki_single_request_timeout: "{{meraki_single_request_timeout}}"
meraki_certificate_path: "{{meraki_certificate_path}}"
meraki_requests_proxy: "{{meraki_requests_proxy}}"
meraki_wait_on_rate_limit: "{{meraki_wait_on_rate_limit}}"
meraki_nginx_429_retry_wait_time: "{{meraki_nginx_429_retry_wait_time}}"
meraki_action_batch_retry_wait_time: "{{meraki_action_batch_retry_wait_time}}"
meraki_retry_4xx_error: "{{meraki_retry_4xx_error}}"
meraki_retry_4xx_error_wait_time: "{{meraki_retry_4xx_error_wait_time}}"
meraki_maximum_retries: "{{meraki_maximum_retries}}"
meraki_output_log: "{{meraki_output_log}}"
meraki_log_file_prefix: "{{meraki_log_file_prefix}}"
meraki_log_path: "{{meraki_log_path}}"
meraki_print_console: "{{meraki_print_console}}"
meraki_suppress_logging: "{{meraki_suppress_logging}}"
meraki_simulate: "{{meraki_simulate}}"
meraki_be_geo_id: "{{meraki_be_geo_id}}"
meraki_caller: "{{meraki_caller}}"
meraki_use_iterator_for_get_pages: "{{meraki_use_iterator_for_get_pages}}"
meraki_inherit_logging_config: "{{meraki_inherit_logging_config}}"
state: absent
networkId: string
staticRouteId: string
Значения возврата
Общие значения возврата описаны здесь, следующие являются полями, уникальными для данного модуля:
Ключ | Описание |
|---|---|
meraki_response словарь | Словарь или список со значением, возвращаемым Cisco Meraki Python SDK Возвращается: всегда Пример: |
Ссылки на коллекцию
© 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/networks_appliance_static_routes_module.html