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

Примечание

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

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

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

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

Новый модуль в cisco.nxos 1.0.0

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

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

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

Примечание

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

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

Параметры

Параметр	Комментарии
config список / элементы=словарь	Словарь параметров интерфейса
description строка	Описание интерфейса.
duplex строка	Состояние линии интерфейса. Применимо только к интерфейсам Ethernet. Варианты: `"full"` `"half"` `"auto"`
enabled логическое значение	Административное состояние интерфейса. Задайте значение `true`, чтобы административно включить интерфейс, или `false`, чтобы отключить его Варианты: `false` `true`
fabric_forwarding_anycast_gateway логическое значение	Связать SVI со шлюзом anycast в режиме настройки VLAN. Применимо только к интерфейсам SVI. Варианты: `false` `true`
ip_forward логическое значение	Включить или отключить функцию IP forwarding на SVI. Задайте значение `true`, чтобы включить ее, или `false`, чтобы отключить. Варианты: `false` `true`
logging словарь	Журналирование событий интерфейса
link_status логическое значение	Сообщения UPDOWN и CHANGE Варианты: `false` `true`
trunk_status логическое значение	Сообщения о состоянии TRUNK Варианты: `false` `true`
mac_address строка	MAC-адрес в формате E.E.E.
mode строка	Управление состоянием интерфейса уровня 2 или уровня 3. Применимо только к интерфейсам Ethernet и port channel. Варианты: `"layer2"` `"layer3"`
mtu строка	MTU для конкретного интерфейса. Должно быть четным числом от 576 до 9216. Применимо только к интерфейсам Ethernet.
name строка / обязательный	Полное имя интерфейса, например Ethernet1/1, port-channel10.
service_policy словарь	Настройка политики обслуживания
input строка	Назначить policy-map входящему трафику интерфейса
output строка	Назначить policy-map исходящему трафику интерфейса
type_options словарь	Указать тип этой политики
qos словарь	Настроить политику обслуживания QoS
input строка	Назначить policy-map входящему трафику интерфейса
output строка	Назначить policy-map исходящему трафику интерфейса
queuing словарь	Настроить политику обслуживания очередей
input строка	Назначить policy-map входящему трафику интерфейса
output строка	Назначить policy-map исходящему трафику интерфейса
snmp словарь	Изменить параметры SNMP-интерфейса
trap словарь	Разрешить определенную SNMP-ловушку
link_status логическое значение	Разрешить ловушки SNMP LINKUP и LINKDOWN (snmp trap link-status permit duplicates) Варианты: `false` `true`
speed строка	Скорость линии интерфейса. Применимо только к интерфейсам Ethernet.
running_config строка	Этот параметр используется только при состоянии parsed. Значением этого параметра должен быть вывод, полученный с устройства NX-OS при выполнении команды show running-config \| section ^interface Состояние parsed считывает конфигурацию из параметра `running_config` и преобразует ее в структурированные данные Ansible согласно спецификации аргументов модуля ресурса; затем значение возвращается в ключе parsed результата.
state строка	Состояние конфигурации после выполнения модуля Для состояния rendered режим интерфейсов по умолчанию в системе считается «уровнем 3», а состояние интерфейсов по умолчанию — выключенным. Состояние purged удаляет из running-config виртуальные интерфейсы, указанные в задаче. Варианты: `"merged"` ← (по умолчанию) `"replaced"` `"overridden"` `"deleted"` `"gathered"` `"rendered"` `"parsed"` `"purged"`

Примечания

Примечание

Проверено на NXOS 10.4(2) в CML
Не поддерживается для Cisco MDS
Этот модуль предполагает, что устройство настроено с поведением switchport по умолчанию, в частности, что system default switchport shutdown не включен. Если на устройстве включен system default switchport shutdown, модуль будет работать некорректно. Единственное решение — вернуть настройку устройства по умолчанию с помощью no system default switchport shutdown. В настоящее время для устройств с такой нестандартной конфигурацией обходного решения нет.

Примеры

# Using merged

# Before state:
# -------------
#
# switch# show running-config | section interface
# interface Ethernet1/1
#   description testing
# interface mgmt0
#   description mgmt interface
#   ip address dhcp
#   vrf member management

- 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

# Task Output
# -----------
#
# before:
# - description: testing
#   name: Ethernet1/1
# - description: mgmt interface
#   name: mgmt0
# commands:
# - interface Ethernet1/1
# - description Configured by Ansible
# - interface Ethernet1/2
# - description Configured by Ansible Network
# - shutdown
# after:
# - description: Configured by Ansible
#   name: Ethernet1/1
# - description: Configured by Ansible Network
#   enabled: false
#   name: Ethernet1/2
# - description: mgmt interface
#   name: mgmt0

# After state:
# ------------
#
# switch# show running-config | section interface
# interface Ethernet1/1
#   description Configured by Ansible
# interface Ethernet1/2
#   description Configured by Ansible Network
#   shutdown
# interface mgmt0
#   description mgmt interface
#   ip address dhcp
#   vrf member management

# Using replaced

# Before state:
# -------------
#
# switch# show running-config | section interface
# interface Ethernet1/1
#   description Updated by Ansible
# interface Ethernet1/2
#   description Configured by Ansible Network
#   shutdown
# interface mgmt0
#   description mgmt interface
#   ip address dhcp
#   vrf member management

