cisco.ios.ios_interface – (deprecated, removed after 2022-06-01) Управление интерфейсами на устройствах Cisco IOS
Примечание
Этот плагин входит в коллекцию cisco.ios (версия 1.2.1).
Для его установки используйте: ansible-galaxy collection install cisco.ios.
Для использования в playbook, укажите: cisco.ios.ios_interface.
Введено в версии 1.0.0: модуля 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 строка | Скорость приема в битах в секунду (bps). Этот параметр используется только для проверки состояния. Поддерживает условные выражения, см. Условные выражения в модулях сети
| |||
| speed строка | Скорость подключения интерфейса. | |||
| state строка |
| Состояние конфигурации интерфейса, up означает присутствие и операционное включение, а down означает присутствие и операционное down
| ||
| tx_rate строка | Скорость передачи в битах в секунду (bps). Этот параметр используется только для проверки состояния. Поддерживает условные выражения, см. Условные выражения в модулях сети
| |||
| 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 IOS Platform Options guide. Объект словаря, содержащий данные соединения. | |||
| 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. | |||
| rx_rate строка | Скорость приема в битах в секунду (bps). Этот параметр используется только для проверки состояния. Поддерживает условные выражения, см. Условные выражения в модулях сети
| |||
| speed строка | Скорость подключения интерфейса. | |||
| state строка |
| Состояние конфигурации интерфейса, up означает наличие и операционное включение, а down означает наличие и операционное down
| ||
| tx_rate строка | Скорость передачи в битах в секунду (bps). Этот параметр используется только для проверки состояния. Поддерживает условные выражения, см. Условные выражения в модулях сети
| |||
Примечания
Примечание
- Проверено на 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
Возвращаемые значения
Общие возвращаемые значения описаны в данном месте, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| commands list / elements=string | всегда, за исключением платформ, использующих транспорт Netconf для управления устройством. | Список команд конфигурационного режима, которые необходимо отправить устройству. Пример: ['interface GigabitEthernet0/2', 'description test-interface', 'duplex half', 'mtu 512'] |
Статус
- Этот модуль будет удален в релизе следующего мажорного релиза после 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_interface_module.html