ios_l3_interface – Управление интерфейсами уровня 3 в устройствах Cisco IOS
Новое в версии 2.5.
Обзор
- Этот модуль предоставляет декларативное управление интерфейсами уровня 3 в устройствах IOS.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| aggregate - | Список определений интерфейсов уровня 3. Каждая запись в списке aggregate должна определять имя интерфейса name и необязательный ipv4 или ipv6 адрес. | ||
| auth_pass строка | Устаревший Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli и become: yes с become_pass. Для получения дополнительной информации см. руководство по параметрам платформы IOS IOS Platform Options guide. Указывает пароль для входа в привилегированный режим на удаленном устройстве. Если authorize имеет значение false, этот аргумент не имеет эффекта. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTH_PASS. | ||
| authorize логическое |
| Устаревший Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli и become: yes. Для получения дополнительной информации см. руководство по параметрам платформы IOS IOS Platform Options guide. Инструктирует модуль войти в привилегированный режим на удаленном устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTHORIZE. | |
| 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 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 целое число | Значение по умолчанию: 22 | Указывает порт для подключения к удаленному устройству. | |
| ssh_keyfile путь | Указывает SSH-ключ для аутентификации подключения к удаленному устройству. Это значение — путь к ключу, используемому для аутентификации сеанса SSH. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_SSH_KEYFILE. | ||
| timeout целое число | Значение по умолчанию: 10 | Указывает тайм-аут в секундах для связи с сетевым устройством при подключении или отправке команд. Если тайм-аут превышен до завершения операции, модуль сообщит об ошибке. | |
| username строка | Указывает имя пользователя для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_USERNAME. | ||
| state - |
| Состояние конфигурации интерфейса уровня 3. Указывает, должна ли конфигурация присутствовать или отсутствовать на удаленном устройстве. | |
Примечания
Примечание
- Проверено на 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 по сетям. [сеть]
Поддержка 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.8/modules/ios_l3_interface_module.html