radware.radware_modules.alteon_config_system_logging (0.6.12) — module

Manage system logging in Radware Alteon

| "added in version" 2.9 of radware.radware_modules"

Authors: Leon Meguira (@leonmeguira), Nati Fridman (@natifridman)

stableinterface | supported by certified

Install collection

Install with ansible-galaxy collection install radware.radware_modules:==0.6.12


Add to requirements.yml

  collections:
    - name: radware.radware_modules
      version: 0.6.12

Description

Manage system logging in Radware Alteon.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: alteon configuration command
  radware.radware_modules.alteon_config_system_logging:
    provider: 
      server: 192.168.1.1
      user: admin
      password: admin
      validate_certs: no
      https_port: 443
      ssh_port: 22
      timeout: 5
    state: present
    parameters:
      show_syslog_on_console: enabled
      configuration_audit: enabled
      extended_log_format: enabled
      session_log_state: enabled
      session_log_mode: disk
      log_trap_system: enabled
      log_trap_management: enabled
      log_trap_virtual_services: enabled
      log_trap_cli: disabled
      log_trap_bgp: enabled
      syslog_servers:
      host1:
        ip4_address: 10.10.10.1
        port: 514
        severity: warning4
        facility: local5
        module: all
      host3:
        ip4_address: 10.10.10.2
        port: 514
        severity: notice5
        facility: local3
        module: appsvc

Inputs

    
state:
    choices:
    - present
    - absent
    - read
    - overwrite
    - append
    default: null
    description:
    - When C(present), guarantees that the object exists with the provided attributes.
    - When C(absent), when applicable removes the object.
    - When C(read), when exists read object from configuration to parameter format.
    - When C(overwrite), removes the object if exists then recreate it
    - When C(append), append object configuration with the provided parameters
    required: true

provider:
    description:
    - Radware Alteon connection details.
    required: true
    suboptions:
      https_port:
        default: null
        description:
        - Radware Alteon https port.
        required: true
      password:
        default: null
        description:
        - Radware Alteon password.
        required: true
      server:
        default: null
        description:
        - Radware Alteon IP address.
        required: true
      ssh_port:
        default: null
        description:
        - Radware Alteon ssh port.
        required: true
      timeout:
        default: null
        description:
        - Timeout for connection.
        required: true
      user:
        default: null
        description:
        - Radware Alteon username.
        required: true
      validate_certs:
        default: null
        description:
        - If C(no), SSL certificates will not be validated.
        - This should only set to C(no) used on personally controlled sites using self-signed
          certificates.
        required: true
        type: bool

