nxos_l2_interface – Управление интерфейсом уровня 2 на устройствах Cisco NXOS.
Новая версия 2.5.
Описание
- Этот модуль предоставляет декларативное управление интерфейсом уровня 2 на устройствах Cisco NXOS.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| access_vlan - | Настройка указанного VLAN на порту доступа. Если mode=access, используется в качестве идентификатора VLAN доступа. | ||
| aggregate - | Список определений интерфейсов уровня 2. | ||
| mode - |
| Режим конфигурации интерфейса. | |
| name - / обязательно | Полное имя интерфейса без номера логического блока, например, Ethernet1/1. Псевдонимы: интерфейс | ||
| native_vlan - | Основной VLAN, который нужно настроить на порту trunk. Если mode=trunk, используется в качестве идентификатора основного VLAN trunk. | ||
| provider - | Устаревшее Начиная с Ansible 2.5 рекомендуется использовать connection: network_cli. Этот параметр необходим только при использовании NX-API. Для получения дополнительной информации см. руководство NXOS Platform Options. Объект словаря, содержащий данные подключения. | ||
| auth_pass - добавлен в 2.5.3 | По умолчанию: "none" | Указывает пароль, который необходимо использовать, если требуется ввод привилегированного режима на удаленном устройстве. Если authorize ложно, этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTH_PASS. | |
| authorize boolean добавлен в 2.5.3 |
| Инструктирует модуль перейти в привилегированный режим на удаленном устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTHORIZE. | |
| host - / обязательно | Указывает имя хоста DNS или адрес для подключения к удаленному устройству через указанный транспорт. Значение хоста используется в качестве адреса назначения для транспорта. | ||
| password - | Указывает пароль, используемый для аутентификации подключения к удаленному устройству. Это общий аргумент, используемый для транспортов cli или nxapi. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_PASSWORD. | ||
| port - | По умолчанию: "0 (использовать общий порт)" | Указывает порт для подключения к удаленному устройству. Это значение применимо к транспорту cli или nxapi. Значение порта по умолчанию соответствует общему порту соответствующего транспорта, если в задаче не указано другое. (cli=22, http=80, https=443). | |
| ssh_keyfile - | Указывает SSH-ключ для аутентификации подключения к удаленному устройству. Этот аргумент используется только для транспорта cli. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_SSH_KEYFILE. | ||
| timeout - добавлен в 2.3 | По умолчанию: 10 | Устанавливает тайм-аут в секундах для связи с сетевым устройством для подключения или отправки команд. Если тайм-аут истек до завершения операции, модуль вернет ошибку. NX-API может медленно возвращать результат при выполнении длительных команд (sh mac, sh bgp и т.д.). | |
| transport - / обязательно | По умолчанию: "cli" | Конфигурирует транспортное соединение для подключения к удаленному устройству. Аргумент transport поддерживает подключение к устройству по cli (ssh) или nxapi. | |
| use_proxy boolean добавлен в 2.5 |
| Если no, переменные среды http_proxy и https_proxy будут проигнорированы. | |
| use_ssl boolean |
| Конфигурирует transport для использования SSL, если значение равно true, только если transport=nxapi, в противном случае это значение игнорируется. | |
| username - | Настраивает имя пользователя для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации входа в CLI или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_USERNAME. | ||
| validate_certs boolean |
| Если no, сертификаты SSL не будут проверены. Это следует использовать только на сайтах, находящихся под личным контролем, использующих самозаверенные сертификаты. Если аргумент transport не nxapi, это значение игнорируется. | |
| state - |
| Управление состоянием конфигурации интерфейса уровня 2. | |
| 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 list | всегда, за исключением платформ, использующих транспорт Netconf для управления устройством. | Список команд режима конфигурации для отправки устройству Пример: ['interface eth1/5', 'switchport access vlan 20'] |
Статус
- Данный модуль не гарантирует обратную совместимость интерфейса. [preview]
- Данный модуль поддерживается командой Ansible Network Team. [network]
Поддержка Red Hat
Дополнительную информацию о поддержке данного модуля Red Hat можно найти в статье базы знаний 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.7/modules/nxos_l2_interface_module.html