cisco.ios.ios_linkagg – Управление группами агрегирования каналов на устройствах сети Cisco IOS

Примечание

Этот плагин входит в состав коллекции cisco.ios (версия 1.2.1).

Для его установки используйте: ansible-galaxy collection install cisco.ios.

Для использования в книге задач укажите: cisco.ios.ios_linkagg.

В версии 1.0.0: из cisco.ios

Обзор
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

Этот модуль обеспечивает декларативное управление группами агрегирования каналов на устройствах сети Cisco IOS.

Примечание

У этого модуля есть соответствующий плагин действия.

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
aggregate список / элементы=словарь			Список определений агрегирования каналов.
	group строка / обязательно		Номер группы каналов для группы агрегирования каналов port-channel. Диапазон от 1 до 255.
	members список / элементы=строка		Список членов группы агрегирования каналов.
	mode строка	Варианты: active on passive auto desirable	Режим работы группы агрегирования каналов. Режим On необходимо указывать как 'on', иначе pyyaml преобразует его в True до попадания в Ansible.
	state строка	Варианты: present absent	Состояние группы агрегирования каналов.
group целое число			Номер группы каналов для группы агрегирования каналов port-channel. Диапазон от 1 до 255.
members список / элементы=строка			Список членов группы агрегирования каналов.
mode строка		Варианты: active on passive auto desirable	Режим работы группы агрегирования каналов. Режим On необходимо указывать как 'on', иначе pyyaml преобразует его в True до попадания в Ansible.
provider словарь			Устарело Начиная с Ansible 2.5, рекомендуется использовать `connection: network_cli`. Для получения дополнительной информации см. руководство IOS Platform Options. Объект словаря, содержащий сведения о подключении.
	auth_pass строка		Указывает пароль для использования при входе в привилегированный режим на удалённом устройстве. Если authorize ложно, этот аргумент ничего не делает. Если значение не указано в задаче, вместо него используется значение переменной среды `ANSIBLE_NET_AUTH_PASS`.
	authorize булево	Варианты: нет ← да	Указывает модулю войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, вместо него используется значение переменной среды `ANSIBLE_NET_AUTHORIZE`.
	host строка		Указывает имя хоста DNS или адрес для подключения к удалённому устройству через указанный транспорт. Значение хоста используется в качестве адреса назначения для транспорта.
	password строка		Указывает пароль для проверки подлинности подключения к удалённому устройству. Это значение используется для проверки подлинности сессии SSH. Если значение не указано в задаче, вместо него используется значение переменной среды `ANSIBLE_NET_PASSWORD`.
	port целое число		Указывает порт для создания подключения к удалённому устройству.
	ssh_keyfile путь		Указывает SSH-ключ для проверки подлинности подключения к удалённому устройству. Это значение — путь к ключу, используемому для проверки подлинности сессии SSH. Если значение не указано в задаче, вместо него используется значение переменной среды `ANSIBLE_NET_SSH_KEYFILE`.
	timeout целое число		Указывает время ожидания в секундах для связи с сетевым устройством при подключении или отправке команд. Если время ожидания превышено до завершения операции, модуль выдаст ошибку.
	username строка		Устанавливает имя пользователя для проверки подлинности подключения к удалённому устройству. Это значение используется для проверки подлинности сессии SSH. Если значение не указано в задаче, вместо него используется значение переменной среды `ANSIBLE_NET_USERNAME`.
purge булево		Варианты: нет ← да	Очистить ссылки, не определённые в параметре aggregate.
state строка		Варианты: present ← absent	Состояние группы агрегирования каналов.

Примечания

Примечание

Проверено на IOS 15.2
Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в руководстве Ansible по сетям
Дополнительную информацию об использовании Ansible для управления устройствами Cisco см. на странице интеграции Cisco.

Примеры

- name: create link aggregation group
  cisco.ios.ios_linkagg:
    group: 10
    state: present

- name: delete link aggregation group
  cisco.ios.ios_linkagg:
    group: 10
    state: absent

- name: set link aggregation group to members
  cisco.ios.ios_linkagg:
    group: 200
    mode: active
    members:
    - GigabitEthernet0/0
    - GigabitEthernet0/1

- name: remove link aggregation group from GigabitEthernet0/0
  cisco.ios.ios_linkagg:
    group: 200
    mode: active
    members:
    - GigabitEthernet0/1

- name: Create aggregate of linkagg definitions
  cisco.ios.ios_linkagg:
    aggregate:
    - {group: 3, mode: on, members: [GigabitEthernet0/1]}
    - {group: 100, mode: passive, members: [GigabitEthernet0/2]}

Возвращаемые значения

Общие возвращаемые значения описаны здесь, следующие — поля, уникальные для данного модуля:

Ключ	Возвращаемое значение	Описание
commands список / элементы=строка	всегда, за исключением платформ, использующих транспорт Netconf для управления устройством.	Список команд режима конфигурации для отправки устройству Пример: ['interface port-channel 30', 'interface GigabitEthernet0/3', 'channel-group 30 mode on', 'no interface port-channel 30']

Авторы

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.10/collections/cisco/ios/ios_linkagg_module.html