community.network.cnos_interface – Управление интерфейсом на сетевых устройствах Lenovo CNOS

Примечание

Этот плагин входит в сборку community.network (версия 2.0.1).

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

Для использования в playbook укажите: community.network.cnos_interface.

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

Обзор

Этот модуль предоставляет декларативное управление интерфейсами на сетевых устройствах Lenovo CNOS.

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
aggregate строка			Список определений интерфейсов.
delay строка		По умолчанию: 20	Время в секундах ожидания перед проверкой операционного состояния на удаленном устройстве. Это ожидание применимо к параметру операционного состояния, у которого параметр state со значениями `up`/`down`, tx_rate и rx_rate
description строка			Описание интерфейса.
duplex строка		Варианты: full half auto ←	Состояние подключения интерфейса
enabled булево		Варианты: no yes ←	Состояние подключения интерфейса.
mtu строка			Максимальный размер передаваемого пакета.
name строка / обязательно			Имя интерфейса.
neighbors строка			Проверка операционного состояния заданного интерфейса `name` для соседа LLDP. Доступны следующие подпараметры.
	host строка		Хост соседа LLDP для данного интерфейса `name`.
	port строка		Порт соседа LLDP, к которому подключен интерфейс `name`.
provider строка			Устаревшее Начиная с Ansible 2.5, рекомендуется использовать `connection: network_cli`. Дополнительную информацию см. в руководстве CNOS Platform Options. Объект типа dict, содержащий сведения о подключении.
	auth_pass строка		Указывает пароль для входа в привилегированный режим на удаленном устройстве. Если authorize имеет значение false, то этот аргумент ничего не делает. Если значение не указано в задаче, будет использовано значение переменной окружения `ANSIBLE_NET_AUTH_PASS`.
	authorize булево	Варианты: no ← yes	Инструктирует модуль войти в привилегированный режим на удаленном устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, будет использовано значение переменной окружения `ANSIBLE_NET_AUTHORIZE`.
	host строка / обязательно		Указывает имя хоста DNS или адрес для подключения к удаленному устройству по указанному транспорту. Значение host используется в качестве адреса назначения для транспорта.
	password строка		Указывает пароль для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, будет использовано значение переменной окружения `ANSIBLE_NET_PASSWORD`.
	port строка	По умолчанию: 22	Указывает порт для подключения к удаленному устройству.
	ssh_keyfile строка		Указывает SSH-ключ для аутентификации подключения к удаленному устройству. Это значение — путь к ключу, используемому для аутентификации сеанса SSH. Если значение не указано в задаче, будет использовано значение переменной окружения `ANSIBLE_NET_SSH_KEYFILE`.
	timeout строка	По умолчанию: 10	Указывает время ожидания в секундах для связи с сетевым устройством при подключении или отправке команд. Если время ожидания истекает до завершения операции, модуль сообщит об ошибке.
	username строка		Указывает имя пользователя для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, будет использовано значение переменной окружения `ANSIBLE_NET_USERNAME`.
rx_rate строка			Скорость приема в битах в секунду (бит/с). Этот параметр используется только для проверки состояния. Поддерживает условные выражения, см. Условные выражения в сетевых модулях
speed строка			Скорость подключения интерфейса.
state строка		Варианты: present ← absent up down	Состояние конфигурации интерфейса, `up` означает присутствие и операционное включение, а `down` означает присутствие и операционное `down`.
tx_rate строка			Скорость передачи в битах в секунду (бит/с). Этот параметр используется только для проверки состояния. Поддерживает условные выражения, см. Условные выражения в сетевых модулях

Примечания

Примечание

Проверено на CNOS 10.8.1

Примеры

- name: Configure interface
  community.network.cnos_interface:
      name: Ethernet1/33
      description: test-interface
      speed: 100
      duplex: half
      mtu: 999

- name: Remove interface
  community.network.cnos_interface:
    name: loopback3
    state: absent

- name: Make interface up
  community.network.cnos_interface:
    name: Ethernet1/33
    enabled: True

- name: Make interface down
  community.network.cnos_interface:
    name: Ethernet1/33
    enabled: False

- name: Check intent arguments
  community.network.cnos_interface:
    name: Ethernet1/33
    state: up
    tx_rate: ge(0)
    rx_rate: le(0)

- name: Check neighbors intent arguments
  community.network.cnos_interface:
    name: Ethernet1/33
    neighbors:
    - port: eth0
      host: netdev

- name: Config + intent
  community.network.cnos_interface:
    name: Ethernet1/33
    enabled: False
    state: down

- name: Add interface using aggregate
  community.network.cnos_interface:
    aggregate:
    - { name: Ethernet1/33, mtu: 256, description: test-interface-1 }
    - { name: Ethernet1/44, mtu: 516, description: test-interface-2 }
    duplex: full
    speed: 100
    state: present

- name: Delete interface using aggregate
  community.network.cnos_interface:
    aggregate:
    - name: loopback3
    - name: loopback6
    state: absent

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

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

Ключ	Возвращаемое значение	Описание
commands список / элементы=строка	всегда, за исключением платформ, которые используют транспорт Netconf для управления устройством.	Список команд конфигурации в режиме настройки для отправки на устройство. Пример: ['interface Ethernet1/33', 'description test-interface', 'duplex half', 'mtu 512']

Авторы

Anil Kumar Muraleedharan(@amuraleedhar)

© 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/community/network/cnos_interface_module.html