ios_l2_interface – Управление интерфейсами второго уровня на устройствах Cisco IOS
Новая в версии 2.5.
УСТАРЕВШЕЕ
| Удалено в Ansible: | |
|---|---|
| версия: 2.13 | |
| Почему: | Выпущены новые и обновленные модули с большей функциональностью в Ansible 2.9 |
| Альтернатива: | ios_l2_interfaces |
Описание
- Этот модуль предоставляет декларативное управление интерфейсами второго уровня на устройствах Cisco IOS.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| access_vlan - | Настроить заданную VLAN в порту доступа. Если mode=access, используется идентификатор VLAN доступа. | ||
| aggregate - | Список определений интерфейсов второго уровня. | ||
| auth_pass строка | Устаревший Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli и become: yes с become_pass. Дополнительная информация в руководстве по параметрам платформы IOS IOS Platform Options guide. Указывает пароль для входа в привилегированный режим на удаленном устройстве. Если authorize ложно, этот аргумент не имеет значения. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTH_PASS. | ||
| authorize булево |
| Устаревший Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli и become: yes. Дополнительная информация в руководстве по параметрам платформы IOS IOS Platform Options guide. Указывает модулю войти в привилегированный режим на удаленном устройстве перед выполнением команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTHORIZE. | |
| mode - |
| Режим настройки интерфейса. | |
| name - / обязательно | Полное имя интерфейса без номера логического блока, например, GigabitEthernet0/1. псевдонимы: интерфейс | ||
| native_vlan - | VLAN по умолчанию для порта trunk. Если mode=trunk, используется идентификатор VLAN по умолчанию для порта trunk. | ||
| provider словарь | Устаревший Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli. Дополнительная информация в руководстве по параметрам платформы IOS IOS Platform Options guide. Объект словаря, содержащий данные подключения. | ||
| auth_pass строка | Указывает пароль для входа в привилегированный режим на удаленном устройстве. Если authorize ложно, этот аргумент не имеет значения. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTH_PASS. | ||
| authorize булево |
| Указывает модулю войти в привилегированный режим на удаленном устройстве перед выполнением команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTHORIZE. | |
| host строка / обязательно | Указывает имя хоста DNS или адрес для подключения к удаленному устройству по указанному транспорту. Значение хоста используется как адрес назначения для транспорта. | ||
| password строка | Указывает пароль для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_PASSWORD. | ||
| port целое число | По умолчанию: 22 | Указывает порт для подключения к удаленному устройству. | |
| ssh_keyfile путь | Указывает SSH-ключ для аутентификации подключения к удаленному устройству. Это путь к ключу, используемому для аутентификации сеанса SSH. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_SSH_KEYFILE. | ||
| timeout целое число | По умолчанию: 10 | Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истекает до завершения операции, модуль вернет ошибку. | |
| 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
- Дополнительная информация об использовании Ansible для управления устройствами Cisco см. на странице интеграции Cisco Cisco integration page.
Примеры
- 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_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_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'] |
Статус
- Этот модуль будет удален в версии 2.13. [устарел]
- Дополнительная информация см. в УСТАРЕВШЕЕ.
Авторы
- 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.9/modules/ios_l2_interface_module.html