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

Примечание

Этот плагин является частью коллекции cisco.ios (версия 1.2.1).

Для его установки используйте: 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 IOS Platform Options. Объект словаря, содержащий сведения о подключении.
	auth_pass строка		Указывает пароль, который необходимо использовать, если требуется входить в привилегированный режим на удаленном устройстве. Если authorize ложно, этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной среды `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–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/cisco/ios/ios_logging_module.html