ios_interface – Управление интерфейсами на устройствах Cisco IOS
Новая в версии 2.4.
Описание
- Этот модуль обеспечивает декларативное управление интерфейсами на устройствах Cisco IOS.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| aggregate - | Список определений интерфейсов. | ||
| auth_pass - | Устарело Начиная с Ansible 2.5 рекомендуется использовать connection: network_cli и become: yes с become_pass. Для получения дополнительной информации см. руководство IOS Platform Options. Указывает пароль для входа в привилегированный режим на удаленном устройстве. Если authorize равно false, то этот аргумент не имеет действия. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTH_PASS. | ||
| authorize boolean |
| Устарело Начиная с Ansible 2.5 рекомендуется использовать connection: network_cli и become: yes. Для получения дополнительной информации см. руководство IOS Platform Options. Инструктирует модуль войти в привилегированный режим на удаленном устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTHORIZE. | |
| 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. Объект dict, содержащий данные подключения. | ||
| auth_pass - | Указывает пароль для входа в привилегированный режим на удаленном устройстве. Если authorize равно false, то этот аргумент не имеет действия. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTH_PASS. | ||
| authorize boolean |
| Инструктирует модуль войти в привилегированный режим на удаленном устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTHORIZE. | |
| host - / обязательно | Указывает имя хоста DNS или адрес для подключения к удаленному устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта. | ||
| password - | Указывает пароль для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации сессии SSH. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_PASSWORD. | ||
| port - | По умолчанию: 22 | Указывает порт для подключения к удаленному устройству. | |
| ssh_keyfile - | Указывает SSH-ключ для аутентификации подключения к удаленному устройству. Это значение — путь к ключу, используемому для аутентификации сессии SSH. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_SSH_KEYFILE. | ||
| timeout - | По умолчанию: 10 | Указывает время ожидания в секундах для связи с сетевым устройством при подключении или отправке команд. Если время ожидания истечет до завершения операции, модуль выдаст ошибку. | |
| 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
ios_interface:
name: GigabitEthernet0/2
description: test-interface
speed: 100
duplex: half
mtu: 512
- name: remove interface
ios_interface:
name: Loopback9
state: absent
- name: make interface up
ios_interface:
name: GigabitEthernet0/2
enabled: True
- name: make interface down
ios_interface:
name: GigabitEthernet0/2
enabled: False
- name: Check intent arguments
ios_interface:
name: GigabitEthernet0/2
state: up
tx_rate: ge(0)
rx_rate: le(0)
- name: Check neighbors intent arguments
ios_interface:
name: Gi0/0
neighbors:
- port: eth0
host: netdev
- name: Config + intent
ios_interface:
name: GigabitEthernet0/2
enabled: False
state: down
- name: Add interface using aggregate
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
ios_interface:
aggregate:
- name: Loopback9
- name: Loopback10
state: absent
Возвращаемые значения
Общие значения возврата документированы здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| commands list | всегда, за исключением платформ, использующих транспорт Netconf для управления устройством. | Список команд режима конфигурации для отправки на устройство. Пример: ['interface GigabitEthernet0/2', 'description test-interface', 'duplex half', 'mtu 512'] |
Статус
- Для этого модуля не гарантируется обратная совместимость интерфейса. [превью]
- Этот модуль поддерживается командой Ansible Network Team. [сеть]
Поддержка Red Hat
Дополнительную информацию о поддержке данного модуля компанией Red Hat можно найти в этой статье базы знаний 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.7/modules/ios_interface_module.html