Spec-Zone.ru › Ansible 2.11

cisco.nxos.nxos_logging – Управление журналированием на сетевых устройствах

Примечание

Этот плагин является частью коллекции cisco.nxos (версии 1.4.0).

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

Для использования в playbook, укажите: cisco.nxos.nxos_logging

Новое в версии 1.0.0: of cisco.nxos

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

Обзор

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

Примечание

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

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
aggregate
list / elements=dictionary
Список определений журналирования.
dest
string
    Варианты:
  • console
  • logfile
  • module
  • monitor
  • server
Назначение журналов.
dest_level
integer
Устанавливает уровни серьезности журналирования.

псевдонимы: level
event
string
    Варианты:
  • link-enable
  • link-default
  • trunk-enable
  • trunk-default
Журналирование конфигурации интерфейсов link/trunk enable/default
facility
string
Имя объекта для журналирования.
facility_level
integer
Устанавливает уровни серьезности журналирования для сообщений журнала, основанных на объекте.
facility_link_status
string
    Варианты:
  • link-down-notif
  • link-down-error
  • link-up-notif
  • link-up-error
Установить объект журналирования состояния канала ethpm. Не идемпотентен для изображений версии 6.0.
file_size
integer
Установить размер файла журнала
interface
string
Интерфейс, который будет использоваться при конфигурировании source-interface для журналирования (например, 'Ethernet1/2', 'mgmt0')
interface_message
string
    Варианты:
  • add-interface-description
Добавить описание интерфейса в syslog интерфейса. Не работает с изображениями версии 6.0, использующими nxapi в качестве транспорта.
name
string
Если значение dest равно logfile, это указывает имя файла.
provider
dictionary
Устарело
Начиная с Ansible 2.5, мы рекомендуем использовать connection: network_cli
Начиная с Ansible 2.6, мы рекомендуем использовать connection: httpapi для NX-API.
Этот параметр будет удален в релизе после 2022-06-01.
Для получения дополнительной информации, см. руководство NXOS Platform Options.
Объект dict, содержащий сведения о подключении.
auth_pass
string
Указывает пароль, который необходимо использовать, если требуется перейти в привилегированный режим на удаленном устройстве. Если authorize ложно, то этот аргумент ничего не делает. Если значение не указано в задании, будет использоваться значение переменной среды ANSIBLE_NET_AUTH_PASS
authorize
boolean
    Варианты:
  • нет ←
  • да
Указывает модулю перейти в привилегированный режим на удаленном устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задании, будет использоваться значение переменной среды ANSIBLE_NET_AUTHORIZE
host
string
Указывает имя хоста DNS или адрес для подключения к удаленному устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта.
password
string
Указывает пароль, используемый для аутентификации подключения к удаленному устройству. Это общий аргумент, используемый для транспортов cli или nxapi. Если значение не указано в задании, будет использоваться значение переменной среды ANSIBLE_NET_PASSWORD
port
integer
Указывает порт, используемый при построении подключения к удаленному устройству. Это значение относится к cli или nxapi. Значение порта будет по умолчанию соответствовать общему порту соответствующего транспорта, если он не указан в задании (cli=22, http=80, https=443).
ssh_keyfile
string
Указывает SSH-ключ, используемый для аутентификации подключения к удаленному устройству. Этот аргумент используется только для транспорта cli. Если значение не указано в задании, будет использоваться значение переменной среды ANSIBLE_NET_SSH_KEYFILE
timeout
integer
Указывает время ожидания в секундах для связи с сетевым устройством при подключении или отправке команд. Если время ожидания истечет до завершения операции, модуль выдаст ошибку. NX-API может медленно отвечать на длительные команды (sh mac, sh bgp и т. д.).
transport
string
    Варианты:
  • cli ←
  • nxapi
Настраивает транспортное соединение, используемое при подключении к удаленному устройству. Аргумент transport поддерживает подключение к устройству по cli (ssh) или nxapi.
use_proxy
boolean
    Варианты:
  • нет
  • да ←
