nxos_interface - Управляет физическими атрибутами интерфейсов.
Новая версия 2.1.
Описание
- Управляет физическими атрибутами интерфейсов коммутаторов NX-OS.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| admin_state |
| Административное состояние интерфейса. | |
| aggregate (добавлено в 2.5) | Список определений интерфейсов. | ||
| delay | Значение по умолчанию: 10 | Время в секундах ожидания перед проверкой операционного состояния на удалённом устройстве. Это ожидание применяется для аргументов операционного состояния. | |
| description | Значение по умолчанию: None | Описание интерфейса. | |
| duplex (добавлено в 2.5) |
| Статус соединения интерфейса. Применимо только для интерфейсов ethernet. | |
| fabric_forwarding_anycast_gateway (добавлено в 2.2) |
None | Связать SVI с anycast шлюзом в режиме конфигурации VLAN. Применимо только для интерфейсов SVI. | |
| interface_type (добавлено в 2.2) |
None | Тип интерфейса, который нужно отключить на устройстве. | |
| ip_forward (добавлено в 2.2) |
None | Включить/выключить функцию ip forward для SVIs. | |
| mode |
None | Управление состоянием интерфейса Layer 2 или Layer 3. Этот параметр поддерживается для ethernet и portchannel интерфейсов. Применимо только для ethernet и portchannel интерфейсов. | |
| mtu (добавлено в 2.5) | MTU для конкретного интерфейса. Должно быть чётным числом от 576 до 9216. Применимо только для интерфейсов ethernet. | ||
| name обязательно | Значение по умолчанию: None | Полное имя интерфейса, например Ethernet1/1, port-channel10. псевдонимы: interface | |
| neighbors (добавлено в 2.5) | Проверка операционного состояния заданного интерфейса name для соседа LLDP.Доступны следующие подопции. Это только параметр проверки состояния. | ||
| host | Хост соседа LLDP для данного интерфейса name. | ||
| port | Порт соседа LLDP, к которому подключен данный интерфейс name. | ||
| provider | Значение по умолчанию: None | Устарело Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli.Этот параметр необходим только при использовании NX-API. Для получения дополнительной информации, обратитесь к руководству NXOS Platform Options. Объект словаря, содержащий данные подключения. | |
| username | Настраивает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации входа в командную строку или аутентификации 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) | Значение по умолчанию: none | Указывает пароль для входа в привилегированный режим на удалённом устройстве, если требуется. Если 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 | Значение по умолчанию: None | Указывает пароль для аутентификации подключения к удалённому устройству. Это общий аргумент, используемый для транспортов cli или nxapi. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_PASSWORD. | |
| validate_certs |
None | Если no, сертификаты SSL не будут проверены. Это следует использовать только на сайтах, контролируемых лично, которые используют самозаверяющие сертификаты. Если аргумент transport не nxapi, это значение игнорируется. | |
| port | Значение по умолчанию: 0 (использовать стандартный порт) | Указывает порт для создания соединения с удалённым устройством. Это значение применимо к транспорту cli или nxapi. Значение порта будет по умолчанию соответствовать общепринятому порту для транспорта, если он не указан в задаче. (cli=22, http=80, https=443). | |
| transport обязательно | Значение по умолчанию: cli | Настраивает транспортное соединение для подключения к удалённому устройству. Аргумент transport поддерживает подключение к устройству через cli (ssh) или nxapi. | |
| rx_rate (добавлено в 2.5) | Скорость приёма в битах в секунду (bps). Это только параметр проверки состояния. Поддерживает условные выражения, см. Условные выражения в сетевых модулях
| ||
| speed (добавлено в 2.5) | Скорость соединения интерфейса. Применимо только для интерфейсов ethernet. | ||
| state обязательно |
| Указывает желаемое состояние ресурса. | |
| tx_rate (добавлено в 2.5) | Скорость передачи в битах в секунду (bps). Это только параметр проверки состояния. Поддерживает условные выражения, см. Условные выражения в сетевых модулях
| ||
Примечания
Примечание
- Проверено на 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 Network Guide.
- Дополнительную информацию об использовании 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'] |
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантирует обратной совместимости.
Поддержка
Дополнительную информацию о поддержке данного модуля Red Hat см. в этой статье из базы знаний Knowledge Base article
Автор
- 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.5/modules/nxos_interface_module.html