cisco.ios.ios_l3_interface – (устаревший, удален после 2022-06-01) Управление интерфейсами уровня 3 на устройствах сети Cisco IOS.
Примечание
Этот плагин входит в коллекцию cisco.ios (версия 1.2.1).
Для его установки используйте: ansible-galaxy collection install cisco.ios.
Чтобы использовать его в книге задач, укажите: cisco.ios.ios_l3_interface.
Новое в версии 1.0.0: из cisco.ios
УСТАРЕВШЕ
- Удалено в
-
главной версии после 2022-06-01
- Почему
-
Выпущены более новые и обновленные модули с большей функциональностью в Ansible 2.9
- Альтернатива
-
ios_l3_interfaces
Краткое описание
- Этот модуль предоставляет декларативное управление интерфейсами уровня 3 на устройствах IOS.
Примечание
У этого модуля есть соответствующий плагин действий.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| aggregate список / элементы=словарь | Список определений интерфейсов уровня 3. Каждый элемент в списке aggregate должен определять имя интерфейса name и необязательный ipv4 или ipv6 адрес. | ||
| ipv4 строка | IPv4-адрес, который необходимо установить для интерфейса уровня 3, указанного в параметре name. Формат адреса <ipv4-адрес>/<маска>, маска — число в диапазоне от 0 до 32, например, 192.168.0.1/24 | ||
| ipv6 строка | IPv6-адрес, который необходимо установить для интерфейса уровня 3, указанного в параметре name. Формат адреса <ipv6-адрес>/<маска>, маска — число в диапазоне от 0 до 128, например, fd5d:12c9:2201:1::1/64 | ||
| name строка / обязательно | Имя интерфейса уровня 3, который необходимо настроить, например, GigabitEthernet0/2 | ||
| state строка |
| Состояние конфигурации интерфейса уровня 3. Указывает, должна ли конфигурация присутствовать или отсутствовать на удалённом устройстве. | |
| ipv4 строка | IPv4-адрес, который необходимо установить для интерфейса уровня 3, указанного в параметре name. Формат адреса <ipv4-адрес>/<маска>, маска — число в диапазоне от 0 до 32, например, 192.168.0.1/24 | ||
| ipv6 строка | IPv6-адрес, который необходимо установить для интерфейса уровня 3, указанного в параметре name. Формат адреса <ipv6-адрес>/<маска>, маска — число в диапазоне от 0 до 128, например, fd5d:12c9:2201:1::1/64 | ||
| name строка | Имя интерфейса уровня 3, который необходимо настроить, например, GigabitEthernet0/2 | ||
| provider словарь | Устаревший Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli. Для получения дополнительной информации см. руководство IOS Platform Options. Объект словаря, содержащий данные подключения. | ||
| auth_pass строка | Указывает пароль для входа в привилегированный режим на удалённом устройстве, если это требуется. Если authorize — false, этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTH_PASS. | ||
| authorize логическое значение |
| Указывает модулю войти в привилегированный режим на удалённом устройстве перед отправкой команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTHORIZE. | |
| host строка | Указывает имя хоста DNS или адрес для подключения к удалённому устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта. | ||
| password строка | Указывает пароль для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации SSH-сессии. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_PASSWORD. | ||
| port целое число | Указывает порт для создания подключения к удалённому устройству. | ||
| ssh_keyfile путь | Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Это значение — путь к ключу, используемому для аутентификации SSH-сессии. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_SSH_KEYFILE. | ||
| timeout целое число | Указывает тайм-аут в секундах для связи с сетевым устройством при подключении или отправке команд. Если тайм-аут превышен до завершения операции, модуль выдаст ошибку. | ||
| username строка | Назначает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации SSH-сессии. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_USERNAME. | ||
| state строка |
| Состояние конфигурации интерфейса уровня 3. Указывает, должна ли конфигурация присутствовать или отсутствовать на удалённом устройстве. | |
Примечания
Примечание
- Проверено на IOS 15.2
- Для получения дополнительной информации об использовании Ansible для управления сетевыми устройствами см. Руководство Ansible по сетям
- Для получения дополнительной информации об использовании Ansible для управления устройствами Cisco см. страницу интеграции Cisco.
Примеры
- name: Remove GigabitEthernet0/3 IPv4 and IPv6 address
cisco.ios.ios_l3_interface:
name: GigabitEthernet0/3
state: absent
- name: Set GigabitEthernet0/3 IPv4 address
cisco.ios.ios_l3_interface:
name: GigabitEthernet0/3
ipv4: 192.168.0.1/24
- name: Set GigabitEthernet0/3 IPv6 address
cisco.ios.ios_l3_interface:
name: GigabitEthernet0/3
ipv6: fd5d:12c9:2201:1::1/64
- name: Set GigabitEthernet0/3 in dhcp
cisco.ios.ios_l3_interface:
name: GigabitEthernet0/3
ipv4: dhcp
ipv6: dhcp
- name: Set interface Vlan1 (SVI) IPv4 address
cisco.ios.ios_l3_interface:
name: Vlan1
ipv4: 192.168.0.5/24
- name: Set IP addresses on aggregate
cisco.ios.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
cisco.ios.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'] |
Статус
- Этот модуль будет удалён в основной версии после 2022-06-01. [устаревший]
- Для получения более подробной информации см. УСТАРЕВШЕ.
Авторы
- 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.10/collections/cisco/ios/ios_l3_interface_module.html