Class: Ansible::Ruby::Modules::Iosxr_banner

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

Overview

This module will configure both exec and motd banners on remote device running Cisco IOS XR. It allows playbooks to add or remove banner text from the running configuration.

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

Returns Specifies the type of banner to configure on remote device.

Returns:

  • (:login, :motd) —

    Specifies the type of banner to configure on remote device.



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

attribute :banner

#state ⇒ :present, ...

Returns Existential state of the configuration on the device.

Returns:

  • (:present, :absent, nil) —

    Existential state of the configuration on the device.



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

attribute :state

#text ⇒ String?

Returns Banner text to be configured. Accepts multiline string, without empty lines. Requires I(state=present).

Returns:

  • (String, nil) —

    Banner text to be configured. Accepts multiline string, without empty lines. Requires I(state=present).



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

attribute :text