com.quantum.dxi.rest.system

Class SoftwarePatchUpgrades

java.lang.Object

Base

com.quantum.dxi.rest.system.SoftwarePatchUpgrades

public class SoftwarePatchUpgrades
extends Base

The SoftwarePatchUpgrades resource represents availability and status of software upgrades. The SoftwarePatchUpgrades resource includes services for getting preflight instructions for upgrades, checking for upgrade availability, checking the status of upgrade download and instalation, and initiating download and installation of upgrades.

The schema that defines the SoftwarePatchUpgrades resource is defined below.

 
    <xs:element name="SoftwarePatchUpgrades">
        <xs:complexType>
            <xs:sequence>
                <xs:element name="TotalCount" type="xs:long" minOccurs="0">
                    <xs:annotation>
                        <xs:documentation>Total number of Software Patch Upgrade entries</xs:documentation>
                    </xs:annotation>
                </xs:element>
                <xs:element ref="SoftwarePatchUpgrade" minOccurs="0" maxOccurs="unbounded"/>
            </xs:sequence>
        </xs:complexType>
    </xs:element>

    <xs:element name="SoftwarePatchUpgrade">
        <xs:complexType>
            <xs:sequence>
                <xs:element name="Id" type="xs:string"/>
                <xs:element name="ReleaseDate" type="xs:long"/>
                <xs:element name="Version" type="xs:string"/>
                <xs:element name="Summary" type="xs:string"/>
                <xs:element name="Description" type="xs:string"/>
                <xs:element name="DownloadComplete" type="xs:boolean"/>
                <xs:element name="PreflightInstructionsFile" type="xs:string" minOccurs="0"/>
            </xs:sequence>
        </xs:complexType>
    </xs:element>

    <xs:element name="SoftwarePatchUpgradeColumnName">
        <xs:annotation>
            <xs:documentation>An enum containing the valid column names for a SoftwarePatchUpgrade</xs:documentation>
        </xs:annotation>
        <xs:simpleType>
            <xs:restriction base="xs:string">
                <xs:enumeration value="SoftwarepatchupgradeId"/>
                <xs:enumeration value="SoftwarepatchupgradeReleaseDate"/>
                <xs:enumeration value="SoftwarepatchupgradeVersion"/>
                <xs:enumeration value="SoftwarepatchupgradeSummary"/>
                <xs:enumeration value="SoftwarepatchupgradeDescription"/>
                <xs:enumeration value="SoftwarepatchupgradeDownloadComplete"/>
                <xs:enumeration value="SoftwarepatchupgradePreflightInstructionsFile"/>
            </xs:restriction>
        </xs:simpleType>
    </xs:element>
 
 

Constructor Summary

Constructors

Constructor and Description
SoftwarePatchUpgrades()

Method Summary

