nxos_logging — Управление журналированием на сетевых устройствах NX-OS
Новая версия 2.4.
Обзор
- Этот модуль обеспечивает декларативное управление журналированием на устройствах Cisco NX-OS.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| aggregate | Список определений журналирования. | ||
| dest |
| Место назначения журнальных записей. | |
| dest_level | Установите уровни серьезности журналирования. псевдонимы: level | ||
| facility | Имя объекта журналирования. | ||
| facility_level | Установите уровни серьезности журналирования для сообщений журнала, основанных на объекте. | ||
| name | Если значение dest равно logfile, это указывает имя файла. | ||
| provider | Устарело Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli. Этот параметр требуется только при использовании NX-API. Дополнительная информация в руководстве по настройке NXOS NXOS Platform Options. Объект словаря, содержащий сведения о подключении. | ||
| host обязательно | Указывает имя хоста DNS или адрес для подключения к удаленному устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта. | ||
| port | По умолчанию: "0 (использовать общий порт)" | Указывает порт для использования при создании подключения к удаленному устройству. Это значение относится к cli или nxapi. Значение порта по умолчанию будет соответствовать общему порту транспорта, если он не указан в задаче (cli=22, http=80, https=443). | |
| username | Настраивает имя пользователя для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации входа в командную строку или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_USERNAME. | ||
| password | Указывает пароль для аутентификации подключения к удаленному устройству. Это общий аргумент, используемый для cli или nxapi транспортов. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_PASSWORD. | ||
| authorize bool (добавлено в 2.5.3) |
| Инструктирует модуль войти в привилегированный режим на удаленном устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTHORIZE. | |
| auth_pass (добавлено в 2.5.3) | По умолчанию: "нет" | Указывает пароль для использования, если требуется для входа в привилегированный режим на удаленном устройстве. Если authorize равно false, этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTH_PASS. | |
| timeout (добавлено в 2.3) | По умолчанию: 10 | Указывает таймаут в секундах для связи с сетевым устройством для подключения или отправки команд. Если таймаут превышен до завершения операции, модуль вернет ошибку. NX-API может медленно возвращать данные при длительных командах (sh mac, sh bgp и т.д.). | |
| ssh_keyfile | Указывает SSH-ключ для аутентификации подключения к удаленному устройству. Этот аргумент используется только для транспорта cli. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_SSH_KEYFILE. | ||
| transport обязательно | По умолчанию: "cli" | Настраивает транспортное соединение для подключения к удаленному устройству. Параметр transport поддерживает подключение к устройству через cli (ssh) или nxapi. | |
| use_ssl bool |
| Настраивает transport для использования SSL, если значение равно true, только если transport=nxapi, в противном случае это значение игнорируется. | |
| validate_certs bool |
| Если no, сертификаты SSL не будут проверены. Это следует использовать только на сайтах, контролируемых вами, которые используют самозаверенные сертификаты. Если параметр transport не nxapi, это значение игнорируется. | |
| use_proxy bool (добавлено в 2.5) |
| Если no, переменные окружения http_proxy и https_proxy будут проигнорированы. | |
| state |
| Состояние конфигурации журнала. | |
Примечания
Примечание
- Подробную информацию об использовании командной строки и NX-API см. в руководстве NXOS Platform Options
- Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в руководстве Ansible Network Guide
- Дополнительную информацию об использовании 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 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
Значения возврата
Общие значения возврата описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| commands список | всегда | Список команд конфигурации режима, которые необходимо отправить на устройство Пример: ['logging console 2', 'logging logfile testfile 3', 'logging level daemon 0'] |
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется обратной совместимостью.
Техническое обслуживание
Этот модуль помечен как сетевой, что означает, что его обслуживает команда Ansible Network Team. Дополнительную информацию см. в разделе Техническое обслуживание и поддержка модулей.
Список других модулей, также поддерживаемых командой Ansible Network Team, см. здесь.
Поддержка
Дополнительную информацию о поддержке этого модуля компанией Red Hat см. в этой статье Knowledge Base.
Автор
- 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.6/modules/nxos_logging_module.html
