Class: Ansible::Ruby::Modules::Junos_template

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

Overview

The M(junos_template) module will load a candidate configuration from a template file onto a remote device running Junos. The module will return the differences in configuration if the diff option is specified on the Ansible command line

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

#action ⇒ :merge, ...

Returns The C(action) argument specifies how the module will apply changes.

Returns:

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

    The C(action) argument specifies how the module will apply changes.



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

attribute :action

#backup ⇒ Boolean?

Returns When this argument is configured true, the module will backup the configuration from the node prior to making any changes. The backup file will be written to backup_hostname } in the root of the playbook directory.

Returns:

  • (Boolean, nil) —

    When this argument is configured true, the module will backup the configuration from the node prior to making any changes. The backup file will be written to backup_hostname } in the root of the playbook directory.



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

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.



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

attribute :comment

#config_format ⇒ :text, ...

Returns The C(format) argument specifies the format of the configuration template specified in C(src). If the format argument is not specified, the module will attempt to infer the configuration format based of file extension. Files that end in I(xml) will set the format to xml. Files that end in I(set) will set the format to set and all other files will default the format to text.

Returns:

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

    The C(format) argument specifies the format of the configuration template specified in C(src). If the format argument is not specified, the module will attempt to infer the configuration format based of file extension. Files that end in I(xml) will set the format to xml. Files that end in I(set) will set the format to set and all other files will default the format to text.



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

attribute :config_format

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



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

attribute :confirm

#src ⇒ 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:

  • (String) —

    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.



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

attribute :src