SoftLayer Account::getWindowsUpdateStatus

From SoftLayer Development Network Wiki

getWindowsUpdateStatus is a member of the SoftLayer_Account service.

Contents 1 Overview 2 Return Type 3 Headers 3.1 Required Headers 3.2 Optional Headers 4 Error Handling 5 Associated Methods

Overview

Retrieve a list of an account's hardware's Windows Update status. This list includes which servers have available updates, which servers require rebooting due to updates, which servers have failed retrieving updates, and which servers have failed to communicate with the SoftLayer private Windows Software Update Services server.

Return Type

getWindowsUpdateStatus returns the SoftLayer_Container_Utility_Microsoft_Windows_UpdateServices_StatusArray data type.

Headers

Required Headers

getWindowsUpdateStatus requires the following headers:

• authenticate
• SoftLayer_AccountInitParameters

Optional Headers

getWindowsUpdateStatus may use the following headers:

• SoftLayer_AccountObjectMask

Error Handling

getWindowsUpdateStatus throws the following exceptions:

• SoftLayer

Exception Throw the exception "No servers found for this user." if the user making the API call does not have access to any of their account's hardware.

• SoftLayer

Exception Throw the exception "No Windows-based servers found for this user." if the user making the API call does not have access to hardware that runs the Microsoft Windows operating system.

• SoftLayer

Exception Throw the exception "Filed to get a response from {address}." if the API is unable to contact the rrivate WSUS servers.

Associated Methods

• SoftLayer_Hardware::getWindowsUpdateStatus