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 Platform Options. Указывает пароль, который необходимо использовать для входа в привилегированный режим на удалённом устройстве. Если authorize ложно, этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTH_PASS. | |
| authorize |
| Устарело Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli и become: yes. Для получения дополнительной информации см. руководство IOS Platform Options. Указывает модулю войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTHORIZE. | |
| mode |
| Режим, в котором должен быть настроен интерфейс. | |
| name обязательно | Полное имя интерфейса без номера логического блока, например, GigabitEthernet0/1. псевдонимы: интерфейс | ||
| native_vlan | VLAN по умолчанию, который необходимо настроить в магистральном порте. Если mode=trunk, используется как идентификатор магистральной VLAN по умолчанию. | ||
| provider | По умолчанию: Нет | Устарело Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli. Для получения дополнительной информации см. руководство IOS Platform Options. Объект типа dict, содержащий данные подключения. | |
| username | Настраивает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации сессии SSH. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_USERNAME. | ||
| authorize |
| Указывает модулю войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTHORIZE. | |
| ssh_keyfile | Указывает SSH-ключ, который необходимо использовать для аутентификации подключения к удалённому устройству. Это значение - путь к ключу, используемому для аутентификации сессии SSH. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_SSH_KEYFILE. | ||
| auth_pass | По умолчанию: нет | Указывает пароль, который необходимо использовать для входа в привилегированный режим на удалённом устройстве. Если authorize ложно, этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTH_PASS. | |
| host обязательно | Указывает имя хоста DNS или адрес для подключения к удалённому устройству по указанному транспорту. Значение host используется в качестве целевого адреса для транспорта. | ||
| timeout | По умолчанию: 10 | Указывает время ожидания в секундах для связи с сетевым устройством для подключения или отправки команд. Если время ожидания истечёт до завершения операции, модуль вернёт ошибку. | |
| password | По умолчанию: Нет | Указывает пароль, который необходимо использовать для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации сессии SSH. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_PASSWORD. | |
| port | По умолчанию: 22 | Указывает порт, который нужно использовать при создании подключения к удалённому устройству. | |
| state |
| Управление состоянием конфигурации интерфейса второго уровня. | |
| trunk_allowed_vlans | Список разрешённых VLAN в данном магистральном порте. Если mode=trunk, это единственные VLAN, которые будут настроены на магистрали, например, "2-10,15". | ||
| trunk_vlans | Список VLAN, которые необходимо настроить в магистральном порте. Если mode=trunk, используется диапазон VLAN для ДОБАВЛЕНИЯ или УДАЛЕНИЯ из магистрали. | ||
Примечания
Примечание
- Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в руководстве Ansible Network Guide
- Дополнительную информацию об использовании 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'] |
Статус
Этот модуль помечен как экспериментальный, что означает, что его интерфейс не гарантируется как обратная совместимость.
Поддержка
Дополнительную информацию о поддержке этого модуля компанией 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.5/modules/ios_l2_interface_module.html
