Class: Ansible::Ruby::Modules::Bigip_ucs

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

Overview

Manage upload, installation and removal of UCS files.

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

#force ⇒ Symbol?

Returns If C(yes) will upload the file every time and replace the file on the device. If C(no), the file will only be uploaded if it does not already exist. Generally should be C(yes) only in cases where you have reason to believe that the image was corrupted during upload.

Returns:

  • (Symbol, nil) —

    If C(yes) will upload the file every time and replace the file on the device. If C(no), the file will only be uploaded if it does not already exist. Generally should be C(yes) only in cases where you have reason to believe that the image was corrupted during upload.



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

attribute :force

#include_chassis_level_config ⇒ Symbol?

Returns During restore of the UCS file, include chassis level configuration that is shared among boot volume sets. For example, cluster default configuration.

Returns:

  • (Symbol, nil) —

    During restore of the UCS file, include chassis level configuration that is shared among boot volume sets. For example, cluster default configuration.



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

attribute :include_chassis_level_config

#no_license ⇒ Symbol?

Returns Performs a full restore of the UCS file and all the files it contains, with the exception of the license file. The option must be used to restore a UCS on RMA devices (Returned Materials Authorization).

Returns:

  • (Symbol, nil) —

    Performs a full restore of the UCS file and all the files it contains, with the exception of the license file. The option must be used to restore a UCS on RMA devices (Returned Materials Authorization).



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

attribute :no_license

#no_platform_check ⇒ Symbol?

Returns Bypasses the platform check and allows a UCS that was created using a different platform to be installed. By default (without this option), a UCS created from a different platform is not allowed to be installed.

Returns:

  • (Symbol, nil) —

    Bypasses the platform check and allows a UCS that was created using a different platform to be installed. By default (without this option), a UCS created from a different platform is not allowed to be installed.



28
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_ucs.rb', line 28

attribute :no_platform_check

#passphrase ⇒ Symbol?

Returns Specifies the passphrase that is necessary to load the specified UCS file.

Returns:

  • (Symbol, nil) —

    Specifies the passphrase that is necessary to load the specified UCS file.



32
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_ucs.rb', line 32

attribute :passphrase

#reset_trust ⇒ Symbol?

Returns When specified, the device and trust domain certs and keys are not loaded from the UCS. Instead, a new set is regenerated.

Returns:

  • (Symbol, nil) —

    When specified, the device and trust domain certs and keys are not loaded from the UCS. Instead, a new set is regenerated.



36
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_ucs.rb', line 36

attribute :reset_trust

#state ⇒ :absent, ...

Returns When C(installed), ensures that the UCS is uploaded and installed, on the system. When C(present), ensures that the UCS is uploaded. When C(absent), the UCS will be removed from the system. When C(installed), the uploading of the UCS is idempotent, however the installation of that configuration is not idempotent.

Returns:

  • (:absent, :installed, :present, nil) —

    When C(installed), ensures that the UCS is uploaded and installed, on the system. When C(present), ensures that the UCS is uploaded. When C(absent), the UCS will be removed from the system. When C(installed), the uploading of the UCS is idempotent, however the installation of that configuration is not idempotent.



40
 
# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_ucs.rb', line 40

attribute :state

#ucs ⇒ String?

Returns The path to the UCS file to install. The parameter must be provided if the C(state) is either C(installed) or C(activated). When C(state) is C(absent), the full path for this parameter will be ignored and only the filename will be used to select a UCS for removal. Therefore you could specify C(/mickey/mouse/test.ucs) and this module would only look for C(test.ucs).

Returns:

  • (String, nil) —

    The path to the UCS file to install. The parameter must be provided if the C(state) is either C(installed) or C(activated). When C(state) is C(absent), the full path for this parameter will be ignored and only the filename will be used to select a UCS for removal. Therefore you could specify C(/mickey/mouse/test.ucs) and this module would only look for C(test.ucs).



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

attribute :ucs