System::SoftwareManagement

Introduced : BIG-IP_v9.2.0
The SoftwareManagement interface enables you to manage the software installed on the system. This interface does not support transactions.

Methods

Method Description Introduced
cleanup_ramfs Cleanup the ramfs mounted at HF_MNT_LOCATION BIG-IP_v9.4.2 BIG-IP v9.6.0 and later: this function is no longer functional due to changes with the hotfix installation procedure.
create_ramfs Create a RAM disk and return its path to the caller. BIG-IP_v9.4.2 BIG-IP v9.6.0 and later: this function is no longer functional due to changes with the hotfix installation procedure.
delete_software_image Deletes software images from the repository. BIG-IP_v9.6.1
delete_volume Deletes a volume from the system, or from all blades on a chassis. BIG-IP_v11.2.0
get_all_software_status Gets the software status for all installation ids. This provides a complete picture of software status, for all ids. BIG-IP_v10.0.1
get_block_device_software_hotfix Gets information about specific hotfix block device images. BIG-IP_v11.6.0
get_block_device_software_hotfix_list Gets the list of available hotfix block device images. BIG-IP_v11.6.0
get_block_device_software_image Gets information about specific software block device images. BIG-IP_v11.6.0
get_block_device_software_image_list Gets the list of available software block device images. BIG-IP_v11.6.0
get_boot_image_information This method is deprecated, as it returns details which are available using more modern techniques (it relies on the “audit script”, which is no longer under active development). The functionality is now available using System::SoftwareManagement::get_software_status and methods in the System::Disk interface. Gets text which contains boot image information, in the form of “name=value” pairs. The text includes information about what&aposs 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. BIG-IP_v9.2.0
get_boot_location Gets the configured default boot location, which will be the location that boots after the system reboots. BIG-IP_v9.2.0
get_cluster_boot_location Gets the cluster boot location, which will be the location set in the software desired table. BIG-IP_v9.6.0
get_hotfix_information Gets information on any hotfixes applied to the system. There may not be any hotfix installed, in which case the returned sequence is empty. BIG-IP_v9.2.0
get_live_install_completion 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. BIG-IP_v9.6.0
get_rpm_package_information Gets the RPM packages installed on the device. BIG-IP_v9.2.0
get_software_hotfix Gets a list of hotfix information about specific hotfix image in the repository. BIG-IP_v9.6.1
get_software_hotfix_list Gets a list of hotfix images available in the repository. BIG-IP_v9.6.0
get_software_image Gets a list of image information about specific image in the repository. BIG-IP_v9.6.1
get_software_image_list Gets a list of software images available in the repository. BIG-IP_v9.6.0
get_software_status Gets the software status for given installation ids. This provides a complete picture of software status, per id. BIG-IP_v10.0.1
get_version Gets the version information for this interface. BIG-IP_v9.2.0
has_logical_volume_management Checks to see whether the system disks are managed with logical volumes. BIG-IP_v10.0.0
install_hotfix Installs the specified hotfixes. BIG-IP_v9.2.0
install_hotfix_no_daemons Calls bigstart stop and installs the specified hotfixes. Upon completion, if reboot_system is set to false, bigstart start is called to bring daemons back up. BIG-IP_v9.4.2
install_software_image This method has been deprecated as it does not allow the creation of volumes. Please use install_software_image_v2 in its stead. Initiates an install of SW images on all blades installed on one chassis. BIG-IP_v9.6.0
install_software_image_v2 Initiates an install of a software image on all blades installed on one chassis. BIG-IP_v11.2.0
set_boot_image_information Sets the boot image information and automatically initiates installation based on the boot image information. BIG-IP_v9.2.0
set_boot_location 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. BIG-IP_v9.2.0
set_cluster_boot_location 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. BIG-IP_v9.6.0

Structures

Structure

Description

HotFixInformation

A structure that contains the information on hotfixes that have been applied to the system.

InstallationID

A structure that contains the information for identifying a live install process.

SoftwareStatus

A structure that contains information on software status. This includes items like product, version, build, and (live install) completion status.

repositoryImageID

A structure with information for identifying a specific image or hotfix.

softwareBlockDeviceHotfix

A structure with information for describing a specific block device hotfix.

softwareBlockDeviceImage

A structure with information for describing a specific block device image.

softwareRepositoryHotfix

A structure with information for describing a specific hotfix.

softwareRepositoryImage

A structure with information for describing a specific image.


Enumerations

Enumeration Description
SoftwareBlockDeviceAgent A list of possible sources for block device images and hotfixes.

Exceptions

Exception Description

Constants

Constant Type Value Description

Aliases

Alias Type Description
HotFixInformationSequence HotFixInformation [] A sequence of hotfix information.
InstallationIDSequence InstallationID [] A sequence of InstallationID information.
SoftwareStatusSequence SoftwareStatus [] A sequence of software status objects.
repositoryImageIDSequence repositoryImageID [] A sequence of repositoryImageID s.
softwareBlockDeviceHotfixSequence softwareBlockDeviceHotfix [] A sequence of softwareBlockDeviceHotfix objects.
softwareBlockDeviceImageSequence softwareBlockDeviceImage [] A sequence of softwareBlockDeviceImage objects.
softwareRepositoryHotfixSequence softwareRepositoryHotfix [] A sequence of softwareRepositoryHotfix objects.
softwareRepositoryImageSequence softwareRepositoryImage [] A sequence of softwareRepositoryImage objects.

See Also

Warning

The links to the sample code below are remnants of the old DevCentral wiki and will result in a 404 error. For best results, please copy the link text and search the codeshare directly on DevCentral.

Sample Code


The BIG-IP API Reference documentation contains community-contributed content. F5 does not monitor or control community code contributions. We make no guarantees or warranties regarding the available code, and it may contain errors, defects, bugs, inaccuracies, or security vulnerabilities. Your access to and use of any code available in the BIG-IP API reference guides is solely at your own risk.