eos_logging – Управление журналированием на устройствах сети
Новое в версии 2.4.
Обзор
- Этот модуль предоставляет декларативное управление журналированием на устройствах Arista Eos.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| aggregate - | Список определений журналирования. | ||
| auth_pass - | Устарело Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli и become: yes с become_pass. Этот параметр необходим только при использовании eAPI. Для получения дополнительной информации см. руководство EOS Platform Options. Указывает пароль, используемый для входа в привилегированный режим на удалённом устройстве. Если authorize имеет значение false, этот аргумент игнорируется. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTH_PASS. | ||
| authorize boolean |
| Устарело Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli и become: yes. Этот параметр необходим только при использовании eAPI. Для получения дополнительной информации см. руководство EOS Platform Options. Указывает модулю войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTHORIZE. | |
| dest - |
| Место назначения логов. | |
| facility - | Устанавливает уровень журналирования. | ||
| level - |
| Устанавливает уровни серьёзности журналирования. | |
| name - | Если значение dest равно host, необходимо указать name, что указывает на имя хоста или IP-адрес. | ||
| provider - | Устарело Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli. Этот параметр необходим только при использовании eAPI. Для получения дополнительной информации см. руководство EOS Platform Options. Объект словаря, содержащий данные подключения. | ||
| auth_pass - | Указывает пароль, используемый для входа в привилегированный режим на удалённом устройстве. Если authorize имеет значение false, этот аргумент игнорируется. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTH_PASS. | ||
| authorize boolean |
| Указывает модулю войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTHORIZE. | |
| host - / обязательно | Указывает имя хоста DNS или адрес для подключения к удалённому устройству через указанный транспорт. Значение host используется в качестве целевого адреса для транспорта. | ||
| password - | Указывает пароль для аутентификации подключения к удалённому устройству. Этот аргумент обычно используется для транспортов cli или eapi. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_PASSWORD. | ||
| port - | По умолчанию: "0 (использовать стандартный порт)" | Указывает порт для подключения к удалённому устройству. Это значение применяется к транспорту cli или eapi. Значение порта по умолчанию соответствует стандартному порту транспорта, если не указано в задаче. (cli=22, http=80, https=443). | |
| ssh_keyfile - | Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Этот аргумент используется только для транспортов cli. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_SSH_KEYFILE. | ||
| timeout - | По умолчанию: 10 | Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истечёт до завершения операции, модуль выдаст ошибку. | |
| transport - / обязательно |
| Настройка транспорта для подключения к удалённому устройству. | |
| use_proxy boolean добавлен в 2.5 |
| Если no, переменные среды http_proxy и https_proxy будут проигнорированы. | |
| use_ssl boolean |
| Настройка транспорта transport для использования SSL, если установлено значение true только тогда, когда transport=eapi. Если аргумент transport не eapi, это значение игнорируется. | |
| username - | Указывает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации входа в CLI или аутентификации eAPI в зависимости от используемого транспорта. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_USERNAME. | ||
| validate_certs boolean |
| Если no, сертификаты SSL не будут проверены. Это должно использоваться только на контролируемых сайтах с самоподписанными сертификатами. Если аргумент transport не eapi, это значение игнорируется. | |
| size - | Размер буфера. Приемлемое значение находится в диапазоне от 10 до 2147483647 байт. | ||
| state - |
| Состояние конфигурации журналирования. | |
Примечания
Примечание
- Тестировалось на EOS 4.15
- Для информации по использованию CLI, eAPI и привилегированного режима см. EOS Platform Options
- Для получения дополнительной информации по использованию Ansible для управления сетевыми устройствами см. Ansible Network Guide
- Для получения дополнительной информации по использованию Ansible для управления устройствами Arista EOS см. страницу интеграции Arista.
Примеры
- 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'] |
Статус
- Интерфейс этого модуля не гарантирует обратную совместимость. [превью]
- Этот модуль поддерживается командой Ansible Network Team. [сеть]
Поддержка 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.7/modules/eos_logging_module.html