ibm.storage_virtualize.ibm_sv_manage_syslog_server module – This module manages syslog server on IBM Storage Virtualize family systems
Note
This module is part of the ibm.storage_virtualize collection (version 2.5.0).
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 ibm.storage_virtualize
.
To use it in a playbook, specify: ibm.storage_virtualize.ibm_sv_manage_syslog_server
.
New in ibm.storage_virtualize 2.1.0
Synopsis
This Ansible module provides the interface to manage syslog servers through ‘mksyslogserver’, ‘chsyslogserver’ and ‘rmsyslogserver’ Storage Virtualize commands.
Parameters
Parameter |
Comments |
---|---|
Specifies whether the server receives CLI audit logs. The default value is off. Choices:
|
|
Specifies that Cloud Auditing Data Federation (CADF) data reporting be turned on or off. The parameters facility and I (cadf) are mutually exclusive. Choices:
|
|
The hostname or management IP of the Storage Virtualize system. |
|
Domain for the Storage Virtualize system. Valid when hostname is used for the parameter clustername. |
|
Specifies whether the server receives error notifications. If specified as on, error notifications are sent to the syslog server. The default value is on. Choices:
|
|
Specifies the facility number used in syslog messages. This number identifies the origin of the message to the receiving server. The default value is 0. The parameters facility and I (cadf) are mutually exclusive. |
|
Specifies whether the server receives information notifications. If specified as on, information notifications are sent to the syslog server. The default value is on. Choices:
|
|
Specifies the Internet Protocol (IP) address or domain name of the syslog server. If a domain name is specified, a DNS server must be configured on the system. |
|
Path of debug log file. |
|
Specifies whether the server receives authentication logs. The default value is off. Choices:
|
|
Specifies the name of a syslog server. |
|
Specifies the old name of a syslog server to rename. Valid when state=present, to rename the existing syslog server. |
|
REST API password for the Storage Virtualize system. The parameters username and password are required if not using token to authenticate a user. |
|
Specifies the communication port that is used by this server. The parameter protocol must be specified while specifying this parameter. The default value is 514 for udp and 6514 for tcp. |
|
Specifies the communication protocol that is used by this server. The default value is udp. Choices:
|
|
Creates, updates ( Choices:
|
|
The authentication token to verify a user on the Storage Virtualize system. To generate a token, use the ibm.storage_virtualize.ibm_svc_auth module. |
|
REST API username for the Storage Virtualize system. The parameters username and password are required if not using token to authenticate a user. |
|
Validates certification. Choices:
|
|
Specifies whether the server receives warning notifications. If specified as on, warning notifications are sent to the syslog server. The default value is on. Choices:
|
Notes
Note
This module supports
check_mode
.
Examples
- name: Create syslog server
ibm.storage_virtualize.ibm_sv_manage_syslog_server:
clustername: '{{clustername}}'
username: '{{username}}'
password: '{{password}}'
name: server1
ip: 1.2.3.4
state: present
- name: Create a syslog server that communicates with TLS
ibm.storage_virtualize.ibm_sv_manage_syslog_server:
clustername: '{{clustername}}'
username: '{{username}}'
password: '{{password}}'
name: server1
ip: 1.2.3.4
protocol: tls
state: present
- name: Modify the server details
ibm.storage_virtualize.ibm_sv_manage_syslog_server:
clustername: '{{clustername}}'
username: '{{username}}'
password: '{{password}}'
name: server1
info: off
state: present
- name: Delete the syslog server
ibm.storage_virtualize.ibm_sv_manage_syslog_server:
clustername: '{{clustername}}'
username: '{{username}}'
password: '{{password}}'
name: server1
state: absent