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