nxos_l2_interface — Управление интерфейсом второго уровня на устройствах Cisco NXOS.
Новая версия с 2.5.
Обзор
- Этот модуль предоставляет декларативное управление интерфейсом второго уровня на устройствах Cisco NXOS.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| access_vlan | Настройка заданной VLAN на порту доступа. Если mode=access, используется как идентификатор VLAN доступа. | ||
| aggregate | Список определений интерфейсов второго уровня. | ||
| mode |
| Режим, в котором должен быть настроен интерфейс. | |
| name обязательно | Полное имя интерфейса без номера логического блока, например Ethernet1/1. псевдонимы: interface | ||
| native_vlan | Нативная VLAN для настройки на порту trunk. Если mode=trunk, используется как идентификатор нативной VLAN trunk. | ||
| provider | Устарело Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli. Этот параметр нужен только при использовании NX-API. Для получения дополнительной информации см. руководство NXOS Platform Options. Объект типа dict, содержащий данные подключения. | ||
| 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) | Значение по умолчанию: "нет" | Указывает пароль, необходимый для входа в привилегированный режим на удаленном устройстве. Если authorize ложно, этот аргумент ничего не делает. Если значение не указано в задании, используется значение переменной среды 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 |
| Управление состоянием конфигурации интерфейса второго уровня. | |
| 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.
Примеры
- 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'] |
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантированно будет обратной совместимостью.
Техническое обслуживание
Этот модуль помечен как сетевой, что означает, что он поддерживается командой Ansible по работе с сетями. Для получения дополнительной информации см. поддержку и техническое обслуживание модулей.
Список других модулей, которые также поддерживаются командой Ansible по работе с сетями, см. в этом месте.
Поддержка
Для получения дополнительной информации о поддержке этого модуля компанией Red Hat см. эту статью в базе знаний Knowledge Base article
Автор
- 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_l2_interface_module.html