system.search
Description
Provides methods to perform system search requests using the search server.
Namespace:
system.search
Method: deviceDescription
HTTP GET
Description:
List the systems which match the device description.
Parameters:
-
string sessionKey
-
string searchTerm
Returns:
-
array :
-
struct system
-
int "id"
-
string "name"
-
dateTime.iso8601 "last_checkin" - last time server successfully checked in
-
string "hostname"
-
string "uuid"
-
string "ip"
-
string "hw_description" - HW description if not null
-
string "hw_device_id" - HW device id if not null
-
string "hw_vendor_id" - HW vendor id if not null
-
string "hw_driver" - HW driver if not null
-
Method: deviceDriver
HTTP GET
Description:
List the systems which match this device driver.
Parameters:
-
string sessionKey
-
string searchTerm
Returns:
-
array :
-
struct system
-
int "id"
-
string "name"
-
dateTime.iso8601 "last_checkin" - last time server successfully checked in
-
string "hostname"
-
string "uuid"
-
string "ip"
-
string "hw_description" - HW description if not null
-
string "hw_device_id" - HW device id if not null
-
string "hw_vendor_id" - HW vendor id if not null
-
string "hw_driver" - HW driver if not null
-
Method: deviceId
HTTP GET
Description:
List the systems which match this device id
Parameters:
-
string sessionKey
-
string searchTerm
Returns:
-
array :
-
struct system
-
int "id"
-
string "name"
-
dateTime.iso8601 "last_checkin" - last time server successfully checked in
-
string "hostname"
-
string "uuid"
-
string "ip"
-
string "hw_description" - HW description if not null
-
string "hw_device_id" - HW device id if not null
-
string "hw_vendor_id" - HW vendor id if not null
-
string "hw_driver" - HW driver if not null
-
Method: deviceVendorId
HTTP GET
Description:
List the systems which match this device vendor_id
Parameters:
-
string sessionKey
-
string searchTerm
Returns:
-
array :
-
struct system
-
int "id"
-
string "name"
-
dateTime.iso8601 "last_checkin" - last time server successfully checked in
-
string "hostname"
-
string "uuid"
-
string "ip"
-
string "hw_description" - HW description if not null
-
string "hw_device_id" - HW device id if not null
-
string "hw_vendor_id" - HW vendor id if not null
-
string "hw_driver" - HW driver if not null
-
Method: hostname
HTTP GET
Description:
List the systems which match this hostname
Parameters:
-
string sessionKey
-
string searchTerm
Returns:
-
array :
-
struct system
-
int "id"
-
string "name"
-
dateTime.iso8601 "last_checkin" - last time server successfully checked in
-
string "hostname"
-
string "uuid"
-
string "ip"
-
string "hw_description" - HW description if not null
-
string "hw_device_id" - HW device id if not null
-
string "hw_vendor_id" - HW vendor id if not null
-
string "hw_driver" - HW driver if not null
-
Method: ip
HTTP GET
Description:
List the systems which match this ip.
Parameters:
-
string sessionKey
-
string searchTerm
Returns:
-
array :
-
struct system
-
int "id"
-
string "name"
-
dateTime.iso8601 "last_checkin" - last time server successfully checked in
-
string "hostname"
-
string "uuid"
-
string "ip"
-
string "hw_description" - HW description if not null
-
string "hw_device_id" - HW device id if not null
-
string "hw_vendor_id" - HW vendor id if not null
-
string "hw_driver" - HW driver if not null
-
Method: nameAndDescription
HTTP GET
Description:
List the systems which match this name or description
Parameters:
-
string sessionKey
-
string searchTerm
Returns:
-
array :
-
struct system
-
int "id"
-
string "name"
-
dateTime.iso8601 "last_checkin" - last time server successfully checked in
-
string "hostname"
-
string "uuid"
-
string "ip"
-
string "hw_description" - HW description if not null
-
string "hw_device_id" - HW device id if not null
-
string "hw_vendor_id" - HW vendor id if not null
-
string "hw_driver" - HW driver if not null
-
Method: uuid
HTTP GET
Description:
List the systems which match this UUID
Parameters:
-
string sessionKey
-
string searchTerm
Returns:
-
array :
-
struct system
-
int "id"
-
string "name"
-
dateTime.iso8601 "last_checkin" - last time server successfully checked in
-
string "hostname"
-
string "uuid"
-
string "ip"
-
string "hw_description" - HW description if not null
-
string "hw_device_id" - HW device id if not null
-
string "hw_vendor_id" - HW vendor id if not null
-
string "hw_driver" - HW driver if not null
-