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

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install cisco.meraki.

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

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

УСТАРЕЛО

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

Описание

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

Параметры

Параметр	Комментарии
areas список / элементы=словарь	Список областей в сети OSPF.
area_id псевдонимы: id целое число	Идентификатор области OSPF
area_name псевдонимы: name строка	Описание области OSPF.
area_type псевдонимы: type строка	Тип области OSPF. Варианты: `"normal"` `"stub"` `"nssa"`
auth_key строка / обязательно	Ключ аутентификации, предоставленный панелью управления. Требуется, если переменная среды `MERAKI_KEY` не задана.
dead_timer целое число	Интервал времени для определения неактивности узла. Значение должно быть от 1 до 65535.
enabled логический тип	Включить или выключить OSPF в сети. Варианты: `false` `true`
hello_timer целое число	Интервал времени, в секундах, через который будут отправляться пакеты hello для поддержания соединения с соседями OSPF. Значение должно быть от 1 до 255. По умолчанию 10 секунд.
host строка	Имя хоста для панели управления Meraki. Можно использовать для доступа к региональным средам Meraki, таким как Китай. По умолчанию: `"api.meraki.com"`
internal_error_retry_time целое число	Количество секунд для повторной попытки, если сервер возвращает внутреннюю ошибку. По умолчанию: `60`
md5_authentication_enabled логический тип	Включить или выключить аутентификацию MD5. Варианты: `false` `true`
md5_authentication_key словарь	Данные аутентификации MD5.
id строка	Индекс ключа аутентификации MD5. Должно быть от 1 до 255.
passphrase строка	Пароль аутентификации в текстовом формате
net_id строка	Идентификатор сети, содержащей конфигурацию OSPF.
net_name псевдонимы: name, network строка	Название сети, содержащей конфигурацию OSPF.
org_id строка	Идентификатор организации.
org_name псевдонимы: organization строка	Название организации.
output_format строка	Указывает модулю, следует ли использовать snake case (например, `net_id`) или camel case (например, `netId`). Варианты: `"snakecase"` ← (по умолчанию) `"camelcase"`
output_level строка	Установите объем отладочной информации во время выполнения модуля. Варианты: `"debug"` `"normal"` ← (по умолчанию)
rate_limit_retry_time целое число	Количество секунд для повторной попытки, если срабатывает ограничитель скорости. По умолчанию: `165`

END_OF_DOCUMENT_MARKER

состояние строка	Чтение или изменение настроек OSPF. Выборы: `"present"` ← (по умолчанию) `"query"`
таймаут целое число	Время ожидания для запросов HTTP. По умолчанию: `30`
использовать_https логическое значение	Если `no`, то будет использоваться HTTP. В противном случае будет использоваться HTTPS. Полезно только для внутренних разработчиков Meraki. Выборы: `false` `true` ← (по умолчанию)
использовать_прокси логическое значение	Если `no`, прокси не будет использоваться, даже если она определена в переменной окружения на целевых хостах. Выборы: `false` ← (по умолчанию) `true`
валидировать_сертификаты логическое значение	Включает или отключает проверку сертификатов HTTP. Выборы: `false` `true` ← (по умолчанию)

Примечания

Примечание

Дополнительную информацию об API Meraki можно найти по адресу https://dashboard.meraki.com/api_docs.
Некоторые параметры, вероятно, используются только разработчиками внутри Meraki.
Начиная с Ansible 2.9, модули Meraki выводят ключи в формате snake case. Для использования camel case, установите переменную окружения ANSIBLE_MERAKI_FORMAT в camelcase.
Модули Meraki от Ansible перестанут поддерживать вывод camel case в Ansible 2.13. Пожалуйста, обновите свои playbook'и.
Режим проверки загружает текущую конфигурацию с панели управления, а затем сравнивает изменения с этой загрузкой. Режим проверки сообщит об изменениях, если существуют различия в конфигурациях, но не отправляет изменения в 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
      - area_id: 1
        area_name: Office
        area_type: nssa
    md5_authentication_enabled: false

Значения возврата

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

Ключ	Описание
данные сложная структура	Информация о запрошенном объекте. Возвращается: успех
области сложная структура	Список областей в OSPF-сети. Возвращается: успех
id_области целое число	Идентификатор OSPF-области Возвращается: успех
название_области строка	Описание области OSPF. Возвращается: успех
тип_области строка	Тип OSPF-области. Возвращается: успех
таймер_неактивности_в_секундах целое число	Интервал времени для определения, когда узел-сосед будет объявлен неактивным. Возвращается: успех
включено логическое значение	Включение или выключение OSPF в сети. Возвращается: успех
таймер_hello_в_секундах целое число	Интервал времени в секундах, с которым hello-пакеты будут отправляться OSPF-соседям для поддержания соединения. Возвращается: успех
включено_аутентификацию_md5 логическое значение	Включение или выключение аутентификации MD5. Возвращается: успех
ключ_аутентификации_md5 сложная структура	Учетные данные аутентификации MD5. Возвращается: успех
id_ключа целое число	Индекс ключа MD5. Возвращается: успех
парольная_фраза строка	Парольная фраза для ключа MD5. Возвращается: успех

Статус

Этот модуль будет удален в версии 3.0.0. [устаревший]
Для получения дополнительной информации см. УСТАРЕВШИЙ.

Авторы

Kevin Breit (@kbreit)

Ссылки на сборник

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