Spec-Zone.ru › Ansible

Модуль cisco.nxos.nxos_vrf_interfaces — модуль ресурсов для настройки интерфейсов VRF.

Примечание

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

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

Для установки используйте: ansible-galaxy collection install cisco.nxos.

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

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

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

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

  • Этот модуль настраивает и управляет конфигурацией VRF на интерфейсах платформ NX-OS.

Примечание

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

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

Параметры

Параметр

Комментарии

config

list / elements=dictionary

Список конфигураций VRF интерфейсов.

name

string / обязательный

Полное имя интерфейса без номера логического канала, например Ethernet1/1.

vrf_name

string

Имя VRF, настраиваемой на интерфейсе.

При настройке применяет команду ‘vrf member <vrf_name>’ в контексте интерфейса.

running_config

string

Этот параметр используется только при значении состояния parsed.

Значением этого параметра должен быть вывод, полученный с устройства NX-OS при выполнении команды show running-config interface.

При состоянии parsed конфигурация считывается из параметра running_config и преобразуется в структурированные данные Ansible в соответствии со спецификацией аргументов модуля ресурсов; затем значение возвращается в ключе parsed результата.

state

string

Состояние, в котором должна остаться конфигурация

Варианты:

  • "merged" ← (по умолчанию)
  • "replaced"
  • "overridden"
  • "deleted"
  • "gathered"
  • "rendered"
  • "parsed"

Примечания

Примечание

  • Проверено на Cisco NX-OS.
  • Этот модуль работает с подключением network_cli.

Примеры

# Using merged

# Before state:
# -------------
#
# nxos#show running-config interface
# interface Ethernet1/1
#  no switchport
# interface Ethernet1/2
#  description test
#  no switchport
#  no shutdown
# interface Ethernet1/3
# interface Ethernet1/4
#  no switchport
#  speed 1000
#  no shutdown

- name: Merge provided configuration with device configuration
  cisco.nxos.nxos_vrf_interfaces:
    config:
      - name: Ethernet1/1
      - name: Ethernet1/2
        vrf_name: test
      - name: Ethernet1/3
      - name:Ethernet1/4
    state: merged

# Task Output:
# ------------
#
# before:
#   - name: "Ethernet1/1"
#   - name: "Ethernet1/2"
#   - name: "Ethernet1/3"
#   - name: "Ethernet1/4"
#
# commands:
#   - interface Ethernet1/2
#   - vrf member test
#
# after:
#   - name: "Ethernet1/1"
#   - name: "Ethernet1/2"
#     vrf_name: "test2"
#   - name: "Ethernet1/3"
#   - name: "Ethernet1/4"

# After state:
# ------------
#
# nxos#show running-config interface
# interface Ethernet1/1
#  no ip address
# interface Ethernet1/2
#  vrf member test
#  no ip address
#  shutdown
#  negotiation auto
# interface Ethernet1/3
#  no ip address
#  negotiation auto
# interfaceEthernet1/4
#  no ip address
#  shutdown
#  negotiation auto

# Using overridden

# Before state:
# -------------
#
# nxos#show running-config interface
# interface Ethernet1/1
#  no ip address
# interface Ethernet1/1
#  ip address dhcp
#  negotiation auto
# interface Ethernet1/2
#  vrf member vrf_B
#  no ip address
#  shutdown
#  negotiation auto
# interface Ethernet1/3
#  no ip address
#  negotiation auto
# interface Ethernet1/4
#  no ip address
#  shutdown
#  negotiation auto

- name: Override device configuration with provided configuration
  cisco.nxos.nxos_vrf_interfaces:
    config:
      - name: Ethernet1/1
      - name: Ethernet1/2
      - name: Ethernet1/3
      - name: Ethernet1/4
    state: overridden

# Task Output:
# ------------
#
# before:
#   - name: "Ethernet1/1"
#   - name: "Ethernet1/2"
#     vrf_name: "vrf_B"
#   - name: "Ethernet1/3"
#   - name: "Ethernet1/4"
#
# commands:
#   - interface Ethernet1/2
#   - no vrf member vrf_B
#
# after:
#   - name: "Ethernet1/1"
#   - name: "Ethernet1/2"
#   - name: "Ethernet1/3"
#   - name: "Ethernet1/4"

