nxos_interface_ospf — Управляет конфигурацией экземпляра интерфейса OSPF.
Новая версия с 2.2.
Описание
- Управляет конфигурацией экземпляра интерфейса OSPF.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| area обязательно | Область OSPF, связанная с этим экземпляром cisco_interface_ospf. Допустимые значения — строка, отформатированная как IP-адрес (например, "0.0.0.0") или целое число. | ||
| cost | По умолчанию: Нет | Стоимость, связанная с этим экземпляром cisco_interface_ospf. | |
| dead_interval | По умолчанию: Нет | Интервал времени, в течение которого сосед OSPF ожидает пакета hello перед разрывом смежности. Допустимые значения — целое число или ключевое слово 'default'. | |
| hello_interval | По умолчанию: Нет | Период времени между отправкой последовательных пакетов hello. Допустимые значения — целое число или ключевое слово 'default'. | |
| interface обязательно | Имя этого ресурса cisco_interface. Допустимое значение — строка. | ||
| message_digest |
Нет | Включает или отключает использование аутентификации с помощью message digest. Допустимые значения — 'true' и 'false'. | |
| 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. Допустимое значение — строка. | |
| ospf обязательно | Имя экземпляра ospf. | ||
| passive_interface |
Нет | Установите в значение true, чтобы предотвратить получение этим интерфейсом пакетов HELLO. Допустимые значения — 'true' и 'false'. | |
| provider | По умолчанию: Нет | Устарело Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli. Этот параметр требуется только при использовании NX-API. Дополнительную информацию см. в руководстве NXOS Platform Options. Объект словаря, содержащий сведения о подключении. | |
| username | Настраивает имя пользователя для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации входа в CLI или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_USERNAME. | ||
| authorize (добавлен в 2.5.3) |
| Указывает модулю войти в привилегированный режим на удаленном устройстве перед отправкой каких-либо команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTHORIZE. | |
| ssh_keyfile | Указывает SSH-ключ для аутентификации подключения к удаленному устройству. Этот аргумент используется только для транспорта cli. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_SSH_KEYFILE. | ||
| use_proxy (добавлен в 2.5) |
| Если no, переменные среды http_proxy и https_proxy будут игнорироваться. | |
| auth_pass (добавлен в 2.5.3) | По умолчанию: нет | Указывает пароль для входа в привилегированный режим на удалённом устройстве, если это требуется. Если authorize равно false, этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTH_PASS. | |
| host обязательно | Указывает имя хоста DNS или адрес для подключения к удалённому устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта. | ||
| timeout (добавлен в 2.3) | По умолчанию: 10 | Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут превышен до завершения операции, модуль вернёт ошибку. NX-API может медленно возвращать результаты при выполнении длительных команд (sh mac, sh bgp и т. д.). | |
| use_ssl |
| Настраивает transport на использование SSL, если значение true только тогда, когда transport=nxapi, в противном случае это значение игнорируется. | |
| password | По умолчанию: Нет | Указывает пароль для аутентификации подключения к удаленному устройству. Это общий аргумент, используемый для транспортов cli или nxapi. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_PASSWORD. | |
| validate_certs |
Нет | Если no, сертификаты SSL не будут проверены. Это следует использовать только на контролируемых лично сайтах, использующих самоподписанные сертификаты. Если аргумент transport не nxapi, это значение игнорируется. | |
| port | По умолчанию: 0 (использовать стандартный порт) | Указывает порт для создания подключения к удаленному устройству. Это значение относится к транспорту cli или nxapi. Значение порта по умолчанию будет соответствовать общему порту транспорта, если он не предоставлен в задаче (cli=22, http=80, https=443). | |
| transport обязательно | По умолчанию: cli | Настраивает транспортное соединение для подключения к удаленному устройству. Аргумент transport поддерживает подключение к устройству через cli (ssh) или nxapi. | |
| state |
| Определяет, должен ли конфигурация быть присутствующей или отсутствовать на устройстве. | |
Примечания
Примечание
- Проверено на NXOSv 7.3.(0)D1(1) на VIRL
- Значение по умолчанию, где поддерживается, восстанавливает значения параметров по умолчанию.
- Чтобы удалить существующую конфигурацию аутентификации, необходимо использовать
message_digest_key_id=defaultплюс все остальные параметры, соответствующие их существующим значениям. -
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
cost: default
Возвращаемые значения
Общие значения возвращаемых данных описаны здесь, ниже приведены поля, уникальные для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| commands список | всегда | команды, отправленные на устройство Пример: ['interface Ethernet1/32', 'ip router ospf 1 area 0.0.0.1'] |
Статус
Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость.
Поддержка
Для получения дополнительной информации о поддержке данного модуля компанией Red Hat, пожалуйста, обратитесь к этой статье из базы знаний
Автор
- 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.5/modules/nxos_interface_ospf_module.html
