arista.eos.eos_interfaces – Модуль ресурсов интерфейсов

Примечание

Этот плагин входит в коллекцию arista.eos (версия 1.3.0).

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

Для использования в плейбуке укажите: arista.eos.eos_interfaces.

Новый в версии 1.0.0: модуль arista.eos

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

Обзор

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

Примечание

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
config список / элементы=словарь			Предоставленная конфигурация
	description строка		Описание интерфейса
	duplex строка		Состояние связи интерфейса. Применимо только для Ethernet-интерфейсов. Значения, отличные от `auto`, также должны задавать speed. Игнорируется, когда speed задано выше `1000`.
	enabled булево	Варианты: нет да ←	Административное состояние интерфейса. Установите значение `true` для административного включения интерфейса или `false` для отключения.
	mode строка	Варианты: layer2 layer3	Управление состоянием Layer2 или Layer3 интерфейса. Применимо только для Ethernet- и интерфейсов канала связи.
	mtu целое число		MTU для определенного интерфейса. Должно быть чётным числом от 576 до 9216. Применимо только для Ethernet-интерфейсов.
	name строка / обязательно		Полное имя интерфейса, например, GigabitEthernet1.
	speed строка		Скорость интерфейса. Применимо только для Ethernet-интерфейсов.
running_config строка			Этот параметр используется только со значением parsed. Значение этого параметра должно быть результатом выполнения команды show running-config \| section ^interface на устройстве EOS. Значение parsed считывает конфигурацию из параметра `running_config` и преобразует её в структурированные данные Ansible в соответствии с argspec модуля ресурса, а затем возвращает значение в ключе parsed в результате.
state строка		Варианты: merged ← replaced overridden deleted parsed rendered gathered	Состояние конфигурации после завершения модуля.

Примечания

Примечание

Проверено на Arista EOS 4.20.10M
Этот модуль работает с подключением network_cli. См. Параметры платформы EOS.

Примеры

# Using merged

# Before state:
# -------------
#
# veos#show running-config | section interface
# interface Ethernet1
#    description "Interface 1"
# !
# interface Ethernet2
# !
# interface Management1
#    description "Management interface"
#    ip address dhcp
# !

- name: Merge provided configuration with device configuration
  arista.eos.eos_interfaces:
    config:
    - name: Ethernet1
      enabled: true
      mode: layer3
    - name: Ethernet2
      description: Configured by Ansible
      enabled: false
    state: merged

# After state:
# ------------
#
# veos#show running-config | section interface
# interface Ethernet1
#    description "Interface 1"
#    no switchport
# !
# interface Ethernet2
#    description "Configured by Ansible"
#    shutdown
# !
# interface Management1
#    description "Management interface"
#    ip address dhcp
# !

# Using replaced

# Before state:
# -------------
#
# veos#show running-config | section interface
# interface Ethernet1
#    description "Interface 1"
# !
# interface Ethernet2
# !
# interface Management1
#    description "Management interface"
#    ip address dhcp
# !

- name: Replaces device configuration of listed interfaces with provided configuration
  arista.eos.eos_interfaces:
    config:
    - name: Ethernet1
      enabled: true
    - name: Ethernet2
      description: Configured by Ansible
      enabled: false
    state: replaced

# After state:
# ------------
#
# veos#show running-config | section interface
# interface Ethernet1
# !
# interface Ethernet2
#    description "Configured by Ansible"
#    shutdown
# !
# interface Management1
#    description "Management interface"
#    ip address dhcp
# !

# Using overridden

# Before state:
# -------------
#
# veos#show running-config | section interface
# interface Ethernet1
#    description "Interface 1"
# !
# interface Ethernet2
# !
# interface Management1
#    description "Management interface"
#    ip address dhcp
# !

- name: Overrides all device configuration with provided configuration
  arista.eos.eos_interfaces:
    config:
    - name: Ethernet1
      enabled: true
    - name: Ethernet2
      description: Configured by Ansible
      enabled: false
    state: overridden

# After state:
# ------------
#
# veos#show running-config | section interface
# interface Ethernet1
# !
# interface Ethernet2
#    description "Configured by Ansible"
#    shutdown
# !
# interface Management1
#    ip address dhcp
# !

# Using deleted

# Before state:
# -------------
#
# veos#show running-config | section interface
# interface Ethernet1
#    description "Interface 1"
#    no switchport
# !
# interface Ethernet2
# !
# interface Management1
#    description "Management interface"
#    ip address dhcp
# !

- name: Delete or return interface parameters to default settings
  arista.eos.eos_interfaces:
    config:
    - name: Ethernet1
    state: deleted

# After state:
# ------------
#
# veos#show running-config | section interface
# interface Ethernet1
# !
# interface Ethernet2
# !
# interface Management1
#    description "Management interface"
#    ip address dhcp
# !

# Using rendered

- name: Use Rendered to convert the structured data to native config
  arista.eos.eos_interfaces:
    config:
    - name: Ethernet1
      enabled: true
      mode: layer3
    - name: Ethernet2
      description: Configured by Ansible
      enabled: false
    state: merged

# Output:
# ------------

# - "interface Ethernet1"
# - "description "Interface 1""
# - "no swithcport"
# - "interface Ethernet2"
# - "description "Configured by Ansible""
# - "shutdown"
# - "interface Management1"
# - "description "Management interface""
# - "ip address dhcp"

# Using parsed
# parsed.cfg

# interface Ethernet1
#    description "Interface 1"
# !
# interface Ethernet2
#    description "Configured by Ansible"
#    shutdown
# !

- name: Use parsed to convert native configs to structured data
  arista.eos.interfaces:
    running_config: "{{ lookup('file', 'parsed.cfg') }}"
    state: parsed

# Output
# parsed:
#     - name: Ethernet1
#       enabled: True
#       mode: layer2
#     - name: Ethernet2
#       description: 'Configured by Ansible'
#       enabled: False
#       mode: layer2

# Using gathered:

# Existing config on the device
# -----------------------------
# interface Ethernet1
#    description "Interface 1"
# !
# interface Ethernet2
#    description "Configured by Ansible"
#    shutdown
# !

- name: Gather interfaces facts from the device
  arista.eos.interfaces:
    state: gathered

# output
# gathered:
#      - name: Ethernet1
#        enabled: True
#        mode: layer2
#      - name: Ethernet2
#        description: 'Configured by Ansible'
#        enabled: False
#        mode: layer2

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

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

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

Авторы

Nathaniel Case (@qalthos)

© 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/arista/eos/eos_interfaces_module.html