SoftLayer Hardware Server::getPrivateNetworkComponent

From SoftLayer Development Network Wiki

getPrivateNetworkComponent is a member of the SoftLayer_Hardware_Server service.

Contents 1 Overview 2 User Access 3 Return Type 4 Headers 4.1 Required Headers 4.2 Optional Headers 5 Error Handling

Overview

Retrieve the private network component attached with this server.

User Access

Users wishing to execute getPrivateNetworkComponent must have the following permissions assigned to their account:

• View Hardware Details

Return Type

getPrivateNetworkComponent returns the SoftLayer_Network_Component data type.

Headers

Required Headers

getPrivateNetworkComponent requires the following headers set:

• authenticate
• SoftLayer_Hardware_ServerInitParameter

Optional Headers

getPrivateNetworkComponent takes the following optional headers:

• SoftLayer_Hardware_ServerObjectMask

Error Handling

getPrivateNetworkComponent throws the following exceptions:

• SoftLayer_Exception

Throw the exception "Unable to locate this server's private networking component." if the API is unable to locate a management componenet for this server.