SoftLayer_Hardware_Server::shutdownPrivatePort

Disconnect a server’s private network interface.

Description

Disconnect a server’s private network interface. This operation is an alias for calling SoftLayer_Hardware_Server::setPrivateNetworkInterfaceSpeed with a $newSpeed of 0 and unspecified $redundancy.

Receipt of a response does not indicate completion of the configuration change. Any subsequent attempts to request the interface change speed or state, while changes are pending, will result in a busy error.

A response of true indicates a change was required to disconnect the interface; thus changes are pending. A response of false indicates the interface was already disconnected, and thus no changes are pending.

Parameters

None

Required Headers

• Authenticate
• SoftLayer_Hardware_ServerInitParameters

Optional Headers

• None

Return Values

• boolean

Error Handling

• Throws If the requested network is not available to the server
• Throws If a change, not necessarily a speed change, is pending against the server
• Throws If the server is not yet available for interface speed changes
• Throws If the user requesting the change lacks the Port Control permission

Associated Methods

• SoftLayer_Hardware_Server::setPrivateNetworkInterfaceSpeed
• SoftLayer_Hardware_Server::activatePrivatePort
• SoftLayer_Hardware_Server::shutdownPublicPort

REST Example

curl -g -u $SL_USER:$SL_APIKEY -X GET \
'https://api.softlayer.com/rest/v3.1/SoftLayer_Hardware_Server/{SoftLayer_Hardware_ServerID}/shutdownPrivatePort'