ios_logging — Управление журналированием на сетевых устройствах IOS

Новая версия с 2.4.

Обзор
Параметры
Примечания
Примеры
Возвращаемые значения
Статус
- Поддержка
- Автор

Обзор

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
aggregate			Список определений журналирования.
auth_pass		По умолчанию: none	Устарело Начиная с Ansible 2.5 рекомендуется использовать `connection: network_cli` и `become: yes` с `become_pass`. Дополнительную информацию см. в руководстве IOS Platform Options. Указывает пароль для входа в привилегированный режим на удалённом устройстве. Если authorize равен false, этот аргумент не используется. Если значение не указано в задаче, будет использовано значение переменной окружения `ANSIBLE_NET_AUTH_PASS`.
authorize		Варианты: yes no ←	Устарело Начиная с Ansible 2.5 рекомендуется использовать `connection: network_cli` и `become: yes`. Дополнительную информацию см. в руководстве IOS Platform Options. Указывает модулю войти в привилегированный режим на удалённом устройстве перед отправкой команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, будет использовано значение переменной окружения `ANSIBLE_NET_AUTHORIZE`.
dest		Варианты: on host console monitor buffered	Место назначения журналов.
facility			Установить системную информацию.
level			Установить уровни серьёзности журналирования.
name			Если значение `dest` равно file, это указывает имя файла; для user — имя пользователя; для host — имя хоста, которому нужно сообщить.
provider		По умолчанию: None	Устарело Начиная с Ansible 2.5 рекомендуется использовать `connection: network_cli`. Дополнительную информацию см. в руководстве IOS Platform Options. Объект типа dict, содержащий данные подключения.
	username		Устанавливает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации SSH-сессии. Если значение не указано в задаче, будет использовано значение переменной окружения `ANSIBLE_NET_USERNAME`.
	authorize	Варианты: yes no ←	Указывает модулю войти в привилегированный режим на удалённом устройстве перед отправкой команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, будет использовано значение переменной окружения `ANSIBLE_NET_AUTHORIZE`.
	ssh_keyfile		Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Это значение — путь к ключу, используемому для аутентификации SSH-сессии. Если значение не указано в задаче, будет использовано значение переменной окружения `ANSIBLE_NET_SSH_KEYFILE`.
	auth_pass	По умолчанию: none	Указывает пароль для входа в привилегированный режим на удалённом устройстве. Если authorize равен false, этот аргумент не используется. Если значение не указано в задаче, будет использовано значение переменной окружения `ANSIBLE_NET_AUTH_PASS`.
	host обязательно		Указывает имя DNS-хоста или адрес для подключения к удалённому устройству по указанному протоколу. Значение host используется в качестве адреса назначения для протокола.
	timeout	По умолчанию: 10	Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истечёт до завершения операции, модуль выдаст ошибку.
	password	По умолчанию: None	Указывает пароль для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации SSH-сессии. Если значение не указано в задаче, будет использовано значение переменной окружения `ANSIBLE_NET_PASSWORD`.
	port	По умолчанию: 22	Указывает порт для подключения к удалённому устройству.
size		По умолчанию: 4096	Размер буфера. Допустимое значение от 4096 до 4294967295 байт.
state		Варианты: present ← absent	Состояние конфигурации журналирования.

Примечания

Примечание

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

Примеры

- name: configure host logging
  ios_logging:
    dest: host
    name: 172.16.0.1
    state: present

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

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

- name: enable logging to all
  ios_logging:
    dest : on

- name: configure buffer size
  ios_logging:
    dest: buffered
    size: 5000

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

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

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

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

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

Статус

Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется обратной совместимостью.

Поддержка

Дополнительную информацию о поддержке этого модуля Red Hat см. в этой статье базы знаний

Автор

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.5/modules/ios_logging_module.html