ios_l3_interface - Управление интерфейсами L3 на устройствах Cisco IOS.
Новое в версии 2.5.
Обзор
- Этот модуль обеспечивает декларативное управление интерфейсами L3 на устройствах IOS.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| aggregate | Список определений интерфейсов L3. Каждый элемент в списке aggregate должен определять имя интерфейса name и необязательный ipv4 или ipv6 адрес. | ||
| auth_pass | По умолчанию: нет | Устаревший Начиная с 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. | |
| ipv4 | IP-адрес IPv4, который необходимо установить для интерфейса L3, указанного в параметре name. Формат адреса <ip-адрес IPv4>/<маска>, маска — число в диапазоне 0-32, например, 192.168.0.1/24. | ||
| ipv6 | IP-адрес IPv6, который необходимо установить для интерфейса L3, указанного в параметре name. Формат адреса <ip-адрес IPv6>/<маска>, маска — число в диапазоне 0-128, например, fd5d:12c9:2201:1::1/64. | ||
| name | Имя интерфейса L3 для настройки, например, GigabitEthernet0/2. | ||
| 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 имеет значение false, то этот аргумент не имеет действия. Если значение не указано в задаче, то будет использовано значение переменной окружения ANSIBLE_NET_AUTH_PASS. | |
| host обязательно | Указывает имя хоста DNS или адрес для подключения к удалённому устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта. | ||
| timeout | По умолчанию: 10 | Указывает таймаут в секундах для связи с сетевым устройством для подключения или отправки команд. Если таймаут истекает до завершения операции, модуль вернёт ошибку. | |
| password | По умолчанию: Нет | Указывает пароль для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации сессии SSH. Если значение не указано в задаче, то будет использовано значение переменной окружения ANSIBLE_NET_PASSWORD. | |
| порт | По умолчанию: 22 | Указывает порт, используемый при установлении соединения с удалённым устройством. | |
| состояние |
| Состояние конфигурации интерфейса L3. Указывает, должна ли конфигурация присутствовать или отсутствовать на удалённом устройстве. | |
Примечания
Примечание
- Проверено на IOS 15.2
- Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в Руководстве по сети Ansible
- Дополнительную информацию об использовании Ansible для управления устройствами Cisco см. на странице интеграции Cisco.
Примеры
- name: Remove GigabitEthernet0/3 IPv4 and IPv6 address
ios_l3_interface:
name: GigabitEthernet0/3
state: absent
- name: Set GigabitEthernet0/3 IPv4 address
ios_l3_interface:
name: GigabitEthernet0/3
ipv4: 192.168.0.1/24
- name: Set GigabitEthernet0/3 IPv6 address
ios_l3_interface:
name: GigabitEthernet0/3
ipv6: "fd5d:12c9:2201:1::1/64"
- name: Set GigabitEthernet0/3 in dhcp
ios_l3_interface:
name: GigabitEthernet0/3
ipv4: dhcp
ipv6: dhcp
- name: Set interface Vlan1 (SVI) IPv4 address
ios_l3_interface:
name: Vlan1
ipv4: 192.168.0.5/24
- name: Set IP addresses on aggregate
ios_l3_interface:
aggregate:
- { name: GigabitEthernet0/3, ipv4: 192.168.2.10/24 }
- { name: GigabitEthernet0/3, ipv4: 192.168.3.10/24, ipv6: "fd5d:12c9:2201:1::1/64" }
- name: Remove IP addresses on aggregate
ios_l3_interface:
aggregate:
- { name: GigabitEthernet0/3, ipv4: 192.168.2.10/24 }
- { name: GigabitEthernet0/3, ipv4: 192.168.3.10/24, ipv6: "fd5d:12c9:2201:1::1/64" }
state: absent
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие — поля, уникальные для данного модуля:
| Ключ | Возвращённое значение | Описание |
|---|---|---|
| commands список | всегда, за исключением платформ, использующих транспорт Netconf для управления устройством. | Список команд режима конфигурации для отправки на устройство Пример: ['interface GigabitEthernet0/2', 'ip address 192.168.0.1 255.255.255.0', 'ipv6 address fd5d:12c9:2201:1::1/64'] |
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется как обратной совместимости.
Поддержка
Дополнительную информацию о поддержке данного модуля Red Hat см. в этой статье базы знаний
Автор
- Ganesh Nalawade (@ganeshrn)
Подсказка
Если вы заметите какие-либо проблемы в этом документе, вы можете отредактировать этот документ, чтобы улучшить его.
© 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_l3_interface_module.html