cisco.nxos.nxos_linkagg – (устаревший, удалён после 2022-06-01) Управление группами агрегирования каналов на устройствах Cisco NXOS.
Примечание
Этот плагин входит в коллекцию cisco.nxos (версия 1.4.0).
Для его установки используйте: ansible-galaxy collection install cisco.nxos.
Для использования в плейбуке укажите: cisco.nxos.nxos_linkagg.
Новое в версии 1.0.0: cisco.nxos
УСТАРЕВШИЙ
- Удалён в
-
главной версии после 2022-06-01
- Почему
-
Обновлённые модули выпущены с большей функциональностью.
- Альтернатива
-
nxos_lag_interfaces
Описание
- Этот модуль обеспечивает декларативное управление группами агрегирования каналов на устройствах Cisco NXOS.
Примечание
Этот модуль имеет соответствующий плагин действия.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| aggregate список / элементы=словарь | Список определений агрегирования каналов. | ||
| force логическое значение |
| Если true, то члены группы агрегирования каналов будут принудительно соответствовать объявленным в параметре members. Это может использоваться для удаления членов. | |
| group строка / обязательный | Номер канала-группы для группы агрегирования каналов port-channel. | ||
| members список / элементы=строка | Список интерфейсов, которые будут управляться в группе агрегирования каналов. | ||
| min_links целое число | Минимальное количество подключенных портов, требуемых для включения группы агрегирования каналов. | ||
| mode строка |
| Режим для группы агрегирования каналов. | |
| state строка |
| Состояние группы агрегирования каналов. | |
| force логическое значение |
| Если true, то члены группы агрегирования каналов будут принудительно соответствовать объявленным в параметре members. Это может использоваться для удаления членов. | |
| group строка | Номер канала-группы для группы агрегирования каналов port-channel. | ||
| members список / элементы=строка | Список интерфейсов, которые будут управляться в группе агрегирования каналов. | ||
| min_links целое число | Минимальное количество подключенных портов, требуемых для включения группы агрегирования каналов. | ||
| mode строка |
| Режим для группы агрегирования каналов. | |
| provider словарь | Устаревший Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli. Начиная с Ansible 2.6, рекомендуется использовать connection: httpapi для NX-API. Этот параметр будет удалён в версии после 2022-06-01. Для получения дополнительной информации, пожалуйста, ознакомьтесь с руководством NXOS Platform Options. Объект словаря, содержащий данные подключения. | ||
| auth_pass строка | Указывает пароль для использования при входе в привилегированный режим на удалённом устройстве. Если authorize равно false, этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTH_PASS. | ||
| authorize логическое значение |
| Инструктирует модуль войти в привилегированный режим на удалённом устройстве перед отправкой команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTHORIZE. | |
| host строка | Указывает имя хоста DNS или адрес для подключения к удалённому устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта. | ||
| password строка | Указывает пароль для аутентификации подключения к удалённому устройству. Это общий аргумент, используемый для транспортов cli или nxapi. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_PASSWORD. | ||
| port целое число | Указывает порт для построения подключения к удалённому устройству. Это значение относится к транспорту cli или nxapi. Значение порта по умолчанию будет соответствовать обычному порту транспорта, если он не предоставлен в задаче (cli=22, http=80, https=443). | ||
| ssh_keyfile строка | Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Этот аргумент используется только для транспорта cli. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_SSH_KEYFILE. | ||
| timeout целое число | Указывает таймаут в секундах для связи с сетевым устройством для подключения или отправки команд. Если таймаут превышен до завершения операции, модуль выдаст ошибку. NX-API может медленно возвращать результаты при длительных командах (sh mac, sh bgp и т.д.). | ||
| transport строка |
| Настраивает транспортное подключение для использования при подключении к удалённому устройству. Аргумент transport поддерживает подключение к устройству через cli (ssh) или nxapi. | |
| use_proxy логическое значение |
| Если no, переменные окружения http_proxy и https_proxy будут проигнорированы. | |
| use_ssl логическое значение |
| Настраивает transport для использования SSL, если установлено yes, только когда transport=nxapi, в противном случае это значение игнорируется. | |
| username строка | Настраивает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации входа в CLI или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_USERNAME. | ||
| validate_certs логическое значение |
| Если no, сертификаты SSL не будут проверены. Это следует использовать только на сайтах, контролируемых лично, использующих самозаверенные сертификаты. Если аргумент transport не nxapi, это значение игнорируется. | |
| purge логическое значение |
| Удаляет ссылки, не определённые в параметре aggregate. | |
| state строка |
| Состояние группы агрегирования каналов. | |
Примечания
Примечание
- Проверено на NXOSv 7.0(3)I5(1).
-
state=absentудаляет конфигурацию portchannel и интерфейс, если они уже существуют. Если члены, которые нужно удалить, не указаны явно, удаляются все существующие члены (если таковые имеются). - Члены должны быть списком.
- LACP необходимо сначала включить, если используются активные/пассивные режимы.
- Дополнительную информацию об использовании CLI и NX-API см. в руководстве NXOS Platform Options.
- Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в руководстве Ansible Network Guide.
- Дополнительную информацию об использовании Ansible для управления устройствами Cisco см. на странице интеграции Cisco.
Примеры
- name: create link aggregation group
cisco.nxos.nxos_linkagg:
group: 99
state: present
- name: delete link aggregation group
cisco.nxos.nxos_linkagg:
group: 99
state: absent
- name: set link aggregation group to members
cisco.nxos.nxos_linkagg:
group: 10
min_links: 3
mode: active
members:
- Ethernet1/2
- Ethernet1/4
- name: remove link aggregation group from Ethernet1/2
cisco.nxos.nxos_linkagg:
group: 10
min_links: 3
mode: active
members:
- Ethernet1/4
- name: Create aggregate of linkagg definitions
cisco.nxos.nxos_linkagg:
aggregate:
- {group: 3}
- {group: 100, min_links: 3}
- name: Remove aggregate of linkagg definitions
cisco.nxos.nxos_linkagg:
aggregate:
- {group: 3}
- {group: 100, min_links: 3}
state: absent
Значения возврата
Общие значения возврата документированы здесь, следующие являются полями, уникальными для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| commands list / elements=string | всегда, за исключением платформ, которые используют транспорт Netconf для управления устройством. | Список команд режима конфигурации для отправки устройству Пример: ['interface port-channel 30', 'lacp min-links 5', 'interface Ethernet2/1', 'channel-group 30 mode active', 'no interface port-channel 30'] |
Статус
- Этот модуль будет удален в основной версии после 2022-06-01. [устаревший]
- Дополнительную информацию см. в УСТАРЕВШЕЕ.
Авторы
- Trishna Guha (@trishnaguha)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/cisco/nxos/nxos_linkagg_module.html