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

Примечание

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

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

Для использования в книге задач укажите: 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 целое число			Интервал времени для определения, когда сосед будет объявлен неактивным. Значение должно быть в диапазоне от 1 до 65535.
enabled логическое значение		Варианты: нет да	Включить или отключить OSPF в сети.
hello_timer целое число			Интервал времени в секундах, с которым пакеты hello будут отправляться OSPF-соседям для поддержания подключения. Значение должно быть в диапазоне от 1 до 255. По умолчанию 10 секунд.
host строка		По умолчанию: "api.meraki.com"	Имя хоста для панели управления Meraki. Может использоваться для доступа к региональным средам Meraki, таким как Китай.
internal_error_retry_time целое число		По умолчанию: 60	Количество секунд для повторной попытки, если сервер возвращает внутреннюю ошибку сервера.
md5_authentication_enabled логическое значение		Варианты: нет да	Включить или отключить аутентификацию 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`, будет использоваться HTTP. В противном случае — HTTPS. Полезно только для внутренних разработчиков Meraki.
use_proxy логическое значение		Варианты: нет ← да	Если `no`, прокси не будет использоваться, даже если он определён в переменной среды на целевых хостах.
validate_certs логическое значение		Варианты: нет да ←	Подтверждать ли 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. Пожалуйста, обновите свои книги задач.
Режим проверки загружает текущую конфигурацию с панели управления, затем сравнивает изменения с этой загрузкой. Режим проверки будет сообщать об изменениях, если есть различия в конфигурациях, но не отправляет изменения в 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 сложный тип			успех	Информация о запрошенном объекте.
	areas сложный тип		успех	Список областей в сети OSPF.
		area_id целое число	успех	Идентификатор области OSPF
		area_name строка	успех	Дескриптивное имя области OSPF.
		area_type строка	успех	Тип области OSPF.
	dead_timer_in_seconds целое число		успех	Интервал времени для определения, когда сосед будет объявлен неактивным.
	enabled логическое значение		успех	Включить или отключить OSPF в сети.
	hello_timer_in_seconds целое число		успех	Интервал времени в секундах, с которым пакеты hello будут отправляться OSPF-соседям для поддержания подключения.
	md5_authentication_enabled логическое значение		успех	Включить или отключить аутентификацию MD5.
	md5_authentication_key сложный тип		успех	Учетные данные аутентификации MD5.
		id целое число	успех	Индекс ключа MD5.
		passphrase строка	успех	Пароль для ключа MD5.

Авторы

Kevin Breit (@kbreit)

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