ios_vlan — Управление VLAN на устройствах сети IOS
Новое в версии 2.5.
Обзор
- Этот модуль предоставляет декларативное управление VLAN на устройствах сети Cisco IOS.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| aggregate | Список определений VLAN. | ||
| associated_interfaces (добавлено в 2.5) | Это параметр намерения и проверяет оперативное состояние для заданного vlan name для ассоциированных интерфейсов. Если значение в associated_interfaces не совпадает с оперативным состоянием интерфейсов vlan на устройстве, произойдет ошибка. | ||
| auth_pass | По умолчанию: none | Устаревшее Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli и become: yes с become_pass. Дополнительную информацию см. в руководстве IOS Platform Options. Указывает пароль, который нужно использовать для входа в привилегированный режим на удаленном устройстве. Если authorize имеет значение false, этот аргумент не действует. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения ANSIBLE_NET_AUTH_PASS. | |
| authorize |
| Устаревшее Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli и become: yes. Дополнительную информацию см. в руководстве IOS Platform Options. Инструктирует модуль войти в привилегированный режим на удаленном устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения ANSIBLE_NET_AUTHORIZE. | |
| delay | По умолчанию: 10 | Задержка, которую задача должна подождать, чтобы проверить значения параметров декларативного намерения. | |
| interfaces обязательно | Список интерфейсов, которые необходимо ассоциировать с VLAN. | ||
| name | Имя VLAN. | ||
| provider | По умолчанию: None | Устаревшее Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli.Дополнительную информацию см. в руководстве IOS Platform Options. Объект словаря, содержащий данные подключения. | |
| username | Настраивает имя пользователя для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения ANSIBLE_NET_USERNAME. | ||
| authorize |
| Инструктирует модуль войти в привилегированный режим на удаленном устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения ANSIBLE_NET_AUTHORIZE. | |
| ssh_keyfile | Указывает SSH-ключ для аутентификации подключения к удаленному устройству. Это значение — путь к ключу, используемому для аутентификации сеанса SSH. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения ANSIBLE_NET_SSH_KEYFILE. | ||
| auth_pass | По умолчанию: none | Указывает пароль, который нужно использовать для входа в привилегированный режим на удаленном устройстве. Если authorize имеет значение false, этот аргумент не действует. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения ANSIBLE_NET_AUTH_PASS. | |
| host обязательно | Указывает имя хоста DNS или адрес для подключения к удаленному устройству через указанный транспорт. Значение host используется в качестве целевого адреса для транспорта. | ||
| timeout | По умолчанию: 10 | Указывает таймаут в секундах для связи с сетевым устройством для подключения или отправки команд. Если таймаут истекает до завершения операции, модуль сообщит об ошибке. | |
| password | По умолчанию: None | Указывает пароль для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения ANSIBLE_NET_PASSWORD. | |
| port | По умолчанию: 22 | Указывает порт, используемый при построении подключения к удаленному устройству. | |
| purge | По умолчанию: no | Очистка VLAN, не определенных в параметре aggregate. | |
| state |
| Состояние конфигурации VLAN. | |
| vlan_id обязательно | Идентификатор VLAN. Диапазон 1-4094. | ||
Примечания
Примечание
- Проверено на IOS 15.2
- Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в Руководстве по сетям Ansible
- Дополнительную информацию об использовании Ansible для управления устройствами Cisco см. на странице интеграции Cisco.
Примеры
- name: Create vlan
ios_vlan:
vlan_id: 100
name: test-vlan
state: present
- name: Add interfaces to VLAN
ios_vlan:
vlan_id: 100
interfaces:
- GigabitEthernet0/0
- GigabitEthernet0/1
- name: Check if interfaces is assigned to VLAN
ios_vlan:
vlan_id: 100
associated_interfaces:
- GigabitEthernet0/0
- GigabitEthernet0/1
- name: Delete vlan
ios_vlan:
vlan_id: 100
state: absent
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| commands список | всегда | Список команд режима конфигурации, которые нужно отправить устройству Пример: ['vlan 100', 'name test-vlan'] |
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантированно будет совместим с предыдущими версиями.
Поддержка
Дополнительную информацию о поддержке этого модуля компанией Red Hat см. в этой статье базы знаний.
Автор
- 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.5/modules/ios_vlan_module.html
