nxos_l2_interface — Управление интерфейсом второго уровня на устройствах Cisco NXOS.
Новая версия 2.5.
Описание
- Этот модуль обеспечивает декларативное управление интерфейсом второго уровня на устройствах Cisco NXOS.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| access_vlan | Настроить заданный VLAN в порту доступа. Если mode=access, используется как идентификатор VLAN доступа. | ||
| aggregate | Список определений интерфейсов второго уровня. | ||
| mode |
| Режим, в котором должен быть настроен интерфейс. | |
| name обязательно | Полное имя интерфейса без номера логического блока, например Ethernet1/1. Псевдонимы: интерфейс | ||
| native_vlan | Нативный VLAN, который должен быть настроен в порту trunk. Если mode=trunk, используется как идентификатор нативного VLAN trunk. | ||
| provider | Значение по умолчанию: None | Устарело Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli. Этот параметр требуется только при использовании NX-API. Дополнительную информацию можно найти в руководстве NXOS Platform Options. Объект типа dict, содержащий данные подключения. | |
| 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) | Значение по умолчанию: none | Указывает пароль для входа в привилегированный режим на удаленном устройстве, если это необходимо. Если authorize false, этот аргумент ничего не делает. Если значение не указано в задаче, будет использовано значение переменной среды ANSIBLE_NET_AUTH_PASS. | |
| host обязательно | Указывает имя DNS-хоста или адрес для подключения к удаленному устройству по указанному транспорту. Значение host используется в качестве адреса назначения для транспорта. | ||
| timeout (добавлен в 2.3) | Значение по умолчанию: 10 | Указывает тайм-аут в секундах для связи с сетевым устройством при подключении или отправке команд. Если тайм-аут истекает до завершения операции, модуль выдаст ошибку. NX-API может медленно возвращать данные при выполнении длительных команд (sh mac, sh bgp и т. д.). | |
| use_ssl |
| Настраивает транспорт для использования 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. | |
| state |
| Управление состоянием конфигурации интерфейса второго уровня. | |
| trunk_allowed_vlans | Список разрешенных VLAN в заданном порту trunk. Если mode=trunk, это единственные VLAN, которые будут настроены на trunk, например "2-10,15". | ||
| trunk_vlans | Список VLAN, которые должны быть настроены в порту trunk. Если mode=trunk, используется диапазон VLAN для добавления или удаления из trunk.Псевдонимы: trunk_add_vlans | ||
Примечания
Примечание
- Проверено на NXOSv 7.0(3)I5(1).
- Дополнительная информация об использовании CLI и NX-API представлена в руководстве NXOS Platform Options
- Дополнительная информация об использовании Ansible для управления сетевыми устройствами представлена в руководстве Ansible Network Guide
- Дополнительная информация об использовании Ansible для управления устройствами Cisco представлена на странице интеграции Cisco Cisco integration page.
Примеры
- name: Ensure Eth1/5 is in its default l2 interface state
nxos_l2_interface:
name: Ethernet1/5
state: unconfigured
- name: Ensure Eth1/5 is configured for access vlan 20
nxos_l2_interface:
name: Ethernet1/5
mode: access
access_vlan: 20
- name: Ensure Eth1/5 only has vlans 5-10 as trunk vlans
nxos_l2_interface:
name: Ethernet1/5
mode: trunk
native_vlan: 10
trunk_vlans: 5-10
- name: Ensure eth1/5 is a trunk port and ensure 2-50 are being tagged (doesn't mean others aren't also being tagged)
nxos_l2_interface:
name: Ethernet1/5
mode: trunk
native_vlan: 10
trunk_vlans: 2-50
- name: Ensure these VLANs are not being tagged on the trunk
nxos_l2_interface:
name: Ethernet1/5
mode: trunk
trunk_vlans: 51-4094
state: absent
- name: Aggregate Configure interfaces for access_vlan with aggregate
nxos_l2_interface:
aggregate:
- { name: "Ethernet1/2", access_vlan: 6 }
- { name: "Ethernet1/7", access_vlan: 15 }
mode: access
Возвращаемые значения
Общие значения, возвращаемые модулем, описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| commands список | всегда, кроме платформ, использующих транспорт Netconf для управления устройством. | Список команд режима конфигурации для отправки устройству Пример: ['interface eth1/5', 'switchport access vlan 20'] |
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется как обратный.
Поддержка
Дополнительную информацию о поддержке этого модуля компанией Red Hat см. в этой статье базы знаний
Автор
- 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_l2_interface_module.html