Spec-Zone.ru › Ansible 2.9

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

Новая в версии 2.4.

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

Обзор

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

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
aggregate
-
Список определений логирования.
dest
-
    Варианты:
  • console
  • logfile
  • module
  • monitor
  • server
Место назначения логов.
dest_level
-
Установить уровни серьезности логирования.

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

Примечания

Примечание

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

Примеры

- name: configure console logging with level
  nxos_logging:
    dest: console
    level: 2
    state: present
- name: remove console logging configuration
  nxos_logging:
    dest: console
    level: 2
    state: absent
- name: configure file logging with level
  nxos_logging:
    dest: logfile
    name: testfile
    dest_level: 3
    state: present
- name: Configure logging logfile with size
  nxos_logging:
    dest: logfile
    name: testfile
    dest_level: 3
    file_size: 16384
- name: configure facility level logging
  nxos_logging:
    facility: daemon
    facility_level: 0
    state: present
- name: remove facility level logging
  nxos_logging:
    facility: daemon
    facility_level: 0
    state: absent
- name: Configure Remote Logging
  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
  nxos_logging:
    interface: mgmt0
    state: present
- name: Purge nxos_logging configuration not managed by this playbook
  nxos_logging:
    purge: true
- name: Configure logging timestamp
  nxos_logging:
    timestamp: milliseconds
    state: present
- name: Configure logging facility ethpm link status
  nxos_logging:
    facility: ethpm
    facility_link_status: link-up-notif
    state: present
- name: Configure logging message ethernet description
  nxos_logging:
    interface_message: add-interface-description
    state: present
- name: Configure logging event link enable
  nxos_logging:
    event: link-enable
    state: present
- name: Configure logging using aggregate
  nxos_logging:
    aggregate:
      - { dest: console, dest_level: 2 }
      - { dest: logfile, dest_level: 2, name: testfile }
      - { facility: daemon, facility_level: 0 }
    state: present

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

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

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

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


Статус

  • Гарантия обратной совместимости интерфейса этого модуля не предоставляется. [превью]
  • Этот модуль поддерживается командой Ansible по сетям. [сеть]

Поддержка Red Hat

Дополнительную информацию о поддержке этого модуля Red Hat см. в этой статье базы знаний Red Hat.

Авторы

  • Trishna Guha (@trishnaguha)

Подсказка

Если вы обнаружите какие-либо проблемы в данном руководстве, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/nxos_logging_module.html

Spec-Zone.ru

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