# After state:
# ------------
#
# nxos#show running-config interface
# interface Ethernet1/1
#  no ip address
# interface Ethernet1/2
#  no ip address
#  shutdown
#  negotiation auto
# interface Ethernet1/3
#  no ip address
#  negotiation auto
# interface Ethernet1/4
#  no ip address
#  shutdown
#  negotiation auto

# Using gathered

# Before state:
# -------------
#
# nxos#show running-config interface
# interface Ethernet1/1
#  no ip address
# interface Ethernet1/2
#  vrf member vrf_B
#  no ip address
#  shutdown
#  negotiation auto
# interface Ethernet1/3
#  no ip address
#  negotiation auto
# interfaceEthernet1/4
#  no ip address
#  shutdown
#  negotiation auto

- name: Gather listed VRF interfaces
  cisco.nxos.nxos_vrf_interfaces:
    state: gathered

# Task Output:
# ------------
#
# gathered:
#   - name: "Ethernet1/1"
#   - name: "Ethernet1/2"
#     vrf_name: "vrf_B"
#   - name: "Ethernet1/3"

# Using rendered

- name: Render VRF configuration
  cisco.nxos.nxos_vrf_interfaces:
    config:
      - name: Ethernet1/1
      - name: Ethernet1/2
        vrf_name: test
      - name: Ethernet1/3
      - name: Ethernet1/4
    state: rendered

# Task Output:
# ------------
#
# rendered:
#   - interface Ethernet1/2
#   - vrf member test

# Using parsed

# File: parsed.cfg
# ---------------
#
# interface Ethernet1/2
#   no switchport
#   vrf member VRF1
# interface Ethernet1/6
#   no switchport
#   speed 1000
#   vrf member TEST_VRF

- name: Parse configuration from device running config
  cisco.nxos.nxos_vrf_interfaces:
    running_config: "{{ lookup('file', 'parsed.cfg') }}"
    state: parsed

# Task Output:
# ------------
#
# parsed:
#   - name: "Ethernet1/2"
#     vrf_name: "VRF1"
#   - name: "Ethernet1/6"
#     vrf_name: "TEST_VRF"

# Using replaced

# Before state:
# -------------
#
# nxos#show running-config interface
# interface Ethernet1/1
#  no ip address
# interface Ethernet1/2
#  vrf member vrf_B
#  no ip address
#  shutdown
# interface Ethernet1/3
#  no ip address
# interfaceEthernet1/4
#  vrf member vrf_C
#  no ip address
#  shutdown

- name: Replace device configuration of listed VRF interfaces with provided configuration
  cisco.nxos.nxos_vrf_interfaces:
    config:
      - name: Ethernet1/1
        vrf_name: test
      - name: Ethernet1/2
        vrf_name: vrf_E
    state: replaced

# Task Output:
# ------------
#
# before:
#   - name: "Ethernet1/1"
#     vrf_name: "vrf_A"
#   - name: "Ethernet1/2"
#     vrf_name: "vrf_B"
#   - name: "Ethernet1/3"
#   - name: "Ethernet1/4"
#     vrf_name: "vrf_C"
#
# commands:
#   - interface Ethernet1/1
#   - no vrf member vrf_A
#   - vrf member test
#   - interface Ethernet1/2
#   - no vrf member vrf_B
#   - vrf member vrf_E
#
# after:
#   - name: "Ethernet1/1"
#     vrf_name: "test"
#   - name: "Ethernet1/2"
#     vrf_name: "vrf_E"
#   - name: "Ethernet1/3"
#   - name: "Ethernet1/4"
#     vrf_name: "vrf_C"

# Using deleted

# Before state:
# -------------
#
# nxos#show running-config interface
# interface Ethernet1/1
#  vrf member vrf_A
#  ip address dhcp
# interface Ethernet1/2
#  vrf member vrf_B
#  no ip address
#  shutdown
# interface Ethernet1/3
#  no ip address
# interfaceEthernet1/4
#  vrf member vrf_C
#  no ip address
#  shutdown

