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 bool |
| Устаревший Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli и become: yes. Дополнительную информацию см. в руководстве IOS Platform Options. Указывает модулю войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в обычном режиме. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTHORIZE. | |
| ipv4 | IP-адрес IPv4, который должен быть задан для интерфейса L3, указанного в параметре name. Формат адреса — <ipv4 address>/<mask>, маска — число в диапазоне от 0 до 32, например 192.168.0.1/24. | ||
| ipv6 | IP-адрес IPv6, который должен быть задан для интерфейса L3, указанного в параметре name. Формат адреса — <ipv6 address>/<mask>, маска — число в диапазоне от 0 до 128, например fd5d:12c9:2201:1::1/64. | ||
| name | Имя интерфейса L3, который необходимо настроить, например GigabitEthernet0/2. | ||
| provider | Устаревший Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli. Дополнительную информацию см. в руководстве IOS Platform Options. Объект типа dict, содержащий данные подключения. | ||
| host обязательно | Указывает имя или адрес хоста DNS для подключения к удалённому устройству по указанному каналу. Значение параметра host используется в качестве адреса назначения для канала. | ||
| port | По умолчанию: 22 | Указывает порт для подключения к удалённому устройству. | |
| username | Указывает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_USERNAME. | ||
| password | Указывает пароль для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_PASSWORD. | ||
| timeout | По умолчанию: 10 | Указывает тайм-аут в секундах для связи с устройством сети, либо для подключения, либо для отправки команд. Если тайм-аут истечёт до завершения операции, модуль выдаст ошибку. | |
| ssh_keyfile | Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Это значение — путь к ключу, используемому для аутентификации сеанса SSH. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_SSH_KEYFILE. | ||
| authorize bool |
| Указывает модулю войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в обычном режиме. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTHORIZE. | |
| auth_pass | Указывает пароль для входа в привилегированный режим на удалённом устройстве. Если authorize имеет значение false, этот аргумент не имеет эффекта. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTH_PASS. | ||
| state |
| Состояние конфигурации интерфейса 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'] |
Статус
Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость.
Техническое сопровождение
Этот модуль помечен как сетевой, что означает, что он поддерживается командой Ansible по работе с сетями. См. Поддержка и сопровождение модулей для получения дополнительной информации.
Список других модулей, также поддерживаемых командой Ansible по работе с сетями, см. в данном документе.
Поддержка
Дополнительную информацию о поддержке этого модуля компанией Red Hat см. в этой статье из базы знаний Knowledge Base article
Автор
- 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.6/modules/ios_l3_interface_module.html
