Class: Ansible::Ruby::Modules::Bigip_ucs_fetch

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

Overview

This module is used for fetching UCS files from remote machines and storing them locally in a file tree, organized by hostname. Note that this module is written to transfer UCS files that might not be present, so a missing remote UCS won’t be an error unless fail_on_missing is set to ‘yes’.

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 ⇒ Symbol?

Returns Create a backup file including the timestamp information so you can get the original file back if you somehow clobbered it incorrectly.

Returns:

  • (Symbol, nil) —

    Create a backup file including the timestamp information so you can get the original file back if you somehow clobbered it incorrectly.



12
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_ucs_fetch.rb', line 12

attribute :backup

#create_on_missing ⇒ Boolean?

Returns Creates the UCS based on the value of C(src) if the file does not already exist on the remote system.

Returns:

  • (Boolean, nil) —

    Creates the UCS based on the value of C(src) if the file does not already exist on the remote system.



16
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_ucs_fetch.rb', line 16

attribute :create_on_missing

#dest ⇒ String

Returns A directory to save the UCS file into.

Returns:

  • (String) —

    A directory to save the UCS file into.



20
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_ucs_fetch.rb', line 20

attribute :dest

#encryption_password ⇒ Object?

Returns Password to use to encrypt the UCS file if desired.

Returns:

  • (Object, nil) —

    Password to use to encrypt the UCS file if desired



24
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_ucs_fetch.rb', line 24

attribute :encryption_password

#fail_on_missing ⇒ Symbol?

Returns Make the module fail if the UCS file on the remote system is missing.

Returns:

  • (Symbol, nil) —

    Make the module fail if the UCS file on the remote system is missing.



27
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_ucs_fetch.rb', line 27

attribute :fail_on_missing

#force ⇒ Boolean?

Returns If C(no), the file will only be transferred if the destination does not exist.

Returns:

  • (Boolean, nil) —

    If C(no), the file will only be transferred if the destination does not exist.



31
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_ucs_fetch.rb', line 31

attribute :force

#src ⇒ String?

Returns The name of the UCS file to create on the remote server for downloading.

Returns:

  • (String, nil) —

    The name of the UCS file to create on the remote server for downloading



35
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_ucs_fetch.rb', line 35

attribute :src