Модуль cisco.meraki.networks_switch_routing_ospf — модуль ресурсов для networks _switch _routing _ospf

Примечание

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

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

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

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

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

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

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

Управление операцией обновления ресурса networks _switch _routing _ospf.
Обновление конфигурации маршрутизации OSPF уровня 3.

Примечание

У этого модуля есть соответствующий модуль действий.

Требования

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

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
areas list / elements=dictionary	Области OSPF.
areaId string	Идентификатор области OSPF.
areaName string	Название области OSPF.
areaType string	Тип области OSPF. Должен быть одним из следующих: “normal”, “stub”, “nssa”.
deadTimerInSeconds integer	Интервал времени, по истечении которого соседний узел будет объявлен неактивным/недоступным. Значение должно находиться в диапазоне от 1 до 65535.
enabled boolean	Логическое значение для включения или отключения маршрутизации OSPF. По умолчанию маршрутизация OSPF отключена. Варианты: `false` `true`
helloTimerInSeconds integer	Интервал в секундах, с которым соседям OSPF отправляются пакеты hello для поддержания соединения. Значение должно находиться в диапазоне от 1 до 255. Значение по умолчанию — 10 секунд.
md5AuthenticationEnabled boolean	Логическое значение для включения или отключения аутентификации MD5. По умолчанию аутентификация MD5 отключена. Варианты: `false` `true`
md5AuthenticationKey dictionary	Учетные данные для аутентификации MD5. Этот параметр используется только при значении true параметра md5AuthenticationEnabled.
id integer	Индекс ключа аутентификации MD5. Индекс ключа должен находиться в диапазоне от 1 до 255.
passphrase string	Пароль для аутентификации MD5.
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` ← (по умолчанию)
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 отключена. Варианты: `false` `true`
helloTimerInSeconds integer	Интервал в секундах, с которым соседям OSPF отправляются пакеты hello для поддержания соединения. Значение должно находиться в диапазоне от 1 до 255. Значение по умолчанию — 10 секунд.

Примечания

Примечание

Используемый метод SDK: switch.Switch.update_network_switch_routing_ospf,
Используемый путь: put /networks/{networkId}/switch/routing/ospf,
Не поддерживает check_mode
Плагин выполняется на управляющем узле и не использует плагины подключения Ansible, а вместо этого использует встроенный менеджер подключений
из Cisco Dashboard API Python(SDK)
Параметры, начинающиеся с dnac_, используются Python SDK Cisco DNAC для установки соединения

См. также

Документация 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_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
    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
    vrf: Blue

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

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

Ключ	Описание
meraki_response dictionary	Словарь или список с ответом, возвращенным Python SDK Cisco Meraki Возвращается: всегда Пример: `{"areas": [{"areaId": "string", "areaName": "string", "areaType": "string"}], "deadTimerInSeconds": 0, "enabled": true, "helloTimerInSeconds": 0, "md5AuthenticationEnabled": true, "md5AuthenticationKey": {"id": 0, "passphrase": "string"}, "v3": {"areas": [{"areaId": "string", "areaName": "string", "areaType": "string"}], "deadTimerInSeconds": 0, "enabled": true, "helloTimerInSeconds": 0}, "vrf": {"name": "string"}}`

Ключ

Описание

meraki_response

dictionary

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

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

Пример: {"areas": [{"areaId": "string", "areaName": "string", "areaType": "string"}], "deadTimerInSeconds": 0, "enabled": true, "helloTimerInSeconds": 0, "md5AuthenticationEnabled": true, "md5AuthenticationKey": {"id": 0, "passphrase": "string"}, "v3": {"areas": [{"areaId": "string", "areaName": "string", "areaType": "string"}], "deadTimerInSeconds": 0, "enabled": true, "helloTimerInSeconds": 0}, "vrf": {"name": "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_switch_routing_ospf_module.html