hitachivantara.vspone_block.sds_block.hv_sds_block_event_log_setting_facts module – Get event log setting from SDS Block storage system

Note

This module is part of the hitachivantara.vspone_block collection (version 4.6.1).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install hitachivantara.vspone_block. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: hitachivantara.vspone_block.sds_block.hv_sds_block_event_log_setting_facts.

New in hitachivantara.vspone_block 4.6.0

Synopsis

Requirements

The below requirements are needed on the host that executes this module.

  • python >= 3.9

Parameters

Parameter

Comments

connection_info

dictionary / required

Information required to establish a connection to the storage system.

address

string / required

IP address or hostname of the storage system.

connection_type

string

Type of connection to the storage system.

Choices:

  • "direct" ← (default)

password

string / required

Password for authentication. This is a required field.

username

string / required

Username for authentication. This is a required field.

spec

dictionary

Specification for the event log settings facts retrieval.

Attributes

Attribute

Support

Description

check_mode

Support: full

Determines if the module should run in check mode.

Examples

- name: Retrieve event log setting information
  hitachivantara.vspone_block.sds_block.hv_sds_block_event_log_setting_facts:
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"

Returned Facts

Facts returned by this module are added/updated in the hostvars host facts and can be referenced by name just like any other host fact. They do not need to be registered in order to use them.

Key

Description

event_log_setting

dictionary

Event log setting information.

Returned: success

emailReportSetting

dictionary

Email report settings.

Returned: success

smtpSettings

list / elements=dictionary

List of SMTP server settings.

Returned: success

syslogForwardingSetting

dictionary

Syslog forwarding settings.

Returned: success

locationName

string

Location name for syslog.

Returned: success

Sample: "datacenter-01"

syslogServers

list / elements=dictionary

List of syslog servers.

Returned: success

Authors

  • Hitachi Vantara LTD (@hitachi-vantara)