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

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

Overview

This module provides an implementation for working with the active configuration running on Juniper JUNOS devices. It provides a set of arguments for loading configuration, performing rollback operations and zeroing the active configuration on 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, fix_inclusion, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

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

Instance Method Details

#backup ⇒ :yes, ...

Returns This argument will cause the module to create a full backup of the current C(running-config) from the remote device before any changes are made. The backup file is written to the C(backup) folder in the playbook root directory or role root directory, if playbook is part of an ansible role. If the directory does not exist, it is created.

Returns:

  • (:yes, :no, nil) —

    This argument will cause the module to create a full backup of the current C(running-config) from the remote device before any changes are made. The backup file is written to the C(backup) folder in the playbook root directory or role root directory, if playbook is part of an ansible role. If the directory does not exist, it is created.



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

attribute :backup

#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.



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

attribute :comment

#confirm ⇒ Integer?

Returns The C(confirm) argument will configure a time out value in minutes 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 in minutes 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.



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

attribute :confirm

#confirm_commit ⇒ :yes, ...

Returns This argument will execute commit operation on remote device. It can be used to confirm a previous commit.

Returns:

  • (:yes, :no, nil) —

    This argument will execute commit operation on remote device. It can be used to confirm a previous commit.



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

attribute :confirm_commit

#lines ⇒ Array<String>, ...

Returns This argument takes a list of C(set) or C(delete) configuration lines to push into the remote device. Each line must start with either C(set) or C(delete). This argument is mutually exclusive with the I(src) argument.

Returns:

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

    This argument takes a list of C(set) or C(delete) configuration lines to push into the remote device. Each line must start with either C(set) or C(delete). This argument is mutually exclusive with the I(src) argument.



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

attribute :lines

#replace ⇒ :yes, ...

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 configuration loaded from this module.,Note this argument should be considered deprecated. To achieve the equivalent, set the I(update) argument to C(replace). This argument will be removed in a future release. The C(replace) and C(update) argument is mutually exclusive.

Returns:

  • (:yes, :no, nil) —

    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 configuration loaded from this module.,Note this argument should be considered deprecated. To achieve the equivalent, set the I(update) argument to C(replace). This argument will be removed in a future release. The C(replace) and C(update) argument is mutually exclusive.



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

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.



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

attribute :rollback

#src ⇒ String?

Returns The I(src) argument provides a path to the configuration file to load into the remote system. The path can either be a full system path to the configuration file if the value starts with / or relative to the root of the implemented role or playbook. This argument is mutually exclusive with the I(lines) argument.

Returns:

  • (String, nil) —

    The I(src) argument provides a path to the configuration file to load into the remote system. The path can either be a full system path to the configuration file if the value starts with / or relative to the root of the implemented role or playbook. This argument is mutually exclusive with the I(lines) argument.



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

attribute :src

#src_format ⇒ :xml, ...

Returns The I(src_format) argument specifies the format of the configuration found int I(src). If the I(src_format) argument is not provided, the module will attempt to determine the format of the configuration file specified in I(src).

Returns:

  • (:xml, :set, :text, :json, nil) —

    The I(src_format) argument specifies the format of the configuration found int I(src). If the I(src_format) argument is not provided, the module will attempt to determine the format of the configuration file specified in I(src).



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

attribute :src_format

#update ⇒ :merge, ...

Returns This argument will decide how to load the configuration data particulary when the candidate configuration and loaded configuration contain conflicting statements. Following are accepted values. C(merge) combines the data in the loaded configuration with the candidate configuration. If statements in the loaded configuration conflict with statements in the candidate configuration, the loaded statements replace the candidate ones. C(override) discards the entire candidate configuration and replaces it with the loaded configuration. C(replace) substitutes each hierarchy level in the loaded configuration for the corresponding level.

Returns:

  • (:merge, :override, :replace, nil) —

    This argument will decide how to load the configuration data particulary when the candidate configuration and loaded configuration contain conflicting statements. Following are accepted values. C(merge) combines the data in the loaded configuration with the candidate configuration. If statements in the loaded configuration conflict with statements in the candidate configuration, the loaded statements replace the candidate ones. C(override) discards the entire candidate configuration and replaces it with the loaded configuration. C(replace) substitutes each hierarchy level in the loaded configuration for the corresponding level.



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

attribute :update

#zeroize ⇒ Boolean?

Returns The C(zeroize) argument is used to completely sanitize 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 sanitize the remote device configuration back to initial defaults. This argument will effectively remove all current configuration statements on the remote device.



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

attribute :zeroize