- 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: 9000
      - name: Ethernet1/2
        description: Configured by Ansible Network
        enabled: false
        mode: layer2
    state: replaced

# Task Output
# -----------
#
# before:
# - description: Updated by Ansible
#   name: Ethernet1/1
# - description: Configured by Ansible Network
#   enabled: false
#   name: Ethernet1/2
# - description: mgmt interface
#   name: mgmt0
# commands:
# - interface Ethernet1/1
# - mtu 1500
# - interface Ethernet1/2
# - description Updated by Ansible
# after:
# - description: Updated by Ansible
#   name: Ethernet1/1
# - description: Updated by Ansible
#   enabled: false
#   name: Ethernet1/2
# - description: mgmt interface
#   name: mgmt0

# After state:
# ------------
#
# switch# show running-config | section interface
# interface Ethernet1/1
#   description Updated by Ansible
# interface Ethernet1/2
#   description Updated by Ansible
#   shutdown
# interface mgmt0
#   description mgmt interface
#   ip address dhcp
#   vrf member management

# Using overridden

# Before state:
# -------------
#
# switch# show running-config | section interface
# interface Ethernet1/1
#   description Updated by Ansible
# interface Ethernet1/2
#   description Updated by Ansible
#   shutdown
# interface mgmt0
#   description mgmt interface
#   ip address dhcp
#   vrf member management

- 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
      - description: mgmt interface
        name: mgmt0
    state: overridden

# Task Output
# -----------
#
# before:
# - description: Updated by Ansible
#   name: Ethernet1/1
# - description: Updated by Ansible
#   enabled: false
#   name: Ethernet1/2
# - description: mgmt interface
#   name: mgmt0
# commands:
# - interface Ethernet1/1
# - no description
# - interface Ethernet1/2
# - description Configured by Ansible Network
# after:
# - name: Ethernet1/1
# - description: Configured by Ansible Network
#   enabled: false
#   name: Ethernet1/2
# - description: mgmt interface
#   name: mgmt0

# After state:
# ------------
#
# switch# show running-config | section interface
# interface Ethernet1/1
# interface Ethernet1/2
#   description Configured by Ansible Network
#   shutdown
# interface mgmt0
#   description mgmt interface
#   ip address dhcp
#   vrf member management

# Using deleted

# Before state:
# -------------
#
# switch# show running-config | section interface
# interface Ethernet1/1
# interface Ethernet1/2
#   description Configured by Ansible Network
#   shutdown
# interface mgmt0
#   description mgmt interface
#   ip address dhcp
#   vrf member management

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

# Task Output
# -----------
#
# before:
# - name: Ethernet1/1
# - description: Configured by Ansible Network
#   enabled: false
#   name: Ethernet1/2
# - description: mgmt interface
#   name: mgmt0
# commands:
# - interface Ethernet1/2
# - no description
# - no shutdown
# after:
# - name: Ethernet1/1
# - name: Ethernet1/2
# - description: mgmt interface
#   name: mgmt0

# After state:
# ------------
#
# switch# show running-config | section interface
# interface Ethernet1/1
# interface Ethernet1/2
# interface mgmt0
#   description mgmt interface
#   ip address dhcp
#   vrf member management

# 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
# -----------
#
# 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
# -----------
#
#  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

# Before state:
# -------------
#
# switch# show running-config | section interface
# 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
# -----------
#
# - name: Ethernet1/1
#   description: outbound-intf
#   mode: layer2
#   enabled: True
# - name: Ethernet1/2
#   description: intf-l3
#   speed: "1000"

# Using purged

# Before state:
# -------------
#
# switch# show running-config | section interface
# interface Vlan1
# interface Vlan42
#   mtu 1800
# interface port-channel10
# interface port-channel11
# interface Ethernet1/1
# interface Ethernet1/2
# interface Ethernet1/2.100
#   description sub-intf

- name: Purge virtual interfaces from running-config
  cisco.nxos.nxos_interfaces:
    config:
      - name: Vlan42
      - name: port-channel10
      - name: Ethernet1/2.100
    state: purged

# Task output
# ------------
#
# before:
#   - name: Vlan1
#   - mtu: '1800'
#     name: Vlan42
#   - name: port-channel10
#   - name: port-channel11
#   - name: Ethernet1/1
#   - name: Ethernet1/2
#   - description: sub-intf
#     name: Ethernet1/2.100
# commands:
#   - no interface port-channel10
#   - no interface Ethernet1/2.100
#   - no interface Vlan42
# after:
#   - name: Vlan1
#   - name: port-channel11
#   - name: Ethernet1/1
#   - name: Ethernet1/2

# After state:
# -------------
#
# switch# show running-config | section interface
# interface Vlan1
# interface port-channel11
# interface Ethernet1/1
# interface Ethernet1/2

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

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

Ключ	Описание
after список / элементы=строка	Конфигурация в виде структурированных данных после выполнения модуля. Возвращается: при изменении Пример: `["The configuration returned will always be in the same format of the parameters above.\n"]`
before список / элементы=строка	Конфигурация в виде структурированных данных до вызова модуля. Возвращается: всегда Пример: `["The configuration returned will always be in the same format of the parameters above.\n"]`
commands список / элементы=строка	Набор команд, отправленных на удаленное устройство. Возвращается: всегда Пример: `["interface Ethernet1/1", "mtu 1800"]`

Авторы

Trishna Guha (@trishnaguha)
Vinay Mulugund (@roverflow)

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

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