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 Platform Options. Указывает пароль, который необходимо использовать для входа в привилегированный режим на удаленном устройстве. Если authorize имеет значение false, этот параметр не имеет действия. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTH_PASS. | ||
| authorize boolean |
| Устаревший Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli и become: yes. Для получения дополнительной информации см. руководство IOS Platform Options. Инструктирует модуль войти в привилегированный режим на удаленном устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной окружения 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 Platform Options. Объект словаря, содержащий данные соединения. | ||
| 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. | ||
| 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 Network. [сетевой]
Поддержка 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_l3_interface_module.html