scale_computing.hypercore.syslog_server module – Create, update or delete Syslog servers from HyperCore API.

Note

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

To install it, use: ansible-galaxy collection install scale_computing.hypercore.

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

New in scale_computing.hypercore 1.2.0

Synopsis

• Use this module to create, update or delete Syslog servers from the Syslog Servers configuration on HyperCore API.

Parameters

Parameter	Comments
cluster_instance dictionary	Scale Computing HyperCore instance information.
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.
host string / required	An IP address or hostname of the Syslog server you wish to create, update or delete.
host_new string	An IP address or hostname with which the existing Syslog server host on the HyperCore API will be updated.
port integer	Network port of the syslog server. Default: 514
protocol string	Network protocol used to send syslog alerts. Choices: "udp" ← (default) "tcp"
state string / required	The desired state of the syslog server on HyperCore API. If state=present a new Syslog server will be added, or existing Syslog server with matching host will be updated. host of existing Syslog server can be changed by specifying both host and host_new. If state=absent, the Syslog server with the provided host will be removed from HyperCore API. Choices: "present" "absent"

Notes

Note

• check_mode is not supported.

See Also

See also

scale_computing.hypercore.syslog_server_info

List Syslog servers on HyperCore API.

Examples

- name: Create Syslog server
  scale_computing.hypercore.syslog_server:
    host: 10.5.11.222
    port: 514
    protocol: udp
    state: present

- name: Update existing Syslog server
  scale_computing.hypercore.syslog_server:
    host: 10.5.11.222
    host_new: 1.2.3.4
    port: 514
    protocol: udp
    state: present

- name: Delete Syslog server
  scale_computing.hypercore.syslog_server:
    host: 10.5.11.222
    state: absent

Return Values

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

Key	Description
record dictionary	Created or updated syslog server. 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)

Collection links

Issue Tracker Repository (Sources)