cisco.ios.ios_logging_global модуль – Модуль ресурсов для настройки журналирования.
Примечание
Этот модуль входит в коллекцию cisco.ios (версия 8.0.0).
У вас, возможно, уже установлена эта коллекция, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install cisco.ios.
Чтобы использовать его в книге задач, укажите: cisco.ios.ios_logging_global.
Новое в cisco.ios 2.2.0
Краткое описание
- Этот модуль управляет атрибутами журналирования сетевых устройств Cisco IOS
Псевдонимы: logging_global
Параметры
Параметр | Комментарии |
|---|---|
config dictionary | Словарь параметров ведения журнала |
|
buffered dictionary |
Установить параметры буферизованного ведения журнала |
|
discriminator string |
Установить связь MD-Buffer |
|
filtered boolean |
Включить фильтрованное ведение журнала Варианты:
|
|
severity string |
Уровень серьезности ведения журнала Варианты:
|
|
size integer |
Размер буфера ведения журнала |
|
xml boolean |
Включить ведение журнала в XML в буфер ведения журнала XML Варианты:
|
|
buginf boolean |
Включить ведение журнала buginf для отладки Варианты:
|
|
cns_events string |
Установить уровень ведения журнала событий CNS Варианты:
|
|
console dictionary |
Установить параметры ведения журнала консоли |
|
discriminator string |
Установить связь MD-Buffer |
|
filtered boolean |
Включить фильтрованное ведение журнала Варианты:
|
|
severity string |
Уровень серьезности ведения журнала Варианты:
|
|
xml boolean |
Включить ведение журнала в XML в буфер ведения журнала XML Варианты:
|
|
count boolean |
Подсчитывать каждое сообщение журнала и помечать время последнего события Варианты:
|
|
delimiter dictionary |
Добавить разделитель к сообщениям syslog |
|
tcp boolean |
Добавить разделитель к сообщениям syslog по TCP Варианты:
|
|
discriminator list / elements=string |
Создать или изменить дискриминатор сообщений |
|
dmvpn dictionary |
Конфигурация DMVPN |
|
rate_limit integer |
Скорость в сообщениях/минуту, по умолчанию 600 сообщений/минуту (1-10000) |
|
esm dictionary |
Установить ограничения фильтра ESM |
|
config boolean |
Разрешить/Запретить изменения конфигурации из фильтров ESM Варианты:
|
|
exception integer |
Ограничение размера выходных данных при сбросе исключений (4096-2147483647) |
|
facility string |
Параметр facility для сообщений syslog Варианты:
|
|
filter list / elements=dictionary |
Укажите фильтр ведения журнала |
|
args string |
Аргументы, передаваемые в модуль фильтра. |
|
order integer |
Порядок выполнения фильтра |
|
url string |
Унифицированный указатель ресурса фильтра |
|
history dictionary |
Настройка таблицы истории syslog |
|
severity string |
Уровень серьезности ведения журнала Варианты:
|
|
size integer |
Размер буфера журнала |
|
hosts list / elements=dictionary |
Установите IP-адрес сервера syslog и параметры |
|
discriminator string |
Установите связь MD-Buffer |
|
filtered boolean |
Включить фильтруемое ведение журнала Варианты:
|
|
host aliases: hostname string |
IP-адрес сервера syslog |
|
ipv6 string |
Настройка сервера syslog IPv6 |
|
sequence_num_session boolean |
Включить тег номера последовательности сессии в сообщении syslog Варианты:
|
|
session_id dictionary |
Укажите маркировку идентификатора сессии сообщения syslog |
|
tag string |
Включить имя хоста в тег идентификатора сессии Варианты:
|
|
text string |
Включить пользовательскую строку в тег идентификатора сессии |
|
stream integer |
Этот сервер должен получать сообщения только из нумерованного потока |
|
transport dictionary |
Укажите транспортный протокол (по умолчанию=UDP) |
|
tcp dictionary |
Протокол управления передачей |
|
audit boolean |
Установите этот хост для ведения журнала аудита брандмауэра IOS Варианты:
|
|
discriminator string |
Установите связь MD-Buffer |
|
filtered boolean |
Включить фильтрованное логирование Choices:
|
|
port integer |
Укажите номер TCP-порта (по умолчанию=601) (1 - 65535) |
|
sequence_num_session boolean |
Включить тег номера последовательности сессии в сообщении syslog Choices:
|
|
session_id dictionary |
Укажите тегирование идентификатора сессии сообщения syslog |
|
tag string |
Включить имя хоста в тег идентификатора сессии Choices:
|
|
text string |
Включить пользовательскую строку в тег идентификатора сессии |
|
stream integer |
Этот сервер должен получать сообщения только из пронумерованного потока |
|
xml boolean |
Включить логирование в XML в буфер XML-логирования Choices:
|
|
udp dictionary |
User Datagram Protocol |
|
discriminator string |
Установить связь MD-Buffer |
|
filtered boolean |
Включить фильтрованное логирование Choices:
|
|
port integer |
Укажите номер UDP-порта (по умолчанию=514) (1 - 65535) |
|
sequence_num_session boolean |
Включить тег номера последовательности сессии в сообщении syslog Choices:
|
|
session_id dictionary |
Укажите тегирование идентификатора сессии сообщения syslog |
|
tag string |
Включить имя хоста в тег идентификатора сессии Choices:
|
|
text string |
Включить пользовательскую строку в тег идентификатора сессии |
|
stream integer |
Этот сервер должен получать сообщения только из пронумерованного потока |
|
xml boolean |
Включить логирование в XML в буфер XML-логирования Choices:
|
|
vrf string |
Установить опцию VRF |
|
xml boolean |
Включить логирование в XML в буфер XML-логирования Choices:
|
|
logging_on string |
Включить логирование во все включенные пункты назначения Choices:
|
|
message_counter list / elements=string |
Настроить сообщение журнала для включения определенного значения счетчика Choices:
|
|
monitor dictionary |
Установить параметры ведения журнала для терминальной линии (монитор) |
|
discriminator string |
Установить связь MD-Buffer |
|
filtered boolean |
Включить фильтрованный журнал Варианты:
|
|
severity string |
Уровень серьезности ведения журнала Варианты:
|
|
xml boolean |
Включить ведение журнала в XML в буфер XML-журнала Варианты:
|
|
origin_id dictionary |
Добавить ID источника в сообщения syslog |
|
tag string |
Включить имя хоста в тег идентификатора сессии Варианты:
|
|
text string |
Включить пользовательскую строку в тег идентификатора сессии |
|
persistent dictionary |
Установить параметры постоянного ведения журнала |
|
batch integer |
Установить размер пакета для записи в постоянное хранилище (4096-2142715904) |
|
filesize integer |
Установить размер отдельных файлов журнала (4096-2142715904) |
|
immediate boolean |
Записать запись журнала в хранилище немедленно (без буферизации). Варианты:
|
|
notify boolean |
Уведомлять при активации show logging [persistent]. Варианты:
|
|
protected boolean |
Исключает манипуляции с файлами logging-persistent. Варианты:
|
|
size integer |
Установить дисковое пространство для записи сообщений журнала (4096-2142715904) |
|
threshold integer |
Установить порог для persistent-журналов |
|
url string |
URL для хранения сообщений журнала |
|
policy_firewall dictionary |
Конфигурация брандмауэра |
|
rate_limit integer |
(0-3600) значение в секундах, по умолчанию 30 сек. |
|
queue_limit dictionary |
Установить размер очереди сообщений журнала |
|
esm integer |
(100-2147483647) установить новый размер очереди |
|
size integer |
(100-2147483647) установить новый размер очереди |
|
trap integer |
(100-2147483647) установить новый размер очереди |
|
rate_limit dictionary |
Установить ограничение количества сообщений в секунду |
|
all boolean |
(1-10000) сообщений в секунду Варианты:
|
|
console boolean |
(1-10000) сообщений в секунду Варианты:
|
|
except_severity string |
Сообщения уровня серьезности или выше Варианты:
|
|
size integer / обязательно |
(1-10000) сообщений в секунду |
|
reload dictionary |
Установить уровень логирования при перезагрузке |
|
message_limit integer |
Количество сообщений (1-4294967295) |
|
severity string |
Уровень серьезности логирования Варианты:
|
|
server_arp boolean |
Включить отправку запросов ARP для серверов syslog при первой настройке Варианты:
|
|
snmp_trap list / elements=string |
Установить уровень syslog для отправки snmp trap Варианты:
|
|
source_interface list / elements=dictionary |
Указать интерфейс для исходного адреса в операциях логирования |
|
interface string |
Имя интерфейса с номером |
|
vrf string |
Имя экземпляра VPN Routing/Forwarding |
|
trap string |
Установить уровень логирования сервера syslog Варианты:
|
|
userinfo boolean |
Включить логирование информации о пользователе при активации привилегированного режима Варианты:
|
running_config string | Этот параметр используется только с состоянием parsed. Значение этого параметра должно быть результатом выполнения команды show running-config | include logging на устройстве IOS. Состояние parsed считывает конфигурацию из параметра |
state string | Состояние, в котором должна остаться конфигурация Состоянием replaced для указанных конфигураций логирования, которые находятся в running-config и могут иметь несколько наборов команд, но не в задаче, игнорируются. Состоянием overridden игнорируются все конфигурации, которые находятся в running-config, но не в задаче. Для более подробной информации см. примеры. Варианты:
|
Примечания
Примечание
- Проверено на Cisco IOSXE версии 17.3 на CML.
- Этот модуль работает с подключением
network_cli. См. https://docs.ansible.com/ansible/latest/network/user_guide/platform_ios.html - Конфигурационные значения по умолчанию устройств Cisco IOS должны препятствовать идемпотентному поведению плейбуков
Примеры
# Using state: merged
# Before state:
# -------------
# router-ios#show running-config | section logging
# no logging exception
# no logging buffered
# no logging reload
# no logging rate-limit
# no logging console
# no logging monitor
# no logging cns-events
# no logging trap
- name: Apply the provided configuration
cisco.ios.ios_logging_global:
config:
buffered:
severity: notifications
size: 5099
xml: true
console:
severity: critical
xml: true
facility: local5
hosts:
- hostname: 172.16.1.12
- hostname: 172.16.1.11
xml: true
- hostname: 172.16.1.10
filtered: true
stream: 10
- hostname: 172.16.1.13
transport:
tcp:
port: 514
monitor:
severity: warnings
message_counter: log
snmp_trap:
- errors
trap: errors
userinfo: true
policy_firewall:
rate_limit: 10
logging_on: enable
exception: 4099
dmvpn:
rate_limit: 10
cns_events: warnings
state: merged
# Commands Fired:
# ---------------
# "commands": [
# "logging buffered xml 5099 notifications",
# "logging cns-events warnings",
# "logging console xml critical",
# "logging dmvpn rate-limit 10",
# "logging exception 4099",
# "logging facility local5",
# "logging monitor warnings",
# "logging on",
# "logging policy-firewall rate-limit 10",
# "logging trap errors",
# "logging userinfo",
# "logging host 172.16.1.12",
# "logging host 172.16.1.10 filtered stream 10",
# "logging host 172.16.1.13 transport tcp port 514",
# "logging message-counter log",
# "logging snmp-trap errors",
# "logging host 172.16.1.11 xml"
# ],
# After state:
# ------------
# router-ios#show running-config | section logging
# logging exception 4099
# logging message-counter log
# logging userinfo
# logging buffered xml 5099 notifications
# no logging reload
# no logging rate-limit
# logging console xml critical
# logging monitor warnings
# logging cns-events warnings
# logging policy-firewall rate-limit 10
# logging dmvpn rate-limit 10
# logging trap errors
# logging facility local5
# logging snmp-trap errors
# logging snmp-trap warnings
# logging host 172.16.1.13 transport tcp port 514
# logging host 172.16.1.11 xml
# logging host 172.16.1.12
# logging host 172.16.1.10 filtered stream 10
# Using state: deleted
# Before state:
# -------------
# router-ios#show running-config | section logging
# logging exception 4099
# logging message-counter log
# logging userinfo
# logging buffered xml 5099 notifications
# no logging reload
# no logging rate-limit
# logging console xml critical
# logging monitor warnings
# logging cns-events warnings
# logging policy-firewall rate-limit 10
# logging dmvpn rate-limit 10
# logging trap errors
# logging facility local5
# logging snmp-trap errors
# logging host 172.16.1.13 transport tcp port 514
# logging host 172.16.1.11 xml
# logging host 172.16.1.12
# logging host 172.16.1.10 filtered stream 10
- name: Remove all existing configuration
cisco.ios.ios_logging_global:
state: deleted
# Commands Fired:
# ---------------
# "commands": [
# "no logging message-counter log",
# "no logging snmp-trap errors",
# "no logging host 172.16.1.13",
# "no logging host 172.16.1.11",
# "no logging host 172.16.1.12",
# "no logging host 172.16.1.10",
# "no logging exception 4099",
# "no logging userinfo",
# "no logging buffered xml 5099 notifications",
# "no logging console xml critical",
# "no logging monitor warnings",
# "no logging cns-events warnings",
# "no logging policy-firewall rate-limit 10",
# "no logging dmvpn rate-limit 10",
# "no logging trap errors",
# "no logging facility local5"
# ],
# After state:
# ------------
# router-ios#show running-config | section logging
# no logging exception
# no logging buffered
# no logging reload
# no logging rate-limit
# no logging console
# no logging monitor
# no logging cns-events
# no logging trap
# Using state: overridden
# Before state:
# -------------
# router-ios#show running-config | section logging
# logging exception 4099
# logging message-counter log
# logging userinfo
# logging buffered 6000 critical
# no logging reload
# no logging rate-limit
# logging console xml critical
# logging monitor warnings
# logging cns-events warnings
# logging policy-firewall rate-limit 10
# logging dmvpn rate-limit 10
# logging trap errors
# logging facility local6
# logging host 172.16.1.13 transport tcp port 514
# logging host 172.16.1.12
# logging host 172.16.1.10 filtered stream 10
# logging host 172.16.1.25 filtered
- name: Override commands with provided configuration
cisco.ios.ios_logging_global:
config:
hosts:
- hostname: 172.16.1.27
filtered: true
state: overridden
# Commands Fired:
# ---------------
# "commands": [
# "no logging message-counter log",
# "no logging host 172.16.1.12",
# "no logging host 172.16.1.10",
# "no logging host 172.16.1.13",
# "no logging exception 4099",
# "no logging userinfo",
# "no logging console xml critical",
# "no logging monitor warnings",
# "no logging cns-events warnings",
# "no logging policy-firewall rate-limit 10",
# "no logging dmvpn rate-limit 10",
# "no logging trap errors",
# "no logging buffered 6000 critical",
# "no logging facility local6",
# "logging host 172.16.1.27 filtered",
# ],
# After state:
# ------------
# router-ios#show running-config | section logging
# no logging exception
# no logging buffered
# no logging reload
# no logging rate-limit
# no logging console
# no logging monitor
# no logging cns-events
# no logging trap
# logging host 172.16.1.27 filtered
# Using state: replaced
# Before state:
# -------------
# router-ios#show running-config | section logging
# logging exception 4099
# logging message-counter log
# logging userinfo
# logging buffered xml 5099 notifications
# no logging reload
# no logging rate-limit
# logging console xml critical
# logging monitor warnings
# logging cns-events warnings
# logging policy-firewall rate-limit 10
# logging dmvpn rate-limit 10
# logging trap errors
# logging facility local5
# logging snmp-trap errors
# logging host 172.16.1.13 transport tcp port 514
# logging host 172.16.1.11 xml
# logging host 172.16.1.12
# logging host 172.16.1.10 filtered stream 10
- name: Replace commands with provided configuration
cisco.ios.ios_logging_global:
config:
buffered:
severity: alerts
size: 6025
facility: local6
hosts:
- hostname: 172.16.1.19
- hostname: 172.16.1.10
filtered: true
stream: 15
state: replaced
# Commands Fired:
# ---------------
# "commands": [
# "no logging host 172.16.1.13",
# "no logging host 172.16.1.11",
# "no logging host 172.16.1.12",
# "no logging host 172.16.1.10",
# "logging host 172.16.1.19",
# "logging host 172.16.1.10 filtered stream 15",
# "logging buffered 6025 alerts",
# "logging facility local6"
# ],
# After state:
# ------------
# router-ios#show running-config | section logging
# logging exception 4099
# logging message-counter log
# logging userinfo
# logging buffered 6025 alerts
# no logging reload
# no logging rate-limit
# logging console xml critical
# logging monitor warnings
# logging cns-events warnings
# logging policy-firewall rate-limit 10
# logging dmvpn rate-limit 10
# logging trap errors
# logging facility local6
# logging snmp-trap errors
# logging host 172.16.1.19
# Using state: gathered
# Before state:
# -------------
# router-ios#show running-config | section logging
# logging exception 4099
# logging message-counter log
# logging userinfo
# logging buffered xml 5099 notifications
# no logging reload
# no logging rate-limit
# logging console xml critical
# logging monitor warnings
# logging cns-events warnings
# logging policy-firewall rate-limit 10
# logging dmvpn rate-limit 10
# logging trap errors
# logging facility local5
# logging snmp-trap errors
# logging host 172.16.1.13 transport tcp port 514
# logging host 172.16.1.11 xml
# logging host 172.16.1.12
# logging host 172.16.1.10 filtered stream 10
# logging host 172.16.1.25 filtered
- name: Gather listed logging config
cisco.ios.ios_logging_global:
state: gathered
# Module Execution Result:
# ------------------------
# "gathered": {
# "buffered": {
# "severity": "notifications",
# "size": 5099,
# "xml": true
# },
# "cns_events": "warnings",
# "console": {
# "severity": "critical",
# "xml": true
# },
# "dmvpn": {
# "rate_limit": 10
# },
# "exception": 4099,
# "facility": "local5",
# "hosts": [
# {
# "hostname": "172.16.1.11",
# "xml": true
# },
# {
# "hostname": "172.16.1.12"
# },
# {
# "filtered": true,
# "hostname": "172.16.1.10",
# "stream": 10
# },
# {
# "hostname": "172.16.1.13",
# "transport": {
# "tcp": {
# "port": 514
# }
# }
# },
# {
# "filtered": true,
# "hostname": "172.16.1.25"
# }
# ],
# "message_counter": [
# "log"
# ],
# "monitor": {
# "severity": "warnings"
# },
# "policy_firewall": {
# "rate_limit": 10
# },
# "snmp_trap": [
# "errors"
# ],
# "trap": "errors",
# "userinfo": true
# },
# After state:
# -------------
# router-ios#show running-config | section logging
# logging exception 4099
# logging message-counter log
# logging userinfo
# logging buffered xml 5099 notifications
# no logging reload
# no logging rate-limit
# logging console xml critical
# logging monitor warnings
# logging cns-events warnings
# logging policy-firewall rate-limit 10
# logging dmvpn rate-limit 10
# logging trap errors
# logging facility local5
# logging snmp-trap errors
# logging host 172.16.1.13 transport tcp port 514
# logging host 172.16.1.11 xml
# logging host 172.16.1.12
# logging host 172.16.1.10 filtered stream 10
# logging host 172.16.1.25 filtered
# Using state: rendered
- name: Render the commands for provided configuration
cisco.ios.ios_logging_global:
config:
buffered:
severity: notifications
size: 5099
xml: true
console:
severity: critical
xml: true
facility: local5
hosts:
- hostname: 172.16.1.12
- hostname: 172.16.1.11
xml: true
- hostname: 172.16.1.10
filtered: true
stream: 10
- hostname: 172.16.1.13
transport:
tcp:
port: 514
monitor:
severity: warnings
message_counter: log
snmp_trap: errors
trap: errors
userinfo: true
policy_firewall:
rate_limit: 10
logging_on: enable
exception: 10
dmvpn:
rate_limit: 10
cns_events: warnings
state: rendered
# Module Execution Result:
# ------------------------
# "rendered": [
# "logging host 172.16.1.12",
# "logging host 172.16.1.11 xml",
# "logging host 172.16.1.10 filtered stream 10",
# "logging host 172.16.1.13 transport tcp port 514",
# "logging message-counter log",
# "logging snmp-trap errors",
# "logging buffered xml 5099 notifications",
# "logging console xml critical",
# "logging facility local5",
# "logging monitor warnings",
# "logging trap errors",
# "logging userinfo",
# "logging policy-firewall rate-limit 10",
# "logging on",
# "logging exception 10",
# "logging dmvpn rate-limit 10",
# "logging cns-events warnings"
# ]
# Using state: parsed
# File: parsed.cfg
# ----------------
# logging on
# logging count
# logging userinfo
# logging trap errors
# logging reload alerts
# logging host 172.16.1.1
# logging exception 4099
# logging history alerts
# logging facility local5
# logging snmp-trap errors
# logging monitor warnings
# logging origin-id hostname
# logging host 172.16.1.11 xml
# logging cns-events warnings
# logging dmvpn rate-limit 10
# logging message-counter log
# logging console xml critical
# logging message-counter debug
# logging persistent batch 4444
# logging host 172.16.1.25 filtered
# logging source-interface GBit1/0
# logging source-interface CTunnel2
# logging policy-firewall rate-limit 10
# logging buffered xml 5099 notifications
# logging rate-limit all 2 except warnings
# logging host 172.16.1.10 filtered stream 10
# logging host 172.16.1.13 transport tcp port 514
# logging discriminator msglog01 severity includes 5
# logging filter tftp://172.16.2.18/ESM/elate.tcl args TESTInst2
# logging filter tftp://172.16.2.14/ESM/escalate.tcl args TESTInst
- name: Parse the provided configuration with the existing running configuration
cisco.ios.ios_logging_global:
running_config: "{{ lookup('file', 'parsed.cfg') }}"
state: parsed
# Module Execution Result:
# ------------------------
# "parsed": {
# "buffered": {
# "severity": "notifications",
# "size": 5099,
# "xml": true
# },
# "cns_events": "warnings",
# "console": {
# "severity": "critical",
# "xml": true
# },
# "count": true,
# "discriminator": [
# "msglog01 severity includes 5"
# ],
# "dmvpn": {
# "rate_limit": 10
# },
# "exception": 4099,
# "facility": "local5",
# "filter": [
# {
# "args": "TESTInst2",
# "url": "tftp://172.16.2.18/ESM/elate.tcl"
# },
# {
# "args": "TESTInst",
# "url": "tftp://172.16.2.14/ESM/escalate.tcl"
# }
# ],
# "history": {
# "severity": "alerts"
# },
# "hosts": [
# {
# "hostname": "172.16.1.1"
# },
# {
# "hostname": "172.16.1.11",
# "xml": true
# },
# {
# "filtered": true,
# "hostname": "172.16.1.25"
# },
# {
# "filtered": true,
# "hostname": "172.16.1.10",
# "stream": 10
# },
# {
# "hostname": "172.16.1.13",
# "transport": {
# "tcp": {
# "port": 514
# }
# }
# }
# ],
# "logging_on": "enable",
# "message_counter": [
# "log",
# "debug"
# ],
# "monitor": {
# "severity": "warnings"
# },
# "origin_id": {
# "tag": "hostname"
# },
# "persistent": {
# "batch": 4444
# },
# "policy_firewall": {
# "rate_limit": 10
# },
# "rate_limit": {
# "all": true,
# "except_severity": "warnings",
# "size": 2
# },
# "reload": {
# "severity": "alerts"
# },
# "snmp_trap": [
# "errors"
# ],
# "source_interface": [
# {
# "interface": "GBit1/0"
# },
# {
# "interface": "CTunnel2"
# }
# ],
# "trap": "errors",
# "userinfo": true
# }
Значения возврата
Общие значения возврата документированы здесь, следующие — поля, уникальные для данного модуля:
Ключ | Описание |
|---|---|
after словарь | Вызов результата конфигурационной модели. Возвращается: при изменении Пример: |
before словарь | Конфигурация до вызова модели. Возвращается: всегда Пример: |
commands список / элементы=строка | Набор команд, отправленных на удаленное устройство. Возвращается: всегда Пример: |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/cisco/ios/ios_logging_global_module.html