модуль cisco.iosxr.iosxr_ospf_interfaces — модуль ресурсов для настройки интерфейсов OSPF.
Примечание
Этот модуль входит в коллекцию cisco.iosxr (версия 12.3.1).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install cisco.iosxr.
Чтобы использовать модуль в плейбуке, укажите: cisco.iosxr.iosxr_ospf_interfaces.
Добавлено в cisco.iosxr 1.2.0
Краткое описание
- Этот модуль управляет конфигурацией OSPF (v2/v3) интерфейсов на устройствах под управлением Cisco IOS-XR.
Примечание
Этому модулю соответствует плагин действий.
Псевдонимы: ospf_interfaces
Параметры
Параметр | Комментарии |
|---|---|
config list / elements=dictionary | Список конфигураций OSPF для интерфейсов. |
|
address_family list / elements=dictionary |
Параметры OSPF на интерфейсах в контексте семейства адресов. |
|
afi string / обязательный |
Идентификатор семейства адресов (AFI) для параметров OSPF на интерфейсах. Варианты:
|
|
apply_group_option dictionary |
Указать конфигурацию группы |
|
group_name string |
Указать имя группы |
|
operation string |
Указать операцию с конфигурацией группы Варианты:
|
|
authentication dictionary |
Включить аутентификацию |
|
message_digest dictionary |
Использовать аутентификацию с дайджестом сообщения |
|
keychain string |
Указать имя цепочки ключей |
|
null_auth boolean |
Не использовать аутентификацию Варианты:
|
|
authentication_key dictionary |
Указать пароль (ключ) для аутентификации |
|
clear string |
Указывает, что далее будет задан НЕЗАШИФРОВАННЫЙ пароль (ключ) |
|
encrypted string |
Указывает, что далее будет задан ЗАШИФРОВАННЫЙ пароль (ключ) |
|
password string |
Пароль (ключ) OSPFv2 |
|
bfd dictionary |
Настроить параметры BFD |
|
fast_detect dictionary |
Настроить быстрое обнаружение |
|
set boolean |
Включить только быстрое обнаружение Варианты:
|
|
strict_mode boolean |
Удерживать сеанс с соседом до установления сеанса BFD Варианты:
|
|
minimum_interval integer |
Интервал Hello в миллисекундах |
|
multiplier integer |
Множитель обнаружения |
|
cost integer |
Указать стоимость интерфейса |
|
cost_fallback dictionary |
Указать стоимость, если суммарная пропускная способность опускается ниже порогового значения |
|
cost integer |
Указать стоимость относительно суммарной пропускной способности |
|
threshold integer |
Указать пороговую пропускную способность, при которой применяется резервная стоимость |
|
database_filter dictionary |
Фильтровать LSA OSPF во время синхронизации и распространения |
|
all_outgoing_lsa boolean |
Фильтровать все исходящие LSA Варианты:
|
|
dead_interval integer |
Указать интервал, по истечении которого сосед объявляется неактивным |
|
demand_circuit boolean |
Включить/отключить каналы по требованию Варианты:
|
|
fast_reroute dictionary |
Указать IP Fast Reroute |
|
disabled boolean |
Отключить быстрое перенаправление IP-трафика Варианты:
|
|
per_link dictionary |
Указать вычисление для каждого префикса |
|
information_type string |
Указать сведения об исключении LFA для канала или о кандидате FRR LFA Варианты:
|
|
interface dictionary |
Указать сведения об исключении LFA для канала |
|
bundle_ether list / elements=dictionary |
Указать агрегированные интерфейсы Ethernet |
|
name integer |
Указать идентификатор интерфейса |
|
bvi list / elements=dictionary |
Указать виртуальный интерфейс группы мостов |
|
name integer |
Указать идентификатор интерфейса |
|
fast_ethernet list / elements=dictionary |
Указать интерфейсы FastEthernet/IEEE 802.3 |
|
name string |
Указать идентификатор интерфейса |
|
fiftygige list / elements=dictionary |
Указать интерфейсы FiftyGigE/IEEE 802.3 |
|
name string |
Указать идентификатор интерфейса |
|
fortygige list / elements=dictionary |
Указать интерфейсы FortyGigE/IEEE 802.3 |
|
name string |
Указать идентификатор интерфейса |
|
fourhundredgige list / elements=dictionary |
Указать интерфейсы FourHundredGigE/IEEE 802.3 |
|
name string |
Указать идентификатор интерфейса |
|
gigabitethernet list / elements=dictionary |
Указать интерфейсы GigabitEthernet/IEEE 802.3 |
|
name string |
Указать идентификатор интерфейса |
|
hundredgige list / elements=dictionary |
Указать интерфейсы HundredGigE/IEEE 802.3 |
|
name string |
Указать идентификатор интерфейса |
|
mgmteth list / elements=dictionary |
Указать интерфейсы MgmtEth/IEEE 802.3 |
|
name string |
Указать идентификатор интерфейса |
|
multilink list / elements=dictionary |
Указать сетевые интерфейсы Multilink |
|
name string |
Указать идентификатор интерфейса |
|
nve list / elements=dictionary |
Указать интерфейсы конечных точек виртуализации сети |
|
name integer |
Указать идентификатор интерфейса |
|
pos_int list / elements=dictionary |
Указать агрегированные интерфейсы POS |
|
name integer |
Указать идентификатор интерфейса |
|
pw_ether list / elements=dictionary |
Указать интерфейс Ethernet PWHE |
|
name integer |
Указать идентификатор интерфейса |
|
pw_iw list / elements=dictionary |
Указать интерфейс IP-взаимодействия PWHE VC11 |
|
name integer |
Указать идентификатор интерфейса |
|
serial list / elements=dictionary |
Указать последовательные сетевые интерфейсы |
|
name string |
Указать идентификатор интерфейса |
|
srp list / elements=dictionary |
Указать интерфейсы SRP |
|
name string |
Указать идентификатор интерфейса |
|
tengige list / elements=dictionary |
Укажите интерфейс(ы) TenGigabitEthernet/IEEE 802.3 |
|
name string |
Укажите идентификатор интерфейса |
|
tunnel_ip list / elements=dictionary |
Укажите интерфейс(ы) туннеля GRE/IPinIP |
|
name integer |
Укажите идентификатор интерфейса |
|
tunnel_ipsec list / elements=dictionary |
Укажите интерфейс(ы) туннеля IPSec |
|
name integer |
Укажите идентификатор интерфейса |
|
tunnel_mpls list / elements=dictionary |
Интерфейс туннеля транспортного протокола MPLS |
|
name string |
Укажите идентификатор интерфейса |
|
tunnel_mte list / elements=dictionary |
Укажите интерфейс(ы) туннеля MPLS Traffic Engineering P2MP |
|
name integer |
Укажите идентификатор интерфейса |
|
twentyfivegige list / elements=dictionary |
Укажите интерфейс(ы) TwentyFiveGigabitEthernet/IEEE 802.3 |
|
name string |
Укажите идентификатор интерфейса |
|
twohundredgige list / elements=dictionary |
Укажите интерфейс(ы) TwoHundredGigE/IEEE 802.3 |
|
name string |
Укажите идентификатор интерфейса |
|
use_candidate_only boolean |
Включить/отключить выбор резервного маршрута только из списка кандидатов Варианты:
|
|
flood_reduction boolean |
Включить/отключить сокращение рассылки Варианты:
|
|
hello_interval integer |
Укажите интервал между пакетами HELLO |
|
link_down_fast_detect boolean |
Настройте параметры отключения интерфейса Варианты:
|
|
message_digest_key dictionary |
Пароль (ключ) аутентификации с дайджестом сообщения |
|
id integer / обязательный |
Идентификатор ключа |
|
md5 dictionary / обязательный |
Использовать алгоритм MD5 |
|
clear boolean |
Указывает, что далее будет задан НЕЗАШИФРОВАННЫЙ пароль (ключ) Варианты:
|
|
encrypted boolean |
Указывает, что далее будет задан ЗАШИФРОВАННЫЙ пароль (ключ) Варианты:
|
|
password string |
Пароль (ключ) OSPFv2 |
|
mpls_ldp_sync boolean |
Включить/отключить синхронизацию MPLS LDP Варианты:
|
|
mtu_ignore boolean |
Включить/отключить игнорирование MTU в пакетах DBD Варианты:
|
|
neighbors list / elements=dictionary |
Укажите маршрутизаторы-соседи |
|
cost integer |
Укажите стоимость OSPF для соседа в сети типа «точка — многоточка» |
|
db_filter_all_out boolean |
Укажите фильтрацию LSA OSPF во время синхронизации и рассылки для соседа в сети типа «точка — многоточка» Варианты:
|
|
neighbor_id string |
Укажите адрес (имя) соседа |
|
poll_interval integer |
Укажите интервал опроса неактивного маршрутизатора OSPF |
|
priority integer |
Укажите приоритет OSPF для соседа в сети без широковещания |
|
network string |
Укажите тип сети Варианты:
|
|
packet_size integer |
Настройте размер пакетов OSPF в пределах MTU |
|
passive boolean |
Включить/отключить пассивный режим Варианты:
|
|
prefix_suppression boolean |
Подавить объявление префиксов Варианты:
|
|
priority integer |
Укажите приоритет маршрутизатора |
|
processes list / elements=dictionary |
Конфигурация интерфейсов для процесса OSPF. |
|
area dictionary |
Укажите идентификатор области |
|
area_id string |
Идентификатор области интерфейсов OSPF в виде десятичного значения. Допустимые значения см. в документации производителя. Идентификатор области интерфейсов OSPF в формате IP-адреса (например, A.B.C.D) |
|
process_id string / обязательный |
Метка процесса OSPF. |
|
retransmit_interval integer |
Укажите интервал между повторными передачами потерянных объявлений о состоянии канала |
|
security_ttl dictionary |
Включить защиту |
|
hops integer |
Максимальное допустимое количество переходов IP <1-254> |
|
set boolean |
Включить защиту TTL Варианты:
|
|
transmit_delay integer |
Укажите расчетное время, необходимое для отправки пакета обновления состояния канала |
|
name string / обязательный |
Имя/идентификатор интерфейса. |
|
type string / обязательный |
Тип интерфейса. |
running_config string | Этот параметр используется только при состоянии parsed. Значением этого параметра должен быть вывод, полученный с устройства IOS-XR при выполнении команды show running-config router ospf’. Состояние parsed считывает конфигурацию из параметра |
state string | Состояние, в котором должна остаться конфигурация. Варианты:
|
Примечания
Примечание
- Этот модуль работает с подключением
network_cli. См. параметры платформы IOS-XR
Примеры
# Using merged
# Before state:
# -------------
#
# RP/0/RP0/CPU0:anton#show running-config router ospf
# % No such configuration item(s)
#
- name: Merge provided OSPF interfaces configuration with the existing configuration
cisco.iosxr.iosxr_ospf_interfaces:
config:
- name: GigabitEthernet0/0/0/0
type: gigabitethernet
address_family:
- afi: ipv4
processes:
- process_id: LAB3
area:
area_id: 0.0.0.3
cost: 20
authentication:
message_digest:
keychain: cisco
- afi: ipv6
processes:
- process_id: LAB3
area:
area_id: 0.0.0.2
cost: 30
state: merged
#
#
# Task Output:
# ------------
#
# before: []
#
# commands:
# - router ospf LAB3 area 0.0.0.3 interface GigabitEthernet 0/0/0/0 cost 20
# - router ospf LAB3 area 0.0.0.3 interface GigabitEthernet 0/0/0/0 authentication message-digest
# - router ospf LAB3 area 0.0.0.3 interface GigabitEthernet 0/0/0/0 authentication message-digest keychain cisco
# - router ospfv3 LAB3 area 0.0.0.2 interface GigabitEthernet 0/0/0/0 cost 30
#
# after:
# - address_family:
# - afi: ipv4
# authentication:
# message_digest:
# keychain: cisco
# cost: 20
# processes:
# - area:
# area_id: 0.0.0.3
# process_id: LAB3
# - afi: ipv6
# cost: 30
# processes:
# - area:
# area_id: 0.0.0.2
# process_id: LAB3
# name: GigabitEthernet0/0/0/0
# type: gigabitethernet
#
# After state:
# ------------
#
# RP/0/0/CPU0:an-iosxr-02#show running-config router ospf
# Thu Oct 23 06:00:57.217 UTC
# router ospf LAB3
# area 0.0.0.3
# interface GigabitEthernet0/0/0/0
# cost 20
# authentication message-digest keychain cisco
# !
# !
# !
# router ospfv3 LAB3
# area 0.0.0.2
# interface GigabitEthernet0/0/0/0
# cost 30
# !
# !
# !
# Using replaced
#
# Before state:
# -------------
#
#
# RP/0/0/CPU0:an-iosxr-02#show running-config router ospf
# Thu Oct 23 06:00:57.217 UTC
# router ospf LAB3
# area 0.0.0.3
# interface GigabitEthernet0/0/0/0
# cost 20
# authentication message-digest keychain cisco
# !
# !
# !
# router ospfv3 LAB3
# area 0.0.0.2
# interface GigabitEthernet0/0/0/0
# cost 30
# !
# !
# !
- name: Replace OSPF interfaces configuration
cisco.iosxr.iosxr_ospf_interfaces:
config:
- name: GigabitEthernet0/0/0/0
type: gigabitethernet
address_family:
- afi: ipv4
processes:
- process_id: LAB3
area:
area_id: 0.0.0.3
cost: 30
authentication:
message_digest:
keychain: ciscoiosxr
- afi: ipv6
processes:
- process_id: LAB3
area:
area_id: 0.0.0.2
cost: 30
state: replaced
#
# Task Output:
# ------------
#
# before:
# - address_family:
# - afi: ipv4
# authentication:
# message_digest:
# keychain: cisco
# cost: 20
# processes:
# - area:
# area_id: 0.0.0.3
# process_id: LAB3
# - afi: ipv6
# cost: 30
# processes:
# - area:
# area_id: 0.0.0.2
# process_id: LAB3
# name: GigabitEthernet0/0/0/0
# type: gigabitethernet
#
# commands:
# - router ospf LAB3 area 0.0.0.3 interface GigabitEthernet 0/0/0/0 cost 30
# - router ospf LAB3 area 0.0.0.3 interface GigabitEthernet 0/0/0/0 authentication message-digest
# - router ospf LAB3 area 0.0.0.3 interface GigabitEthernet 0/0/0/0 authentication message-digest keychain ciscoiosxr
#
# after:
# - address_family:
# - afi: ipv4
# authentication:
# message_digest:
# keychain: ciscoiosxr
# cost: 30
# processes:
# - area:
# area_id: 0.0.0.3
# process_id: LAB3
# - afi: ipv6
# cost: 30
# processes:
# - area:
# area_id: 0.0.0.2
# process_id: LAB3
# name: GigabitEthernet0/0/0/0
# type: gigabitethernet
#
# After state:
# ------------
#
# RP/0/0/CPU0:an-iosxr-02#show running-config router ospf
# Thu Oct 23 06:10:39.827 UTC
# router ospf LAB3
# area 0.0.0.3
# interface GigabitEthernet0/0/0/0
# cost 30
# authentication message-digest keychain ciscoiosxr
# !
# router ospfv3 LAB3
# area 0.0.0.2
# interface GigabitEthernet0/0/0/0
# cost 30
# !
# !
# !
# Using overridden
#
# Before state
# ------------
#
- name: Override existing OSPF interfaces configuration
cisco.iosxr.iosxr_ospf_interfaces:
config:
- name: GigabitEthernet0/0/0/1
type: gigabitethernet
address_family:
- afi: ipv4
processes:
- process_id: LAB1
area:
area_id: 0.0.0.3
cost: 10
authentication:
message_digest:
keychain: iosxr
state: overridden
#
#
# Task Output:
# ------------
#
# before:
# - address_family:
# - afi: ipv4
# authentication:
# message_digest:
# keychain: ciscoiosxr
# cost: 30
# processes:
# - area:
# area_id: 0.0.0.3
# process_id: LAB3
# - afi: ipv6
# cost: 30
# processes:
# - area:
# area_id: 0.0.0.2
# process_id: LAB3
# name: GigabitEthernet0/0/0/0
# type: gigabitethernet
#
# commands:
# - no router ospf LAB3 area 0.0.0.3 interface GigabitEthernet 0/0/0/0
# - no router ospfv3 LAB3 area 0.0.0.2 interface GigabitEthernet 0/0/0/0
# - router ospf LAB1 area 0.0.0.3 interface GigabitEthernet 0/0/0/1 cost 10
# - router ospf LAB1 area 0.0.0.3 interface GigabitEthernet 0/0/0/1 authentication message-digest
# - router ospf LAB1 area 0.0.0.3 interface GigabitEthernet 0/0/0/1 authentication message-digest keychain iosxr
#
# after:
# - address_family:
# - afi: ipv4
# authentication:
# message_digest:
# keychain: iosxr
# cost: 10
# processes:
# - area:
# area_id: 0.0.0.3
# process_id: LAB1
# name: GigabitEthernet0/0/0/1
# type: gigabitethernet
#
# After state:
# ------------
#
# RP/0/0/CPU0:an-iosxr-02#show running-config router ospf
# Thu Oct 23 06:28:15.025 UTC
# router ospf LAB1
# area 0.0.0.3
# interface GigabitEthernet0/0/0/1
# cost 10
# authentication message-digest keychain iosxr
# !
# !
# !
# router ospf LAB3
# area 0.0.0.3
# !
# !
# router ospfv3 LAB3
# area 0.0.0.2
# !
# !
# Using deleted
#
# Before state:
# -------------
#
#
# RP/0/0/CPU0:an-iosxr-02#show running-config router ospf
# Thu Oct 23 06:28:15.025 UTC
# router ospf LAB1
# area 0.0.0.3
# interface GigabitEthernet0/0/0/1
# cost 10
# authentication message-digest keychain iosxr
# !
# !
# !
# router ospf LAB3
# area 0.0.0.3
# interface GigabitEthernet0/0/0/0
# cost 20
# authentication message-digest keychain cisco
# !
# !
# !
# router ospfv3 LAB3
# area 0.0.0.2
# interface GigabitEthernet0/0/0/0
# cost 30
# !
# !
# !
- name: Deleted existing OSPF interfaces from the device
cisco.iosxr.iosxr_ospf_interfaces:
config:
- name: GigabitEthernet0/0/0/1
type: gigabitethernet
state: deleted
#
# Task Output:
# ------------
#
# before:
# - address_family:
# - afi: ipv4
# authentication:
# message_digest:
# keychain: iosxr
# cost: 10
# processes:
# - area:
# area_id: 0.0.0.3
# process_id: LAB1
# name: GigabitEthernet0/0/0/1
# type: gigabitethernet
# - address_family:
# - afi: ipv4
# authentication:
# message_digest:
# keychain: cisco
# cost: 20
# processes:
# - area:
# area_id: 0.0.0.3
# process_id: LAB3
# - afi: ipv6
# cost: 30
# processes:
# - area:
# area_id: 0.0.0.2
# process_id: LAB3
# name: GigabitEthernet0/0/0/0
# type: gigabitethernet
#
# commands:
# - no router ospf LAB1 area 0.0.0.3 interface GigabitEthernet 0/0/0/1]
#
# after:
# - address_family:
# - afi: ipv4
# authentication:
# message_digest:
# keychain: cisco
# cost: 20
# processes:
# - area:
# area_id: 0.0.0.3
# process_id: LAB3
# - afi: ipv6
# cost: 30
# processes:
# - area:
# area_id: 0.0.0.2
# process_id: LAB3
# name: GigabitEthernet0/0/0/0
# type: gigabitethernet
#
# After state:
# ------------
#
# RP/0/0/CPU0:an-iosxr-02#show running-config router ospf
# Thu Oct 23 06:34:38.319 UTC
# router ospf LAB1
# area 0.0.0.3
# !
# !
# router ospf LAB3
# area 0.0.0.3
# interface GigabitEthernet0/0/0/0
# cost 20
# authentication message-digest keychain cisco
# !
# !
# !
# router ospfv3 LAB3
# area 0.0.0.2
# interface GigabitEthernet0/0/0/0
# cost 30
# !
# !
# !
# Using parsed
#
# parsed.cfg
# ------------
# router ospf LAB
# area 0.0.0.0
# !
# area 0.0.0.9
# !
# !
# router ospf LAB1
# area 0.0.0.1
# !
# area 0.0.0.3
# !
# !
# router ospf LAB3
# area 0.0.0.3
# interface GigabitEthernet0/0/0/0
# cost 20
# authentication message-digest keychain cisco
# !
# !
# !
# router ospf ipv4
# !
- name: Parsed running config and display structured facts.
cisco.iosxr.iosxr_ospf_interfaces:
running_config: "{{ lookup('file', './parsed.cfg') }}"
state: parsed
#
# Task Output:
# ------------
#
# parsed:
# - address_family:
# - afi: ipv4
# authentication:
# message_digest:
# keychain: cisco
# cost: 20
# processes:
# - area:
# area_id: 0.0.0.3
# process_id: LAB3
# name: GigabitEthernet0/0/0/0
# type: gigabitethernet
# Using rendered
#
- name: Render the commands for provided configuration
cisco.iosxr.iosxr_ospf_interfaces:
config:
- name: GigabitEthernet0/0/0/0
type: gigabitethernet
address_family:
- afi: ipv4
processes:
- process_id: LAB3
area:
area_id: 0.0.0.3
cost: 20
authentication:
message_digest:
keychain: cisco
- afi: ipv6
processes:
- process_id: LAB3
area:
area_id: 0.0.0.2
cost: 30
state: rendered
#
# Task Output:
# ------------
#
# rendered:
# - router ospf LAB3 area 0.0.0.3 interface GigabitEthernet 0/0/0/0 cost 20
# - router ospf LAB3 area 0.0.0.3 interface GigabitEthernet 0/0/0/0 authentication message-digest
# - router ospf LAB3 area 0.0.0.3 interface GigabitEthernet 0/0/0/0 authentication message-digest keychain cisco
# - router ospfv3 LAB3 area 0.0.0.2 interface GigabitEthernet 0/0/0/0 cost 30
# Using gathered
#
# Before state:
# -------------
#
# RP/0/0/CPU0:an-iosxr-02#show running-config router ospf
# Thu Oct 23 06:50:38.743 UTC
# router ospf LAB3
# area 0.0.0.3
# interface GigabitEthernet0/0/0/0
# cost 20
# authentication message-digest keychain cisco
# !
# !
# !
# router ospfv3 LAB3
# area 0.0.0.2
# interface GigabitEthernet0/0/0/0
# cost 30
# !
# !
# !
- name: Gather ospf_interfaces routes configuration
cisco.iosxr.iosxr_ospf_interfaces:
state: gathered
#
# Task Output:
# ------------
#
# gathered:
# - address_family:
# - afi: ipv4
# authentication:
# message_digest:
# keychain: cisco
# cost: 20
# processes:
# - area:
# area_id: 0.0.0.3
# process_id: LAB3
# - afi: ipv6
# cost: 30
# processes:
# - area:
# area_id: 0.0.0.2
# process_id: LAB3
# name: GigabitEthernet0/0/0/0
# type: gigabitethernet
Возвращаемые значения
Общие возвращаемые значения описаны здесь, ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
after list / elements=string | Результирующая конфигурация после вызова модели. Возвращается: при изменении Пример: |
before list / elements=string | Конфигурация до вызова модели. Возвращается: всегда Пример: |
commands list / elements=string | Набор команд, отправленных на удалённое устройство. Возвращается: всегда Пример: |
gathered list / elements=string | Сведения о сетевом ресурсе, собранные с удалённого устройства в виде структурированных данных. Возвращается: когда state равен Пример: |
parsed list / elements=string | Собственная конфигурация устройства, переданная в параметре running_config и разобранная в структурированные данные в соответствии со спецификацией аргументов модуля. Возвращается: когда state равен Пример: |
rendered list / elements=string | Конфигурация, указанная в задаче, преобразованная в собственный формат устройства (без подключения к устройству). Возвращается: когда state равен Пример: |
Ссылки на коллекцию
© 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_ospf_interfaces_module.html