Class: Ansible::Ruby::Modules::Vyos_system

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

Overview

Runs one or more commands on remote devices running VyOS. This module can also be introspected to validate key parameters before returning successfully.

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

#domain_name ⇒ String?

Returns The new domain name to apply to the device.

Returns:

  • (String, nil) —

    The new domain name to apply to the device.



16
 
# File 'lib/ansible/ruby/modules/generated/network/vyos/vyos_system.rb', line 16

attribute :domain_name

#domain_search ⇒ Array<String>, ...

Returns A list of domain names to search. Mutually exclusive with I(name_server).

Returns:

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

    A list of domain names to search. Mutually exclusive with I(name_server)



23
 
# File 'lib/ansible/ruby/modules/generated/network/vyos/vyos_system.rb', line 23

attribute :domain_search

#host_name ⇒ String?

Returns Configure the device hostname parameter. This option takes an ASCII string value.

Returns:

  • (String, nil) —

    Configure the device hostname parameter. This option takes an ASCII string value.



12
 
# File 'lib/ansible/ruby/modules/generated/network/vyos/vyos_system.rb', line 12

attribute :host_name

#name_servers ⇒ Object?

Returns A list of name servers to use with the device. Mutually exclusive with I(domain_search).

Returns:

  • (Object, nil) —

    A list of name servers to use with the device. Mutually exclusive with I(domain_search)



20
 
# File 'lib/ansible/ruby/modules/generated/network/vyos/vyos_system.rb', line 20

attribute :name_servers

#state ⇒ :present, ...

Returns Whether to apply (C(present)) or remove (C(absent)) the settings.

Returns:

  • (:present, :absent, nil) —

    Whether to apply (C(present)) or remove (C(absent)) the settings.



27
 
# File 'lib/ansible/ruby/modules/generated/network/vyos/vyos_system.rb', line 27

attribute :state