Listing Workstations: list_workstations
Service name: list_workstations |
|
URL |
https://SERVER/api/?apikey=yourAPItoken&service=list_workstations &required_parameters=required_parameters [&optional_parameters=optional_parameters] |
Description |
Lists all workstation monitoring devices for site (including top level asset information if available). Includes Agentless scans and mini-agent devices (deprecated features) |
Parameters |
|||||
Post Variable |
Description |
Type |
Required |
Options |
Default |
Optional. Returns a description of the service. |
boolean |
no |
true |
0 |
|
siteid |
The siteid must be a valid id. |
integer |
yes |
0 |
0 |
Example Service Call =list_workstations |
https://SERVER/api/?apikey=yourAPItoken&service=list_workstations&siteid=SITEID |
Example Response |
<result created="2009-09-24T16:41:12+01:00" host="SERVER" status="OK"> <items> <workstation> <guid></guid> <name>PETE-LAPTOP</name> <description>76508TG</description> <install_date>2009-07-10</install_date> <last_boot_time /> <dsc_active>1</dsc_active> <atz_dst_date>0000-03-05:00T01:00:00</atz_dst_date> <utc_apt /> <utc_offset>0</utc_offset> <user>SERVER\peter </user> <domain>test.local</domain> <manufacturer>LENOVO</manufacturer> <model>76508TG</model> <ip>192.168.201.66</ip> <external_ip>101.101.101.101</external_ip> <mac1>00:1C:BF:3D:03:AD</mac1> <mac2>00:15:58:CC:D0:FE</mac2> <mac3>18:E0:20:52:41:53</mac3> <os>Microsoft Windows </os> <workstationid>38549</workstationid> <agent_version>6_0_0</agent_version> <agent_mode>3</agent_mode> <online>1</online> <active_247>0</active_247> <check_interval_247>60</check_interval_247> <status_247>5</status_247> <local_date_247>2009-07-15</local_date_247> <local_time_247>09:16:00</local_time_247> <utc_time_247>2009-07-10 10:36:00</utc_time_247> <dsc_hour>6</dsc_hour> <dsc_status>1</dsc_status> <dsc_local_date>2009-07-15</dsc_local_date> <dsc_local_time>09:16:00</dsc_local_time> <dsc_utc_time>2009-07-10 10:36:00</dsc_utc_time> <tz_bias /> <tz_dst_bias /> <tz_std_bias /> <tz_mode /> <tz_dst_date>0000-03-05:00T01:00:00</tz_dst_date> <tz_std_date>0000-10-05:00T02:00:00</tz_std_date> <assetid>53614</assetid> <wins_name>PETE-LAPTOP</wins_name> <role>1</role> <chassis_type>10</chassis_type> <device_serial>L3G4568</device_serial> <processor_count>1</processor_count> <total_memory>3221225472</total_memory> <os_type>18</os_type> <service_pack>3</service_pack> <os_serial_number>12345-OEM-00123456-00123</os_serial_number> <os_product_key>ABCD1-EFG2H-IJ2KLM-NO3PQ-RSTUV</os_product_key> <last_scan_time>2009-07-10 10:36:00</last_scan_time> <custom field name> custom value </custom fieldname> </workstation> ..... more <server> nodes ... </items> </result> ..... more workstation nodes ... </items> </result> |
Fields Description |
|||||||||||||||||||||
Field |
Type |
Can Be Empty |
Description |
||||||||||||||||||
workstationid |
integer |
no |
Unique identifier of the monitored workstation. |
||||||||||||||||||
guid |
string |
yes |
The guid the monitored workstation uses to authenticate. |
||||||||||||||||||
name |
string |
no |
The name given to the monitored workstation. |
||||||||||||||||||
description |
string |
yes |
The description of the monitored workstation. |
||||||||||||||||||
agent_version |
string |
yes |
The version of the Advanced Monitoring Agent installed on monitored workstation. |
||||||||||||||||||
install_date |
date |
no |
The date the Advanced Monitoring Agent was installed on the monitored workstation. |
||||||||||||||||||
last_boot_time |
integer |
yes |
Timestamp of the last boot time of the monitored workstation. |
||||||||||||||||||
online |
integer (1 or 0) |
no |
Is workstation online or offline?
|
||||||||||||||||||
active_247 |
integer (1 or 0) |
no |
Are 24x7 checks running on workstation?
|
||||||||||||||||||
check_interval_247 |
integer |
no |
Interval for 24x7 checks (minutes) |
||||||||||||||||||
status_247 |
integer |
no |
Status of 24x7 checks:
|
||||||||||||||||||
local_date_247 |
date |
no |
Date (on wkstn) of last 24x7 Checks upload. |
||||||||||||||||||
local_time_247 |
time |
no |
Time (on wkstn) of last 24x7 Checks upload. |
||||||||||||||||||
utc_time_247 |
datetime |
yes |
UTC date and time of last 24x7 Checks upload. |
||||||||||||||||||
dsc_active |
integer |
no |
Are Daily Safety Checks running on workstation?
|
||||||||||||||||||
agent_mode |
Integer |
no |
Agent mode:
|
||||||||||||||||||
dsc_hour |
integer |
no |
Hour of day Daily Safety Checks are running. |
||||||||||||||||||
dsc_status |
integer |
no |
Status of DSC checks:
|
||||||||||||||||||
dsc_local_date |
date |
no |
Date (on wkstn) of last Daily Safety Checks upload. |
||||||||||||||||||
dsc_local_time |
time |
no |
Time (on wkstn) of last Daily Safety Checks upload. |
||||||||||||||||||
dsc_utc_time |
datetime |
yes |
UTC date and time of last Daily Safety Checks upload. |
||||||||||||||||||
tz_bias |
integer |
yes |
The offset in minutes from UTC time |
||||||||||||||||||
tz_dst_bias |
integer |
yes |
The daylight saving time offset in minutes |
||||||||||||||||||
tz_std_bias |
integer |
yes |
The standard time offset in minutes |
||||||||||||||||||
tz_mode |
integer |
yes |
The current time zone mode:
|
||||||||||||||||||
atz_dst_date |
string |
yes |
The date when daylight saving time begins |
||||||||||||||||||
tz_dst_date |
string |
yes |
The date when daylight saving time begins |
||||||||||||||||||
tz_std_date |
string |
yes |
The date when standard time begins |
||||||||||||||||||
utc_apt |
datetime |
yes |
The Agent perceived UTC time |
||||||||||||||||||
utc_offset |
integer |
yes |
The effective UTC offset in seconds |
||||||||||||||||||
assetid |
integer |
yes |
The workstations unique physical asset identifier, Agent v8.0 and above. |
||||||||||||||||||
wins_name |
string |
yes |
The WINS name of the physical asset. |
||||||||||||||||||
user |
string |
yes |
The user logged onto the physical asset during scan. |
||||||||||||||||||
domain |
string |
yes |
The domain the physical asset is a member of. |
||||||||||||||||||
role |
string |
yes |
The role being performed by physical asset:
|
||||||||||||||||||
chassis_type |
integer |
yes |
Chassis type (physical workstations only):
|
||||||||||||||||||
manufacturer |
string |
yes |
The manufacturer of the physical asset. |
||||||||||||||||||
model |
string |
yes |
The model of the physical asset. |
||||||||||||||||||
device_serial |
string |
yes |
The serial number of the physical asset. |
||||||||||||||||||
ip |
string |
yes |
The IP address of the physical asset. |
||||||||||||||||||
external_ip |
string |
yes |
The external IP address of the last agent upload. |
||||||||||||||||||
mac1 |
string |
yes |
The MAC address of the first NIC in the physical asset. |
||||||||||||||||||
mac2 |
string |
yes |
The MAC address of the second NIC in the physical asset. |
||||||||||||||||||
mac3 |
string |
yes |
The MAC address of the third NIC in the physical asset. |
||||||||||||||||||
processor_count |
integer |
yes |
The number of processors in the physical asset. |
||||||||||||||||||
total_memory |
integer |
yes |
The total memory (bytes) in the physical asset. |
||||||||||||||||||
os_type |
integer |
no |
Type of Operating System installed. |
||||||||||||||||||
os |
string |
yes |
The operating system installed on the physical asset. Returns device.osversion if no as_device record. |
||||||||||||||||||
service_pack |
float |
yes |
The service pack installed on the physical asset. |
||||||||||||||||||
os_serial_number |
string |
yes |
The operating system serial number. |
||||||||||||||||||
os_product_key |
string |
yes |
The operating system product key. |
||||||||||||||||||
last_scan_time |
datetime |
yes |
The date and time of last asset scan. |
||||||||||||||||||
custom field name |
string |
yes |
The information entered in the Custom Field |
Example Associated Service Calls | ||
Parameter | Call | URL Format |
SiteID | list_sites | https://SERVER/api/?apikey=yourAPItoken&service=list_sites&clientid=CLIENTID |
ClientID | list_clients | https://SERVER/api/?apikey=yourAPItoken&service=list_clients |