nxos_switchport – Управляет портами коммутатора уровня 2.
Новая версия с 2.1.
УСТЕРЕВШЕЕ
| Удалено в Ansible: | |
|---|---|
| версия: 2.9 | |
| Почему: | Заменено на общую версию. |
| Альтернатива: | Используйте nxos_l2_interface вместо этого. |
Описание
- Управляет интерфейсами уровня 2
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| access_vlan - | Если mode=access, используется как идентификатор VLAN доступа. | ||
| interface - | Полное имя интерфейса, например Ethernet1/1. | ||
| mode - |
| Режим порта уровня 2. | |
| native_vlan - | Если 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 или адрес для подключения к удалённому устройству через указанный транспорт. Значение 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 - добавлен в 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 - |
| Управление состоянием ресурса. | |
| trunk_allowed_vlans - добавлен в 2.2 | если mode=trunk, это единственные VLAN, которые будут настроены на trunk, например "2-10,15". | ||
| trunk_vlans - | Если mode=trunk, используется диапазон VLAN для ДОБАВЛЕНИЯ или УДАЛЕНИЯ из trunk.псевдонимы: trunk_add_vlans | ||
Примечания
Примечание
- Тестировано на NXOSv 7.3.(0)D1(1) на VIRL
- Когда
state=absent, VLANы могут быть добавлены/удалены из trunk и существующий VLAN доступа может быть «сброшен» на VLAN 1 на этом интерфейсе. - При работе с VLANs trunk ключевые слова add/remove всегда отправляются в команде
switchport trunk allowed vlan. Используйте режим verbose, чтобы увидеть отправленные команды. - Когда
state=unconfigured, интерфейс будет иметь интерфейс уровня 2 по умолчанию, т.е. vlan 1 в режиме access. - Дополнительная информация об использовании CLI и NX-API в руководстве NXOS Platform Options
- Дополнительная информация об использовании Ansible для управления сетевыми устройствами в руководстве Ansible Network Guide
- Дополнительная информация об использовании Ansible для управления устройствами Cisco на странице интеграции Cisco.
Примеры
- name: Ensure Eth1/5 is in its default switchport state
nxos_switchport:
interface: eth1/5
state: unconfigured
- name: Ensure Eth1/5 is configured for access vlan 20
nxos_switchport:
interface: eth1/5
mode: access
access_vlan: 20
- name: Ensure Eth1/5 only has vlans 5-10 as trunk vlans
nxos_switchport:
interface: eth1/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_switchport:
interface: eth1/5
mode: trunk
native_vlan: 10
trunk_vlans: 2-50
- name: Ensure these VLANs are not being tagged on the trunk
nxos_switchport:
interface: eth1/5
mode: trunk
trunk_vlans: 51-4094
state: absent
Значения возврата
Общие значения возвращаемых данных описаны здесь, ниже приведены поля, уникальные для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| commands список | всегда | строка команды, отправленная на устройство Пример: ['interface eth1/5', 'switchport access vlan 20'] |
Состояние
- Этот модуль будет удален в версии 2.9. [устаревший]
- Для получения дополнительной информации см. УСТАРЕВШИЙ.
Авторы
- Jason Edelman (@jedelman8)
Подсказка
Если вы заметили какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 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_switchport_module.html