wti.remote.cpm_syslog_client_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 Client 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 Client Parameters
- name: Set the an SYSLOG Client 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
    protocol: 0
    index:
        - 1
    address:
        - "11.22.33.44"
    port:
        - 555
    transport:
        - 1
    secure:
        - 0

Scanned by Steampunk Spotter

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

# Sets the device SYSLOG Client Parameters
- name: Set the SYSLOG Client Parameters a WTI device
  cpm_iptables_config:
    cpm_url: "nonexist.wti.com"
    cpm_username: "super"
    cpm_password: "super"
    use_https: true
    validate_certs: false
    protocol: 0
    index:
        - 1
        - 2
    address:
        - "11.22.33.44"
        - "55.66.77.88"
    port:
        - 555
        - 557
    transport:
        - 1
        - 0
    secure:
        - 0
        - 1

Inputs

    
port:
    description:
    - Defines the port number used by the SYSLOG Client (1 - 65535).
    elements: raw
    required: false
    type: list

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

secure:
    description:
    - Defines if a secure connection is used by the SYSLOG Client (TCP Transport required).
    elements: raw
    required: false
    type: list

address:
    description:
    - Sets the IP Address of the SYSLOG server to contact.
    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

transport:
    description:
    - Defines the transfer protocol type used by the SYSLOG Client. 0=UDP, 1=TCP;
    elements: raw
    required: false
    type: list

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:
    syslogclient:
      description: Current k/v pairs of interface info for the WTI device after module
        execution.
      returned: always
      sample:
        syslogclient:
          ietf-ipv4:
            clients:
            - address: ''
              index: '1'
              port: '514'
              secure: '0'
              transport: '0'
            - address: ''
              index: '2'
              port: '514'
              secure: '0'
              transport: '0'
            - address: ''
              index: '3'
              port: '514'
              secure: '0'
              transport: '0'
            - address: ''
              index: '4'
              port: '514'
              secure: '0'
              transport: '0'
          ietf-ipv6:
            clients:
            - address: ''
              index: '1'
              port: '514'
              secure: '0'
              transport: '0'
            - address: ''
              index: '2'
              port: '514'
              secure: '0'
              transport: '0'
            - address: ''
              index: '3'
              port: '514'
              secure: '0'
              transport: '0'
            - address: ''
              index: '4'
              port: '514'
              secure: '0'
              transport: '0'
      type: dict
  description: The output JSON returned from the commands sent
  returned: always
  type: complex