Modifier and Type	Method and Description
void	deleteAction(javax.servlet.http.HttpServletRequest request, String upgradeId, String errorType) DELETE /rest/SoftwarePatchUpgrades/{upgradeId}
javax.ws.rs.core.Response	disableAutoPolling(javax.servlet.http.HttpServletRequest request, String errorType) POST /rest/SoftwarePatchUpgrades/disableAutoPolling
javax.ws.rs.core.Response	download(javax.servlet.http.HttpServletRequest request, String upgradeId, String errorType) POST /rest/SoftwarePatchUpgrades/{upgradeId}/download
javax.ws.rs.core.Response	enableAutoPolling(javax.servlet.http.HttpServletRequest request, String errorType) POST /rest/SoftwarePatchUpgrades/enableAutoPolling
BooleanScalarType	getAutoPolling(javax.servlet.http.HttpServletRequest request, String errorType) GET /rest/SoftwarePatchUpgrades/getAutoPolling
StringScalarType	getDownloadProgressionStatus(javax.servlet.http.HttpServletRequest request, String errorType) GET /rest/SoftwarePatchUpgrades/getDownloadProgressionStatus
StringScalarType	getInstallProgressionStatus(javax.servlet.http.HttpServletRequest request, String errorType) GET /rest/SoftwarePatchUpgrades/getInstallProgressionStatus
NumericScalarType	getLastPollingTime(javax.servlet.http.HttpServletRequest request, String errorType) GET /rest/SoftwarePatchUpgrades/getLastPollingTime
SoftwarePatchUpgrade	getPatchUpgradeOffline(javax.servlet.http.HttpServletRequest request, String errorType) GET /rest/SoftwarePatchUpgrades/getPatchUpgradeOffline
javax.ws.rs.core.Response	getPreflightInstructions(javax.servlet.http.HttpServletRequest request, String errorType) GET /rest/SoftwarePatchUpgrades/getPreflightInstructions
javax.ws.rs.core.Response	getSoftwareUpgradeDocumentation(javax.servlet.http.HttpServletRequest request, String actionString, String errorType) Deprecated. As of 1.1 ?action=getPreflightInstructions replaced by getPreflightInstructions(HttpServletRequest, String) ?action=getUpgradesDescriptionSummary replaced by getUpgradesDescriptionSummary(HttpServletRequest, String)
javax.ws.rs.core.Response	getUpgradesDescriptionSummary(javax.servlet.http.HttpServletRequest request, String errorType) GET /rest/SoftwarePatchUpgrades/getUpgradesDescriptionSummary
StringScalarType	getUpgradesState(javax.servlet.http.HttpServletRequest request, String errorType) GET /rest/SoftwarePatchUpgrades/getUpgradesState
javax.ws.rs.core.Response	install(javax.servlet.http.HttpServletRequest request, String upgradeId, String errorType) POST /rest/SoftwarePatchUpgrades/{upgradeId}/install
javax.ws.rs.core.Response	pollUpgrades(javax.servlet.http.HttpServletRequest request, String errorType) POST /rest/SoftwarePatchUpgrades/pollUpgrades
NumericScalarType	postAction(javax.servlet.http.HttpServletRequest request, String actionString, String upgradeId, String errorType) Deprecated. As of 1.1 ?action=download replaced by download(HttpServletRequest, String, String) ?action=install replaced by install(HttpServletRequest, String, String)
Object	upgradeActions(javax.servlet.http.HttpServletRequest request, String actionString, String errorType) Deprecated. As of 1.1 ?action=getAutoPolling replaced by getAutoPolling(HttpServletRequest, String) ?action=enableAutoPolling replaced by enableAutoPolling(HttpServletRequest, String) ?action=disableAutoPolling replaced by disableAutoPolling(HttpServletRequest, String) ?action=pollUpgrades replaced by pollUpgrades(HttpServletRequest, String) ?action=getPatchUpgradeOffline replaced by getPatchUpgradeOffline(HttpServletRequest, String) ?action=getLastPollingTime replaced by getLastPollingTime(HttpServletRequest, String) ?action=getUpgradesState replaced by getUpgradesState(HttpServletRequest, String) ?action=getDownloadProgressionStatus replaced by getDownloadProgressionStatus(HttpServletRequest, String) ?action=getInstallProgressionStatus replaced by getInstallProgressionStatus(HttpServletRequest, String)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SoftwarePatchUpgrades

public SoftwarePatchUpgrades()

Method Detail

getPreflightInstructions

public javax.ws.rs.core.Response getPreflightInstructions(@Context
                                                          javax.servlet.http.HttpServletRequest request,
                                                          String errorType)

GET /rest/SoftwarePatchUpgrades/getPreflightInstructions

Get preflight instructions for software upgrade.

Response Entity type: formatted documentation Response Content type: text/html

Since:

1.1

getUpgradesDescriptionSummary

public javax.ws.rs.core.Response getUpgradesDescriptionSummary(@Context
                                                               javax.servlet.http.HttpServletRequest request,
                                                               String errorType)

GET /rest/SoftwarePatchUpgrades/getUpgradesDescriptionSummary

Get summary description for the software upgrade.

Response Entity type: formatted documentation Response Content type: text/html

Since:

1.1

getSoftwareUpgradeDocumentation

public javax.ws.rs.core.Response getSoftwareUpgradeDocumentation(@Context
                                                                 javax.servlet.http.HttpServletRequest request,
                                                                 String actionString,
                                                                 String errorType)

