Spec-Zone.ru › Ansible

Модуль cisco.meraki.networks_appliance_static_routes — модуль ресурсов для networks _appliance _static _routes

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install cisco.meraki. Для использования этого модуля необходимы дополнительные требования; подробности см. в разделе Требования.

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

Добавлено в cisco.meraki 1.0.0

  • Краткое описание
  • Требования
  • Параметры
  • Примечания
  • См. также
  • Примеры
  • Возвращаемые значения

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

  • Управление операциями создания, обновления и удаления ресурса networks _appliance _static _routes.
  • Добавление статического маршрута для сети MX или сети teleworker.
  • Удаление статического маршрута из сети MX или сети teleworker.
  • Обновление статического маршрута для сети MX или сети teleworker.

Примечание

Этому модулю соответствует плагин действий.

Требования

На узле, выполняющем этот модуль, необходимы следующие компоненты.

  • meraki >= 2.4.9
  • python >= 3.5

Параметры

Параметр

Комментарии

enabled

boolean

Следует ли включить маршрут.

Варианты:

  • false
  • true

fixedIpAssignments

dictionary

Фиксированные назначения IP-адресов DHCP для маршрута.

gatewayIp

string

IP-адрес шлюза (следующий переход).

gatewayVlanId

string

Идентификатор VLAN шлюза.

meraki_action_batch_retry_wait_time

integer

meraki_action_batch_retry_wait_time (integer), время ожидания перед повтором при ошибке параллельного выполнения пакета действий

По умолчанию: 60

meraki_api_key

string / обязательный

meraki_api_key (string), ключ API, созданный в панели управления; также может быть задан как переменная среды MERAKI_DASHBOARD_API_KEY

meraki_base_url

string

meraki_base_url (string), базовый URL, указываемый перед ресурсами конечных точек

По умолчанию: "https://api.meraki.com/api/v1"

meraki_be_geo_id

string

meraki_be_geo_id (string), необязательный идентификатор партнёра для отслеживания использования API; также может быть задан как переменная среды BE_GEO_ID

По умолчанию: ""

meraki_certificate_path

string

meraki_certificate_path (string), путь к сертификату для проверки TLS/SSL при работе за локальным прокси-сервером

По умолчанию: ""

meraki_inherit_logging_config

boolean

meraki_inherit_logging_config (boolean), использовать унаследованный экземпляр логгера

Варианты:

  • false ← (по умолчанию)
  • true

meraki_log_file_prefix

string

meraki_log_file_prefix (string), имя файла журнала с добавленными датой и временем

По умолчанию: "meraki_api_"

meraki_log_path

string

log_path (string), путь для вывода журнала; если не указан, используется рабочий каталог скрипта

По умолчанию: ""

meraki_maximum_retries

integer

meraki_maximum_retries (integer), количество повторных попыток при получении ошибок 429 или других ошибок на стороне сервера

По умолчанию: 2

meraki_nginx_429_retry_wait_time

integer

meraki_nginx_429_retry_wait_time (integer), время ожидания перед повтором при ошибке Nginx 429

По умолчанию: 60

meraki_output_log

boolean

meraki_output_log (boolean), создавать файл журнала вывода?

Варианты:

  • false
  • true ← (по умолчанию)

meraki_print_console

boolean

meraki_print_console (boolean), выводить журнал в консоль?

Варианты:

  • false
  • true ← (по умолчанию)

meraki_requests_proxy

string

meraki_requests_proxy (string), адрес и порт прокси-сервера для HTTPS, если он необходим

По умолчанию: ""

meraki_retry_4xx_error

boolean

meraki_retry_4xx_error (boolean), повторять запрос при получении другой ошибки 4XX (кроме 429)?

Варианты:

  • false ← (по умолчанию)
  • true

meraki_retry_4xx_error_wait_time

integer

meraki_retry_4xx_error_wait_time (integer), время ожидания перед повтором при другой ошибке 4XX

По умолчанию: 60

meraki_simulate

boolean

meraki_simulate (boolean), имитировать вызовы POST/PUT/DELETE, чтобы предотвратить внесение изменений?

Варианты:

  • false ← (по умолчанию)
  • true

meraki_single_request_timeout

integer

meraki_single_request_timeout (integer), максимальное время выполнения каждого вызова API в секундах

По умолчанию: 60

meraki_suppress_logging

boolean

meraki_suppress_logging (boolean), отключить всё ведение журнала? Тогда действуйте на свой страх и риск!

Варианты:

  • false ← (по умолчанию)
  • true

meraki_use_iterator_for_get_pages

boolean

meraki_use_iterator_for_get_pages (boolean), методы list* возвращают итератор с каждым объектом вместо полного списка всех элементов

Варианты:

  • false ← (по умолчанию)
  • true

meraki_wait_on_rate_limit

boolean

meraki_wait_on_rate_limit (boolean), повторять запрос при ошибке ограничения частоты запросов 429?

Варианты:

  • false
  • true ← (по умолчанию)

name

string

Имя маршрута.

networkId

string

Параметр пути NetworkId. Идентификатор сети.

reservedIpRanges

list / elements=dictionary

Зарезервированные диапазоны IP-адресов DHCP.

comment

string

Описание диапазона.

end

string

Последний адрес в зарезервированном диапазоне.

start

string

Первый адрес в зарезервированном диапазоне.

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 Dashboard API Python(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
        AQUI ['gatewayIp: 1.2.3.5', "gatewayVlanId: '100'", 'name: My route', 'networkId: string', 'subnet: 192.168.1.0/24']
    gatewayIp: 1.2.3.5
    gatewayVlanId: '100'
    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
        AQUI ['enabled: true', 'fixedIpAssignments:', '  22:33:44:55:66:77:', '    ip: 1.2.3.4', '    name: Some client name', 'gatewayIp: 1.2.3.5', "gatewayVlanId: '100'", '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']
    enabled: true
    fixedIpAssignments:
      22:33:44:55:66:77:
        ip: 1.2.3.4
        name: Some client name
    gatewayIp: 1.2.3.5
    gatewayVlanId: '100'
    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
        AQUI ['networkId: string', 'staticRouteId: string']
    networkId: string
    staticRouteId: string

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

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

Ключ

Описание

meraki_response

dictionary

Словарь или список с ответом, возвращённым Cisco Meraki Python SDK

Возвращается: всегда

Пример: {"enabled": true, "fixedIpAssignments": {}, "gatewayIp": "string", "gatewayVlanId": 0, "id": "string", "ipVersion": 0, "name": "string", "networkId": "string", "reservedIpRanges": [{"comment": "string", "end": "string", "start": "string"}], "subnet": "string"}

Авторы

  • Francisco Munoz (@fmunoz)

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

  • Отслеживание проблем
  • Репозиторий (исходный код)

© 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/networks_appliance_static_routes_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API