cisco.ios.ios_l2_interface – (deprecated, removed after 2022-06-01) Управление интерфейсом второго уровня на устройствах Cisco IOS.
Примечание
Этот плагин входит в коллекцию cisco.ios (версия 1.3.0).
Для его установки используйте: ansible-galaxy collection install cisco.ios
Для использования в книге задач, укажите: cisco.ios.ios_l2_interface
Новое в версии 1.0.0: of cisco.ios
УСТАНОВЛЕН КАК УСТАРЕВШИЙ
- Удален в
-
главной версии после 2022-06-01
- Почему
-
Выпущены новые и обновлённые модули с более функциональностью в Ansible 2.9
- Альтернатива
-
ios_l2_interfaces
Описание
- Этот модуль предоставляет декларативное управление интерфейсами второго уровня на устройствах Cisco IOS.
Примечание
У этого модуля есть соответствующий плагин действий.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| access_vlan строка | Настройка указанной VLAN в порту доступа. Если mode=access, используется как идентификатор VLAN доступа. | ||
| aggregate список / элементы=словарь | Список определений интерфейсов второго уровня. | ||
| access_vlan строка | Настройка указанной VLAN в порту доступа. Если mode=access, используется как идентификатор VLAN доступа. | ||
| mode строка |
| Режим, в котором необходимо настроить интерфейс. | |
| name строка | Полное имя интерфейса без номера логического блока, например, GigabitEthernet0/1. псевдонимы: интерфейс | ||
| native_vlan строка | VLAN по умолчанию для настройки в порту trunk. Если mode=trunk, используется как идентификатор VLAN по умолчанию для trunk. | ||
| state строка |
| Управление состоянием конфигурации интерфейса второго уровня. | |
| trunk_allowed_vlans строка | Список разрешенных VLAN в заданном порту trunk. Если mode=trunk, это единственные VLAN, которые будут настроены на trunk, например, "2-10,15". | ||
| trunk_vlans строка | Список VLAN, которые необходимо настроить в порту trunk. Если mode=trunk, используется диапазон VLAN для ДОБАВЛЕНИЯ или УДАЛЕНИЯ из trunk. | ||
| mode строка |
| Режим, в котором необходимо настроить интерфейс. | |
| name строка | Полное имя интерфейса без номера логического блока, например, GigabitEthernet0/1. псевдонимы: интерфейс | ||
| native_vlan строка | VLAN по умолчанию для настройки в порту trunk. Если mode=trunk, используется как идентификатор VLAN по умолчанию для trunk. | ||
| provider словарь | Устаревший Начиная с Ansible 2.5, рекомендуется использовать connection: network_cliДополнительную информацию можно найти в руководстве IOS Platform Options. Объект словаря, содержащий сведения о подключении. | ||
| auth_pass строка | Указывает пароль для входа в привилегированный режим на удалённом устройстве. Если authorize равно false, этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTH_PASS | ||
| authorize логическое |
| Инструктирует модуль войти в привилегированный режим на удалённом устройстве перед отправкой команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTHORIZE | |
| host строка | Указывает имя хоста DNS или адрес для подключения к удалённому устройству через указанный транспорт. Значение host используется как адрес назначения для транспорта. | ||
| password строка | Указывает пароль для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_PASSWORD | ||
| port целое число | Указывает порт для создания соединения с удалённым устройством. | ||
| ssh_keyfile путь | Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Это значение — путь к ключу, используемому для аутентификации сеанса SSH. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_SSH_KEYFILE | ||
| timeout целое число | Указывает время ожидания в секундах для связи с сетевым устройством для подключения или отправки команд. Если время ожидания истечёт до завершения операции, модуль выдаст ошибку. | ||
| username строка | Настраивает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_USERNAME | ||
| state строка |
| Управление состоянием конфигурации интерфейса второго уровня. | |
| trunk_allowed_vlans строка | Список разрешенных VLAN в заданном порту trunk. Если mode=trunk, это единственные VLAN, которые будут настроены на trunk, например, "2-10,15". | ||
| trunk_vlans строка | Список VLAN, которые необходимо настроить в порту trunk. Если mode=trunk, используется диапазон VLAN для ДОБАВЛЕНИЯ или УДАЛЕНИЯ из trunk. | ||
Примечания
Примечание
- Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в Руководстве по сетям Ansible
- Дополнительную информацию об использовании Ansible для управления устройствами Cisco см. на странице интеграции Cisco.
Примеры
- name: Ensure GigabitEthernet0/5 is in its default l2 interface state
ios.ios_l2_interface:
name: GigabitEthernet0/5
state: unconfigured
- name: Ensure GigabitEthernet0/5 is configured for access vlan 20
ios.ios_l2_interface:
name: GigabitEthernet0/5
mode: access
access_vlan: 20
- name: Ensure GigabitEthernet0/5 only has vlans 5-10 as trunk vlans
ios.ios_l2_interface:
name: GigabitEthernet0/5
mode: trunk
native_vlan: 10
trunk_allowed_vlans: 5-10
- name: Ensure GigabitEthernet0/5 is a trunk port and ensure 2-50 are being tagged
(doesn't mean others aren't also being tagged)
ios.ios_l2_interface:
name: GigabitEthernet0/5
mode: trunk
native_vlan: 10
trunk_vlans: 2-50
- name: Ensure these VLANs are not being tagged on the trunk
ios.ios_l2_interface:
name: GigabitEthernet0/5
mode: trunk
trunk_vlans: 51-4094
state: absent
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| commands список / элементы=строка | всегда, за исключением платформ, которые используют транспорт Netconf для управления устройством. | Список команд конфигурации в режиме конфигурации, которые нужно отправить устройству Пример: ['interface GigabitEthernet0/5', 'switchport access vlan 20'] |
Статус
- Этот модуль будет удалён в основной версии после 2022-06-01. [устарел]
- Дополнительная информация в УСТАНОВЛЕН КАК УСТАРЕВШИЙ.
Авторы
- Nathaniel Case (@Qalthos)
© 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/ios/ios_l2_interface_module.html