parameters:
    description:
    - Parameters system logging configuration.
    suboptions:
      configuration_audit:
        choices:
        - enabled
        - disabled
        default: disabled
        description:
        - Specifies whether to log the details of all configuration changes to the syslog
          server.
        required: false
      extended_log_format:
        choices:
        - enabled
        - disabled
        default: enabled
        description:
        - Enables or disables extended information in syslog messages.
        required: false
      log_trap_app_services:
        choices:
        - enabled
        - disabled
        default: null
        description:
        - Specifies whether Alteon sends syslogs and SNMP traps relating to application
          services.
        required: false
      log_trap_audit:
        choices:
        - enabled
        - disabled
        default: null
        description:
        - Specifies whether Alteon sends syslogs and SNMP traps relating to audit.
        required: false
      log_trap_bgp:
        choices:
        - enabled
        - disabled
        default: null
        description:
        - Specifies whether Alteon sends syslogs and SNMP traps relating to BGP.
        required: false
      log_trap_cli:
        choices:
        - enabled
        - disabled
        default: null
        description:
        - Specifies whether Alteon sends CLI-generated errors.
        required: false
      log_trap_console:
        choices:
        - enabled
        - disabled
        default: null
        description:
        - Specifies whether Alteon sends syslogs and SNMP traps relating to the console.
        required: false
      log_trap_fastview:
        choices:
        - enabled
        - disabled
        default: null
        description:
        - Specifies whether Alteon sends syslogs and SNMP traps relating to FastView.
        required: false
      log_trap_filter:
        choices:
        - enabled
        - disabled
        default: null
        description:
        - Specifies whether Alteon sends syslogs and SNMP traps relating to the filter.
        required: false
      log_trap_global_lb:
        choices:
        - enabled
        - disabled
        default: null
        description:
        - Specifies whether Alteon sends syslogs and SNMP traps relating to GSLB.
        required: false
      log_trap_high_availability:
        choices:
        - enabled
        - disabled
        default: null
        description:
        - Specifies whether Alteon sends syslogs and SNMP traps relating to high availability.
        required: false
      log_trap_ip:
        choices:
        - enabled
        - disabled
        default: null
        description:
        - Specifies whether Alteon sends syslogs and SNMP traps relating to IP.
        required: false
      log_trap_ip_reputation:
        choices:
        - enabled
        - disabled
        default: null
        description:
        - Specifies whether Alteon sends syslogs and SNMP traps relating to IP reputation.
        required: false
      log_trap_ipv6:
        choices:
        - enabled
        - disabled
        default: null
        description:
        - Specifies whether Alteon sends syslogs and SNMP traps relating to IPv6.
        required: false
      log_trap_management:
        choices:
        - enabled
        - disabled
        default: null
        description:
        - Specifies whether Alteon sends syslogs and SNMP traps relating to management.
        required: false
      log_trap_ntp:
        choices:
        - enabled
        - disabled
        default: null
        description:
        - Specifies whether Alteon sends syslogs and SNMP traps relating to NTP.
        required: false
      log_trap_ospf:
        choices:
        - enabled
        - disabled
        default: null
        description:
        - Specifies whether Alteon sends syslogs and SNMP traps relating to OSPF.
        required: false
      log_trap_ospf_v3:
        choices:
        - enabled
        - disabled
        default: null
        description:
        - Specifies whether Alteon sends syslogs and SNMP traps relating to OSPFv3.
        required: false
      log_trap_rate_limit:
        choices:
        - enabled
        - disabled
        default: null
        description:
        - Specifies whether Alteon sends syslogs and SNMP traps relating to TCP-rate-limiting.
        required: false
      log_trap_rmon:
        choices:
        - enabled
        - disabled
        default: null
        description:
        - Specifies whether Alteon sends syslogs and SNMP traps relating to RMON.
        required: false
      log_trap_security:
        choices:
        - enabled
        - disabled
        default: null
        description:
        - Specifies whether Alteon sends syslogs and SNMP traps relating to the Security
          packs.
        required: false
      log_trap_slb_attack:
        choices:
        - enabled
        - disabled
        default: null
        description:
        - Specifies whether Alteon sends syslogs and SNMP traps relating to SLB attacks.
        - This parameter is not displayed in ADC-VX mode.
        required: false
      log_trap_spanning_tree:
        choices:
        - enabled
        - disabled
        default: null
        description:
        - Specifies whether Alteon sends syslogs and SNMP traps relating to spanning tree.
        required: false
      log_trap_ssh:
        choices:
        - enabled
        - disabled
        default: null
        description:
        - Specifies whether Alteon sends syslogs and SNMP traps relating to SSH RADIUS.
        required: false
      log_trap_syn_attack:
        choices:
        - enabled
        - disabled
        default: null
        description:
        - Specifies whether Alteon sends syslogs and SNMP traps relating to SYN-attack
          detection.
        required: false
      log_trap_system:
        choices:
        - enabled
        - disabled
        default: null
        description:
        - Specifies whether Alteon sends syslogs and SNMP traps relating to the system.
        required: false
      log_trap_virtual_services:
        choices:
        - enabled
        - disabled
        default: null
        description:
        - Specifies whether Alteon sends all syslogs and SNMP traps relating to SLB.
        required: false
      log_trap_vlan:
        choices:
        - enabled
        - disabled
        default: null
        description:
        - Specifies whether Alteon sends syslogs and SNMP traps relating to VLAN.
        required: false
      log_trap_vrrp:
        choices:
        - enabled
        - disabled
        default: null
        description:
        - Specifies whether Alteon sends syslogs and SNMP traps relating to legacy VRRP.
        required: false
      log_trap_web:
        choices:
        - enabled
        - disabled
        default: null
        description:
        - Specifies whether Alteon sends syslogs and SNMP traps relating to WEB UI.
        required: false
      session_log_mode:
        choices:
        - syslog
        - disk
        - both
        default: null
        description:
        - Specifies the session log connection mode.
        - Depending on the configuration, session logs can be sent via the management
          port to the syslog servers or saved to disk to export later, or to both.
        required: false
      session_log_nat_data:
        choices:
        - enabled
        - disabled
        default: enabled
        description:
        - Enables or disables log NAT data.
        required: false
      session_log_server_data:
        choices:
        - enabled
        - disabled
        default: enabled
        description:
        - Enables or disables log real server data.
        required: false
      session_log_state:
        choices:
        - enabled
        - disabled
        default: disabled
        description:
        - Enables or disables session log.
        - 'Caution: Turning on the session log may impair Alteon traffic-processing performance.'
        required: false
      show_syslog_on_console:
        choices:
        - enabled
        - disabled
        default: null
        description:
        - Specifies whether to enable console output of syslog messages.
        required: false
      syslog_servers:
        default: null
        description:
        - Syslog servers configuration.
        required: false
        suboptions:
          host1:
            default: null
            description:
            - Host 1 configuration.
            required: false
            suboptions:
              facility:
                choices:
                - local0
                - local1
                - local2
                - local3
                - local4
                - local5
                - local6
                - local7
                default: local0
                description:
                - The facility of syslog server.
                required: false
              ip4_address:
                default: null
                description:
                - The IPv4 address of the syslog server.
                required: false
                type: str
              ip6_address:
                default: null
                description:
                - The IPv6 address of the syslog server.
                required: false
                type: str
              module:
                choices:
                - all
                - grpmng
                - grpsys
                - grpnw
                - grpslb
                - grpsec
                - fastview
                - ha
                - appsvc
                - bgp
                - filter
                - gslb
                - ip
                - ipv6
                - ospf
                - ospfv3
                - ratelim
                - rmon
                - security
                - slb
                - slbatk
                - synatk
                - vlan
                - vrrp
                - cli
                - console
                - mgmt
                - ntp
                - ssh
                - stp
                - system
                - web
                - audit
                default: all
                description:
                - Specifies whether to send syslog messages generated by a specific module
                  or module group to the specified syslog server (host 1 through host
                  5).
                - If a module group is specified, messages generated by all the modules
                  included in the group are enabled for logging and routed to the syslog
                  server.
                required: false
              port:
                default: null
                description:
                - The port number of the syslog server.
                required: false
                type: int
              severity:
                choices:
                - emerg0
                - alert1
                - crit2
                - err3
                - warning4
                - notice5
                - info6
                - debug7
                default: null
                description:
                - The lowest severity messages that Alteon sends to the syslog server.
                required: false
          host2:
            default: null
            description:
            - Host 2 configuration.
            required: false
            suboptions:
              facility:
                choices:
                - local0
                - local1
                - local2
                - local3
                - local4
                - local5
                - local6
                - local7
                default: local0
                description:
                - The facility of syslog server.
                required: false
              ip4_address:
                default: null
                description:
                - The IPv4 address of the syslog server.
                required: false
                type: str
              ip6_address:
                default: null
                description:
                - The IPv6 address of the syslog server.
                required: false
                type: str
              module:
                choices:
                - all
                - grpmng
                - grpsys
                - grpnw
                - grpslb
                - grpsec
                - fastview
                - ha
                - appsvc
                - bgp
                - filter
                - gslb
                - ip
                - ipv6
                - ospf
                - ospfv3
                - ratelim
                - rmon
                - security
                - slb
                - slbatk
                - synatk
                - vlan
                - vrrp
                - cli
                - console
                - mgmt
                - ntp
                - ssh
                - stp
                - system
                - web
                - audit
                default: all
                description:
                - Specifies whether to send syslog messages generated by a specific module
                  or module group to the specified syslog server (host 1 through host
                  5).
                - If a module group is specified, messages generated by all the modules
                  included in the group are enabled for logging and routed to the syslog
                  server.
                required: false
              port:
                default: null
                description:
                - The port number of the syslog server.
                required: false
                type: int
              severity:
                choices:
                - emerg0
                - alert1
                - crit2
                - err3
                - warning4
                - notice5
                - info6
                - debug7
                default: null
                description:
                - The lowest severity messages that Alteon sends to the syslog server.
                required: false
          host3:
            default: null
            description:
            - Host 3 configuration.
            required: false
            suboptions:
              facility:
                choices:
                - local0
                - local1
                - local2
                - local3
                - local4
                - local5
                - local6
                - local7
                default: local0
                description:
                - The facility of syslog server.
                required: false
              ip4_address:
                default: null
                description:
                - The IPv4 address of the syslog server.
                required: false
                type: str
              ip6_address:
                default: null
                description:
                - The IPv6 address of the syslog server.
                required: false
                type: str
              module:
                choices:
                - all
                - grpmng
                - grpsys
                - grpnw
                - grpslb
                - grpsec
                - fastview
                - ha
                - appsvc
                - bgp
                - filter
                - gslb
                - ip
                - ipv6
                - ospf
                - ospfv3
                - ratelim
                - rmon
                - security
                - slb
                - slbatk
                - synatk
                - vlan
                - vrrp
                - cli
                - console
                - mgmt
                - ntp
                - ssh
                - stp
                - system
                - web
                - audit
                default: all
                description:
                - Specifies whether to send syslog messages generated by a specific module
                  or module group to the specified syslog server (host 1 through host
                  5).
                - If a module group is specified, messages generated by all the modules
                  included in the group are enabled for logging and routed to the syslog
                  server.
                required: false
              port:
                default: null
                description:
                - The port number of the syslog server.
                required: false
                type: int
              severity:
                choices:
                - emerg0
                - alert1
                - crit2
                - err3
                - warning4
                - notice5
                - info6
                - debug7
                default: null
                description:
                - The lowest severity messages that Alteon sends to the syslog server.
                required: false
          host4:
            default: null
            description:
            - Host 4 configuration.
            required: false
            suboptions:
              facility:
                choices:
                - local0
                - local1
                - local2
                - local3
                - local4
                - local5
                - local6
                - local7
                default: local0
                description:
                - The facility of syslog server.
                required: false
              ip4_address:
                default: null
                description:
                - The IPv4 address of the syslog server.
                required: false
                type: str
              ip6_address:
                default: null
                description:
                - The IPv6 address of the syslog server.
                required: false
                type: str
              module:
                choices:
                - all
                - grpmng
                - grpsys
                - grpnw
                - grpslb
                - grpsec
                - fastview
                - ha
                - appsvc
                - bgp
                - filter
                - gslb
                - ip
                - ipv6
                - ospf
                - ospfv3
                - ratelim
                - rmon
                - security
                - slb
                - slbatk
                - synatk
                - vlan
                - vrrp
                - cli
                - console
                - mgmt
                - ntp
                - ssh
                - stp
                - system
                - web
                - audit
                default: all
                description:
                - Specifies whether to send syslog messages generated by a specific module
                  or module group to the specified syslog server (host 1 through host
                  5).
                - If a module group is specified, messages generated by all the modules
                  included in the group are enabled for logging and routed to the syslog
                  server.
                required: false
              port:
                default: null
                description:
                - The port number of the syslog server.
                required: false
                type: int
              severity:
                choices:
                - emerg0
                - alert1
                - crit2
                - err3
                - warning4
                - notice5
                - info6
                - debug7
                default: null
                description:
                - The lowest severity messages that Alteon sends to the syslog server.
                required: false
          host5:
            default: null
            description:
            - Host 5 configuration.
            required: false
            suboptions:
              facility:
                choices:
                - local0
                - local1
                - local2
                - local3
                - local4
                - local5
                - local6
                - local7
                default: local0
                description:
                - The facility of syslog server.
                required: false
              ip4_address:
                default: null
                description:
                - The IPv4 address of the syslog server.
                required: false
                type: str
              ip6_address:
                default: null
                description:
                - The IPv6 address of the syslog server.
                required: false
                type: str
              module:
                choices:
                - all
                - grpmng
                - grpsys
                - grpnw
                - grpslb
                - grpsec
                - fastview
                - ha
                - appsvc
                - bgp
                - filter
                - gslb
                - ip
                - ipv6
                - ospf
                - ospfv3
                - ratelim
                - rmon
                - security
                - slb
                - slbatk
                - synatk
                - vlan
                - vrrp
                - cli
                - console
                - mgmt
                - ntp
                - ssh
                - stp
                - system
                - web
                - audit
                default: all
                description:
                - Specifies whether to send syslog messages generated by a specific module
                  or module group to the specified syslog server (host 1 through host
                  5).
                - If a module group is specified, messages generated by all the modules
                  included in the group are enabled for logging and routed to the syslog
                  server.
                required: false
              port:
                default: null
                description:
                - The port number of the syslog server.
                required: false
                type: int
              severity:
                choices:
                - emerg0
                - alert1
                - crit2
                - err3
                - warning4
                - notice5
                - info6
                - debug7
                default: null
                description:
                - The lowest severity messages that Alteon sends to the syslog server.
                required: false

revert_on_error:
    default: false
    description:
    - If an error occurs, perform revert on alteon.
    required: false
    type: bool

write_on_change:
    default: false
    description:
    - Executes Alteon write calls only when an actual change has been evaluated.
    required: false
    type: bool

Outputs

obj:
  description: parameters object type
  returned: changed, read
  type: dictionary
status:
  description: Message detailing run result
  returned: success
  sample: object deployed successfully
  type: str