Spec-Zone.ru › Ansible

Модуль cisco.nxos.nxos_logging_global — модуль ресурса ведения журнала.

Примечание

Этот модуль входит в коллекцию cisco.nxos (версия 11.2.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Чтобы установить её, используйте: ansible-galaxy collection install cisco.nxos.

Чтобы использовать её в плейбуке, укажите: cisco.nxos.nxos_logging_global.

Добавлено в cisco.nxos 2.5.0

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

Обзор

  • Этот модуль управляет конфигурацией ведения журнала на устройствах под управлением Cisco NX-OS.

Примечание

Этому модулю соответствует модуль действий.

Псевдонимы: logging_global

Параметры

Параметр

Комментарии

config

dictionary

Словарь конфигурации ведения журнала.

console

dictionary

Задать параметры ведения журнала консоли.

severity

string

Задать уровень важности для консоли.

Варианты:

  • "emergency"
  • "alert"
  • "critical"
  • "error"
  • "warning"
  • "notification"
  • "informational"
  • "debugging"

state

string

Включить или отключить ведение журнала сообщений монитора.

Варианты:

  • "enabled"
  • "disabled"

event

dictionary

События интерфейса.

link_status

dictionary

Сообщения UPDOWN и CHANGE.

default

boolean

Конфигурация ведения журнала по умолчанию для интерфейсов, которые не были настроены явно.

Варианты:

  • false
  • true

enable

boolean

Включить ведение журнала с переопределением настройки уровня важности порта.

Варианты:

  • false
  • true

trunk_status

dictionary

Сообщения о состоянии TRUNK.

default

boolean

Конфигурация ведения журнала по умолчанию для интерфейсов, которые не были настроены явно.

Варианты:

  • false
  • true

enable

boolean

Включить ведение журнала с переопределением настройки уровня важности порта.

Варианты:

  • false
  • true

facilities

list / elements=dictionary

Параметр facility для сообщений syslog.

facility

string

Имя facility.

severity

string

Задать уровень важности для консоли.

Варианты:

  • "emergency"
  • "alert"
  • "critical"
  • "error"
  • "warning"
  • "notification"
  • "informational"
  • "debugging"

history

dictionary

Изменяет уровень важности или размер таблицы истории.

severity

string

Задать уровень важности для консоли.

Варианты:

  • "emergency"
  • "alert"
  • "critical"
  • "error"
  • "warning"
  • "notification"
  • "informational"
  • "debugging"

size

integer

Задать размер таблицы истории.

hosts

list / elements=dictionary

Включить пересылку на удаленные серверы Syslog.

facility

string

Facility, используемый при пересылке на сервер.

host

string

Имя хоста/адрес IPv4/IPv6 удаленного сервера Syslog.

port

integer

Порт назначения при пересылке на удаленный сервер.

secure

dictionary

Включить защищенное соединение с удаленным сервером.

trustpoint

dictionary

Конфигурация trustpoint.

client_identity

string

Сертификат идентификации клиента для взаимной аутентификации.

Trustpoint для аутентификации клиентского сертификата.

severity

string

Задать уровень важности для консоли.

Варианты:

  • "emergency"
  • "alert"
  • "critical"
  • "error"
  • "warning"
  • "notification"
  • "informational"
  • "debugging"

use_vrf

string

Отображать информацию по каждому VRF.

Этот параметр не поддерживается коммутаторами MDS.

ip

dictionary

Конфигурация IP.

Этот параметр не поддерживается коммутаторами MDS.

access_list

dictionary

Список контроля доступа.

cache

dictionary

Задать параметры кэширования.

entries

integer

Максимальное число записей журнала, кэшируемых в программном обеспечении.

interval

integer

Интервал обновления журнала (в секундах).

threshold

integer

Порог обновления журнала (число совпадений)

detailed

boolean

Подробная информация ACL.

Варианты:

  • false
  • true

include

dictionary

Добавлять в сообщения syslog дополнительные поля.

sgt

boolean

Добавлять в сообщения syslog сведения о теге исходной группы.

Варианты:

  • false
  • true

logfile

dictionary

Настроить ведение журнала в файл.

name

string

Имя файла журнала.

persistent_threshold

integer

Задать пороговое значение предупреждения об использовании постоянного журнала в процентах.

Этот параметр не поддерживается коммутаторами MDS.

severity

string

Задать уровень важности для консоли.

Варианты:

  • "emergency"
  • "alert"
  • "critical"
  • "error"
  • "warning"
  • "notification"
  • "informational"
  • "debugging"

size

integer

Указать размер файла журнала в байтах.

state

string

Включить или отключить файл журнала.

Варианты:

  • "enabled"
  • "disabled"

module

dictionary

Настроить ведение журнала модулей (линейных карт).

severity

string

Задать уровень важности для консоли.

Варианты:

  • "emergency"
  • "alert"
  • "critical"
  • "error"
  • "warning"
  • "notification"
  • "informational"
  • "debugging"

state

string

Включить или отключить ведение журнала модулей.

Варианты:

  • "enabled"
  • "disabled"

monitor

dictionary

Задать уровень важности ведения журнала для терминальной линии (монитора).

severity

string

Задать уровень важности для консоли.

Варианты:

  • "emergency"
  • "alert"
  • "critical"
  • "error"
  • "warning"
  • "notification"
  • "informational"
  • "debugging"

state

string

Включить или отключить ведение журнала сообщений монитора.

Варианты:

  • "enabled"
  • "disabled"

origin_id

dictionary

Включить информацию об источнике для удаленного сервера Syslog.

hostname

boolean

Использовать имя хоста в качестве origin-id сообщений журнала.

Этот параметр нельзя использовать одновременно с ip и string.

Варианты:

  • false
  • true

ip

string

Использовать IP-адрес в качестве origin-id сообщений журнала.

Этот параметр нельзя использовать одновременно с hostname и string.

string

string

Использовать текстовую строку в качестве origin-id сообщений журнала.

Этот параметр нельзя использовать одновременно с hostname и ip.

rate_limit

string

Включить или отключить ограничение частоты отправки сообщений журнала.

Варианты:

  • "enabled"
  • "disabled"

rfc_strict

boolean

Задать RFC, которому должны соответствовать сообщения.

Сообщения Syslog будут соответствовать RFC 5424.

Этот параметр не поддерживается коммутаторами MDS.

Варианты:

  • false
  • true

source_interface

string

Включить интерфейс источника для удаленного сервера Syslog.

Этот параметр не поддерживается коммутаторами MDS.

timestamp

string

Задать точность временных меток журнала.

Варианты:

  • "microseconds"
  • "milliseconds"
  • "seconds"

running_config

string

Этот параметр используется только при состоянии parsed.

Значением этого параметра должен быть вывод, полученный с устройства NX-OS при выполнении команды show running-config | include logging.

Состояние parsed считывает конфигурацию из параметра running_config и преобразует ее в структурированные данные Ansible согласно спецификации аргументов модуля ресурсов; затем значение возвращается в ключе parsed результата.

state

string

Состояние, в котором должна остаться конфигурация.

Состояния replaced и overridden работают в этом модуле одинаково.

Дополнительные сведения см. в примерах.

Варианты:

  • "merged" ← (по умолчанию)
  • "replaced"
  • "overridden"
  • "deleted"
  • "parsed"
  • "gathered"
  • "rendered"

Примечания

Примечание

  • Проверено на коммутаторах Cisco Nexus с NX-OS 9.3.6.
  • Ограниченная поддержка Cisco MDS
  • Этот модуль работает с подключениями network_cli и httpapi.
  • Проверено на Cisco MDS NX-OS 9.2(2) с подключением network_cli.

Примеры

# Using merged

# Before state:
# -------------
# nxos-9k-rdo# show running-config | include logging
# nxos-9k-rdo#

- name: Merge the provided configuration with the existing running configuration
  cisco.nxos.nxos_logging_global:
    config:
      console:
        severity: error
      monitor:
        severity: warning
      ip:
        access_list:
          cache:
            entries: 16384
            interval: 200
            threshold: 5000
      facilities:
        - facility: auth
          severity: critical
        - facility: ospfv3
          severity: alert
        - facility: ftp
          severity: informational
      hosts:
        - host: 203.0.113.100
          severity: alert
          use_vrf: management
        - host: 203.0.113.101
          severity: error
          facility: local6
          use_vrf: default
      origin_id:
        hostname: true

# Task output
# -------------
#  before: {}
#
#  commands:
#    - "logging console 3"
#    - "logging monitor 4"
#    - "logging ip access-list cache entries 16384"
#    - "logging ip access-list cache interval 200"
#    - "logging ip access-list cache threshold 5000"
#    - "logging severity auth 2"
#    - "logging severity ospfv3 1"
#    - "logging severity ftp 6"
#    - "logging server 203.0.113.100 1 use-vrf management"
#    - "logging server 203.0.113.101 3 facility local6 use-vrf default"
#    - "logging origin-id hostname"
#
# after:
#   console:
#      severity: error
#    facilities:
#      - facility: auth
#        severity: critical
#      - facility: ftp
#        severity: informational
#      - facility: ospfv3
#        severity: alert
#    ip:
#      access_list:
#        cache:
#          entries: 16384
#          interval: 200
#          threshold: 5000
#    monitor:
#      severity: warning
#    origin_id:
#      hostname: true
#    hosts:
#      - severity: alert
#        host: 203.0.113.100
#        use_vrf: management
#      - facility: local6
#        severity: error
#        host: 203.0.113.101
#        use_vrf: default

# After state:
# ------------
# nxos-9k-rdo# show running-config | include logging
# logging console 3
# logging monitor 4
# logging ip access-list cache entries 16384
# logging ip access-list cache interval 200
# logging ip access-list cache threshold 5000
# logging severity auth 2
# logging severity ospfv3 1
# logging severity ftp 6
# logging origin-id hostname
# logging server 203.0.113.100 1 use-vrf management
# logging server 203.0.113.101 3 use-vrf default facility local6

# Using replaced

# Before state:
# ------------
# nxos-9k-rdo# show running-config | include logging
# logging console 3
# logging monitor 4
# logging ip access-list cache entries 16384
# logging ip access-list cache interval 200
# logging ip access-list cache threshold 5000
# logging severity auth 2
# logging severity ospfv3 1
# logging severity ftp 6
# logging origin-id hostname
# logging server 203.0.113.100 1 use-vrf management
# logging server 203.0.113.101 3 use-vrf default facility local6

- name: Replace logging configurations with provided config
  cisco.nxos.nxos_logging_global:
    config:
      monitor:
        severity: warning
      ip:
        access_list:
          cache:
            entries: 4096
      facilities:
        - facility: auth
          severity: critical
        - facility: ospfv3
          severity: alert
        - facility: ftp
          severity: informational
      hosts:
        - host: 203.0.113.101
          severity: error
          facility: local6
          use_vrf: default
        - host: 198.51.100.101
          severity: alert
          port: 6538
          use_vrf: management
      origin_id:
        ip: 192.0.2.100
    state: replaced

# Task output
# -------------
# before:
#   console:
#      severity: error
#    facilities:
#      - facility: auth
#        severity: critical
#      - facility: ftp
#        severity: informational
#      - facility: ospfv3
#        severity: alert
#    ip:
#      access_list:
#        cache:
#          entries: 16384
#          interval: 200
#          threshold: 5000
#    monitor:
#      severity: warning
#    origin_id:
#      hostname: true
#    hosts:
#      - severity: alert
#        host: 203.0.113.100
#        use_vrf: management
#      - facility: local6
#        severity: error
#        host: 203.0.113.101
#        use_vrf: default
#
# commands:
#   - "logging console"
#   - "logging ip access-list cache entries 4096"
#   - "no logging ip access-list cache interval 200"
#   - "no logging ip access-list cache threshold 5000"
#   - "no logging origin-id hostname"
#   - "logging origin-id ip 192.0.2.100"
#   - "logging server 198.51.100.101 1 port 6538 use-vrf management"
#   - "no logging server 203.0.113.100 1 use-vrf management"
#
#  after:
#    facilities:
#      - facility: auth
#        severity: critical
#      - facility: ftp
#        severity: informational
#      - facility: ospfv3
#        severity: alert
#    ip:
#      access_list:
#        cache:
#          entries: 4096
#    monitor:
#      severity: warning
#    origin_id:
#      ip: 192.0.2.100
#    hosts:
#      - severity: alert
#        port: 6538
#        host: 198.51.100.101
#        use_vrf: management
#      - facility: local6
#        severity: error
#        host: 203.0.113.101
#        use_vrf: default
#
# After state:
# ------------
# nxos-9k-rdo# show running-config | include logging
# logging monitor 4
# logging ip access-list cache entries 4096
# logging severity auth 2
# logging severity ospfv3 1
# logging severity ftp 6
# logging origin-id ip 192.0.2.100
# logging server 203.0.113.101 3 use-vrf default facility local6
# logging server 198.51.100.101 1 port 6538 use-vrf management

# Using deleted to delete all logging configurations

# Before state:
# ------------
# nxos-9k-rdo# show running-config | include logging
# logging console 3
# logging monitor 4
# logging ip access-list cache entries 16384
# logging ip access-list cache interval 200
# logging ip access-list cache threshold 5000
# logging severity auth 2
# logging severity ospfv3 1
# logging severity ftp 6
# logging origin-id hostname
# logging server 203.0.113.100 1 use-vrf management
# logging server 203.0.113.101 3 use-vrf default facility local6

- name: Delete all logging configuration
  cisco.nxos.nxos_logging_global:
    state: deleted

# Task output
# -------------
# before:
#   console:
#      severity: error
#    facilities:
#      - facility: auth
#        severity: critical
#      - facility: ftp
#        severity: informational
#      - facility: ospfv3
#        severity: alert
#    ip:
#      access_list:
#        cache:
#          entries: 16384
#          interval: 200
#          threshold: 5000
#    monitor:
#      severity: warning
#    origin_id:
#      hostname: true
#    hosts:
#      - severity: alert
#        host: 203.0.113.100
#        use_vrf: management
#      - facility: local6
#        severity: error
#        host: 203.0.113.101
#        use_vrf: default
#
# commands:
#   - "logging console"
#   - "logging monitor"
#   - "no logging ip access-list cache entries 16384"
#   - "no logging ip access-list cache interval 200"
#   - "no logging ip access-list cache threshold 5000"
#   - "no logging origin-id hostname"
#   - "no logging severity auth 2"
#   - "no logging severity ospfv3 1"
#   - "no logging severity ftp 6"
#   - "no logging server 203.0.113.100 1 use-vrf management"
#   - "no logging server 203.0.113.101 3 facility local6 use-vrf default"
#
# after: {}

# Using rendered

- name: Render platform specific configuration lines with state rendered (without connecting to the device)
  cisco.nxos.nxos_logging_global:
    config:
      console:
        severity: error
      monitor:
        severity: warning
      ip:
        access_list:
          cache:
            entries: 16384
            interval: 200
            threshold: 5000
      facilities:
        - facility: auth
          severity: critical
        - facility: ospfv3
          severity: alert
        - facility: ftp
          severity: informational
      hosts:
        - host: 203.0.113.100
          severity: alert
          use_vrf: management
        - host: 203.0.113.101
          severity: error
          facility: local6
          use_vrf: default
      origin_id:
        hostname: true

# Task Output (redacted)
# -----------------------
#  rendered:
#    - "logging console 3"
#    - "logging monitor 4"
#    - "logging ip access-list cache entries 16384"
#    - "logging ip access-list cache interval 200"
#    - "logging ip access-list cache threshold 5000"
#    - "logging severity auth 2"
#    - "logging severity ospfv3 1"
#    - "logging severity ftp 6"
#    - "logging server 203.0.113.100 1 use-vrf management"
#    - "logging server 203.0.113.101 3 facility local6 use-vrf default"
#    - "logging origin-id hostname"

# Using parsed

# parsed.cfg
# ------------
# logging console 3
# logging monitor 4
# logging ip access-list cache entries 16384
# logging ip access-list cache interval 200
# logging ip access-list cache threshold 5000
# logging severity auth 2
# logging severity ospfv3 1
# logging severity ftp 6
# logging origin-id hostname
# logging server 203.0.113.100 1 use-vrf management
# logging server 203.0.113.101 3 use-vrf default facility local6

- name: Parse externally provided logging configuration
  cisco.nxos.nxos_logging_global:
    running_config: "{{ lookup('file', './fixtures/parsed.cfg') }}"
    state: parsed

# Task output (redacted)
# -----------------------
# parsed:
#   console:
#      severity: error
#    facilities:
#      - facility: auth
#        severity: critical
#      - facility: ftp
#        severity: informational
#      - facility: ospfv3
#        severity: alert
#    ip:
#      access_list:
#        cache:
#          entries: 16384
#          interval: 200
#          threshold: 5000
#    monitor:
#      severity: warning
#    origin_id:
#      hostname: true
#    hosts:
#      - severity: alert
#        host: 203.0.113.100
#        use_vrf: management
#      - facility: local6
#        severity: error
#        host: 203.0.113.101
#        use_vrf: default

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

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

Ключ

Описание

after

dictionary

Конфигурация после выполнения модуля.

Возвращается: при наличии изменений

Пример: "This output will always be in the same format as the module argspec.\n"

before

dictionary

Конфигурация до выполнения модуля.

Возвращается: если для параметра state задано значение merged, replaced, overridden, deleted или purged

Пример: "This output will always be in the same format as the module argspec.\n"

commands

list / elements=string

Набор команд, отправленных на удалённое устройство.

Возвращается: если для параметра state задано значение merged, replaced, overridden, deleted или purged

Пример: ["logging console 3", "logging monitor 4", "logging ip access-list cache entries 16384", "logging ip access-list cache interval 200", "logging ip access-list cache threshold 5000"]

gathered

list / elements=string

Сведения о сетевом ресурсе, собранные с удалённого устройства в виде структурированных данных.

Возвращается: если для параметра state задано значение gathered

Пример: ["This output will always be in the same format as the module argspec.\n"]

parsed

list / elements=string

Собственная конфигурация устройства, переданная в параметре running_config и преобразованная в структурированные данные согласно спецификации аргументов модуля.

Возвращается: если для параметра state задано значение parsed

Пример: ["This output will always be in the same format as the module argspec.\n"]

rendered

list / elements=string

Переданная в задаче конфигурация преобразована в собственный формат устройства (в автономном режиме).

Возвращается: если для параметра state задано значение rendered

Пример: ["logging ip access-list cache entries 4096", "no logging ip access-list cache interval 200", "no logging ip access-list cache threshold 5000", "no logging origin-id hostname", "logging origin-id ip 192.0.2.100", "logging server 198.51.100.101 1 port 6538 use-vrf management"]

Авторы

  • Nilashish Chakraborty (@NilashishC)

Ссылки на коллекцию

  • Отслеживание проблем
  • Репозиторий (исходный код)

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/cisco/nxos/nxos_logging_global_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API