junipernetworks.junos.junos_logging – Управление журналом на сетевых устройствах

Примечание

Этот плагин входит в состав коллекции junipernetworks.junos (версия 1.2.1).

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

Для использования в книге задач укажите: junipernetworks.junos.junos_logging.

Новое в версии 1.0.0: of junipernetworks.junos

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

Обзор

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

Примечание

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

Требования

Ниже перечислены требования к хосту, на котором выполняется этот модуль.

ncclient (>=v0.5.2)

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
active boolean		Варианты: no yes ←	Указывает, активна или деактивирована конфигурация.
aggregate list / elements=dictionary			Список определений журналирования.
	active boolean	Варианты: no yes	Указывает, активна или деактивирована конфигурация.
	dest string	Варианты: console host file user	Назначение журналов.
	facility string		Установить объект журналирования.
	files integer		Количество архивируемых файлов, применимо, если значение dest равно `file`. Допустимое значение в диапазоне от 1 до 1000.
	level string		Установить уровни серьезности журналирования.
	name string		Если значение `dest` равно file, то это имя файла, для user — имя пользователя, а для host — имя хоста для уведомления.
	rotate_frequency integer		Частота вращения журнала в минутах, применимо, если значение dest равно `file`. Допустимое значение в диапазоне от 1 до 59. Это контролирует частоту вращения файла журнала.
	size integer		Размер файла в архиве, применимо, если значение dest равно `file`. Допустимое значение в диапазоне от 65536 до 1073741824 байт.
	state string	Варианты: present absent	Состояние конфигурации журналирования.
dest string		Варианты: console host file user	Назначение журналов.
facility string			Установить объект журналирования.
files integer			Количество архивируемых файлов, применимо, если значение dest равно `file`. Допустимое значение в диапазоне от 1 до 1000.
level string			Установить уровни серьезности журналирования.
name string			Если значение `dest` равно file, то это имя файла, для user — имя пользователя, а для host — имя хоста для уведомления.
provider dictionary			Устарело Начиная с Ansible 2.5, рекомендуется использовать `connection: network_cli` или `connection: netconf`. Для получения дополнительной информации, пожалуйста, обратитесь к руководству Junos OS Platform Options. Объект словаря, содержащий данные подключения.
	host string		Указывает имя хоста DNS или адрес для подключения к удаленному устройству по указанному транспорту. Значение host используется в качестве адреса назначения для транспорта.
	password string		Указывает пароль для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, используется значение переменной среды `ANSIBLE_NET_PASSWORD`.
	port integer		Указывает порт для создания соединения с удаленным устройством. Значение порта по умолчанию равно общеизвестному порту SSH 22 (для `transport=cli`) или порту 830 (для `transport=netconf`) устройства.
	ssh_keyfile path		Указывает SSH-ключ для аутентификации подключения к удаленному устройству. Это значение — путь к ключу, используемому для аутентификации сеанса SSH. Если значение не указано в задаче, используется значение переменной среды `ANSIBLE_NET_SSH_KEYFILE`.
	timeout integer		Указывает тайм-аут в секундах для связи с сетевым устройством для подключения или отправки команд. Если тайм-аут истекает до завершения операции, модуль выдаст ошибку.
	transport string	Варианты: cli netconf ←	Настраивает транспортное соединение для подключения к удаленному устройству.
	username string		Настраивает имя пользователя для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, используется значение переменной среды `ANSIBLE_NET_USERNAME`.
rotate_frequency integer			Частота вращения журнала в минутах, применимо, если значение dest равно `file`. Допустимое значение в диапазоне от 1 до 59. Это контролирует частоту вращения файла журнала.
size integer			Размер файла в архиве, применимо, если значение dest равно `file`. Допустимое значение в диапазоне от 65536 до 1073741824 байт.
state string		Варианты: present ← absent	Состояние конфигурации журналирования.

Примечания

Примечание

Для работы с данным модулем необходимо включить системную службу netconf на удалённом управляемом устройстве.
Тестировалось на vSRX JUNOS версии 15.1X49-D15.4, vqfx-10000 JUNOS версии 15.1X53-D60.4.
Рекомендуемое соединение netconf. См. параметры платформы Junos OS.
Этот модуль также работает с local подключениями для устаревших playbooks.
Сведения об использовании CLI и netconf см. в руководстве по параметрам платформы Junos OS
Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в Руководстве по сетям Ansible
Дополнительную информацию об использовании Ansible для управления устройствами сети Juniper см. на https://www.ansible.com/ansible-juniper.

Примеры

- name: configure console logging
  junipernetworks.junos.junos_logging:
    dest: console
    facility: any
    level: critical

- name: remove console logging configuration
  junipernetworks.junos.junos_logging:
    dest: console
    state: absent

- name: configure file logging
  junipernetworks.junos.junos_logging:
    dest: file
    name: test
    facility: pfe
    level: error

- name: configure logging parameter
  junipernetworks.junos.junos_logging:
    files: 30
    size: 65536
    rotate_frequency: 10

- name: Configure file logging using aggregate
  junipernetworks.junos.junos_logging:
    dest: file
    aggregate:
    - name: test-1
      facility: pfe
      level: critical
    - name: test-2
      facility: kernel
      level: emergency
    active: true

- name: Delete file logging using aggregate
  junipernetworks.junos.junos_logging:
    aggregate:
    - {dest: file, name: test-1, facility: pfe, level: critical}
    - {dest: file, name: test-2, facility: kernel, level: emergency}
    state: absent

Значения возврата

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

Ключ	Возвращённое значение	Описание
diff.prepared string	при изменении конфигурации и включенном параметре diff.	Разница в конфигурации до и после применения изменений. Пример: [edit system syslog] + [edit system syslog] file interactive-commands { ... } + file test { + pfe critical; + }

Авторы

Ganesh Nalawade (@ganeshrn)

© 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/junipernetworks/junos/junos_logging_module.html