Если no, переменные среды http_proxy и https_proxy будут проигнорированы.
use_ssl
boolean
    Варианты:
  • нет ←
  • да
Настраивает transport для использования SSL, если значение равно yes, только если transport=nxapi, в противном случае это значение игнорируется.
username
string
Настраивает имя пользователя, используемое для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации входа в CLI или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задании, будет использоваться значение переменной среды ANSIBLE_NET_USERNAME
validate_certs
boolean
    Варианты:
  • нет ←
  • да
Если no, сертификаты SSL не будут проверены. Это следует использовать только на контролируемых вами сайтах, использующих самозаверенные сертификаты. Если аргумент transport не nxapi, это значение игнорируется.
purge
boolean
    Варианты:
  • нет ←
  • да
Удалить любую конфигурацию журналирования коммутатора, которая не соответствует настроенной конфигурации. Не поддерживается для ansible_connection local. Все задачи nxos_logging должны использовать тот же тип ansible_connection.
remote_server
string
Имя хоста или IP-адрес для удаленного журналирования (когда dest — 'server').
state
string
    Варианты:
  • present ←
  • absent
Состояние конфигурации журналирования.
timestamp
string
    Варианты:
  • микросекунды
  • миллисекунды
  • секунды
Установить формат временной метки журналирования
use_vrf
string
VRF, который будет использован при настройке удаленного журналирования (когда dest — 'server').

Примечания

Примечание

  • Дополнительную информацию об использовании CLI и NX-API см. в руководстве NXOS Platform Options
  • Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в руководстве Ansible Network Guide
  • Для получения дополнительной информации об использовании Ansible для управления устройствами Cisco см. страницу интеграции Cisco.

Примеры

- name: configure console logging with level
  cisco.nxos.nxos_logging:
    dest: console
    level: 2
    state: present
- name: remove console logging configuration
  cisco.nxos.nxos_logging:
    dest: console
    level: 2
    state: absent
- name: configure file logging with level
  cisco.nxos.nxos_logging:
    dest: logfile
    name: testfile
    dest_level: 3
    state: present
- name: Configure logging logfile with size
  cisco.nxos.nxos_logging:
    dest: logfile
    name: testfile
    dest_level: 3
    file_size: 16384
- name: configure facility level logging
  cisco.nxos.nxos_logging:
    facility: daemon
    facility_level: 0
    state: present
- name: remove facility level logging
  cisco.nxos.nxos_logging:
    facility: daemon
    facility_level: 0
    state: absent
- name: Configure Remote Logging
  cisco.nxos.nxos_logging:
    dest: server
    remote_server: test-syslogserver.com
    facility: auth
    facility_level: 1
    use_vrf: management
    state: present
- name: Configure Source Interface for Logging
  cisco.nxos.nxos_logging:
    interface: mgmt0
    state: present
- name: Purge nxos_logging configuration not managed by this playbook
  cisco.nxos.nxos_logging:
    purge: true
- name: Configure logging timestamp
  cisco.nxos.nxos_logging:
    timestamp: milliseconds
    state: present
- name: Configure logging facility ethpm link status
  cisco.nxos.nxos_logging:
    facility: ethpm
    facility_link_status: link-up-notif
    state: present
- name: Configure logging message ethernet description
  cisco.nxos.nxos_logging:
    interface_message: add-interface-description
    state: present
- name: Configure logging event link enable
  cisco.nxos.nxos_logging:
    event: link-enable
    state: present
- name: Configure logging using aggregate
  cisco.nxos.nxos_logging:
    aggregate:
    - {dest: console, dest_level: 2}
    - {dest: logfile, dest_level: 2, name: testfile}
    - {facility: daemon, facility_level: 0}
    state: present

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

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

Ключ Возвращаемое Описание
commands
list / elements=string
всегда
Список команд режима конфигурации, которые необходимо отправить устройству

Пример:
['logging console 2', 'logging logfile testfile 3', 'logging level daemon 0']


Авторы

  • Trishna Guha (@trishnaguha)

© 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/cisco/nxos/nxos_logging_module.html

Spec-Zone.ru

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