nxos_interface — Управляет физическими атрибутами интерфейсов.
Новая в версии 2.1.
Обзор
- Управляет физическими атрибутами интерфейсов коммутаторов NX-OS.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| admin_state |
| Административное состояние интерфейса. | |
| aggregate (добавлен в 2.5) | Список определений интерфейсов. | ||
| delay | Значение по умолчанию: 10 | Время в секундах ожидания проверки операционного состояния на удаленном устройстве. Это ожидание применяется для аргументов операционного состояния. | |
| description | Описание интерфейса. | ||
| duplex (добавлен в 2.5) |
| Состояние соединения интерфейса. Применимо только для интерфейсов Ethernet. | |
| fabric_forwarding_anycast_gateway bool (добавлен в 2.2) |
| Связать SVI с anycast шлюзом в режиме конфигурации VLAN. Применимо только для интерфейсов SVI. | |
| interface_type (добавлен в 2.2) |
| Тип интерфейса, который будет отключен на устройстве. | |
| ip_forward (добавлен в 2.2) |
| Включение/выключение функции ip forward на SVI. | |
| mode |
| Управление состоянием уровня 2 или уровня 3 интерфейса. Этот параметр поддерживается для интерфейсов ethernet и portchannel. Применимо только для ethernet и portchannel интерфейсов. | |
| mtu (добавлен в 2.5) | MTU для конкретного интерфейса. Должно быть четным числом от 576 до 9216. Применимо только для интерфейсов Ethernet. | ||
| name обязательно | Полное имя интерфейса, например Ethernet1/1, port-channel10. алиасы: interface | ||
| neighbors (добавлен в 2.5) | Проверка операционного состояния указанного интерфейса name для соседа LLDP.Доступны следующие подпараметры. Это только параметр проверки состояния. | ||
| host | Хост соседа LLDP для данного интерфейса name. | ||
| port | Порт соседа LLDP, к которому подключен данный интерфейс name. | ||
| 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 будут проигнорированы. | |
| rx_rate (добавлен в 2.5) | Скорость приёма в битах в секунду (бит/с). Это только параметр проверки состояния. Поддерживает условные выражения, см. Условные выражения в сетевых модулях
| ||
| speed (добавлен в 2.5) | Скорость соединения интерфейса. Применимо только для интерфейсов Ethernet. | ||
| state |
| Укажите желаемое состояние ресурса. | |
| tx_rate (добавлен в 2.5) | Скорость передачи в битах в секунду (бит/с). Это только параметр проверки состояния. Поддерживает условные выражения, см. Условные выражения в сетевых модулях
| ||
Примечания
Примечание
- Тестировалось на NXOSv 7.3.(0)D1(1) на VIRL
- Этот модуль также используется для создания логических интерфейсов, таких как svis и loopbacks.
- Будьте осторожны с платформенными особенностями. Например, при установке по умолчанию интерфейса loopback, состояние администратора переключается на некоторых версиях NX-OS.
- Атрибут nxos_overlay_global
anycast_gateway_macдолжен быть установлен перед установкой свойстваfabric_forwarding_anycast_gateway. - Дополнительную информацию об использовании CLI и NX-API см. в руководстве NXOS Platform Options
- Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в руководстве Сетевое руководство Ansible
- Дополнительную информацию об использовании Ansible для управления устройствами Cisco см. на странице интеграции Cisco Cisco integration page.
Примеры
- name: Ensure an interface is a Layer 3 port and that it has the proper description
nxos_interface:
name: Ethernet1/1
description: 'Configured by Ansible'
mode: layer3
- name: Admin down an interface
nxos_interface:
name: Ethernet2/1
admin_state: down
- name: Remove all loopback interfaces
nxos_interface:
name: loopback
state: absent
- name: Remove all logical interfaces
nxos_interface:
interface_type: "{{ item }} "
state: absent
loop:
- loopback
- portchannel
- svi
- nve
- name: Admin up all loopback interfaces
nxos_interface:
name: loopback 0-1023
admin_state: up
- name: Admin down all loopback interfaces
nxos_interface:
name: looback 0-1023
admin_state: down
- name: Check neighbors intent arguments
nxos_interface:
name: Ethernet2/3
neighbors:
- port: Ethernet2/3
host: abc.mycompany.com
- name: Add interface using aggregate
nxos_interface:
aggregate:
- { name: Ethernet0/1, mtu: 256, description: test-interface-1 }
- { name: Ethernet0/2, mtu: 516, description: test-interface-2 }
duplex: full
speed: 100
state: present
- name: Delete interface using aggregate
nxos_interface:
aggregate:
- name: Loopback9
- name: Loopback10
state: absent
- name: Check intent arguments
nxos_interface:
name: Ethernet0/2
state: up
tx_rate: ge(0)
rx_rate: le(0)
Значения возврата
Общие значения возврата документированы здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| commands список | всегда | Список команд, отправленных устройству Пример: ['interface Ethernet2/3', 'mtu 1500', 'speed 10'] |
Статус
Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость интерфейса.
Техническое обслуживание
Этот модуль помечен как сетевой, что означает, что он поддерживается командой Ansible по сетям. Подробнее см. в поддержке и техническом обслуживании модулей.
Список других модулей, поддерживаемых командой Ansible по сетям, см. здесь.
Поддержка
Дополнительную информацию о поддержке этого модуля компанией Red Hat см. в этой статье базы знаний
Автор
- Jason Edelman (@jedelman8)
- Trishna Guha (@trishnaguha)
Подсказка
Если вы заметите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 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_module.html