Class: IControl::System::SoftwareManagement

Inherits:
Base
  • Object
show all
Defined in:
lib/icontrol/system/software_management.rb,
lib/icontrol/system.rb

Overview

The SoftwareManagement interface enables you to manage the software installed on the system.

Defined Under Namespace

Classes: HotFixInformation, HotFixInformationSequence, InstallationID, InstallationIDSequence, RepositoryImageID, RepositoryImageIDSequence, SoftwareRepositoryHotfix, SoftwareRepositoryHotfixSequence, SoftwareRepositoryImage, SoftwareRepositoryImageSequence, SoftwareStatus, SoftwareStatusSequence

Instance Method Summary collapse

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class IControl::Base

Instance Method Details

#all_software_statusSoftwareStatus

Gets the software status for all installation ids. This provides a complete picture of software status, for all ids.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



62
63
64
# File 'lib/icontrol/system/software_management.rb', line 62

def all_software_status
  super
end

#boot_image_information(opts) ⇒ char

Gets text which contains boot image information, in the form of "name=value“ pairs. The text includes information about what's installed in each of the boot locations in the device. While this method is not officially deprecated, it is preferred to use get_software_status, as that method is a newer method which yields much the same information in a more rigorous and controlled manner.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :save_active_config (boolean)

    The boolean indicating whether we should backup the configuration on the active boot location for the installer.

Returns:

  • (char)

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



79
80
81
82
# File 'lib/icontrol/system/software_management.rb', line 79

def boot_image_information(opts)
  opts = check_params(opts,[:save_active_config])
  super(opts)
end

#boot_locationString

Gets the configured default boot location, which will be the location that boots after the system reboots.

Returns:

  • (String)

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



92
93
94
# File 'lib/icontrol/system/software_management.rb', line 92

def boot_location
  super
end

#cleanup_ramfsObject

Cleanup the ramfs mounted at HF_MNT_LOCATION

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)
  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



26
27
28
# File 'lib/icontrol/system/software_management.rb', line 26

def cleanup_ramfs
  super
end

#cluster_boot_locationString

Gets the cluster boot location, which will be the location set in the software desired table.

Returns:

  • (String)

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



104
105
106
# File 'lib/icontrol/system/software_management.rb', line 104

def cluster_boot_location
  super
end

#create_ramfsString

Create a RAM disk and return its path to the caller.

Returns:

  • (String)

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)
  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



37
38
39
# File 'lib/icontrol/system/software_management.rb', line 37

def create_ramfs
  super
end

#delete_software_image(opts) ⇒ Object

Deletes software images from the repository.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :image_filenames (String)

    are the images you want to delete.

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



49
50
51
52
# File 'lib/icontrol/system/software_management.rb', line 49

def delete_software_image(opts)
  opts = check_params(opts,[:image_filenames])
  super(opts)
end

#has_logical_volume_managementboolean

Checks to see whether the system disks are managed with logical volumes.

Returns:

  • (boolean)

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



222
223
224
# File 'lib/icontrol/system/software_management.rb', line 222

def has_logical_volume_management
  super
end

#hotfix_informationHotFixInformation

Gets information on any hotfixes applied to the system. There may not be any hotfix installed, in which case the returned sequence is empty.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



116
117
118
# File 'lib/icontrol/system/software_management.rb', line 116

def hotfix_information
  super
end

#install_hotfix(opts) ⇒ Object

Installs this hotfixes.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :hotfix_files (String)

    The names of the hotfix files to be installed. These hotfix files must already exist on the system.

  • :reboot_system (boolean)

    The flag to indicate whether to reboot the system after the hotfixes have been installed.

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



235
236
237
238
# File 'lib/icontrol/system/software_management.rb', line 235

def install_hotfix(opts)
  opts = check_params(opts,[:hotfix_files,:reboot_system])
  super(opts)
end

#install_hotfix_no_daemons(opts) ⇒ Object

Calls bigstart stop and installs this hotfixes. Upon completion, if reboot_system is set to false, bigstart start is called to bring daemons back up.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :hotfix_files (String)

    The names of the hotfix files to be installed. These hotfix files must already exist on the system.

  • :reboot_system (boolean)

    The flag to indicate whether to reboot the system after the hotfixes have been installed.

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



250
251
252
253
# File 'lib/icontrol/system/software_management.rb', line 250

