SoftLayer Hardware Server::setPublicNetworkInterfaceSpeed
From SoftLayer Development Network Wiki
setPublicNetworkInterfaceSpeed is a member of the SoftLayer_Hardware_Server service.
Contents |
Overview
Sets the public network interface speed to the new speed. Speed values can only be 0 (Disconnect), 10, 100, and 1000. The new speed must be equal to or less than the max speed of the interface.
It will take less than a minute to update the switch port speed. The server uplink will not be operational again until the server interface speed is updated.
User Access
Users wishing to execute setPublicNetworkInterfaceSpeed service must have the View Hardware permission assigned to their account.
Return Type
setPublicNetworkInterfaceSpeed returns the boolean data type.
Headers
Required Headers
setPublicNetworkInterfaceSpeed requires the following headers:
Parameters
setPublicNetworkInterfaceSpeed takes the following parameters:
newSpeed
New speed for public network component
- Type: integer
Error Handling
setPublicNetworkInterfaceSpeed throws the following exceptions:
- SoftLayer_Exception_Public
- Throws the exception 'Speed cannot be null and must be 0 (Disconnect), 10, 100, or 1000.' when the parameter being passed in is null.
- SoftLayer_Exception_Public
- Throws the exception 'You do not have permission to this service.' when a user does not have permission to Manage Port Control.
- SoftLayer_Exception_Public
- Throws the exception 'There is currently an outstanding transaction for this server.' when there is a current hardware update.
- SoftLayer_Exception_Public
- Throws the exception 'Speed must be 0 (Disconnect), 10, 100, or 1000.' when the speed being passed in is not in the list of accepted speeds.
- SoftLayer_Exception_Public
- Throws the exception 'You cannot set interface speed greater than max speed.' when the new speed is greater than the current max speed of the public interface.
