Spec-Zone.ru › Ansible

Модуль hitachivantara.vspone_block.sds_block.hv_sds_block_audit_log_setting — управление настройками журнала аудита блочной системы хранения Hitachi SDS.

Примечание

Этот модуль входит в коллекцию hitachivantara.vspone_block (версия 4.8.1).

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

Для установки используйте: ansible-galaxy collection install hitachivantara.vspone_block. Для работы с этим модулем требуются дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать модуль в сценарии, укажите: hitachivantara.vspone_block.sds_block.hv_sds_block_audit_log_setting.

Добавлено в hitachivantara.vspone_block 4.6.0

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

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

  • Этот модуль позволяет настраивать параметры журнала аудита.
  • Поддерживается обновление параметров пересылки syslog и конфигураций серверов.
  • Примеры см. по адресу https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/sds_block_direct/audit_log_setting.yml

Требования

На хосте, выполняющем этот модуль, должны быть установлены следующие компоненты.

  • python >= 3.9

Параметры

Параметр

Комментарии

connection_info

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

Сведения, необходимые для подключения к системе хранения.

address

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

IP-адрес или имя хоста системы хранения.

connection_type

string

Тип подключения к системе хранения.

Варианты:

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

password

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

Пароль для аутентификации. Это обязательное поле.

username

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

Имя пользователя для аутентификации. Это обязательное поле.

spec

dictionary

Параметры задачи настройки журнала аудита.

audit_log_file_location

string

Каталог, в который будет загружен файл журнала аудита. Это обязательное поле, если значение поля state — download_audit_log.

refresh

boolean

Следует ли создать файл журнала аудита в системе хранения перед загрузкой. Это допустимое поле, если значение поля state — download_audit_log.

Варианты:

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

syslog_forwarding_setting

dictionary

Конфигурация пересылки syslog.

location_name

string

Название расположения для пересылки syslog.

syslog_servers

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

Список конфигураций серверов syslog.

index

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

Индекс сервера syslog.

Варианты:

  • 1
  • 2

is_enabled

boolean

Указывает, включен ли сервер syslog.

Варианты:

  • false
  • true

port

integer

Номер порта сервера syslog.

server_name

string

Имя или IP-адрес сервера syslog.

transport_protocol

string

Транспортный протокол для сервера syslog.

Варианты:

  • "UDP"

state

string

Уровень задачи настройки журнала аудита. Допустимые значения: present и download_audit_log.

Варианты:

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

Атрибуты

Атрибут

Поддержка

Описание

check_mode

Поддержка: нет

Определяет, должен ли модуль выполняться в режиме проверки.

Примеры

- name: Configure audit log settings with syslog forwarding
  hitachivantara.vspone_block.sds_block.hv_sds_block_audit_log_setting:
    state: present
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"
    spec:
      syslog_forwarding_setting:
        location_name: "datacenter1"
        syslog_servers:
          - index: 1
            is_enabled: true
            server_name: "syslog.example.com"
            port: 514
            transport_protocol: "UDP"
          - index: 2
            is_enabled: false
            server_name: "backup-syslog.example.com"
            port: 514
            transport_protocol: "UDP"

- name: Update syslog server configuration
  hitachivantara.vspone_block.sds_block.hv_sds_block_audit_log_setting:
    state: present
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"
    spec:
      syslog_forwarding_setting:
        location_name: "datacenter1"
        syslog_servers:
          - index: 1
            is_enabled: true
            server_name: "new-syslog.example.com"
            port: 1514
            transport_protocol: "UDP"

- name: Download audit log file
  hitachivantara.vspone_block.sds_block.hv_sds_block_audit_log_setting:
    state: download_audit_log
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"
    spec:
      audit_log_file_location: "/tmp/audit_logs"

- name: Create and download audit log file
  hitachivantara.vspone_block.sds_block.hv_sds_block_audit_log_setting:
    state: download_audit_log
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"
    spec:
      audit_log_file_location: "/tmp/audit_logs"
      refresh: true

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

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

Ключ

Описание

audit_log_settings

dictionary

Словарь с настроенными параметрами журнала аудита.

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

syslog_forwarding_setting

dictionary

Сведения о конфигурации пересылки syslog.

Возвращается: при успешном выполнении

location_name

string

Название расположения для пересылки syslog.

Возвращается: при успешном выполнении

Пример: "datacenter1"

syslog_servers

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

Список настроенных серверов syslog.

Возвращается: при успешном выполнении

index

integer

Индекс сервера syslog.

Возвращается: при успешном выполнении

Пример: 1

is_enabled

boolean

Указывает, включен ли сервер syslog.

Возвращается: при успешном выполнении

Пример: true

port

integer

Номер порта сервера syslog.

Возвращается: при успешном выполнении

Пример: 514

server_name

string

Имя или IP-адрес сервера syslog.

Возвращается: при успешном выполнении

Пример: "syslog.example.com"

transport_protocol

string

Транспортный протокол для сервера syslog.

Возвращается: при успешном выполнении

Пример: "UDP"

Авторы

  • Hitachi Vantara LTD (@hitachi-vantara)

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

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

© 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/hitachivantara/vspone_block/sds_block.hv_sds_block_audit_log_setting_module.html

Spec-Zone.ru

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