Deprecated. As of 1.1
?action=getPreflightInstructions replaced by getPreflightInstructions(HttpServletRequest, String)
?action=getUpgradesDescriptionSummary replaced by getUpgradesDescriptionSummary(HttpServletRequest, String)

GET /rest/SoftwarePatchUpgrades

Get formatted documentation for software upgrades.

The action query parameter is required.

Supported actions are:

• ?action=getPreflightInstructions get preflight instructions for the upgrade
• ?action=getUpgradesDescriptionSummary get summary description for the upgrade

Response Entity type: formatted documentation Response Content type: text/html

getAutoPolling

public BooleanScalarType getAutoPolling(@Context
                                        javax.servlet.http.HttpServletRequest request,
                                        String errorType)

GET /rest/SoftwarePatchUpgrades/getAutoPolling

Get the configuration state of auto polling for upgrades on the system.

Response Entity type: <xs:element name="BooleanScalarType">

Since:

1.1

enableAutoPolling

public javax.ws.rs.core.Response enableAutoPolling(@Context
                                                   javax.servlet.http.HttpServletRequest request,
                                                   String errorType)

POST /rest/SoftwarePatchUpgrades/enableAutoPolling

Enable auto polling for upgrades on the system.

Since:

1.1

disableAutoPolling

public javax.ws.rs.core.Response disableAutoPolling(@Context
                                                    javax.servlet.http.HttpServletRequest request,
                                                    String errorType)

POST /rest/SoftwarePatchUpgrades/disableAutoPolling

Disable auto polling for upgrades on the system.

Since:

1.1

pollUpgrades

public javax.ws.rs.core.Response pollUpgrades(@Context
                                              javax.servlet.http.HttpServletRequest request,
                                              String errorType)

POST /rest/SoftwarePatchUpgrades/pollUpgrades

Start a background job to poll for available upgrades on the system.

Response Entity type: <xs:element name="NumericScalarType"> representing the job id.

Since:

1.1

getPatchUpgradeOffline

public SoftwarePatchUpgrade getPatchUpgradeOffline(@Context
                                                   javax.servlet.http.HttpServletRequest request,
                                                   String errorType)

GET /rest/SoftwarePatchUpgrades/getPatchUpgradeOffline

Get patch upgrades offline.

Response Entity type: <xs:element name="SoftwarePatchUpgrade">

Since:

1.1

getLastPollingTime

public NumericScalarType getLastPollingTime(@Context
                                            javax.servlet.http.HttpServletRequest request,
                                            String errorType)

GET /rest/SoftwarePatchUpgrades/getLastPollingTime

Get the last time the system polled for available upgrades.

Response Entity type: <xs:element name="NumericScalarType">

Since:

1.1

getUpgradesState

public StringScalarType getUpgradesState(@Context
                                         javax.servlet.http.HttpServletRequest request,
                                         String errorType)

GET /rest/SoftwarePatchUpgrades/getUpgradesState

Get upgrades download/install state.

Response Entity type: <xs:element name="StringScalarType">

Since:

1.1

getDownloadProgressionStatus

public StringScalarType getDownloadProgressionStatus(@Context
                                                     javax.servlet.http.HttpServletRequest request,
                                                     String errorType)

GET /rest/SoftwarePatchUpgrades/getDownloadProgressionStatus

Get the progress status of a software upgrade download.

Response Entity type: <xs:element name="StringScalarType">

Since:

1.1

getInstallProgressionStatus

public StringScalarType getInstallProgressionStatus(@Context
                                                    javax.servlet.http.HttpServletRequest request,
                                                    String errorType)

GET /rest/SoftwarePatchUpgrades/getInstallProgressionStatus

Get the progress status of a software upgrade install.

Response Entity type: <xs:element name="StringScalarType">

Since:

1.1

upgradeActions

public Object upgradeActions(@Context
                             javax.servlet.http.HttpServletRequest request,
                             String actionString,
                             String errorType)

