SoftLayer Ticket::createUpgradeTicket

From SoftLayer Development Network Wiki

Jump to: navigation, search

createUpgradeTicket is a member of the SoftLayer_Ticket service.

Contents

Overview

Create a ticket for the SoftLayer sales team to perform a hardware or service upgrade. Our sales team will work with you on upgrade feasibility and pricing and then send the upgrade ticket to the proper department to perform the actual upgrade. Service affecting upgrades, such as server hardware upgrades that require the server powered down must have a two hour maintenance specified for our datacenter engineers to perform your upgrade. Account level upgrades, such as adding PPTP VPN users, CDNLayer accounts, and monitoring services are processed much faster and do not require a maintenance window.

User Access

Users wishing to execute createUpgradeTicket service must have the Add / Edit Tickets and View Tickets permissions assigned to their account.

Return Type

createUpgradeTicket returns the SoftLayer_Ticket data type.

Headers

Required Headers

createUpgradeTicket requires the following headers:

Parameters

createUpgradeTicket takes the following parameters:

hardwareId

An optional hardware identifier if your upgrade request is related to a specific server on your account.

  • Type: integer



genericUpgrade

A brief description of what you wish to upgrade or add to your account. Descriptions like "CPU", "RAM", "RAID cards", "PPTP VPN users", and "StorageLayer".

  • Type: string



upgradeMaintenanceWindow

If your upgrade is service affecting then please provide an appropriate two hour maintenance window in which SoftLayer's staff can upgrade your server.

  • Type: string



details

A detailed description of the the server or account upgrade you wish to perform.

  • Type: string

Error Handling

createUpgradeTicket throws the following exceptions:

  • SoftLayer_Exception
Throw the exception "Unable to open an upgrade ticket on hardware id <hardwareId>" when the given hardware id does not exist or if the user accessing the API doesn't have access to that piece of hardware..
  • SoftLayer_Exception
Throw the exception "Please provide an upgrade maintenance window." when a maintenace window is not provided.
  • SoftLayer_Exception
Throw the exception "Please provide upgrade details." when upgrade details are not provided.
Personal tools