cisco.nxos.nxos_interfaces – Модуль ресурсов интерфейсов

Примечание

Этот плагин входит в коллекцию cisco.nxos (версия 1.4.0).

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

Для использования в playbook укажите: cisco.nxos.nxos_interfaces

Новый в версии 1.0.0: модуля cisco.nxos

Обзор
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

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

Примечание

У этого модуля есть соответствующий плагин действия.

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
config список / элементы=словарь			Словарь параметров интерфейса
	description строка		Описание интерфейса.
	duplex строка	Варианты: full half auto	Состояние соединения интерфейса. Применимо только для Ethernet-интерфейсов.
	enabled булево	Варианты: no yes	Административное состояние интерфейса. Установите значение в `true`, чтобы административно включить интерфейс, или `false`, чтобы отключить его.
	fabric_forwarding_anycast_gateway булево	Варианты: no yes	Связать SVI с шлюзом anycast в режиме конфигурации VLAN. Применимо только для интерфейсов SVI.
	ip_forward булево	Варианты: no yes	Включить или отключить функцию IP-передачи на SVI. Установите значение в `true`, чтобы включить, или `false`, чтобы отключить.
	mode строка	Варианты: layer2 layer3	Управление состоянием уровня 2 или уровня 3 интерфейса. Применимо только для Ethernet- и интерфейсов каналов портов.
	mtu строка		MTU для конкретного интерфейса. Должно быть чётным числом от 576 до 9216. Применимо только для Ethernet-интерфейсов.
	name строка / обязательно		Полное имя интерфейса, например, Ethernet1/1, port-channel10.
	speed строка		Скорость соединения интерфейса. Применимо только для Ethernet-интерфейсов.
running_config строка			Этот параметр используется только со значением состояния parsed. Значение этого параметра должно быть выводом с устройства NX-OS, полученным выполнением команды show running-config \| section ^interface Состояние parsed считывает конфигурацию из параметра `running_config` и преобразует её в структурированные данные Ansible в соответствии со спецификацией аргументов модуля ресурса, а затем возвращает значение в ключе parsed в результате.
state строка		Варианты: merged ← replaced overridden deleted gathered rendered parsed	Состояние конфигурации после завершения работы модуля Состояние rendered учитывает системный режим по умолчанию для интерфейсов как "Уровень 3" и системное состояние по умолчанию для интерфейсов как выключено.

Примечания

Примечание

Тестировалось на NXOS 7.3.(0)D1(1) на VIRL

Примеры

# Using merged

# Before state:
# -------------
#
# interface Ethernet1/1
#   description testing
#   mtu 1800

- name: Merge provided configuration with device configuration
  cisco.nxos.nxos_interfaces:
    config:
    - name: Ethernet1/1
      description: Configured by Ansible
      enabled: true
    - name: Ethernet1/2
      description: Configured by Ansible Network
      enabled: false
    state: merged

# After state:
# ------------
#
# interface Ethernet1/1
#    description Configured by Ansible
#    no shutdown
#    mtu 1800
# interface Ethernet2
#    description Configured by Ansible Network
#    shutdown


# Using replaced

# Before state:
# -------------
#
# interface Ethernet1/1
#    description Interface 1/1
# interface Ethernet1/2

- name: Replaces device configuration of listed interfaces with provided configuration
  cisco.nxos.nxos_interfaces:
    config:
    - name: Ethernet1/1
      description: Configured by Ansible
      enabled: true
      mtu: 2000
    - name: Ethernet1/2
      description: Configured by Ansible Network
      enabled: false
      mode: layer2
    state: replaced

# After state:
# ------------
#
# interface Ethernet1/1
#   description Configured by Ansible
#   no shutdown
#   mtu 1500
# interface Ethernet2/2
#    description Configured by Ansible Network
#    shutdown
#    switchport


# Using overridden

# Before state:
# -------------
#
# interface Ethernet1/1
#    description Interface Ethernet1/1
# interface Ethernet1/2
# interface mgmt0
#    description Management interface
#    ip address dhcp

- name: Override device configuration of all interfaces with provided configuration
  cisco.nxos.nxos_interfaces:
    config:
    - name: Ethernet1/1
      enabled: true
    - name: Ethernet1/2
      description: Configured by Ansible Network
      enabled: false
    state: overridden

# After state:
# ------------
#
# interface Ethernet1/1
# interface Ethernet1/2
#    description Configured by Ansible Network
#    shutdown
# interface mgmt0
#    ip address dhcp


# Using deleted

# Before state:
# -------------
#
# interface Ethernet1/1
#    description Interface Ethernet1/1
# interface Ethernet1/2
# interface mgmt0
#    description Management interface
#    ip address dhcp

- name: Delete or return interface parameters to default settings
  cisco.nxos.nxos_interfaces:
    config:
    - name: Ethernet1/1
    state: deleted

# After state:
# ------------
#
# interface Ethernet1/1
# interface Ethernet1/2
# interface mgmt0
#    description Management interface
#    ip address dhcp

# Using rendered

- name: Use rendered state to convert task input to device specific commands
  cisco.nxos.nxos_interfaces:
    config:
    - name: Ethernet1/1
      description: outbound-intf
      mode: layer3
      speed: 100
    - name: Ethernet1/2
      mode: layer2
      enabled: true
      duplex: full
    state: rendered

# Task Output (redacted)
# -----------------------

# rendered:
#   - "interface Ethernet1/1"
#   - "description outbound-intf"
#   - "speed 100"
#   - "interface Ethernet1/2"
#   - "switchport"
#   - "duplex full"
#   - "no shutdown"

# Using parsed

# parsed.cfg
# ------------
# interface Ethernet1/800
#   description test-1
#   speed 1000
#   shutdown
#   no switchport
#   duplex half
# interface Ethernet1/801
#   description test-2
#   switchport
#   no shutdown
#   mtu 1800

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

# Task output (redacted)
# -----------------------
#  parsed:
#    - description: "test-1"
#      duplex: "half"
#      enabled: false
#      mode: "layer3"
#      name: "Ethernet1/800"
#      speed: "1000"
#
#    - description: "test-2"
#      enabled: true
#      mode: "layer2"
#      mtu: "1800"
#      name: "Ethernet1/801"

# Using gathered

# Existing device config state
# -----------------------------
# interface Ethernet1/1
#   description outbound-intf
#   switchport
#   no shutdown
# interface Ethernet1/2
#   description intf-l3
#   speed 1000
# interface Ethernet1/3
# interface Ethernet1/4
# interface Ethernet1/5

- name: Gather interfaces facts from the device using nxos_interfaces
  cisco.nxos.nxos_interfaces:
    state: gathered

# Task output (redacted)
# -----------------------
# - name: Ethernet1/1
#   description: outbound-intf
#   mode: layer2
#   enabled: True
# - name: Ethernet1/2
#   description: intf-l3
#   speed: "1000"

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

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

Ключ	Возвращаемое значение	Описание
after список / элементы=строка	при изменении	Конфигурация в виде структурированных данных после завершения модуля. Пример: Возвращаемая конфигурация всегда будет в том же формате, что и параметры выше.
before список / элементы=строка	всегда	Конфигурация в виде структурированных данных до вызова модуля. Пример: Возвращаемая конфигурация всегда будет в том же формате, что и параметры выше.
commands список / элементы=строка	всегда	Набор команд, отправленных на удаленное устройство. Пример: ['interface Ethernet1/1', 'mtu 1800']

Авторы

Trishna Guha (@trishnaguha)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/cisco/nxos/nxos_interfaces_module.html