SoftLayer Ticket::createAdministrativeTicket
From SoftLayer Development Network Wiki
createAdministrativeTicket is a member of the SoftLayer_Ticket service.
Contents |
Overview
Create an administrative support ticket. Use an administrative ticket if you require SoftLayer's assistance managing your server or content. If you are experiencing an issue with SoftLayer's hardware, network, or services then please open a standard support ticket.
Support tickets may only be created in the open state. The SoftLayer API defaults new ticket properties userEditableFlag to true, accountId to the id of the account that your API user belongs to, and statusId to 1001 (or "open"). You may not assign your new to ticket to users that your API user does not have access to.
Once your ticket is created it is placed in a queue for SoftLayer employees to work. As they update the ticket new SoftLayer_Ticket_Update entries are added to the ticket object.
Administrative support tickets add a one-time $3USD charge to your account.
User Access
Users wishing to execute createAdministrativeTicket service must have the Add / Edit Tickets and View Tickets permissions assigned to their account.
Return Type
createAdministrativeTicket returns the SoftLayer_Ticket data type.
Headers
Required Headers
createAdministrativeTicket requires the following headers:
Parameters
createAdministrativeTicket takes the following parameters:
templateObject
A skeleton SoftLayer_Ticket object containing the data of the ticket you wish to submit.
- Type: SoftLayer_Ticket
contents
The contents of the first update of the ticket. This is typically the ticket's problem description.
- Type: string
attachedHardwareId
An optional internal identifier of a piece of hardware you wish to attach to this ticket. If you attach hardware to a ticket then you must also specify a root or admin password.
- Type: integer
rootPassword
The root password of the hardware you wish to attach to this ticket. Providing your administrative password can significantly improve your ticket response time.
- Type: string
controlPanelPassword
An optional administrative password to a hosting control panel running on your server, if your server has one installed.
- Type: string
accessPort
The TCP port on your server that SoftLayer must use to access your operating system. This is typically 22 for SSH and 3389 for Remote Desktop.
- Type: string
attachedFiles
An array of no more than two files to attach to your ticket.
Error Handling
createAdministrativeTicket throws the following exceptions:
- SoftLayer_Exception
- Throw the exception "Please provide a title when creating an administrative support ticket." If the $templateObject parameter does not have a title set.
- SoftLayer_Exception
- Throw the exception "Please provide ticket contents." if no contents are provided to the method.
- SoftLayer_Exception
- Throw the exception "Please provide a root/admin password." if a hardware id was passed to the method, but a root password wasn't.
