getRouter


SoftLayer_Resource_Metadata::getRouter

The router associated with a network component

Description

The getRouter method will return the router associated with a network component. When the router is redundant, the hostname of the redundant group will be returned, rather than the router hostname.

Parameters

Name Type Description
macAddress string The MAC address to obtain the router for

Required Headers

Optional Headers

  • None

Return Values

  • string

Error Handling

  • Thrown when a network component is not found for the provided MAC address
  • Thrown when a router is not found for the network component
  • Thrown when the MAC address provided is invalid