cisco.nxos.nxos_interface_ospf – (устаревший, удалён после 2022-10-26) Управляет конфигурацией экземпляра интерфейса OSPF.
Примечание
Этот плагин является частью коллекции cisco.nxos (версия 1.4.0).
Для его установки используйте: 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. Допустимые значения — '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 строка |
| Указывает тип сети интерфейса ospf. Допустимые значения — 'point-to-point' или 'broadcast'. | |
| ospf строка / обязательно | Имя экземпляра ospf. | ||
| passive_interface логическое значение |
| Включить или отключить состояние passive-interface на этом интерфейсе. true — (включить) Предотвратить установление смежности OSPF или отправку обновлений маршрутизации по этому интерфейсу. false — (отключить) Переопределить глобальный 'passive-interface default' для этого интерфейса. | |
| provider словарь | Устаревшее Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli. Начиная с Ansible 2.6, рекомендуется использовать connection: httpapi для NX-API.Этот параметр будет удалён в версии после 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
- Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в Руководстве по сети Ansible
- Дополнительную информацию об использовании 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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/cisco/nxos/nxos_interface_ospf_module.html