Модуль cisco.meraki.networks_switch_routing_ospf – Модуль ресурсов для networks_switch_routing_ospf
Примечание
Этот модуль является частью коллекции cisco.meraki (версия 2.18.2).
У вас, возможно, уже установлена эта коллекция, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Чтобы установить ее, используйте: ansible-galaxy collection install cisco.meraki. Для использования этого модуля требуются дополнительные зависимости. Подробности см. в разделе Требования.
Чтобы использовать его в плейбуке, укажите: cisco.meraki.networks_switch_routing_ospf.
Новая функция в cisco.meraki 2.16.0
Описание
- Управление обновлением операций ресурса networks_switch_routing_ospf.
- Обновление конфигурации маршрутизации OSPF уровня 3.
Примечание
Для этого модуля существует соответствующий плагин действий.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- meraki >= 2.4.9
- python >= 3.5
Параметры
Параметр | Комментарии |
|---|---|
areas список / элементы=словарь | Области OSPF. |
|
areaId строка |
Идентификатор области OSPF. |
|
areaName строка |
Имя области OSPF. |
|
areaType строка |
Типы областей в OSPF. Должно быть одно из «normal», «stub», «nssa». |
deadTimerInSeconds целое число | Интервал времени для определения, когда узел считается неактивным/мертвым. Значение должно быть от 1 до 65535. |
enabled логическое | Логическое значение для включения или выключения маршрутизации OSPF. Маршрутизация OSPF по умолчанию отключена. Варианты:
|
helloTimerInSeconds целое число | Интервал времени в секундах, через который пакет hello отправляется соседям OSPF для поддержания соединения. Значение должно быть от 1 до 255. По умолчанию 10 секунд. |
md5AuthenticationEnabled логическое | Логическое значение для включения или выключения аутентификации MD5. Аутентификация MD5 по умолчанию отключена. Варианты:
|
md5AuthenticationKey словарь | Данные аутентификации MD5. Этот параметр актуален только если md5AuthenticationEnabled — true. |
|
id целое число |
Индекс ключа аутентификации MD5. Индекс ключа должен быть от 1 до 255. |
|
passphrase строка |
Пароль аутентификации MD5. |
meraki_action_batch_retry_wait_time целое число | meraki_action_batch_retry_wait_time (целое число), время ожидания при повторной попытке сбоя в конкурентном режиме обработки действий По умолчанию: |
meraki_api_key строка / обязательно | meraki_api_key (строка), ключ API, сгенерированный в панели управления; также может быть задан как переменная окружения MERAKI_DASHBOARD_API_KEY |
meraki_base_url строка | meraki_base_url (строка), префикс всех ресурсов конечной точки По умолчанию: |
meraki_be_geo_id строка | meraki_be_geo_id (строка), необязательный идентификатор партнера для отслеживания использования API; также может быть задан как переменная окружения BE_GEO_ID По умолчанию: |
meraki_caller строка | meraki_caller (строка), необязательный идентификатор для отслеживания использования API; также может быть задан как переменная окружения MERAKI_PYTHON_SDK_CALLER По умолчанию: |
meraki_certificate_path строка | meraki_certificate_path (строка), путь к сертификату TLS/SSL для проверки, если за локальным прокси По умолчанию: |
meraki_inherit_logging_config логическое | meraki_inherit_logging_config (логическое), наследование собственного экземпляра регистратора Варианты:
|
meraki_log_file_prefix строка | meraki_log_file_prefix (строка), имя файла журнала, дополненное датой и меткой времени По умолчанию: |
meraki_log_path строка | log_path (строка), путь для вывода журнала; по умолчанию, рабочая директория скрипта, если не указано По умолчанию: |
meraki_maximum_retries целое число | meraki_maximum_retries (целое число), максимальное количество попыток повторной обработки при возникновении ошибок 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? Варианты:
|
networkId string | Параметр пути networkId. Идентификатор сети. |
v3 dictionary | Конфигурация OSPF v3. |
|
areas list / elements=dictionary |
Области OSPF v3. |
|
areaId string |
Идентификатор области OSPF. |
|
areaName string |
Название области OSPF. |
|
areaType string |
Типы областей в OSPF. Должно быть одно из «normal», «stub», «nssa». |
|
deadTimerInSeconds integer |
Интервал времени для определения, когда сосед считается неактивным/мертвым. Значение должно быть между 1 и 65535. |
|
enabled boolean |
Булево значение для включения или отключения маршрутизации OSPF V3. Маршрутизация OSPF V3 отключена по умолчанию. Варианты:
|
|
helloTimerInSeconds integer |
Интервал времени в секундах, в течение которого пакет hello будет отправлен соседям OSPF для поддержания соединения. Значение должно быть между 1 и 255. По умолчанию 10 секунд. |
Примечания
Примечание
- Используемый метод SDK switch.Switch.update_network_switch_routing_ospf,
- Используемые пути: put /networks/{networkId}/switch/routing/ospf,
- Не поддерживает
check_mode - Плагин работает на узле управления и не использует плагины подключения ansible, а вместо этого использует встроенный менеджер подключений из Cisco DNAC SDK
- Параметры, начинающиеся с dnac_, используются Cisco DNAC Python SDK для установления подключения
См. также
См. также
- Документация Cisco Meraki для обновления switch updateNetworkSwitchRoutingOspf
-
Полная справка по API updateNetworkSwitchRoutingOspf.
Примеры
- name: Update all
cisco.meraki.networks_switch_routing_ospf:
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_use_iterator_for_get_pages: "{{meraki_use_iterator_for_get_pages}}"
meraki_inherit_logging_config: "{{meraki_inherit_logging_config}}"
state: present
areas:
- areaId: '1284392014819'
areaName: Backbone
areaType: normal
deadTimerInSeconds: 40
enabled: true
helloTimerInSeconds: 10
md5AuthenticationEnabled: true
md5AuthenticationKey:
id: 1234
passphrase: abc1234
networkId: string
v3:
areas:
- areaId: '1284392014819'
areaName: V3 Backbone
areaType: normal
deadTimerInSeconds: 40
enabled: true
helloTimerInSeconds: 10
Значения возврата
Общие значения возврата задокументированы здесь, следующие являются полями, уникальными для данного модуля:
Ключ | Описание |
|---|---|
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_switch_routing_ospf_module.html