Class: IControl::System::SoftwareManagement::SoftwareStatus

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

Overview

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

Instance Attribute Summary collapse

Instance Attribute Details

#activeObject

Whether the boot location is active.

Returns:

  • (Object)

    the current value of active


350
351
352
# File 'lib/icontrol/system/software_management.rb', line 350

def active
  @active
end

#base_buildString

The base build (used for hotfixes).

Returns:

  • (String)

    the current value of base_build


350
351
352
# File 'lib/icontrol/system/software_management.rb', line 350

def base_build
  @base_build
end

#buildString

The build number you are installing.

Returns:

  • (String)

    the current value of build


350
351
352
# File 'lib/icontrol/system/software_management.rb', line 350

def build
  @build
end

#editionString

Gives the edition, e.g.“Hotfix HF4” (used for hotfixes).

Returns:

  • (String)

    the current value of edition


350
351
352
# File 'lib/icontrol/system/software_management.rb', line 350

def edition
  @edition
end

#installation_idIControl::System::SoftwareManagement::InstallationID

The location for the status.

Returns:


350
351
352
# File 'lib/icontrol/system/software_management.rb', line 350

def installation_id
  @installation_id
end

#productString

The product you are installing (ex: BIGIP) (or, product which is installed).

Returns:

  • (String)

    the current value of product


350
351
352
# File 'lib/icontrol/system/software_management.rb', line 350

def product
  @product
end

#statusString

A string indicating the status of the live install process. The status strings are “none”, “audited”, “retry”, “upgrade needed”, “waiting for image”, “installing nn.mmm pct”, “complete”, “cancelling”, “cancelled”, and “failed”. The “failed” string may have text giving a reason after it. The “waiting for image” string may have further text after it describing the image being awaited. A client should ignore any strings returned other than these. You can use the status field to monitor the completion status of a live install operation in process. When checking status, you should ensure that the product, version, and build reflect the software whose status you are interested in (because there are a few scenarios where the product, version, and build for a volume may not be updated as quickly as you might expect).

Returns:

  • (String)

    the current value of status


350
351
352
# File 'lib/icontrol/system/software_management.rb', line 350

def status
  @status
end

#versionString

The version of product (ex: 9.6.0).

Returns:

  • (String)

    the current value of version


350
351
352
# File 'lib/icontrol/system/software_management.rb', line 350

def version
  @version
end