nxos_interface_ospf – Управляет конфигурацией экземпляра интерфейса OSPF
Описание
- Управляет конфигурацией экземпляра интерфейса OSPF.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| area - / обязательно | Область OSPF, связанная с этим экземпляром cisco_interface_ospf. Допустимые значения — строка, отформатированная как IP-адрес (например, "0.0.0.0") или целое число. | ||
| bfd строка добавлено в 2.9 |
| Включает bfd на уровне интерфейса. Это переопределяет переменную bfd, заданную на уровне маршрутизатора ospf. Допустимые значения — 'enable', 'disable' или 'default'. Зависимость: 'feature bfd' | |
| cost - | Стоимость, связанная с этим экземпляром cisco_interface_ospf. | ||
| dead_interval - | Интервал времени, в течение которого сосед ospf ожидает получения пакета hello перед разрывом смежности. Допустимые значения — целое число или ключевое слово 'default'. | ||
| hello_interval - | Интервал времени между отправкой последовательных пакетов hello. Допустимые значения — целое число или ключевое слово 'default'. | ||
| interface - / обязательно | Имя ресурса cisco_interface. Допустимое значение — строка. | ||
| message_digest логическое |
| Включает или отключает использование аутентификации с помощью сообщения digest. | |
| message_digest_algorithm_type - |
| Алгоритм, используемый для аутентификации между соседними маршрутизаторами в рамках области. Допустимые значения — 'md5' и 'default'. | |
| message_digest_encryption_type - |
| Указывает схему, используемую для шифрования message_digest_password. Допустимые значения — шифрование '3des' или 'cisco_type_7' или 'default'. | |
| message_digest_key_id - | Идентификатор ключа аутентификации md5, связанный с экземпляром ospf. Если он присутствует, message_digest_encryption_type, message_digest_algorithm_type и message_digest_password являются обязательными. Допустимое значение — целое число и 'default'. | ||
| message_digest_password - | Указывает пароль message_digest. Допустимое значение — строка. | ||
| network - добавлено в 2.8 |
| Указывает тип сети ospf интерфейса. Допустимые значения — 'точка-точка' или 'вещательная'. | |
| ospf - / обязательно | Имя экземпляра ospf. | ||
| passive_interface логическое |
| Включить или отключить состояние passive-interface на этом интерфейсе. true - (включить) Запретить OSPF устанавливать смежность или отправлять обновления маршрутизации на этом интерфейсе. false - (отключить) Переопределить глобальное значение 'passive-interface default' для этого интерфейса. | |
| provider словарь | Устарело Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli. Этот параметр требуется только при использовании NX-API. Для получения дополнительной информации см. руководство NXOS Platform Options. Объект словаря, содержащий данные подключения. | ||
| auth_pass строка добавлено в 2.5.3 | Указывает пароль, необходимый для входа в привилегированный режим на удаленном устройстве. Если authorize имеет значение false, этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTH_PASS. | ||
| authorize логическое добавлено в 2.5.3 |
| Инструктирует модуль войти в привилегированный режим на удаленном устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTHORIZE. | |
| host строка / обязательно | Указывает имя хоста DNS или адрес для подключения к удаленному устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта. | ||
| password строка | Указывает пароль для аутентификации подключения к удаленному устройству. Этот аргумент обычно используется для транспортов cli или nxapi. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_PASSWORD. | ||
| port целое число | По умолчанию: "0 (использовать общий порт)" | Указывает порт для создания соединения с удаленным устройством. Это значение относится к транспорту cli или nxapi. Значение порта по умолчанию соответствует обычному порту транспорта, если он не указан в задаче. (cli=22, http=80, https=443). | |
| ssh_keyfile строка | Указывает SSH-ключ для аутентификации подключения к удаленному устройству. Этот аргумент используется только для транспорта cli. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_SSH_KEYFILE. | ||
| timeout целое число | По умолчанию: 10 | Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истекает до завершения операции, модуль выдаст ошибку. NX-API может медленно отвечать на длительные команды (sh mac, sh bgp и т. д.). | |
| transport строка / обязательно |
| Настраивает транспортное соединение для подключения к удаленному устройству. Аргумент transport поддерживает подключение к устройству через cli (ssh) или nxapi. | |
| use_proxy логическое добавлено в 2.5 |
| Если no, переменные среды http_proxy и https_proxy будут игнорироваться. | |
| use_ssl логическое |
| Настраивает transport для использования SSL, если установлено значение yes, только если transport=nxapi, в противном случае это значение игнорируется. | |
| username строка | Настраивает имя пользователя для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации входа в CLI или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_USERNAME. | ||
| validate_certs логическое |
| Если no, сертификаты SSL не будут проверены. Это следует использовать только на управляемых пользователем сайтах с использованием самозаверяемых сертификатов. Если аргумент transport не является nxapi, это значение игнорируется. | |
| состояние - |
| Определяет, должно ли конфигурация присутствовать на устройстве. | |
Примечания
Примечание
- Проверено на NXOSv 7.3.(0)D1(1) на VIRL
- По умолчанию, где поддерживается, восстанавливает значения параметров по умолчанию.
- Чтобы удалить существующую конфигурацию аутентификации, необходимо использовать
message_digest_key_id=defaultплюс все остальные параметры, соответствующие их существующим значениям. - Интерфейсы loopback поддерживают только тип сети ospf «точка-точка».
-
state=absentудаляет всю конфигурацию интерфейса OSPF. - Для получения информации об использовании CLI и NX-API см. руководство NXOS Platform Options
- Для получения дополнительной информации об использовании Ansible для управления сетевыми устройствами см. руководство Ansible Network Guide
- Для получения дополнительной информации об использовании Ansible для управления устройствами Cisco см. страницу интеграции Cisco Cisco integration page.
Примеры
- nxos_interface_ospf:
interface: ethernet1/32
ospf: 1
area: 1
bfd: disable
cost: default
- nxos_interface_ospf:
interface: loopback0
ospf: prod
area: 0.0.0.0
bfd: enable
network: point-to-point
state: present
Значения возврата
Общие значения возврата описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое | Описание |
|---|---|---|
| команды список | всегда | Команды, отправленные на устройство Пример: ['interface Ethernet1/32', 'ip router ospf 1 area 0.0.0.1', 'ip ospf bfd disable'] |
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль поддерживается командой Ansible Network Ansible Network Team. [сеть]
Поддержка Red Hat
Дополнительную информацию о поддержке этого модуля Red Hat можно найти в статье базы знаний Red Hat Red Hat Knowledge Base article.
Авторы
- Gabriele Gerbino (@GGabriele)
Подсказка
Если вы заметили какие-либо проблемы в этом руководстве, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/nxos_interface_ospf_module.html