wti.remote.cpm_syslog_server_config (1.0.5) — lookup

Install collection

Install with ansible-galaxy collection install wti.remote:==1.0.5

Add to requirements.yml

  collections:
    - name: wti.remote
      version: 1.0.5

Description

Set network SYSLOG Server parameters in WTI OOB and PDU devices

Usage examples

Scanned by Steampunk Spotter

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

# Sets the device SYSLOG Server Parameters
- name: Set the an SYSLOG Server Parameter for a WTI device
  cpm_iptables_config:
    cpm_url: "nonexist.wti.com"
    cpm_username: "super"
    cpm_password: "super"
    use_https: true
    validate_certs: false
    interface: "eth0"
    protocol: 0
    port: 514
    transport: 0
    secure: 0
    clear: 1

Scanned by Steampunk Spotter

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

# Sets the device SYSLOG Server Parameters
- name: Set the SYSLOG Server Parameters a WTI device
  cpm_iptables_config:
    cpm_url: "nonexist.wti.com"
    cpm_username: "super"
    cpm_password: "super"
    use_https: true
    validate_certs: false
    interface: "eth0"
    protocol: 0
    port: 514
    transport: 0
    secure: 0
    clear: 1
    index:
      - 1
      - 2
    block:
      - "192.168.50.4"
      - "72.76.4.56"

Inputs

    
port:
    description:
    - Defines the port number used by the SYSLOG Server (1 - 65535).
    required: false
    type: int

clear:
    choices:
    - 0
    - 1
    description:
    - Removes all the IP block entries for the protocol being defined before setting the
      newly defined entries.
    required: false
    type: int

index:
    description:
    - Index of the IP block being modified.
    elements: raw
    required: false
    type: list

enable:
    choices:
    - 0
    - 1
    description:
    - Activates SYSLOG listening for the specified interface and protocol.
    required: false
    type: int

secure:
    choices:
    - 0
    - 1
    description:
    - Defines if a secure connection is used by the SYSLOG Server (TCP Transport required).
    required: false
    type: int

address:
    description:
    - Sets the IP Address to block message logging.
    elements: raw
    required: false
    type: list

cpm_url:
    description:
    - This is the URL of the WTI device to send the module.
    required: true
    type: str

protocol:
    choices:
    - 0
    - 1
    description:
    - The protocol that the SYSLOG entry should be applied. 0 = ipv4, 1 = ipv6.
    required: false
    type: int

interface:
    choices:
    - eth0
    - eth1
    - ppp0
    - qmimux0
    description:
    - The ethernet port for the SYSLOG we are defining.
    required: true
    type: str

transport:
    choices:
    - 0
    - 1
    description:
    - Defines the transfer protocol type used by the SYSLOG Server. 0=UDP, 1=TCP;
    required: false
    type: int

use_https:
    default: true
    description:
    - Designates to use an https connection or http connection.
    required: false
    type: bool

use_proxy:
    default: false
    description:
    - Flag to control if the lookup will observe HTTP proxy environment variables when
      present.
    required: false
    type: bool

cpm_password:
    description:
    - This is the Password of the WTI device to send the module.
    required: true
    type: str

cpm_username:
    description:
    - This is the Username of the WTI device to send the module.
    required: true
    type: str

validate_certs:
    default: true
    description:
    - If false, SSL certificates will not be validated. This should only be used
    - on personally controlled sites using self-signed certificates.
    required: false
    type: bool

Outputs

data:
  contains:
    syslogserver:
      description: Current k/v pairs of interface info for the WTI device after module
        execution.
      returned: always
      sample:
        syslogserver:
          eth0:
          - ietf-ipv4:
              block:
              - address: ''
                index: '1'
              - address: ''
                index: '2'
              - address: ''
                index: '3'
              - address: ''
                index: '4'
              enable: 0
              port: '514'
              secure: '0'
              transport: '0'
            ietf-ipv6:
              block:
              - address: ''
                index: '1'
              - address: ''
                index: '2'
              - address: ''
                index: '3'
              - address: ''
                index: '4'
              enable: 0
              port: '514'
              secure: '0'
              transport: '0'
      type: dict
  description: The output JSON returned from the commands sent
  returned: always
  type: complex