cisco.ios.ios_interface – (deprecated, removed after 2022-06-01) Управление интерфейсом на устройствах сети Cisco IOS
Примечание
Этот плагин является частью коллекции cisco.ios (версия 1.3.0).
Для его установки используйте: ansible-galaxy collection install cisco.ios.
Для использования в playbook, укажите: cisco.ios.ios_interface.
Новое в версии 1.0.0: of cisco.ios
УСТЕРЕГШИЙСЯ
- Удалено в
-
главной версии после 2022-06-01
- Почему
-
Выпущены новые и обновленные модули с большей функциональностью в Ansible 2.9
- Альтернатива
-
ios_interfaces
Обзор
- Этот модуль обеспечивает декларативное управление интерфейсами на устройствах сети Cisco IOS.
Примечание
У этого модуля есть соответствующий плагин действий.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | ||
|---|---|---|---|---|
| aggregate список / элементы=словарь | Список определений интерфейсов. | |||
| delay целое число | Время в секундах ожидания, прежде чем проверять оперативное состояние удаленного устройства. Это ожидание применимо к аргументу оперативного состояния, которые являются state со значениями up/down, tx_rate и rx_rate. | |||
| description строка | Описание интерфейса. | |||
| duplex строка |
| Статус соединения интерфейса | ||
| enabled логический тип |
| Статус соединения интерфейса. | ||
| mtu строка | Максимальный размер передаваемого пакета. | |||
| name строка / обязательно | Имя интерфейса. | |||
| neighbors список / элементы=словарь | Проверка оперативного состояния заданного интерфейса name для соседа CDP/LLDP.Доступны следующие подопции. | |||
| host строка | Хост соседа CDP/LLDP для данного интерфейса name. | |||
| port строка | Порт соседа CDP/LLDP, к которому подключен данный интерфейс name. | |||
| rx_rate строка | Скорость приёма в битах в секунду (бит/с). Этот параметр предназначен только для проверки состояния. Поддерживает условные операторы, см. Условные операторы в сетевых модулях
| |||
| speed строка | Скорость соединения интерфейса. | |||
| state строка |
| Состояние конфигурации интерфейса, up означает присутствие и оперативную активность, а down означает присутствие и оперативное состояние down.
| ||
| tx_rate строка | Скорость передачи в битах в секунду (бит/с). Этот параметр предназначен только для проверки состояния. Поддерживает условные операторы, см. Условные операторы в сетевых модулях
| |||
| delay целое число | По умолчанию: 10 | Время в секундах ожидания, прежде чем проверять оперативное состояние удалённого устройства. Это ожидание применимо к аргументу оперативного состояния, которые являются state со значениями up/down, tx_rate и rx_rate. | ||
| description строка | Описание интерфейса. | |||
| duplex строка |
| Статус соединения интерфейса | ||
| enabled логический тип |
| Статус соединения интерфейса. | ||
| mtu строка | Максимальный размер передаваемого пакета. | |||
| name строка | Имя интерфейса. | |||
| neighbors список / элементы=словарь | Проверка оперативного состояния заданного интерфейса name для соседа CDP/LLDP.Доступны следующие подопции. | |||
| host строка | Хост соседа CDP/LLDP для данного интерфейса name. | |||
| port строка | Порт соседа CDP/LLDP, к которому подключен данный интерфейс name. | |||
| provider словарь | Устаревший Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli. Для получения дополнительной информации см. руководство IOS Platform Options. Объект словаря, содержащий сведения о подключении. | |||
| auth_pass строка | Указывает пароль для использования при необходимости входа в привилегированный режим на удалённом устройстве. Если authorize равно false, этот аргумент не действует. Если значение не указано в задаче, вместо него будет использовано значение переменной среды ANSIBLE_NET_AUTH_PASS. | |||
| authorize логический тип |
| Инструктирует модуль войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, вместо него будет использовано значение переменной среды ANSIBLE_NET_AUTHORIZE. | ||
| host строка | Указывает имя хоста DNS или адрес для подключения к удалённому устройству через указанный транспорт. Значение хоста используется в качестве адреса назначения для транспорта. | |||
| password строка | Указывает пароль для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, вместо него будет использовано значение переменной среды ANSIBLE_NET_PASSWORD. | |||
| port целое число | Указывает порт для создания подключения к удалённому устройству. | |||
| ssh_keyfile путь | Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Это значение — путь к ключу, используемому для аутентификации сеанса SSH. Если значение не указано в задаче, вместо него будет использовано значение переменной среды ANSIBLE_NET_SSH_KEYFILE. | |||
| timeout целое число | Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истекает до завершения операции, модуль вернёт ошибку. | |||
| username строка | Устанавливает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, вместо него будет использовано значение переменной среды ANSIBLE_NET_USERNAME. | |||
| rx_rate строка | Скорость приёма в битах в секунду (бит/с). Этот параметр предназначен только для проверки состояния. Поддерживает условные операторы, см. Условные операторы в сетевых модулях
| |||
| speed строка | Скорость соединения интерфейса. | |||
| state строка |
| Состояние конфигурации интерфейса, up означает присутствие и оперативную активность, а down означает присутствие и оперативное состояние down.
| ||
| tx_rate строка | Скорость передачи в битах в секунду (бит/с). Этот параметр предназначен только для проверки состояния. Поддерживает условные операторы, см. Условные операторы в сетевых модулях
| |||
Примечания
Примечание
- Проверено на IOS 15.6
- Для получения дополнительной информации об использовании Ansible для управления сетевыми устройствами см. Руководство по Ansible для сетей
- Для получения дополнительной информации об использовании Ansible для управления устройствами Cisco см. страницу интеграции Cisco.
Примеры
- name: configure interface
cisco.ios.ios_interface:
name: GigabitEthernet0/2
description: test-interface
speed: 100
duplex: half
mtu: 512
- name: remove interface
cisco.ios.ios_interface:
name: Loopback9
state: absent
- name: make interface up
cisco.ios.ios_interface:
name: GigabitEthernet0/2
enabled: true
- name: make interface down
cisco.ios.ios_interface:
name: GigabitEthernet0/2
enabled: false
- name: Check intent arguments
cisco.ios.ios_interface:
name: GigabitEthernet0/2
state: up
tx_rate: ge(0)
rx_rate: le(0)
- name: Check neighbors intent arguments
cisco.ios.ios_interface:
name: Gi0/0
neighbors:
- port: eth0
host: netdev
- name: Config + intent
cisco.ios.ios_interface:
name: GigabitEthernet0/2
enabled: false
state: down
- name: Add interface using aggregate
cisco.ios.ios_interface:
aggregate:
- {name: GigabitEthernet0/1, mtu: 256, description: test-interface-1}
- {name: GigabitEthernet0/2, mtu: 516, description: test-interface-2}
duplex: full
speed: 100
state: present
- name: Delete interface using aggregate
cisco.ios.ios_interface:
aggregate:
- name: Loopback9
- name: Loopback10
state: absent
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| команды список / элементы=строка | всегда, за исключением платформ, которые используют транспорт Netconf для управления устройством. | Список команд режима конфигурации, которые необходимо отправить устройству. Пример: ['interface GigabitEthernet0/2', 'description test-interface', 'duplex half', 'mtu 512'] |
Статус
- Этот модуль будет удален в крупном релизе после 2022-06-01. [устаревший]
- Для получения дополнительной информации см. УСТАРЕВШИЙ.
Авторы
- Ganesh Nalawade (@ganeshrn)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/cisco/ios/ios_interface_module.html