def install_hotfix_no_daemons(opts)
  opts = check_params(opts,[:hotfix_files,:reboot_system])
  super(opts)
end

#install_software_image(opts) ⇒ Object

Initiates an install of SW images on all blades installed on one chassis.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :install_volume (String)

    installation slot (HD slot) to install to. This will be the same on all blades.

  • :product (String)

    The product you are installing (ex: BIGIP)

  • :version (String)

    The version of product (ex: 10.0.0)

  • :build (String)

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



266
267
268
269
# File 'lib/icontrol/system/software_management.rb', line 266

def install_software_image(opts)
  opts = check_params(opts,[:install_volume,:product,:version,:build])
  super(opts)
end

#live_install_completion(opts) ⇒ String

Gets the percent complete of the current live install processes. Note: You may wish to use get_software_status instead of this method as it returns more information, such as the product, version, and build, along with the "percent complete“/status field.

Parameters:

  • opts (Hash)

Options Hash (opts):

Returns:

  • (String)

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



132
133
134
135
# File 'lib/icontrol/system/software_management.rb', line 132

def live_install_completion(opts)
  opts = check_params(opts,[:installation_ids])
  super(opts)
end

#rpm_package_informationString

Gets the RPM packages installed on the device.

Returns:

  • (String)

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



144
145
146
# File 'lib/icontrol/system/software_management.rb', line 144

def rpm_package_information
  super
end

#set_boot_image_information(opts) ⇒ Object

Sets the boot image information and automatically initiates installation based on the boot image information.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :boot_image_information (char)

    The boot image information file data.

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



280
281
282
283
# File 'lib/icontrol/system/software_management.rb', line 280

def set_boot_image_information(opts)
  opts = check_params(opts,[:boot_image_information])
  super(opts)
end

#set_boot_location(opts) ⇒ Object

Sets the default boot location, which will be the boot location that boots after the next system reboot. This version will not work on a clustered system.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :location (String)

    The boot location name. Short-form names such as CF1 .1, HD1 .1, HD1 .2

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



294
295
296
297
# File 'lib/icontrol/system/software_management.rb', line 294

def set_boot_location(opts)
  opts = check_params(opts,[:location])
  super(opts)
end

#set_cluster_boot_location(opts) ⇒ Object

Sets the cluster wide boot location, which will be the boot location after the next system reboot. Starting with BIG-IP version 9.6.0, clustered systems will reboot immediately.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :location (String)

    The boot location name. Short-form names such as CF1 .1, HD1 .1, HD1 .2

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs, or if attemped on a non clustered system.



309
310
311
312
# File 'lib/icontrol/system/software_management.rb', line 309

def set_cluster_boot_location(opts)
  opts = check_params(opts,[:location])
  super(opts)
end

#software_hotfixsoftwareRepositoryHotfix

Gets a list of hotfix information about specific hotfix image in the reporitory.

Returns:

  • (softwareRepositoryHotfix)

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



155
156
157
# File 'lib/icontrol/system/software_management.rb', line 155

def software_hotfix
  super
end

#software_hotfix_listrepositoryImageID

Gets a list of hotfix images available in the repository.

Returns:

  • (repositoryImageID)

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



166
167
168
# File 'lib/icontrol/system/software_management.rb', line 166

def software_hotfix_list
  super
end

#software_imagesoftwareRepositoryImage

Gets a list of image information about specific image in the reporitory.

Returns:

  • (softwareRepositoryImage)

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



177
178
179
# File 'lib/icontrol/system/software_management.rb', line 177

def software_image
  super
end

#software_image_listrepositoryImageID

Gets a list of software images available in the repository.

Returns:

  • (repositoryImageID)

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



188
189
190
# File 'lib/icontrol/system/software_management.rb', line 188

def software_image_list
  super
end

#software_status(opts) ⇒ SoftwareStatus

Gets the software status for given installation ids. This provides a complete picture of software status, per id.

Parameters:

  • opts (Hash)

Options Hash (opts):

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied)

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument)

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed)

    raised if an operation error occurs.



202
203
204
205
# File 'lib/icontrol/system/software_management.rb', line 202

def software_status(opts)
  opts = check_params(opts,[:installation_ids])
  super(opts)
end

#versionString

Gets the version information for this interface.

Returns:

  • (String)


211
212
213
# File 'lib/icontrol/system/software_management.rb', line 211

def version
  super
end