nxos_logging – Управление журналированием на сетевых устройствах
Новая в версии 2.4.
Обзор
- Этот модуль обеспечивает декларативное управление журналированием на устройствах Cisco NX-OS.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| aggregate - | Список определений логирования. | ||
| dest - |
| Место назначения логов. | |
| dest_level - | Установить уровни серьезности логирования. псевдонимы: level | ||
| event - добавлен в 2.8 |
| Логирование конфигурации интерфейсов link/trunk enable/default | |
| facility - | Имя объекта для логирования. | ||
| facility_level - | Установить уровни серьезности логирования для сообщений логов, основанных на объекте. | ||
| facility_link_status - добавлен в 2.8 |
| Установить логирование состояния канала ethpm. Не идемпотентно для изображений версии 6.0. | |
| file_size - добавлен в 2.8 | Установить размер файла журнала | ||
| interface - добавлен в 2.7 | Интерфейс, который будет использоваться при конфигурировании интерфейса источника для логирования (например, 'Ethernet1/2', 'mgmt0') | ||
| interface_message - добавлен в 2.8 |
| Добавление описания интерфейса в системные журналы интерфейса. Не работает с изображениями версии 6.0, использующими nxapi в качестве транспортного средства. | |
| name - | Если значение dest равно logfile, это указывает имя файла. | ||
| provider словарь | Устарело Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli. Этот параметр необходим только при использовании NX-API. Для получения дополнительной информации см. руководство NXOS Platform Options. Объект словаря, содержащий данные соединения. | ||
| auth_pass строка добавлен в 2.5.3 | Указывает пароль для использования при входе в привилегированный режим на удаленном устройстве. Если authorize равно false, этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной окружения 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 целое число добавлен в 2.3 | Значение по умолчанию: 10 | Указывает время ожидания в секундах для связи с сетевым устройством для подключения или отправки команд. Если время ожидания истечёт до завершения операции, модуль выдаст ошибку. NX-API может медленно возвращать результаты при выполнении длительных команд (sh mac, sh bgp и т. д.). | |
| transport строка / обязательно |
| Настройка транспортного подключения для соединения с удалённым устройством. Аргумент 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 - |
| Состояние конфигурации логирования. | |
| timestamp - добавлено в 2.8 |
| Установить формат временной метки регистрации | |
| use_vrf - добавлено в 2.7 | VRF, который будет использоваться при настройке удалённой регистрации (когда dest — 'server'). | ||
Примечания
Примечание
- Дополнительную информацию об использовании командной строки и NX-API см. в руководстве NXOS Platform Options
- Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в руководстве Ansible Network Guide
- Дополнительную информацию об использовании Ansible для управления устройствами Cisco см. на странице интеграции Cisco Cisco integration page.
Примеры
- 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 Network Team. [сеть]
Поддержка Red Hat
Дополнительную информацию о поддержке этого модуля Red Hat см. в статье базы знаний Red Hat 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.8/modules/nxos_logging_module.html