ios_l2_interface — Управление интерфейсом второго уровня на устройствах Cisco IOS.
Новое в версии 2.5.
Обзор
- Этот модуль предоставляет декларативное управление интерфейсом второго уровня на устройствах Cisco IOS.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| access_vlan | Настройка заданной VLAN в порту доступа. Если mode=access, используется в качестве идентификатора VLAN доступа. | ||
| aggregate | Список определений интерфейсов второго уровня. | ||
| auth_pass | Устаревший Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli и become: yes с become_pass. Для получения дополнительной информации см. Руководство по платформенным параметрам IOS. Указывает пароль для входа в привилегированный режим на удалённом устройстве. Если authorize равно false, этот аргумент не используется. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTH_PASS. | ||
| authorize bool |
| Устаревший Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli и become: yes.Для получения дополнительной информации см. Руководство по платформенным параметрам IOS. Указывает модулю войти в привилегированный режим на удалённом устройстве перед отправкой команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTHORIZE. | |
| mode |
| Режим, в котором должен быть настроен интерфейс. | |
| name обязательно | Полное имя интерфейса без номера логического блока, например, GigabitEthernet0/1. алиасы: interface | ||
| native_vlan | Встроенная VLAN, которая должна быть настроена в порту trunk. Если mode=trunk, используется в качестве идентификатора VLAN встроенной для trunk. | ||
| provider | Устаревший Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli. Для получения дополнительной информации см. Руководство по платформенным параметрам IOS. Объект dict, содержащий данные подключения. | ||
| host обязательно | Указывает имя DNS-хоста или адрес для подключения к удалённому устройству по указанному транспорту. Значение host используется в качестве адреса назначения для транспорта. | ||
| port | По умолчанию: 22 | Указывает порт, который используется при построении соединения с удалённым устройством. | |
| username | Настраивает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации SSH-сессии. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_USERNAME. | ||
| password | Указывает пароль для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации SSH-сессии. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_PASSWORD. | ||
| timeout | По умолчанию: 10 | Указывает тайм-аут в секундах для связи с сетевым устройством при подключении или отправке команд. Если тайм-аут превышен до завершения операции, модуль выдаст ошибку. | |
| ssh_keyfile | Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Это путь к ключу, используемому для аутентификации SSH-сессии. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_SSH_KEYFILE. | ||
| authorize bool |
| Указывает модулю войти в привилегированный режим на удалённом устройстве перед отправкой команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTHORIZE. | |
| auth_pass | Указывает пароль для входа в привилегированный режим на удалённом устройстве. Если authorize равно false, этот аргумент не используется. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTH_PASS. | ||
| 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_l2_interface:
name: GigabitEthernet0/5
state: unconfigured
- name: Ensure GigabitEthernet0/5 is configured for access vlan 20
ios_l2_interface:
name: GigabitEthernet0/5
mode: access
access_vlan: 20
- name: Ensure GigabitEthernet0/5 only has vlans 5-10 as trunk vlans
ios_l2_interface:
name: GigabitEthernet0/5
mode: trunk
native_vlan: 10
trunk_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_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_l2_interface:
name: GigabitEthernet0/5
mode: trunk
trunk_vlans: 51-4094
state: absent
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращённое | Описание |
|---|---|---|
| commands список | всегда, за исключением платформ, которые используют транспорт Netconf для управления устройством. | Список команд конфигурации режима, которые необходимо отправить устройству Пример: ['interface GigabitEthernet0/5', 'switchport access vlan 20'] |
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантированно будет обратной совместимостью.
Техническое сопровождение
Этот модуль помечен как сетевой, что означает, что он поддерживается командой Ansible по сетевым вопросам. Дополнительную информацию см. в разделе по поддержке и обслуживанию модулей.
Список других модулей, которые также поддерживаются командой Ansible по сетевым вопросам, см. здесь.
Поддержка
Дополнительную информацию о поддержке данного модуля Red Hat см. в этой статье базы знаний.
Автор
- Nathaniel Case (@qalthos)
Подсказка
Если вы обнаружите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.6/modules/ios_l2_interface_module.html
