junipernetworks.junos.junos_logging – Управление журналированием на сетевых устройствах
Примечание
Этот плагин входит в состав коллекции junipernetworks.junos (версия 1.3.0).
Для его установки используйте: ansible-galaxy collection install junipernetworks.junos.
Чтобы использовать его в книге задач, укажите: junipernetworks.junos.junos_logging.
Новое в версии 1.0.0: из junipernetworks.junos
Обзор
- Этот модуль предоставляет декларативное управление журналированием на устройствах Juniper JUNOS.
Примечание
Для этого модуля существует соответствующий плагин действий.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- ncclient (>=v0.5.2)
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| active boolean |
| Указывает, активна или деактивирована конфигурация | |
| aggregate list / elements=dictionary | Список определений журналирования. | ||
| active boolean |
| Указывает, активна или деактивирована конфигурация | |
| dest string |
| Место назначения журналов. | |
| 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 |
| Состояние конфигурации журналирования. | |
| dest string |
| Место назначения журналов. | |
| 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 |
| Настраивает транспортное соединение для подключения к удалённому устройству. | |
| username string | Настраивает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации сессии SSH. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_USERNAME. | ||
| rotate_frequency integer | Частота вращения журнала в минутах, применимо если значение dest равно file. Допустимое значение от 1 до 59. Управляет частотой вращения файла журнала. | ||
| size integer | Размер файла в архиве, применимо если значение dest равно file. Допустимое значение от 65536 до 1073741824 байт. | ||
| state string |
| Состояние конфигурации журналирования. | |
Примечания
Примечание
- Для этого модуля требуется, чтобы служба netconf была включена на управляемом удалённом устройстве.
- Тестировано на vSRX JUNOS версии 15.1X49-D15.4, vqfx-10000 JUNOS версии 15.1X53-D60.4.
- Рекомендуемое подключение —
netconf. См. руководство по параметрам платформы Junos OS. - Этот модуль также работает с подключением
localдля устаревших книг задач. - Сведения о использовании 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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/junipernetworks/junos/junos_logging_module.html