модуль cisco.meraki.meraki_ms_ospf — управление конфигурацией OSPF на коммутаторах MS

Примечание

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

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

Для установки используйте: ansible-galaxy collection install cisco.meraki.

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

УСТАРЕЛО
Краткое описание
Параметры
Примечания
Примеры
Возвращаемые значения
Статус

УСТАРЕЛО

Удалено в:: версии 3.0.0
Причина:: Выпущены обновлённые модули с расширенными возможностями
Альтернатива:: cisco.meraki.networks_switch_routing_ospf

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

Настройка OSPF для совместимых коммутаторов Meraki MS.

Параметры

Параметр	Комментарии
areas list / elements=dictionary	Список областей сети OSPF.
area_id псевдонимы: id integer	Идентификатор области OSPF
area_name псевдонимы: name string	Описательное название области OSPF.
area_type псевдонимы: type string	Тип области OSPF. Варианты: `"normal"` `"stub"` `"nssa"`
auth_key string / обязательный	Ключ аутентификации, предоставленный dashboard. Обязателен, если не задана переменная среды `MERAKI_KEY`.
dead_timer integer	Интервал времени, по истечении которого соседнее устройство будет считаться неактивным. Значение должно находиться в диапазоне от 1 до 65535.
enabled boolean	Включение или отключение OSPF в сети. Варианты: `false` `true`
hello_timer integer	Интервал в секундах, с которым соседям OSPF отправляются пакеты hello для поддержания связи. Значение должно находиться в диапазоне от 1 до 255. По умолчанию — 10 секунд.
host string	Имя хоста для панели управления Meraki. Можно использовать для доступа к региональным средам Meraki, например в Китае. По умолчанию: `"api.meraki.com"`
internal_error_retry_time integer	Количество секунд до повторной попытки, если сервер возвращает внутреннюю ошибку сервера. По умолчанию: `60`
md5_authentication_enabled boolean	Включение или отключение аутентификации MD5. Варианты: `false` `true`
md5_authentication_key dictionary	Учётные данные для аутентификации MD5.
id string	Индекс ключа аутентификации MD5. Значение должно находиться в диапазоне от 1 до 255.
passphrase string	Пароль аутентификации в открытом виде
net_id string	Идентификатор сети с конфигурацией OSPF.
net_name псевдонимы: name, network string	Название сети с конфигурацией OSPF.
org_id string	Идентификатор организации.
org_name псевдонимы: organization string	Название организации.
output_format string	Указывает модулю, должны ли ключи ответа быть в формате snake case (например, `net_id`) или camel case (например, `netId`). Варианты: `"snakecase"` ← (по умолчанию) `"camelcase"`
output_level string	Задаёт объём отладочных данных во время выполнения модуля. Варианты: `"debug"` `"normal"` ← (по умолчанию)
rate_limit_retry_time integer	Количество секунд до повторной попытки, если сработало ограничение частоты запросов. По умолчанию: `165`
state string	Чтение или изменение настроек OSPF. Варианты: `"present"` ← (по умолчанию) `"query"`
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. Чтобы использовать camel case, задайте переменной среды ANSIBLE_MERAKI_FORMAT значение camelcase.
В Ansible 2.13 модули Meraki перестанут поддерживать вывод в формате camel case. Обновите свои плейбуки.
Режим проверки загружает текущую конфигурацию с панели управления, а затем сравнивает изменения с этой загруженной конфигурацией. Режим проверки сообщит об изменениях, если конфигурации различаются, но не отправляет изменения в API для проверки их применимости.

Примеры

- name: Query OSPF settings
  meraki_ms_ospf:
    auth_key: abc123
    org_name: YourOrg
    net_name: YourNet
    state: query
  delegate_to: localhost

- name: Enable OSPF with check mode
  meraki_ms_ospf:
    auth_key: abc123
    org_name: YourOrg
    net_name: YourNet
    state: present
    enabled: true
    hello_timer: 20
    dead_timer: 60
    areas:
      area_id: 0
      area_name: Backbone
      area_type: normal
      md5_authentication_enabled: false

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

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

Ключ	Описание
data complex	Информация о запрошенном объекте. Возвращается: успешно
areas complex	Список областей сети OSPF. Возвращается: успешно
area_id integer	Идентификатор области OSPF Возвращается: успешно
area_name string	Описательное название области OSPF. Возвращается: успешно
area_type string	Тип области OSPF. Возвращается: успешно
dead_timer_in_seconds integer	Интервал времени, по истечении которого соседнее устройство будет считаться неактивным. Возвращается: успешно
enabled boolean	Включение или отключение OSPF в сети. Возвращается: успешно
hello_timer_in_seconds integer	Интервал в секундах, с которым соседям OSPF отправляются пакеты hello для поддержания связи. Возвращается: успешно
md5_authentication_enabled boolean	Включение или отключение аутентификации MD5. Возвращается: успешно
md5_authentication_key complex	Учётные данные для аутентификации MD5. Возвращается: успешно
id integer	Индекс ключа MD5. Возвращается: успешно
passphrase string	Пароль для ключа MD5. Возвращается: успешно

Статус

Этот модуль будет удалён в версии 3.0.0. [устарело]
Дополнительную информацию см. в разделе УСТАРЕЛО.

Авторы

Kevin Breit (@kbreit)

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

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