cisco.nxos.nxos_interface_ospf – (устаревший, удален после 2022-10-26) Управляет конфигурацией экземпляра интерфейса OSPF.
Примечание
Этот плагин является частью коллекции cisco.nxos (версия 1.3.1).
Для его установки используйте: ansible-galaxy collection install cisco.nxos.
Для использования в плане задания укажите: cisco.nxos.nxos_interface_ospf.
В версии 1.0.0: из cisco.nxos
УСТАРЕВШИЙ
- Удален в
-
главном выпуске после 2022-10-26
- Почему
-
Обновленные модули выпущены с дополнительной функциональностью
- Альтернатива
-
nxos_ospf_interfaces
Обзор
- Управляет конфигурацией экземпляра интерфейса OSPF.
Примечание
Данный модуль имеет соответствующий плагин действий.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| area строка / обязательно | Область OSPF, связанная с этим экземпляром cisco_interface_ospf. Допустимые значения — строка, отформатированная как IP-адрес (например, "0.0.0.0") или целое число. | ||
| bfd строка |
| Включает bfd на уровне интерфейса. Это переопределяет переменную bfd, заданную на уровне маршрутизатора ospf. Допустимые значения — 'включить', 'выключить' или 'по умолчанию'. Зависимость: ''функция bfd'' | |
| cost строка | Стоимость, связанная с этим экземпляром cisco_interface_ospf. | ||
| dead_interval строка | Интервал времени, в течение которого маршрутизатор OSPF ожидает пакета hello перед разрывом соседства. Допустимые значения — целое число или ключевое слово 'по умолчанию'. | ||
| hello_interval строка | Время между отправкой последовательных пакетов hello. Допустимые значения — целое число или ключевое слово 'по умолчанию'. | ||
| interface строка / обязательно | Имя этого ресурса cisco_interface. Допустимое значение — строка. | ||
| message_digest булево |
| Включает или отключает использование аутентификации с контролем целостности сообщений. | |
| message_digest_algorithm_type строка |
| Алгоритм, используемый для аутентификации между соседними маршрутизаторами в пределах области. Допустимые значения — 'md5' и 'по умолчанию'. | |
| message_digest_encryption_type строка |
| Указывает схему, используемую для шифрования message_digest_password. Допустимые значения — шифрование '3des' или 'cisco_type_7' или 'по умолчанию'. | |
| message_digest_key_id строка | Идентификатор ключа аутентификации md5, связанный с экземпляром ospf. Если он присутствует, message_digest_encryption_type, message_digest_algorithm_type и message_digest_password являются обязательными. Допустимое значение — целое число и 'по умолчанию'. | ||
| message_digest_password строка | Указывает пароль message_digest. Допустимое значение — строка. | ||
| network строка |
| Указывает тип сети ospf интерфейса. Допустимые значения — 'точка-точка' или 'вещательная сеть'. | |
| ospf строка / обязательно | Имя экземпляра ospf. | ||
| passive_interface булево |
| Включить или выключить состояние passive-interface на этом интерфейсе. true - (включить) предотвратить установку соседства OSPF или отправку обновлений маршрутизации на этом интерфейсе. false - (выключить) переопределить глобальное 'passive-interface по умолчанию' для этого интерфейса. | |
| provider словарь | Устарело Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli. Начиная с Ansible 2.6, для NX-API рекомендуется использовать connection: httpapi. Этот параметр будет удален в релизе после 2022-06-01. Дополнительную информацию можно найти в руководстве NXOS Platform Options. Объект словаря, содержащий данные подключения. | ||
| auth_pass строка | Указывает пароль, необходимый для входа в привилегированный режим на удаленном устройстве. Если authorize равно false, этот параметр ничего не делает. Если значение не указано в задаче, будет использовано значение переменной среды ANSIBLE_NET_AUTH_PASS. | ||
| authorize булево |
| Указывает модулю войти в привилегированный режим на удаленном устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, будет использовано значение переменной среды ANSIBLE_NET_AUTHORIZE. | |
| host строка | Указывает имя хоста DNS или адрес для подключения к удаленному устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта. | ||
| password строка | Указывает пароль для аутентификации подключения к удаленному устройству. Это общий параметр, используемый для транспортов cli или nxapi. Если значение не указано в задаче, будет использовано значение переменной среды ANSIBLE_NET_PASSWORD. | ||
| port целое число | Указывает порт, используемый при построении подключения к удаленному устройству. Это значение относится к cli или nxapi. Значение порта по умолчанию соответствует обычному порту соответствующего транспорта, если он не указан в задаче (cli=22, http=80, https=443). | ||
| ssh_keyfile строка | Указывает SSH-ключ для аутентификации подключения к удаленному устройству. Этот параметр используется только для транспорта cli. Если значение не указано в задаче, будет использовано значение переменной среды ANSIBLE_NET_SSH_KEYFILE. | ||
| timeout целое число | Указывает тайм-аут в секундах для связи с сетевым устройством для подключения или отправки команд. Если тайм-аут истекает до завершения операции, модуль вернет ошибку. NX-API может быть медленным при возврате результатов при длительных командах (sh mac, sh bgp и т. д.). | ||
| transport строка |
| Настраивает транспортное соединение для подключения к удаленному устройству. Параметр transport поддерживает подключение к устройству через cli (ssh) или nxapi. | |
| use_proxy булево |
| Если no, переменные среды http_proxy и https_proxy будут проигнорированы. | |
| use_ssl булево |
| Настраивает transport для использования SSL, если установлено значение yes, только когда transport=nxapi, в противном случае это значение игнорируется. | |
| username строка | Настраивает имя пользователя для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации входа в CLI или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задаче, будет использовано значение переменной среды ANSIBLE_NET_USERNAME. | ||
| validate_certs булево |
| Если no, сертификаты SSL не будут проверены. Это следует использовать только на сайтах, находящихся под собственным контролем, использующих самозаверяющие сертификаты. Если параметр transport не равен nxapi, это значение игнорируется. | |
| state строка |
| Определяет, должен ли быть настроен параметр на устройстве. | |
Примечания
Примечание
- Проверено на 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.nxos.nxos_interface_ospf:
interface: ethernet1/32
ospf: 1
area: 1
bfd: disable
cost: default
- cisco.nxos.nxos_interface_ospf:
interface: loopback0
ospf: prod
area: 0.0.0.0
bfd: enable
network: point-to-point
state: present
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| commands список / элементы=строка | всегда | команды, отправленные на устройство Пример: ['interface Ethernet1/32', 'ip router ospf 1 area 0.0.0.1', 'ip ospf bfd disable'] |
Статус
- Этот модуль будет удален в основной версии после 2022-10-26. [устаревший]
- Дополнительную информацию см. в разделе УСТАРЕВШИЙ.
Авторы
- 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.10/collections/cisco/nxos/nxos_interface_ospf_module.html