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

Примечание

Этот плагин входит в коллекцию cisco.meraki (версия 2.2.0).

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

Для использования в playbook, укажите: cisco.meraki.meraki_ms_ospf.

Обзор
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

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

Параметры

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

Примечания

Примечание

Дополнительную информацию об 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. Пожалуйста, обновите свои playbooks.
Режим проверки загружает текущую конфигурацию с панели управления, затем сравнивает изменения с этой загрузкой. Режим проверки сообщит об изменениях, если есть различия в конфигурациях, но не отправляет изменения в 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

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

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

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

Авторы

Kevin Breit (@kbreit)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/cisco/meraki/meraki_ms_ospf_module.html