Class: Ansible::Ruby::Modules::Junos_config

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/core/network/junos/junos_config.rb

Overview

The M(junos_config) module provides an abstraction for working with the configuration running on remote devices. It can perform operations that influence the configuration state. This module provides an implementation for configuring Juniper JUNOS devices. The configuration statements must start with either ‘set` or `delete` and are compared against the current device configuration and only changes are pushed to the device.

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

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

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

Constructor Details

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

Instance Method Details

#comment ⇒ String?

Returns The C(comment) argument specifies a text string to be used when committing the configuration. If the C(confirm) argument is set to False, this argument is silently ignored.

Returns:

  • (String, nil) —

    The C(comment) argument specifies a text string to be used when committing the configuration. If the C(confirm) argument is set to False, this argument is silently ignored.



28
 
# File 'lib/ansible/ruby/modules/generated/core/network/junos/junos_config.rb', line 28

attribute :comment

#confirm ⇒ Integer?

Returns The C(confirm) argument will configure a time out value for the commit to be confirmed before it is automatically rolled back. If the C(confirm) argument is set to False, this argument is silently ignored. If the value for this argument is set to 0, the commit is confirmed immediately.

Returns:

  • (Integer, nil) —

    The C(confirm) argument will configure a time out value for the commit to be confirmed before it is automatically rolled back. If the C(confirm) argument is set to False, this argument is silently ignored. If the value for this argument is set to 0, the commit is confirmed immediately.



24
 
# File 'lib/ansible/ruby/modules/generated/core/network/junos/junos_config.rb', line 24

attribute :confirm

#lines ⇒ Array<String>, ...

Returns The path to the config source. The source can be either a file with config or a template that will be merged during runtime. By default the task will search for the source file in role or playbook root folder in templates directory.

Returns:

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

    The path to the config source. The source can be either a file with config or a template that will be merged during runtime. By default the task will search for the source file in role or playbook root folder in templates directory.



12
 
# File 'lib/ansible/ruby/modules/generated/core/network/junos/junos_config.rb', line 12

attribute :lines

#replace ⇒ Boolean

Returns The C(replace) argument will instruct the remote device to replace the current configuration hierarchy with the one specified in the corresponding hierarchy of the source configuraiton loaded from this module.

Returns:

  • (Boolean) —

    The C(replace) argument will instruct the remote device to replace the current configuration hierarchy with the one specified in the corresponding hierarchy of the source configuraiton loaded from this module.



32
 
# File 'lib/ansible/ruby/modules/generated/core/network/junos/junos_config.rb', line 32

attribute :replace

#rollback ⇒ Integer?

Returns The C(rollback) argument instructs the module to rollback the current configuration to the identifier specified in the argument. If the specified rollback identifier does not exist on the remote device, the module will fail. To rollback to the most recent commit, set the C(rollback) argument to 0.

Returns:

  • (Integer, nil) —

    The C(rollback) argument instructs the module to rollback the current configuration to the identifier specified in the argument. If the specified rollback identifier does not exist on the remote device, the module will fail. To rollback to the most recent commit, set the C(rollback) argument to 0



16
 
# File 'lib/ansible/ruby/modules/generated/core/network/junos/junos_config.rb', line 16

attribute :rollback

#zeroize ⇒ Boolean?

Returns The C(zeroize) argument is used to completely ssantaize the remote device configuration back to initial defaults. This argument will effectively remove all current configuration statements on the remote device.

Returns:

  • (Boolean, nil) —

    The C(zeroize) argument is used to completely ssantaize the remote device configuration back to initial defaults. This argument will effectively remove all current configuration statements on the remote device



20
 
# File 'lib/ansible/ruby/modules/generated/core/network/junos/junos_config.rb', line 20

attribute :zeroize