nxos_l2_interface – Управление интерфейсом второго уровня на устройствах Cisco NXOS
Новая версия 2.5.
УСТАНОВЛЕНО
| Удалено в Ansible: | |
|---|---|
| версия: 2.13 | |
| Почему: | Выпущены обновлённые модули с дополнительной функциональностью |
| Альтернатива: | nxos_l2_interfaces |
Описание
- Этот модуль обеспечивает декларативное управление интерфейсом второго уровня на устройствах Cisco NXOS.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| access_vlan - | Настройка заданной VLAN на порту доступа. Если mode=access, используется идентификатор VLAN доступа. | ||
| aggregate - | Список определений интерфейсов второго уровня. | ||
| 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 | Указывает пароль для использования при входе в привилегированный режим на удалённом устройстве. Если authorize ложно, то этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTH_PASS. | ||
| authorize булево добавлен в 2.5.3 |
| Инструктирует модуль войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTHORIZE. | |
| host строка / обязательно | Указывает имя хоста DNS или адрес для подключения к удалённому устройству по указанному транспорту. Значение host используется в качестве адреса назначения для транспорта. | ||
| 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 целое число | По умолчанию: 10 | Указывает время ожидания в секундах для связи с сетевым устройством для подключения или отправки команд. Если время ожидания истечёт до завершения операции, модуль выдаст ошибку. NX-API может медленно возвращать данные при длительных командах (sh mac, sh bgp и т. д.). | |
| transport строка / обязательно |
| Настраивает транспортное соединение для использования при подключении к удалённому устройству. Аргумент transport поддерживает подключение к устройству через cli (ssh) или nxapi. | |
| use_proxy булево добавлен в 2.5 |
| Если no, переменные среды http_proxy и https_proxy будут проигнорированы. | |
| use_ssl булево |
| Настраивает транспорт transport для использования SSL, если задано yes, только при transport=nxapi, в противном случае это значение игнорируется. | |
| username строка | Настраивает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации входа в CLI или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_USERNAME. | ||
| validate_certs булево |
| Если no, сертификаты SSL не будут проверены. Это следует использовать только на контролируемых сайтах с использованием самозаверяемых сертификатов. Если аргумент transport не 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
- Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в руководстве по Ansible для сети
- Дополнительную информацию об использовании 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'] |
Статус
- Этот модуль будет удален в версии 2.13. [устаревший]
- Дополнительную информацию можно найти в УСТАРЕВШИЙ.
Авторы
- 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.9/modules/nxos_l2_interface_module.html