Class: Ansible::Ruby::Modules::Iosxr_logging

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/network/iosxr/iosxr_logging.rb

Overview

This module provides declarative management configuration of system logging (syslog) on Cisco IOS XR devices.

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, fix_inclusion, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#aggregate ⇒ Array<Hash>, ...

Returns List of syslog logging configuration definitions.

Returns:

  • (Array<Hash>, Hash, nil) —

    List of syslog logging configuration definitions.



40
 
# File 'lib/ansible/ruby/modules/generated/network/iosxr/iosxr_logging.rb', line 40

attribute :aggregate

#dest ⇒ :host, ...

Returns Destination for system logging (syslog) messages.

Returns:

  • (:host, :console, :monitor, :buffered, :file, nil) —

    Destination for system logging (syslog) messages.



12
 
# File 'lib/ansible/ruby/modules/generated/network/iosxr/iosxr_logging.rb', line 12

attribute :dest

#facility ⇒ String?

Returns To configure the type of syslog facility in which system logging (syslog) messages are sent to syslog servers Optional config for C(dest) = C(host).

Returns:

  • (String, nil) —

    To configure the type of syslog facility in which system logging (syslog) messages are sent to syslog servers Optional config for C(dest) = C(host)



28
 
# File 'lib/ansible/ruby/modules/generated/network/iosxr/iosxr_logging.rb', line 28

attribute :facility

#hostnameprefix ⇒ String?

Returns To append a hostname prefix to system logging (syslog) messages logged to syslog servers. Optional config for C(dest) = C(host).

Returns:

  • (String, nil) —

    To append a hostname prefix to system logging (syslog) messages logged to syslog servers. Optional config for C(dest) = C(host)



32
 
# File 'lib/ansible/ruby/modules/generated/network/iosxr/iosxr_logging.rb', line 32

attribute :hostnameprefix

#level ⇒ String?

Returns Specifies the severity level for the logging.

Returns:

  • (String, nil) —

    Specifies the severity level for the logging.



36
 
# File 'lib/ansible/ruby/modules/generated/network/iosxr/iosxr_logging.rb', line 36

attribute :level

#name ⇒ String?

Returns When C(dest) = I(file) name indicates file-name,When C(dest) = I(host) name indicates the host-name or ip-address of syslog server.

Returns:

  • (String, nil) —

    When C(dest) = I(file) name indicates file-name,When C(dest) = I(host) name indicates the host-name or ip-address of syslog server.



16
 
# File 'lib/ansible/ruby/modules/generated/network/iosxr/iosxr_logging.rb', line 16

attribute :name

#size ⇒ Integer?

Returns Size of buffer when C(dest) = C(buffered). The acceptable value is in the range I(307200 to 125000000 bytes). Default 307200,Size of file when C(dest) = C(file). The acceptable value is in the range I(1 to 2097152)KB. Default 2 GB.

Returns:

  • (Integer, nil) —

    Size of buffer when C(dest) = C(buffered). The acceptable value is in the range I(307200 to 125000000 bytes). Default 307200,Size of file when C(dest) = C(file). The acceptable value is in the range I(1 to 2097152)KB. Default 2 GB



24
 
# File 'lib/ansible/ruby/modules/generated/network/iosxr/iosxr_logging.rb', line 24

attribute :size

#state ⇒ :present, ...

Returns Existential state of the logging configuration on the node.

Returns:

  • (:present, :absent, nil) —

    Existential state of the logging configuration on the node.



44
 
# File 'lib/ansible/ruby/modules/generated/network/iosxr/iosxr_logging.rb', line 44

attribute :state

#vrf ⇒ String?

Returns vrf name when syslog server is configured, C(dest) = C(host).

Returns:

  • (String, nil) —

    vrf name when syslog server is configured, C(dest) = C(host)



20
 
# File 'lib/ansible/ruby/modules/generated/network/iosxr/iosxr_logging.rb', line 20

attribute :vrf