arista.eos.eos_logging – Управление журналированием на устройствах сети Arista EOS

Примечание

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

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

Для использования в книге задач укажите: arista.eos.eos_logging.

Добавлен в версии 1.0.0: модуля arista.eos

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

Обзор

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

Примечание

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
aggregate список / элементы=словарь			Список определений журналирования.
	dest строка	Варианты: on host console monitor buffered	Место назначения журналов.
	facility строка		Установить удобство ведения журнала.
	level строка	Варианты: emergencies alerts critical errors warnings notifications informational debugging	Установите уровни серьезности журналирования.
	name строка		Имя хоста или IP-адрес места назначения. Требуется, когда dest=host.
	size целое число		Размер буфера. Допустимое значение находится в диапазоне от 10 до 2147483647 байтов.
	state строка	Варианты: present ← absent	Состояние конфигурации журналирования.
dest строка		Варианты: on host console monitor buffered	Место назначения журналов.
facility строка			Установить удобство ведения журнала.
level строка		Варианты: emergencies alerts critical errors warnings notifications informational debugging	Установите уровни серьезности журналирования.
name строка			Имя хоста или IP-адрес места назначения. Требуется, когда dest=host.
provider словарь			Устарело Начиная с Ansible 2.5, мы рекомендуем использовать `connection: network_cli`. Начиная с Ansible 2.6, для eAPI рекомендуется использовать `connection: httpapi`. Этот параметр будет удален в релизе после 2022-06-01. Для получения дополнительной информации см. руководство по параметрам платформы EOS. Объект словаря, содержащий данные подключения.
	auth_pass строка		Указывает пароль для использования, если требуется вход в привилегированный режим на удаленном устройстве. Если authorize равно false, этот аргумент ничего не делает. Если значение не указано в задаче, будет использовано значение переменной среды `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 булево	Варианты: нет да ←	Если `no`, сертификаты SSL не будут проверены. Это следует использовать только на сайтах, контролируемых вами лично, с использованием самозаверяющих сертификатов. Если аргумент transport не eapi, это значение игнорируется.
size целое число			Размер буфера. Допустимое значение находится в диапазоне от 10 до 2147483647 байтов.
state строка		Варианты: present ← absent	Состояние конфигурации журналирования.

Примечания

Примечание

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

Примеры

- name: configure host logging
  arista.eos.eos_logging:
    dest: host
    name: 172.16.0.1
    state: present

- name: remove host logging configuration
  arista.eos.eos_logging:
    dest: host
    name: 172.16.0.1
    state: absent

- name: configure console logging level and facility
  arista.eos.eos_logging:
    dest: console
    facility: local7
    level: debugging
    state: present

- name: enable logging to all
  arista.eos.eos_logging:
    dest: on

- name: configure buffer size
  arista.eos.eos_logging:
    dest: buffered
    size: 5000

- name: Configure logging using aggregate
  arista.eos.eos_logging:
    aggregate:
    - {dest: console, level: warnings}
    - {dest: buffered, size: 480000}
    state: present

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

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

Ключ	Возвращаемое значение	Описание
commands список / элементы=строка	всегда	Список команд конфигурационного режима для отправки устройству Пример: ['logging facility local7', 'logging host 172.16.0.1']

Авторы

Trishna Guha (@trishnaguha)

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