upgrade

Classes SoftLayer_Network_Vlan
Tags method sldn network

SoftLayer_Network_Vlan::upgrade

Convert the VLAN to a paid resource, from an Automatic to a Premium VLAN.

Description

Converts this VLAN to a paid resource. This can be done for any Automatic VLAN. This operation can only be executed on an Automatic VLAN, and will transition it to being a Premium VLAN. The VLAN will then provide the benefits of a Premium VLAN. A Premium VLAN will remain on the account until cancelled. This operation cannot be undone! Once a VLAN becomes Premium, it can only be removed through cancellation, which will result in it being reclaimed.

This operation is a convenience for utilizing the SoftLayer_Product_Order.placeOrder operation. It will place an order to upgrade the VLAN it is executed against. It will take a few moments for the order to be processed and the upgrade to complete. Note that the order is placed in such a way that any account state which prevents automatic order approval will prevent the order from being placed. Thus, if no error is received, the order was placed and approved, and the VLAN will be upgraded shortly.

Parameters

None

Required Headers

Optional Headers

  • None

Return Values

Error Handling

  • Throw the exception “Specified VLAN is not eligible for upgrade. Already upgraded.” if the VLAN is already considered purchased.
  • Throw the exception “Specified VLAN is not eligible for upgrade. Ineligible type.” if the VLAN is ineligible for purchase, such as a GATEWAY VLAN.
  • Throw the exception “Specified VLAN cannot be upgraded at this time. Insufficient capacity; try again later.” if the Pod lacks capacity for new Premium VLANs on the respective network.

Associated Methods

curl -g -u $SL_USER:$SL_APIKEY -X GET \
'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Vlan/{SoftLayer_Network_VlanID}/upgrade'