nxos_logging – Управление журналированием на сетевых устройствах
Новое в версии 2.4.
Обзор
- Этот модуль предоставляет декларативное управление журналированием на устройствах Cisco NX-OS.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| aggregate - | Список определений журналирования. | ||
| dest - |
| Место назначения журналов. | |
| dest_level - | Установление уровней серьезности журналирования. псевдонимы: уровень | ||
| facility - | Имя объекта для журналирования. | ||
| facility_level - | Установка уровней серьезности журналирования для сообщений журнала, основанных на объекте. | ||
| interface - добавлен в 2.7 | Интерфейс, который необходимо использовать при настройке интерфейса источника для журналирования (например, 'Ethernet1/2', 'mgmt0'). | ||
| name - | Если значение dest равно logfile, это указывает имя файла. | ||
| provider - | Устаревший Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli. Этот параметр необходим только при использовании NX-API. Для получения дополнительной информации обратитесь к руководству NXOS Platform Options. Объект dict, содержащий данные подключения. | ||
| auth_pass - добавлен в 2.5.3 | Значение по умолчанию: "none" | Указывает пароль, который необходимо использовать, если требуется ввести привилегированный режим на удаленном устройстве. Если authorize имеет значение false, этот аргумент не используется. Если значение не указано в задаче, вместо него будет использоваться значение переменной среды ANSIBLE_NET_AUTH_PASS. | |
| authorize boolean добавлен в 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 - / обязательно | Значение по умолчанию: "cli" | Настраивает транспортное соединение для подключения к удалённому устройству. Аргумент транспорт поддерживает подключение к устройству через cli (ssh) или nxapi. | |
| use_proxy boolean добавлен в 2.5 |
| Если no, переменные среды http_proxy и https_proxy будут проигнорированы. | |
| use_ssl boolean |
| Настраивает транспорт для использования SSL, если значение равно true, только когда transport=nxapi, в противном случае это значение игнорируется. | |
| username - | Настраивает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации входа в CLI или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задаче, вместо него будет использоваться значение переменной среды ANSIBLE_NET_USERNAME. | ||
| validate_certs boolean |
| Если no, сертификаты SSL не будут проверены. Это следует использовать только на сайтах под личным контролем, использующих самозаверяющие сертификаты. Если аргумент транспорт не равен nxapi, это значение игнорируется. | |
| remote_server - добавлен в 2.7 | Имя хоста или IP-адрес для удалённого журналирования (когда dest равен 'server'). | ||
| state - |
| Состояние конфигурации журналирования. | |
| 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 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: 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.
Авторы
- 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/nxos_logging_module.html