cisco.ios.ios_logging – Управление журналированием на устройствах сети

Примечание

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

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

Для использования в плейбуке укажите: cisco.ios.ios_logging

Новое в версии 1.0.0: модуля cisco.ios

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

Обзор

Этот модуль обеспечивает декларативное управление журналированием на устройствах Cisco Ios.

Примечание

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
aggregate список / элементы=словарь			Список определений журналирования.
	dest строка	Варианты: on host console monitor buffered trap	Место назначения журналов. Для параметра dest со значением "on" необходимо использовать кавычки 'on', иначе pyyaml преобразует его в True перед передачей в Ansible.
	facility строка		Установить уровень журналирования.
	level строка	Варианты: emergencies alerts critical errors warnings notifications informational debugging	Установить уровни серьезности журналирования.
	name строка		Имя хоста или IP-адрес места назначения. Требуется, если dest=host.
	size целое число		Размер буфера. Допустимые значения от 4096 до 4294967295 байт.
	state строка	Варианты: present absent	Состояние конфигурации журналирования.
dest строка		Варианты: on host console monitor buffered trap	Место назначения журналов. Для параметра dest со значением "on" необходимо использовать кавычки 'on', иначе pyyaml преобразует его в True перед передачей в Ansible.
facility строка			Установить уровень журналирования.
level строка		Варианты: emergencies alerts critical errors warnings notifications informational debugging ←	Установить уровни серьезности журналирования.
name строка			Имя хоста или IP-адрес места назначения. Требуется, если dest=host.
provider словарь			Устарело Начиная с Ansible 2.5 рекомендуется использовать `connection: network_cli`. Дополнительную информацию можно найти в руководстве IOS Platform Options. Объект словаря с данными подключения.
	auth_pass строка		Указывает пароль для входа в привилегированный режим на удаленном устройстве. Если authorize имеет значение false, то этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной среды `ANSIBLE_NET_AUTH_PASS`
	authorize логическое значение	Варианты: no ← yes	Инструктирует модуль войти в привилегированный режим на удаленном устройстве перед отправкой команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной среды `ANSIBLE_NET_AUTHORIZE`
	host строка		Указывает DNS имя хоста или адрес для подключения к удаленному устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта.
	password строка		Указывает пароль для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, используется значение переменной среды `ANSIBLE_NET_PASSWORD`
	port целое число		Указывает порт, используемый при построении подключения к удаленному устройству.
	ssh_keyfile путь		Указывает SSH ключ для аутентификации подключения к удаленному устройству. Это значение — путь к ключу, используемому для аутентификации сеанса SSH. Если значение не указано в задаче, используется значение переменной среды `ANSIBLE_NET_SSH_KEYFILE`
	timeout целое число		Указывает время ожидания в секундах для связи с сетевым устройством при подключении или отправке команд. Если время ожидания истечет до завершения операции, модуль выдаст ошибку.
	username строка		Устанавливает имя пользователя для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, используется значение переменной среды `ANSIBLE_NET_USERNAME`
size целое число			Размер буфера. Допустимые значения от 4096 до 4294967295 байт.
state строка		Варианты: present ← absent	Состояние конфигурации журналирования.

Примечания

Примечание

Проверено на IOS 15.6
Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в Руководстве по сети Ansible
Дополнительную информацию об использовании Ansible для управления устройствами Cisco см. на странице интеграции Cisco.

Примеры

- name: configure host logging
  cisco.ios.ios_logging:
    dest: host
    name: 172.16.0.1
    state: present

- name: remove host logging configuration
  cisco.ios.ios_logging:
    dest: host
    name: 172.16.0.1
    state: absent

- name: configure console logging level and facility
  cisco.ios.ios_logging:
    dest: console
    facility: local7
    level: debugging
    state: present

- name: enable logging to all
  cisco.ios.ios_logging:
    dest: on

- name: configure buffer size
  cisco.ios.ios_logging:
    dest: buffered
    size: 5000

- name: Configure logging using aggregate
  cisco.ios.ios_logging:
    aggregate:
    - {dest: console, level: notifications}
    - {dest: buffered, size: 9000}

- name: remove logging using aggregate
  cisco.ios.ios_logging:
    aggregate:
    - {dest: console, level: notifications}
    - {dest: buffered, size: 9000}
    state: absent

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

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

Ключ	Возвращаемое значение	Описание
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/cisco/ios/ios_logging_module.html