nxos_switchport - Управляет интерфейсами портов коммутатора уровня 2.
Новая версия 2.1.
Обзор
- Управляет интерфейсами уровня 2
Параметры
| параметр | обязательно | по умолчанию | выбор | комментарии |
|---|---|---|---|---|
| access_vlan | нет | Если mode=access, используется в качестве идентификатора VLAN доступа. | ||
| auth_pass (добавлено в 2.4.4)
| нет | none | Указывает пароль для входа в привилегированный режим на удалённом устройстве, если это требуется. Если authorize имеет значение false, то этот аргумент не действует. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTH_PASS. | |
| authorize (добавлено в 2.4.4)
| нет |
| Указывает модулю войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTHORIZE. | |
| host | да | Указывает имя хоста DNS или адрес для подключения к удалённому устройству по указанному протоколу передачи. Значение host используется в качестве целевого адреса для протокола передачи. | ||
| interface | да | Полное имя интерфейса, например, Ethernet1/1. | ||
| mode | нет |
| Режим порта уровня 2. | |
| native_vlan | нет | Если mode=trunk, используется в качестве идентификатора VLAN по умолчанию для trunk. | ||
| password | нет | Указывает пароль для аутентификации подключения к удалённому устройству. Этот аргумент обычно используется для протоколов передачи cli или nxapi. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_PASSWORD. | ||
| port | нет | 0 (использовать стандартный порт) | Указывает порт для подключения к удалённому устройству. Это значение применимо к протоколам передачи cli или nxapi. Значение порта по умолчанию соответствует соответствующему стандартному порту протокола передачи, если в задаче не указано другое значение. (cli=22, http=80, https=443). | |
| provider | нет | Удобный метод, который позволяет передавать все аргументы nxos как объект словаря. Все ограничения (обязательность, выбор и т. д.) должны быть удовлетворены либо отдельными аргументами, либо значениями в этом словаре. | ||
| ssh_keyfile | нет | Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Этот аргумент используется только для протокола передачи cli. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_SSH_KEYFILE. | ||
| state | нет | present |
| Управляет состоянием ресурса. |
| timeout (добавлено в 2.3)
| нет | 10 | Указывает тайм-аут в секундах для связи с сетевым устройством для подключения или отправки команд. Если тайм-аут превышен до завершения операции, модуль вернёт ошибку. NX-API может медленно отвечать на длительные команды (sh mac, sh bgp и т. д.). | |
| transport | да | cli | Настраивает соединение с помощью протокола передачи для подключения к удалённому устройству. Аргумент transport поддерживает подключение к устройству через cli (ssh) или nxapi. | |
| trunk_allowed_vlans (добавлено в 2.2)
| нет | Если mode=trunk, это единственные VLAN, которые будут настроены на trunk, например, «2-10,15». | ||
| trunk_vlans | нет | Если mode=trunk, используется в качестве диапазона VLAN для добавления или удаления из trunk.псевдонимы: trunk_add_vlans | ||
| use_ssl | нет |
| Настраивает протокол передачи transport на использование SSL, если значение равно true только когда transport=nxapi, в противном случае это значение игнорируется. | |
| username | нет | Настраивает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации входа в CLI или аутентификации nxapi в зависимости от используемого протокола передачи. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_USERNAME. | ||
| validate_certs | нет |
| Если no, сертификаты SSL не будут проверяться. Это следует использовать только на контролируемых вами сайтах с самозаверяющимися сертификатами. Если аргумент transport не равен nxapi, это значение игнорируется. |
Примеры
- 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
Возвращаемые значения
Общие возвращаемые значения описаны здесь Возвращаемые значения, следующие поля уникальны для этого модуля:
| имя | описание | возвращаемое значение | тип | пример |
|---|---|---|---|---|
| команды | строка команды, отправленная устройству | всегда | список | ['interface eth1/5', 'switchport access vlan 20'] |
Примечания
Примечание
- Проверено на NXOSv 7.3.(0)D1(1) на VIRL
- Когда
state=absent, VLAN можно добавлять/удалять из trunk-соединений, а существующий VLAN доступа можно «отключить», чтобы на интерфейсе был только VLAN 1. - При работе с trunk-VLAN ключи add/remove всегда отправляются в команде
switchport trunk allowed vlan. Используйте режим verbose для просмотра отправленных команд. - Когда
state=unconfigured, интерфейс будет иметь интерфейс уровня 2 по умолчанию, т. е. VLAN 1 в режиме доступа.
Статус
Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость.
Информация о техническом обслуживании
Дополнительную информацию о поддержке этого модуля компанией Red Hat см. в knowledge base article<https://access.redhat.com/articles/rhel-top-support-policies>
Для получения помощи в разработке модулей, если вы захотите, ознакомьтесь с Справочной информацией и участием в сообществе, Тестирование Ansible и Разработка модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/nxos_switchport_module.html
