List all Patches for device: patch_list_all

Service name: patch_list_all

URL

https://SERVER/api/?apikey=yourAPItoken&service=patch_list_all

&required_parameters=required_parameters

[&optional_parameters=optional_parameters]

Description

Lists all software patches for the specified device.

 

Parameters

Post Variable

Description

Type

Required

Options

Default

describe

Optional. Returns a description of the service.

boolean

no

true

0

deviceid

The deviceid must be a valid id.

number

yes

0

0

 

Example Service Call =patch_list_all

https://SERVER/api/?apikey=yourAPItoken&service=patch_list_all&deviceid=DEVICEID

Example Response

<?xml version="1.0" ?>

<patches>

<patch>

<patchid>78</patchid>

<policy>4</policy>

<patchicon>aw-image-patch-installed</patchicon>

<status>8</status>

<statusLabel>Installed</statusLabel>

<patchUrl>http://go.microsoft.com/fwlink/?LinkId=184779</patchUrl>

<patchTitle>Security Update for Windows Vista (KB981349)</patchTitle>

<product>Windows</product>

<severity>4</severity>

<severityLabel>Low</severityLabel>

<releaseDate>1300471870</releaseDate>

<releaseDateText>18-Mar-2011</releaseDateText>

<installdate>1303187104</installdate>

<installdatetext>19-Apr-2011</installdatetext>

</patch>

... more patch nodes ...

</patches>

</result>

 

Field Descriptions

Field

Type

Can Be Empty

Description

patchid

integer

no

The unique identifier of the patch

policy

integer

no

Policy setting:
0 - No policy exists
1 - Install feature/patch
2 - Do not install feature/patch
3 - Inherit policy from parent

patchicon

string

yes

Generalized status icon:
aw-image-patch-failed
aw-image-patch-installed
aw-image-patch-missing
aw-image-patch-pending
aw-image-patch-installing
aw-image-patch-ignored

status

integer

no

The patch status (bit flags)
0x01 - Missing
0x02 - Pending
0x04 - Queued
0x08 - Installed
0x10 - Failed
0x20 - Ignored

statusLabel

string

no

Installation status:
Missing
Pending
Queued
Installed
Failed
Ignored

patchUrl

string

yes

External link to patch description, for example:
http://support.microsoft.com/kb/979441

patchTitle

string

no

Title/name of the patch, for example:
Security Update for Microsoft Office InfoPath 2007 (KB979441)

product

string

no

Product identifier, for example:
Office

severity

integer

yes

The severity of the vulnerability the patch addresses.
1 (Critical)
2 (Important)
3 (Moderate)
4 (Low)
See [http://www.microsoft.com/technet/security/bulletin/rating.mspx Microsoft Security Response Center Security Bulletin Severity Rating System]

severityLabel

string

yes

Severity level name.
Critical
Important
Moderate
Low
See [http://www.microsoft.com/technet/security/bulletin/rating.mspx Microsoft Security Response Center Security Bulletin Severity Rating System]

releaseDate

int

yes

Patch release date/time (timestamp)

releaseDateText

datetime

yes

Patch release date/time human format, for example:
28-Jul-2011

installdate

int

yes

Installation date/time (timestamp)

installdatetext

datetime

yes

Installation date/time human format, for example:
28-Jul-2011

Please note, Patch releaseDate and releaseDateText were included from Dashboard 5.42.1

 

Example Associated Service Calls
Parameter Call URL Format
DeviceID list_devices_at_client

https://SERVER/api/?apikey=yourAPItoken&service=list_devices_at_client&clientid=CLIENTID&devicetype=server
list_servers

https://SERVER/api/?apikey=yourAPItoken&service=list_servers&siteid=SITEID

list_workstations

https://SERVER/api/?apikey=yourAPItoken&service=list_workstations&siteid=SITEID
SiteID list_sites https://SERVER/api/?apikey=yourAPItoken&service=list_sites&clientid=CLIENTID
ClientID list_clients https://SERVER/api/?apikey=yourAPItoken&service=list_clients