nxos_interface_ospf — Управляет конфигурацией экземпляра интерфейса OSPF.
Новая версия с 2.2.
Описание
- Управляет конфигурацией экземпляра интерфейса OSPF.
Параметры
| параметр | обязательно | по умолчанию | значения | комментарии |
|---|---|---|---|---|
| area | да | Область OSPF, связанная с этим экземпляром cisco_interface_ospf. Допустимые значения — строка, отформатированная как IP-адрес (например, "0.0.0.0") или как целое число. | ||
| auth_pass (добавлено в 2.4.4)
| нет | отсутствует | Указывает пароль для входа в привилегированный режим на удалённом устройстве, если это требуется. Если authorize равно false, этот аргумент ничего не делает. Если значение не указано в задании, используется значение переменной окружения ANSIBLE_NET_AUTH_PASS. | |
| authorize (добавлено в 2.4.4)
| нет |
| Указывает модулю войти в привилегированный режим на удалённом устройстве перед отправкой команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задании, используется значение переменной окружения ANSIBLE_NET_AUTHORIZE. | |
| cost | нет | Стоимость, связанная с этим экземпляром cisco_interface_ospf. | ||
| dead_interval | нет | Интервал времени, в течение которого сосед OSPF ожидает пакет hello перед разрывом adjacencies. Допустимые значения — целое число или ключевое слово 'default'. | ||
| hello_interval | нет | Интервал времени между отправкой последовательных пакетов hello. Допустимые значения — целое число или ключевое слово 'default'. | ||
| host | да | Указывает имя хоста DNS или адрес для подключения к удалённому устройству через указанный транспорт. Значение host используется как адрес назначения для транспорта. | ||
| interface | да | Имя этого ресурса cisco_interface. Допустимое значение — строка. | ||
| message_digest | нет |
| Включает или отключает использование аутентификации с помощью message digest. Допустимые значения — 'true' и 'false'. | |
| 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 обязательны. Допустимое значение — целое число и 'default'. | ||
| message_digest_password | нет | Указывает пароль message_digest. Допустимое значение — строка. | ||
| ospf | да | Имя экземпляра ospf. | ||
| passive_interface | нет |
| Установление в значение true предотвратит получение пакетов HELLO этим интерфейсом. Допустимые значения — 'true' и 'false'. | |
| password | нет | Указывает пароль для аутентификации подключения к удалённому устройству. Это общий аргумент, используемый для транспортов cli или nxapi. Если значение не указано в задании, используется значение переменной окружения ANSIBLE_NET_PASSWORD. | ||
| port | нет | 0 (использовать стандартный порт) | Указывает порт для подключения к удалённому устройству. Это значение относится к cli или nxapi. Значение порта будет по умолчанию установлено на соответствующий стандартный порт транспорта, если он не предоставлен в задании (cli=22, http=80, https=443). | |
| provider | нет | Удобный метод, позволяющий передать все аргументы nxos в виде объекта словаря. Все ограничения (обязательность, допустимые значения и т. д.) должны быть соблюдены либо отдельными аргументами, либо значениями в этом словаре. | ||
| ssh_keyfile | нет | Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Этот аргумент используется только для транспорта cli. Если значение не указано в задании, используется значение переменной окружения ANSIBLE_NET_SSH_KEYFILE. | ||
| state | нет | present |
| Определяет, должна ли конфигурация присутствовать на устройстве или нет. |
| timeout (добавлено в 2.3)
| нет | 10 | Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истечёт до завершения операции, модуль выдаст ошибку. NX-API может медленно возвращать данные при выполнении длительных команд (sh mac, sh bgp и т. д.). | |
| transport | да | cli | Настраивает подключение транспорта для соединения с удалённым устройством. Аргумент transport поддерживает подключение к устройству через cli (ssh) или nxapi. | |
| use_ssl | нет |
| Настраивает transport для использования SSL, если установлено в значение true только в том случае, если transport=nxapi, в противном случае это значение игнорируется. | |
| username | нет | Настраивает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации входа в CLI или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задании, используется значение переменной окружения ANSIBLE_NET_USERNAME. | ||
| validate_certs | нет |
| Если no, сертификаты SSL не будут проверены. Это следует использовать только на контролируемых лично сайтах, использующих самоподписанные сертификаты. Если аргумент transport не равен nxapi, это значение игнорируется. |
Примеры
- 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'] |
Примечания
Примечание
- Проверено на NXOSv 7.3.(0)D1(1) на VIRL
- Значение по умолчанию, где поддерживается, восстанавливает значение параметров по умолчанию.
- Для удаления существующей конфигурации аутентификации необходимо использовать
message_digest_key_id=defaultплюс все остальные параметры, соответствующие их существующим значениям. -
state=absentудаляет всю конфигурацию интерфейса OSPF.
Статус
Этот модуль помечен как предварительный, что означает, что он не гарантирует обратную совместимость интерфейса.
Информация о техническом обслуживании
Для получения дополнительной информации о поддержке этого модуля компанией Red Hat, обратитесь к knowledge base article<https://access.redhat.com/articles/rhel-top-support-policies>.
Для помощи в разработке модулей, если вы заинтересованы, ознакомьтесь с Информация о сообществе и участие в разработке, Тестирование Ansible и Разработка модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/nxos_interface_ospf_module.html
