Spec-Zone.ru › Ansible 2.5

eos_logging — Управление журналированием на устройствах сети

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

  • Описание
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения
  • Статус
    • Поддержка
    • Автор

Описание

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

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
aggregate
Список определений журналирования.
auth_pass По умолчанию:
нет
Устарело
Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli и become: yes с become_pass.
Этот параметр необходим только при использовании eAPI.
Дополнительную информацию см. в руководстве EOS Platform Options.
Указывает пароль, используемый для входа в привилегированный режим на удалённом устройстве. Если authorize ложно, этот параметр игнорируется. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTH_PASS.
authorize
    Варианты:
  • да
  • нет ←
Устарело
Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli и become: yes.
Этот параметр необходим только при использовании eAPI.
Дополнительную информацию см. в руководстве EOS Platform Options.
Указывает модулю войти в привилегированный режим на удалённом устройстве перед отправкой команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTHORIZE.
dest
    Варианты:
  • on
  • host
  • console'
  • monitor
  • buffered
Назначение журналов.
facility
Установить уровень журналирования.
level
    Варианты:
  • emergencies
  • alerts
  • critical
  • errors
  • warnings
  • notifications
  • informational
  • debugging
Установить уровни важности журналирования.
name
Если значение dest равно host, необходимо указать name, что обозначает имя хоста или IP-адрес.
provider По умолчанию:
None
Устарело
Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli.
Этот параметр необходим только при использовании eAPI.
Дополнительную информацию см. в руководстве EOS Platform Options.
Объект словаря, содержащий данные подключения.
username
Устанавливает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации входа в командную строку или аутентификации eAPI в зависимости от используемого транспорта. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_USERNAME.
authorize
    Варианты:
  • да
  • нет ←
Указывает модулю войти в привилегированный режим на удалённом устройстве перед отправкой команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTHORIZE.
ssh_keyfile
Указывает SSH-ключевой файл для аутентификации подключения к удалённому устройству. Этот параметр используется только для транспортов cli. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_SSH_KEYFILE.
use_proxy
(добавлено в 2.5)
    Варианты:
  • да ←
  • нет
Если no, переменные окружения http_proxy и https_proxy будут проигнорированы.
auth_pass По умолчанию:
нет
Указывает пароль, используемый для входа в привилегированный режим на удалённом устройстве. Если authorize ложно, этот параметр игнорируется. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTH_PASS.
host
обязательно
Указывает имя DNS-хоста или адрес для подключения к удалённому устройству через указанный транспорт. Значение параметра host используется в качестве адреса назначения для транспорта.
timeout По умолчанию:
10
Указывает таймаут в секундах для связи с сетевым устройством для подключения или отправки команд. Если таймаут истекает до завершения операции, модуль выдаст ошибку.
use_ssl
    Варианты:
  • да ←
  • нет
Настраивает транспорт transport для использования SSL, если значение истинно, только когда transport=eapi. Если параметр transport не равен eapi, это значение игнорируется.
password По умолчанию:
None
Указывает пароль, используемый для аутентификации подключения к удалённому устройству. Это общий параметр, используемый как для cli, так и для eapi транспортов. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_PASSWORD.
validate_certs
    Варианты:
  • да
  • нет
Если no, сертификаты SSL не будут проверяться. Это следует использовать только на управляемых локально сайтах с самозаверяющимися сертификатами. Если параметр transport не равен eapi, это значение игнорируется.
port По умолчанию:
0 (использовать общий порт)
Указывает порт, используемый при построении подключения к удалённому устройству. Это значение относится как к cli, так и к eapi. Значение порта будет по умолчанию равно соответствующему общему порту транспорта, если не указано другое значение в задаче (cli=22, http=80, https=443).
transport
обязательно
    Варианты:
  • eapi
  • cli ←
Настраивает транспортное соединение, используемое при подключении к удалённому устройству.
size
Размер буфера. Допустимое значение находится в диапазоне от 10 до 2147483647 байт.
state
    Варианты:
  • present ←
  • absent
Состояние конфигурации журналирования.

Примечания

Примечание

  • Тестировалось на EOS 4.15
  • Дополнительную информацию об использовании командной строки, eAPI и привилегированного режима см. в руководстве EOS Platform Options
  • Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в руководстве Ansible Network Guide
  • Дополнительную информацию об использовании Ansible для управления устройствами Arista EOS см. на странице интеграции Arista Arista integration page.

Примеры

- name: configure host logging
  eos_logging:
    dest: host
    name: 172.16.0.1
    state: present

- name: remove host logging configuration
  eos_logging:
    dest: host
    name: 172.16.0.1
    state: absent

- name: configure console logging level and facility
  eos_logging:
    dest: console
    facility: local7
    level: debugging
    state: present

- name: enable logging to all
  eos_logging:
    dest : on

- name: configure buffer size
  eos_logging:
    dest: buffered
    size: 5000

- name: Configure logging using aggregate
  eos_logging:
    aggregate:
      - { dest: console, level: warnings }
      - { dest: buffered, size: 480000 }
    state: present

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

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

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

Пример:
['logging facility local7', 'logging host 172.16.0.1']


Статус

Этот модуль помечен как preview, что означает, что интерфейс не гарантируется, что будет обратной совместимостью.

Поддержка

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

Автор

  • 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.5/modules/eos_logging_module.html

Spec-Zone.ru

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