Spec-Zone.ru › Ansible 2.11

arista.eos.eos_interface – (deprecated, removed after 2022-06-01) Управление интерфейсом на устройствах Arista EOS

Примечание

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

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

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

Новое в версии 1.0.0: из arista.eos

  • УСТАРЕВШИЙ
  • Описание
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения
  • Статус

УСТАРЕВШИЙ

Удалено в

основной версии после 2022-06-01

Почему

Выпущены обновленные модули с большей функциональностью

Альтернатива

eos_interfaces

Описание

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

Примечание

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

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
aggregate
список / элементы=словарь
Список определений интерфейсов. Каждый элемент в списке aggregate должен определять имя интерфейса name и другие необходимые параметры.
delay
целое число
По умолчанию:
10
Время в секундах ожидания перед проверкой операционного состояния на удалённом устройстве. Это ожидание применяется к аргументу операционного состояния, который является state со значениями up/down, tx_rate и rx_rate.
description
строка
Описание интерфейса до 240 символов.
enabled
булево
    Варианты:
  • нет
  • да
Статус соединения интерфейса. Если значение True, состояние интерфейса будет включено, в противном случае, если значение False, интерфейс будет отключён (выключен).
mtu
строка
Устанавливает максимальный размер блока передачи (MTU) в байтах для передающего пакета интерфейса, указанного в параметре name.
name
строка / обязательно
Имя интерфейса для конфигурации на удалённом устройстве. Имя интерфейса должно быть в полном формате, а не сокращённым.
neighbors
список / элементы=словарь
Проверка операционного состояния данного интерфейса name для соседа LLDP.
Доступны следующие подпараметры.
host
строка
Хост соседа LLDP для данного интерфейса name.
port
строка
Порт соседа LLDP, к которому подключен данный интерфейс name.
rx_rate
строка
Скорость приёма в битах в секунду (bps) для интерфейса, указанного в параметре name.
Этот параметр предназначен только для проверки состояния.
Поддерживает условные выражения, см. Условные выражения в сетевых модулях
speed
строка
Этот параметр настраивает autoneg и скорость/дуплекс/flowcontrol для интерфейса, указанного в параметре name.
state
строка
    Варианты:
  • present
  • absent
  • up
  • down
Состояние конфигурации интерфейса, up означает присутствие и операционную активность, а down означает присутствие и операционное down
tx_rate
строка
Скорость передачи в битах в секунду (bps) для интерфейса, указанного в параметре name.
Этот параметр предназначен только для проверки состояния.
Поддерживает условные выражения, см. Условные выражения в сетевых модулях
delay
целое число
По умолчанию:
10
Время в секундах ожидания перед проверкой операционного состояния на удалённом устройстве. Это ожидание применяется к аргументу операционного состояния, который является state со значениями up/down, tx_rate и rx_rate.
description
строка
Описание интерфейса до 240 символов.
enabled
булево
    Варианты:
  • нет
  • да ←
Статус соединения интерфейса. Если значение True, состояние интерфейса будет включено, в противном случае, если значение False, интерфейс будет отключён (выключен).
mtu
строка
Устанавливает максимальный размер блока передачи (MTU) в байтах для передающего пакета интерфейса, указанного в параметре name.
name
строка
Имя интерфейса для конфигурации на удалённом устройстве. Имя интерфейса должно быть в полном формате, а не сокращённым.
neighbors
список / элементы=словарь
Проверка операционного состояния данного интерфейса name для соседа LLDP.
Доступны следующие подпараметры.
host
строка
Хост соседа LLDP для данного интерфейса name.
port
строка
Порт соседа LLDP, к которому подключен данный интерфейс name.
provider
словарь
Устарело
Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli.
Начиная с Ansible 2.6, рекомендуется использовать connection: httpapi для eAPI.
Этот параметр будет удалён в релизе после 2022-06-01.
Для получения дополнительной информации, см. руководство по параметрам платформы EOS EOS Platform Options guide.
Объект словаря, содержащий детали соединения.
auth_pass
строка
Указывает пароль для входа в привилегированный режим на удалённом устройстве, если это необходимо. Если authorize ложно, то этот аргумент ничего не делает. Если значение не указано в задаче, вместо него используется значение переменной окружения ANSIBLE_NET_AUTH_PASS.
authorize
булево
    Варианты:
  • нет ←
  • да
