nxos_portchannel — Управление интерфейсами порт-каналов.
Новая версия 2.2.
Описание
- Управление параметрами конфигурации, специфичными для порт-каналов.
Параметры
| параметр | обязателен | значение по умолчанию | возможные значения | комментарии |
|---|---|---|---|---|
| auth_pass (добавлен в 2.4.4)
| нет | нет | Указывает пароль, используемый для входа в привилегированный режим на удаленном устройстве, если это требуется. Если authorize равно false, этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTH_PASS. | |
| authorize (добавлен в 2.4.4)
| нет |
| Инструктирует модуль войти в привилегированный режим на удаленном устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTHORIZE. | |
| force | нет |
| Если true, заставляет членов порт-канала соответствовать объявленным в параметре members. Это можно использовать для удаления членов. | |
| group | да | Номер группы каналов для порт-канала. | ||
| host | да | Указывает имя хоста DNS или адрес для подключения к удаленному устройству по указанному транспорту. Значение параметра host используется в качестве адреса назначения для транспорта. | ||
| members | нет | Список интерфейсов, которые будут управляться в данном порт-канале. | ||
| min_links | нет | Минимальное количество каналов, необходимых для поддержания работоспособности порт-канала. | ||
| mode | нет | True |
| Режим для порт-канала, т.е. включен, активный, пассивный. |
| 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. | |
| use_ssl | нет |
| Настраивает транспорт transport на использование SSL, если значение равно true, только когда transport=nxapi, в противном случае это значение игнорируется. | |
| username | нет | Настраивает имя пользователя для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации входа в CLI или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_USERNAME. | ||
| validate_certs | нет |
| Если no, сертификаты SSL не будут проверены. Это следует использовать только на контролируемых сайтах с использованием самозаверяющих сертификатов. Если аргумент transport не является nxapi, это значение игнорируется. |
Примеры
# Ensure port-channel99 is created, add two members, and set to mode on
- nxos_portchannel:
group: 99
members: ['Ethernet1/1','Ethernet1/2']
mode: 'active'
state: present
Возвращаемые значения
Общие возвращаемые значения описаны здесь Возвращаемые значения, следующие поля уникальны для данного модуля:
| имя | описание | возвращается | тип | пример |
|---|---|---|---|---|
| commands | команда, отправленная устройству | всегда | список | ['interface Ethernet2/6', 'no channel-group 12', 'interface Ethernet2/5', 'no channel-group 12', 'interface Ethernet2/6', 'channel-group 12 mode on', 'interface Ethernet2/5', 'channel-group 12 mode on'] |
Примечания
Примечание
- Проверено на NXOSv 7.3.(0)D1(1) на VIRL
-
state=absentудаляет конфигурацию порт-канала и интерфейс, если он уже существует. Если члены, которые нужно удалить, не указаны явно, удаляются все существующие члены (если таковые имеются). - Члены должны быть списком.
- LACP необходимо сначала включить, если используются режимы активный/пассивный.
Статус
Этот модуль помечен как предварительный просмотр, что означает, что его интерфейс не гарантированно будет обратной совместимостью.
Информация о техническом обслуживании
Дополнительную информацию о поддержке этого модуля компанией 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_portchannel_module.html
