nxos_linkagg – Управление группами агрегирования каналов на устройствах Cisco NXOS
Новая в версии 2.5.
Обзор
- Этот модуль обеспечивает декларативное управление группами агрегирования каналов на устройствах Cisco NXOS.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| aggregate - | Список определений агрегирования каналов. | ||
| force boolean |
| Если true, принудительно согласует членов группы агрегирования каналов с объявленными в параметре members. Это может использоваться для удаления членов. | |
| group string / обязательно | Номер канала (channel-group) для группы агрегирования портов (port-channel). | ||
| members - | Список интерфейсов, которые будут управляться в группе агрегирования каналов. | ||
| min_links - | Минимальное количество портов, необходимое для активации группы агрегирования каналов. | ||
| mode - |
| Режим работы группы агрегирования каналов. | |
| provider dictionary | Устарело Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli. Этот параметр нужен только при использовании NX-API. Дополнительную информацию можно найти в руководстве NXOS Platform Options. Объект словаря, содержащий сведения о подключении. | ||
| auth_pass string добавлено в 2.5.3 | Указывает пароль для входа в привилегированный режим на удалённом устройстве. Если authorize ложно, этот аргумент не имеет значения. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTH_PASS. | ||
| authorize boolean добавлено в 2.5.3 |
| Указывает модулю войти в привилегированный режим на удалённом устройстве перед отправкой команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTHORIZE. | |
| host string / обязательно | Указывает имя хоста DNS или адрес для подключения к удалённому устройству через указанный транспорт. Значение параметра host используется в качестве адреса назначения для транспорта. | ||
| password string | Указывает пароль для аутентификации подключения к удалённому устройству. Это общий аргумент, используемый для транспортов cli или nxapi. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_PASSWORD. | ||
| port integer | По умолчанию: "0 (использовать общий порт)" | Указывает порт для подключения к удалённому устройству. Это значение относится к транспорту cli или nxapi. Значение порта по умолчанию соответствует обычному порту для транспорта, если оно не указано в задаче (cli=22, http=80, https=443). | |
| ssh_keyfile string | Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Этот аргумент используется только для транспорта cli. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_SSH_KEYFILE. | ||
| timeout integer добавлено в 2.3 | По умолчанию: 10 | Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут превышен до завершения операции, модуль выдаст ошибку. NX-API может медленно отвечать на длительные команды (sh mac, sh bgp и т. д.). | |
| transport string / обязательно |
| Устанавливает транспортное подключение для соединения с удалённым устройством. Аргумент transport поддерживает подключение к устройству по протоколам cli (ssh) или nxapi. | |
| use_proxy boolean добавлено в 2.5 |
| Если no, переменные окружения http_proxy и https_proxy будут проигнорированы. | |
| use_ssl boolean |
| Устанавливает использование SSL для транспорта transport, если значение равно yes, только когда transport=nxapi, иначе это значение игнорируется. | |
| username string | Указывает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации входа в CLI или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_USERNAME. | ||
| validate_certs boolean |
| Если no, сертификаты SSL не будут проверены. Это следует использовать только на сайтах, контролируемых лично, с самозаверяющими сертификатами. Если транспорт не nxapi, это значение игнорируется. | |
| purge boolean |
| Удаление каналов, не определённых в параметре aggregate. | |
| state - |
| Состояние группы агрегирования каналов. | |
Примечания
Примечание
- Проверено на NXOSv 7.0(3)I5(1).
-
state=absentудаляет конфигурацию portchannel и интерфейс, если она уже существует. Если члены, которые нужно удалить, не указаны явно, удаляются все существующие члены (если таковые есть). - Члены должны быть списком.
- LACP необходимо сначала включить, если используются режимы active/passive.
- Дополнительную информацию об использовании CLI и NX-API см. в руководстве NXOS Platform Options
- Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в руководстве Ansible Network Guide
- Дополнительную информацию об использовании Ansible для управления устройствами Cisco см. на странице интеграции Cisco.
Примеры
- name: create link aggregation group
nxos_linkagg:
group: 99
state: present
- name: delete link aggregation group
nxos_linkagg:
group: 99
state: absent
- name: set link aggregation group to members
nxos_linkagg:
group: 10
min_links: 3
mode: active
members:
- Ethernet1/2
- Ethernet1/4
- name: remove link aggregation group from Ethernet1/2
nxos_linkagg:
group: 10
min_links: 3
mode: active
members:
- Ethernet1/4
- name: Create aggregate of linkagg definitions
nxos_linkagg:
aggregate:
- { group: 3 }
- { group: 100, min_links: 3 }
- name: Remove aggregate of linkagg definitions
nxos_linkagg:
aggregate:
- { group: 3 }
- { group: 100, min_links: 3 }
state: absent
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| commands список | всегда, за исключением платформ, использующих транспорт Netconf для управления устройством. | Список команд режима конфигурации для отправки устройству Пример: ['interface port-channel 30', 'lacp min-links 5', 'interface Ethernet2/1', 'channel-group 30 mode active', 'no interface port-channel 30'] |
Статус
- Данный модуль не гарантирует обратной совместимости интерфейса. [превью]
- Данный модуль поддерживается командой Ansible 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.8/modules/nxos_linkagg_module.html