Spec-Zone.ru › Ansible

модуль cisco.intersight.intersight_syslog_policy — настройка политики Syslog для Cisco Intersight

Примечание

Этот модуль входит в коллекцию cisco.intersight (версия 2.18.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните команду ansible-galaxy collection list.

Чтобы установить её, используйте: ansible-galaxy collection install cisco.intersight.

Чтобы использовать её в плейбуке, укажите: cisco.intersight.intersight_syslog_policy.

  • Краткое описание
  • Параметры
  • Примеры
  • Возвращаемые значения

Краткое описание

  • Управляет настройкой политики Syslog в Cisco Intersight.
  • Эта политика настраивает уровень важности локального журналирования и до двух удалённых серверов Syslog для управляемых устройств.
  • Дополнительную информацию см. в документации Cisco Intersight.

Параметры

Параметр

Комментарии

api_key_id

string / обязательный

Идентификатор открытого ключа API, связанного с закрытым ключом.

Если значение не задано, используется значение переменной среды INTERSIGHT_API_KEY_ID.

api_private_key

path / обязательный

Имя файла (абсолютный путь) или строка с данными закрытого ключа в формате PEM, используемого для аутентификации в Intersight API.

Если используется строка, для шифрования строковых данных следует использовать Ansible Vault.

Например: ansible-vault encrypt_string --vault-id tme@/Users/dsoper/Documents/vault_password_file ‘-----BEGIN EC PRIVATE KEY-----

<your private key data>

-----END EC PRIVATE KEY-----’

Если значение не задано, используется значение переменной среды INTERSIGHT_API_PRIVATE_KEY.

api_uri

string

URI для доступа к Intersight API.

Если значение не задано, используется значение переменной среды INTERSIGHT_API_URI.

По умолчанию: "https://intersight.com/api/v1"

description

псевдонимы: descr

string

Описание политики Syslog, заданное пользователем.

first_remote_logging_enabled

boolean

Если true, включается первый удалённый сервер Syslog.

Варианты:

  • false ← (по умолчанию)
  • true

first_remote_logging_hostname

string

Имя хоста или IP-адрес первого сервера Syslog, на котором следует хранить журнал.

Этот параметр обязателен, если first_remote_logging_enabled имеет значение true.

first_remote_logging_minimum_severity

string

Наименьший уровень важности сообщений, включаемых в первый удалённый журнал.

Варианты:

  • "warning" ← (по умолчанию)
  • "emergency"
  • "alert"
  • "critical"
  • "error"
  • "notice"
  • "informational"
  • "debug"

first_remote_logging_port

integer

Номер порта, используемый для журналирования на первом сервере Syslog.

По умолчанию: 514

first_remote_logging_protocol

string

Протокол транспортного уровня для передачи сообщений журнала на первый сервер Syslog.

Варианты:

  • "udp" ← (по умолчанию)
  • "tcp"

local_logging_minimum_severity

string

Наименьший уровень важности сообщений, включаемых в локальный журнал.

Варианты:

  • "warning" ← (по умолчанию)
  • "emergency"
  • "alert"
  • "critical"
  • "error"
  • "notice"
  • "informational"
  • "debug"

name

string / обязательный

Имя, присвоенное политике Syslog.

organization

string

Название организации, которой назначен этот ресурс.

По умолчанию: "default"

second_remote_logging_enabled

boolean

Если true, включается второй удалённый сервер Syslog.

Варианты:

  • false ← (по умолчанию)
  • true

second_remote_logging_hostname

string

Имя хоста или IP-адрес второго сервера Syslog, на котором следует хранить журнал.

Этот параметр обязателен, если second_remote_logging_enabled имеет значение true.

second_remote_logging_minimum_severity

string

Наименьший уровень важности сообщений, включаемых во второй удалённый журнал.

Варианты:

  • "warning" ← (по умолчанию)
  • "emergency"
  • "alert"
  • "critical"
  • "error"
  • "notice"
  • "informational"
  • "debug"

second_remote_logging_port

integer

Номер порта, используемый для журналирования на втором сервере Syslog.

По умолчанию: 514

second_remote_logging_protocol

string

Протокол транспортного уровня для передачи сообщений журнала на второй сервер Syslog.

Варианты:

  • "udp" ← (по умолчанию)
  • "tcp"

state

string

Если present, проверяет наличие ресурса и при необходимости создаёт его.

Если absent, проверяет отсутствие ресурса и при необходимости удаляет его.

Варианты:

  • "present" ← (по умолчанию)
  • "absent"

tags

list / элементы=dictionary

Список тегов в формате «Ключ:<ключ, заданный пользователем> Значение:<значение, заданное пользователем>».

use_proxy

boolean

Если no, прокси-сервер использоваться не будет, даже если он задан в переменной среды на целевых узлах.

Варианты:

  • false
  • true ← (по умолчанию)

validate_certs

boolean

Логический параметр, управляющий проверкой TLS-сертификата api_uri.

Варианты:

  • false
  • true ← (по умолчанию)

Примеры

- name: Create a Syslog Policy with one remote server enabled
  cisco.intersight.intersight_syslog_policy:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    name: "Syslog-Policy-PROD"
    description: "Syslog policy for production servers"
    tags:
      - Key: "Env"
        Value: "Production"
    local_logging_minimum_severity: "notice"
    first_remote_logging_enabled: true
    first_remote_logging_hostname: "10.10.10.50"
    first_remote_logging_port: 514
    first_remote_logging_protocol: "udp"
    first_remote_logging_minimum_severity: "informational"

- name: Create a Syslog Policy with only local logging configured
  cisco.intersight.intersight_syslog_policy:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    name: "Syslog-Policy-Local-Only"
    description: "Send only critical local logs"
    local_logging_minimum_severity: "critical"

- name: Delete a Syslog Policy
  cisco.intersight.intersight_syslog_policy:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    name: "Syslog-Policy-PROD"
    state: absent

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

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

Ключ

Описание

api_response

dictionary

Ответ API, возвращаемый для указанного ресурса.

Возвращается: всегда

Пример: {"api_response": {"LocalClients": [{"ClassId": "syslog.LocalFileLoggingClient", "MinSeverity": "critical", "ObjectType": "syslog.LocalFileLoggingClient"}], "Name": "Syslog-Policy-Local-Only", "ObjectType": "syslog.Policy", "Tags": []}}

Авторы

  • Ron Gershburg (@rgershbu)

Ссылки на коллекцию

  • Отслеживание проблем
  • Репозиторий (исходный код)

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/cisco/intersight/intersight_syslog_policy_module.html

Spec-Zone.ru

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