ibm.storage_virtualize.ibm_sv_manage_syslog_server (2.3.1) — module

Install collection

Install with ansible-galaxy collection install ibm.storage_virtualize:==2.3.1

Add to requirements.yml

  collections:
    - name: ibm.storage_virtualize
      version: 2.3.1

Description

This Ansible module provides the interface to manage syslog servers through 'mksyslogserver', 'chsyslogserver' and 'rmsyslogserver' Storage Virtualize commands.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Delete the syslog server
  ibm.storage_virtualize.ibm_sv_manage_syslog_server:
   clustername: '{{clustername}}'
   username: '{{username}}'
   password: '{{password}}'
   name: server1
   state: absent

Inputs

    
ip:
    description:
    - 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.
    type: str

cadf:
    choices:
    - 'off'
    - 'on'
    description:
    - Specifies that Cloud Auditing Data Federation (CADF) data reporting be turned on
      or off. The parameters I(facility) and I (cadf) are mutually exclusive.
    type: str

info:
    choices:
    - 'off'
    - 'on'
    description:
    - Specifies whether the server receives information notifications. If specified as
      on, information notifications are sent to the syslog server. The default value is
      on.
    type: str

name:
    description:
    - Specifies the name of a syslog server.
    required: true
    type: str

port:
    description:
    - Specifies the communication port that is used by this server. The parameter I(protocol)
      must be specified while specifying this parameter. The default value is 514 for
      udp and 6514 for tcp.
    type: int

audit:
    choices:
    - 'off'
    - 'on'
    description:
    - Specifies whether the server receives CLI audit logs. The default value is off.
    type: str

error:
    choices:
    - 'off'
    - 'on'
    description:
    - Specifies whether the server receives error notifications. If specified as on, error
      notifications are sent to the syslog server. The default value is on.
    type: str

login:
    choices:
    - 'off'
    - 'on'
    description:
    - Specifies whether the server receives authentication logs. The default value is
      off.
    type: str

state:
    choices:
    - present
    - absent
    description:
    - Creates, updates (C(present)) or deletes (C(absent)) a syslog server.
    required: true
    type: str

token:
    description:
    - The authentication token to verify a user on the Storage Virtualize system.
    - To generate a token, use the M(ibm.storage_virtualize.ibm_svc_auth) module.
    type: str

domain:
    description:
    - Domain for the Storage Virtualize system.
    - Valid when hostname is used for the parameter I(clustername).
    type: str

warning:
    choices:
    - 'off'
    - 'on'
    description:
    - Specifies whether the server receives warning notifications. If specified as on,
      warning notifications are sent to the syslog server. The default value is on.
    type: str

facility:
    description:
    - 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
      I(facility) and I (cadf) are mutually exclusive.
    type: int

log_path:
    description:
    - Path of debug log file.
    type: str

old_name:
    description:
    - Specifies the old name of a syslog server to rename.
    - Valid when I(state=present), to rename the existing syslog server.
    type: str

password:
    description:
    - REST API password for the Storage Virtualize system.
    - The parameters I(username) and I(password) are required if not using I(token) to
      authenticate a user.
    type: str

protocol:
    choices:
    - tcp
    - udp
    description:
    - Specifies the communication protocol that is used by this server. The default value
      is udp.
    type: str

username:
    description:
    - REST API username for the Storage Virtualize system.
    - The parameters I(username) and I(password) are required if not using I(token) to
      authenticate a user.
    type: str

clustername:
    description:
    - The hostname or management IP of the Storage Virtualize system.
    required: true
    type: str

validate_certs:
    default: false
    description:
    - Validates certification.
    type: bool