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

Примечание

Этот модуль входит в коллекцию arista.eos (версия 9.0.0).

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

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

Чтобы использовать его в playbook, укажите: arista.eos.eos_interfaces.

Добавлен в arista.eos 1.0.0

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

Описание

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

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

Параметры

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

Примечания

Примечание

Проверено на Arista EOS 4.24.6F
Этот модуль работает с подключением network_cli. См. https://docs.ansible.com/ansible/latest/network/user_guide/platform_eos.html

Примеры

# Using merged

# Before state:
# -------------
#
# test#show running-config | section interface
# interface Ethernet1
# !
# interface Ethernet2
# !
# interface Management1
#    ip address dhcp
#    dhcp client accept default-route

- 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

# Task Output
# -----------
#
# before:
# - enabled: true
#   name: Ethernet1
# - enabled: true
#   name: Ethernet2
# - enabled: true
#   name: Management1
# commands:
# - interface Ethernet1
# - no switchport
# - interface Ethernet2
# - shutdown
# - description Configured by Ansible
# after:
# - enabled: true
#   mode: layer3
#   name: Ethernet1
# - description: Configured by Ansible
#   enabled: false
#   name: Ethernet2
# - enabled: true
#   name: Management1

# After state:
# ------------
#
# test#show running-config | section interface
# interface Ethernet1
#    no switchport
# !
# interface Ethernet2
#    description Configured by Ansible
#    shutdown
# !
# interface Management1
#    ip address dhcp
#    dhcp client accept default-route

# Using replaced

# Before state:
# -------------
#
# test#show running-config | section interface
# interface Ethernet1
#    no switchport
# !
# interface Ethernet2
#    description Configured by Ansible
#    shutdown
# !
# interface Management1
#    ip address dhcp
#    dhcp client accept default-route

- 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

# Task Output
# -----------
#
# before:
# - enabled: true
#   mode: layer3
#   name: Ethernet1
# - description: Configured by Ansible
#   enabled: false
#   name: Ethernet2
# - enabled: true
#   name: Management1
# commands:
# - interface Ethernet1
# - switchport
# after:
# - enabled: true
#   name: Ethernet1
# - description: Configured by Ansible
#   enabled: false
#   name: Ethernet2
# - enabled: true
#   name: Management1

# After state:
# ------------
#
# test#show running-config | section interface
# interface Ethernet1
# !
# interface Ethernet2
#    description Configured by Ansible
#    shutdown
# !
# interface Management1
#    ip address dhcp
#    dhcp client accept default-route

# Using overridden

# Before state:
# -------------
#
# test#show running-config | section interface
# interface Ethernet1
# !
# interface Ethernet2
#    description Configured by Ansible
#    shutdown
# !
# interface Management1
#    ip address dhcp
#    dhcp client accept default-route

- 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

# Task Output
# -----------
#
# before:
# - enabled: true
#   name: Ethernet1
# - description: Configured by Ansible
#   enabled: false
#   name: Ethernet2
# - enabled: true
#   name: Management1
# commands:
# - interface Management1
# - no shutdown
# after:
# - enabled: true
#   name: Ethernet1
# - description: Configured by Ansible
#   enabled: false
#   name: Ethernet2
# - enabled: true
#   name: Management1

# After state:
# ------------
#
# test#show running-config | section interface
# interface Ethernet1
# !
# interface Ethernet2
#    description Configured by Ansible
#    shutdown
# !
# interface Management1
#    ip address dhcp
#    dhcp client accept default-route

# Using deleted

# Before state:
# -------------
#
# test#show running-config | section interface
# interface Ethernet1
# !
# interface Ethernet2
#    description Configured by Ansible
#    shutdown
# !
# interface Management1
#    ip address dhcp
#    dhcp client accept default-route

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

# Task Output
# -----------
#
# before:
# - enabled: true
#   name: Ethernet1
# - description: Configured by Ansible
#   enabled: false
#   name: Ethernet2
# - enabled: true
#   name: Management1
# commands:
# - interface Ethernet1
# - no shutdown
# after:
# - enabled: true
#   name: Ethernet1
# - description: Configured by Ansible
#   enabled: false
#   name: Ethernet2
# - enabled: true
#   name: Management1

# After state:
# ------------
#
# test#show running-config | section interface
# interface Ethernet1
# !
# interface Ethernet2
#    description Configured by Ansible
#    shutdown
# !
# interface Management1
#    ip address dhcp
#    dhcp client accept default-route

# Using rendered

- name: Render the provided configuration into platform specific configuration lines
  arista.eos.eos_interfaces:
    config:
      - name: Ethernet1
        enabled: true
        mode: layer3
      - name: Ethernet2
        description: Configured by Ansible
        enabled: false
    state: rendered

# Module Execution Result:
# ------------------------
#
# rendered:
# - interface Ethernet1
# - no shutdown
# - no switchport
# - interface Ethernet2
# - shutdown
# - description Configured by Ansible

# Using Parsed

# File: parsed.cfg
# ----------------
#
# interface Ethernet1
#    description "Interface 1"
# !
# interface Ethernet2
#    description "Configured by Ansible"
#    shutdown
# !

- name: Parse the commands for provided configuration
  arista.eos.interfaces:
    running_config: "{{ lookup('file', 'parsed.cfg') }}"
    state: parsed

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

# Using Gathered

# Before state:
# -------------
#
# test#show running-config | section interface
# interface Ethernet1
# !
# interface Ethernet2
#    description Configured by Ansible
#    shutdown
# !
# interface Management1
#    ip address dhcp
#    dhcp client accept default-route

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

# Module Execution Result:
# ------------------------
#
# gathered:
# - enabled: true
#   name: Ethernet1
# - description: Configured by Ansible
#   enabled: false
#   name: Ethernet2
# - enabled: true
#   name: Management1

Значения возврата

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

Ключ	Описание
after словарь	Результирующая конфигурация после выполнения модуля. Возвращается: при изменении Пример: `"This output will always be in the same format as the module argspec.\n"`
before словарь	Конфигурация до выполнения модуля. Возвращается: когда состояние равно `merged`, `replaced`, `overridden`, `deleted` или `purged` Пример: `"This output will always be in the same format as the module argspec.\n"`
commands список / элементы=строка	Набор команд, отправленных на удаленное устройство. Возвращается: когда состояние равно `merged`, `replaced`, `overridden`, `deleted` или `purged` Пример: `["interface Ethernet1", "no shutdown", "no switchport"]`
gathered список / элементы=строка	Факты о сетевом ресурсе, собранные с удаленного устройства в виде структурированных данных. Возвращается: когда состояние равно `gathered` Пример: `["This output will always be in the same format as the module argspec.\n"]`
parsed список / элементы=строка	Родная конфигурация устройства из параметра running_config, разобранная в структурированные данные в соответствии со спецификацией аргументов модуля. Возвращается: когда состояние равно `parsed` Пример: `["This output will always be in the same format as the module argspec.\n"]`
rendered список / элементы=строка	Предоставленная конфигурация в задаче, представленная в формате устройства (офлайн). Возвращается: когда состояние равно `rendered` Пример: `["interface Ethernet1", "no shutdown", "no switchport"]`

Авторы

Nathaniel Case (@Qalthos)

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

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/arista/eos/eos_interfaces_module.html