модуль cisco.nxos.nxos_l3_interfaces — модуль ресурсов интерфейсов L3

Примечание

Этот модуль входит в коллекцию cisco.nxos (версия 11.2.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Чтобы установить её, используйте: ansible-galaxy collection install cisco.nxos.

Чтобы использовать её в плейбуке, укажите: cisco.nxos.nxos_l3_interfaces.

Добавлено в cisco.nxos 1.0.0

Краткое описание
Параметры
Примечания
Примеры
Возвращаемые значения

Краткое описание

Этот модуль управляет атрибутами интерфейсов уровня 3 интерфейсов NX-OS.

Примечание

Этому модулю соответствует плагин действий.

Псевдонимы: l3_interfaces

Параметры

Параметр	Комментарии
config list / elements=dictionary	Словарь параметров интерфейса уровня 3
bandwidth dictionary	Задать пропускную способность вручную
inherit boolean	Указать, что пропускная способность наследуется Допустимые значения: `false` `true`
kilobits integer	Пропускная способность в килобитах
dhcp dictionary	Настройка отслеживания DHCP или ретрансляции DHCP
ipv4 dictionary	Отслеживание DHCP для IPv4
option82 dictionary	Параметр DHCP option82.
suboption dictionary	Параметр DHCP option82.
circuit_id string	Настройка строкового значения circuit-id подопции DHCP option82.
relay dictionary	Настройка агента ретрансляции.
address list / elements=dictionary	Список адресов ретрансляции IPv4
relay_ip string	IP-адрес
vrf_name string	Принадлежность вспомогательного адреса к VRF
information dictionary	Параметр информации агента ретрансляции.
trusted boolean	Включить доверие к ретрансляции на этом интерфейсе. Допустимые значения: `false` `true`
source_interface dictionary	Настройка адреса шлюза для ретрансляции DHCP
interface_id string	Идентификатор интерфейса
interface_type string	Тип интерфейса
subnet_selection dictionary	Настройка адреса шлюза для ретрансляции DHCP
subnet_ip string	IP-адрес
smart_relay boolean	Настройка интеллектуальной ретрансляции DHCP на интерфейсе. Допустимые значения: `false` `true`
ipv6 dictionary	Отслеживание DHCP для IPv6
relay dictionary	Настройка агента ретрансляции.
address list / elements=dictionary	Настройка адреса ретрансляции сервера DHCPv6
interface_id string	Идентификатор интерфейса
interface_type string	Тип интерфейса
relay_ip string	IP-адрес
vrf_name string	Принадлежность вспомогательного адреса к VRF
source_interface dictionary	Настройка исходного интерфейса для ретрансляции DHCPv6.
interface_id string	Идентификатор интерфейса
interface_type string	Тип интерфейса
smart_relay boolean	Настройка интеллектуальной ретрансляции DHCP на интерфейсе. Допустимые значения: `false` `true`
dot1q integer	Настройка инкапсуляции VLAN IEEE 802.1Q на подинтерфейсе.
evpn_multisite_tracking string добавлено в cisco.nxos 1.1.0	Отслеживание интерфейсов в многосайтовой конфигурации VxLAN EVPN. Поддерживается только на отдельных моделях. Допустимые значения: `"fabric-tracking"` `"dci-tracking"`
ipv4 list / elements=dictionary	IPv4-адрес и атрибуты интерфейса уровня 3.
address string	IPv4-адрес интерфейса уровня 3.
ip_network_mask string	Префикс IP и длина сетевой маски в формате x.x.x.x/m или сетевая маска IP в формате m.m.m.m
route_preference integer	Предпочтение маршрута URIB для локальных/непосредственно подключённых маршрутов
secondary boolean	Логический атрибут для управления добавлением вторичного IP-адреса. Допустимые значения: `false` `true`
tag integer	Значение тега маршрута URIB для локальных/непосредственно подключённых маршрутов.
ipv6 list / elements=dictionary	IPv6-адрес и атрибуты интерфейса уровня 3.
address string	IPv6-адрес интерфейса уровня 3.
aggregate_prefix_length integer	Длина префикса для агрегации маршрутов AM
anycast boolean	Настройка IPv6-адреса anycast на интерфейсе Допустимые значения: `false` `true`
eui64 boolean	Настройка расширенного уникального идентификатора для младших 64 бит Допустимые значения: `false` `true`
route_preference integer	Предпочтение маршрута URIB для локальных/непосредственно подключённых маршрутов
tag integer	Значение тега маршрута URIB для локальных/непосредственно подключённых маршрутов.
use_bia boolean	Использовать BIA Допустимые значения: `false` `true`
ipv6_redirects boolean	Включает/отключает перенаправления IPv6. Допустимые значения: `false` `true`
ipv6_unreachables boolean	Включает/отключает перенаправления IP. Допустимые значения: `false` `true`
ipv6_verify dictionary	Пересылка одноадресных пакетов по обратному пути.
unicast dictionary	Пересылка одноадресных пакетов по обратному пути.
source dictionary	Проверка адреса источника.
reachable_via dictionary	Указать проверку доступности, применяемую к адресу источника.
allow_default boolean	Ослабленная проверка пересылки одноадресных пакетов по обратному пути с маршрутом по умолчанию. Допустимые значения: `false` `true`
mode string	Источник доступен через любой интерфейс/входящий интерфейс.
mac_address string	Задать MAC-адрес интерфейса вручную или извлечь MAC-адрес (3) из IPv6-адреса, настроенного на интерфейсе.
name string / обязательный	Полное имя интерфейса уровня 3, например Ethernet1/1.
port_unreachable boolean	Включить отправку сообщений ICMP о недоступности порта. Допустимые значения: `false` `true`
proxy_arp boolean	Настройка Proxy ARP. Допустимые значения: `false` `true`
redirects boolean	Включает/отключает перенаправления IPv4. Допустимые значения: `false` `true`
unreachables boolean	Включает/отключает перенаправления IP. Допустимые значения: `false` `true`
verify dictionary	Настройка пересылки одноадресных пакетов по обратному пути или защиты источника IP.
unicast dictionary	Пересылка одноадресных пакетов по обратному пути.
source dictionary	Проверка адреса источника.
reachable_via dictionary	Указать проверку доступности, применяемую к адресу источника.
allow_default boolean	Ослабленная проверка пересылки одноадресных пакетов по обратному пути с маршрутом по умолчанию. Допустимые значения: `false` `true`

mode string	Источник доступен через любой интерфейс/интерфейс приема.
running_config string	Этот параметр используется только при состоянии parsed. Значением этого параметра должен быть вывод, полученный с устройства IOS при выполнении команды show running-config \| section ^interface. Состояние parsed считывает конфигурацию из параметра `running_config` и преобразует ее в структурированные данные Ansible в соответствии со спецификацией аргументов модуля ресурса, после чего значение возвращается в ключе parsed результата.
state string	Состояние, в котором должна остаться конфигурация Состояния rendered, gathered и parsed не вносят изменений на устройстве. Состояние rendered преобразует конфигурацию в параметре `config` в команды CLI, специфичные для платформы, и возвращает их в ключе rendered результата. Для состояния rendered активное подключение к удаленному узлу не требуется. Состояние gathered получает текущую конфигурацию устройства, преобразует ее в структурированные данные в формате, соответствующем спецификации аргументов модуля ресурса, и возвращает значение в ключе gathered результата. Состояние parsed считывает конфигурацию из параметра `running_config` и преобразует ее в формат JSON в соответствии с параметрами модуля ресурса, после чего значение возвращается в ключе parsed результата. Значение параметра `running_config` должно иметь тот же формат, что и вывод команды show running-config \| section ^interface, выполненной на устройстве. Для состояния parsed активное подключение к удаленному узлу не требуется. Варианты: `"merged"` ← (по умолчанию) `"replaced"` `"overridden"` `"deleted"` `"rendered"` `"gathered"` `"parsed"`

Примечания

Примечание

Проверено на NXOS 7.3.(0)D1(1) в VIRL
Не поддерживается для Cisco MDS

Примеры

# Using merged

# Before state:
# -------------
#
# router# show running-config | section interface
# interface Ethernet1/1
# interface Ethernet1/2

- name: Merge provided configuration with device configuration.
  cisco.nxos.nxos_l3_interfaces:
    config:
      - name: Ethernet1/1
        mac_address: 0011.2233.4455
        ipv4:
          verify:
            unicast:
              source:
                reachable_via:
                  mode: any
                  allow_default: true
          dhcp:
            relay:
              address:
                - relay_ip: 11.0.0.1
                  vrf_name: abc
      - name: Ethernet1/2
        ipv6:
          addresses:
            - ipv6_address: 2001:db8::1/32
              route_preference: 70
              tag: 97
          dhcp:
            relay:
              address:
                - relay_ip: 2001:db8::1:abcd
    state: merged

# Task Output
# -----------
#
# before:
# - name: Ethernet1/1
# - name: Ethernet1/2
# commands:
# - interface Ethernet1/1
# - mac-address 0011.2233.4455
# - ip verify unicast source reachable-via any allow-default
# - ip dhcp relay address 11.0.0.1 use-vrf abc
# - interface Ethernet1/2
# - ipv6 address 2001:db8::1/32 route-preference 70 tag 97
# - ipv6 dhcp relay address 2001:db8::1:abcd
# after:
# - name: Ethernet1/1
#   mac_address: 0011.2233.4455
#   ipv4:
#     verify:
#       unicast:
#         source:
#           reachable_via:
#             mode: any
#             allow_default: true
#     dhcp:
#       relay:
#         address:
#           - relay_ip: 11.0.0.1
#             vrf_name: abc
# - name: Ethernet1/2
#   ipv6:
#     addresses:
#       - ipv6_address: 2001:db8::1/32
#         route_preference: 70
#         tag: 97
#     dhcp:
#       relay:
#         address:
#           - relay_ip: 2001:db8::1:abcd

# After state:
# ------------
#
# router# show running-config | section interface
# interface Ethernet1/1
#  mac-address 0011.2233.4455
#  ip verify unicast source reachable-via any allow-default
#  ip dhcp relay address 11.0.0.1 use-vrf abc
# interface Ethernet1/2
#  ipv6 address 2001:db8::1/32 route-preference 70 tag 97
#  ipv6 dhcp relay address 2001:db8::1:abcd


# Using replaced

# Before state:
# -------------
#
# router# show running-config | section interface
# interface Ethernet 1/1
#  mac-address 00:11:22:33:44:55
#  ip verify unicast source reachable-via any allow-default
#  ip dhcp relay address 11.0.0.1 use-vrf abc
# interface Ethernet 1/2
#  ipv6 dhcp relay address 2001:0db8::1:abcd
#  ipv6 address 2001:db8::1/32 route-preference 70 tag 97

- name: Replace device configuration of specified L3 interfaces with provided configuration.
  cisco.nxos.nxos_l3_interfaces:
    config:
      - name: Ethernet1/2
        mac_address: 0011.2233.4456
        ipv6:
          addresses:
            - ipv6_address: 2001:db8::1/32
              route_preference: 200
              tag: 22
          dhcp:
            relay:
              address:
                - relay_ip: 2001:db8::1:abcd
    state: replaced

# Task Output
# -----------
#
# before:
# - name: Ethernet1/1
#   mac_address: 0011.2233.4455
#   ipv4:
#     verify:
#       unicast:
#         source:
#           reachable_via:
#             mode: any
#             allow_default: true
#     dhcp:
#       relay:
#         address:
#           - relay_ip: 11.0.0.1
#             vrf_name: abc
# - name: Ethernet1/2
#   ipv6:
#     addresses:
#       - ipv6_address: 2001:db8::1/32
#         route_preference: 70
#         tag: 97
#     dhcp:
#       relay:
#         address:
#           - relay_ip: 2001:db8::1:abcd
# commands:
# - interface Ethernet1/2
# - no ipv6 address 2001:db8::1/32 route-preference 70 tag 97
# - ipv6 address 2001:db8::1/32 route-preference 200 tag 22
# - mac-address 0011.2233.4456
# after:
# - name: Ethernet1/1
#   mac_address: 0011.2233.4455
#   ipv4:
#     verify:
#       unicast:
#         source:
#           reachable_via:
#             mode: any
#             allow_default: true
#     dhcp:
#       relay:
#         address:
#           - relay_ip: 11.0.0.1
#             vrf_name: abc
# - name: Ethernet1/2
#   mac_address: 0011.2233.4456
#   ipv6:
#     addresses:
#       - ipv6_address: 2001:db8::1/32
#         route_preference: 200
#         tag: 22
#     dhcp:
#       relay:
#         address:
#           - relay_ip: 2001:db8::1:abcd

# After state:
# ------------
#
# router# show running-config | section interface
# interface Ethernet1/1
#  mac-address 0011.2233.4455
#  ip verify unicast source reachable-via any allow-default
#  ip dhcp relay address 11.0.0.1 use-vrf abc
# interface Ethernet1/2
#  mac-address 0011.2233.4456
#  ipv6 address 2001:db8::1/32 route-preference 200 tag 22
#  ipv6 dhcp relay address 2001:db8::1:abcd

# Using overridden

# Before state:
# -------------
#
# router# show running-config | section interface
# interface Ethernet 1/1
#  mac-address 00:11:22:33:44:55
#  ip verify unicast source reachable-via any allow-default
#  ip dhcp relay address 11.0.0.1 use-vrf abc
# interface Ethernet 1/2
#  ipv6 dhcp relay address 2001:0db8::1:abcd
#  ipv6 address 2001:db8::1/32 route-preference 70 tag 97

- name: Override device configuration with provided configuration.
  cisco.nxos.nxos_l3_interfaces:
    config:
      - name: Ethernet1/1
        mac_address: 0011.2233.4455
        ipv4:
          verify:
            unicast:
              source:
                reachable_via:
                  mode: any
                  allow_default: true
    state: overridden

# Task Output
# -----------
#
# before:
# before:
# - name: Ethernet1/1
#   mac_address: 0011.2233.4455
#   ipv4:
#     verify:
#       unicast:
#         source:
#           reachable_via:
#             mode: any
#             allow_default: true
#     dhcp:
#       relay:
#         address:
#           - relay_ip: 11.0.0.1
#             vrf_name: abc
# - name: Ethernet1/2
#   ipv6:
#     addresses:
#       - ipv6_address: 2001:db8::1/32
#         route_preference: 70
#         tag: 97
#     dhcp:
#       relay:
#         address:
#           - relay_ip: 2001:db8::1:abcd
# commands:
# - interface Ethernet1/1
# - no ip dhcp relay address 11.0.0.1 use-vrf abc
# - interface Ethernet1/2
# - no ipv6 address 2001:db8::1/32 route-preference 70 tag 97
# - no ipv6 dhcp relay address 2001:db8::1:abcd
# after:
# - name: Ethernet1/1
#   mac_address: 0011.2233.4455
#   ipv4:
#     verify:
#       unicast:
#         source:
#           reachable_via:
#             mode: any
#             allow_default: true
# - name: Ethernet1/2

# After state:
# ------------
#
# router# show running-config | section interface
# interface Ethernet1/1
#  mac-address 0011.2233.4455
#  ip verify unicast source reachable-via any allow-default

# Using deleted

# Before state:
# -------------
#
# router# show running-config | section interface
# interface Ethernet 1/1
#  mac-address 00:11:22:33:44:55
#  ip verify unicast source reachable-via any allow-default
#  ip dhcp relay address 11.0.0.1 use-vrf abc
# interface Ethernet 1/2
#  ipv6 dhcp relay address 2001:0db8::1:abcd
#  ipv6 address 2001:db8::1/32 route-preference 70 tag 97

- name: Delete L3 attributes of given interfaces (This won't delete the interface
    itself).
  cisco.nxos.nxos_l3_interfaces:
    config:
      - name: Ethernet1/1
      - name: Ethernet1/2
    state: deleted

# Task Output
# -----------
#
# before:
# - name: Ethernet1/1
#   mac_address: 0011.2233.4455
#   ipv4:
#     verify:
#       unicast:
#         source:
#           reachable_via:
#             mode: any
#             allow_default: true
#     dhcp:
#       relay:
#         address:
#           - relay_ip: 11.0.0.1
#             vrf_name: abc
# - name: Ethernet1/2
#   ipv6:
#     addresses:
#       - ipv6_address: 2001:db8::1/32
#         route_preference: 70
#         tag: 97
#     dhcp:
#       relay:
#         address:
#           - relay_ip: 2001:db8::1:abcd
# commands:
# - interface Ethernet1/1
# - no mac-address 0011.2233.4455
# - no ip verify unicast source reachable-via any allow-default
# - no ip dhcp relay address 11.0.0.1 use-vrf abc
# - interface Ethernet1/2
# - no ipv6 address 2001:db8::1/32 route-preference 70 tag 97
# - no ipv6 dhcp relay address 2001:db8::1:abcd
# after:
# - name: Ethernet1/1
# - name: Ethernet1/2

# After state:
# ------------
#
# router# show running-config | section interface
# interface Ethernet1/1
# interface Ethernet1/2

# Using rendered

- name: Use rendered state to convert task input to device specific commands
  cisco.nxos.nxos_l3_interfaces:
    config:
      - name: Ethernet1/1
        mac_address: 0011.2233.4455
        ipv4:
          verify:
            unicast:
              source:
                reachable_via:
                  mode: any
                  allow_default: true
          dhcp:
            relay:
              address:
                - relay_ip: 11.0.0.1
                  vrf_name: abc
      - name: Ethernet1/2
        ipv6:
          addresses:
            - ipv6_address: 2001:db8::1/32
              route_preference: 70
              tag: 97
          dhcp:
            relay:
              address:
                - relay_ip: 2001:db8::1:abcd
    state: rendered

# Task Output
# -----------
#
# rendered:
# - interface Ethernet1/1
# - mac-address 0011.2233.4455
# - ip verify unicast source reachable-via any allow-default
# - ip dhcp relay address 11.0.0.1 use-vrf abc
# - interface Ethernet1/2
# - ipv6 address 2001:db8::1/32 route-preference 70 tag 97
# - ipv6 dhcp relay address 2001:db8::1:abcd

# Using parsed

# parsed.cfg
# ----------
#
# interface Ethernet1/1
#  mac-address 0011.2233.4455
#  ip verify unicast source reachable-via any allow-default
#  ip dhcp relay address 11.0.0.1 use-vrf abc
# interface Ethernet1/2
#  ipv6 address 2001:db8::1/32 route-preference 70 tag 97
#  ipv6 dhcp relay address 2001:db8::1:abcd

- name: Use parsed state to convert externally supplied config to structured format
  cisco.nxos.nxos_l3_interfaces:
    running_config: "{{ lookup('file', 'parsed.cfg') }}"
    state: parsed

# Task output
# -----------
#
# parsed:
#   - name: Ethernet1/1
#     mac_address: 0011.2233.4455
#     ipv4:
#       verify:
#         unicast:
#           source:
#             reachable_via:
#               mode: any
#               allow_default: true
#       dhcp:
#         relay:
#           address:
#             - relay_ip: 11.0.0.1
#               vrf_name: abc
#   - name: Ethernet1/2
#     ipv6:
#       addresses:
#         - ipv6_address: 2001:db8::1/32
#           route_preference: 70
#           tag: 97
#       dhcp:
#         relay:
#           address:
#             - relay_ip: 2001:db8::1:abcd

# Using gathered

# Before state:
# -------------
#
# interface Ethernet 1/1
#  mac-address 00:11:22:33:44:55
#  ip verify unicast source reachable-via any allow-default
#  ip dhcp relay address 11.0.0.1 use-vrf abc
# interface Ethernet 1/2
#  ipv6 dhcp relay address 2001:0db8::1:abcd
#  ipv6 address 2001:db8::1/32 route-preference 70 tag 97

- name: Gather l3_interfaces facts from the device using nxos_l3_interfaces
  cisco.nxos.nxos_l3_interfaces:
    state: gathered

# Task output
# -----------
#
# gathered:
#   - name: Ethernet1/1
#     mac_address: 0011.2233.4455
#     ipv4:
#       verify:
#         unicast:
#           source:
#             reachable_via:
#               mode: any
#               allow_default: true
#       dhcp:
#         relay:
#           address:
#             - relay_ip: 11.0.0.1
#               vrf_name: abc
#   - name: Ethernet1/2
#     ipv6:
#       addresses:
#         - ipv6_address: 2001:db8::1/32
#           route_preference: 70
#           tag: 97
#       dhcp:
#         relay:
#           address:
#             - relay_ip: 2001:db8::1:abcd

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже приведены поля, уникальные для этого модуля:

Ключ	Описание
after dictionary	Конфигурация после выполнения модуля. Возвращается: при наличии изменений Пример: `"This output will always be in the same format as the module argspec.\n"`
before dictionary	Конфигурация до выполнения модуля. Возвращается: если state имеет значение `merged`, `replaced`, `overridden`, `deleted` или `purged` Пример: `"This output will always be in the same format as the module argspec.\n"`
commands list / элементы=string	Набор команд, отправленных на удаленное устройство. Возвращается: если state имеет значение `merged`, `replaced`, `overridden`, `deleted` или `purged` Пример: `["ip dhcp relay address 11.0.0.1 use-vrf abc", "ipv6 address 2001:db8::1/32 route-preference 70 tag 97", "ipv6 dhcp relay address 2001:db8::1:abcd"]`
gathered list / элементы=string	Сведения о сетевом ресурсе, полученные с удаленного устройства в виде структурированных данных. Возвращается: если state имеет значение `gathered` Пример: `["This output will always be in the same format as the module argspec.\n"]`
parsed list / элементы=string	Исходная конфигурация устройства, переданная в параметре running_config и разобранная в структурированные данные в соответствии со спецификацией аргументов модуля. Возвращается: если state имеет значение `parsed` Пример: `["This output will always be in the same format as the module argspec.\n"]`
rendered list / элементы=string	Конфигурация, указанная в задаче и преобразованная в исходный формат устройства (без подключения). Возвращается: если state имеет значение `rendered` Пример: `["ip dhcp relay address 11.0.0.1 use-vrf abc", "ipv6 address 2001:db8::1/32 route-preference 70 tag 97", "ipv6 dhcp relay address 2001:db8::1:abcd"]`

Авторы

Trishna Guha (@trishnaguha)
Nikhil Bhasin (@nickbhasin)

Ссылки на коллекцию

© 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/nxos/nxos_l3_interfaces_module.html