- name: Delete VRF configuration of specified interfaces
  cisco.nxos.nxos_vrf_interfaces:
    config:
      - name: Ethernet1/1
      - name: Ethernet1/2
    state: deleted

# Task Output:
# ------------
#
# before:
#   - name: "Ethernet1/1"
#     vrf_name: "vrf_A"
#   - name: "Ethernet1/2"
#     vrf_name: "vrf_B"
#   - name: "Ethernet1/3"
#   - name: "Ethernet1/4"
#     vrf_name: "vrf_C"
#
# commands:
#   - interface Ethernet1/1
#   - no vrf member vrf_A
#   - interface Ethernet1/2
#   - no vrf member vrf_B
#
# after:
#   - name: "Ethernet1/1"
#   - name: "Ethernet1/1"
#   - name: "Ethernet1/2"
#   - name: "Ethernet1/3"
#   - name: "Ethernet1/4"
#     vrf_name: "vrf_C"

# After state:
# ------------
#
# nxos#show running-config interface
# interface Ethernet1/1
#  ip address dhcp
# interface Ethernet1/2
#  no ip address
#  shutdown
# interface Ethernet1/3
#  no ip address
# interfaceEthernet1/4
#  vrf member vrf_C
#  no ip address
#  shutdown

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

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

Ключ

Описание

after

list / elements=string

Конфигурация после выполнения модуля.

Возвращается: если были изменения

Пример: ["[\n    {\n        \"name\": \"Ethernet1/1\"\n    }", "\n    {\n        \"name\": \"Ethernet1/2\"", "\n        \"vrf_name\": \"test\"\n    }", "\n    {\n        \"name\": \"Ethernet1/3\"\n    }", "\n    {\n        \"name\": \"Ethernet1/4\"\n    }\n]\n"]

before

list / elements=string

Конфигурация до выполнения модуля.

Возвращается: если значение state равно merged, replaced, overridden, deleted

Пример: ["[\n    {\n        \"name\": \"Ethernet1/1\"\n    }", "\n    {\n        \"name\": \"Ethernet1/2\"", "\n        \"vrf_name\": \"test\"\n    }", "\n    {\n        \"name\": \"Ethernet1/3\"\n    }", "\n    {\n        \"name\": \"Ethernet1/4\"\n    }\n]\n"]

commands

list / elements=string

Набор команд, отправленных на удалённое устройство.

Возвращается: если значение state равно merged, replaced, overridden, deleted

Пример: ["interface Ethernet1/2", "vrf member test", "no vrf member vrf_B"]

gathered

list / elements=string

Факты о сетевом ресурсе, собранные с удалённого устройства в виде структурированных данных.

Возвращается: если значение state равно gathered

Пример: ["[\n    {\n        \"name\": \"Ethernet1/1\"\n    }", "\n    {\n        \"name\": \"Ethernet1/2\"", "\n        \"vrf_name\": \"vrf_B\"\n    }", "\n    {\n        \"name\": \"Ethernet1/3\"\n    }", "\n    {\n        \"name\": \"Ethernet1/4\"\n    }\n]\n"]

parsed

list / elements=string

Собственная конфигурация устройства, переданная в параметре running_config и разобранная в структурированные данные согласно спецификации аргументов модуля.

Возвращается: если значение state равно parsed

Пример: ["[\n    {\n        \"name\": \"Ethernet1/1\"", "\n        \"vrf_name\": \"vrf_C\"\n    }", "\n    {\n        \"name\": \"Ethernet1/2\"", "\n        \"vrf_name\": \"test\"\n    }", "\n    {\n        \"name\": \"Ethernet1/3\"\n    }", "\n    {\n        \"name\": \"Ethernet1/4\"\n    }\n]\n"]

rendered

list / elements=string

Конфигурация, переданная в задаче и преобразованная в формат устройства (в автономном режиме).

Возвращается: если значение state равно rendered

Пример: ["interface Ethernet1/1", "vrf member vrf_C", "interface Ethernet1/2", "vrf member test"]

Авторы

  • Ruchi Pakhle (@Ruchip16)

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

  • Отслеживание проблем
  • Репозиторий (исходный код)

© 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_vrf_interfaces_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API