Указывает модулю войти в привилегированный режим на удалённом устройстве перед отправкой команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, вместо него используется значение переменной окружения ANSIBLE_NET_AUTHORIZE.
host
строка
Указывает имя хоста DNS или адрес для подключения к удалённому устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта.
password
строка
Указывает пароль для аутентификации подключения к удалённому устройству. Это общий аргумент, используемый для транспортов cli или eapi. Если значение не указано в задаче, вместо него используется значение переменной окружения ANSIBLE_NET_PASSWORD.
port
целое число
По умолчанию:
0
Указывает порт для использования при построении подключения к удалённому устройству. Это значение применяется к транспорту cli или eapi.
Значение порта будет по умолчанию соответствовать стандартному порту транспорта, если не указано в задаче (cli=22, http=80, https=443).
ssh_keyfile
путь
Указывает SSH-ключевой файл для аутентификации подключения к удалённому устройству. Этот аргумент используется только для транспортов cli. Если значение не указано в задаче, вместо него используется значение переменной окружения ANSIBLE_NET_SSH_KEYFILE.
timeout
целое число
Указывает тайм-аут в секундах для связи с сетевым устройством при подключении или отправке команд. Если тайм-аут превышен до завершения операции, модуль выдаст ошибку.
transport
строка
    Варианты:
  • cli ←
  • eapi
Настраивает транспортное соединение для подключения к удалённому устройству.
use_proxy
булево
    Варианты:
  • нет
  • да ←
Если no, переменные среды http_proxy и https_proxy будут проигнорированы.
use_ssl
булево
    Варианты:
  • нет
  • да ←
Настраивает transport для использования SSL, если установлено yes только в случае, когда transport=eapi. Если аргумент transport не eapi, это значение игнорируется.
username
строка
Настраивает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации входа CLI или аутентификации eAPI в зависимости от используемого транспорта. Если значение не указано в задаче, вместо него используется значение переменной окружения ANSIBLE_NET_USERNAME.
validate_certs
boolean
    Варианты:
  • no
  • да ←
Если no, сертификаты SSL не будут проверены. Это следует использовать только на сайтах, контролируемых лично, которые используют самозаверенные сертификаты. Если аргумент transport не eapi, это значение игнорируется.
rx_rate
string
Скорость приёма в битах в секунду (бит/с) для интерфейса, указанного в опции name.
Это параметр только для проверки состояния.
Поддерживает условные выражения, см. Условные выражения в сетевых модулях
speed
string
Эта опция настраивает autoneg и скорость/дуплекс/flowcontrol для интерфейса, указанного в опции name.
state
string
    Варианты:
  • present ←
  • absent
  • up
  • down
Состояние конфигурации интерфейса, up означает присутствие и операционную активность, а down означает присутствие и операционную down.
tx_rate
string
Скорость передачи в битах в секунду (бит/с) для интерфейса, указанного в опции name.
Это параметр только для проверки состояния.
Поддерживает условные выражения, см. Условные выражения в сетевых модулях

Примечания

Примечание

  • Тестировалось с EOS 4.15
  • Для получения информации о работе с CLI, eAPI и привилегированным режимом обратитесь к руководству EOS Platform Options
  • Для получения более подробной информации о использовании Ansible для управления сетевыми устройствами, обратитесь к руководству Руководство по Ansible Network
  • Для получения более подробной информации о использовании Ansible для управления устройствами Arista EOS см. страницу интеграции Arista.

Примеры

- name: configure interface
  arista.eos.eos_interface:
    name: ethernet1
    description: test-interface
    speed: 100full
    mtu: 512

- name: remove interface
  arista.eos.eos_interface:
    name: ethernet1
    state: absent

- name: make interface up
  arista.eos.eos_interface:
    name: ethernet1
    enabled: true

- name: make interface down
  arista.eos.eos_interface:
    name: ethernet1
    enabled: false

- name: Check intent arguments
  arista.eos.eos_interface:
    name: ethernet1
    state: up
    tx_rate: ge(0)
    rx_rate: le(0)

- name: Check neighbors intent arguments
  arista.eos.eos_interface:
    name: ethernet1
    neighbors:
    - port: eth0
      host: netdev

- name: Configure interface in disabled state and check if the operational state is
    disabled or not
  arista.eos.eos_interface:
    name: ethernet1
    enabled: false
    state: down

- name: Add interface using aggregate
  arista.eos.eos_interface:
    aggregate:
    - {name: ethernet1, mtu: 256, description: test-interface-1}
    - {name: ethernet2, mtu: 516, description: test-interface-2}
    speed: 100full
    state: present

- name: Delete interface using aggregate
  arista.eos.eos_interface:
    aggregate:
    - name: loopback9
    - name: loopback10
    state: absent

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

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

Ключ Возвращаемое значение Описание
commands
list / elements=string
всегда, кроме платформ, использующих Netconf transport для управления устройством.
Список команд конфигурации режима для отправки на устройство.

Пример:
['interface ethernet1', 'description test-interface', 'speed 100full', 'mtu 512']


Статус

  • Этот модуль будет удален в основной версии после 2022-06-01. [устарел]
  • Для получения дополнительной информации см. УСТАРЕВШИЙ.

Авторы

  • Ganesh Nalawade (@ganeshrn)

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

Spec-Zone.ru

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