Deprecated. As of 1.1
?action=getAutoPolling replaced by getAutoPolling(HttpServletRequest, String)
?action=enableAutoPolling replaced by enableAutoPolling(HttpServletRequest, String)
?action=disableAutoPolling replaced by disableAutoPolling(HttpServletRequest, String)
?action=pollUpgrades replaced by pollUpgrades(HttpServletRequest, String)
?action=getPatchUpgradeOffline replaced by getPatchUpgradeOffline(HttpServletRequest, String)
?action=getLastPollingTime replaced by getLastPollingTime(HttpServletRequest, String)
?action=getUpgradesState replaced by getUpgradesState(HttpServletRequest, String)
?action=getDownloadProgressionStatus replaced by getDownloadProgressionStatus(HttpServletRequest, String)
?action=getInstallProgressionStatus replaced by getInstallProgressionStatus(HttpServletRequest, String)

POST /rest/SoftwarePatchUpgrades

Perform a software upgrade-related action on the system.

The action query parameter is required.

Supported actions are:

• ?action=getAutoPolling get the configuration state of auto polling for upgrades on the system
• ?action=enableAutoPolling enable auto polling for upgrades on the system
• ?action=disableAutoPolling disable auto polling for upgrades on the system
• ?action=pollUpgrades poll for available upgrades on the system
• ?action=getPatchUpgradeOffline get patch upgrades offline
• ?action=getLastPollingTime get the last time the system polled for available upgrades
• ?action=getUpgradesState get upgrades download/install state
• ?action=getDownloadProgressionStatus get the progress status of a software upgrade download
• ?action=getInstallProgressionStatus get the progress status of a software upgrade install

Response Entity type:

• ?action=getAutoPolling <xs:element name="BooleanScalarType">
• ?action=enableAutoPolling <xs:element name="StringScalarType">
• ?action=disableAutoPolling <xs:element name="StringScalarType">
• ?action=pollUpgrades <xs:element name="NumericScalarType">
• ?action=getPatchUpgradeOffline <xs:element name="SoftwarePatchUpgrade">
• ?action=getLastPollingTime <xs:element name="NumericScalarType">
• ?action=getUpgradesState <xs:element name="StringScalarType">
• ?action=getDownloadProgressionStatus <xs:element name="StringScalarType">
• ?action=getInstallProgressionStatus <xs:element name="StringScalarType">

download

public javax.ws.rs.core.Response download(@Context
                                          javax.servlet.http.HttpServletRequest request,
                                          String upgradeId,
                                          String errorType)

POST /rest/SoftwarePatchUpgrades/{upgradeId}/download

Download the requested software upgrade.

Response Entity type: <xs:element name="NumericScalarType"> representing a background job id.

Since:

1.1

install

public javax.ws.rs.core.Response install(@Context
                                         javax.servlet.http.HttpServletRequest request,
                                         String upgradeId,
                                         String errorType)

POST /rest/SoftwarePatchUpgrades/{upgradeId}/install

Install the requested software upgrade.

Response Entity type: <xs:element name="NumericScalarType"> representing a background job id.

Since:

1.1

postAction

public NumericScalarType postAction(@Context
                                    javax.servlet.http.HttpServletRequest request,
                                    String actionString,
                                    String upgradeId,
                                    String errorType)

Deprecated. As of 1.1
?action=download replaced by download(HttpServletRequest, String, String)
?action=install replaced by install(HttpServletRequest, String, String)

POST /rest/SoftwarePatchUpgrades/{upgradeId}

Perform an action on a specific upgrade on the system. The {upgradeId} will match against the <xs:element name="Id" type="xs:string"/> element of the schema to find the requested upgrade. The action will run in a background job.

The action query parameter is required.

Supported actions are:

• ?action=download download the requested software upgrade
• ?action=install install the requested software upgrade

Response Entity type: <xs:element name="NumericScalarType"> representing a background job id.

deleteAction

public void deleteAction(@Context
                         javax.servlet.http.HttpServletRequest request,
                         String upgradeId,
                         String errorType)

DELETE /rest/SoftwarePatchUpgrades/{upgradeId}

Delete a software upgrade from the system. The {upgradeId} will match against the <xs:element name="Id" type="xs:string"/> element of the schema to find the requested upgrade.