Method: Rbeapi::Api::BaseInterface#set_description

Defined in:
lib/rbeapi/api/interfaces.rb

#set_description(name, opts = {}) ⇒ Boolean

set_description configures the description value for the specified interface name in the nodes running configuration. If the enable keyword is false then the description value is negated using the no keyword. If the default keyword is set to true, then the description value is defaulted using the default keyword. The default keyword takes precedence over the enable keyword if both are provided.

Options Hash (opts):

  • value (String) —

    The value to configure the description to in the node’s configuration.

  • enable (Boolean) —

    If false then the command is negated. Default is true.

  • default (Boolean) —

    Configure the interface description using the default keyword.

Since:

  • eos_version 4.13.7M



343
344
345
346
 
# File 'lib/rbeapi/api/interfaces.rb', line 343

def set_description(name, opts = {})
  commands = command_builder('description', opts)
  configure_interface(name, commands)
end