system.search

Description

Provides methods to perform system search requests using the search server.

Namespace:

system.search

Method: deviceDescription

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 "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

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 "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

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 "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

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 "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

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 "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

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 "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

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 "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

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 "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