SoftLayer_Network_Component::removeNetworkVlanTrunks

Remove VLAN trunks from a network component

Description

Remove one or more VLANs currently attached as trunks to this network component.

If any VLANs are given which are not attached as trunks, they will be ignored.

This method should be called on a network component of assigned hardware. A current list of VLAN trunks for a network component on a customer server can be found at ‘uplinkComponent->networkVlanTrunks’.

This method returns an array of SoftLayer_Network_Vlans which will be removed as trunks. Any requested VLANs which were not trunked will be ignored and will not be returned.

Affected VLANs will not yet be removed as trunks upon return of this call, but deactivation and removal will have been scheduled and should be considered imminent. The trunking records associated with the affected VLANs will maintain an ‘isUpdating’ value of ‘1’ so long as this is the case.

Note that in the event of a “pending API request” error some VLANs may still have been affected and scheduled for deactivation.

Parameters

Required Headers

• Authenticate
• SoftLayer_Network_ComponentInitParameters

Optional Headers

• SoftLayer_Network_ComponentObjectMask

Return Values

• SoftLayer_Network_Vlan[]

Error Handling

• Throw the error ‘Invalid value provided for 'id and vlanNumber'’ if sufficient data was not provided from which to retrieve a VLAN record.
• Throw the error ‘The following VLAN IDs|numbers are not valid’ if a VLAN record could not be retrieved for the provided data.
• Throw the error ‘Insufficient permissions to modify server’ if the user lacks access to the associated hardware.
• Throw the error ‘Hardware is not supported for customer-managed trunking’ if trunking cannot be modified for the associated hardware.
• Throw the error ‘Component is not supported for customer-managed trunking’ if trunking cannot be modified on the given component.
• Throw the error ‘Trunking management is not available to gateway inside VLANs’ if a given VLAN is already associated to this gateway.
• Throw the error ‘Server is not currently available for VLAN trunk modification’ if the associated hardware cannot be modified at this time. Try again later.
• Throw the error ‘The network is undergoing maintenance and requests to modify trunking cannot be fulfilled at this time’ if the network is undergoing maintenance. Try again later.
• Throw the error ‘A pending API request to update trunks for network component exists’ if a trunking request for this component is in-progress. Try again later.

REST Example

curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [SoftLayer_Network_Vlan]}' \
'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Component/{SoftLayer_Network_ComponentID}/removeNetworkVlanTrunks'