Модуль cisco.iosxr.iosxr_l3_interfaces – модуль ресурсов для настройки интерфейсов L3.
Примечание
Этот модуль является частью коллекции cisco.iosxr (версия 12.3.1).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в состав ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Чтобы установить её, используйте: ansible-galaxy collection install cisco.iosxr.
Чтобы использовать её в плейбуке, укажите: cisco.iosxr.iosxr_l3_interfaces.
Добавлено в cisco.iosxr 1.0.0
Краткое описание
- Этот модуль обеспечивает декларативное управление интерфейсами уровня 3 на устройствах Cisco IOS-XR.
Примечание
Этому модулю соответствует плагин действий.
Псевдонимы: l3_interfaces
Параметры
Параметр | Комментарии |
|---|---|
config list / elements=dictionary | Словарь параметров интерфейса уровня 3 |
|
carrier_delay dictionary |
Задержка переходов состояния несущей. |
|
down integer |
Задержка события потери несущей в миллисекундах. |
|
up integer |
Задержка события восстановления несущей в миллисекундах. |
|
dampening dictionary |
Включение подавления колебаний состояния интерфейса для уменьшения их влияния. |
|
enabled boolean |
Включение или отключение подавления колебаний. Варианты:
|
|
half_life integer |
Время в минутах, по истечении которого штраф уменьшается вдвое, если интерфейс остаётся в рабочем состоянии. |
|
max_suppress_time integer |
Максимальное время в минутах, в течение которого интерфейс может быть подавлен. |
|
restart_penalty integer |
Штраф, назначаемый интерфейсу при колебаниях его состояния. |
|
reuse_threshold integer |
Значение штрафа, ниже которого подавление интерфейса снимается. |
|
suppress_threshold integer |
Значение штрафа, выше которого интерфейс подавляется. |
|
flow dictionary |
Настройка мониторинга NetFlow на интерфейсе. |
|
ipv4 dictionary |
Настройка мониторинга NetFlow для трафика IPv4. |
|
direction string |
Направление мониторинга потоков. Варианты:
|
|
monitor string |
Имя применяемого монитора потоков. |
|
sampler string |
Имя применяемого семплера. |
|
ipv6 dictionary |
Настройка мониторинга NetFlow для трафика IPv6. |
|
direction string |
Направление мониторинга потоков. Варианты:
|
|
monitor string |
Имя применяемого монитора потоков. |
|
sampler string |
Имя применяемого семплера. |
|
flow_control string |
Настройка управления потоком для интерфейса. Варианты:
|
|
ipv4 list / elements=dictionary |
Адрес IPv4, назначаемый интерфейсу уровня 3, указанному в параметре name. Формат адреса: <адрес ipv4>/<маска>; маска — число в диапазоне 0–32, например 192.168.0.1/24 |
|
address string |
Настраивает адрес IPv4 для интерфейса. |
|
secondary boolean |
Настраивает IP-адрес как дополнительный адрес. Варианты:
|
|
ipv6 list / elements=dictionary |
Адрес IPv6, назначаемый интерфейсу уровня 3, указанному в параметре name. Формат адреса: <адрес ipv6>/<маска>; маска — число в диапазоне 0–128, например fd5d:12c9:2201:1::1/64 |
|
address string |
Настраивает адрес IPv6 для интерфейса. |
|
load_interval integer |
Задаёт интервал времени, за который вычисляется статистика нагрузки. |
|
name string / обязательный |
Полное имя интерфейса без номера логического канала, например GigabitEthernet0/1. |
running_config string | Этот параметр используется только при состоянии parsed. Значением этого параметра должен быть вывод, полученный от устройства IOS-XR при выполнении команды show running-config interface. Состояние parsed считывает конфигурацию из параметра |
state string | Состояние конфигурации после выполнения модуля Варианты:
|
Примечания
Примечание
- Этот модуль работает с подключением
network_cli. См. параметры платформы IOS-XR.
Примеры
# Using merged
# Before state:
# -------------
#
# viosxr#show running-config interface
# interface Loopback888
# !
# interface Loopback999
# !
# interface MgmtEth0/RP0/CPU0/0
# ipv4 address dhcp
# !
# interface preconfigure GigabitEthernet0/0/0/2
# !
# interface preconfigure GigabitEthernet0/0/0/3
# !
- name: Merge provided configuration with device configuration
cisco.iosxr.iosxr_l3_interfaces:
config:
- name: GigabitEthernet0/0/0/2
ipv4:
- address: 192.168.0.1/24
- name: GigabitEthernet0/0/0/3
ipv4:
- address: 192.168.2.1/24
secondary: true
state: merged
# Task Output
# -----------
#
# before:
# - name: Loopback888
# - name: Loopback999
# - name: GigabitEthernet0/0/0/2
# - name: GigabitEthernet0/0/0/3
# commands:
# - interface GigabitEthernet0/0/0/2
# - ipv4 address 192.168.0.1 255.255.255.0
# - interface GigabitEthernet0/0/0/3
# - ipv4 address 192.168.2.1 255.255.255.0 secondary
# after:
# - name: Loopback888
# - name: Loopback999
# - ipv4:
# - address: 192.168.0.1/24
# name: GigabitEthernet0/0/0/2
# - ipv4:
# - address: 192.168.2.1/24
# secondary: true
# name: GigabitEthernet0/0/0/3
# After state:
# ------------
#
# viosxr#show running-config interface
# interface Loopback888
# !
# interface Loopback999
# !
# interface MgmtEth0/RP0/CPU0/0
# ipv4 address dhcp
# !
# interface preconfigure GigabitEthernet0/0/0/2
# ipv4 address 192.168.0.1 255.255.255.0
# !
# interface preconfigure GigabitEthernet0/0/0/3
# ipv4 address 192.168.2.1 255.255.255.0 secondary
# !
# Using overridden
# Before state:
# -------------
#
# viosxr#show running-config interface
# interface Loopback888
# !
# interface Loopback999
# !
# interface MgmtEth0/RP0/CPU0/0
# ipv4 address dhcp
# !
# interface preconfigure GigabitEthernet0/0/0/2
# ipv4 address 192.168.0.1 255.255.255.0
# !
# interface preconfigure GigabitEthernet0/0/0/3
# ipv4 address 192.168.2.1 255.255.255.0 secondary
# !
- name: Override device configuration of all interfaces with provided configuration
cisco.iosxr.iosxr_l3_interfaces:
config:
- name: GigabitEthernet0/0/0/3
ipv4:
- address: 192.168.0.2/24
- address: 192.168.2.1/24
secondary: true
state: overridden
# Task Output
# -----------
#
# before:
# - name: Loopback888
# - name: Loopback999
# - ipv4:
# - address: 192.168.0.1/24
# name: GigabitEthernet0/0/0/2
# - ipv4:
# - address: 192.168.2.1/24
# secondary: true
# name: GigabitEthernet0/0/0/3
# commands:
# - interface GigabitEthernet0/0/0/2
# - no ipv4 address
# - interface GigabitEthernet0/0/0/3
# - ipv4 address 192.168.0.2 255.255.255.0
# - ipv4 address 192.168.0.1 255.255.255.0
# after:
# - name: Loopback888
# - name: Loopback999
# - name: GigabitEthernet0/0/0/2
# - ipv4:
# - address: 192.168.0.1/24
# - address: 192.168.2.1/24
# secondary: true
# name: GigabitEthernet0/0/0/3
# After state:
# -------------
#
# viosxr#show running-config interface
# interface Loopback888
# !
# interface Loopback999
# !
# interface MgmtEth0/RP0/CPU0/0
# ipv4 address dhcp
# !
# interface preconfigure GigabitEthernet0/0/0/2
# !
# interface preconfigure GigabitEthernet0/0/0/3
# ipv4 address 192.168.0.1 255.255.255.0
# ipv4 address 192.168.2.1 255.255.255.0 secondary
# !
# Using replaced
# Before state:
# -------------
#
# viosxr#show running-config interface
# interface Loopback888
# !
# interface Loopback999
# !
# interface MgmtEth0/RP0/CPU0/0
# ipv4 address dhcp
# !
# interface preconfigure GigabitEthernet0/0/0/2
# !
# interface preconfigure GigabitEthernet0/0/0/3
# ipv4 address 192.168.0.1 255.255.255.0
# ipv4 address 192.168.2.1 255.255.255.0 secondary
# !
- name: >-
Replaces device configuration of listed interfaces with provided
configuration
cisco.iosxr.iosxr_l3_interfaces:
config:
- name: GigabitEthernet0/0/0/3
ipv6:
- address: 'fd5d:12c9:2201:1::1/64'
- name: GigabitEthernet0/0/0/2
ipv4:
- address: 192.168.0.2/24
state: replaced
# Task Output
# -----------
#
# before:
# - name: Loopback888
# - name: Loopback999
# - name: GigabitEthernet0/0/0/2
# - ipv4:
# - address: 192.168.0.1/24
# - address: 192.168.2.1/24
# secondary: true
# name: GigabitEthernet0/0/0/3
# commands:
# - interface GigabitEthernet0/0/0/3
# - no ipv4 address
# - ipv6 address fd5d:12c9:2201:1::1/64
# - interface GigabitEthernet0/0/0/2
# - ipv4 address 192.168.0.2 255.255.255.0
# after:
# - name: Loopback888
# - name: Loopback999
# - ipv4:
# - address: 192.168.0.2/24
# name: GigabitEthernet0/0/0/2
# - ipv6:
# - address: fd5d:12c9:2201:1::1/64
# name: GigabitEthernet0/0/0/3
# After state:
# -------------
#
# viosxr#show running-config interface
# interface Loopback888
# !
# interface Loopback999
# !
# interface MgmtEth0/RP0/CPU0/0
# ipv4 address dhcp
# !
# interface preconfigure GigabitEthernet0/0/0/2
# ipv4 address 192.168.0.2 255.255.255.0
# !
# interface preconfigure GigabitEthernet0/0/0/3
# ipv6 address fd5d:12c9:2201:1::1/64
# !
# Using deleted
# Before state:
# -------------
#
# viosxr#show running-config interface
# interface Loopback888
# !
# interface Loopback999
# !
# interface MgmtEth0/RP0/CPU0/0
# ipv4 address dhcp
# !
# interface preconfigure GigabitEthernet0/0/0/2
# ipv4 address 192.168.0.2 255.255.255.0
# !
# interface preconfigure GigabitEthernet0/0/0/3
# ipv6 address fd5d:12c9:2201:1::1/64
# !
- name: Delete attributes for interfaces (This won't delete the interface itself)
cisco.iosxr.iosxr_l3_interfaces:
config:
- name: GigabitEthernet0/0/0/3
- name: GigabitEthernet0/0/0/4
- name: GigabitEthernet0/0/0/3.700
state: deleted
# Task Output
# -----------
#
# before:
# - name: Loopback888
# - name: Loopback999
# - ipv4:
# - address: 192.168.0.2/24
# name: GigabitEthernet0/0/0/2
# - ipv6:
# - address: fd5d:12c9:2201:1::1/64
# name: GigabitEthernet0/0/0/3
# commands:
# - interface GigabitEthernet0/0/0/3
# - no ipv6 address
# after:
# - name: Loopback888
# - name: Loopback999
# - ipv4:
# - address: 192.168.0.2/24
# name: GigabitEthernet0/0/0/2
# - name: GigabitEthernet0/0/0/3
# After state:
# -------------
#
# viosxr#show running-config interface
# interface Loopback888
# !
# interface Loopback999
# !
# interface MgmtEth0/RP0/CPU0/0
# ipv4 address dhcp
# !
# interface preconfigure GigabitEthernet0/0/0/2
# ipv4 address 192.168.0.2 255.255.255.0
# !
# interface preconfigure GigabitEthernet0/0/0/3
# !
# Using deleted - will delete all interface configuration and not interface
# Before state:
# -------------
#
# viosxr#show running-config interface
# interface Loopback888
# !
# interface Loopback999
# !
# interface MgmtEth0/RP0/CPU0/0
# ipv4 address dhcp
# !
# interface preconfigure GigabitEthernet0/0/0/1
# ipv4 address 192.168.2.1 255.255.255.0
# shutdown
# !
# interface preconfigure GigabitEthernet0/0/0/2
# ipv4 address 192.168.3.1 255.255.255.0
# shutdown
# !
# interface preconfigure GigabitEthernet0/0/0/3
# ipv4 address 192.168.0.2 255.255.255.0
# shutdown
# !
# interface preconfigure GigabitEthernet0/0/0/3.700
# ipv4 address 192.168.0.1 255.255.255.0
# !
# interface preconfigure GigabitEthernet0/0/0/4
# ipv6 address fd5d:12c9:2201:1::1/64
# shutdown
# !
- name: "Delete L3 config of all interfaces (This won't delete the interface itself)"
cisco.iosxr.iosxr_l3_interfaces:
state: deleted
# Task Output
# -----------
#
# before:
# - name: Loopback888
# - name: Loopback999
# - ipv4:
# - address: 192.168.2.1/24
# name: GigabitEthernet0/0/0/1
# - ipv4:
# - address: 192.168.3.1/24
# name: GigabitEthernet0/0/0/2
# - ipv4:
# - address: 192.168.0.2/24
# name: GigabitEthernet0/0/0/3
# - ipv4:
# - address: 192.168.0.1/24
# name: GigabitEthernet0/0/0/3.700
# - ipv6:
# - address: fd5d:12c9:2201:1::1/64
# name: GigabitEthernet0/0/0/4
# commands:
# - interface GigabitEthernet0/0/0/1
# - no ipv4 address
# - interface GigabitEthernet0/0/0/2
# - no ipv4 address
# - interface GigabitEthernet0/0/0/3
# - no ipv4 address
# - interface GigabitEthernet0/0/0/3.700
# - no ipv4 address
# - interface GigabitEthernet0/0/0/4
# - no ipv6 address
# after:
# - name: Loopback888
# - name: Loopback999
# - name: GigabitEthernet0/0/0/1
# - name: GigabitEthernet0/0/0/2
# - name: GigabitEthernet0/0/0/3
# - name: GigabitEthernet0/0/0/3.700
# - name: GigabitEthernet0/0/0/4
# After state:
# -------------
#
# viosxr#show running-config interface
# interface Loopback888
# !
# interface Loopback999
# !
# interface MgmtEth0/RP0/CPU0/0
# ipv4 address dhcp
# !
# interface preconfigure GigabitEthernet0/0/0/1
# shutdown
# !
# interface preconfigure GigabitEthernet0/0/0/2
# shutdown
# !
# interface preconfigure GigabitEthernet0/0/0/3
# shutdown
# !
# interface preconfigure GigabitEthernet0/0/0/3.700
# !
# interface preconfigure GigabitEthernet0/0/0/4
# shutdown
# !
# Using parsed
# File: parsed.cfg
# ----------------
#
# interface Loopback888
# description test for ansible
# shutdown
# !
# interface MgmtEth0/0/CPU0/0
# ipv4 address 10.8.38.70 255.255.255.0
# !
# interface GigabitEthernet0/0/0/0
# description Configured and Merged by Ansible-Network
# mtu 66
# ipv4 address 192.0.2.1 255.255.255.0
# ipv4 address 192.0.2.2 255.255.255.0 secondary
# ipv6 address 2001:db8:0:3::/64
# duplex half
# !
# interface GigabitEthernet0/0/0/1
# description Configured and Merged by Ansible-Network
# mtu 66
# speed 100
# duplex full
# dot1q native vlan 10
# l2transport
# l2protocol cdp forward
# l2protocol pvst tunnel
# propagate remote-status
# !
# !
# interface GigabitEthernet0/0/0/3
# ipv4 address 192.0.22.1 255.255.255.0
# ipv4 address 192.0.23.1 255.255.255.0
# !
- name: Convert L3 interfaces config to argspec without connecting to the appliance
cisco.iosxr.iosxr_l3_interfaces:
running_config: "{{ lookup('file', './parsed.cfg') }}"
state: parsed
# Task Output
# -----------
#
# parsed:
# - ipv4:
# - address: 192.0.2.1 255.255.255.0
# - address: 192.0.2.2 255.255.255.0
# secondary: true
# ipv6:
# - address: 2001:db8:0:3::/64
# name: GigabitEthernet0/0/0/0
# - name: GigabitEthernet0/0/0/1
# - ipv4:
# - address: 192.0.22.1 255.255.255.0
# - address: 192.0.23.1 255.255.255.0
# name: GigabitEthernet0/0/0/3
# Using rendered
- name: Render platform specific commands from task input using rendered state
cisco.iosxr.iosxr_l3_interfaces:
config:
- name: GigabitEthernet0/0/0/0
ipv4:
- address: 198.51.100.1/24
- name: GigabitEthernet0/0/0/1
ipv6:
- address: '2001:db8:0:3::/64'
ipv4:
- address: 192.0.2.1/24
- address: 192.0.2.2/24
secondary: true
state: rendered
# Task Output
# -----------
#
# rendered:
# - interface GigabitEthernet0/0/0/0
# - ipv4 address 198.51.100.1 255.255.255.0
# - interface GigabitEthernet0/0/0/1
# - ipv4 address 192.0.2.2 255.255.255.0 secondary
# - ipv4 address 192.0.2.1 255.255.255.0
# - ipv6 address 2001:db8:0:3::/64
# Using gathered
# Before state:
# ------------
#
# RP/0/0/CPU0:an-iosxr-02#show running-config interface
# interface Loopback888
# description test for ansible
# shutdown
# !
# interface MgmtEth0/0/CPU0/0
# ipv4 address 10.8.38.70 255.255.255.0
# !
# interface GigabitEthernet0/0/0/0
# description Configured and Merged by Ansible-Network
# mtu 66
# ipv4 address 192.0.2.1 255.255.255.0
# ipv4 address 192.0.2.2 255.255.255.0 secondary
# ipv6 address 2001:db8:0:3::/64
# duplex half
# !
# interface GigabitEthernet0/0/0/1
# description Configured and Merged by Ansible-Network
# mtu 66
# speed 100
# duplex full
# dot1q native vlan 10
# l2transport
# l2protocol cdp forward
# l2protocol pvst tunnel
# propagate remote-status
# !
# !
# interface GigabitEthernet0/0/0/3
# shutdown
# !
# interface GigabitEthernet0/0/0/4
# shutdown
# dot1q native vlan 40
# !
- name: Gather l3 interfaces facts
cisco.iosxr.iosxr_l3_interfaces:
config:
state: gathered
# Task Output
# -----------
#
# gathered:
# - name: Loopback888
# - ipv4:
# - address: 192.0.2.1 255.255.255.0
# - address: 192.0.2.2 255.255.255.0
# secondary: true
# ipv6:
# - address: 2001:db8:0:3::/64
# name: GigabitEthernet0/0/0/0
# - name: GigabitEthernet0/0/0/1
# - name: GigabitEthernet0/0/0/3
# - name: GigabitEthernet0/0/0/4
# Using bidirectional flow monitoring (merged)
# Before state:
# -------------
#
# viosxr#show running-config interface
# interface GigabitEthernet0/0/0/0
# ipv4 address 198.51.100.1 255.255.255.0
# !
- name: Configure bidirectional NetFlow on an interface (merged)
cisco.iosxr.iosxr_l3_interfaces:
config:
- name: GigabitEthernet0/0/0/0
flow:
ipv4:
monitor: FlowMap-IPv4
sampler: NETFLOW_1
direction: bidirectional
ipv6:
monitor: FlowMap-IPv6
sampler: NETFLOW_1
direction: bidirectional
state: merged
# Task Output
# -----------
#
# before:
# - name: GigabitEthernet0/0/0/0
# ipv4:
# - address: 198.51.100.1/24
# commands:
# - interface GigabitEthernet0/0/0/0
# - flow ipv4 monitor FlowMap-IPv4 sampler NETFLOW_1 ingress
# - flow ipv4 monitor FlowMap-IPv4 sampler NETFLOW_1 egress
# - flow ipv6 monitor FlowMap-IPv6 sampler NETFLOW_1 ingress
# - flow ipv6 monitor FlowMap-IPv6 sampler NETFLOW_1 egress
# after:
# - name: GigabitEthernet0/0/0/0
# ipv4:
# - address: 198.51.100.1/24
# flow:
# ipv4:
# monitor: FlowMap-IPv4
# sampler: NETFLOW_1
# direction: bidirectional
# ipv6:
# monitor: FlowMap-IPv6
# sampler: NETFLOW_1
# direction: bidirectional
# After state:
# ------------
#
# viosxr#show running-config interface
# interface GigabitEthernet0/0/0/0
# ipv4 address 198.51.100.1 255.255.255.0
# flow ipv4 monitor FlowMap-IPv4 sampler NETFLOW_1 ingress
# flow ipv4 monitor FlowMap-IPv4 sampler NETFLOW_1 egress
# flow ipv6 monitor FlowMap-IPv6 sampler NETFLOW_1 ingress
# flow ipv6 monitor FlowMap-IPv6 sampler NETFLOW_1 egress
# !
# Using bidirectional flow monitoring (deleted)
# Before state:
# -------------
#
# viosxr#show running-config interface
# interface GigabitEthernet0/0/0/0
# ipv4 address 198.51.100.1 255.255.255.0
# flow ipv4 monitor FlowMap-IPv4 sampler NETFLOW_1 ingress
# flow ipv4 monitor FlowMap-IPv4 sampler NETFLOW_1 egress
# flow ipv6 monitor FlowMap-IPv6 sampler NETFLOW_1 ingress
# flow ipv6 monitor FlowMap-IPv6 sampler NETFLOW_1 egress
# !
- name: >-
Remove L3 attributes for an interface including bidirectional flow
(does not remove the interface itself)
cisco.iosxr.iosxr_l3_interfaces:
config:
- name: GigabitEthernet0/0/0/0
state: deleted
# Task Output
# -----------
#
# before:
# - name: GigabitEthernet0/0/0/0
# ipv4:
# - address: 198.51.100.1/24
# flow:
# ipv4:
# monitor: FlowMap-IPv4
# sampler: NETFLOW_1
# direction: bidirectional
# ipv6:
# monitor: FlowMap-IPv6
# sampler: NETFLOW_1
# direction: bidirectional
# commands:
# - interface GigabitEthernet0/0/0/0
# - no ipv4 address
# - no flow ipv4 monitor FlowMap-IPv4 sampler NETFLOW_1 ingress
# - no flow ipv4 monitor FlowMap-IPv4 sampler NETFLOW_1 egress
# - no flow ipv6 monitor FlowMap-IPv6 sampler NETFLOW_1 ingress
# - no flow ipv6 monitor FlowMap-IPv6 sampler NETFLOW_1 egress
# after:
# - name: GigabitEthernet0/0/0/0
# After state:
# ------------
#
# viosxr#show running-config interface
# interface GigabitEthernet0/0/0/0
# !
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
after list / elements=string | Конфигурация в виде структурированных данных после выполнения модуля. Возвращается: при наличии изменений Пример: |
before list / elements=string | Конфигурация в виде структурированных данных до вызова модуля. Возвращается: всегда Пример: |
commands list / elements=string | Набор команд, отправленных на удалённое устройство Возвращается: всегда Пример: |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/cisco/iosxr/iosxr_l3_interfaces_module.html
