SoftLayer Network Monitor Version1 Query Host::findByHardwareId

From SoftLayer Development Network Wiki

findByHardwareId is a member of the SoftLayer_Network_Monitor_Version1_Query_Host service.

Contents 1 Overview 2 User Access 3 Return Type 4 Headers 4.1 Required Headers 4.2 Optional Headers 5 Parameters 5.1 hardwareId

Overview

This method returns all Query_Host objects associated with the passed in hardware ID as long as that hardware ID is owned by the current user's account.

This behavior can also be accomplished by simply tapping networkMonitors on the Hardware_Server object.

User Access

Users wishing to execute findByHardwareId service must have the Monitoring permission assigned to their account.

Return Type

findByHardwareId returns the SoftLayer_Network_Monitor_Version1_Query_HostArray data type.

Headers

Required Headers

findByHardwareId requires the following headers:

• authenticate

Optional Headers

findByHardwareId may use the following headers:

• SoftLayer_Network_Monitor_Version1_Query_HostObjectMask

Parameters

findByHardwareId takes the following parameters:

hardwareId

The ID of the hardware to search by

• Type: integer