scale_computing.hypercore.syslog_server_info module – List Syslog servers on HyperCore API

Note

This module is part of the scale_computing.hypercore collection (version 1.6.0).

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 scale_computing.hypercore.

To use it in a playbook, specify: scale_computing.hypercore.syslog_server_info.

New in scale_computing.hypercore 1.2.0

Synopsis

  • Use this module to list information about the Syslog servers configuration on HyperCore API.

  • The output is sorted, in ascending order, first by host, then port, then protocol.

Parameters

Parameter

Comments

cluster_instance

dictionary

Scale Computing HyperCore instance information.

auth_method

string

Select login method. If not set, the value of the SC_AUTH_METHOD environment variable will be used.

Value local - username/password is verified by the HyperCore server (the local users).

Value oidc - username/password is verified by the configured OIDC provider.

Choices:

  • "local" ← (default)

  • "oidc"

host

string / required

The HyperCore instance URL.

If not set, the value of the SC_HOST environment variable will be used.

For example “https://10.1.2.3:443”.

password

string / required

Password used for authentication.

If not set, the value of the SC_PASSWORD environment variable will be used.

timeout

float

Timeout in seconds for the connection with the Scale Computing HyperCore API instance.

If not set, the value of the SC_TIMEOUT environment variable will be used.

username

string / required

Username used for authentication.

If not set, the value of the SC_USERNAME environment variable will be used.

See Also

See also

scale_computing.hypercore.syslog_server

Create, update or delete Syslog servers from HyperCore API.

Examples

- name: List all Syslog servers on HyperCore API
  scale_computing.hypercore.syslog_server_info:
  register: syslog_server

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

records

list / elements=dictionary

A list of Syslog servers records.

Returned: success

alert_tag_uuid

string

Unique identifier for an AlertTag (internal)

Returned: success

Sample: "0"

host

string

IP address or hostname of the syslog server

Returned: success

Sample: "10.5.11.222"

latest_task_tag

dictionary

Latest Task Tag

Returned: success

Sample: {"completed": 1623069193, "created": 1623069187, "descriptionParameters": [], "formattedDescription": "Create Alert Syslog Target", "formattedMessage": "", "messageParameters": [], "modified": 1623069193, "nodeUUIDs": ["32c5012d-7d7b-49b4-9201-70e02b0d8758"], "objectUUID": "21c65667-234a-437b-aead-df0199598ff9", "progressPercent": 100, "sessionID": "", "state": "COMPLETE", "taskTag": 13}

port

integer

Network port of the syslog server

Returned: success

Sample: 514

protocol

string

Network protocol used to send syslog alerts

Returned: success

Sample: "udp"

resend_delay

integer

Alert resend delay in seconds

Returned: success

Sample: 86400

silent_period

string

Alerts will not resend if there are additional event triggers within this time in seconds

Returned: success

Sample: "900"

uuid

string

Unique identifer

Returned: success

Sample: "21c65667-234a-437b-aead-df0199598ff9"

Authors

  • Ana Zobec (@anazobec)