Items with tag method

    reference

    • acceptFromTicket
      Register the acceptance of the associated policy to product assignment, and link the created record to a Ticket.
    • acknowledge
      Acknowledge the associated [SoftLayer_Notification_Occurrence_Event](/reference/datatypes/SoftLayer_Notification_Occurrence_Event) for this impacted user.
    • acknowledgeNotification
      <<<< EOT
    • acknowledgeSupportPolicy
    • acknowledgeSupportPolicy
    • acknowledgeSupportPolicy
    • activate
    • activateOpenIdConnectUser
      Completes invitation process for an OpenIdConnect user created by Bluemix Unified User Console.
    • activateOpenIdConnectUser
      Completes invitation process for an OpenIdConnect user created by Bluemix Unified User Console.
    • activatePartner
      This service enables a partner account that has been created but is currently inactive. This restricted service is only available for certain accounts. Please contact support for questions.
    • activatePrivatePort
      Activate a server's private network interface to the maximum available speed. This operation is an alias for [SoftLayer_Hardware_Server::setPrivateNetworkInterfaceSpeed](/reference/services/SoftLayer_Hardware_Server/setPrivateNetworkInterfaceSpeed) with a $newSpeed of -1 and a $redundancy of 'redundant' or unspecified (which results in the best available redundancy state). Receipt of a response does not indicate completion of the configuration change. Any subsequent attempts to request the interface change speed or state, while changes are pending, will result in a busy error. A response of true indicates a change was required to activate the interface; thus changes are pending. A response of false indicates the interface was already active, and thus no changes are pending.
    • activatePrivatePort
      Activate a server's private network interface to the maximum available speed. This operation is an alias for [SoftLayer_Hardware_Server::setPrivateNetworkInterfaceSpeed](/reference/services/SoftLayer_Hardware_Server/setPrivateNetworkInterfaceSpeed) with a $newSpeed of -1 and a $redundancy of 'redundant' or unspecified (which results in the best available redundancy state). Receipt of a response does not indicate completion of the configuration change. Any subsequent attempts to request the interface change speed or state, while changes are pending, will result in a busy error. A response of true indicates a change was required to activate the interface; thus changes are pending. A response of false indicates the interface was already active, and thus no changes are pending.
    • activatePrivatePort
      Activate a server's private network interface to the maximum available speed. This operation is an alias for [SoftLayer_Hardware_Server::setPrivateNetworkInterfaceSpeed](/reference/services/SoftLayer_Hardware_Server/setPrivateNetworkInterfaceSpeed) with a $newSpeed of -1 and a $redundancy of 'redundant' or unspecified (which results in the best available redundancy state). Receipt of a response does not indicate completion of the configuration change. Any subsequent attempts to request the interface change speed or state, while changes are pending, will result in a busy error. A response of true indicates a change was required to activate the interface; thus changes are pending. A response of false indicates the interface was already active, and thus no changes are pending.
    • activatePrivatePort
      Activate the private network port
    • activatePublicPort
      Activate a server's public network interface to the maximum available speed. This operation is an alias for [SoftLayer_Hardware_Server::setPublicNetworkInterfaceSpeed](/reference/services/SoftLayer_Hardware_Server/setPublicNetworkInterfaceSpeed) with a $newSpeed of -1 and a $redundancy of 'redundant' or unspecified (which results in the best available redundancy state). Receipt of a response does not indicate completion of the configuration change. Any subsequent attempts to request the interface change speed or state, while changes are pending, will result in a busy error. A response of true indicates a change was required to activate the interface; thus changes are pending. A response of false indicates the interface was already active, and thus no changes are pending.
    • activatePublicPort
      Activate a server's public network interface to the maximum available speed. This operation is an alias for [SoftLayer_Hardware_Server::setPublicNetworkInterfaceSpeed](/reference/services/SoftLayer_Hardware_Server/setPublicNetworkInterfaceSpeed) with a $newSpeed of -1 and a $redundancy of 'redundant' or unspecified (which results in the best available redundancy state). Receipt of a response does not indicate completion of the configuration change. Any subsequent attempts to request the interface change speed or state, while changes are pending, will result in a busy error. A response of true indicates a change was required to activate the interface; thus changes are pending. A response of false indicates the interface was already active, and thus no changes are pending.
    • activatePublicPort
      Activate a server's public network interface to the maximum available speed. This operation is an alias for [SoftLayer_Hardware_Server::setPublicNetworkInterfaceSpeed](/reference/services/SoftLayer_Hardware_Server/setPublicNetworkInterfaceSpeed) with a $newSpeed of -1 and a $redundancy of 'redundant' or unspecified (which results in the best available redundancy state). Receipt of a response does not indicate completion of the configuration change. Any subsequent attempts to request the interface change speed or state, while changes are pending, will result in a busy error. A response of true indicates a change was required to activate the interface; thus changes are pending. A response of false indicates the interface was already active, and thus no changes are pending.
    • activatePublicPort
      Activate the public network port
    • addAchInformation
    • addAction
      Assigns a SoftLayer_User_Permission_Action object to the group.
    • addAllowedHost
      Use this method to attach a SoftLayer_Network_Storage_Allowed_Host object to this group. This will automatically enable access from this host to any SoftLayer_Network_Storage volumes currently attached to this group.
    • addAllowedHost
      Use this method to attach a SoftLayer_Network_Storage_Allowed_Host object to this group. This will automatically enable access from this host to any SoftLayer_Network_Storage volumes currently attached to this group.
    • addAllowedHost
      Use this method to attach a SoftLayer_Network_Storage_Allowed_Host object to this group. This will automatically enable access from this host to any SoftLayer_Network_Storage volumes currently attached to this group.
    • addApiAuthenticationKey
      Create a user's API authentication key, allowing that user access to query the SoftLayer API. addApiAuthenticationKey() returns the user's new API key. Each portal user is allowed only one API key.
    • addApiAuthenticationKey
      Create a user's API authentication key, allowing that user access to query the SoftLayer API. addApiAuthenticationKey() returns the user's new API key. Each portal user is allowed only one API key.
    • addApiAuthenticationKey
      Create a user's API authentication key, allowing that user access to query the SoftLayer API. addApiAuthenticationKey() returns the user's new API key. Each portal user is allowed only one API key.
    • addAssignedAgent
    • addAttachedAdditionalEmails
      Creates new additional emails for assigned user if new emails are provided. Attaches any newly created additional emails to ticket.
    • addAttachedDedicatedHost
      Attach the given Dedicated Host to a SoftLayer ticket. An attachment provides an easy way for SoftLayer's employees to quickly look up your records in the case of specific issues.
    • addAttachedFile
      Attach the given file to a SoftLayer ticket. A file attachment is a convenient way to submit non-textual error reports to SoftLayer employees in a ticket. File attachments to tickets must have a unique name.
    • addAttachedHardware
      Attach the given hardware to a SoftLayer ticket. A hardware attachment provides an easy way for SoftLayer's employees to quickly look up your hardware records in the case of hardware-specific issues.
    • addAttachedVirtualGuest
      Attach the given CloudLayer Computing Instance to a SoftLayer ticket. An attachment provides an easy way for SoftLayer's employees to quickly look up your records in the case of specific issues.
    • addBulkActions
      Assigns multiple SoftLayer_User_Permission_Action objects to the group.
    • addBulkDedicatedHostAccess
      Grants the user access to one or more dedicated host devices. The user will only be allowed to see and access devices in both the portal and the API to which they have been granted access. If the user's account has devices to which the user has not been granted access, then 'not found' exceptions are thrown if the user attempts to access any of these devices. Users can assign device access to their child users, but not to themselves. An account's master has access to all devices on their customer account and can set dedicated host access for any of the other users on their account.
    • addBulkDedicatedHostAccess
      Grants the user access to one or more dedicated host devices. The user will only be allowed to see and access devices in both the portal and the API to which they have been granted access. If the user's account has devices to which the user has not been granted access, then 'not found' exceptions are thrown if the user attempts to access any of these devices. Users can assign device access to their child users, but not to themselves. An account's master has access to all devices on their customer account and can set dedicated host access for any of the other users on their account.
    • addBulkDedicatedHostAccess
      Grants the user access to one or more dedicated host devices. The user will only be allowed to see and access devices in both the portal and the API to which they have been granted access. If the user's account has devices to which the user has not been granted access, then 'not found' exceptions are thrown if the user attempts to access any of these devices. Users can assign device access to their child users, but not to themselves. An account's master has access to all devices on their customer account and can set dedicated host access for any of the other users on their account.
    • addBulkHardwareAccess
      Add multiple hardware to a portal user's hardware access list. A user's hardware access list controls which of an account's hardware objects a user has access to in the SoftLayer customer portal and API. Hardware does not exist in the SoftLayer portal and returns 'not found' exceptions in the API if the user doesn't have access to it. addBulkHardwareAccess() does not attempt to add hardware access if the given user already has access to that hardware object. Users can assign hardware access to their child users, but not to themselves. An account's master has access to all hardware on their customer account and can set hardware access for any of the other users on their account.
    • addBulkHardwareAccess
      Add multiple hardware to a portal user's hardware access list. A user's hardware access list controls which of an account's hardware objects a user has access to in the SoftLayer customer portal and API. Hardware does not exist in the SoftLayer portal and returns 'not found' exceptions in the API if the user doesn't have access to it. addBulkHardwareAccess() does not attempt to add hardware access if the given user already has access to that hardware object. Users can assign hardware access to their child users, but not to themselves. An account's master has access to all hardware on their customer account and can set hardware access for any of the other users on their account.
    • addBulkHardwareAccess
      Add multiple hardware to a portal user's hardware access list. A user's hardware access list controls which of an account's hardware objects a user has access to in the SoftLayer customer portal and API. Hardware does not exist in the SoftLayer portal and returns 'not found' exceptions in the API if the user doesn't have access to it. addBulkHardwareAccess() does not attempt to add hardware access if the given user already has access to that hardware object. Users can assign hardware access to their child users, but not to themselves. An account's master has access to all hardware on their customer account and can set hardware access for any of the other users on their account.
    • addBulkPortalPermission
      Add multiple permissions to a portal user's permission set. [SoftLayer_User_Customer_CustomerPermission_Permission](/reference/datatypes/SoftLayer_User_Customer_CustomerPermission_Permission) control which features in the SoftLayer customer portal and API a user may use. addBulkPortalPermission() does not attempt to add permissions already assigned to the user. Users can assign permissions to their child users, but not to themselves. An account's master has all portal permissions and can set permissions for any of the other users on their account. Use the [SoftLayer_User_Customer_CustomerPermission_Permission::getAllObjects](/reference/datatypes/$1/#$2) method to retrieve a list of all permissions available in the SoftLayer customer portal and API. Permissions are removed based on the keyName property of the permission objects within the permissions parameter.
    • addBulkPortalPermission
      Add multiple permissions to a portal user's permission set. [SoftLayer_User_Customer_CustomerPermission_Permission](/reference/datatypes/SoftLayer_User_Customer_CustomerPermission_Permission) control which features in the SoftLayer customer portal and API a user may use. addBulkPortalPermission() does not attempt to add permissions already assigned to the user. Users can assign permissions to their child users, but not to themselves. An account's master has all portal permissions and can set permissions for any of the other users on their account. Use the [SoftLayer_User_Customer_CustomerPermission_Permission::getAllObjects](/reference/datatypes/$1/#$2) method to retrieve a list of all permissions available in the SoftLayer customer portal and API. Permissions are removed based on the keyName property of the permission objects within the permissions parameter.
    • addBulkPortalPermission
      Add multiple permissions to a portal user's permission set. [SoftLayer_User_Customer_CustomerPermission_Permission](/reference/datatypes/SoftLayer_User_Customer_CustomerPermission_Permission) control which features in the SoftLayer customer portal and API a user may use. addBulkPortalPermission() does not attempt to add permissions already assigned to the user. Users can assign permissions to their child users, but not to themselves. An account's master has all portal permissions and can set permissions for any of the other users on their account. Use the [SoftLayer_User_Customer_CustomerPermission_Permission::getAllObjects](/reference/datatypes/$1/#$2) method to retrieve a list of all permissions available in the SoftLayer customer portal and API. Permissions are removed based on the keyName property of the permission objects within the permissions parameter.
    • addBulkResourceObjects
      Links multiple SoftLayer_Hardware_Server, SoftLayer_Virtual_Guest, or SoftLayer_Virtual_DedicatedHost objects to the group. All objects must be of the same type.
    • addBulkRoles
    • addBulkRoles
    • addBulkRoles
    • addBulkVirtualGuestAccess
      Add multiple CloudLayer Computing Instances to a portal user's access list. A user's CloudLayer Computing Instance access list controls which of an account's CloudLayer Computing Instance objects a user has access to in the SoftLayer customer portal and API. CloudLayer Computing Instances do not exist in the SoftLayer portal and returns 'not found' exceptions in the API if the user doesn't have access to it. addBulkVirtualGuestAccess() does not attempt to add CloudLayer Computing Instance access if the given user already has access to that CloudLayer Computing Instance object. Users can assign CloudLayer Computing Instance access to their child users, but not to themselves. An account's master has access to all CloudLayer Computing Instances on their customer account and can set CloudLayer Computing Instance access for any of the other users on their account.
    • addBulkVirtualGuestAccess
      Add multiple CloudLayer Computing Instances to a portal user's access list. A user's CloudLayer Computing Instance access list controls which of an account's CloudLayer Computing Instance objects a user has access to in the SoftLayer customer portal and API. CloudLayer Computing Instances do not exist in the SoftLayer portal and returns 'not found' exceptions in the API if the user doesn't have access to it. addBulkVirtualGuestAccess() does not attempt to add CloudLayer Computing Instance access if the given user already has access to that CloudLayer Computing Instance object. Users can assign CloudLayer Computing Instance access to their child users, but not to themselves. An account's master has access to all CloudLayer Computing Instances on their customer account and can set CloudLayer Computing Instance access for any of the other users on their account.
    • addBulkVirtualGuestAccess
      Add multiple CloudLayer Computing Instances to a portal user's access list. A user's CloudLayer Computing Instance access list controls which of an account's CloudLayer Computing Instance objects a user has access to in the SoftLayer customer portal and API. CloudLayer Computing Instances do not exist in the SoftLayer portal and returns 'not found' exceptions in the API if the user doesn't have access to it. addBulkVirtualGuestAccess() does not attempt to add CloudLayer Computing Instance access if the given user already has access to that CloudLayer Computing Instance object. Users can assign CloudLayer Computing Instance access to their child users, but not to themselves. An account's master has access to all CloudLayer Computing Instances on their customer account and can set CloudLayer Computing Instance access for any of the other users on their account.
    • addByolAttribute
      This method allows you to mark this image template as customer managed software license (BYOL)
    • addCloudInitAttribute
      This method allows you to mark this image template as cloud init
    • addCustomerSubnetToNetworkTunnel
      Associates a remote subnet to the network tunnel. When a remote subnet is associated, a network tunnel will allow the customer (remote) network to communicate with the private and service subnets on the SoftLayer network which are on the other end of this network tunnel. NOTE: A network tunnel's configurations must be applied to the network device in order for the association described above to take effect.
    • addCustomerUpgradeWindow
      getMaintenceWindowForTicket() returns a boolean
    • addDedicatedHostAccess
      Grants the user access to a single dedicated host device. The user will only be allowed to see and access devices in both the portal and the API to which they have been granted access. If the user's account has devices to which the user has not been granted access, then 'not found' exceptions are thrown if the user attempts to access any of these devices. Users can assign device access to their child users, but not to themselves. An account's master has access to all devices on their customer account and can set dedicated host access for any of the other users on their account. Only the USER_MANAGE permission is required to execute this.
    • addDedicatedHostAccess
      Grants the user access to a single dedicated host device. The user will only be allowed to see and access devices in both the portal and the API to which they have been granted access. If the user's account has devices to which the user has not been granted access, then 'not found' exceptions are thrown if the user attempts to access any of these devices. Users can assign device access to their child users, but not to themselves. An account's master has access to all devices on their customer account and can set dedicated host access for any of the other users on their account. Only the USER_MANAGE permission is required to execute this.
    • addDedicatedHostAccess
      Grants the user access to a single dedicated host device. The user will only be allowed to see and access devices in both the portal and the API to which they have been granted access. If the user's account has devices to which the user has not been granted access, then 'not found' exceptions are thrown if the user attempts to access any of these devices. Users can assign device access to their child users, but not to themselves. An account's master has access to all devices on their customer account and can set dedicated host access for any of the other users on their account. Only the USER_MANAGE permission is required to execute this.
    • addExternalBinding
    • addExternalBinding
    • addExternalBinding
    • addFinalComments
      As part of the customer service process SoftLayer has provided a quick feedback mechanism for its customers to rate their overall experience with SoftLayer after a ticket is closed. addFinalComments() sets these comments for a ticket update made by a SoftLayer employee. Final comments may only be set on closed tickets, can only be set once, and may not exceed 4000 characters in length. Once the comments are set ''addFinalComments()'' returns a boolean true.
    • addHardwareAccess
      Add hardware to a portal user's hardware access list. A user's hardware access list controls which of an account's hardware objects a user has access to in the SoftLayer customer portal and API. Hardware does not exist in the SoftLayer portal and returns 'not found' exceptions in the API if the user doesn't have access to it. If a user already has access to the hardware you're attempting to add then addHardwareAccess() returns true. Users can assign hardware access to their child users, but not to themselves. An account's master has access to all hardware on their customer account and can set hardware access for any of the other users on their account. Only the USER_MANAGE permission is required to execute this.
    • addHardwareAccess
      Add hardware to a portal user's hardware access list. A user's hardware access list controls which of an account's hardware objects a user has access to in the SoftLayer customer portal and API. Hardware does not exist in the SoftLayer portal and returns 'not found' exceptions in the API if the user doesn't have access to it. If a user already has access to the hardware you're attempting to add then addHardwareAccess() returns true. Users can assign hardware access to their child users, but not to themselves. An account's master has access to all hardware on their customer account and can set hardware access for any of the other users on their account. Only the USER_MANAGE permission is required to execute this.
    • addHardwareAccess
      Add hardware to a portal user's hardware access list. A user's hardware access list controls which of an account's hardware objects a user has access to in the SoftLayer customer portal and API. Hardware does not exist in the SoftLayer portal and returns 'not found' exceptions in the API if the user doesn't have access to it. If a user already has access to the hardware you're attempting to add then addHardwareAccess() returns true. Users can assign hardware access to their child users, but not to themselves. An account's master has access to all hardware on their customer account and can set hardware access for any of the other users on their account. Only the USER_MANAGE permission is required to execute this.
    • addL7Policies
      This function creates multiple policies with rules for the given listener.
    • addL7PoolMembers
      Add server instances as members to a L7pool and return the LoadBalancer Object with listeners, pools and members populated
    • addL7Rules
      This function creates and adds multiple Rules to a given L7 policy with all the details provided for rules
    • addLoadBalancerMembers
      Add server instances as members to load balancer and return it with listeners, pools and members populated
    • addLocations
      This method will create transaction(s) to add available locations to an archive image template.
    • addNameserversToDomain
      The addNameserversToDomain method adds nameservers to a domain for a domain that already has nameservers assigned to it. This method does not create a nameserver; the nameserver must already exist.
    • addNetworkVlanTrunks
      Add VLANs as trunks to a network component. The VLANs given must be assigned to your account and belong to the same pod in which this network component and its hardware reside. The current native VLAN cannot be added as a trunk. 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 were added as trunks. Any requested VLANs which are already trunked will be ignored and will not be returned. Affected VLANs will not yet be operational as trunks on the network upon return of this call, but activation 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 an 'internal system error' some VLANs may still have been affected and scheduled for activation.
    • addNotificationSubscriber
      Create a notification subscription record for the user. If a subscription record exists for the notification, the record will be set to active, if currently inactive.
    • addNotificationSubscriber
      Create a notification subscription record for the user. If a subscription record exists for the notification, the record will be set to active, if currently inactive.
    • addNotificationSubscriber
      Create a notification subscription record for the user. If a subscription record exists for the notification, the record will be set to active, if currently inactive.
    • addNsRecord
      The global load balancer service has been deprecated and is no longer available. If your globally load balanced domain is hosted on the SoftLayer nameservers this method will add the required NS resource record to your DNS zone file and remove any A records that match the host portion of a global load balancer account hostname.
    • addPortalPermission
      Add a permission to a portal user's permission set. [SoftLayer_User_Customer_CustomerPermission_Permission](/reference/datatypes/SoftLayer_User_Customer_CustomerPermission_Permission) control which features in the SoftLayer customer portal and API a user may use. If the user already has the permission you're attempting to add then addPortalPermission() returns true. Users can assign permissions to their child users, but not to themselves. An account's master has all portal permissions and can set permissions for any of the other users on their account. Use the [SoftLayer_User_Customer_CustomerPermission_Permission::getAllObjects](/reference/datatypes/$1/#$2) method to retrieve a list of all permissions available in the SoftLayer customer portal and API. Permissions are added based on the keyName property of the permission parameter.
    • addPortalPermission
      Add a permission to a portal user's permission set. [SoftLayer_User_Customer_CustomerPermission_Permission](/reference/datatypes/SoftLayer_User_Customer_CustomerPermission_Permission) control which features in the SoftLayer customer portal and API a user may use. If the user already has the permission you're attempting to add then addPortalPermission() returns true. Users can assign permissions to their child users, but not to themselves. An account's master has all portal permissions and can set permissions for any of the other users on their account. Use the [SoftLayer_User_Customer_CustomerPermission_Permission::getAllObjects](/reference/datatypes/$1/#$2) method to retrieve a list of all permissions available in the SoftLayer customer portal and API. Permissions are added based on the keyName property of the permission parameter.
    • addPortalPermission
      Add a permission to a portal user's permission set. [SoftLayer_User_Customer_CustomerPermission_Permission](/reference/datatypes/SoftLayer_User_Customer_CustomerPermission_Permission) control which features in the SoftLayer customer portal and API a user may use. If the user already has the permission you're attempting to add then addPortalPermission() returns true. Users can assign permissions to their child users, but not to themselves. An account's master has all portal permissions and can set permissions for any of the other users on their account. Use the [SoftLayer_User_Customer_CustomerPermission_Permission::getAllObjects](/reference/datatypes/$1/#$2) method to retrieve a list of all permissions available in the SoftLayer customer portal and API. Permissions are added based on the keyName property of the permission parameter.
    • addPrivateSubnetToNetworkTunnel
      Associates a private subnet to the network tunnel. When a private subnet is associated, the network tunnel will allow the customer (remote) network to access the private subnet. NOTE: A network tunnel's configurations must be applied to the network device in order for the association described above to take effect.
    • addReferralPartnerPaymentOption
    • addResourceObject
      Links a SoftLayer_Hardware_Server, SoftLayer_Virtual_Guest, or SoftLayer_Virtual_DedicatedHost object to the group.
    • addResponseRating
      As part of the customer service process SoftLayer has provided a quick feedback mechanism for its customers to rate the responses that its employees give on tickets. addResponseRating() sets the rating for a single ticket update made by a SoftLayer employee. Ticket ratings have the integer values 1 through 5, with 1 being the worst and 5 being the best. Once the rating is set ''addResponseRating()'' returns a boolean true.
    • addRole
    • addRole
    • addRole
    • addRules
      Add new rules to a security group by sending in an array of template [SoftLayer_Network_SecurityGroup_Rule](/reference/datatypes/SoftLayer_Network_SecurityGroup_Rule) objects to be created.
    • addScheduledAlert
    • addScheduledAutoClose
    • addServiceSubnetToNetworkTunnel
      Associates a service subnet to the network tunnel. When a service subnet is associated, a network tunnel will allow the customer (remote) network to communicate with the private and service subnets on the SoftLayer network which are on the other end of this network tunnel. Service subnets provide access to SoftLayer services such as the customer management portal and the SoftLayer API. NOTE: A network tunnel's configurations must be applied to the network device in order for the association described above to take effect.
    • addSupportedBootMode
      This method allows you to mark this image's supported boot modes as 'HVM' or 'PV'.
    • addUnsubscribeEmailAddress
    • addUpdate
      Add an update to a ticket. A ticket update's entry has a maximum length of 4000 characters, so ''addUpdate()'' splits the ''entry'' property in the ''templateObject'' parameter into 3900 character blocks and creates one entry per 3900 character block. Once complete ''addUpdate()'' emails the ticket's owner and additional email addresses with an update message if the ticket's ''notifyUserOnUpdateFlag'' is set. If the ticket is a Legal or Abuse ticket, then the account's abuse emails are also notified when the updates are processed. Finally, ''addUpdate()'' returns an array of the newly created ticket updates.
    • addUser
      Assigns a SoftLayer_User_Customer object to the role.
    • addVirtualGuestAccess
      Add a CloudLayer Computing Instance to a portal user's access list. A user's CloudLayer Computing Instance access list controls which of an account's CloudLayer Computing Instance objects a user has access to in the SoftLayer customer portal and API. CloudLayer Computing Instances do not exist in the SoftLayer portal and returns 'not found' exceptions in the API if the user doesn't have access to it. If a user already has access to the CloudLayer Computing Instance you're attempting to add then addVirtualGuestAccess() returns true. Users can assign CloudLayer Computing Instance access to their child users, but not to themselves. An account's master has access to all CloudLayer Computing Instances on their customer account and can set CloudLayer Computing Instance access for any of the other users on their account. Only the USER_MANAGE permission is required to execute this.
    • addVirtualGuestAccess
      Add a CloudLayer Computing Instance to a portal user's access list. A user's CloudLayer Computing Instance access list controls which of an account's CloudLayer Computing Instance objects a user has access to in the SoftLayer customer portal and API. CloudLayer Computing Instances do not exist in the SoftLayer portal and returns 'not found' exceptions in the API if the user doesn't have access to it. If a user already has access to the CloudLayer Computing Instance you're attempting to add then addVirtualGuestAccess() returns true. Users can assign CloudLayer Computing Instance access to their child users, but not to themselves. An account's master has access to all CloudLayer Computing Instances on their customer account and can set CloudLayer Computing Instance access for any of the other users on their account. Only the USER_MANAGE permission is required to execute this.
    • addVirtualGuestAccess
      Add a CloudLayer Computing Instance to a portal user's access list. A user's CloudLayer Computing Instance access list controls which of an account's CloudLayer Computing Instance objects a user has access to in the SoftLayer customer portal and API. CloudLayer Computing Instances do not exist in the SoftLayer portal and returns 'not found' exceptions in the API if the user doesn't have access to it. If a user already has access to the CloudLayer Computing Instance you're attempting to add then addVirtualGuestAccess() returns true. Users can assign CloudLayer Computing Instance access to their child users, but not to themselves. An account's master has access to all CloudLayer Computing Instances on their customer account and can set CloudLayer Computing Instance access for any of the other users on their account. Only the USER_MANAGE permission is required to execute this.
    • advancedSearch
      This method allows for searching for SoftLayer resources by simple terms and operators. Fields that are used for searching will be available at sldn.softlayer.com. It returns a collection or array of [SoftLayer_Container_Search_Result](/reference/datatypes/SoftLayer_Container_Search_Result) objects that have search metadata for each result and the resulting resource found. The advancedSearch() method recognizes the special <code>_objectType:</code></b> quantifier in search strings. See the documentation for the [SoftLayer_Search::search](/reference/services/SoftLayer_Search/search) method on how to restrict searches using object types. The advancedSearch() method recognizes [SoftLayer_Container_Search_ObjectType_Property](/reference/datatypes/SoftLayer_Container_Search_ObjectType_Property), which can also be used to limit searches. Example: <code>_objectType:Type_1 propertyA:</code><i><code>value</code></i> A search string can specify multiple properties, separated with spaces. Example: <code>_objectType:Type_1 propertyA:</code><i><code>value</code></i> <code>propertyB:</code><i><code>value</code></i> A collection of available object types and their properties can be retrieved by calling the [SoftLayer_Search::getObjectTypes](/reference/services/SoftLayer_Search/getObjectTypes) method. #### Exact Match on Text Fields To enforce an exact match on text fields, encapsulate the term in double quotes. For example, given a set of device host names: <ul> <li>baremetal-a</li> <li>baremetal-b</li> <li>a-virtual-guest</li> <li>b-virtual-guest</li> <li>edge-router</li> </ul> An exact search (double-quote) for 'baremetal-a' will return only the exact match of <u>baremetal-a</u>. A fuzzy search (no double-quote) for baremetal-a will return <u>baremetal</u>-<u>a</u>, <u>baremetal</u>-b, <u>a</u>-virtu<u>a</u>l-guest, b-virtu<u>a</u>l-guest but will omit edge-router.
    • allowAccessFromHardware
      This method is used to modify the access control list for this Storage volume. The SoftLayer_Hardware objects which have been allowed access to this storage will be listed in the allowedHardware property of this storage volume.
    • allowAccessFromHardware
      This method is used to modify the access control list for this Storage volume. The SoftLayer_Hardware objects which have been allowed access to this storage will be listed in the allowedHardware property of this storage volume.
    • allowAccessFromHardware
      This method is used to modify the access control list for this Storage volume. The SoftLayer_Hardware objects which have been allowed access to this storage will be listed in the allowedHardware property of this storage volume.
    • allowAccessFromHardwareList
    • allowAccessFromHardwareList
    • allowAccessFromHardwareList
    • allowAccessFromHost
      This method is used to modify the access control list for this Storage volume. The [[SoftLayer_Hardware|SoftLayer_Virtual_Guest|SoftLayer_Network_Subnet|SoftLayer_Network_Subnet_IpAddress]] objects which have been allowed access to this storage will be listed in the [[allowedHardware|allowedVirtualGuests|allowedSubnets|allowedIpAddresses]] property of this storage volume.
    • allowAccessFromHost
      This method is used to modify the access control list for this Storage volume. The [[SoftLayer_Hardware|SoftLayer_Virtual_Guest|SoftLayer_Network_Subnet|SoftLayer_Network_Subnet_IpAddress]] objects which have been allowed access to this storage will be listed in the [[allowedHardware|allowedVirtualGuests|allowedSubnets|allowedIpAddresses]] property of this storage volume.
    • allowAccessFromHost
      This method is used to modify the access control list for this Storage volume. The [[SoftLayer_Hardware|SoftLayer_Virtual_Guest|SoftLayer_Network_Subnet|SoftLayer_Network_Subnet_IpAddress]] objects which have been allowed access to this storage will be listed in the [[allowedHardware|allowedVirtualGuests|allowedSubnets|allowedIpAddresses]] property of this storage volume.
    • allowAccessFromHostList
      This method is used to modify the access control list for this Storage volume. The [[SoftLayer_Hardware|SoftLayer_Virtual_Guest|SoftLayer_Network_Subnet|SoftLayer_Network_Subnet_IpAddress]] objects which have been allowed access to this storage volume will be listed in the [[allowedHardware|allowedVirtualGuests|allowedSubnets|allowedIpAddresses]] property of this storage volume.
    • allowAccessFromHostList
      This method is used to modify the access control list for this Storage volume. The [[SoftLayer_Hardware|SoftLayer_Virtual_Guest|SoftLayer_Network_Subnet|SoftLayer_Network_Subnet_IpAddress]] objects which have been allowed access to this storage volume will be listed in the [[allowedHardware|allowedVirtualGuests|allowedSubnets|allowedIpAddresses]] property of this storage volume.
    • allowAccessFromHostList
      This method is used to modify the access control list for this Storage volume. The [[SoftLayer_Hardware|SoftLayer_Virtual_Guest|SoftLayer_Network_Subnet|SoftLayer_Network_Subnet_IpAddress]] objects which have been allowed access to this storage volume will be listed in the [[allowedHardware|allowedVirtualGuests|allowedSubnets|allowedIpAddresses]] property of this storage volume.
    • allowAccessFromIpAddress
      This method is used to modify the access control list for this Storage volume. The SoftLayer_Network_Subnet_IpAddress objects which have been allowed access to this storage will be listed in the allowedIpAddresses property of this storage volume.
    • allowAccessFromIpAddress
      This method is used to modify the access control list for this Storage volume. The SoftLayer_Network_Subnet_IpAddress objects which have been allowed access to this storage will be listed in the allowedIpAddresses property of this storage volume.
    • allowAccessFromIpAddress
    • allowAccessFromIpAddressList
    • allowAccessFromIpAddressList
    • allowAccessFromIpAddressList
    • allowAccessFromSubnet
      This method is used to modify the access control list for this Storage volume. The SoftLayer_Network_Subnet objects which have been allowed access to this storage will be listed in the allowedHardware property of this storage volume.
    • allowAccessFromSubnet
      This method is used to modify the access control list for this Storage volume. The SoftLayer_Network_Subnet objects which have been allowed access to this storage will be listed in the allowedHardware property of this storage volume.
    • allowAccessFromSubnet
      This method is used to modify the access control list for this Storage volume. The SoftLayer_Network_Subnet objects which have been allowed access to this storage will be listed in the allowedHardware property of this storage volume.
    • allowAccessFromSubnetList
    • allowAccessFromSubnetList
    • allowAccessFromSubnetList
    • allowAccessFromVirtualGuest
      This method is used to modify the access control list for this Storage volume. The SoftLayer_Virtual_Guest objects which have been allowed access to this storage will be listed in the allowedVirtualGuests property of this storage volume.
    • allowAccessFromVirtualGuest
      This method is used to modify the access control list for this Storage volume. The SoftLayer_Virtual_Guest objects which have been allowed access to this storage will be listed in the allowedVirtualGuests property of this storage volume.
    • allowAccessFromVirtualGuest
      This method is used to modify the access control list for this Storage volume. The SoftLayer_Virtual_Guest objects which have been allowed access to this storage will be listed in the allowedVirtualGuests property of this storage volume.
    • allowAccessFromVirtualGuestList
      This method is used to modify the access control list for this Storage volume. The SoftLayer_Virtual_Guest objects which have been allowed access to this storage will be listed in the allowedVirtualGuests property of this storage volume.
    • allowAccessFromVirtualGuestList
      This method is used to modify the access control list for this Storage volume. The SoftLayer_Virtual_Guest objects which have been allowed access to this storage will be listed in the allowedVirtualGuests property of this storage volume.
    • allowAccessFromVirtualGuestList
      This method is used to modify the access control list for this Storage volume. The SoftLayer_Virtual_Guest objects which have been allowed access to this storage will be listed in the allowedVirtualGuests property of this storage volume.
    • allowAccessToNetworkStorage
      This method is used to allow access to a SoftLayer_Network_Storage volume that supports host- or network-level access control.
    • allowAccessToNetworkStorage
      This method is used to allow access to a SoftLayer_Network_Storage volume that supports host- or network-level access control.
    • allowAccessToNetworkStorage
      This method is used to allow access to a SoftLayer_Network_Storage volume that supports host- or network-level access control.
    • allowAccessToNetworkStorage
      This method is used to allow access to a SoftLayer_Network_Storage volume that supports host- or network-level access control.
    • allowAccessToNetworkStorage
      This method is used to allow access to a SoftLayer_Network_Storage volume that supports host- or network-level access control.
    • allowAccessToNetworkStorage
      This method is used to allow access to a SoftLayer_Network_Storage volume that supports host- or network-level access control.
    • allowAccessToNetworkStorage
      This method is used to allow access to a SoftLayer_Network_Storage volume that supports host- or network-level access control.
    • allowAccessToNetworkStorage
      This method is used to allow access to a SoftLayer_Network_Storage volume that supports host- or network-level access control.
    • allowAccessToNetworkStorageList
      This method is used to allow access to multiple SoftLayer_Network_Storage volumes that support host- or network-level access control.
    • allowAccessToNetworkStorageList
      This method is used to allow access to multiple SoftLayer_Network_Storage volumes that support host- or network-level access control.
    • allowAccessToNetworkStorageList
      This method is used to allow access to multiple SoftLayer_Network_Storage volumes that support host- or network-level access control.
    • allowAccessToNetworkStorageList
      This method is used to allow access to multiple SoftLayer_Network_Storage volumes that support host- or network-level access control.
    • allowAccessToNetworkStorageList
      This method is used to allow access to multiple SoftLayer_Network_Storage volumes that support host- or network-level access control.
    • allowAccessToNetworkStorageList
      This method is used to allow access to multiple SoftLayer_Network_Storage volumes that support host- or network-level access control.
    • allowAccessToNetworkStorageList
      This method is used to allow access to multiple SoftLayer_Network_Storage volumes that support host- or network-level access control.
    • allowAccessToNetworkStorageList
      This method is used to allow access to multiple SoftLayer_Network_Storage volumes that support host- or network-level access control.
    • allowAccessToReplicantFromHardware
      This method is used to modify the access control list for this Storage replicant volume. The SoftLayer_Hardware objects which have been allowed access to this storage will be listed in the allowedHardware property of this storage replicant volume.
    • allowAccessToReplicantFromHardware
      This method is used to modify the access control list for this Storage replicant volume. The SoftLayer_Hardware objects which have been allowed access to this storage will be listed in the allowedHardware property of this storage replicant volume.
    • allowAccessToReplicantFromHardware
      This method is used to modify the access control list for this Storage replicant volume. The SoftLayer_Hardware objects which have been allowed access to this storage will be listed in the allowedHardware property of this storage replicant volume.
    • allowAccessToReplicantFromHardwareList
      This method is used to modify the access control list for this Storage volume's replica. The SoftLayer_Hardware objects which have been allowed access to this storage volume's replica will be listed in the allowedReplicationHardware property of this storage volume.
    • allowAccessToReplicantFromHardwareList
      This method is used to modify the access control list for this Storage volume's replica. The SoftLayer_Hardware objects which have been allowed access to this storage volume's replica will be listed in the allowedReplicationHardware property of this storage volume.
    • allowAccessToReplicantFromHardwareList
      This method is used to modify the access control list for this Storage replica volume. The SoftLayer_Hardware objects which have been allowed access to this storage will be listed in the allowedHardware property of this storage replica volume.
    • allowAccessToReplicantFromIpAddress
    • allowAccessToReplicantFromIpAddress
    • allowAccessToReplicantFromIpAddress
    • allowAccessToReplicantFromIpAddressList
      This method is used to modify the access control list for this Storage volume's replica. The SoftLayer_Network_Subnet_IpAddress objects which have been allowed access to this storage volume's replica will be listed in the allowedReplicationIpAddresses property of this storage volume.
    • allowAccessToReplicantFromIpAddressList
      This method is used to modify the access control list for this Storage volume's replica. The SoftLayer_Network_Subnet_IpAddress objects which have been allowed access to this storage volume's replica will be listed in the allowedReplicationIpAddresses property of this storage volume.
    • allowAccessToReplicantFromIpAddressList
      This method is used to modify the access control list for this Storage volume. The SoftLayer_Network_Subnet_IpAddress objects which have been allowed access to this storage will be listed in the allowedVirtualGuests property of this storage volume.
    • allowAccessToReplicantFromSubnet
      This method is used to modify the access control list for this Storage replicant volume. The SoftLayer_Network_Subnet objects which have been allowed access to this storage will be listed in the allowedHardware property of this storage replicant volume.
    • allowAccessToReplicantFromSubnet
      This method is used to modify the access control list for this Storage replicant volume. The SoftLayer_Network_Subnet objects which have been allowed access to this storage will be listed in the allowedHardware property of this storage replicant volume.
    • allowAccessToReplicantFromSubnet
      This method is used to modify the access control list for this Storage replicant volume. The SoftLayer_Network_Subnet objects which have been allowed access to this storage will be listed in the allowedHardware property of this storage replicant volume.
    • allowAccessToReplicantFromSubnetList
      This method is used to modify the access control list for this Storage volume's replica. The SoftLayer_Network_Subnet objects which have been allowed access to this storage volume's replica will be listed in the allowedReplicationSubnets property of this storage volume.
    • allowAccessToReplicantFromSubnetList
      This method is used to modify the access control list for this Storage volume's replica. The SoftLayer_Network_Subnet objects which have been allowed access to this storage volume's replica will be listed in the allowedReplicationSubnets property of this storage volume.
    • allowAccessToReplicantFromSubnetList
      This method is used to modify the access control list for this Storage volume's replica. The SoftLayer_Network_Subnet objects which have been allowed access to this storage volume's replica will be listed in the allowedReplicationSubnets property of this storage volume.
    • allowAccessToReplicantFromVirtualGuest
      This method is used to modify the access control list for this Storage replicant volume. The SoftLayer_Virtual_Guest objects which have been allowed access to this storage will be listed in the allowedVirtualGuests property of this storage replicant volume.
    • allowAccessToReplicantFromVirtualGuest
      This method is used to modify the access control list for this Storage replicant volume. The SoftLayer_Virtual_Guest objects which have been allowed access to this storage will be listed in the allowedVirtualGuests property of this storage replicant volume.
    • allowAccessToReplicantFromVirtualGuest
      This method is used to modify the access control list for this Storage replicant volume. The SoftLayer_Virtual_Guest objects which have been allowed access to this storage will be listed in the allowedVirtualGuests property of this storage replicant volume.
    • allowAccessToReplicantFromVirtualGuestList
      This method is used to modify the access control list for this Storage volume's replica. The SoftLayer_Virtual_Guest objects which have been allowed access to this storage volume's replica will be listed in the allowedReplicationVirtualGuests property of this storage volume.
    • allowAccessToReplicantFromVirtualGuestList
      This method is used to modify the access control list for this Storage volume's replica. The SoftLayer_Virtual_Guest objects which have been allowed access to this storage volume's replica will be listed in the allowedReplicationVirtualGuests property of this storage volume.
    • allowAccessToReplicantFromVirtualGuestList
      This method is used to modify the access control list for this Storage volume. The SoftLayer_Virtual_Guest objects which have been allowed access to this storage will be listed in the allowedVirtualGuests property of this storage volume.
    • allowDeleteConnection
    • applyConfigurationsToDevice
      An asynchronous task will be created to apply the IPSec network tunnel's configuration to network devices. During this time, an IPSec network tunnel cannot be modified in anyway. Only one network tunnel configuration task can be created at a time. If a task has already been created and has not completed, a new task cannot be created.
    • approveBypassRequest
      Approve a request from technical support to bypass the firewall. Once approved, support will be able to route and unroute the VLAN on the firewall.
    • approveChanges
      When a change is made to an upgrade by Sales, this method will approve the changes that were made. A customer must acknowledge the change and approve it so that the upgrade request can proceed.
    • approveModifiedOrder
      When an order has been modified, the customer will need to approve the changes. This method will allow the customer to approve the changes.
    • approveReview
      Allows a verified reviewer to approve a request
    • areVdrUpdatesBlockedForBilling
      This method indicates whether or not Bandwidth Pooling updates are blocked for the account so the billing cycle can run. Generally, accounts are restricted from moving servers in or out of Bandwidth Pools from 12:00 CST on the day prior to billing, until the billing batch completes, sometime after midnight the day of actual billing for the account.
    • assignCredential
      This method will assign an existing credential to the current volume. The credential must have been created using the 'addNewCredential' method. The volume type must support an additional credential.
    • assignCredential
      This method will assign an existing credential to the current volume. The credential must have been created using the 'addNewCredential' method. The volume type must support an additional credential.
    • assignCredential
      This method will assign an existing credential to the current volume. The credential must have been created using the 'addNewCredential' method. The volume type must support an additional credential.
    • assignNewCredential
      This method will set up a new credential for the remote storage volume. The storage volume must support an additional credential. Once created, the credential will be automatically assigned to the current volume. If there are no volumes assigned to the credential it will be automatically deleted.
    • assignNewCredential
      This method will set up a new credential for the remote storage volume. The storage volume must support an additional credential. Once created, the credential will be automatically assigned to the current volume. If there are no volumes assigned to the credential it will be automatically deleted.
    • assignNewCredential
      This method will set up a new credential for the remote storage volume. The storage volume must support an additional credential. Once created, the credential will be automatically assigned to the current volume. If there are no volumes assigned to the credential it will be automatically deleted.
    • assignNewParentId
      This method can be used in place of [SoftLayer_User_Customer::editObject](/reference/datatypes/$1/#$2) to change the parent user of this user. The new parent must be a user on the same account, and must not be a child of this user. A user is not allowed to change their own parent. If the cascadeFlag is set to false, then an exception will be thrown if the new parent does not have all of the permissions that this user possesses. If the cascadeFlag is set to true, then permissions will be removed from this user and the descendants of this user as necessary so that no children of the parent will have permissions that the parent does not possess. However, setting the cascadeFlag to true will not remove the access all device permissions from this user. The customer portal will need to be used to remove these permissions.
    • assignNewParentId
      This method can be used in place of [SoftLayer_User_Customer::editObject](/reference/datatypes/$1/#$2) to change the parent user of this user. The new parent must be a user on the same account, and must not be a child of this user. A user is not allowed to change their own parent. If the cascadeFlag is set to false, then an exception will be thrown if the new parent does not have all of the permissions that this user possesses. If the cascadeFlag is set to true, then permissions will be removed from this user and the descendants of this user as necessary so that no children of the parent will have permissions that the parent does not possess. However, setting the cascadeFlag to true will not remove the access all device permissions from this user. The customer portal will need to be used to remove these permissions.
    • assignNewParentId
      This method can be used in place of [SoftLayer_User_Customer::editObject](/reference/datatypes/$1/#$2) to change the parent user of this user. The new parent must be a user on the same account, and must not be a child of this user. A user is not allowed to change their own parent. If the cascadeFlag is set to false, then an exception will be thrown if the new parent does not have all of the permissions that this user possesses. If the cascadeFlag is set to true, then permissions will be removed from this user and the descendants of this user as necessary so that no children of the parent will have permissions that the parent does not possess. However, setting the cascadeFlag to true will not remove the access all device permissions from this user. The customer portal will need to be used to remove these permissions.
    • assignSubnetsToAcl
    • assignSubnetsToAcl
    • assignSubnetsToAcl
    • assignSubnetsToAcl
    • assignSubnetsToAcl
    • attachDiskImage
      Creates a transaction to attach a guest's disk image. If the disk image is already attached it will be ignored. WARNING: SoftLayer_Virtual_Guest::checkHostDiskAvailability should be called before this method. If the SoftLayer_Virtual_Guest::checkHostDiskAvailability method is not called before this method, the guest migration will happen automatically.
    • attachNetworkComponents
      Attach virtual guest network components to a security group by creating [SoftLayer_Virtual_Network_SecurityGroup_NetworkComponentBinding](/reference/datatypes/SoftLayer_Virtual_Network_SecurityGroup_NetworkComponentBinding) objects.
    • attachToVolume
      Use this method to attach a SoftLayer_Network_Storage volume to this group. This will automatically enable access to this volume for any SoftLayer_Network_Storage_Allowed_Host objects currently attached to this group.
    • attachToVolume
      Use this method to attach a SoftLayer_Network_Storage volume to this group. This will automatically enable access to this volume for any SoftLayer_Network_Storage_Allowed_Host objects currently attached to this group.
    • attachToVolume
      Use this method to attach a SoftLayer_Network_Storage volume to this group. This will automatically enable access to this volume for any SoftLayer_Network_Storage_Allowed_Host objects currently attached to this group.
    • autoComplete
      This function is responsible for setting the Tags values. The internal flag is set to 0 if the user is a customer, and 1 otherwise. AccountId is set to the account bound to the user, and the tags name is set to the clean version of the tag inputted by the user.
    • bootToRescueLayer
      The Rescue Kernel is designed to provide you with the ability to bring a server online in order to troubleshoot system problems that would normally only be resolved by an OS Reload. The correct Rescue Kernel will be selected based upon the currently installed operating system. When the rescue kernel process is initiated, the server will shutdown and reboot on to the public network with the same IP's assigned to the server to allow for remote connections. It will bring your server offline for approximately 10 minutes while the rescue is in progress. The root/administrator password will be the same as what is listed in the portal for the server.
    • bootToRescueLayer
      The Rescue Kernel is designed to provide you with the ability to bring a server online in order to troubleshoot system problems that would normally only be resolved by an OS Reload. The correct Rescue Kernel will be selected based upon the currently installed operating system. When the rescue kernel process is initiated, the server will shutdown and reboot on to the public network with the same IP's assigned to the server to allow for remote connections. It will bring your server offline for approximately 10 minutes while the rescue is in progress. The root/administrator password will be the same as what is listed in the portal for the server.
    • bootToRescueLayer
      The Rescue Kernel is designed to provide you with the ability to bring a server online in order to troubleshoot system problems that would normally only be resolved by an OS Reload. The correct Rescue Kernel will be selected based upon the currently installed operating system. When the rescue kernel process is initiated, the server will shutdown and reboot on to the public network with the same IP's assigned to the server to allow for remote connections. It will bring your server offline for approximately 10 minutes while the rescue is in progress. The root/administrator password will be the same as what is listed in the portal for the server.
    • bypass
      Start the asynchronous process to bypass/unroute the VLAN from this gateway.
    • bypassAllVlans
      Start the asynchronous process to bypass all VLANs. Any VLANs that are already bypassed will be ignored. The status field can be checked for progress.
    • bypassVlans
      Start the asynchronous process to bypass the provided VLANs. The VLANs must already be attached. Any VLANs that are already bypassed will be ignored. The status field can be checked for progress.
    • cancelIsolationForDestructiveAction
      Reopens the public and/or private ports to reverse the changes made when the server was isolated for a destructive action.
    • cancelItem
      Cancel the resource or service for a billing Item. By default the billing item will be canceled on the next bill date and reclaim of the resource will begin shortly after the cancellation. Setting the 'cancelImmediately' property to true will start the cancellation immediately if the item is eligible to be canceled immediately. The reason parameter could be from the list below: * 'No longer needed' * 'Business closing down' * 'Server / Upgrade Costs' * 'Migrating to larger server' * 'Migrating to smaller server' * 'Migrating to a different SoftLayer datacenter' * 'Network performance / latency' * 'Support response / timing' * 'Sales process / upgrades' * 'Moving to competitor'
    • cancelItem
      Cancel the resource or service for a billing Item. By default the billing item will be canceled on the next bill date and reclaim of the resource will begin shortly after the cancellation. Setting the 'cancelImmediately' property to true will start the cancellation immediately if the item is eligible to be canceled immediately. The reason parameter could be from the list below: * 'No longer needed' * 'Business closing down' * 'Server / Upgrade Costs' * 'Migrating to larger server' * 'Migrating to smaller server' * 'Migrating to a different SoftLayer datacenter' * 'Network performance / latency' * 'Support response / timing' * 'Sales process / upgrades' * 'Moving to competitor'
    • cancelLoadBalancer
      Cancel a load balancer with the given uuid. The billing system will execute the deletion of load balancer and all objects associated with it such as load balancer appliances, listeners, pools and members in the background.
    • cancelPayPalTransaction
      Cancel the PayPal Payment Request process. During the process of submitting a PayPal payment request, the customer is redirected to PayPal to confirm the request. If the customer elects to cancel the payment from PayPal, they are returned to SoftLayer where the manual payment record is updated to a status of canceled.
    • cancelRequest
      Will cancel a lockdown request scheduled in the future. Once canceled, the lockdown request cannot be reconciled and new requests must be made for subsequent actions on the account.
    • cancelService
      Cancel the resource or service (excluding bare metal servers) for a billing Item. The billing item will be cancelled immediately and reclaim of the resource will begin shortly.
    • cancelService
      Cancel the resource or service (excluding bare metal servers) for a billing Item. The billing item will be cancelled immediately and reclaim of the resource will begin shortly.
    • cancelServiceOnAnniversaryDate
      Cancel the resource or service for a billing Item
    • cancelServiceOnAnniversaryDate
      Cancel the resource or service for a billing Item
    • cancelSslOrder
      Cancels a pending SSL certificate order at the Certificate Authority
    • cancelWorkspaceResources
      This method will cancel the resources associated with the provided VLAN and have a 'cvad' tag reference.
    • captureImage
      Captures an Image of the hard disk on the physical machine, based on the capture template parameter. Returns the image template group containing the disk image.
    • captureImage
      Captures an Image of the hard disk on the physical machine, based on the capture template parameter. Returns the image template group containing the disk image.
    • captureImage
      Captures an Image of the hard disk on the physical machine, based on the capture template parameter. Returns the image template group containing the disk image.
    • captureImage
      Captures an Image of the hard disk on the physical machine, based on the capture template parameter. Returns the image template group containing the disk image.
    • captureImage
      Captures an Image of the hard disk on the physical machine, based on the capture template parameter. Returns the image template group containing the disk image.
    • captureImage
      Captures a Flex Image of the hard disk on the virtual machine, based on the capture template parameter. Returns the image template group containing the disk image.
    • changeGatewayVersion
      Used to create a transaction to upgrade or rollback the vSRX version for Juniper gateway.
    • changePassword
      The method will change the password for the given Storage/Virtual Server Storage account.
    • changePassword
      The method will change the password for the given Storage/Virtual Server Storage account.
    • changePassword
      The method will change the password for the given Storage/Virtual Server Storage account.
    • changePreference
      Select a type of preference you would like to modify using [SoftLayer_User_Customer::getPreferenceTypes](/reference/datatypes/$1/#$2) and invoke this method using that preference type key name.
    • changePreference
      Select a type of preference you would like to modify using [SoftLayer_User_Customer::getPreferenceTypes](/reference/datatypes/$1/#$2) and invoke this method using that preference type key name.
    • changePreference
      Select a type of preference you would like to modify using [SoftLayer_User_Customer::getPreferenceTypes](/reference/datatypes/$1/#$2) and invoke this method using that preference type key name.
    • checkAccountWhiteList
    • checkConnection
      DEPRECATED. Checks if a monitoring robot can communicate with SoftLayer monitoring management system via the private network. TCP port 48000 - 48002 must be open on your server or your virtual server in order for this test to succeed.
    • checkHostDiskAvailability
      Checks the associated host for available disk space to determine if guest migration is necessary. This method is only used with local disks. If this method returns false, calling attachDiskImage($imageId) will automatically migrate the destination guest to a new host before attaching the portable volume.
    • checkItemAvailability
    • checkItemAvailabilityForImageTemplate
    • checkItemConflicts
      Check order items for conflicts
    • claim
      This method is used to transfer an anonymous quote to the active user and associated account. An anonymous quote is one that was created by a user without being authenticated. If a quote was created anonymously and then the customer attempts to access that anonymous quote via the API (which requires authentication), the customer will be unable to retrieve the quote due to the security restrictions in place. By providing the ability for a customer to claim a quote, s/he will be able to pull the anonymous quote onto his/her account and successfully view the quote. To claim a quote, both the quote id and the quote key (the 32-character random string) must be provided.
    • claim
      This method is used to transfer an anonymous quote to the active user and associated account. An anonymous quote is one that was created by a user without being authenticated. If a quote was created anonymously and then the customer attempts to access that anonymous quote via the API (which requires authentication), the customer will be unable to retrieve the quote due to the security restrictions in place. By providing the ability for a customer to claim a quote, s/he will be able to pull the anonymous quote onto his/her account and successfully view the quote. To claim a quote, both the quote id and the quote key (the 32-character random string) must be provided.
    • clearNetworkVlanTrunks
      Remove all VLANs currently attached as trunks to this network component. 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. 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.
    • clearRegistration
      This method will initiate the removal of a subnet registration.
    • clearRoute
      This interface allows you to remove the route of your secondary subnets. The result will be a subnet that is no longer routed on the network. Remove the route of subnets you are not actively using, as it will make it easier to identify available subnets later. '''Important:''' When removing the route of ''Portable'' subnets, know that any subnet depending on an IP address provided by the Portable subnet will also have their routes removed! To review what subnets are routed to IP addresses provided by a ''Portable'' subnet, you can utilize the following object mask: 'mask[ipAddresses[endpointSubnets]]'. Any subnet present in conjunction with ''endpointSubnets'' is a subnet which depends on the respective IP address. The behavior of this interface is such that either true or false is returned. A result of false can be interpreted as the clear route request having already been completed. In contrast, a result of true means the subnet is currently routed and will be transitioned. This route change is asynchronous to the request. A response of true does not mean the subnet's route has changed, but simply that it will change. In order to monitor for the completion of the change, you may either attempt a clear route again until the result is false, or monitor one or more SoftLayer_Network_Subnet properties: subnetType, networkVlanId, and or endPointIpAddress to determine if routing of the subnet has been removed.
    • clearSnoozeTimer
    • collectBandwidth
      {{CloudLayerOnlyMethod}} collectBandwidth() Retrieve the bandwidth usage for the current billing cycle.
    • collectBandwidth
      {{CloudLayerOnlyMethod}} collectBandwidth() Retrieve the bandwidth usage for the current billing cycle.
    • collectBandwidth
      {{CloudLayerOnlyMethod}} collectBandwidth() Retrieve the bandwidth usage for the current billing cycle.
    • collectBytesUsed
      {{CloudLayerOnlyMethod}} collectBytesUsed() retrieves the number of bytes capacity currently in use on a Storage account.
    • collectBytesUsed
      {{CloudLayerOnlyMethod}} collectBytesUsed() retrieves the number of bytes capacity currently in use on a Storage account.
    • collectBytesUsed
      {{CloudLayerOnlyMethod}} collectBytesUsed() retrieves the number of bytes capacity currently in use on a Storage account.
    • completeInvitationAfterLogin
      Completes invitation processing after logging on an existing OpenIdConnect user identity and return an access token
    • completeInvitationAfterLogin
      Completes invitation processing after logging on an existing OpenIdConnect user identity and return an access token
    • completePayPalTransaction
      Complete the PayPal Payment Request process and receive confirmation message. During the process of submitting a PayPal payment request, the customer is redirected to PayPal to confirm the request. Once confirmed, PayPal returns the customer to SoftLayer where an attempt is made to finalize the transaction. A status message regarding the attempt is returned to the calling function.
    • configureMetadataDisk
      Creates a transaction to configure the guest's metadata disk. If the guest has user data associated with it, the transaction will create a small virtual drive and write the metadata to a file on the drive; if the drive already exists, the metadata will be rewritten. If the guest has no user data associated with it, the transaction will remove the virtual drive if it exists. WARNING: The transaction created by this service will shut down the guest while the metadata disk is configured. The guest will be turned back on once this process is complete.
    • connectPrivateEndpointService
      Initiate the automated process to establish connectivity granting the account private back-end network access to the services available through IBM Cloud Service Endpoint. Once initiated, the configuration process occurs asynchronously in the background. <h2>Responses</h2> <code>True</code> The request to connect was successfully initiated. <code>False</code> The account and Service Endpoint networks are already connected. <h2>Exceptions</h2> <code>SoftLayer_Exception_NotReady</code> Thrown when the current network configuration will not support connection alteration.
    • convertCloneDependentToIndependent
      Splits a clone from its parent allowing it to be an independent volume.
    • convertCloneDependentToIndependent
      Splits a clone from its parent allowing it to be an independent volume.
    • convertCloneDependentToIndependent
      Splits a clone from its parent allowing it to be an independent volume.
    • convertToPrimary
      A secondary DNS record may be converted to a primary DNS record. By converting a secondary DNS record, the SoftLayer name servers will be the authoritative nameserver for this domain and will be directly editable in the SoftLayer API and Portal. Primary DNS record conversion performs the following steps: * The SOA record is updated with SoftLayer's primary name server. * All NS records are removed and replaced with SoftLayer's NS records. * The secondary DNS record is removed. After the DNS records are converted, the following restrictions will apply to the new domain record: * You will need to manage the zone record using the [SoftLayer_Dns_Domain](/reference/datatypes/SoftLayer_Dns_Domain) service. * You may not edit the SOA or NS records. * You may only edit the following resource records: A, AAAA, CNAME, MX, TX, SRV. This change can not be undone, and the record can not be converted back into a secondary DNS record once the conversion is complete.
    • copyTemplate
      Copy a configuration template and returns a newly created template copy
    • copyToExternalSource
      Create a transaction to export/copy a template to an external source.
    • copyToIcos
      Create a transaction to export/copy a template to an ICOS.
    • countHourlyInstances
      Retrieve the number of hourly services on an account that are active, plus any pending orders with hourly services attached.
    • createAaaaRecord
      Create an AAAA record on a SoftLayer domain. This is a shortcut method, meant to take the work out of creating a SoftLayer_Dns_Domain_ResourceRecord if you already have a domain record available. createARecord returns the newly created SoftLayer_Dns_Domain_ResourceRecord_AaaaType.
    • createAddressTranslation
      Create an address translation for a network tunnel. To create an address translation, ip addresses from an assigned /30 static route subnet are used. Address translations deliver packets to a destination ip address that is on a customer (remote) subnet. NOTE: A network tunnel's configurations must be applied to the network device in order for an address translation to be created.
    • createAddressTranslations
      This has the same functionality as the SoftLayer_Network_Tunnel_Module_Context::createAddressTranslation. However, it allows multiple translations to be passed in for creation. NOTE: A network tunnel's configurations must be applied to the network device in order for the address translations to be created.
    • createAdministrativeTicket
      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](/reference/datatypes/SoftLayer_Ticket_Update) entries are added to the ticket object. Administrative support tickets add a one-time $3USD charge to your account.
    • createArchiveTemplate
      Create a transaction to archive a computing instance's block devices
    • createArchiveTransaction
      Create a transaction to archive a computing instance's block devices
    • createARecord
      Create an A record on a SoftLayer domain. This is a shortcut method, meant to take the work out of creating a SoftLayer_Dns_Domain_ResourceRecord if you already have a domain record available. createARecord returns the newly created SoftLayer_Dns_Domain_ResourceRecord_AType.
    • createCancelServerTicket
      A cancel server request creates a ticket to cancel the resource on next bill date. The hardware ID parameter is required to determine which server is to be cancelled. NOTE: Hourly bare metal servers will be cancelled on next bill date. The reason parameter could be from the list below: * 'No longer needed' * 'Business closing down' * 'Server / Upgrade Costs' * 'Migrating to larger server' * 'Migrating to smaller server' * 'Migrating to a different SoftLayer datacenter' * 'Network performance / latency' * 'Support response / timing' * 'Sales process / upgrades' * 'Moving to competitor' The content parameter describes further the reason for cancelling the server.
    • createCancelServiceTicket
      A cancel service request creates a sales ticket. The hardware ID parameter is required to determine which server is to be cancelled. The reason parameter could be from the list below: * 'No longer needed' * 'Business closing down' * 'Server / Upgrade Costs' * 'Migrating to larger server' * 'Migrating to smaller server' * 'Migrating to a different SoftLayer datacenter' * 'Network performance / latency' * 'Support response / timing' * 'Sales process / upgrades' * 'Moving to competitor' The content parameter describes further the reason for cancelling service.
    • createCart
      When creating a new cart, the order data is sent through SoftLayer_Product_Order::verifyOrder to make sure that the cart contains valid data. If an issue is found with the order, an exception will be thrown and you will receive the same response as if SoftLayer_Product_Order::verifyOrder were called directly. Once the order verification is complete, the cart will be created. The response is the new cart id.
    • createCnameRecord
      Create a CNAME record on a SoftLayer domain. This is a shortcut method, meant to take the work out of creating a SoftLayer_Dns_Domain_ResourceRecord if you already have a domain record available. createCnameRecord returns the newly created SoftLayer_Dns_Domain_ResourceRecord_CnameType.
    • createComplianceReportRequestorContact
      <<EOT
    • createConnection
    • createCustomerAccount
      Create a new customer account record. By default, the newly created account will be associated to a platform (PaaS) account. To skip the automatic creation and linking to a new platform account, set the <em>bluemixLinkedFlag</em> to <strong>false</strong> on the account template.
    • createDomainMapping
      SOAP API will create a new CDN domain mapping for a particular customer.
    • createFirmwareReflashTransaction
      You can launch firmware reflash by selecting from your server list. It will bring your server offline for approximately 60 minutes while the flashes are in progress. In the event of a hardware failure during this our datacenter engineers will be notified of the problem automatically. They will then replace any failed components to bring your server back online, and will be contacting you to ensure that impact on your server is minimal.
    • createFirmwareReflashTransaction
      You can launch firmware reflash by selecting from your server list. It will bring your server offline for approximately 60 minutes while the flashes are in progress. In the event of a hardware failure during this our datacenter engineers will be notified of the problem automatically. They will then replace any failed components to bring your server back online, and will be contacting you to ensure that impact on your server is minimal.
    • createFirmwareReflashTransaction
      You can launch firmware reflash by selecting from your server list. It will bring your server offline for approximately 60 minutes while the flashes are in progress. In the event of a hardware failure during this our datacenter engineers will be notified of the problem automatically. They will then replace any failed components to bring your server back online, and will be contacting you to ensure that impact on your server is minimal.
    • createFirmwareUpdateTransaction
      You can launch firmware updates by selecting from your server list. It will bring your server offline for approximately 20 minutes while the updates are in progress. In the event of a hardware failure during this test our datacenter engineers will be notified of the problem automatically. They will then replace any failed components to bring your server back online, and will be contacting you to ensure that impact on your server is minimal.
    • createFirmwareUpdateTransaction
      You can launch firmware updates by selecting from your server list. It will bring your server offline for approximately 20 minutes while the updates are in progress. In the event of a hardware failure during this test our datacenter engineers will be notified of the problem automatically. They will then replace any failed components to bring your server back online, and will be contacting you to ensure that impact on your server is minimal.
    • createFirmwareUpdateTransaction
      You can launch firmware updates by selecting from your server list. It will bring your server offline for approximately 20 minutes while the updates are in progress. In the event of a hardware failure during this test our datacenter engineers will be notified of the problem automatically. They will then replace any failed components to bring your server back online, and will be contacting you to ensure that impact on your server is minimal.
    • createFolder
      Create a new folder in the root directory.
    • createFolder
      Create a new folder in the root directory.
    • createFolder
      Create a new folder in the root directory.
    • createFromExternalSource
      Create a transaction to import a disk image from an external source and create a standard image template.
    • createFromIcos
      Create a process to import a disk image from ICOS and create a standard
    • createGeoblocking
    • createHotlinkProtection
    • createHyperThreadingUpdateTransaction
      You can launch hyper-threading update by selecting from your server list. It will bring your server offline for approximately 60 minutes while the update is in progress. In the event of a hardware failure during this our datacenter engineers will be notified of the problem automatically. They will then replace any failed components to bring your server back online, and will be contacting you to ensure that impact on your server is minimal.
    • createHyperThreadingUpdateTransaction
      You can launch hyper-threading update by selecting from your server list. It will bring your server offline for approximately 60 minutes while the update is in progress. In the event of a hardware failure during this our datacenter engineers will be notified of the problem automatically. They will then replace any failed components to bring your server back online, and will be contacting you to ensure that impact on your server is minimal.
    • createHyperThreadingUpdateTransaction
      You can launch hyper-threading update by selecting from your server list. It will bring your server offline for approximately 60 minutes while the update is in progress. In the event of a hardware failure during this our datacenter engineers will be notified of the problem automatically. They will then replace any failed components to bring your server back online, and will be contacting you to ensure that impact on your server is minimal.
    • createL7Pool
      Create a backend to be used for L7 load balancing. This L7 pool has backend protocol, L7 members, L7 health monitor and session affinity. L7 pool is associated with L7 policies.
    • createLiveLoadBalancer
      Create or add to an application delivery controller based load balancer service. The loadBalancer parameter must have its ''name'', ''type'', ''sourcePort'', and ''virtualIpAddress'' properties populated. Changes are reflected immediately in the application delivery controller.
    • createModifyResponseHeader
      SOAP API will create modify response header for an existing CDN mapping and for a particular customer.
    • createMxRecord
      Create an MX record on a SoftLayer domain. This is a shortcut method, meant to take the work out of creating a SoftLayer_Dns_Domain_ResourceRecord if you already have a domain record available. MX records are created with a default priority of 10. createMxRecord returns the newly created SoftLayer_Dns_Domain_ResourceRecord_MxType.
    • createNotificationSubscriber
      Create a new subscriber for a given resource.
    • createNotificationSubscriber
      Create a new subscriber for a given resource.
    • createNotificationSubscriber
      Create a new subscriber for a given resource.
    • createNsRecord
      Create an NS record on a SoftLayer domain. This is a shortcut method, meant to take the work out of creating a SoftLayer_Dns_Domain_ResourceRecord if you already have a domain record available. createNsRecord returns the newly created SoftLayer_Dns_Domain_ResourceRecord_NsType.
    • createObject
      Create a new address record. The ''typeId'', ''accountId'', ''description'', ''address1'', ''city'', ''state'', ''country'', and ''postalCode'' properties in the templateObject parameter are required properties and may not be null or empty. Users will be restricted to creating addresses for their account.
    • createObject
      Create a new affiliation to associate with an existing account.
    • createObject
    • createObject
      This method creates an account contact. The accountId is fixed, other properties can be set during creation. The typeId indicates the SoftLayer_Account_Contact_Type for the contact. This method returns the SoftLayer_Account_Contact object that is created.
    • createObject
    • createObject
      <style type='text/css'>.create_object > li > div { padding-top: .5em; padding-bottom: .5em}</style> This method will create a new SoftLayer_Account_Regional_Registry_Detail object. <b>Input</b> - [SoftLayer_Account_Regional_Registry_Detail](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail) <ul class='create_object'> <li><code>detailTypeId</code> <div>The [SoftLayer_Account_Regional_Registry_Detail_Type](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail_Type) of this detail object</div> <ul> <li><b>Required</b></li> <li><b>Type</b> - integer</li> </ul> </li> <li><code>regionalInternetRegistryHandleId</code> <div> The id of the [SoftLayer_Account_Rwhois_Handle](/reference/datatypes/SoftLayer_Account_Rwhois_Handle) object. This is only to be used for detailed registrations, where a subnet is registered to an organization. The associated handle will be required to be a valid organization object id at the relevant registry. In this case, the detail object will only be valid for the registry the organization belongs to. </div> <ul> <li><b>Optional</b></li> <li><b>Type</b> - integer</li> </ul> </li> </ul>
    • createObject
      <style type='text/css'>.create_object > li > div { padding-top: .5em; padding-bottom: .5em}</style> This method will create a new SoftLayer_Account_Regional_Registry_Detail_Property object. <b>Input</b> - [SoftLayer_Account_Regional_Registry_Detail_Property](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail_Property) <ul class='create_object'> <li><code>registrationDetailId</code> <div>The numeric ID of the [SoftLayer_Account_Regional_Registry_Detail](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail) this property belongs to</div> <ul> <li><b>Required</b></li> <li><b>Type</b> - integer</li> </ul> </li> <li><code>propertyTypeId</code> <div> The numeric ID of the associated [SoftLayer_Account_Regional_Registry_Detail_Property_Type](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail_Property_Type) object </div> <ul> <li><b>Required</b></li> <li><b>Type</b> - integer</li> </ul> </li> <li><code>sequencePosition</code> <div> When more than one property of the same type exists on a detail object, this value determines the position in that collection. This can be thought of more as a sort order. </div> <ul> <li><b>Required</b></li> <li><b>Type</b> - integer</li> </ul> </li> <li><code>value</code> <div> The actual value of the property. </div> <ul> <li><b>Required</b></li> <li><b>Type</b> - string</li> </ul> </li> </ul>
    • createObject
      Create a new shipment tracking data. The ''shipmentId'', ''sequence'', and ''trackingData'' properties in the templateObject parameter are required parameters to create a tracking data record.
    • createObject
      This method creates a service cancellation request. You need to have 'Cancel Services' privilege to create a cancellation request. You have to provide at least one SoftLayer_Billing_Item_Cancellation_Request_Item in the 'items' property. Make sure billing item's category code belongs to the cancelable product codes. You can retrieve the cancelable product category by the [SoftLayer_Product_Item_Category::getValidCancelableServiceItemCategories](/reference/datatypes/$1/#$2) service.
    • createObject
      createObject() allows the creation of a new brand. This will also create an `account` to serve as the owner of the brand. In order to create a brand, a template object must be sent in with several required values. ### Input [SoftLayer_Brand](/reference/datatypes/SoftLayer_Brand) - `name` + Name of brand + Required + Type: string - `keyName` + Reference key name + Required + Type: string - `longName` + More descriptive name of brand + Required + Type: string - `account.firstName` + First Name of account contact + Required + Type: string - `account.lastName` + Last Name of account contact + Required + Type: string - `account.address1` + Street Address of company + Required + Type: string - `account.address2` + Street Address of company + Optional + Type: string - `account.city` + City of company + Required + Type: string - `account.state` + State of company (if applicable) + Conditionally Required + Type: string - `account.postalCode` + Postal Code of company + Required + Type: string - `account.country` + Country of company + Required + Type: string - `account.officePhone` + Office Phone number of Company + Required + Type: string - `account.alternatePhone` + Alternate Phone number of Company + Optional + Type: string - `account.companyName` + Name of company + Required + Type: string - `account.email` + Email address of account contact + Required + Type: string REST Example: ``` curl -X POST -d '{ 'parameters':[{ 'name': 'Brand Corp', 'keyName': 'BRAND_CORP', 'longName': 'Brand Corporation', 'account': { 'firstName': 'Gloria', 'lastName': 'Brand', 'address1': '123 Drive', 'city': 'Boston', 'state': 'MA', 'postalCode': '02107', 'country': 'US', 'companyName': 'Brand Corp', 'officePhone': '857-111-1111', 'email': 'noreply@example.com' } }] }' https://api.softlayer.com/rest/v3.1/SoftLayer_Brand/createObject.json ```
    • createObject
      Create a new domain on the SoftLayer name servers. The SoftLayer_Dns_Domain object passed to this function must have at least one A or AAAA resource record. createObject creates a default SOA record with the data: * '''host''': '@' * '''data''': 'ns1.softlayer.com.' * '''responsible person''': 'root.[your domain name].' * '''expire''': 604800 seconds * '''refresh''': 3600 seconds * '''retry''': 300 seconds * '''minimum''': 3600 seconds If your new domain uses the .de top-level domain then SOA refresh is set to 10000 seconds, retry is set to 1800 seconds, and minimum to 10000 seconds. If your domain doesn't contain NS resource records for ns1.softlayer.com or ns2.softlayer.com then ''createObject'' will create them for you. ''createObject'' returns a Boolean ''true'' on successful object creation or ''false'' if your domain was unable to be created..
    • createObject
      createObject creates a new domain resource record. The ''host'' property of the templateObject parameter is scrubbed to remove all non-alpha numeric characters except for '@', '_', '.', '*', and '-'. The ''data'' property of the templateObject parameter is scrubbed to remove all non-alphanumeric characters for '.' and '-'. Creating a resource record updates the serial number of the domain the resource record is associated with. ''createObject'' returns Boolean ''true'' on successful create or ''false'' if it was unable to create a resource record.
    • createObject
      createObject creates a new MX record. The ''host'' property of the templateObject parameter is scrubbed to remove all non-alpha numeric characters except for '@', '_', '.', '*', and '-'. The ''data'' property of the templateObject parameter is scrubbed to remove all non-alphanumeric characters for '.' and '-'. Creating an MX record updates the serial number of the domain the resource record is associated with.
    • createObject
      createObject creates a new SRV record. The ''host'' property of the templateObject parameter is scrubbed to remove all non-alpha numeric characters except for '@', '_', '.', '*', and '-'. The ''data'' property of the templateObject parameter is scrubbed to remove all non-alphanumeric characters for '.' and '-'. Creating an SRV record updates the serial number of the domain the resource record is associated with.
    • createObject
      Create a secondary DNS record. The ''zoneName'', ''masterIpAddress'', and ''transferFrequency'' properties in the templateObject parameter are required parameters to create a secondary DNS record.
    • createObject
      <style type='text/css'>.create_object > li > div { padding-top: .5em; padding-bottom: .5em}</style> createObject() enables the creation of servers on an account. This method is a simplified alternative to interacting with the ordering system directly. In order to create a server, a template object must be sent in with a few required values. When this method returns an order will have been placed for a server of the specified configuration. To determine when the server is available you can poll the server via [SoftLayer_Hardware::getObject](/reference/services/SoftLayer_Hardware/getObject), checking the <code>provisionDate</code> property. When <code>provisionDate</code> is not null, the server will be ready. Be sure to use the <code>globalIdentifier</code> as your initialization parameter. <b>Warning:</b> Servers created via this method will incur charges on your account. For testing input parameters see [SoftLayer_Hardware::generateOrderTemplate](/reference/services/SoftLayer_Hardware/generateOrderTemplate). <b>Input</b> - [SoftLayer_Hardware](/reference/datatypes/SoftLayer_Hardware) <ul class='create_object'> <li><code>hostname</code> <div>Hostname for the server.</div><ul> <li><b>Required</b></li> <li><b>Type</b> - string</li> </ul> <br /> </li> <li><code>domain</code> <div>Domain for the server.</div><ul> <li><b>Required</b></li> <li><b>Type</b> - string</li> </ul> <br /> </li> <li><code>processorCoreAmount</code> <div>The number of logical CPU cores to allocate.</div><ul> <li><b>Required</b></li> <li><b>Type</b> - int</li> <li>See [SoftLayer_Hardware::getCreateObjectOptions](/reference/services/SoftLayer_Hardware/getCreateObjectOptions) for available options.</li> </ul> <br /> </li> <li><code>memoryCapacity</code> <div>The amount of memory to allocate in gigabytes.</div><ul> <li><b>Required</b></li> <li><b>Type</b> - int</li> <li>See [SoftLayer_Hardware::getCreateObjectOptions](/reference/services/SoftLayer_Hardware/getCreateObjectOptions) for available options.</li> </ul> <br /> </li> <li><code>hourlyBillingFlag</code> <div>Specifies the billing type for the server.</div><ul> <li><b>Required</b></li> <li><b>Type</b> - boolean</li> <li>When true the server will be billed on hourly usage, otherwise it will be billed on a monthly basis.</li> </ul> <br /> </li> <li><code>operatingSystemReferenceCode</code> <div>An identifier for the operating system to provision the server with.</div><ul> <li><b>Required</b></li> <li><b>Type</b> - string</li> <li>See [SoftLayer_Hardware::getCreateObjectOptions](/reference/services/SoftLayer_Hardware/getCreateObjectOptions) for available options.</li> </ul> <br /> </li> <li><code>datacenter.name</code> <div>Specifies which datacenter the server is to be provisioned in.</div><ul> <li><b>Required</b></li> <li><b>Type</b> - string</li> <li>The <code>datacenter</code> property is a [SoftLayer_Location](/reference/datatypes/SoftLayer_Location) structure with the <code>name</code> field set.</li> <li>See [SoftLayer_Hardware::getCreateObjectOptions](/reference/services/SoftLayer_Hardware/getCreateObjectOptions) for available options.</li> </ul> <http title='Example'>{ 'datacenter': { 'name': 'dal05' } }</http> <br /> </li> <li><code>networkComponents.maxSpeed</code> <div>Specifies the connection speed for the server's network components.</div><ul> <li><b>Optional</b></li> <li><b>Type</b> - int</li> <li><b>Default</b> - The highest available zero cost port speed will be used.</li> <li><b>Description</b> - The <code>networkComponents</code> property is an array with a single [SoftLayer_Network_Component](/reference/datatypes/SoftLayer_Network_Component) structure. The <code>maxSpeed</code> property must be set to specify the network uplink speed, in megabits per second, of the server.</li> <li>See [SoftLayer_Hardware::getCreateObjectOptions](/reference/services/SoftLayer_Hardware/getCreateObjectOptions) for available options.</li> </ul> <http title='Example'>{ 'networkComponents': [ { 'maxSpeed': 1000 } ] }</http> <br /> </li> <li><code>networkComponents.redundancyEnabledFlag</code> <div>Specifies whether or not the server's network components should be in redundancy groups.</div><ul> <li><b>Optional</b></li> <li><b>Type</b> - bool</li> <li><b>Default</b> - <code>false</code></li> <li><b>Description</b> - The <code>networkComponents</code> property is an array with a single [SoftLayer_Network_Component](/reference/datatypes/SoftLayer_Network_Component) structure. When the <code>redundancyEnabledFlag</code> property is true the server's network components will be in redundancy groups.</li> </ul> <http title='Example'>{ 'networkComponents': [ { 'redundancyEnabledFlag': false } ] }</http> <br /> </li> <li><code>privateNetworkOnlyFlag</code> <div>Specifies whether or not the server only has access to the private network</div><ul> <li><b>Optional</b></li> <li><b>Type</b> - boolean</li> <li><b>Default</b> - <code>false</code></li> <li>When true this flag specifies that a server is to only have access to the private network.</li> </ul> <br /> </li> <li><code>primaryNetworkComponent.networkVlan.id</code> <div>Specifies the network vlan which is to be used for the frontend interface of the server.</div><ul> <li><b>Optional</b></li> <li><b>Type</b> - int</li> <li><b>Description</b> - The <code>primaryNetworkComponent</code> property is a [SoftLayer_Network_Component](/reference/datatypes/SoftLayer_Network_Component) structure with the <code>networkVlan</code> property populated with a [SoftLayer_Network_Vlan](/reference/datatypes/SoftLayer_Network_Vlan) structure. The <code>id</code> property must be set to specify the frontend network vlan of the server.</li> </ul> <http title='Example'>{ 'primaryNetworkComponent': { 'networkVlan': { 'id': 1 } } }</http> <br /> </li> <li><code>primaryBackendNetworkComponent.networkVlan.id</code> <div>Specifies the network vlan which is to be used for the backend interface of the server.</div><ul> <li><b>Optional</b></li> <li><b>Type</b> - int</li> <li><b>Description</b> - The <code>primaryBackendNetworkComponent</code> property is a [SoftLayer_Network_Component](/reference/datatypes/SoftLayer_Network_Component) structure with the <code>networkVlan</code> property populated with a [SoftLayer_Network_Vlan](/reference/datatypes/SoftLayer_Network_Vlan) structure. The <code>id</code> property must be set to specify the backend network vlan of the server.</li> </ul> <http title='Example'>{ 'primaryBackendNetworkComponent': { 'networkVlan': { 'id': 2 } } }</http> <br /> </li> <li><code>fixedConfigurationPreset.keyName</code> <div></div><ul> <li><b>Optional</b></li> <li><b>Type</b> - string</li> <li><b>Description</b> - The <code>fixedConfigurationPreset</code> property is a [SoftLayer_Product_Package_Preset](/reference/datatypes/SoftLayer_Product_Package_Preset) structure. The <code>keyName</code> property must be set to specify preset to use.</li> <li>If a fixed configuration preset is used <code>processorCoreAmount</code>, <code>memoryCapacity</code> and <code>hardDrives</code> properties must not be set.</li> <li>See [SoftLayer_Hardware::getCreateObjectOptions](/reference/services/SoftLayer_Hardware/getCreateObjectOptions) for available options.</li> </ul> <http title='Example'>{ 'fixedConfigurationPreset': { 'keyName': 'SOME_KEY_NAME' } }</http> <br /> </li> <li><code>userData.value</code> <div>Arbitrary data to be made available to the server.</div><ul> <li><b>Optional</b></li> <li><b>Type</b> - string</li> <li><b>Description</b> - The <code>userData</code> property is an array with a single [SoftLayer_Hardware_Attribute](/reference/datatypes/SoftLayer_Hardware_Attribute) structure with the <code>value</code> property set to an arbitrary value.</li> <li>This value can be retrieved via the [SoftLayer_Resource_Metadata::getUserMetadata](/reference/services/SoftLayer_Resource_Metadata/getUserMetadata) method from a request originating from the server. This is primarily useful for providing data to software that may be on the server and configured to execute upon first boot.</li> </ul> <http title='Example'>{ 'userData': [ { 'value': 'someValue' } ] }</http> <br /> </li> <li><code>hardDrives</code> <div>Hard drive settings for the server</div><ul> <li><b>Optional</b></li> <li><b>Type</b> - SoftLayer_Hardware_Component</li> <li><b>Default</b> - The largest available capacity for a zero cost primary disk will be used.</li> <li><b>Description</b> - The <code>hardDrives</code> property is an array of [SoftLayer_Hardware_Component](/reference/datatypes/SoftLayer_Hardware_Component) structures.</i> <li>Each hard drive must specify the <code>capacity</code> property.</li> <li>See [SoftLayer_Hardware::getCreateObjectOptions](/reference/services/SoftLayer_Hardware/getCreateObjectOptions) for available options.</li> </ul> <http title='Example'>{ 'hardDrives': [ { 'capacity': 500 } ] }</http> <br /> </li> <li id='hardware-create-object-ssh-keys'><code>sshKeys</code> <div>SSH keys to install on the server upon provisioning.</div><ul> <li><b>Optional</b></li> <li><b>Type</b> - array of [SoftLayer_Security_Ssh_Key](/reference/datatypes/SoftLayer_Security_Ssh_Key)</li> <li><b>Description</b> - The <code>sshKeys</code> property is an array of [SoftLayer_Security_Ssh_Key](/reference/datatypes/SoftLayer_Security_Ssh_Key) structures with the <code>id</code> property set to the value of an existing SSH key.</li> <li>To create a new SSH key, call [SoftLayer_Security_Ssh_Key::createObject](/reference/services/SoftLayer_Security_Ssh_Key/createObject) on the [SoftLayer_Security_Ssh_Key](/reference/datatypes/SoftLayer_Security_Ssh_Key) service.</li> <li>To obtain a list of existing SSH keys, call [SoftLayer_Account::getSshKeys](/reference/services/SoftLayer_Account/getSshKeys) on the [SoftLayer_Account](/reference/datatypes/SoftLayer_Account) service. </ul> <http title='Example'>{ 'sshKeys': [ { 'id': 123 } ] }</http> <br /> </li> <li><code>postInstallScriptUri</code> <div>Specifies the uri location of the script to be downloaded and run after installation is complete.</div><ul> <li><b>Optional</b></li> <li><b>Type</b> - string</li> </ul> <br /> </li> </ul> <h1>REST Example</h1> <http title='Request'>curl -X POST -d '{ 'parameters':[ { 'hostname': 'host1', 'domain': 'example.com', 'processorCoreAmount': 2, 'memoryCapacity': 2, 'hourlyBillingFlag': true, 'operatingSystemReferenceCode': 'UBUNTU_LATEST' } ] }' https://api.softlayer.com/rest/v3/SoftLayer_Hardware.json </http> <http title='Response'>HTTP/1.1 201 Created Location: https://api.softlayer.com/rest/v3/SoftLayer_Hardware/f5a3fcff-db1d-4b7c-9fa0-0349e41c29c5/getObject { 'accountId': 232298, 'bareMetalInstanceFlag': null, 'domain': 'example.com', 'hardwareStatusId': null, 'hostname': 'host1', 'id': null, 'serviceProviderId': null, 'serviceProviderResourceId': null, 'globalIdentifier': 'f5a3fcff-db1d-4b7c-9fa0-0349e41c29c5', 'hourlyBillingFlag': true, 'memoryCapacity': 2, 'operatingSystemReferenceCode': 'UBUNTU_LATEST', 'processorCoreAmount': 2 } </http>
    • createObject
      <style type='text/css'>.create_object > li > div { padding-top: .5em; padding-bottom: .5em}</style> createObject() enables the creation of servers on an account. This method is a simplified alternative to interacting with the ordering system directly. In order to create a server, a template object must be sent in with a few required values. When this method returns an order will have been placed for a server of the specified configuration. To determine when the server is available you can poll the server via [SoftLayer_Hardware::getObject](/reference/services/SoftLayer_Hardware/getObject), checking the <code>provisionDate</code> property. When <code>provisionDate</code> is not null, the server will be ready. Be sure to use the <code>globalIdentifier</code> as your initialization parameter. <b>Warning:</b> Servers created via this method will incur charges on your account. For testing input parameters see [SoftLayer_Hardware::generateOrderTemplate](/reference/services/SoftLayer_Hardware/generateOrderTemplate). <b>Input</b> - [SoftLayer_Hardware](/reference/datatypes/SoftLayer_Hardware) <ul class='create_object'> <li><code>hostname</code> <div>Hostname for the server.</div><ul> <li><b>Required</b></li> <li><b>Type</b> - string</li> </ul> <br /> </li> <li><code>domain</code> <div>Domain for the server.</div><ul> <li><b>Required</b></li> <li><b>Type</b> - string</li> </ul> <br /> </li> <li><code>processorCoreAmount</code> <div>The number of logical CPU cores to allocate.</div><ul> <li><b>Required</b></li> <li><b>Type</b> - int</li> <li>See [SoftLayer_Hardware::getCreateObjectOptions](/reference/services/SoftLayer_Hardware/getCreateObjectOptions) for available options.</li> </ul> <br /> </li> <li><code>memoryCapacity</code> <div>The amount of memory to allocate in gigabytes.</div><ul> <li><b>Required</b></li> <li><b>Type</b> - int</li> <li>See [SoftLayer_Hardware::getCreateObjectOptions](/reference/services/SoftLayer_Hardware/getCreateObjectOptions) for available options.</li> </ul> <br /> </li> <li><code>hourlyBillingFlag</code> <div>Specifies the billing type for the server.</div><ul> <li><b>Required</b></li> <li><b>Type</b> - boolean</li> <li>When true the server will be billed on hourly usage, otherwise it will be billed on a monthly basis.</li> </ul> <br /> </li> <li><code>operatingSystemReferenceCode</code> <div>An identifier for the operating system to provision the server with.</div><ul> <li><b>Required</b></li> <li><b>Type</b> - string</li> <li>See [SoftLayer_Hardware::getCreateObjectOptions](/reference/services/SoftLayer_Hardware/getCreateObjectOptions) for available options.</li> </ul> <br /> </li> <li><code>datacenter.name</code> <div>Specifies which datacenter the server is to be provisioned in.</div><ul> <li><b>Required</b></li> <li><b>Type</b> - string</li> <li>The <code>datacenter</code> property is a [SoftLayer_Location](/reference/datatypes/SoftLayer_Location) structure with the <code>name</code> field set.</li> <li>See [SoftLayer_Hardware::getCreateObjectOptions](/reference/services/SoftLayer_Hardware/getCreateObjectOptions) for available options.</li> </ul> <http title='Example'>{ 'datacenter': { 'name': 'dal05' } }</http> <br /> </li> <li><code>networkComponents.maxSpeed</code> <div>Specifies the connection speed for the server's network components.</div><ul> <li><b>Optional</b></li> <li><b>Type</b> - int</li> <li><b>Default</b> - The highest available zero cost port speed will be used.</li> <li><b>Description</b> - The <code>networkComponents</code> property is an array with a single [SoftLayer_Network_Component](/reference/datatypes/SoftLayer_Network_Component) structure. The <code>maxSpeed</code> property must be set to specify the network uplink speed, in megabits per second, of the server.</li> <li>See [SoftLayer_Hardware::getCreateObjectOptions](/reference/services/SoftLayer_Hardware/getCreateObjectOptions) for available options.</li> </ul> <http title='Example'>{ 'networkComponents': [ { 'maxSpeed': 1000 } ] }</http> <br /> </li> <li><code>networkComponents.redundancyEnabledFlag</code> <div>Specifies whether or not the server's network components should be in redundancy groups.</div><ul> <li><b>Optional</b></li> <li><b>Type</b> - bool</li> <li><b>Default</b> - <code>false</code></li> <li><b>Description</b> - The <code>networkComponents</code> property is an array with a single [SoftLayer_Network_Component](/reference/datatypes/SoftLayer_Network_Component) structure. When the <code>redundancyEnabledFlag</code> property is true the server's network components will be in redundancy groups.</li> </ul> <http title='Example'>{ 'networkComponents': [ { 'redundancyEnabledFlag': false } ] }</http> <br /> </li> <li><code>privateNetworkOnlyFlag</code> <div>Specifies whether or not the server only has access to the private network</div><ul> <li><b>Optional</b></li> <li><b>Type</b> - boolean</li> <li><b>Default</b> - <code>false</code></li> <li>When true this flag specifies that a server is to only have access to the private network.</li> </ul> <br /> </li> <li><code>primaryNetworkComponent.networkVlan.id</code> <div>Specifies the network vlan which is to be used for the frontend interface of the server.</div><ul> <li><b>Optional</b></li> <li><b>Type</b> - int</li> <li><b>Description</b> - The <code>primaryNetworkComponent</code> property is a [SoftLayer_Network_Component](/reference/datatypes/SoftLayer_Network_Component) structure with the <code>networkVlan</code> property populated with a [SoftLayer_Network_Vlan](/reference/datatypes/SoftLayer_Network_Vlan) structure. The <code>id</code> property must be set to specify the frontend network vlan of the server.</li> </ul> <http title='Example'>{ 'primaryNetworkComponent': { 'networkVlan': { 'id': 1 } } }</http> <br /> </li> <li><code>primaryBackendNetworkComponent.networkVlan.id</code> <div>Specifies the network vlan which is to be used for the backend interface of the server.</div><ul> <li><b>Optional</b></li> <li><b>Type</b> - int</li> <li><b>Description</b> - The <code>primaryBackendNetworkComponent</code> property is a [SoftLayer_Network_Component](/reference/datatypes/SoftLayer_Network_Component) structure with the <code>networkVlan</code> property populated with a [SoftLayer_Network_Vlan](/reference/datatypes/SoftLayer_Network_Vlan) structure. The <code>id</code> property must be set to specify the backend network vlan of the server.</li> </ul> <http title='Example'>{ 'primaryBackendNetworkComponent': { 'networkVlan': { 'id': 2 } } }</http> <br /> </li> <li><code>fixedConfigurationPreset.keyName</code> <div></div><ul> <li><b>Optional</b></li> <li><b>Type</b> - string</li> <li><b>Description</b> - The <code>fixedConfigurationPreset</code> property is a [SoftLayer_Product_Package_Preset](/reference/datatypes/SoftLayer_Product_Package_Preset) structure. The <code>keyName</code> property must be set to specify preset to use.</li> <li>If a fixed configuration preset is used <code>processorCoreAmount</code>, <code>memoryCapacity</code> and <code>hardDrives</code> properties must not be set.</li> <li>See [SoftLayer_Hardware::getCreateObjectOptions](/reference/services/SoftLayer_Hardware/getCreateObjectOptions) for available options.</li> </ul> <http title='Example'>{ 'fixedConfigurationPreset': { 'keyName': 'SOME_KEY_NAME' } }</http> <br /> </li> <li><code>userData.value</code> <div>Arbitrary data to be made available to the server.</div><ul> <li><b>Optional</b></li> <li><b>Type</b> - string</li> <li><b>Description</b> - The <code>userData</code> property is an array with a single [SoftLayer_Hardware_Attribute](/reference/datatypes/SoftLayer_Hardware_Attribute) structure with the <code>value</code> property set to an arbitrary value.</li> <li>This value can be retrieved via the [SoftLayer_Resource_Metadata::getUserMetadata](/reference/services/SoftLayer_Resource_Metadata/getUserMetadata) method from a request originating from the server. This is primarily useful for providing data to software that may be on the server and configured to execute upon first boot.</li> </ul> <http title='Example'>{ 'userData': [ { 'value': 'someValue' } ] }</http> <br /> </li> <li><code>hardDrives</code> <div>Hard drive settings for the server</div><ul> <li><b>Optional</b></li> <li><b>Type</b> - SoftLayer_Hardware_Component</li> <li><b>Default</b> - The largest available capacity for a zero cost primary disk will be used.</li> <li><b>Description</b> - The <code>hardDrives</code> property is an array of [SoftLayer_Hardware_Component](/reference/datatypes/SoftLayer_Hardware_Component) structures.</i> <li>Each hard drive must specify the <code>capacity</code> property.</li> <li>See [SoftLayer_Hardware::getCreateObjectOptions](/reference/services/SoftLayer_Hardware/getCreateObjectOptions) for available options.</li> </ul> <http title='Example'>{ 'hardDrives': [ { 'capacity': 500 } ] }</http> <br /> </li> <li id='hardware-create-object-ssh-keys'><code>sshKeys</code> <div>SSH keys to install on the server upon provisioning.</div><ul> <li><b>Optional</b></li> <li><b>Type</b> - array of [SoftLayer_Security_Ssh_Key](/reference/datatypes/SoftLayer_Security_Ssh_Key)</li> <li><b>Description</b> - The <code>sshKeys</code> property is an array of [SoftLayer_Security_Ssh_Key](/reference/datatypes/SoftLayer_Security_Ssh_Key) structures with the <code>id</code> property set to the value of an existing SSH key.</li> <li>To create a new SSH key, call [SoftLayer_Security_Ssh_Key::createObject](/reference/services/SoftLayer_Security_Ssh_Key/createObject) on the [SoftLayer_Security_Ssh_Key](/reference/datatypes/SoftLayer_Security_Ssh_Key) service.</li> <li>To obtain a list of existing SSH keys, call [SoftLayer_Account::getSshKeys](/reference/services/SoftLayer_Account/getSshKeys) on the [SoftLayer_Account](/reference/datatypes/SoftLayer_Account) service. </ul> <http title='Example'>{ 'sshKeys': [ { 'id': 123 } ] }</http> <br /> </li> <li><code>postInstallScriptUri</code> <div>Specifies the uri location of the script to be downloaded and run after installation is complete.</div><ul> <li><b>Optional</b></li> <li><b>Type</b> - string</li> </ul> <br /> </li> </ul> <h1>REST Example</h1> <http title='Request'>curl -X POST -d '{ 'parameters':[ { 'hostname': 'host1', 'domain': 'example.com', 'processorCoreAmount': 2, 'memoryCapacity': 2, 'hourlyBillingFlag': true, 'operatingSystemReferenceCode': 'UBUNTU_LATEST' } ] }' https://api.softlayer.com/rest/v3/SoftLayer_Hardware.json </http> <http title='Response'>HTTP/1.1 201 Created Location: https://api.softlayer.com/rest/v3/SoftLayer_Hardware/f5a3fcff-db1d-4b7c-9fa0-0349e41c29c5/getObject { 'accountId': 232298, 'bareMetalInstanceFlag': null, 'domain': 'example.com', 'hardwareStatusId': null, 'hostname': 'host1', 'id': null, 'serviceProviderId': null, 'serviceProviderResourceId': null, 'globalIdentifier': 'f5a3fcff-db1d-4b7c-9fa0-0349e41c29c5', 'hourlyBillingFlag': true, 'memoryCapacity': 2, 'operatingSystemReferenceCode': 'UBUNTU_LATEST', 'processorCoreAmount': 2 } </http>
    • createObject
      <style type='text/css'>.create_object > li > div { padding-top: .5em; padding-bottom: .5em}</style> createObject() enables the creation of servers on an account. This method is a simplified alternative to interacting with the ordering system directly. In order to create a server, a template object must be sent in with a few required values. When this method returns an order will have been placed for a server of the specified configuration. To determine when the server is available you can poll the server via [SoftLayer_Hardware::getObject](/reference/services/SoftLayer_Hardware/getObject), checking the <code>provisionDate</code> property. When <code>provisionDate</code> is not null, the server will be ready. Be sure to use the <code>globalIdentifier</code> as your initialization parameter. <b>Warning:</b> Servers created via this method will incur charges on your account. For testing input parameters see [SoftLayer_Hardware::generateOrderTemplate](/reference/services/SoftLayer_Hardware/generateOrderTemplate). <b>Input</b> - [SoftLayer_Hardware](/reference/datatypes/SoftLayer_Hardware) <ul class='create_object'> <li><code>hostname</code> <div>Hostname for the server.</div><ul> <li><b>Required</b></li> <li><b>Type</b> - string</li> </ul> <br /> </li> <li><code>domain</code> <div>Domain for the server.</div><ul> <li><b>Required</b></li> <li><b>Type</b> - string</li> </ul> <br /> </li> <li><code>processorCoreAmount</code> <div>The number of logical CPU cores to allocate.</div><ul> <li><b>Required</b></li> <li><b>Type</b> - int</li> <li>See [SoftLayer_Hardware::getCreateObjectOptions](/reference/services/SoftLayer_Hardware/getCreateObjectOptions) for available options.</li> </ul> <br /> </li> <li><code>memoryCapacity</code> <div>The amount of memory to allocate in gigabytes.</div><ul> <li><b>Required</b></li> <li><b>Type</b> - int</li> <li>See [SoftLayer_Hardware::getCreateObjectOptions](/reference/services/SoftLayer_Hardware/getCreateObjectOptions) for available options.</li> </ul> <br /> </li> <li><code>hourlyBillingFlag</code> <div>Specifies the billing type for the server.</div><ul> <li><b>Required</b></li> <li><b>Type</b> - boolean</li> <li>When true the server will be billed on hourly usage, otherwise it will be billed on a monthly basis.</li> </ul> <br /> </li> <li><code>operatingSystemReferenceCode</code> <div>An identifier for the operating system to provision the server with.</div><ul> <li><b>Required</b></li> <li><b>Type</b> - string</li> <li>See [SoftLayer_Hardware::getCreateObjectOptions](/reference/services/SoftLayer_Hardware/getCreateObjectOptions) for available options.</li> </ul> <br /> </li> <li><code>datacenter.name</code> <div>Specifies which datacenter the server is to be provisioned in.</div><ul> <li><b>Required</b></li> <li><b>Type</b> - string</li> <li>The <code>datacenter</code> property is a [SoftLayer_Location](/reference/datatypes/SoftLayer_Location) structure with the <code>name</code> field set.</li> <li>See [SoftLayer_Hardware::getCreateObjectOptions](/reference/services/SoftLayer_Hardware/getCreateObjectOptions) for available options.</li> </ul> <http title='Example'>{ 'datacenter': { 'name': 'dal05' } }</http> <br /> </li> <li><code>networkComponents.maxSpeed</code> <div>Specifies the connection speed for the server's network components.</div><ul> <li><b>Optional</b></li> <li><b>Type</b> - int</li> <li><b>Default</b> - The highest available zero cost port speed will be used.</li> <li><b>Description</b> - The <code>networkComponents</code> property is an array with a single [SoftLayer_Network_Component](/reference/datatypes/SoftLayer_Network_Component) structure. The <code>maxSpeed</code> property must be set to specify the network uplink speed, in megabits per second, of the server.</li> <li>See [SoftLayer_Hardware::getCreateObjectOptions](/reference/services/SoftLayer_Hardware/getCreateObjectOptions) for available options.</li> </ul> <http title='Example'>{ 'networkComponents': [ { 'maxSpeed': 1000 } ] }</http> <br /> </li> <li><code>networkComponents.redundancyEnabledFlag</code> <div>Specifies whether or not the server's network components should be in redundancy groups.</div><ul> <li><b>Optional</b></li> <li><b>Type</b> - bool</li> <li><b>Default</b> - <code>false</code></li> <li><b>Description</b> - The <code>networkComponents</code> property is an array with a single [SoftLayer_Network_Component](/reference/datatypes/SoftLayer_Network_Component) structure. When the <code>redundancyEnabledFlag</code> property is true the server's network components will be in redundancy groups.</li> </ul> <http title='Example'>{ 'networkComponents': [ { 'redundancyEnabledFlag': false } ] }</http> <br /> </li> <li><code>privateNetworkOnlyFlag</code> <div>Specifies whether or not the server only has access to the private network</div><ul> <li><b>Optional</b></li> <li><b>Type</b> - boolean</li> <li><b>Default</b> - <code>false</code></li> <li>When true this flag specifies that a server is to only have access to the private network.</li> </ul> <br /> </li> <li><code>primaryNetworkComponent.networkVlan.id</code> <div>Specifies the network vlan which is to be used for the frontend interface of the server.</div><ul> <li><b>Optional</b></li> <li><b>Type</b> - int</li> <li><b>Description</b> - The <code>primaryNetworkComponent</code> property is a [SoftLayer_Network_Component](/reference/datatypes/SoftLayer_Network_Component) structure with the <code>networkVlan</code> property populated with a [SoftLayer_Network_Vlan](/reference/datatypes/SoftLayer_Network_Vlan) structure. The <code>id</code> property must be set to specify the frontend network vlan of the server.</li> </ul> <http title='Example'>{ 'primaryNetworkComponent': { 'networkVlan': { 'id': 1 } } }</http> <br /> </li> <li><code>primaryBackendNetworkComponent.networkVlan.id</code> <div>Specifies the network vlan which is to be used for the backend interface of the server.</div><ul> <li><b>Optional</b></li> <li><b>Type</b> - int</li> <li><b>Description</b> - The <code>primaryBackendNetworkComponent</code> property is a [SoftLayer_Network_Component](/reference/datatypes/SoftLayer_Network_Component) structure with the <code>networkVlan</code> property populated with a [SoftLayer_Network_Vlan](/reference/datatypes/SoftLayer_Network_Vlan) structure. The <code>id</code> property must be set to specify the backend network vlan of the server.</li> </ul> <http title='Example'>{ 'primaryBackendNetworkComponent': { 'networkVlan': { 'id': 2 } } }</http> <br /> </li> <li><code>fixedConfigurationPreset.keyName</code> <div></div><ul> <li><b>Optional</b></li> <li><b>Type</b> - string</li> <li><b>Description</b> - The <code>fixedConfigurationPreset</code> property is a [SoftLayer_Product_Package_Preset](/reference/datatypes/SoftLayer_Product_Package_Preset) structure. The <code>keyName</code> property must be set to specify preset to use.</li> <li>If a fixed configuration preset is used <code>processorCoreAmount</code>, <code>memoryCapacity</code> and <code>hardDrives</code> properties must not be set.</li> <li>See [SoftLayer_Hardware::getCreateObjectOptions](/reference/services/SoftLayer_Hardware/getCreateObjectOptions) for available options.</li> </ul> <http title='Example'>{ 'fixedConfigurationPreset': { 'keyName': 'SOME_KEY_NAME' } }</http> <br /> </li> <li><code>userData.value</code> <div>Arbitrary data to be made available to the server.</div><ul> <li><b>Optional</b></li> <li><b>Type</b> - string</li> <li><b>Description</b> - The <code>userData</code> property is an array with a single [SoftLayer_Hardware_Attribute](/reference/datatypes/SoftLayer_Hardware_Attribute) structure with the <code>value</code> property set to an arbitrary value.</li> <li>This value can be retrieved via the [SoftLayer_Resource_Metadata::getUserMetadata](/reference/services/SoftLayer_Resource_Metadata/getUserMetadata) method from a request originating from the server. This is primarily useful for providing data to software that may be on the server and configured to execute upon first boot.</li> </ul> <http title='Example'>{ 'userData': [ { 'value': 'someValue' } ] }</http> <br /> </li> <li><code>hardDrives</code> <div>Hard drive settings for the server</div><ul> <li><b>Optional</b></li> <li><b>Type</b> - SoftLayer_Hardware_Component</li> <li><b>Default</b> - The largest available capacity for a zero cost primary disk will be used.</li> <li><b>Description</b> - The <code>hardDrives</code> property is an array of [SoftLayer_Hardware_Component](/reference/datatypes/SoftLayer_Hardware_Component) structures.</i> <li>Each hard drive must specify the <code>capacity</code> property.</li> <li>See [SoftLayer_Hardware::getCreateObjectOptions](/reference/services/SoftLayer_Hardware/getCreateObjectOptions) for available options.</li> </ul> <http title='Example'>{ 'hardDrives': [ { 'capacity': 500 } ] }</http> <br /> </li> <li id='hardware-create-object-ssh-keys'><code>sshKeys</code> <div>SSH keys to install on the server upon provisioning.</div><ul> <li><b>Optional</b></li> <li><b>Type</b> - array of [SoftLayer_Security_Ssh_Key](/reference/datatypes/SoftLayer_Security_Ssh_Key)</li> <li><b>Description</b> - The <code>sshKeys</code> property is an array of [SoftLayer_Security_Ssh_Key](/reference/datatypes/SoftLayer_Security_Ssh_Key) structures with the <code>id</code> property set to the value of an existing SSH key.</li> <li>To create a new SSH key, call [SoftLayer_Security_Ssh_Key::createObject](/reference/services/SoftLayer_Security_Ssh_Key/createObject) on the [SoftLayer_Security_Ssh_Key](/reference/datatypes/SoftLayer_Security_Ssh_Key) service.</li> <li>To obtain a list of existing SSH keys, call [SoftLayer_Account::getSshKeys](/reference/services/SoftLayer_Account/getSshKeys) on the [SoftLayer_Account](/reference/datatypes/SoftLayer_Account) service. </ul> <http title='Example'>{ 'sshKeys': [ { 'id': 123 } ] }</http> <br /> </li> <li><code>postInstallScriptUri</code> <div>Specifies the uri location of the script to be downloaded and run after installation is complete.</div><ul> <li><b>Optional</b></li> <li><b>Type</b> - string</li> </ul> <br /> </li> </ul> <h1>REST Example</h1> <http title='Request'>curl -X POST -d '{ 'parameters':[ { 'hostname': 'host1', 'domain': 'example.com', 'processorCoreAmount': 2, 'memoryCapacity': 2, 'hourlyBillingFlag': true, 'operatingSystemReferenceCode': 'UBUNTU_LATEST' } ] }' https://api.softlayer.com/rest/v3/SoftLayer_Hardware.json </http> <http title='Response'>HTTP/1.1 201 Created Location: https://api.softlayer.com/rest/v3/SoftLayer_Hardware/f5a3fcff-db1d-4b7c-9fa0-0349e41c29c5/getObject { 'accountId': 232298, 'bareMetalInstanceFlag': null, 'domain': 'example.com', 'hardwareStatusId': null, 'hostname': 'host1', 'id': null, 'serviceProviderId': null, 'serviceProviderResourceId': null, 'globalIdentifier': 'f5a3fcff-db1d-4b7c-9fa0-0349e41c29c5', 'hourlyBillingFlag': true, 'memoryCapacity': 2, 'operatingSystemReferenceCode': 'UBUNTU_LATEST', 'processorCoreAmount': 2 } </http>
    • createObject
      <style type='text/css'>.create_object > li > div { padding-top: .5em; padding-bottom: .5em}</style> createObject() enables the creation of servers on an account. This method is a simplified alternative to interacting with the ordering system directly. In order to create a server, a template object must be sent in with a few required values. When this method returns an order will have been placed for a server of the specified configuration. To determine when the server is available you can poll the server via [SoftLayer_Hardware::getObject](/reference/services/SoftLayer_Hardware/getObject), checking the <code>provisionDate</code> property. When <code>provisionDate</code> is not null, the server will be ready. Be sure to use the <code>globalIdentifier</code> as your initialization parameter. <b>Warning:</b> Servers created via this method will incur charges on your account. For testing input parameters see [SoftLayer_Hardware::generateOrderTemplate](/reference/services/SoftLayer_Hardware/generateOrderTemplate). <b>Input</b> - [SoftLayer_Hardware](/reference/datatypes/SoftLayer_Hardware) <ul class='create_object'> <li><code>hostname</code> <div>Hostname for the server.</div><ul> <li><b>Required</b></li> <li><b>Type</b> - string</li> </ul> <br /> </li> <li><code>domain</code> <div>Domain for the server.</div><ul> <li><b>Required</b></li> <li><b>Type</b> - string</li> </ul> <br /> </li> <li><code>processorCoreAmount</code> <div>The number of logical CPU cores to allocate.</div><ul> <li><b>Required</b></li> <li><b>Type</b> - int</li> <li>See [SoftLayer_Hardware::getCreateObjectOptions](/reference/services/SoftLayer_Hardware/getCreateObjectOptions) for available options.</li> </ul> <br /> </li> <li><code>memoryCapacity</code> <div>The amount of memory to allocate in gigabytes.</div><ul> <li><b>Required</b></li> <li><b>Type</b> - int</li> <li>See [SoftLayer_Hardware::getCreateObjectOptions](/reference/services/SoftLayer_Hardware/getCreateObjectOptions) for available options.</li> </ul> <br /> </li> <li><code>hourlyBillingFlag</code> <div>Specifies the billing type for the server.</div><ul> <li><b>Required</b></li> <li><b>Type</b> - boolean</li> <li>When true the server will be billed on hourly usage, otherwise it will be billed on a monthly basis.</li> </ul> <br /> </li> <li><code>operatingSystemReferenceCode</code> <div>An identifier for the operating system to provision the server with.</div><ul> <li><b>Required</b></li> <li><b>Type</b> - string</li> <li>See [SoftLayer_Hardware::getCreateObjectOptions](/reference/services/SoftLayer_Hardware/getCreateObjectOptions) for available options.</li> </ul> <br /> </li> <li><code>datacenter.name</code> <div>Specifies which datacenter the server is to be provisioned in.</div><ul> <li><b>Required</b></li> <li><b>Type</b> - string</li> <li>The <code>datacenter</code> property is a [SoftLayer_Location](/reference/datatypes/SoftLayer_Location) structure with the <code>name</code> field set.</li> <li>See [SoftLayer_Hardware::getCreateObjectOptions](/reference/services/SoftLayer_Hardware/getCreateObjectOptions) for available options.</li> </ul> <http title='Example'>{ 'datacenter': { 'name': 'dal05' } }</http> <br /> </li> <li><code>networkComponents.maxSpeed</code> <div>Specifies the connection speed for the server's network components.</div><ul> <li><b>Optional</b></li> <li><b>Type</b> - int</li> <li><b>Default</b> - The highest available zero cost port speed will be used.</li> <li><b>Description</b> - The <code>networkComponents</code> property is an array with a single [SoftLayer_Network_Component](/reference/datatypes/SoftLayer_Network_Component) structure. The <code>maxSpeed</code> property must be set to specify the network uplink speed, in megabits per second, of the server.</li> <li>See [SoftLayer_Hardware::getCreateObjectOptions](/reference/services/SoftLayer_Hardware/getCreateObjectOptions) for available options.</li> </ul> <http title='Example'>{ 'networkComponents': [ { 'maxSpeed': 1000 } ] }</http> <br /> </li> <li><code>networkComponents.redundancyEnabledFlag</code> <div>Specifies whether or not the server's network components should be in redundancy groups.</div><ul> <li><b>Optional</b></li> <li><b>Type</b> - bool</li> <li><b>Default</b> - <code>false</code></li> <li><b>Description</b> - The <code>networkComponents</code> property is an array with a single [SoftLayer_Network_Component](/reference/datatypes/SoftLayer_Network_Component) structure. When the <code>redundancyEnabledFlag</code> property is true the server's network components will be in redundancy groups.</li> </ul> <http title='Example'>{ 'networkComponents': [ { 'redundancyEnabledFlag': false } ] }</http> <br /> </li> <li><code>privateNetworkOnlyFlag</code> <div>Specifies whether or not the server only has access to the private network</div><ul> <li><b>Optional</b></li> <li><b>Type</b> - boolean</li> <li><b>Default</b> - <code>false</code></li> <li>When true this flag specifies that a server is to only have access to the private network.</li> </ul> <br /> </li> <li><code>primaryNetworkComponent.networkVlan.id</code> <div>Specifies the network vlan which is to be used for the frontend interface of the server.</div><ul> <li><b>Optional</b></li> <li><b>Type</b> - int</li> <li><b>Description</b> - The <code>primaryNetworkComponent</code> property is a [SoftLayer_Network_Component](/reference/datatypes/SoftLayer_Network_Component) structure with the <code>networkVlan</code> property populated with a [SoftLayer_Network_Vlan](/reference/datatypes/SoftLayer_Network_Vlan) structure. The <code>id</code> property must be set to specify the frontend network vlan of the server.</li> </ul> <http title='Example'>{ 'primaryNetworkComponent': { 'networkVlan': { 'id': 1 } } }</http> <br /> </li> <li><code>primaryBackendNetworkComponent.networkVlan.id</code> <div>Specifies the network vlan which is to be used for the backend interface of the server.</div><ul> <li><b>Optional</b></li> <li><b>Type</b> - int</li> <li><b>Description</b> - The <code>primaryBackendNetworkComponent</code> property is a [SoftLayer_Network_Component](/reference/datatypes/SoftLayer_Network_Component) structure with the <code>networkVlan</code> property populated with a [SoftLayer_Network_Vlan](/reference/datatypes/SoftLayer_Network_Vlan) structure. The <code>id</code> property must be set to specify the backend network vlan of the server.</li> </ul> <http title='Example'>{ 'primaryBackendNetworkComponent': { 'networkVlan': { 'id': 2 } } }</http> <br /> </li> <li><code>fixedConfigurationPreset.keyName</code> <div></div><ul> <li><b>Optional</b></li> <li><b>Type</b> - string</li> <li><b>Description</b> - The <code>fixedConfigurationPreset</code> property is a [SoftLayer_Product_Package_Preset](/reference/datatypes/SoftLayer_Product_Package_Preset) structure. The <code>keyName</code> property must be set to specify preset to use.</li> <li>If a fixed configuration preset is used <code>processorCoreAmount</code>, <code>memoryCapacity</code> and <code>hardDrives</code> properties must not be set.</li> <li>See [SoftLayer_Hardware::getCreateObjectOptions](/reference/services/SoftLayer_Hardware/getCreateObjectOptions) for available options.</li> </ul> <http title='Example'>{ 'fixedConfigurationPreset': { 'keyName': 'SOME_KEY_NAME' } }</http> <br /> </li> <li><code>userData.value</code> <div>Arbitrary data to be made available to the server.</div><ul> <li><b>Optional</b></li> <li><b>Type</b> - string</li> <li><b>Description</b> - The <code>userData</code> property is an array with a single [SoftLayer_Hardware_Attribute](/reference/datatypes/SoftLayer_Hardware_Attribute) structure with the <code>value</code> property set to an arbitrary value.</li> <li>This value can be retrieved via the [SoftLayer_Resource_Metadata::getUserMetadata](/reference/services/SoftLayer_Resource_Metadata/getUserMetadata) method from a request originating from the server. This is primarily useful for providing data to software that may be on the server and configured to execute upon first boot.</li> </ul> <http title='Example'>{ 'userData': [ { 'value': 'someValue' } ] }</http> <br /> </li> <li><code>hardDrives</code> <div>Hard drive settings for the server</div><ul> <li><b>Optional</b></li> <li><b>Type</b> - SoftLayer_Hardware_Component</li> <li><b>Default</b> - The largest available capacity for a zero cost primary disk will be used.</li> <li><b>Description</b> - The <code>hardDrives</code> property is an array of [SoftLayer_Hardware_Component](/reference/datatypes/SoftLayer_Hardware_Component) structures.</i> <li>Each hard drive must specify the <code>capacity</code> property.</li> <li>See [SoftLayer_Hardware::getCreateObjectOptions](/reference/services/SoftLayer_Hardware/getCreateObjectOptions) for available options.</li> </ul> <http title='Example'>{ 'hardDrives': [ { 'capacity': 500 } ] }</http> <br /> </li> <li id='hardware-create-object-ssh-keys'><code>sshKeys</code> <div>SSH keys to install on the server upon provisioning.</div><ul> <li><b>Optional</b></li> <li><b>Type</b> - array of [SoftLayer_Security_Ssh_Key](/reference/datatypes/SoftLayer_Security_Ssh_Key)</li> <li><b>Description</b> - The <code>sshKeys</code> property is an array of [SoftLayer_Security_Ssh_Key](/reference/datatypes/SoftLayer_Security_Ssh_Key) structures with the <code>id</code> property set to the value of an existing SSH key.</li> <li>To create a new SSH key, call [SoftLayer_Security_Ssh_Key::createObject](/reference/services/SoftLayer_Security_Ssh_Key/createObject) on the [SoftLayer_Security_Ssh_Key](/reference/datatypes/SoftLayer_Security_Ssh_Key) service.</li> <li>To obtain a list of existing SSH keys, call [SoftLayer_Account::getSshKeys](/reference/services/SoftLayer_Account/getSshKeys) on the [SoftLayer_Account](/reference/datatypes/SoftLayer_Account) service. </ul> <http title='Example'>{ 'sshKeys': [ { 'id': 123 } ] }</http> <br /> </li> <li><code>postInstallScriptUri</code> <div>Specifies the uri location of the script to be downloaded and run after installation is complete.</div><ul> <li><b>Optional</b></li> <li><b>Type</b> - string</li> </ul> <br /> </li> </ul> <h1>REST Example</h1> <http title='Request'>curl -X POST -d '{ 'parameters':[ { 'hostname': 'host1', 'domain': 'example.com', 'processorCoreAmount': 2, 'memoryCapacity': 2, 'hourlyBillingFlag': true, 'operatingSystemReferenceCode': 'UBUNTU_LATEST' } ] }' https://api.softlayer.com/rest/v3/SoftLayer_Hardware.json </http> <http title='Response'>HTTP/1.1 201 Created Location: https://api.softlayer.com/rest/v3/SoftLayer_Hardware/f5a3fcff-db1d-4b7c-9fa0-0349e41c29c5/getObject { 'accountId': 232298, 'bareMetalInstanceFlag': null, 'domain': 'example.com', 'hardwareStatusId': null, 'hostname': 'host1', 'id': null, 'serviceProviderId': null, 'serviceProviderResourceId': null, 'globalIdentifier': 'f5a3fcff-db1d-4b7c-9fa0-0349e41c29c5', 'hourlyBillingFlag': true, 'memoryCapacity': 2, 'operatingSystemReferenceCode': 'UBUNTU_LATEST', 'processorCoreAmount': 2 } </http>
    • createObject
      <style type='text/css'>.create_object > li > div { padding-top: .5em; padding-bottom: .5em}</style> createObject() enables the creation of servers on an account. This method is a simplified alternative to interacting with the ordering system directly. In order to create a server, a template object must be sent in with a few required values. When this method returns an order will have been placed for a server of the specified configuration. To determine when the server is available you can poll the server via [SoftLayer_Hardware::getObject](/reference/services/SoftLayer_Hardware/getObject), checking the <code>provisionDate</code> property. When <code>provisionDate</code> is not null, the server will be ready. Be sure to use the <code>globalIdentifier</code> as your initialization parameter. <b>Warning:</b> Servers created via this method will incur charges on your account. For testing input parameters see [SoftLayer_Hardware::generateOrderTemplate](/reference/services/SoftLayer_Hardware/generateOrderTemplate). <b>Input</b> - [SoftLayer_Hardware](/reference/datatypes/SoftLayer_Hardware) <ul class='create_object'> <li><code>hostname</code> <div>Hostname for the server.</div><ul> <li><b>Required</b></li> <li><b>Type</b> - string</li> </ul> <br /> </li> <li><code>domain</code> <div>Domain for the server.</div><ul> <li><b>Required</b></li> <li><b>Type</b> - string</li> </ul> <br /> </li> <li><code>processorCoreAmount</code> <div>The number of logical CPU cores to allocate.</div><ul> <li><b>Required</b></li> <li><b>Type</b> - int</li> <li>See [SoftLayer_Hardware::getCreateObjectOptions](/reference/services/SoftLayer_Hardware/getCreateObjectOptions) for available options.</li> </ul> <br /> </li> <li><code>memoryCapacity</code> <div>The amount of memory to allocate in gigabytes.</div><ul> <li><b>Required</b></li> <li><b>Type</b> - int</li> <li>See [SoftLayer_Hardware::getCreateObjectOptions](/reference/services/SoftLayer_Hardware/getCreateObjectOptions) for available options.</li> </ul> <br /> </li> <li><code>hourlyBillingFlag</code> <div>Specifies the billing type for the server.</div><ul> <li><b>Required</b></li> <li><b>Type</b> - boolean</li> <li>When true the server will be billed on hourly usage, otherwise it will be billed on a monthly basis.</li> </ul> <br /> </li> <li><code>operatingSystemReferenceCode</code> <div>An identifier for the operating system to provision the server with.</div><ul> <li><b>Required</b></li> <li><b>Type</b> - string</li> <li>See [SoftLayer_Hardware::getCreateObjectOptions](/reference/services/SoftLayer_Hardware/getCreateObjectOptions) for available options.</li> </ul> <br /> </li> <li><code>datacenter.name</code> <div>Specifies which datacenter the server is to be provisioned in.</div><ul> <li><b>Required</b></li> <li><b>Type</b> - string</li> <li>The <code>datacenter</code> property is a [SoftLayer_Location](/reference/datatypes/SoftLayer_Location) structure with the <code>name</code> field set.</li> <li>See [SoftLayer_Hardware::getCreateObjectOptions](/reference/services/SoftLayer_Hardware/getCreateObjectOptions) for available options.</li> </ul> <http title='Example'>{ 'datacenter': { 'name': 'dal05' } }</http> <br /> </li> <li><code>networkComponents.maxSpeed</code> <div>Specifies the connection speed for the server's network components.</div><ul> <li><b>Optional</b></li> <li><b>Type</b> - int</li> <li><b>Default</b> - The highest available zero cost port speed will be used.</li> <li><b>Description</b> - The <code>networkComponents</code> property is an array with a single [SoftLayer_Network_Component](/reference/datatypes/SoftLayer_Network_Component) structure. The <code>maxSpeed</code> property must be set to specify the network uplink speed, in megabits per second, of the server.</li> <li>See [SoftLayer_Hardware::getCreateObjectOptions](/reference/services/SoftLayer_Hardware/getCreateObjectOptions) for available options.</li> </ul> <http title='Example'>{ 'networkComponents': [ { 'maxSpeed': 1000 } ] }</http> <br /> </li> <li><code>networkComponents.redundancyEnabledFlag</code> <div>Specifies whether or not the server's network components should be in redundancy groups.</div><ul> <li><b>Optional</b></li> <li><b>Type</b> - bool</li> <li><b>Default</b> - <code>false</code></li> <li><b>Description</b> - The <code>networkComponents</code> property is an array with a single [SoftLayer_Network_Component](/reference/datatypes/SoftLayer_Network_Component) structure. When the <code>redundancyEnabledFlag</code> property is true the server's network components will be in redundancy groups.</li> </ul> <http title='Example'>{ 'networkComponents': [ { 'redundancyEnabledFlag': false } ] }</http> <br /> </li> <li><code>privateNetworkOnlyFlag</code> <div>Specifies whether or not the server only has access to the private network</div><ul> <li><b>Optional</b></li> <li><b>Type</b> - boolean</li> <li><b>Default</b> - <code>false</code></li> <li>When true this flag specifies that a server is to only have access to the private network.</li> </ul> <br /> </li> <li><code>primaryNetworkComponent.networkVlan.id</code> <div>Specifies the network vlan which is to be used for the frontend interface of the server.</div><ul> <li><b>Optional</b></li> <li><b>Type</b> - int</li> <li><b>Description</b> - The <code>primaryNetworkComponent</code> property is a [SoftLayer_Network_Component](/reference/datatypes/SoftLayer_Network_Component) structure with the <code>networkVlan</code> property populated with a [SoftLayer_Network_Vlan](/reference/datatypes/SoftLayer_Network_Vlan) structure. The <code>id</code> property must be set to specify the frontend network vlan of the server.</li> </ul> <http title='Example'>{ 'primaryNetworkComponent': { 'networkVlan': { 'id': 1 } } }</http> <br /> </li> <li><code>primaryBackendNetworkComponent.networkVlan.id</code> <div>Specifies the network vlan which is to be used for the backend interface of the server.</div><ul> <li><b>Optional</b></li> <li><b>Type</b> - int</li> <li><b>Description</b> - The <code>primaryBackendNetworkComponent</code> property is a [SoftLayer_Network_Component](/reference/datatypes/SoftLayer_Network_Component) structure with the <code>networkVlan</code> property populated with a [SoftLayer_Network_Vlan](/reference/datatypes/SoftLayer_Network_Vlan) structure. The <code>id</code> property must be set to specify the backend network vlan of the server.</li> </ul> <http title='Example'>{ 'primaryBackendNetworkComponent': { 'networkVlan': { 'id': 2 } } }</http> <br /> </li> <li><code>fixedConfigurationPreset.keyName</code> <div></div><ul> <li><b>Optional</b></li> <li><b>Type</b> - string</li> <li><b>Description</b> - The <code>fixedConfigurationPreset</code> property is a [SoftLayer_Product_Package_Preset](/reference/datatypes/SoftLayer_Product_Package_Preset) structure. The <code>keyName</code> property must be set to specify preset to use.</li> <li>If a fixed configuration preset is used <code>processorCoreAmount</code>, <code>memoryCapacity</code> and <code>hardDrives</code> properties must not be set.</li> <li>See [SoftLayer_Hardware::getCreateObjectOptions](/reference/services/SoftLayer_Hardware/getCreateObjectOptions) for available options.</li> </ul> <http title='Example'>{ 'fixedConfigurationPreset': { 'keyName': 'SOME_KEY_NAME' } }</http> <br /> </li> <li><code>userData.value</code> <div>Arbitrary data to be made available to the server.</div><ul> <li><b>Optional</b></li> <li><b>Type</b> - string</li> <li><b>Description</b> - The <code>userData</code> property is an array with a single [SoftLayer_Hardware_Attribute](/reference/datatypes/SoftLayer_Hardware_Attribute) structure with the <code>value</code> property set to an arbitrary value.</li> <li>This value can be retrieved via the [SoftLayer_Resource_Metadata::getUserMetadata](/reference/services/SoftLayer_Resource_Metadata/getUserMetadata) method from a request originating from the server. This is primarily useful for providing data to software that may be on the server and configured to execute upon first boot.</li> </ul> <http title='Example'>{ 'userData': [ { 'value': 'someValue' } ] }</http> <br /> </li> <li><code>hardDrives</code> <div>Hard drive settings for the server</div><ul> <li><b>Optional</b></li> <li><b>Type</b> - SoftLayer_Hardware_Component</li> <li><b>Default</b> - The largest available capacity for a zero cost primary disk will be used.</li> <li><b>Description</b> - The <code>hardDrives</code> property is an array of [SoftLayer_Hardware_Component](/reference/datatypes/SoftLayer_Hardware_Component) structures.</i> <li>Each hard drive must specify the <code>capacity</code> property.</li> <li>See [SoftLayer_Hardware::getCreateObjectOptions](/reference/services/SoftLayer_Hardware/getCreateObjectOptions) for available options.</li> </ul> <http title='Example'>{ 'hardDrives': [ { 'capacity': 500 } ] }</http> <br /> </li> <li id='hardware-create-object-ssh-keys'><code>sshKeys</code> <div>SSH keys to install on the server upon provisioning.</div><ul> <li><b>Optional</b></li> <li><b>Type</b> - array of [SoftLayer_Security_Ssh_Key](/reference/datatypes/SoftLayer_Security_Ssh_Key)</li> <li><b>Description</b> - The <code>sshKeys</code> property is an array of [SoftLayer_Security_Ssh_Key](/reference/datatypes/SoftLayer_Security_Ssh_Key) structures with the <code>id</code> property set to the value of an existing SSH key.</li> <li>To create a new SSH key, call [SoftLayer_Security_Ssh_Key::createObject](/reference/services/SoftLayer_Security_Ssh_Key/createObject) on the [SoftLayer_Security_Ssh_Key](/reference/datatypes/SoftLayer_Security_Ssh_Key) service.</li> <li>To obtain a list of existing SSH keys, call [SoftLayer_Account::getSshKeys](/reference/services/SoftLayer_Account/getSshKeys) on the [SoftLayer_Account](/reference/datatypes/SoftLayer_Account) service. </ul> <http title='Example'>{ 'sshKeys': [ { 'id': 123 } ] }</http> <br /> </li> <li><code>postInstallScriptUri</code> <div>Specifies the uri location of the script to be downloaded and run after installation is complete.</div><ul> <li><b>Optional</b></li> <li><b>Type</b> - string</li> </ul> <br /> </li> </ul> <h1>REST Example</h1> <http title='Request'>curl -X POST -d '{ 'parameters':[ { 'hostname': 'host1', 'domain': 'example.com', 'processorCoreAmount': 2, 'memoryCapacity': 2, 'hourlyBillingFlag': true, 'operatingSystemReferenceCode': 'UBUNTU_LATEST' } ] }' https://api.softlayer.com/rest/v3/SoftLayer_Hardware.json </http> <http title='Response'>HTTP/1.1 201 Created Location: https://api.softlayer.com/rest/v3/SoftLayer_Hardware/f5a3fcff-db1d-4b7c-9fa0-0349e41c29c5/getObject { 'accountId': 232298, 'bareMetalInstanceFlag': null, 'domain': 'example.com', 'hardwareStatusId': null, 'hostname': 'host1', 'id': null, 'serviceProviderId': null, 'serviceProviderResourceId': null, 'globalIdentifier': 'f5a3fcff-db1d-4b7c-9fa0-0349e41c29c5', 'hourlyBillingFlag': true, 'memoryCapacity': 2, 'operatingSystemReferenceCode': 'UBUNTU_LATEST', 'processorCoreAmount': 2 } </http>
    • createObject
      This method creates a new layout profile object.
    • createObject
      Associate a layout container with a profile
    • createObject
      This method creates a new layout profile object.
    • createObject
      Create a allotment for servers to pool bandwidth and avoid overages in billing if they use more than there allocated bandwidth.
    • createObject
      For IPSec network tunnels, customers can create their local subnets using this method. After the customer is created successfully, the customer subnet can then be added to the IPSec network tunnel.
    • createObject
      Create a new firewall update request. If the SoftLayer_Network_Firewall_Update_Request object passed to this function has no rule, the firewall be set to bypass state and all the existing firewall rule(s) will be deleted. ''createObject'' returns a Boolean ''true'' on successful object creation or ''false'' if your firewall update request was unable to be created.
    • createObject
      Create a new firewall update request. The SoftLayer_Network_Firewall_Update_Request object passed to this function must have at least one rule. ''createObject'' returns a Boolean ''true'' on successful object creation or ''false'' if your firewall update request was unable to be created..
    • createObject
      Create and return a new gateway. This object can be created with any number of members or VLANs, but they all must be in the same pod. By creating a gateway with members and/or VLANs attached, it is the equivalent of individually calling their createObject methods except this will start a single asynchronous process to setup the gateway. The status of this process can be checked using the status field.
    • createObject
      Create a new hardware member on the gateway. This also asynchronously sets up the network for this member. Progress of this process can be monitored via the gateway status. All members created with this object must have no VLANs attached.
    • createObject
      Create a new VLAN attachment. If the bypassFlag is false, this will also create an asynchronous process to route the VLAN through the gateway.
    • createObject
      With this method, you can create a transcode job. The very first step of creating a transcode job is to upload your media files to the /in directory on your Transcode FTP space. Then, you have to pass a [SoftLayer_Network_Media_Transcode_Job](/reference/datatypes/SoftLayer_Network_Media_Transcode_Job) object as a parameter for this method. There are 4 required properties of SoftLayer_Network_Media_Transcode_Job object: transcodePresetName, transcodePresetGuid, inputFile, and outputFile. A transcode preset is a configuration that defines a certain media output. You can retrieve all the supported presets with the [SoftLayer_Network_Media_Transcode_Account::getPresets](/reference/datatypes/$1/#$2) method. You can also use [SoftLayer_Network_Media_Transcode_Account::getPresetDetail](/reference/datatypes/$1/#$2) method to get more information on a preset. Use these two methods to determine appropriate values for 'transcodePresetName' and 'transcodePresetGuid' properties. For an 'inputFile', you must specify a file that exists in the /in directory of your Transcode FTP space. An 'outputFile' name will be used by the Transcode server for naming a transcoded file. An output file name must be in /out directory. If your outputFile name already exists in the /out directory, the Transcode server will append a file name with _n (an underscore and the total number of files with the identical name plus 1). The 'name' property is optional and it can help you keep track of transcode jobs easily. 'autoDeleteDuration' is another optional property that you can specify. It determines how soon your input file will be deleted. If autoDeleteDuration is set to zero, your input file will be removed immediately after the last transcode job running on it is completed. A value for autoDeleteDuration property is in seconds and the maximum value is 259200 which is 3 days. An example SoftLayer_Network_Media_Transcode_Job parameter looks like this: * name: My transcoding * transcodePresetName: F4V 896kbps 640x352 16x9 29.97fps * transcodePresetGuid: {87E01268-C3E3-4A85-9701-052C9AC42BD4} * inputFile: /in/my_birthday.wmv * outputFile: /out/my_birthday_flash Notice that an output file does not have a file extension. The Transcode server will append a file extension based on an output format. A newly created transcode job will be in 'Pending' status and it will be added to the Transcoding queue. You will receive a notification email whenever there is a status change on your transcode job. For example, the Transcode server starts to process your transcode job, you will be notified via an email. You can add up to 3 pending jobs at a time. Transcode jobs with any other status such as 'Complete' or 'Error' will not be counted toward your pending jobs. Once a job is complete, the Transcode server will place the output file into the /out directory along with a notification email. The files in the /out directory will be removed 3 days after they were created. You will need to use an FTP client to download transcoded files.
    • createObject
      Passing in an unsaved instances of a Query_Host object into this function will create the object and return the results to the user.
    • createObject
      Create a new vulnerability scan request. New scan requests are picked up every five minutes, and the time to complete an actual scan may vary. Once the scan is finished, it can take up to another five minutes for the report to be generated and accessible.
    • createObject
      Create a new security group.
    • createObject
    • createObject
    • createObject
    • createObject
      Create a nas volume schedule
    • createObject
      Create registration with a global registrar to associate an assigned subnet with the provided contact details. Contact information is provided in the form of a [SoftLayer_Account_Regional_Registry_Detail](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail), which reference can be provided when the registration is created or afterwards. Registrations without an associated person detail will remain in the ``OPEN`` status. To specify a person detail when creating a registration, the ``detailReferences`` property should be populated with a list item providing a ``detailId`` value referencing the [SoftLayer_Account_Regional_Registry_Detail](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail). The same applies to [SoftLayer_Account_Regional_Registry_Detail](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail), though these references need not be provided. The system will create a reference to the network described by the registration's subnet in the absence of a provided network detail reference. However, if a specific detail is referenced, it must describe the same subnet as the registration. A template containing the following properties will create a subnet registration: * networkIdentifier * cidr * detailReferences ``networkIdentifier`` is the base address of the public, SoftLayer owned subnet which is being registered. ``cidr`` must be an integer representing the CIDR of the subnet to be registered. The ``networkIdentifier``/``cidr`` must represent an assigned subnet. ``detailReferences`` tie the registration to SoftLayer_Account_Regional_Registry_Detail objects.
    • createObject
      <style type='text/css'>.create_object > li > div { padding-top: .5em; padding-bottom: .5em}</style> This method will create a new SoftLayer_Network_Subnet_Registration_Details object. <b>Input</b> - [SoftLayer_Network_Subnet_Registration_Details](/reference/datatypes/SoftLayer_Network_Subnet_Registration_Details) <ul class='create_object'> <li><code>detailId</code> <div> The numeric ID of the [SoftLayer_Account_Regional_Registry_Detail](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail) object to relate. </div> <ul> <li><b>Required</b></li> <li><b>Type</b> - integer</li> </ul> </li> <li><code>registrationId</code> <div> The numeric ID of the [SoftLayer_Network_Subnet_Registration](/reference/datatypes/SoftLayer_Network_Subnet_Registration) object to relate. </div> <ul> <li><b>Required</b></li> <li><b>Type</b> - integer</li> </ul> </li> </ul>
    • createObject
      Use the method to create a new subscription for a notification. This method is the entry method to the notification system. Certain properties are required to create a subscription while others are optional. The required property is the resourceRecord property which is type SoftLayer_Notification_User_Subscriber_Resource. For the resourceRecord property, the only property that needs to be populated is the resourceTableId. The resourceTableId is the unique identifier of a SoftLayer service to create the subscription for. For example, the unique identifier of the Storage Evault service to create the subscription on. Optional properties that can be set is the preferences property. The preference property is an array SoftLayer_Notification_User_Subscriber_Preference. By default, the system will populate the preferences with the default values if no preferences are passed in. The preferences passed in must be the preferences related to the notification subscribing to. The notification preferences and preference details (such as minimum and maximum values) can be retrieved using the SoftLayer_Notification service. The properties that need to be populated for preferences are the notificationPreferenceId and value. For example to create a subscriber for a Storage EVault service to be notified 15 times during a billing cycle and to be notified when the vault usage reaches 85% of its allowed capacity use the following structure: *userRecordId = 1111 *notificationId = 3 *resourceRecord **resourceTableId = 1234 *preferences[1] **notificationPreferenceId = 2 **value = 85 *preference[2] **notificationPreferenceId = 3 **value = 15
    • createObject
      Use the method to create a new subscription for a notification. This method is the entry method to the notification system. Certain properties are required to create a subscription while others are optional. The required property is the resourceRecord property which is type SoftLayer_Notification_User_Subscriber_Resource. For the resourceRecord property, the only property that needs to be populated is the resourceTableId. The resourceTableId is the unique identifier of a SoftLayer service to create the subscription for. For example, the unique identifier of the Storage Evault service to create the subscription on. Optional properties that can be set is the preferences property. The preference property is an array SoftLayer_Notification_User_Subscriber_Preference. By default, the system will populate the preferences with the default values if no preferences are passed in. The preferences passed in must be the preferences related to the notification subscribing to. The notification preferences and preference details (such as minimum and maximum values) can be retrieved using the SoftLayer_Notification service. The properties that need to be populated for preferences are the notificationPreferenceId and value. For example to create a subscriber for a Storage EVault service to be notified 15 times during a billing cycle and to be notified when the vault usage reaches 85% of its allowed capacity use the following structure: *userRecordId = 1111 *notificationId = 3 *resourceRecord **resourceTableId = 1234 *preferences[1] **notificationPreferenceId = 2 **value = 85 *preference[2] **notificationPreferenceId = 3 **value = 15
    • createObject
      Use the method to create a new subscription for a notification. This method is the entry method to the notification system. Certain properties are required to create a subscription while others are optional. The required property is the resourceRecord property which is type SoftLayer_Notification_User_Subscriber_Resource. For the resourceRecord property, the only property that needs to be populated is the resourceTableId. The resourceTableId is the unique identifier of a SoftLayer service to create the subscription for. For example, the unique identifier of the Storage Evault service to create the subscription on. Optional properties that can be set is the preferences property. The preference property is an array SoftLayer_Notification_User_Subscriber_Preference. By default, the system will populate the preferences with the default values if no preferences are passed in. The preferences passed in must be the preferences related to the notification subscribing to. The notification preferences and preference details (such as minimum and maximum values) can be retrieved using the SoftLayer_Notification service. The properties that need to be populated for preferences are the notificationPreferenceId and value. For example to create a subscriber for a Storage EVault service to be notified 15 times during a billing cycle and to be notified when the vault usage reaches 85% of its allowed capacity use the following structure: *userRecordId = 1111 *notificationId = 3 *resourceRecord **resourceTableId = 1234 *preferences[1] **notificationPreferenceId = 2 **value = 85 *preference[2] **notificationPreferenceId = 3 **value = 15
    • createObject
      Use the method to create a new notification preference for a subscriber
    • createObject
    • createObject
      Add a certificate to your account for your records, or for use with various services. Only the certificate and private key are usually required. If your issuer provided an intermediate certificate, you must also provide that certificate. Details will be extracted from the certificate. Validation will be performed between the certificate and the private key as well as the certificate and the intermediate certificate, if provided. The certificate signing request is not required, but can be provided for your records.
    • createObject
      Add a ssh key to your account for use during server provisioning and os reloads.
    • createObject
      Create a password for a software component.
    • createObject
      Create a new user in the SoftLayer customer portal. It is not possible to set up SLL enable flags during object creation. These flags are ignored during object creation. You will need to make a subsequent call to edit object in order to enable VPN access. An account's master user and sub-users who have the User Manage permission can add new users. Users are created with a default permission set. After adding a user it may be helpful to set their permissions and device access. secondaryPasswordTimeoutDays will be set to the system configured default value if the attribute is not provided or the attribute is not a valid value. Note, neither password nor vpnPassword parameters are required. Password When a new user is created, an email will be sent to the new user's email address with a link to a url that will allow the new user to create or change their password for the SoftLayer customer portal. If the password parameter is provided and is not null, then that value will be validated. If it is a valid password, then the user will be created with this password. This user will still receive a portal password email. It can be used within 24 hours to change their password, or it can be allowed to expire, and the password provided during user creation will remain as the user's password. If the password parameter is not provided or the value is null, the user must set their portal password using the link sent in email within 24 hours.  If the user fails to set their password within 24 hours, then a non-master user can use the 'Reset Password' link on the login page of the portal to request a new email. A master user can use the link to retrieve a phone number to call to assist in resetting their password. The password parameter is ignored for VPN_ONLY users or for IBMid authenticated users. vpnPassword If the vpnPassword is provided, then the user's vpnPassword will be set to the provided password.  When creating a vpn only user, the vpnPassword MUST be supplied.  If the vpnPassword is not provided, then the user will need to use the portal to edit their profile and set the vpnPassword. IBMid considerations When a SoftLayer account is linked to a Platform Services (PaaS, formerly Bluemix) account, AND the trait on the SoftLayer Account indicating IBMid authentication is set, then SoftLayer will delegate the creation of an ACTIVE user to PaaS. This means that even though the request to create a new user in such an account may start at the IMS API, via this delegation we effectively turn it into a request that is driven by PaaS. In particular this means that any 'invitation email' that comes to the user, will come from PaaS, not from IMS via IBMid. Users created in states other than ACTIVE (for example, a VPN_ONLY user) will be created directly in IMS without delegation (but note that no invitation is sent for a user created in any state other than ACTIVE).
    • createObject
      Create a new mobile device association for a user.
    • createObject
      Passing in an unsaved instances of a Customer_Notification_Hardware object into this function will create the object and return the results to the user.
    • createObject
      Passing in an unsaved instance of a SoftLayer_Customer_Notification_Virtual_Guest object into this function will create the object and return the results to the user.
    • createObject
      Create a new user in the SoftLayer customer portal. It is not possible to set up SLL enable flags during object creation. These flags are ignored during object creation. You will need to make a subsequent call to edit object in order to enable VPN access. An account's master user and sub-users who have the User Manage permission can add new users. Users are created with a default permission set. After adding a user it may be helpful to set their permissions and device access. secondaryPasswordTimeoutDays will be set to the system configured default value if the attribute is not provided or the attribute is not a valid value. Note, neither password nor vpnPassword parameters are required. Password When a new user is created, an email will be sent to the new user's email address with a link to a url that will allow the new user to create or change their password for the SoftLayer customer portal. If the password parameter is provided and is not null, then that value will be validated. If it is a valid password, then the user will be created with this password. This user will still receive a portal password email. It can be used within 24 hours to change their password, or it can be allowed to expire, and the password provided during user creation will remain as the user's password. If the password parameter is not provided or the value is null, the user must set their portal password using the link sent in email within 24 hours.  If the user fails to set their password within 24 hours, then a non-master user can use the 'Reset Password' link on the login page of the portal to request a new email. A master user can use the link to retrieve a phone number to call to assist in resetting their password. The password parameter is ignored for VPN_ONLY users or for IBMid authenticated users. vpnPassword If the vpnPassword is provided, then the user's vpnPassword will be set to the provided password.  When creating a vpn only user, the vpnPassword MUST be supplied.  If the vpnPassword is not provided, then the user will need to use the portal to edit their profile and set the vpnPassword. IBMid considerations When a SoftLayer account is linked to a Platform Services (PaaS, formerly Bluemix) account, AND the trait on the SoftLayer Account indicating IBMid authentication is set, then SoftLayer will delegate the creation of an ACTIVE user to PaaS. This means that even though the request to create a new user in such an account may start at the IMS API, via this delegation we effectively turn it into a request that is driven by PaaS. In particular this means that any 'invitation email' that comes to the user, will come from PaaS, not from IMS via IBMid. Users created in states other than ACTIVE (for example, a VPN_ONLY user) will be created directly in IMS without delegation (but note that no invitation is sent for a user created in any state other than ACTIVE).
    • createObject
    • createObject
      Customer created permission groups must be of type NORMAL. The SYSTEM type is reserved for internal use. The account id supplied in the template permission group must match account id of the user who is creating the permission group. The user who is creating the permission group must have the permission to manage users.
    • createObject
      Customer created permission roles must set the systemFlag attribute to false. The SYSTEM type is reserved for internal use. The account id supplied in the template permission group must match account id of the user who is creating the permission group. The user who is creating the permission group must have the permission to manage users.
    • createObject
    • createObject
    • createObject
      createObject() enables the creation of computing instances on an account. This method is a simplified alternative to interacting with the ordering system directly. In order to create a computing instance, a template object must be sent in with a few required values. When this method returns an order will have been placed for a computing instance of the specified configuration. To determine when the instance is available you can poll the instance via [SoftLayer_Virtual_Guest::getObject](/reference/services/SoftLayer_Virtual_Guest/getObject), with an object mask requesting the `provisionDate` relational property. When `provisionDate` is not `null`, the instance will be ready. > **Warning:** Computing instances created via this method will incur charges on your account. For testing input parameters see [SoftLayer_Virtual_Guest::generateOrderTemplate](/reference/services/SoftLayer_Virtual_Guest/generateOrderTemplate). ### Required Input [SoftLayer_Virtual_Guest](/reference/datatypes/SoftLayer_Virtual_Guest) - `Hostname` String **Required** + Hostname for the computing instance. - `Domain` String **Required** + Domain for the computing instance. - `startCpus` Integer **Required** + The number of CPU cores to allocate. + See [SoftLayer_Virtual_Guest::getCreateObjectOptions](/reference/services/SoftLayer_Virtual_Guest/getCreateObjectOptions) for available options. - `maxMemory` Integer **Required** + The amount of memory to allocate in megabytes. + See [SoftLayer_Virtual_Guest::getCreateObjectOptions](/reference/services/SoftLayer_Virtual_Guest/getCreateObjectOptions) for available options. - `datacenter.name` *String* **Required** + Specifies which datacenter the instance is to be provisioned in. Needs to be a nested object. + Example: `'datacenter': {'name': 'dal05'}` + See [SoftLayer_Virtual_Guest::getCreateObjectOptions](/reference/services/SoftLayer_Virtual_Guest/getCreateObjectOptions) for available options. - `hourlyBillingFlag` Boolean **Required** + Specifies the billing type for the instance. + True for hourly billing, False for monthly billing. - `localDiskFlag` Boolean **Required** + Specifies the disk type for the instance. + True for local to the instance disks, False for SAN disks. - `dedicatedAccountHostOnlyFlag` Boolean + When true this flag specifies that a compute instance is to run on hosts that only have guests from the same account. + Default: False - `operatingSystemReferenceCode` String **Conditionally required** + An identifier for the operating system to provision the computing instance with. + Not required when using a `blockDeviceTemplateGroup.globalIdentifier`, as the template will have its own operating system. + See [SoftLayer_Virtual_Guest::getCreateObjectOptions](/reference/services/SoftLayer_Virtual_Guest/getCreateObjectOptions) for available options. + **Notice**: Some operating systems are billed based on the number of CPUs the guest has. The price which is used can be determined by calling [SoftLayer_Virtual_Guest::generateOrderTemplate](/reference/services/SoftLayer_Virtual_Guest/generateOrderTemplate) with your desired device specifications. - `blockDeviceTemplateGroup.globalIdentifier` String + The GUID for the template to be used to provision the computing instance. + Conflicts with `operatingSystemReferenceCode` + **Notice**: Some operating systems are billed based on the number of CPUs the guest has. The price which is used can be determined by calling [SoftLayer_Virtual_Guest::generateOrderTemplate](/reference/services/SoftLayer_Virtual_Guest/generateOrderTemplate) with your desired device specifications. + A list of public images may be obtained via a request to [SoftLayer_Virtual_Guest_Block_Device_Template_Group::getPublicImages](/reference/services/SoftLayer_Virtual_Guest_Block_Device_Template_Group/getPublicImages) + A list of private images may be obtained via a request to [SoftLayer_Account::getPrivateBlockDeviceTemplateGroups](/reference/services/SoftLayer_Account/getPrivateBlockDeviceTemplateGroups) + Example: `'blockDeviceTemplateGroup': { globalIdentifier': '07beadaa-1e11-476e-a188-3f7795feb9fb'` - `networkComponents.maxSpeed` Integer + Specifies the connection speed for the instance's network components. + The `networkComponents` property is an array with a single [SoftLayer_Virtual_Guest_Network_Component](/reference/datatypes/SoftLayer_Virtual_Guest_Network_Component) structure. The `maxSpeed` property must be set to specify the network uplink speed, in megabits per second, of the computing instance. + See [SoftLayer_Virtual_Guest::getCreateObjectOptions](/reference/services/SoftLayer_Virtual_Guest/getCreateObjectOptions) for available options. + Default: 10 + Example: `'networkComponents': [{'maxSpeed': 1000}]` - `privateNetworkOnlyFlag` Boolean + When true this flag specifies that a compute instance is to only have access to the private network. + Default: False - `primaryNetworkComponent.networkVlan.id` Integer + Specifies the network vlan which is to be used for the frontend interface of the computing instance. + The `primaryNetworkComponent` property is a [SoftLayer_Virtual_Guest_Network_Component](/reference/datatypes/SoftLayer_Virtual_Guest_Network_Component) structure with the `networkVlan` property populated with a i [SoftLayer_Network_Vlan](/reference/datatypes/SoftLayer_Network_Vlan) structure. The `id` property must be set to specify the frontend network vlan of the computing instance. + *NOTE* This is the VLAN `id`, NOT the vlan number. + Example: `'primaryNetworkComponent':{'networkVlan': {'id': 1234567}}` - `backendNetworkComponent.networkVlan.id` Integer + Specifies the network vlan which is to be used for the backend interface of the computing instance. + The `backendNetworkComponent` property is a [SoftLayer_Virtual_Guest_Network_Component](/reference/datatypes/SoftLayer_Virtual_Guest_Network_Component) structure with the `networkVlan` property populated with a [SoftLayer_Network_Vlan](/reference/datatypes/SoftLayer_Network_Vlan) structure. The `id` property must be set to specify the backend network vlan of the computing instance. + *NOTE* This is the VLAN `id`, NOT the vlan number. + Example: `'backendNetworkComponent':{'networkVlan': {'id': 1234567}}` - `primaryNetworkComponent.securityGroupBindings` [SoftLayer_Virtual_Network_SecurityGroup_NetworkComponentBinding](/reference/datatypes/SoftLayer_Virtual_Network_SecurityGroup_NetworkComponentBinding)[] + Specifies the security groups to be attached to this VSI's frontend network adapter + The `primaryNetworkComponent` property is a [SoftLayer_Virtual_Guest_Network_Component](/reference/datatypes/SoftLayer_Virtual_Guest_Network_Component) structure with the `securityGroupBindings` property populated with an array of [SoftLayer_Virtual_Network_SecurityGroup_NetworkComponentBinding](/reference/datatypes/SoftLayer_Virtual_Network_SecurityGroup_NetworkComponentBinding) structures. The `securityGroup` property in each must be set to specify the security group to be attached to the primary frontend network component. + Example: ``` 'primaryNetworkComponent': { 'securityGroupBindings': [ {'securityGroup':{'id': 5555555}}, {'securityGroup':{'id': 1112223}}, ] } ``` - `primaryBackendNetworkComponent.securityGroupBindings` [SoftLayer_Virtual_Network_SecurityGroup_NetworkComponentBinding](/reference/datatypes/SoftLayer_Virtual_Network_SecurityGroup_NetworkComponentBinding)[] + Specifies the security groups to be attached to this VSI's backend network adapter + The `primaryNetworkComponent` property is a [SoftLayer_Virtual_Guest_Network_Component](/reference/datatypes/SoftLayer_Virtual_Guest_Network_Component) structure with the `securityGroupBindings` property populated with an array of [SoftLayer_Virtual_Network_SecurityGroup_NetworkComponentBinding](/reference/datatypes/SoftLayer_Virtual_Network_SecurityGroup_NetworkComponentBinding) structures. The `securityGroup` property in each must be set to specify the security group to be attached to the primary frontend network component. + Example: ``` 'primaryBackendNetworkComponent': { 'securityGroupBindings': [ {'securityGroup':{'id': 33322211}}, {'securityGroup':{'id': 77777222}}, ] } ``` - `blockDevices` [SoftLayer_Virtual_Guest_Block_Device](/reference/datatypes/SoftLayer_Virtual_Guest_Block_Device)[] + Block device and disk image settings for the computing instance + The `blockDevices` property is an array of [SoftLayer_Virtual_Guest_Block_Device](/reference/datatypes/SoftLayer_Virtual_Guest_Block_Device) structures. Each block device must specify the `device` property along with the `diskImage` property, which is a [SoftLayer_Virtual_Disk_Image](/reference/datatypes/SoftLayer_Virtual_Disk_Image) structure with the `capacity` property set. The `device` number `'1'` is reserved for the SWAP disk attached to the computing instance. + Default: The smallest available capacity for the primary disk will be used. If an image template is specified the disk capacity will be be provided by the template. + Example: ``` 'blockDevices':[{'device': '0', 'diskImage': {'capacity': 100}}], 'localDiskFlag': true ``` + See [SoftLayer_Virtual_Guest::getCreateObjectOptions](/reference/services/SoftLayer_Virtual_Guest/getCreateObjectOptions) for available options. - `userData.value` String + Arbitrary data to be made available to the computing instance. + The `userData` property is an array with a single [SoftLayer_Virtual_Guest_Attribute](/reference/datatypes/SoftLayer_Virtual_Guest_Attribute) structure with the `value` property set to an arbitrary value. This value can be retrieved via the [SoftLayer_Resource_Metadata::getUserMetadata](/reference/services/SoftLayer_Resource_Metadata/getUserMetadata) method from a request originating from the computing instance. This is primarily useful for providing data to software that may be on the instance and configured to execute upon first boot. + Example: `'userData':[{'value': 'testData'}]` - `sshKeys` [SoftLayer_Security_Ssh_Key](/reference/datatypes/SoftLayer_Security_Ssh_Key)[] + The `sshKeys` property is an array of [SoftLayer_Security_Ssh_Key](/reference/datatypes/SoftLayer_Security_Ssh_Key) structures with the `id` property set to the value of an existing SSH key. + To create a new SSH key, call [SoftLayer_Security_Ssh_Key::createObject](/reference/services/SoftLayer_Security_Ssh_Key/createObject). + To obtain a list of existing SSH keys, call [SoftLayer_Account::getSshKeys](/reference/services/SoftLayer_Account/getSshKeys) + Example: `'sshKeys':[{'id': 1234567}]` - `postInstallScriptUri` String + Specifies the uri location of the script to be downloaded and run after installation is complete. Only scripts from HTTPS servers are executed on startup. REST Example: ``` curl -X POST -d '{ 'parameters':[ { 'hostname': 'host1', 'domain': 'example.com', 'startCpus': 1, 'maxMemory': 1024, 'hourlyBillingFlag': true, 'localDiskFlag': true, 'operatingSystemReferenceCode': 'UBUNTU_LATEST' } }' https://api.softlayer.com/rest/v3.1/SoftLayer_Virtual_Guest/createObject.json HTTP/1.1 201 Created Location: https://api.softlayer.com/rest/v3.1/SoftLayer_Virtual_Guest/1301396/getObject { 'accountId': 232298, 'createDate': '2012-11-30T16:28:17-06:00', 'dedicatedAccountHostOnlyFlag': false, 'domain': 'example.com', 'hostname': 'host1', 'id': 1301396, 'lastPowerStateId': null, 'lastVerifiedDate': null, 'maxCpu': 1, 'maxCpuUnits': 'CORE', 'maxMemory': 1024, 'metricPollDate': null, 'modifyDate': null, 'privateNetworkOnlyFlag': false, 'startCpus': 1, 'statusId': 1001, 'globalIdentifier': '2d203774-0ee1-49f5-9599-6ef67358dd31' } ```
    • createObject
      Create a boot parameter record to be used at next boot
    • createObject
      Add a placement group to your account for use during VSI provisioning.
    • createObject
      Creates a new Citrix Virtual Apps and Desktops deployment.
    • createObject
      This will add the resource into CVAD deployment.
    • createObjects
      Edit multiple [SoftLayer_Account_Regional_Registry_Detail_Property](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail_Property) objects.
    • createObjects
      Create a new shipment tracking data. The ''shipmentId'', ''sequence'', and ''trackingData'' properties of each templateObject in the templateObjects array are required parameters to create a tracking data record.
    • createObjects
      Create multiple domains on the SoftLayer name servers. Each domain record passed to ''createObjects'' follows the logic in the SoftLayer_Dns_Domain ''createObject'' method.
    • createObjects
      Create multiple resource records on a domain. This follows the same logic as ''createObject'. The serial number of the domain associated with this resource record is updated upon creation. ''createObjects'' returns Boolean ''true'' on successful creation or ''false'' if it was unable to create a resource record.
    • createObjects
      Create multiple MX records on a domain. This follows the same logic as ''createObject'. The serial number of the domain associated with this MX record is updated upon creation. ''createObjects'' returns Boolean ''true'' on successful creation or ''false'' if it was unable to create a resource record.
    • createObjects
      Create multiple SRV records on a domain. This follows the same logic as ''createObject'. The serial number of the domain associated with this SRV record is updated upon creation. ''createObjects'' returns Boolean ''true'' on successful creation or ''false'' if it was unable to create a resource record.
    • createObjects
      Create multiple secondary DNS records. Each record passed to ''createObjects'' follows the logic in the SoftLayer_Dns_Secondary [SoftLayer_Dns_Secondary::createObject](/reference/datatypes/$1/#$2) method.
    • createObjects
      Create multiple new hardware members on the gateway. This also asynchronously sets up the network for the members. Progress of this process can be monitored via the gateway status. All members created with this object must have no VLANs attached.
    • createObjects
      Create multiple new VLAN attachments. If the bypassFlag is false, this will also create an asynchronous process to route the VLANs through the gateway.
    • createObjects
      Passing in a collection of unsaved instances of Query_Host objects into this function will create all objects and return the results to the user.
    • createObjects
      Create new security groups.
    • createObjects
      Create Softlayer portal user VPN overrides.
    • createObjects
      Create registrations with respective registrars to associate multiple assigned subnets with the provided contact details.
    • createObjects
      Create more than one password for a software component.
    • createObjects
      Passing in a collection of unsaved instances of Customer_Notification_Hardware objects into this function will create all objects and return the results to the user.
    • createObjects
      Passing in a collection of unsaved instances of SoftLayer_Customer_Notification_Virtual_Guest objects into this function will create all objects and return the results to the user.
    • createObjects
      createObjects() enables the creation of multiple computing instances on an account in a single call. This method is a simplified alternative to interacting with the ordering system directly. In order to create a computing instance a set of template objects must be sent in with a few required values. <b>Warning:</b> Computing instances created via this method will incur charges on your account. See [SoftLayer_Virtual_Guest::createObject](/reference/services/SoftLayer_Virtual_Guest/createObject) for specifics on the requirements of each template object. <h1>Example</h1> <http title='Request'>curl -X POST -d '{ 'parameters':[ [ { 'hostname': 'host1', 'domain': 'example.com', 'startCpus': 1, 'maxMemory': 1024, 'hourlyBillingFlag': true, 'localDiskFlag': true, 'operatingSystemReferenceCode': 'UBUNTU_LATEST' }, { 'hostname': 'host2', 'domain': 'example.com', 'startCpus': 1, 'maxMemory': 1024, 'hourlyBillingFlag': true, 'localDiskFlag': true, 'operatingSystemReferenceCode': 'UBUNTU_LATEST' } ] ] }' https://api.softlayer.com/rest/v3/SoftLayer_Virtual_Guest/createObjects.json </http> <http title='Response'>HTTP/1.1 200 OK [ { 'accountId': 232298, 'createDate': '2012-11-30T23:56:48-06:00', 'dedicatedAccountHostOnlyFlag': false, 'domain': 'softlayer.com', 'hostname': 'ubuntu1', 'id': 1301456, 'lastPowerStateId': null, 'lastVerifiedDate': null, 'maxCpu': 1, 'maxCpuUnits': 'CORE', 'maxMemory': 1024, 'metricPollDate': null, 'modifyDate': null, 'privateNetworkOnlyFlag': false, 'startCpus': 1, 'statusId': 1001, 'globalIdentifier': 'fed4c822-48c0-45d0-85e2-90476aa0c542' }, { 'accountId': 232298, 'createDate': '2012-11-30T23:56:49-06:00', 'dedicatedAccountHostOnlyFlag': false, 'domain': 'softlayer.com', 'hostname': 'ubuntu2', 'id': 1301457, 'lastPowerStateId': null, 'lastVerifiedDate': null, 'maxCpu': 1, 'maxCpuUnits': 'CORE', 'maxMemory': 1024, 'metricPollDate': null, 'modifyDate': null, 'privateNetworkOnlyFlag': false, 'startCpus': 1, 'statusId': 1001, 'globalIdentifier': 'bed4c686-9562-4ade-9049-dc4d5b6b200c' } ] </http>
    • createOpenIdConnectUserAndCompleteInvitation
      Completes invitation processing when a new OpenIdConnect user must be created.
    • createOpenIdConnectUserAndCompleteInvitation
      Completes invitation processing when a new OpenIdConnect user must be created.
    • createOriginPath
      SOAP API will create Origin Path for an existing CDN mapping and for a particular customer.
    • createOrUpdateLunId
      The LUN ID only takes effect during the Host Authorization process. It is required to de-authorize all hosts before using this method.
    • createOrUpdateLunId
      The LUN ID only takes effect during the Host Authorization process. It is required to de-authorize all hosts before using this method.
    • createOrUpdateLunId
      The LUN ID only takes effect during the Host Authorization process. It is required to de-authorize all hosts before using this method.
    • createOSDomain
    • createOSProject
    • createPostSoftwareInstallTransaction
    • createPostSoftwareInstallTransaction
    • createPostSoftwareInstallTransaction
    • createPostSoftwareInstallTransaction
    • createProspect
      Create a new Referral Partner Prospect
    • createPtrRecord
      setPtrRecordForIpAddress() sets a single reverse DNS record for a single IP address and returns the newly created or edited [SoftLayer_Dns_Domain_ResourceRecord](/reference/datatypes/SoftLayer_Dns_Domain_ResourceRecord) record. Currently this method only supports IPv4 addresses and performs no operation when given an IPv6 address.
    • createPublicArchiveTransaction
      Create a transaction to copy archived block devices into public repository
    • createPurge
      This method creates a purge record in the purge table, and also initiates the create purge call.
    • createPurgeGroup
      This method creates a purge group record in the table, and also initiates the purge action based on the input option value. The unsaved groups will be deleted after 15 days if no purge actions executed. The possible input option value can be: 1: (Default) Only purge the paths in the group, don't save the group as favorite. 2: Only save the group as favorite, don't purge the paths. 3: Save the group as favorite and also purge the paths in the group.
    • createRequest
    • createResourceLocation
    • createReverseDomainRecords
      Create the default PTR records for this subnet
    • createSnapshot
      Manually create a new snapshot of a storage volume.
    • createSnapshot
      Manually create a new snapshot of a storage volume.
    • createSnapshot
      Manually create a new snapshot of a storage volume.
    • createSpfRecord
      Create an SPF record on a SoftLayer domain. This is a shortcut method, meant to take the work out of creating a SoftLayer_Dns_Domain_ResourceRecord if you already have a domain record available. createARecord returns the newly created SoftLayer_Dns_Domain_ResourceRecord_SpfType.
    • createStandardTicket
      Create a standard support ticket. Use a standard support ticket if you need to work out a problem related to SoftLayer's hardware, network, or services. If you require SoftLayer's assistance managing your server or content then please open an administrative 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](/reference/datatypes/SoftLayer_Ticket_Update) entries are added to the ticket object.
    • createSubnetRouteUpdateTransaction
      ***DEPRECATED*** This endpoint is deprecated in favor of the more expressive and capable SoftLayer_Network_Subnet::route, to which this endpoint now proxies. Refer to it for more information. Similarly, unroute requests are proxied to SoftLayer_Network_Subnet::clearRoute.
    • createSubscriberDeliveryMethods
      Create delivery methods for a notification that the user is subscribed to. Multiple delivery method keyNames can be supplied to create multiple delivery methods for the specified notification. Available delivery methods - 'EMAIL'. Available notifications - 'PLANNED_MAINTENANCE', 'UNPLANNED_INCIDENT'.
    • createSubscriberDeliveryMethods
      Create delivery methods for a notification that the user is subscribed to. Multiple delivery method keyNames can be supplied to create multiple delivery methods for the specified notification. Available delivery methods - 'EMAIL'. Available notifications - 'PLANNED_MAINTENANCE', 'UNPLANNED_INCIDENT'.
    • createSubscriberDeliveryMethods
      Create delivery methods for a notification that the user is subscribed to. Multiple delivery method keyNames can be supplied to create multiple delivery methods for the specified notification. Available delivery methods - 'EMAIL'. Available notifications - 'PLANNED_MAINTENANCE', 'UNPLANNED_INCIDENT'.
    • createSubscriberForMobileDevice
      Create a new subscriber for a given resource.
    • createSwipTransaction
      ***DEPRECATED*** This function is used to create a new SoftLayer SWIP transaction to register your RWHOIS data with ARIN. SWIP transactions can only be initiated on subnets that contain more than 8 IP addresses.
    • createTimeToLive
      Creates a Time To Live object and inserts it into the database
    • createTokenAuthPath
      SOAP API will create Token authentication Path for an existing CDN mapping and for a particular customer.
    • createTranscodeAccount
      With this method, you can create a transcode account. Individual SoftLayer account can have a single Transcode account. You have to pass your SoftLayer account id as a parameter.
    • createTranscodeJob
      '''Note'''. This method is obsolete. Please use the [SoftLayer_Network_Media_Transcode_Job::createObject](/reference/datatypes/$1/#$2) method on SoftLayer_Network_Media_Transcode_Job object instead. SoftLayer_Network_Media_Transcode_Job::createObject returns an object of a newly created Transcode Job. With this method, you can create a transcode job. The very first step of creating a transcode job is to upload your media files to the /in directory on your Transcode FTP space. Then, you have to pass a [SoftLayer_Network_Media_Transcode_Job](/reference/datatypes/SoftLayer_Network_Media_Transcode_Job) object as a parameter for this method. There are 4 required properties of SoftLayer_Network_Media_Transcode_Job object: transcodePresetName, transcodePresetGuid, inputFile, and outputFile. A transcode preset is a configuration that defines a certain media output. You can retrieve all the supported presets with the [SoftLayer_Network_Media_Transcode_Account::getPresets](/reference/datatypes/$1/#$2) method. You can also use [SoftLayer_Network_Media_Transcode_Account::getPresetDetail](/reference/datatypes/$1/#$2) method to get more information on a preset. Use these two methods to determine appropriate values for 'transcodePresetName' and 'transcodePresetGuid' properties. For an 'inputFile', you must specify a file that exists in the /in directory of your Transcode FTP space. An 'outputFile' name will be used by the Transcode server for naming a transcoded file. An output file name must be in /out directory. If your outputFile name already exists in the /out directory, the Transcode server will append a file name with _n (an underscore and the total number of files with the identical name plus 1). The 'name' property is optional and it can help you keep track of transcode jobs easily. 'autoDeleteDuration' is another optional property that you can specify. It determines how soon your input file will be deleted. If autoDeleteDuration is set to zero, your input file will be removed immediately after the last transcode job running on it is completed. A value for autoDeleteDuration property is in seconds and the maximum value is 259200 which is 3 days. An example SoftLayer_Network_Media_Transcode_Job parameter looks like this: * name: My transcoding * transcodePresetName: F4V 896kbps 640x352 16x9 29.97fps * transcodePresetGuid: {87E01268-C3E3-4A85-9701-052C9AC42BD4} * inputFile: /in/my_birthday.wmv * outputFile: /out/my_birthday_flash Notice that an output file does not have a file extension. The Transcode server will append a file extension based on an output format. A newly created transcode job will be in 'Pending' status and it will be added to the Transcoding queue. You will receive a notification email whenever there is a status change on your transcode job. For example, the Transcode server starts to process your transcode job, you will be notified via an email. You can add up to 3 pending jobs at a time. Transcode jobs with any other status such as 'Complete' or 'Error' will not be counted toward your pending jobs. Once a job is complete, the Transcode server will place the output file into the /out directory along with a notification email. The files in the /out directory will be removed 3 days after they were created. You will need to use an FTP client to download transcoded files.
    • createTxtRecord
      Create a TXT record on a SoftLayer domain. This is a shortcut method, meant to take the work out of creating a SoftLayer_Dns_Domain_ResourceRecord if you already have a domain record available. createARecord returns the newly created SoftLayer_Dns_Domain_ResourceRecord_TxtType.
    • createUpgradeTicket
      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 or CloudLayer Computing Instance 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.
    • createUser
      Create a new Customer user record in the SoftLayer customer portal. This is a wrapper around the Customer::createObject call, please see the documentation of that API. This wrapper adds the feature of the 'silentlyCreate' option, which bypasses the IBMid invitation email process. False (the default) goes through the IBMid invitation email process, which creates the IBMid/SoftLayer Single-Sign-On (SSO) user link when the invitation is accepted (meaning the email has been received, opened, and the link(s) inside the email have been clicked to complete the process). True will silently (no email) create the IBMid/SoftLayer user SSO link immediately. Either case will use the value in the template object 'email' field to indicate the IBMid to use. This can be the username or, if unique, the email address of an IBMid. In the silent case, the IBMid must already exist. In the non-silent invitation email case, the IBMid can be created during this flow, by specifying an email address to be used to create the IBMid.All the features and restrictions of createObject apply to this API as well. In addition, note that the 'silentlyCreate' flag is ONLY valid for IBMid-authenticated accounts.
    • credentialCreate
      Create credentials for an IBM Cloud Object Storage Account
    • credentialDelete
      Delete a credential
    • deactivate
    • deactivateNotificationSubscriber
      Create a new subscriber for a given resource.
    • deactivateNotificationSubscriber
      Create a new subscriber for a given resource.
    • deactivateNotificationSubscriber
      Create a new subscriber for a given resource.
    • declineInvitation
      Declines an invitation to link an OpenIdConnect identity to a SoftLayer (Atlas) identity and account. Note that this uses a registration code that is likely a one-time-use-only token, so if an invitation has already been processed (accepted or previously declined) it will not be possible to process it a second time.
    • declineInvitation
      Declines an invitation to link an OpenIdConnect identity to a SoftLayer (Atlas) identity and account. Note that this uses a registration code that is likely a one-time-use-only token, so if an invitation has already been processed (accepted or previously declined) it will not be possible to process it a second time.
    • deleteAddressTranslation
      Remove an existing address translation from a network tunnel. Address translations deliver packets to a destination ip address that is on a customer subnet (remote). NOTE: A network tunnel's configurations must be applied to the network device in order for an address translation to be deleted.
    • deleteAllFiles
      {{CloudLayerOnlyMethod}} Delete all files within a Storage account. Depending on the type of Storage account, Deleting either deletes files permanently or sends files to your account's recycle bin. Currently, Virtual Server storage is the only type of Storage account that sends files to a recycle bin when deleted. When called against a Virtual Server storage account , this method also determines if the files are in the account's recycle bin. If the files exist in the recycle bin, then they are permanently deleted. Please note, files can not be restored once they are permanently deleted.
    • deleteAllFiles
      {{CloudLayerOnlyMethod}} Delete all files within a Storage account. Depending on the type of Storage account, Deleting either deletes files permanently or sends files to your account's recycle bin. Currently, Virtual Server storage is the only type of Storage account that sends files to a recycle bin when deleted. When called against a Virtual Server storage account , this method also determines if the files are in the account's recycle bin. If the files exist in the recycle bin, then they are permanently deleted. Please note, files can not be restored once they are permanently deleted.
    • deleteAllFiles
      {{CloudLayerOnlyMethod}} Delete all files within a Storage account. Depending on the type of Storage account, Deleting either deletes files permanently or sends files to your account's recycle bin. Currently, Virtual Server storage is the only type of Storage account that sends files to a recycle bin when deleted. When called against a Virtual Server storage account , this method also determines if the files are in the account's recycle bin. If the files exist in the recycle bin, then they are permanently deleted. Please note, files can not be restored once they are permanently deleted.
    • deleteByolAttribute
      This method allows you to remove BYOL attribute for a given image template.
    • deleteCart
      If a cart is no longer needed, it can be deleted using this service. Once a cart has been deleted, it cannot be retrieved again.
    • deleteCloudInitAttribute
      This method allows you to remove cloud init attribute for a given image template.
    • deleteConnection
    • deleteDomainMapping
      SOAP API will delete CDN domain mapping for a particular customer.
    • deleteEmailListEntries
    • deleteFile
      {{CloudLayerOnlyMethod}} Delete an individual file within a Storage account. Depending on the type of Storage account, Deleting a file either deletes the file permanently or sends the file to your account's recycle bin. Currently, Virtual Server storage is the only type of Storage account that sends files to a recycle bin when deleted. When called against a Virtual Server storage account , this method also determines if the file is in the account's recycle bin. If the file exist in the recycle bin, then it is permanently deleted. Please note, a file can not be restored once it is permanently deleted.
    • deleteFile
      {{CloudLayerOnlyMethod}} Delete an individual file within a Storage account. Depending on the type of Storage account, Deleting a file either deletes the file permanently or sends the file to your account's recycle bin. Currently, Virtual Server storage is the only type of Storage account that sends files to a recycle bin when deleted. When called against a Virtual Server storage account , this method also determines if the file is in the account's recycle bin. If the file exist in the recycle bin, then it is permanently deleted. Please note, a file can not be restored once it is permanently deleted.
    • deleteFile
      {{CloudLayerOnlyMethod}} Delete an individual file within a Storage account. Depending on the type of Storage account, Deleting a file either deletes the file permanently or sends the file to your account's recycle bin. Currently, Virtual Server storage is the only type of Storage account that sends files to a recycle bin when deleted. When called against a Virtual Server storage account , this method also determines if the file is in the account's recycle bin. If the file exist in the recycle bin, then it is permanently deleted. Please note, a file can not be restored once it is permanently deleted.
    • deleteFiles
      {{CloudLayerOnlyMethod}} Delete multiple files within a Storage account. Depending on the type of Storage account, Deleting either deletes files permanently or sends files to your account's recycle bin. Currently, Virtual Server storage is the only type of Storage account that sends files to a recycle bin when deleted. When called against a Virtual Server storage account , this method also determines if the files are in the account's recycle bin. If the files exist in the recycle bin, then they are permanently deleted. Please note, files can not be restored once they are permanently deleted.
    • deleteFiles
      {{CloudLayerOnlyMethod}} Delete multiple files within a Storage account. Depending on the type of Storage account, Deleting either deletes files permanently or sends files to your account's recycle bin. Currently, Virtual Server storage is the only type of Storage account that sends files to a recycle bin when deleted. When called against a Virtual Server storage account , this method also determines if the files are in the account's recycle bin. If the files exist in the recycle bin, then they are permanently deleted. Please note, files can not be restored once they are permanently deleted.
    • deleteFiles
      {{CloudLayerOnlyMethod}} Delete multiple files within a Storage account. Depending on the type of Storage account, Deleting either deletes files permanently or sends files to your account's recycle bin. Currently, Virtual Server storage is the only type of Storage account that sends files to a recycle bin when deleted. When called against a Virtual Server storage account , this method also determines if the files are in the account's recycle bin. If the files exist in the recycle bin, then they are permanently deleted. Please note, files can not be restored once they are permanently deleted.
    • deleteFolder
      Delete a folder in the root directory.
    • deleteFolder
      Delete a folder in the root directory.
    • deleteFolder
      Delete a folder in the root directory.
    • deleteGeoblocking
    • deleteHotlinkProtection
    • deleteL7PoolMembers
      Delete given members from load balancer and return load balancer object with listeners, pools and members populated
    • deleteL7Rules
      This function deletes multiple rules aassociated with the same policy.
    • deleteLiveLoadBalancer
      Remove a virtual IP address from an application delivery controller based load balancer. Only the ''name'' property in the loadBalancer parameter must be populated. Changes are reflected immediately in the application delivery controller.
    • deleteLiveLoadBalancerService
      Remove an entire load balancer service, including all virtual IP addresses, from and application delivery controller based load balancer. The ''name'' property the and ''name'' property within the ''vip'' property of the service parameter must be provided. Changes are reflected immediately in the application delivery controller.
    • deleteLoadBalancerMembers
      Delete given members from load balancer and return load balancer object with listeners, pools and members populated
    • deleteLoadBalancerProtocols
      Delete load balancers front- and backend protocols and return load balancer object with listeners (frontend), pools (backend), server instances (members) and datacenter populated.
    • deleteModifyResponseHeader
      SOAP API will delete modify response header for an existing mapping and for a particular customer.
    • deleteObject
      deleteObject permanently removes an account affiliation
    • deleteObject
    • deleteObject
      deleteObject permanently removes an account contact
    • deleteObject
      deleteObject permanently removes an account link and all of it's associated keystone data (including users for the associated project). '''This cannot be undone.''' Be wary of running this method. If you remove an account link in error you will need to re-create it by creating a new SoftLayer_Account_Link_OpenStack object.
    • deleteObject
    • deleteObject
      This method will delete an existing SoftLayer_Account_Regional_Registry_Detail object.
    • deleteObject
      This method will delete an existing SoftLayer_Account_Regional_Registry_Detail_Property object.
    • deleteObject
      deleteObject permanently removes a shipment tracking datum (number)
    • deleteObject
      Deletes a customer configuration template.
    • deleteObject
      deleteObject permanently removes a domain and all of it's associated resource records from the softlayer name servers. '''This cannot be undone.''' Be wary of running this method. If you remove a domain in error you will need to re-create it by creating a new SoftLayer_Dns_Domain object.
    • deleteObject
      Delete a domain's resource record. '''This cannot be undone.''' Be wary of running this method. If you remove a resource record in error you will need to re-create it by creating a new SoftLayer_Dns_Domain_ResourceRecord object. The serial number of the domain associated with this resource record is updated upon deletion. You may not delete SOA, NS, or PTR resource records. ''deleteObject'' returns Boolean ''true'' on successful deletion or ''false'' if it was unable to remove a resource record.
    • deleteObject
      Delete a domain's MX record. '''This cannot be undone.''' Be wary of running this method. If you remove a resource record in error you will need to re-create it by creating a new SoftLayer_Dns_Domain_ResourceRecord_MxType object. The serial number of the domain associated with this MX record is updated upon deletion. ''deleteObject'' returns Boolean ''true'' on successful deletion or ''false'' if it was unable to remove a resource record.
    • deleteObject
      Delete a domain's SRV record. '''This cannot be undone.''' Be wary of running this method. If you remove a resource record in error you will need to re-create it by creating a new SoftLayer_Dns_Domain_ResourceRecord_SrvType object. The serial number of the domain associated with this SRV record is updated upon deletion. ''deleteObject'' returns Boolean ''true'' on successful deletion or ''false'' if it was unable to remove a resource record.
    • deleteObject
      Delete a secondary DNS Record. This will also remove any associated domain records and resource records on the SoftLayer nameservers that were created as a result of the zone transfers. This action cannot be undone.
    • deleteObject
      This method will cancel a server effective immediately. For servers billed hourly, the charges will stop immediately after the method returns.
    • deleteObject
      This method will cancel a server effective immediately. For servers billed hourly, the charges will stop immediately after the method returns.
    • deleteObject
      This method will cancel a server effective immediately. For servers billed hourly, the charges will stop immediately after the method returns.
    • deleteObject
      This method will cancel a server effective immediately. For servers billed hourly, the charges will stop immediately after the method returns.
    • deleteObject
      This method will cancel a server effective immediately. For servers billed hourly, the charges will stop immediately after the method returns.
    • deleteObject
      This method deletes an existing layout profile and associated custom preferences
    • deleteObject
      This method deletes an existing layout profile and associated custom preferences
    • deleteObject
      deleteObject permanently removes a configuration history record
    • deleteObject
    • deleteObject
    • deleteObject
      Start the asynchronous process to detach this VLANs from the gateway.
    • deleteObject
      Deletes a l7 policy instance and the rules associated with the policy
    • deleteObject
      Deletes an existing L7 pool along with L7 members, L7 health monitor, and L7 session affinity.
    • deleteObject
      The global load balancer service has been deprecated and is no longer available. Remove a host from the load balancing pool of a global load balancer account.
    • deleteObject
      Calling deleteObject on a particular server will remove it from the load balancer. This is the only way to remove a service from your load balancer. If you wish to remove a server, first call this function, then reload the virtualIpAddress object and edit the remaining services to reflect the other changes that you wish to make.
    • deleteObject
      Like any other API object, the monitoring objects can be deleted by passing an instance of them into this function. The ID on the object must be set.
    • deleteObject
      Delete a security group for an account. A security group cannot be deleted if any network components are attached or if the security group is a remote security group for a [SoftLayer_Network_SecurityGroup_Rule](/reference/datatypes/SoftLayer_Network_SecurityGroup_Rule).
    • deleteObject
      Use this method to delete a single SoftLayer portal VPN user subnet override.
    • deleteObject
      Delete a network storage volume. '''This cannot be undone.''' At this time only network storage snapshots may be deleted with this method. ''deleteObject'' returns Boolean ''true'' on successful deletion or ''false'' if it was unable to remove a volume;
    • deleteObject
      Delete a network storage volume. '''This cannot be undone.''' At this time only network storage snapshots may be deleted with this method. ''deleteObject'' returns Boolean ''true'' on successful deletion or ''false'' if it was unable to remove a volume;
    • deleteObject
    • deleteObject
    • deleteObject
    • deleteObject
      Delete a network storage volume. '''This cannot be undone.''' At this time only network storage snapshots may be deleted with this method. ''deleteObject'' returns Boolean ''true'' on successful deletion or ''false'' if it was unable to remove a volume;
    • deleteObject
      Delete a network storage schedule. '''This cannot be undone.''' ''deleteObject'' returns Boolean ''true'' on successful deletion or ''false'' if it was unable to remove a schedule;
    • deleteObject
      This method will delete an existing SoftLayer_Account_Regional_Registry_Detail object.
    • deleteObject
    • deleteObject
      Remove a certificate from your account. You may not remove a certificate with associated services.
    • deleteObject
      Remove a ssh key from your account.
    • deleteObject
      Delete a password from a software component.
    • deleteObject
      Delete an external authentication binding. If the external binding currently has an active billing item associated you will be prevented from deleting the binding. The alternative method to remove an external authentication binding is to use the service cancellation form.
    • deleteObject
      Delete an external authentication binding. If the external binding currently has an active billing item associated you will be prevented from deleting the binding. The alternative method to remove an external authentication binding is to use the service cancellation form.
    • deleteObject
      Delete a VeriSign external binding. The only VeriSign external binding that can be deleted through this method is the free VeriSign external binding for the master user of a SoftLayer account. All other external bindings must be canceled using the SoftLayer service cancellation form. When a VeriSign external binding is deleted the credential is deactivated in VeriSign's system for use on the SoftLayer site and the $0 billing item associated with the free VeriSign external binding is cancelled.
    • deleteObject
      Delete a mobile device association for a user.
    • deleteObject
      Delete an external authentication binding. If the external binding currently has an active billing item associated you will be prevented from deleting the binding. The alternative method to remove an external authentication binding is to use the service cancellation form.
    • deleteObject
      Customer users can only delete permission groups of type NORMAL. The SYSTEM type is reserved for internal use. The user who is creating the permission group must have the permission to manage users.
    • deleteObject
      Customer users can only delete permission roles with systemFlag set to false. The SYSTEM type is reserved for internal use. The user who is creating the permission role must have the permission to manage users.
    • deleteObject
    • deleteObject
    • deleteObject
      This method will cancel a dedicated host immediately.
    • deleteObject
      This method will cancel a computing instance effective immediately. For instances billed hourly, the charges will stop immediately after the method returns.
    • deleteObject
      Deleting a block device template group is different from the deletion of other objects. A block device template group can contain several gigabytes of data in its disk images. This may take some time to delete and requires a transaction to be created. This method creates a transaction that will delete all resources associated with the block device template group.
    • deleteObject
      Removes a boot parameter
    • deleteObject
      Delete a placement group from your account.
    • deleteObjects
      Remove multiple resource records from a domain. This follows the same logic as ''deleteObject'' and '''cannot be undone'''. The serial number of the domain associated with this resource record is updated upon deletion. You may not delete SOA records, PTR records, or NS resource records that point to ns1.softlayer.com or ns2.softlayer.com. ''deleteObjects'' returns Boolean ''true'' on successful deletion or ''false'' if it was unable to remove a resource record.
    • deleteObjects
      Remove multiple MX records from a domain. This follows the same logic as ''deleteObject'' and '''cannot be undone'''. The serial number of the domain associated with this MX record is updated upon deletion. ''deleteObjects'' returns Boolean ''true'' on successful deletion or ''false'' if it was unable to remove a resource record.
    • deleteObjects
      Remove multiple SRV records from a domain. This follows the same logic as ''deleteObject'' and '''cannot be undone'''. The serial number of the domain associated with this SRV record is updated upon deletion. ''deleteObjects'' returns Boolean ''true'' on successful deletion or ''false'' if it was unable to remove a resource record.
    • deleteObjects
      Detach several VLANs. This will not detach them right away, but rather start an asynchronous process to detach.
    • deleteObjects
      Like any other API object, the monitoring objects can be deleted by passing an instance of them into this function. The ID on the object must be set.
    • deleteObjects
      Delete security groups for an account. A security group cannot be deleted if any network components are attached or if the security group is a remote security group for a [SoftLayer_Network_SecurityGroup_Rule](/reference/datatypes/SoftLayer_Network_SecurityGroup_Rule).
    • deleteObjects
      Use this method to delete a collection of SoftLayer portal VPN user subnet overrides.
    • deleteObjects
      Delete more than one passwords from a software component.
    • deleteObjects
      Like any other API object, the customer notification objects can be deleted by passing an instance of them into this function. The ID on the object must be set.
    • deleteObjects
      Like any other API object, the customer notification objects can be deleted by passing an instance of them into this function. The ID on the object must be set.
    • deleteOriginPath
      SOAP API will delete Origin Path for an existing mapping and for a particular customer.
    • deleteOSDomain
    • deleteOSProject
    • deleteQuote
      Account master users and sub-users in the SoftLayer customer portal can delete the quote of an order.
    • deleteQuote
      Account master users and sub-users in the SoftLayer customer portal can delete the quote of an order.
    • deleteRegisteredNameserver
      The deleteRegisteredNameserver method deletes a nameserver that was registered, provided it is not currently serving a domain
    • deleteSoftwareComponentPasswords
      Delete software component passwords.
    • deleteSoftwareComponentPasswords
      Delete software component passwords.
    • deleteSoftwareComponentPasswords
      Delete software component passwords.
    • deleteSoftwareComponentPasswords
      Delete software component passwords.
    • deleteSoftwareComponentPasswords
      Delete software component passwords.
    • deleteTag
      Delete an existing tag. If there are any references on the tag, an exception will be thrown.
    • deleteTag
      Delete an existing tag. If there are any references on the tag, an exception will be thrown.
    • deleteTag
      Delete an existing tag. If there are any references on the tag, an exception will be thrown.
    • deleteTag
      Delete an existing tag. If there are any references on the tag, an exception will be thrown.
    • deleteTag
      Delete an existing tag. If there are any references on the tag, an exception will be thrown.
    • deleteTag
      Delete a tag for an object.
    • deleteTag
      Delete a tag
    • deleteTasks
      This method can be used to help maintain the storage space on a vault. When a job is removed from the Webcc, the task and stored usage still exists on the vault. This method can be used to delete the associated task and its usage. All that is required for the use of the method is to pass in an integer array of task(s).
    • deleteTimeToLive
    • deleteTokenAuthPath
      SOAP API will delete token authentication Path for an existing mapping and for a particular customer.
    • deleteTransientWebhook
    • denyReview
      Allows verified reviewer to deny a request
    • denySharingAccess
      This method will deny another SoftLayer customer account's previously given access to provision CloudLayer Computing Instances from an image template group. Template access should only be removed from the parent template group object, not the child.
    • detachDiskImage
      Creates a transaction to detach a guest's disk image. If the disk image is already detached it will be ignored. WARNING: The transaction created by this service will shut down the guest while the disk image is attached. The guest will be turned back on once this process is complete.
    • detachNetworkComponents
      Detach virtual guest network components from a security group by deleting its [SoftLayer_Virtual_Network_SecurityGroup_NetworkComponentBinding](/reference/datatypes/SoftLayer_Virtual_Network_SecurityGroup_NetworkComponentBinding).
    • disable
      Disable email subscription.
    • disable
      Disable a Virtual IP Address, removing it from load balancer rotation and denying all connections to that IP address.
    • disable
      Disabling an external binding will allow you to keep the external binding on your SoftLayer account, but will not require you to authentication with our trusted 2 form factor vendor when logging into the SoftLayer customer portal. You may supply one of the following reason when you disable an external binding: *Unspecified *TemporarilyUnavailable *Lost *Stolen
    • disable
      Disabling an external binding will allow you to keep the external binding on your SoftLayer account, but will not require you to authentication with our trusted 2 form factor vendor when logging into the SoftLayer customer portal. You may supply one of the following reason when you disable an external binding: *Unspecified *TemporarilyUnavailable *Lost *Stolen
    • disable
      Disabling an external binding will allow you to keep the external binding on your SoftLayer account, but will not require you to authentication with our trusted 2 form factor vendor when logging into the SoftLayer customer portal. You may supply one of the following reason when you disable an external binding: *Unspecified *TemporarilyUnavailable *Lost *Stolen
    • disable
      Completely restrict all incoming and outgoing bandwidth traffic to a network component
    • disableAccount
      Disable an account associated with this Brand. Anything that would disqualify the account from being disabled will cause an exception to be raised.
    • disableEuSupport
      <p style='color:red'><strong>Warning</strong>: If you remove the EU Supported account flag, you are removing the restriction that limits Processing activities to EU personnel.</p>
    • disableLockedAccount
      Takes the original lockdown request ID, and an optional disable date. If no date is passed with the API call, the account will be disabled immediately. Otherwise, the account will be disabled on the date given. All hardware will be reclaimed and all accounts permanently disabled.
    • disableSmtpAccess
    • disableSnapshots
      This method is not valid for Legacy iSCSI Storage Volumes. Disable scheduled snapshots of this storage volume. Scheduling options include 'INTERVAL', HOURLY, DAILY and WEEKLY schedules.
    • disableSnapshots
      This method is not valid for Legacy iSCSI Storage Volumes. Disable scheduled snapshots of this storage volume. Scheduling options include 'INTERVAL', HOURLY, DAILY and WEEKLY schedules.
    • disableSnapshots
      This method is not valid for Legacy iSCSI Storage Volumes. Disable scheduled snapshots of this storage volume. Scheduling options include 'INTERVAL', HOURLY, DAILY and WEEKLY schedules.
    • disableVpnConfigRequiresVpnManageAttribute
      Disables the VPN_CONFIG_REQUIRES_VPN_MANAGE attribute on the account. If the attribute does not exist for the account, it will be created and set to false.
    • disasterRecoveryFailoverToReplicant
      If a volume (with replication) becomes inaccessible due to a disaster event, this method can be used to immediately failover to an available replica in another location. This method does not allow for fail back via the API. To fail back to the original volume after using this method, open a support ticket. To test failover, use [SoftLayer_Network_Storage::failoverToReplicant](/reference/datatypes/$1/#$2) instead.
    • disasterRecoveryFailoverToReplicant
      If a volume (with replication) becomes inaccessible due to a disaster event, this method can be used to immediately failover to an available replica in another location. This method does not allow for fail back via the API. To fail back to the original volume after using this method, open a support ticket. To test failover, use [SoftLayer_Network_Storage::failoverToReplicant](/reference/datatypes/$1/#$2) instead.
    • disasterRecoveryFailoverToReplicant
      If a volume (with replication) becomes inaccessible due to a disaster event, this method can be used to immediately failover to an available replica in another location. This method does not allow for fail back via the API. To fail back to the original volume after using this method, open a support ticket. To test failover, use [SoftLayer_Network_Storage::failoverToReplicant](/reference/datatypes/$1/#$2) instead.
    • disconnectCompute
      Takes an account ID and an optional disconnect date. If no disconnect date is passed into the API call, the account disconnection will happen immediately. Otherwise, the account disconnection will happen on the date given. A brand account request ID will be returned and will then be updated when the disconnection occurs.
    • disconnectPrivateEndpointService
      Initiate the automated process to revoke mutual connectivity from the account network and IBM Cloud Service Endpoint network. Once initiated, the configuration process occurs asynchronously in the background. <h2>Responses</h2> <code>True</code> The request to disconnect was successfully initiated. <code>False</code> The account and Service Endpoint networks are already disconnected. <h2>Exceptions</h2> <code>SoftLayer_Exception_NotReady</code> Thrown when the current network configuration will not support connection alteration.
    • downloadAddressTranslationConfigurations
      Provides all of the address translation configurations for an IPSec VPN tunnel in a text file
    • downloadFile
      {{CloudLayerOnlyMethod}} Download a file from a Storage account. This method returns a file's details including the file's raw content.
    • downloadFile
      {{CloudLayerOnlyMethod}} Download a file from a Storage account. This method returns a file's details including the file's raw content.
    • downloadFile
      {{CloudLayerOnlyMethod}} Download a file from a Storage account. This method returns a file's details including the file's raw content.
    • downloadParameterConfigurations
      Provides all of the configurations for an IPSec VPN network tunnel in a text file
    • edit
      Edit a SoftLayer ticket. The edit method is two-fold. You may either edit a ticket itself, add an update to a ticket, attach up to two files to a ticket, or perform all of these tasks. The SoftLayer API ignores changes made to the ''userEditableFlag'' and ''accountId'' properties. You may not assign a ticket to a user that your API account does not have access to. You may not enter a custom title for standard support tickets, buy may do so when editing an administrative ticket. Finally, you may not close a ticket using this method. Please contact SoftLayer if you need a ticket closed. If you need to only add an update to a ticket then please use the [SoftLayer_Ticket::addUpdate](/reference/datatypes/$1/#$2) method in this service. Likewise if you need to only attach a file to a ticket then use the [SoftLayer_Ticket::addAttachedFile](/reference/datatypes/$1/#$2) method. The edit method exists as a convenience if you need to perform all these tasks at once.
    • editAccount
      This method will edit the account's information. Pass in a SoftLayer_Account template with the fields to be modified. Certain changes to the account will automatically create a ticket for manual review. This will be returned with the SoftLayer_Container_Account_Update_Response.<br> <br> The following fields are editable:<br> <br> <ul> <li>companyName</li> <li>firstName</li> <li>lastName</li> <li>address1</li> <li>address2</li> <li>city</li> <li>state</li> <li>country</li> <li>postalCode</li> <li>email</li> <li>officePhone</li> <li>alternatePhone</li> <li>faxPhone</li> <li>abuseEmails.email</li> <li>billingInfo.vatId</li> </ul>
    • editAddressTranslation
      Edit name, source (SoftLayer IP) ip address and/or destination (Customer IP) ip address for an existing address translation for a network tunnel. Address translations deliver packets to a destination ip address that is on a customer (remote) subnet. NOTE: A network tunnel's configurations must be applied to the network device in order for an address translation to be created.
    • editAddressTranslations
      Edit name, source (SoftLayer IP) ip address and/or destination (Customer IP) ip address for existing address translations for a network tunnel. Address translations deliver packets to a destination ip address that is on a customer (remote) subnet. NOTE: A network tunnel's configurations must be applied to the network device in order for an address translation to be modified.
    • editConnection
    • editCredential
      This method will change the password of a credential created using the 'addNewCredential' method. If the credential exists on multiple storage volumes it will change for those volumes as well.
    • editCredential
      This method will change the password of a credential created using the 'addNewCredential' method. If the credential exists on multiple storage volumes it will change for those volumes as well.
    • editCredential
      This method will change the password of a credential created using the 'addNewCredential' method. If the credential exists on multiple storage volumes it will change for those volumes as well.
    • editNote
      Edit the note for this subnet.
    • editObject
      Edit the properties of an address record by passing in a modified instance of a SoftLayer_Account_Address object. Users will be restricted to modifying addresses for their account.
    • editObject
      Edit an affiliation that is associated to an existing account.
    • editObject
      Edit the object by passing in a modified instance of the object
    • editObject
      This method allows you to modify an account contact. Only master users are permitted to modify an account contact.
    • editObject
      Edit the properties of a media record by passing in a modified instance of a SoftLayer_Account_Media object.
    • editObject
      Edit the properties of a data transfer request record by passing in a modified instance of a SoftLayer_Account_Media_Data_Transfer_Request object.
    • editObject
    • editObject
      The password and/or notes may be modified. Modifying the EVault passwords here will also update the password the Webcc interface will use.
    • editObject
      This method will edit an existing SoftLayer_Account_Regional_Registry_Detail object. For more detail, see [SoftLayer_Account_Regional_Registry_Detail::createObject](/reference/datatypes/$1/#$2).
    • editObject
      This method will edit an existing SoftLayer_Account_Regional_Registry_Detail_Property object. For more detail, see [SoftLayer_Account_Regional_Registry_Detail_Property::createObject](/reference/datatypes/$1/#$2).
    • editObject
      Edit the properties of a shipment record by passing in a modified instance of a SoftLayer_Account_Shipment object.
    • editObject
      Edit the properties of a shipment record by passing in a modified instance of a SoftLayer_Account_Shipment_Item object.
    • editObject
      Edit the properties of a tracking data record by passing in a modified instance of a SoftLayer_Account_Shipment_Tracking_Data object.
    • editObject
      Edit the object by passing in a modified instance of the object. Use this method to modify configuration template name or description.
    • editObject
      editObject edits an existing domain resource record. The ''host'' property of the templateObject parameter is scrubbed to remove all non-alpha numeric characters except for '@', '_', '.', '*', and '-'. The ''data'' property of the templateObject parameter is scrubbed to remove all non-alphanumeric characters for '.' and '-'. Editing a resource record updates the serial number of the domain the resource record is associated with. ''editObject'' returns Boolean ''true'' on a successful edit or ''false'' if it was unable to edit the resource record.
    • editObject
      editObject edits an existing MX resource record. The ''host'' property of the templateObject parameter is scrubbed to remove all non-alpha numeric characters except for '@', '_', '.', '*', and '-'. The ''data'' property of the templateObject parameter is scrubbed to remove all non-alphanumeric characters for '.' and '-'. Editing an MX record updates the serial number of the domain the record is associated with. ''editObject'' returns Boolean ''true'' on a successful edit or ''false'' if it was unable to edit the resource record.
    • editObject
      editObject edits an existing SRV resource record. The ''host'' property of the templateObject parameter is scrubbed to remove all non-alpha numeric characters except for '@', '_', '.', '*', and '-'. The ''data'' property of the templateObject parameter is scrubbed to remove all non-alphanumeric characters for '.' and '-'. Editing an SRV record updates the serial number of the domain the record is associated with. ''editObject'' returns Boolean ''true'' on a successful edit or ''false'' if it was unable to edit the resource record.
    • editObject
      Edit the properties of a secondary DNS record by passing in a modified instance of a SoftLayer_Dns_Secondary object. You may only edit the ''masterIpAddress'' and ''transferFrequency'' properties of your secondary DNS record. ''ZoneName'' may not be altered after a secondary DNS record has been created. Please remove and re-create the record if you need to make changes to your zone name.
    • editObject
      Edit a server's properties
    • editObject
      Edit a server's properties
    • editObject
      Edit a server's properties
    • editObject
      This method edits an existing layout profile object by passing in a modified instance of the object.
    • editObject
      Edit the object by passing in a modified instance of the object
    • editObject
      This method edits an existing layout profile object by passing in a modified instance of the object.
    • editObject
      Edit an applications delivery controller record. Currently only a controller's notes property is editable.
    • editObject
      Like any other API object, the load balancers can have their exposed properties edited by passing in a modified version of the object. The load balancer object also can modify its services in this way. Simply request the load balancer object you wish to edit, then modify the objects in the services array and pass the modified object to this function. WARNING: Services cannot be deleted in this manner, you must call deleteObject() on the service to physically remove them from the load balancer.
    • editObject
      Edit a bandwidth allotment's local properties. Currently you may only change an allotment's name. Use the [SoftLayer_Network_Bandwidth_Version1_Allotment::reassignServers](/reference/datatypes/$1/#$2) and [SoftLayer_Network_Bandwidth_Version1_Allotment::unassignServers](/reference/datatypes/$1/#$2) methods to move servers in and out of your allotments.
    • editObject
      Edit this gateway. Currently, the only value that can be edited is the name.
    • editObject
      Edit this member, only manufacturer and version can be changed
    • editObject
      Edit a l7 policy instance's properties
    • editObject
      The global load balancer service has been deprecated and is no longer available. Edit the properties of a global load balancer account by passing in a modified instance of the object.
    • editObject
      Like any other API object, the load balancers can have their exposed properties edited by passing in a modified version of the object. The load balancer object also can modify its services in this way. Simply request the load balancer object you wish to edit, then modify the objects in the services array and pass the modified object to this function. WARNING: Services cannot be deleted in this manner, you must call deleteObject() on the service to physically remove them from the load balancer.
    • editObject
    • editObject
    • editObject
      Like any other API object, the monitoring objects can have their exposed properties edited by passing in a modified version of the object.
    • editObject
      Edit a security group.
    • editObject
      The password and/or notes may be modified for the Storage service except evault passwords and notes.
    • editObject
    • editObject
    • editObject
    • editObject
    • editObject
    • editObject
      The password and/or notes may be modified for the Storage service except evault passwords and notes.
    • editObject
    • editObject
    • editObject
    • editObject
      The password and/or notes may be modified for the Storage service except evault passwords and notes.
    • editObject
      Edit a nas volume schedule
    • editObject
      Edit a subnet IP address.
    • editObject
      This method will edit an existing SoftLayer_Network_Subnet_Registration object. For more detail, see [SoftLayer_Network_Subnet_Registration::createObject](/reference/datatypes/$1/#$2).
    • editObject
      Edit the RWHOIS record by passing in a modified version of the record object. All fields are editable.
    • editObject
      Negotiation parameters for both phases one and two are editable. Here are the phase one and two parameters that can modified: *Phase One **Authentication ***Default value is set to MD5. ***Valid Options are: MD5, SHA1, SHA256. **Encryption ***Default value is set to 3DES. ***Valid Options are: DES, 3DES, AES128, AES192, AES256. **Diffie-Hellman Group ***Default value is set to 2. ***Valid Options are: 0 (None), 1, 2, 5. **Keylife ***Default value is set to 3600. ***Limits are: MIN = 120, MAX = 172800 **Preshared Key *Phase Two **Authentication ***Default value is set to MD5. ***Valid Options are: MD5, SHA1, SHA256. **Encryption ***Default value is set to 3DES. ***Valid Options are: DES, 3DES, AES128, AES192, AES256. **Diffie-Hellman Group ***Default value is set to 2. ***Valid Options are: 0 (None), 1, 2, 5. **Keylife ***Default value is set to 28800. ***Limits are: MIN = 120, MAX = 172800 **Perfect Forward Secrecy ***Valid Options are: Off = 0, On = 1. ***NOTE: If perfect forward secrecy is turned On (set to 1), then a phase 2 diffie-hellman group is required. The remote peer address for the network tunnel may also be modified if needed. Invalid options will not be accepted and will cause an exception to be thrown. There are properties that provide valid options and limits for each negotiation parameter. Those properties are as follows: * encryptionDefault * encryptionOptions * authenticationDefault * authenticationOptions * diffieHellmanGroupDefault * diffieHellmanGroupOptions * phaseOneKeylifeDefault * phaseTwoKeylifeDefault * keylifeLimits Configurations cannot be modified if a network tunnel's requires complex manual setups/configuration modifications by the SoftLayer Network department. If the former is required, the configurations for the network tunnel will be locked until the manual configurations are complete. A network tunnel's configurations are applied via a transaction. If a network tunnel configuration change transaction is currently running, the network tunnel's setting cannot be modified until the running transaction completes. NOTE: A network tunnel's configurations must be applied to the network device in order for the modifications made to take effect.
    • editObject
      Updates this VLAN using the provided VLAN template. The following properties may be modified. - 'name' - A description no more than 20 characters in length.
    • editObject
      The subscriber's subscription status can be 'turned off' or 'turned on' if the subscription is not required. Subscriber preferences may also be edited. To edit the preferences, you must pass in the id off the preferences to edit. Here is an example of structure to pass in. In this example, the structure will set the subscriber status to active and the threshold preference to 90 and the limit preference to 20 *id = 1111 *active = 1 *preferences[1] **id = 11 **value = 90 *preference[2] **id = 12 **value = 20
    • editObject
      The subscriber's subscription status can be 'turned off' or 'turned on' if the subscription is not required. Subscriber preferences may also be edited. To edit the preferences, you must pass in the id off the preferences to edit. Here is an example of structure to pass in. In this example, the structure will set the subscriber status to active and the threshold preference to 90 and the limit preference to 20 *id = 1111 *active = 1 *preferences[1] **id = 11 **value = 90 *preference[2] **id = 12 **value = 20
    • editObject
      The subscriber's subscription status can be 'turned off' or 'turned on' if the subscription is not required. Subscriber preferences may also be edited. To edit the preferences, you must pass in the id off the preferences to edit. Here is an example of structure to pass in. In this example, the structure will set the subscriber status to active and the threshold preference to 90 and the limit preference to 20 *id = 1111 *active = 1 *preferences[1] **id = 11 **value = 90 *preference[2] **id = 12 **value = 20
    • editObject
    • editObject
    • editObject
      Update a certificate. Modifications are restricted to the note and CSR if the are any services associated with the certificate. There are no modification restrictions for a certificate with no associated services.
    • editObject
      Update a ssh key.
    • editObject
      Edit the properties of a software component password such as the username, password, port, and notes.
    • editObject
      Account master users and sub-users who have the User Manage permission in the SoftLayer customer portal can update other user's information. Use editObject() if you wish to edit a single user account. Users who do not have the User Manage permission can only update their own information.
    • editObject
      Edit the properties of customer ApiAuthentication record by passing in a modified instance of a SoftLayer_User_Customer_ApiAuthentication object. Only the ipAddressRestriction property can be modified.
    • editObject
      Edit the object by passing in a modified instance of the object
    • editObject
      Account master users and sub-users who have the User Manage permission in the SoftLayer customer portal can update other user's information. Use editObject() if you wish to edit a single user account. Users who do not have the User Manage permission can only update their own information.
    • editObject
      Account master users and sub-users who have the User Manage permission in the SoftLayer customer portal can update other user's information. Use editObject() if you wish to edit a single user account. Users who do not have the User Manage permission can only update their own information.
    • editObject
      Allows a user to modify the name and description of an existing customer permission group. Customer permission groups must be of type NORMAL. The SYSTEM type is reserved for internal use. The account id supplied in the template permission group must match account id of the user who is creating the permission group. The user who is creating the permission group must have the permission to manage users.
    • editObject
      Allows a user to modify the name and description of an existing customer permission role. Customer permission roles must set the systemFlag attribute to false. The SYSTEM type is reserved for internal use. The account id supplied in the template permission role must match account id of the user who is creating the permission role. The user who is creating the permission role must have the permission to manage users.
    • editObject
      Edit a dedicated host's properties.
    • editObject
    • editObject
      Edit a computing instance's properties
    • editObject
      Edit an image template group's associated name and note. All other properties in the SoftLayer_Virtual_Guest_Block_Device_Template_Group data type are read-only.
    • editObject
      Edits a single boot parameter
    • editObject
      Update a placement group.
    • editObject
      Update a reserved capacity group.
    • editObjects
      Edit multiple [SoftLayer_Account_Regional_Registry_Detail_Property](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail_Property) objects.
    • editObjects
      Edit multiple resource records on a domain. This follows the same logic as ''createObject'. The serial number of the domain associated with this resource record is updated upon creation. ''createObjects'' returns Boolean ''true'' on successful creation or ''false'' if it was unable to create a resource record.
    • editObjects
      Edit multiple MX records on a domain. This follows the same logic as ''createObject'. The serial number of the domain associated with this MX record is updated upon creation. ''createObjects'' returns Boolean ''true'' on successful creation or ''false'' if it was unable to create a resource record.
    • editObjects
      Edit multiple SRV records on a domain. This follows the same logic as ''createObject'. The serial number of the domain associated with this SRV record is updated upon creation. ''createObjects'' returns Boolean ''true'' on successful creation or ''false'' if it was unable to create a resource record.
    • editObjects
      Like any other API object, the monitoring objects can have their exposed properties edited by passing in a modified version of the object.
    • editObjects
      Edit security groups.
    • editObjects
      This function is used to edit multiple objects at the same time.
    • editObjects
    • editObjects
      Edit more than one password from a software component.
    • editObjects
      Account master users and sub-users who have the User Manage permission in the SoftLayer customer portal can update other user's information. Use editObjects() if you wish to edit multiple users at once. Users who do not have the User Manage permission can only update their own information.
    • editObjects
      Account master users and sub-users who have the User Manage permission in the SoftLayer customer portal can update other user's information. Use editObjects() if you wish to edit multiple users at once. Users who do not have the User Manage permission can only update their own information.
    • editObjects
      Account master users and sub-users who have the User Manage permission in the SoftLayer customer portal can update other user's information. Use editObjects() if you wish to edit multiple users at once. Users who do not have the User Manage permission can only update their own information.
    • editRegistrationAttachedDetails
      This method modifies a single registration by modifying the current [SoftLayer_Network_Subnet_Registration_Details](/reference/datatypes/SoftLayer_Network_Subnet_Registration_Details) objects that are linked to that registration.
    • editRules
      Edit rules that belong to the security group. An array of skeleton [SoftLayer_Network_SecurityGroup_Rule](/reference/datatypes/SoftLayer_Network_SecurityGroup_Rule) objects must be sent in with only the properties defined that you want to change. To edit a property to null, send in -1 for integer properties and '' for string properties. Unchanged properties are left alone.
    • editSoftwareComponentPasswords
      Edit the properties of a software component password such as the username, password, and notes.
    • editSoftwareComponentPasswords
      Edit the properties of a software component password such as the username, password, and notes.
    • editSoftwareComponentPasswords
      Edit the properties of a software component password such as the username, password, and notes.
    • editSoftwareComponentPasswords
      Edit the properties of a software component password such as the username, password, and notes.
    • editSoftwareComponentPasswords
      Edit the properties of a software component password such as the username, password, and notes.
    • emailInvoices
      Create a transaction to email PDF and/or Excel invoice links to the requesting user's email address. You must have a PDF reader installed in order to view these files.
    • enable
      Enable email subscription.
    • enable
      Enable a disabled Virtual IP Address, allowing connections back to the IP address.
    • enable
      Enabling an external binding will activate the binding on your account and require you to authenticate with our trusted 3rd party 2 form factor vendor when logging into the SoftLayer customer portal. Please note that API access will be disabled for users that have an active external binding.
    • enable
      Enabling an external binding will activate the binding on your account and require you to authenticate with our trusted 3rd party 2 form factor vendor when logging into the SoftLayer customer portal. Please note that API access will be disabled for users that have an active external binding.
    • enable
      Enabling an external binding will activate the binding on your account and require you to authenticate with our trusted 3rd party 2 form factor vendor when logging into the SoftLayer customer portal. Please note that API access will be disabled for users that have an active external binding.
    • enable
      Allow incoming and outgoing bandwidth traffic to a network component
    • enableEuSupport
      <p> If you select the EU Supported option, the most common Support issues will be limited to IBM Cloud staff located in the EU. In the event your issue requires non-EU expert assistance, it will be reviewed and approval given prior to any non-EU intervention. Additionally, in order to support and update the services, cross-border Processing of your data may still occur. Please ensure you take the necessary actions to allow this Processing, as detailed in the <strong><a href='http://www-03.ibm.com/software/sla/sladb.nsf/sla/bm-6605-12'>Cloud Service Terms</a></strong>. A standard Data Processing Addendum is available <strong><a href='https://www-05.ibm.com/support/operations/zz/en/dpa.html'>here</a></strong>. </p> <p> <strong>Important note (you will only see this once):</strong> Orders using the API will proceed without additional notifications. The terms related to selecting products, services, or locations outside the EU apply to API orders. Users you create and API keys you generate will have the ability to order products, services, and locations outside of the EU. It is your responsibility to educate anyone you grant access to your account on the consequences and requirements if they make a selection that is not in the EU Supported option. In order to meet EU Supported requirements, the current PPTP VPN solution will no longer be offered or supported. </p> <p> If PPTP has been selected as an option for any users in your account by itself (or in combination with another VPN offering), you will need to disable PPTP before selecting the EU Supported account feature. For more information on VPN changes, click <strong><a href='http://knowledgelayer.softlayer.com/procedure/activate-or-deactivate-pptp-vpn-access-user'> here</a></strong>. </p>
    • enableOrDisableDataLogs
      When enabled, data log would be forwarded to logging service.
    • enableSmtpAccess
    • enableSnapshots
      This method is not valid for Legacy iSCSI Storage Volumes. Enable scheduled snapshots of this storage volume. Scheduling options include HOURLY, DAILY and WEEKLY schedules. For HOURLY schedules, provide relevant data for $scheduleType, $retentionCount and $minute. For DAILY schedules, provide relevant data for $scheduleType, $retentionCount, $minute, and $hour. For WEEKLY schedules, provide relevant data for all parameters of this method.
    • enableSnapshots
      This method is not valid for Legacy iSCSI Storage Volumes. Enable scheduled snapshots of this storage volume. Scheduling options include HOURLY, DAILY and WEEKLY schedules. For HOURLY schedules, provide relevant data for $scheduleType, $retentionCount and $minute. For DAILY schedules, provide relevant data for $scheduleType, $retentionCount, $minute, and $hour. For WEEKLY schedules, provide relevant data for all parameters of this method.
    • enableSnapshots
      This method is not valid for Legacy iSCSI Storage Volumes. Enable scheduled snapshots of this storage volume. Scheduling options include HOURLY, DAILY and WEEKLY schedules. For HOURLY schedules, provide relevant data for $scheduleType, $retentionCount and $minute. For DAILY schedules, provide relevant data for $scheduleType, $retentionCount, $minute, and $hour. For WEEKLY schedules, provide relevant data for all parameters of this method.
    • enableVpnConfigRequiresVpnManageAttribute
      Enables the VPN_CONFIG_REQUIRES_VPN_MANAGE attribute on the account. If the attribute does not exist for the account, it will be created and set to true.
    • enroll
      Create a new Service Provider Enrollment
    • executeIderaBareMetalRestore
      Reboot a guest into the Idera Bare Metal Restore image.
    • executeR1SoftBareMetalRestore
      Reboot a guest into the R1Soft Bare Metal Restore image.
    • executeRemoteScript
      Download and run remote script from uri on the hardware.
    • executeRemoteScript
      Download and run remote script from uri on the hardware.
    • executeRemoteScript
      Download and run remote script from uri on the hardware.
    • executeRemoteScript
      Download and run remote script from uri on the hardware.
    • executeRemoteScript
      Download and run remote script from uri on the hardware.
    • executeRemoteScript
      Download and run remote script from uri on virtual guests.
    • executeRescueLayer
      Reboot a Linux guest into the Xen rescue image.
    • failbackFromReplicant
      Failback from a volume replicant. In order to failback the volume must have already been failed over to a replicant.
    • failbackFromReplicant
      Failback from a volume replicant. In order to failback the volume must have already been failed over to a replicant.
    • failbackFromReplicant
      Failback from a volume replicant. In order to failback the volume must have already been failed over to a replicant.
    • failoverToReplicant
      Failover to a volume replicant. During the time which the replicant is in use the local nas volume will not be available.
    • failoverToReplicant
      Failover to a volume replicant. During the time which the replicant is in use the local nas volume will not be available.
    • failoverToReplicant
      Failover to a volume replicant. During the time which the replicant is in use the local nas volume will not be available.
    • finalizeExternalBillingForAccount
      Calling this method signals that the account with the provided account id is ready to be billed by the external billing system.
    • findAllSubnetsAndActiveSwipTransactionStatus
      ***DEPRECATED*** Retrieve a list of a SoftLayer customer's subnets along with their SWIP transaction statuses. This is a shortcut method that combines the SoftLayer_Network_Subnet retrieval methods along with [[object masks]] to retrieve their subnets' associated SWIP transactions as well. This is a special function built for SoftLayer's use on the SWIP section of the customer portal, but may also be useful for API users looking for the same data.
    • findBluePagesProfile
      Given an IBM email address, searches BluePages and returns the employee's details. Note that this method is not available to customers, despite being visible, and will return an error response.
    • findByCommonName
      Locate certificates by their common name, traditionally a domain name.
    • findByGuestId
      This method returns all SoftLayer_User_Customer_Notification_Virtual_Guest objects associated with the passed in ID as long as that Virtual Guest ID is owned by the current user's account. This behavior can also be accomplished by simply tapping monitoringUserNotification on the Virtual_Guest object.
    • findByHardwareId
      This method returns all Query_Host objects associated with the passed in hardware ID as long as that hardware ID is owned by the current user's account. This behavior can also be accomplished by simply tapping networkMonitors on the Hardware_Server object.
    • findByHardwareId
      This method returns all Customer_Notification_Hardware objects associated with the passed in hardware ID as long as that hardware ID is owned by the current user's account. This behavior can also be accomplished by simply tapping monitoringUserNotification on the Hardware_Server object.
    • findByHostname
      Find VSIs by hostname.
    • findByIpAddress
      The '''findByIpAddress''' method finds hardware using its primary public or private IP address. IP addresses that have a secondary subnet tied to the hardware will not return the hardware. If no hardware is found, no errors are generated and no data is returned.
    • findByIpAddress
      The '''findByIpAddress''' method finds hardware using its primary public or private IP address. IP addresses that have a secondary subnet tied to the hardware will not return the hardware. If no hardware is found, no errors are generated and no data is returned.
    • findByIpAddress
      The '''findByIpAddress''' method finds hardware using its primary public or private IP address. IP addresses that have a secondary subnet tied to the hardware will not return the hardware. If no hardware is found, no errors are generated and no data is returned.
    • findByIpAddress
      The '''findByIpAddress''' method finds hardware using its primary public or private IP address. IP addresses that have a secondary subnet tied to the hardware will not return the hardware. If no hardware is found, no errors are generated and no data is returned.
    • findByIpAddress
      The '''findByIpAddress''' method finds hardware using its primary public or private IP address. IP addresses that have a secondary subnet tied to the hardware will not return the hardware. If no hardware is found, no errors are generated and no data is returned.
    • findByIpAddress
      Find CCI by only its primary public or private IP address. IP addresses within secondary subnets tied to the CCI will not return the CCI. If no CCI is found, no errors are generated and no data is returned.
    • findByIpv4Address
      Search for an IP address record by IPv4 address.
    • findByPromoCode
      Retrieves a promotion using its code.
    • findGcImagesByCurrentUser
      Find block device template groups containing a GC enabled cloudinit image for the current active user. A sorted collection of groups is returned. The Caller can optionally specify data center or region names to retrieve GC images from only those locations.
    • findMyTransactions
      **DEPRECATED** This function will return an array of SoftLayer_Network_Subnet_Swip_Transaction objects, one for each SWIP that is currently in transaction with ARIN. This includes all swip registrations, swip removal requests, and SWIP objects that are currently OK.
    • findUserPreference
    • findUserPreference
    • findUserPreference
    • forceRebuildCluster
      Purpose is to rebuild the target Gateway cluster with the specified OS price id. Method will remove the current OS and apply the default configuration settings. This will result in an extended OUTAGE!! Any custom configuration settings must be re-applied after the forced rebuild is completed. This is a DESTRUCTIVE action, use with caution.
    • forceRebuildvSRXCluster
      Purpose is to rebuild the target Gateway cluster with the specified OS price id. Method will remove the current OS and apply the default vSRX configuration settings. This will result in an extended OUTAGE!! Any custom configuration settings must be re-applied after the forced rebuild is completed. This is a DESTRUCTIVE action, use with caution.
    • generateOrderTemplate
      Obtain an [SoftLayer_Container_Product_Order_Hardware_Server](/reference/datatypes/SoftLayer_Container_Product_Order_Hardware_Server) that can be sent to [SoftLayer_Product_Order::verifyOrder](/reference/services/SoftLayer_Product_Order/verifyOrder) or [SoftLayer_Product_Order::placeOrder](/reference/services/SoftLayer_Product_Order/placeOrder). This is primarily useful when there is a necessity to confirm the price which will be charged for an order. See [SoftLayer_Hardware::createObject](/reference/services/SoftLayer_Hardware/createObject) for specifics on the requirements of the template object parameter.
    • generateOrderTemplate
      Obtain an [SoftLayer_Container_Product_Order_Hardware_Server](/reference/datatypes/SoftLayer_Container_Product_Order_Hardware_Server) that can be sent to [SoftLayer_Product_Order::verifyOrder](/reference/services/SoftLayer_Product_Order/verifyOrder) or [SoftLayer_Product_Order::placeOrder](/reference/services/SoftLayer_Product_Order/placeOrder). This is primarily useful when there is a necessity to confirm the price which will be charged for an order. See [SoftLayer_Hardware::createObject](/reference/services/SoftLayer_Hardware/createObject) for specifics on the requirements of the template object parameter.
    • generateOrderTemplate
      Obtain an [SoftLayer_Container_Product_Order_Hardware_Server](/reference/datatypes/SoftLayer_Container_Product_Order_Hardware_Server) that can be sent to [SoftLayer_Product_Order::verifyOrder](/reference/services/SoftLayer_Product_Order/verifyOrder) or [SoftLayer_Product_Order::placeOrder](/reference/services/SoftLayer_Product_Order/placeOrder). This is primarily useful when there is a necessity to confirm the price which will be charged for an order. See [SoftLayer_Hardware::createObject](/reference/services/SoftLayer_Hardware/createObject) for specifics on the requirements of the template object parameter.
    • generateOrderTemplate
      Obtain an [SoftLayer_Container_Product_Order_Hardware_Server](/reference/datatypes/SoftLayer_Container_Product_Order_Hardware_Server) that can be sent to [SoftLayer_Product_Order::verifyOrder](/reference/services/SoftLayer_Product_Order/verifyOrder) or [SoftLayer_Product_Order::placeOrder](/reference/services/SoftLayer_Product_Order/placeOrder). This is primarily useful when there is a necessity to confirm the price which will be charged for an order. See [SoftLayer_Hardware::createObject](/reference/services/SoftLayer_Hardware/createObject) for specifics on the requirements of the template object parameter.
    • generateOrderTemplate
      Obtain an [SoftLayer_Container_Product_Order_Hardware_Server](/reference/datatypes/SoftLayer_Container_Product_Order_Hardware_Server) that can be sent to [SoftLayer_Product_Order::verifyOrder](/reference/services/SoftLayer_Product_Order/verifyOrder) or [SoftLayer_Product_Order::placeOrder](/reference/services/SoftLayer_Product_Order/placeOrder). This is primarily useful when there is a necessity to confirm the price which will be charged for an order. See [SoftLayer_Hardware::createObject](/reference/services/SoftLayer_Hardware/createObject) for specifics on the requirements of the template object parameter.
    • generateOrderTemplate
      Obtain an [SoftLayer_Container_Product_Order_Virtual_Guest](/reference/datatypes/SoftLayer_Container_Product_Order_Virtual_Guest) that can be sent to [SoftLayer_Product_Order::verifyOrder](/reference/services/SoftLayer_Product_Order/verifyOrder) or [SoftLayer_Product_Order::placeOrder](/reference/services/SoftLayer_Product_Order/placeOrder). This is primarily useful when there is a necessity to confirm the price which will be charged for an order. See [SoftLayer_Virtual_Guest::createObject](/reference/services/SoftLayer_Virtual_Guest/createObject) for specifics on the requirements of the template object parameter.
    • generateSecretKey
    • getAbuseEmail
      An email address that is responsible for abuse and legal inquiries on behalf of an account. For instance, new legal and abuse tickets are sent to this address.
    • getAbuseEmails
      Email addresses that are responsible for abuse and legal inquiries on behalf of an account. For instance, new legal and abuse tickets are sent to these addresses.
    • getAccount
      The account to which this address belongs.
    • getAccount
      The account that an affiliation belongs to.
    • getAccount
    • getAccount
      The SoftLayer customer account.
    • getAccount
      The account associated with this saml configuration.
    • getAccount
    • getAccount
      Account associated with the business partner data
    • getAccount
    • getAccount
    • getAccount
    • getAccount
    • getAccount
      The account to which the media belongs.
    • getAccount
      The account to which the request belongs.
    • getAccount
    • getAccount
    • getAccount
    • getAccount
      The account that this detail object belongs to.
    • getAccount
    • getAccount
      The account to which the shipment belongs.
    • getAccount
      The SoftLayer customer account associated with this billing information.
    • getAccount
      The account that an invoice belongs to.
    • getAccount
      The account that a billing item belongs to.
    • getAccount
      The SoftLayer account that a service cancellation request belongs to.
    • getAccount
      The account that a billing item belongs to.
    • getAccount
      The [SoftLayer_Account](/reference/datatypes/SoftLayer_Account) to which an order belongs.
    • getAccount
      A quote's corresponding account.
    • getAccount
      A quote's corresponding account.
    • getAccount
    • getAccount
    • getAccount
    • getAccount
      The SoftLayer customer account that owns a domain.
    • getAccount
      The SoftLayer customer account that the domain is registered to.
    • getAccount
      The SoftLayer account that owns a secondary DNS record.
    • getAccount
      The account associated with a piece of hardware.
    • getAccount
      Information regarding a benchmark certification result's associated SoftLayer customer account.
    • getAccount
      A partition template's associated [SoftLayer_Account](/reference/datatypes/SoftLayer_Account).
    • getAccount
      The account associated with a piece of hardware.
    • getAccount
      The account associated with a piece of hardware.
    • getAccount
      The account associated with a piece of hardware.
    • getAccount
      The account associated with a piece of hardware.
    • getAccount
      The account that a billing item belongs to.
    • getAccount
      The SoftLayer customer account that owns an application delivery controller record.
    • getAccount
    • getAccount
      The account associated with this virtual rack.
    • getAccount
      SoftLayer account to which the CDN account belongs.
    • getAccount
      The account for this gateway.
    • getAccount
      Your SoftLayer customer account.
    • getAccount
      The account that owns this load balancer.
    • getAccount
      The SoftLayer account information
    • getAccount
      The SoftLayer customer account that a network message delivery account belongs to.
    • getAccount
      The SoftLayer customer account that a network message delivery account belongs to.
    • getAccount
      The account associated with a security scan request.
    • getAccount
      The account this security group belongs to.
    • getAccount
      The account that a Storage services belongs to.
    • getAccount
      The SoftLayer_Account object which this SoftLayer_Network_Storage_Allowed_Host belongs to.
    • getAccount
      The SoftLayer_Account object which this SoftLayer_Network_Storage_Allowed_Host belongs to.
    • getAccount
      The SoftLayer_Account object which this SoftLayer_Network_Storage_Allowed_Host belongs to.
    • getAccount
      The SoftLayer_Account object which this SoftLayer_Network_Storage_Allowed_Host belongs to.
    • getAccount
      The account that a Storage services belongs to.
    • getAccount
    • getAccount
      The SoftLayer_Account which owns this group.
    • getAccount
      The SoftLayer_Account which owns this group.
    • getAccount
      The SoftLayer_Account which owns this group.
    • getAccount
      SoftLayer account to which an IBM Cloud Object Storage account belongs to.
    • getAccount
      The account that a Storage services belongs to.
    • getAccount
      The account to which the request belongs.
    • getAccount
      The request this key contact belongs to.
    • getAccount
    • getAccount
    • getAccount
      The account that this registration belongs to.
    • getAccount
      The SoftLayer customer account associated with this reverse WHOIS data.
    • getAccount
      The Account whose RWHOIS data was used to SWIP this subnet
    • getAccount
      The account that a network tunnel belongs to.
    • getAccount
      The account this VLAN is associated with.
    • getAccount
      The account that an order belongs to
    • getAccount
    • getAccount
      The account to which a SSL certificate request belongs.
    • getAccount
    • getAccount
      The customer account this Account License belongs to.
    • getAccount
      The customer account this Virtual License belongs to.
    • getAccount
      The account to which the tag is tied.
    • getAccount
      The SoftLayer customer account associated with a ticket.
    • getAccount
      The customer account that a user belongs to.
    • getAccount
      The customer account that a user belongs to.
    • getAccount
      The customer account that a user belongs to.
    • getAccount
    • getAccount
    • getAccount
      The account that the dedicated host belongs to.
    • getAccount
      The account that a virtual guest belongs to.
    • getAccount
      A block device template group's [SoftLayer_Account](/reference/datatypes/SoftLayer_Account).
    • getAccount
      The account which a virtual host belongs to.
    • getAccount
      The account that the placement group is implemented on.
    • getAccount
      The account that the reserved capacity group is implemented on.
    • getAccount
      The [SoftLayer_Account](/reference/datatypes/SoftLayer_Account) that a storage repository belongs to.
    • getAccount
      The [SoftLayer_Account](/reference/datatypes/SoftLayer_Account) to which the deployment belongs.
    • getAccountAffiliationsByAffiliateId
      Get account affiliation information associated with affiliate id.
    • getAccountBackupHistory
      This method returns an array of SoftLayer_Container_Network_Storage_Evault_WebCc_JobDetails objects for the given start and end dates. Start and end dates should be be valid ISO 8601 dates. The backupStatus can be one of null, 'success', 'failed', or 'conflict'. The 'success' backupStatus returns jobs with a status of 'COMPLETED', the 'failed' backupStatus returns jobs with a status of 'FAILED', while the 'conflict' backupStatus will return jobs that are not 'COMPLETED' or 'FAILED'.
    • getAccountContact
      A request's corresponding external contact, if one exists.
    • getAccountContacts
      The account contacts on an account.
    • getAccountContacts
    • getAccountHistory
      Provides a history of an account's lockdown requests and their status.
    • getAccountHostUptimeSummary
    • getAccountId
    • getAccountId
      The getAccountId retrieves the ID for the account on which the resource is located.
    • getAccountLicenses
      The account software licenses owned by an account
    • getAccountLinks
    • getAccountOverview
    • getAccountOwnedPoolFlag
    • getAccountPassword
      Other usernames and passwords associated with a Storage volume.
    • getAccountPassword
      Other usernames and passwords associated with a Storage volume.
    • getAccountPassword
      Other usernames and passwords associated with a Storage volume.
    • getAccountReferences
      The accounts which may have read-only access to an image template group. Will only be populated for parent template group objects.
    • getAccountReservations
    • getAccountRestrictedActivePresets
      The preset configurations available only for the authenticated account and this package.
    • getAccountRestrictedCategories
      The results from this call are similar to [SoftLayer_Product_Package::getCategories](/reference/services/SoftLayer_Product_Package/getCategories), but these ONLY include account-restricted prices. Not all accounts have restricted pricing.
    • getAccountRestrictedPricesFlag
      The flag to indicate if there are any restricted prices in a package for the currently-active account.
    • getAccountRestrictions
      The account that the item price is restricted to.
    • getAccountStatus
      An account's status presented in a more detailed data type.
    • getAccountTraitValue
      This method pulls an account trait by its key.
    • getAccountTypes
      Validates request and, if the request is approved, returns a list of allowed uses for an automatically created IBMer IaaS account.
    • getAccountUrlUptimeSummary
    • getAchInformation
    • getAcknowledgedFlag
      Indicates whether or not this event has been acknowledged by the user.
    • getActions
    • getActions
    • getActions
    • getActions
    • getActions
    • getActivationCodeForMobileClient
      An activation code is required when provisioning a new mobile credential from Verisign. This method will return the required activation code.
    • getActiveAccountDiscountBillingItem
      The billing item associated with an account's monthly discount.
    • getActiveAccountLicenses
      The active account software licenses owned by an account
    • getActiveAddresses
      The active address(es) that belong to an account.
    • getActiveAgreement
    • getActiveAgreement
    • getActiveAgreementFlag
      A flag indicating that the billing item is under an active agreement.
    • getActiveAgreementFlag
      A flag indicating that the billing item is under an active agreement.
    • getActiveAgreements
      All active agreements for an account
    • getActiveAssociatedChildren
      A billing item's active associated child billing items. This includes 'floating' items that are not necessarily child items of this billing item.
    • getActiveAssociatedChildren
      A billing item's active associated child billing items. This includes 'floating' items that are not necessarily child items of this billing item.
    • getActiveAssociatedGuestDiskBillingItems
    • getActiveAssociatedGuestDiskBillingItems
    • getActiveBillingAgreements
      All billing agreements for an account
    • getActiveBundledItems
      A Billing Item's active bundled billing items.
    • getActiveBundledItems
      A Billing Item's active bundled billing items.
    • getActiveCancellationItem
      A service cancellation request item that corresponds to the billing item.
    • getActiveCancellationItem
      A service cancellation request item that corresponds to the billing item.
    • getActiveCatalystEnrollment
    • getActiveChildren
      A Billing Item's active child billing items.
    • getActiveChildren
      A Billing Item's active child billing items.
    • getActiveColocationContainers
      The account's active top level colocation containers.
    • getActiveCommand
      Reboot/power (rebootDefault, rebootSoft, rebootHard, powerOn, powerOff and powerCycle) command currently executing by the server's remote management card.
    • getActiveComponents
      A piece of hardware's active physical components.
    • getActiveComponents
      A piece of hardware's active physical components.
    • getActiveComponents
      A piece of hardware's active physical components.
    • getActiveComponents
      A piece of hardware's active physical components.
    • getActiveComponents
      A piece of hardware's active physical components.
    • getActiveDetails
      The bandwidth allotment detail records associated with this virtual rack.
    • getActiveExternalAuthenticationVendors
      The getActiveExternalAuthenticationVendors method will return a list of available external vendors that a SoftLayer user can authenticate against. The list will only contain vendors for which the user has at least one active external binding.
    • getActiveExternalAuthenticationVendors
      The getActiveExternalAuthenticationVendors method will return a list of available external vendors that a SoftLayer user can authenticate against. The list will only contain vendors for which the user has at least one active external binding.
    • getActiveExternalAuthenticationVendors
      The getActiveExternalAuthenticationVendors method will return a list of available external vendors that a SoftLayer user can authenticate against. The list will only contain vendors for which the user has at least one active external binding.
    • getActiveFlag
    • getActiveFlag
    • getActiveFlag
      A flag to indicate that the presale event is currently active. A presale event is active if the current time is between the start and end dates.
    • getActiveFlexibleCreditEnrollment
      [Deprecated] Please use SoftLayer_Account::activeFlexibleCreditEnrollments.
    • getActiveFlexibleCreditEnrollments
    • getActiveItemPresaleEvents
    • getActiveItems
      Return a list of Items in the package with their active prices.
    • getActiveNetworkFirewallBillingItem
      The billing item for a server's attached network firewall.
    • getActiveNetworkFirewallBillingItem
      The billing item for a server's attached network firewall.
    • getActiveNetworkFirewallBillingItem
      The billing item for a server's attached network firewall.
    • getActiveNetworkMonitorIncident
      A piece of hardware's active network monitoring incidents.
    • getActiveNetworkMonitorIncident
      A piece of hardware's active network monitoring incidents.
    • getActiveNetworkMonitorIncident
      A piece of hardware's active network monitoring incidents.
    • getActiveNetworkMonitorIncident
      A piece of hardware's active network monitoring incidents.
    • getActiveNetworkMonitorIncident
      A piece of hardware's active network monitoring incidents.
    • getActiveNetworkMonitorIncident
      A virtual guest's currently active network monitoring incidents.
    • getActiveNotificationSubscribers
    • getActiveOutletPackages
      This is deprecated and will not return any results.
    • getActivePackages
      This method will return the [SoftLayer_Product_Package](/reference/datatypes/SoftLayer_Product_Package) objects from which you can order a bare metal server, virtual server, service (such as CDN or Object Storage) or other software. Once you have the package you want to order from, you may query one of various endpoints from that package to get specific information about its products and pricing. See [SoftLayer_Product_Package::getCategories](/reference/services/SoftLayer_Product_Package/getCategories) or [SoftLayer_Product_Package::getItems](/reference/services/SoftLayer_Product_Package/getItems) for more information. Packages that have been retired will not appear in this result set.
    • getActivePackagesByAttribute
      <strong>This method is deprecated and should not be used in production code.</strong> This method will return the [SoftLayer_Product_Package](/reference/datatypes/SoftLayer_Product_Package) objects from which you can order a bare metal server, virtual server, service (such as CDN or Object Storage) or other software filtered by an attribute type associated with the package. Once you have the package you want to order from, you may query one of various endpoints from that package to get specific information about its products and pricing. See [SoftLayer_Product_Package::getCategories](/reference/services/SoftLayer_Product_Package/getCategories) or [SoftLayer_Product_Package::getItems](/reference/services/SoftLayer_Product_Package/getItems) for more information.
    • getActivePackagesByAttribute
      <strong>This method is deprecated and should not be used in production code.</strong> This method will return the [SoftLayer_Product_Package](/reference/datatypes/SoftLayer_Product_Package) objects from which you can order a bare metal server, virtual server, service (such as CDN or Object Storage) or other software filtered by an attribute type associated with the package. Once you have the package you want to order from, you may query one of various endpoints from that package to get specific information about its products and pricing. See [SoftLayer_Product_Package::getCategories](/reference/services/SoftLayer_Product_Package/getCategories) or [SoftLayer_Product_Package::getItems](/reference/services/SoftLayer_Product_Package/getItems) for more information.
    • getActivePresaleEvents
    • getActivePresaleEvents
    • getActivePresaleEvents
    • getActivePresets
      The available preset configurations for this package.
    • getActivePrivateHostedCloudPackages
      [DEPRECATED] This method pulls all the active private hosted cloud packages. This will give you a basic description of the packages that are currently active and from which you can order private hosted cloud configurations.
    • getActivePrivateHostedCloudPackages
      [DEPRECATED] This method pulls all the active private hosted cloud packages. This will give you a basic description of the packages that are currently active and from which you can order private hosted cloud configurations.
    • getActiveQuotes
      An account's non-expired quotes.
    • getActiveRamItems
      A collection of valid RAM items available for purchase in this package.
    • getActiveRegistration
      The active regional internet registration for this subnet.
    • getActiveReservedCapacityAgreements
      Active reserved capacity agreements for an account
    • getActiveServerItems
      A collection of valid server items available for purchase in this package.
    • getActiveSoftwareItems
      A collection of valid software items available for purchase in this package.
    • getActiveSparePoolAssociatedGuestDiskBillingItems
    • getActiveSparePoolAssociatedGuestDiskBillingItems
    • getActiveSparePoolBundledItems
      A Billing Item's spare pool bundled billing items.
    • getActiveSparePoolBundledItems
      A Billing Item's spare pool bundled billing items.
    • getActiveSurveyByType
      Provides survey details for the given type
    • getActiveSwipTransaction
      DEPRECATED
    • getActiveTickets
      The active tickets that are attached to the data transfer request.
    • getActiveTickets
    • getActiveTickets
    • getActiveTickets
    • getActiveTickets
      The active tickets that are attached to the MDMS request.
    • getActiveTickets
    • getActiveTransaction
      Transaction currently running for server.
    • getActiveTransaction
      Transaction currently running for server.
    • getActiveTransaction
      Transaction currently running for server.
    • getActiveTransaction
      DEPRECATED
    • getActiveTransaction
      DEPRECATED
    • getActiveTransaction
      DEPRECATED
    • getActiveTransaction
      A transaction that is still be performed on a cloud server.
    • getActiveTransactions
      Any active transaction(s) that are currently running for the server (example: os reload).
    • getActiveTransactions
      Any active transaction(s) that are currently running for the server (example: os reload).
    • getActiveTransactions
      Any active transaction(s) that are currently running for the server (example: os reload).
    • getActiveTransactions
      The currently active transactions on a network storage volume.
    • getActiveTransactions
      The currently active transactions on a network storage volume.
    • getActiveTransactions
      The currently active transactions on a network storage volume.
    • getActiveTransactions
      Any active transaction(s) that are currently running for the server (example: os reload).
    • getActiveUsagePrices
      Active usage based prices.
    • getActiveUsagePrices
      A collection of [SoftLayer_Product_Item_Price](/reference/datatypes/SoftLayer_Product_Item_Price) objects for pay-as-you-go usage.
    • getActiveUsageRatePrices
      This method returns a collection of active usage rate [SoftLayer_Product_Item_Price](/reference/datatypes/SoftLayer_Product_Item_Price) objects for the current package and specified datacenter. Optionally you can retrieve the active usage rate prices for a particular [SoftLayer_Product_Item_Category](/reference/datatypes/SoftLayer_Product_Item_Category) by specifying a category code as the first parameter. This information is useful so that you can see 'pay as you go' rates (if any) for the current package, location and optionally category.
    • getActiveVirtualLicenses
      The virtual software licenses controlled by an account
    • getAdcLoadBalancers
      An account's associated load balancers.
    • getAdditionalEmails
      A portal user's additional email addresses. These email addresses are contacted when updates are made to support tickets.
    • getAdditionalEmails
      A portal user's additional email addresses. These email addresses are contacted when updates are made to support tickets.
    • getAdditionalEmails
      A portal user's additional email addresses. These email addresses are contacted when updates are made to support tickets.
    • getAdditionalPrimarySubnets
      The primary IPv4 subnets routed on this VLAN, excluding the primarySubnet.
    • getAdditionalProductsForCategory
      Returns a list of of active Items in the 'Additional Services' package with their active prices for a given product item category and sorts them by price.
    • getAdditionalRequiredPricesForOsReload
      Return a collection of SoftLayer_Item_Price objects for an OS reload
    • getAdditionalServiceFlag
      This flag indicates that the package is an additional service.
    • getAddress
      The customer address where the device is shipped to.
    • getAddresses
      All the address(es) that belong to an account.
    • getAddressSpace
      The classifier of IP addresses this subnet represents, generally PUBLIC or PRIVATE. This does not necessarily correlate with the network on which the subnet is used.
    • getAddressTranslationConfigurations
      The address translations will be returned. All the translations will be formatted so that the configurations can be copied into a host file. Format: {address translation SoftLayer IP Address} {address translation name}
    • getAddressTranslations
      A network tunnel's address translations.
    • getAdministratorEmailDomains
      Gets the email domains that can be used to validate a certificate to a domain.
    • getAdministratorEmailPrefixes
      Gets the email accounts that can be used to validate a certificate to a domain.
    • getAffiliate
    • getAffiliateId
      An affiliate identifier associated with the customer account.
    • getAffiliates
    • getAffiliatesAvailableForSelfEnrollmentByVerificationType
    • getAgentImpersonationToken
    • getAgentImpersonationToken
    • getAgentImpersonationToken
    • getAgreementType
      The type of agreement.
    • getAllAvailableCompatiblePlatformNames
      Get all available compatible platform names that can be added to a template group.
    • getAllAvailableServiceSubnets
      Subnets that provide access to SoftLayer services such as the management portal and the SoftLayer API.
    • getAllBackbones
      Retrieve a list of all SoftLayer backbone connections. Use this method if you need all backbones or don't know the id number of a specific backbone.
    • getAllBillingItems
      The billing items that will be on an account's next invoice.
    • getAllByUpgradePkgUrlId
    • getAllCancellationReasonCategories
      getAllCancellationReasonCategories() retrieves a list of all cancellation reason categories
    • getAllCancellationReasons
      getAllCancellationReasons() retrieves a list of all cancellation reasons that a server/service may be assigned to.
    • getAllCancellationRequests
      This method returns all service cancellation requests. Make sure to include the 'resultLimit' in the SOAP request header for quicker response. If there is no result limit header is passed, it will return the latest 25 results by default.
    • getAllCommissionBillingItems
      The billing items that will be on an account's next invoice.
    • getAllConnections
    • getAllContactTypes
      This method will return an array of SoftLayer_Account_Contact_Type objects which can be used when creating or editing an account contact.
    • getAllCouriers
      Retrieve a list of available shipping couriers.
    • getAllCouriersByType
      Retrieve a list of available shipping couriers.
    • getAllCurrencyExchangeRates
    • getAllDataCenters
      Retrieve a list of SoftLayer datacenter addresses.
    • getAllEventNames
      This all indexed event names.
    • getAllEventObjectNames
      This all indexed event object names.
    • getAllFiles
      {{CloudLayerOnlyMethod}} Retrieve details such as id, name, size, create date for all files in a Storage account's root directory. This does not download file content.
    • getAllFiles
      {{CloudLayerOnlyMethod}} Retrieve details such as id, name, size, create date for all files in a Storage account's root directory. This does not download file content.
    • getAllFiles
      {{CloudLayerOnlyMethod}} Retrieve details such as id, name, size, create date for all files in a Storage account's root directory. This does not download file content.
    • getAllFilesByFilter
      {{CloudLayerOnlyMethod}} Retrieve details such as id, name, size, create date for all files matching the filter's criteria in a Storage account's root directory. This does not download file content.
    • getAllFilesByFilter
      {{CloudLayerOnlyMethod}} Retrieve details such as id, name, size, create date for all files matching the filter's criteria in a Storage account's root directory. This does not download file content.
    • getAllFilesByFilter
      {{CloudLayerOnlyMethod}} Retrieve details such as id, name, size, create date for all files matching the filter's criteria in a Storage account's root directory. This does not download file content.
    • getAllGroups
      Get all configuration definition group objects. ''getAllGroups'' returns an array of SoftLayer_Configuration_Template_Section_Definition_Group objects upon success.
    • getAllHookTypes
    • getAllMediaTypes
      Retrieve a list supported media types for SoftLayer's Data Transfer Service.
    • getAllObjects
      Returns a list of all Integrated Offering Team regions. Note that this method, despite being visible, is not accessible by customers and attempting to use it will result in an error response.
    • getAllObjects
    • getAllObjects
      Retrieves a list of reviewers
    • getAllObjects
      This method will retrieve all SoftLayer_Account_ProofOfConcept_Campaign_Code objects. Use the `code` field when submitting a request on the [SoftLayer_Container_Account_ProofOfConcept_Request_Opportunity](/reference/datatypes/SoftLayer_Container_Account_ProofOfConcept_Request_Opportunity) container.
    • getAllObjects
    • getAllObjects
    • getAllObjects
    • getAllObjects
    • getAllObjects
      Retrieve an array of SoftLayer_Auxiliary_Notification_Emergency data types, which contain all notification events regardless of status.
    • getAllObjects
    • getAllObjects
    • getAllObjects
    • getAllObjects
      This will get all billing orders for your account.
    • getAllObjects
    • getAllObjects
      <<<EOT
    • getAllObjects
    • getAllObjects
    • getAllObjects
      Retrieves all available configuration templates
    • getAllObjects
    • getAllObjects
    • getAllObjects
    • getAllObjects
    • getAllObjects
      Return the event log data
    • getAllObjects
    • getAllObjects
      Use this method to retrieve all active layout containers that can be customized.
    • getAllObjects
      Retrieve all timezone objects.
    • getAllObjects
    • getAllObjects
      Get all pricing location groups.
    • getAllObjects
      Get all regional groups.
    • getAllObjects
    • getAllObjects
    • getAllObjects
    • getAllObjects
    • getAllObjects
    • getAllObjects
    • getAllObjects
      Return all existing Direct Link location.
    • getAllObjects
      Get all available firewall template objects. ''getAllObjects'' returns an array of SoftLayer_Network_Firewall_Template objects upon success.
    • getAllObjects
    • getAllObjects
      Return all existing load balancers
    • getAllObjects
      Returns all supported cipher list
    • getAllObjects
      Filtering is supported for ``datacenterName`` and ``capabilities``. When filtering on capabilities, use the ``in`` operation. Pods fulfilling all capabilities provided will be returned. ``datacenterName`` represents an operation against ``SoftLayer_Location_Datacenter.name`, such as dal05 when referring to Dallas 5. ```Examples:``` List Pods in a specific datacenter. <pre> datacenterName.operation = 'dal06' </pre> List Pods in a geographical area. <pre> datacenterName.operation = '^= dal' </pre> List Pods in a region fulfilling capabilities. <pre> datacenterName.operation = '^= dal' capabilities.operation = 'in' capabilities.options = [ { name = data, value = [SOME_CAPABILITY, ANOTHER_CAPABILITY] } ] </pre>
    • getAllObjects
      Get all security groups.
    • getAllObjects
    • getAllObjects
    • getAllObjects
    • getAllObjects
    • getAllObjects
    • getAllObjects
      Use this method to retrieve all network storage groups.
    • getAllObjects
      Use this method to retrieve all network storage groups.
    • getAllObjects
      Use this method to retrieve all network storage groups.
    • getAllObjects
      Use this method to retrieve all storage group types available.
    • getAllObjects
    • getAllObjects
      Use this method to retrieve all iSCSI OS Types.
    • getAllObjects
    • getAllObjects
    • getAllObjects
      Use this method to retrieve all network storage schedule property types.
    • getAllObjects
    • getAllObjects
      Use this method to retrieve all active notifications that can be subscribed to.
    • getAllObjects
      Use this method to retrieve all active notifications that can be subscribed to.
    • getAllObjects
    • getAllObjects
      Returns a collection of impacted users, an account master user has the ability to see all impacted users under the account.
    • getAllObjects
      This method pulls all the active packages. This will give you a basic description of the packages that are currently active
    • getAllObjects
      This method returns all the active package presets.
    • getAllObjects
      This method will grab all the package servers.
    • getAllObjects
      This method will return all of the available package types.
    • getAllObjects
    • getAllObjects
    • getAllObjects
    • getAllObjects
      Returns all SSL certificate server types, which are passed in on a [SoftLayer_Container_Product_Order_Security_Certificate](/reference/datatypes/SoftLayer_Container_Product_Order_Security_Certificate).
    • getAllObjects
      Return all account licenses
    • getAllObjects
    • getAllObjects
      Retrieve all possible ticket subjects. The SoftLayer customer portal uses this method in the add standard support ticket form.
    • getAllObjects
      Retrieve all ticket subject categories.
    • getAllObjects
      Retrieve all available permissions.
    • getAllObjects
      getAllObjects() will return a list of the available external binding vendors that SoftLayer supports. Use this list to select the appropriate vendor when creating a new external binding.
    • getAllObjects
    • getAllObjects
    • getAllObjects
      Retrieve all user status objects.
    • getAllObjects
      getAllObjects() will return a list of the available external binding vendors that SoftLayer supports. Use this list to select the appropriate vendor when creating a new external binding.
    • getAllObjects
      Object filters and result limits are enabled on this method.
    • getAllObjects
      Retrieve an array of SoftLayer_User_Permission_Resource_Type objects.
    • getAllObjects
      Retrieve all viewable security questions.
    • getAllObjects
    • getAllObjects
    • getAllObjects
    • getAllObjects
      Get all placement group rules.
    • getAllObjects
      Get all Citrix Virtual Apps And Desktop deployments.
    • getAllObjects
      Get all the resources of Citrix Deployments.
    • getAllocationStatus
      The container that represents allocations on the dedicated host.
    • getAllOptions
      This method will grab all the package server options.
    • getAllotment
      The bandwidth allotment that the reservation belongs to.
    • getAllotment
      The bandwidth allotment that the reservation belongs to.
    • getAllowableHardware
      This method retrieves a list of SoftLayer_Hardware that can be authorized to this SoftLayer_Network_Storage.
    • getAllowableHardware
      This method retrieves a list of SoftLayer_Hardware that can be authorized to this SoftLayer_Network_Storage.
    • getAllowableHardware
      This method retrieves a list of SoftLayer_Hardware that can be authorized to this SoftLayer_Network_Storage.
    • getAllowableIpAddresses
      This method retrieves a list of SoftLayer_Network_Subnet_IpAddress that can be authorized to this SoftLayer_Network_Storage.
    • getAllowableIpAddresses
      This method retrieves a list of SoftLayer_Network_Subnet_IpAddress that can be authorized to this SoftLayer_Network_Storage.
    • getAllowableIpAddresses
      This method retrieves a list of SoftLayer_Network_Subnet_IpAddress that can be authorized to this SoftLayer_Network_Storage.
    • getAllowableSubnets
      This method retrieves a list of SoftLayer_Network_Subnet that can be authorized to this SoftLayer_Network_Storage.
    • getAllowableSubnets
      This method retrieves a list of SoftLayer_Network_Subnet that can be authorized to this SoftLayer_Network_Storage.
    • getAllowableSubnets
      This method retrieves a list of SoftLayer_Network_Subnet that can be authorized to this SoftLayer_Network_Storage.
    • getAllowableVirtualGuests
      This method retrieves a list of SoftLayer_Virtual_Guest that can be authorized to this SoftLayer_Network_Storage.
    • getAllowableVirtualGuests
      This method retrieves a list of SoftLayer_Virtual_Guest that can be authorized to this SoftLayer_Network_Storage.
    • getAllowableVirtualGuests
      This method retrieves a list of SoftLayer_Virtual_Guest that can be authorized to this SoftLayer_Network_Storage.
    • getAllowAccountCreationFlag
      This flag indicates if creation of accounts is allowed.
    • getAllowDisasterRecoveryFailback
    • getAllowDisasterRecoveryFailback
    • getAllowDisasterRecoveryFailback
    • getAllowDisasterRecoveryFailover
    • getAllowDisasterRecoveryFailover
    • getAllowDisasterRecoveryFailover
    • getAllowedDedicatedHostIds
    • getAllowedDedicatedHostIds
    • getAllowedDedicatedHostIds
    • getAllowedHardware
      The SoftLayer_Hardware objects which are allowed access to this storage volume.
    • getAllowedHardware
      The SoftLayer_Hardware objects which are allowed access to this storage volume.
    • getAllowedHardware
      The SoftLayer_Hardware objects which are allowed access to this storage volume.
    • getAllowedHardwareIds
    • getAllowedHardwareIds
    • getAllowedHardwareIds
    • getAllowedHost
      The SoftLayer_Network_Storage_Allowed_Host information to connect this server to Network Storage volumes that require access control lists.
    • getAllowedHost
      The SoftLayer_Network_Storage_Allowed_Host information to connect this server to Network Storage volumes that require access control lists.
    • getAllowedHost
      The SoftLayer_Network_Storage_Allowed_Host information to connect this server to Network Storage volumes that require access control lists.
    • getAllowedHost
      The SoftLayer_Network_Storage_Allowed_Host information to connect this server to Network Storage volumes that require access control lists.
    • getAllowedHost
      The SoftLayer_Network_Storage_Allowed_Host information to connect this server to Network Storage volumes that require access control lists.
    • getAllowedHost
      The link from this subnet to network storage devices supporting access control lists.
    • getAllowedHost
      The SoftLayer_Network_Storage_Allowed_Host information to connect this IP Address to Network Storage supporting access control lists.
    • getAllowedHost
      The SoftLayer_Network_Storage_Allowed_Host information to connect this Virtual Guest to Network Storage volumes that require access control lists.
    • getAllowedHosts
      The allowed hosts list for this group.
    • getAllowedHosts
      The allowed hosts list for this group.
    • getAllowedHosts
      The allowed hosts list for this group.
    • getAllowedHostsLimit
      Retrieves the total number of allowed hosts limit per volume.
    • getAllowedHostsLimit
      Retrieves the total number of allowed hosts limit per volume.
    • getAllowedHostsLimit
      Retrieves the total number of allowed hosts limit per volume.
    • getAllowedIpAddresses
      The SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this storage volume.
    • getAllowedIpAddresses
      The SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this storage volume.
    • getAllowedIpAddresses
      The SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this storage volume.
    • getAllowedNetworkStorage
      The SoftLayer_Network_Storage objects that this SoftLayer_Hardware has access to.
    • getAllowedNetworkStorage
      The SoftLayer_Network_Storage objects that this SoftLayer_Hardware has access to.
    • getAllowedNetworkStorage
      The SoftLayer_Network_Storage objects that this SoftLayer_Hardware has access to.
    • getAllowedNetworkStorage
      The SoftLayer_Network_Storage objects that this SoftLayer_Hardware has access to.
    • getAllowedNetworkStorage
      The SoftLayer_Network_Storage objects that this SoftLayer_Hardware has access to.
    • getAllowedNetworkStorage
      The network storage devices this subnet has been granted access to.
    • getAllowedNetworkStorage
      The SoftLayer_Network_Storage objects that this SoftLayer_Hardware has access to.
    • getAllowedNetworkStorage
      The SoftLayer_Network_Storage objects that this SoftLayer_Virtual_Guest has access to.
    • getAllowedNetworkStorageReplicas
      The SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Hardware has access to.
    • getAllowedNetworkStorageReplicas
      The SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Hardware has access to.
    • getAllowedNetworkStorageReplicas
      The SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Hardware has access to.
    • getAllowedNetworkStorageReplicas
      The SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Hardware has access to.
    • getAllowedNetworkStorageReplicas
      The SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Hardware has access to.
    • getAllowedNetworkStorageReplicas
      The network storage device replicas this subnet has been granted access to.
    • getAllowedNetworkStorageReplicas
      The SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Hardware has access to.
    • getAllowedNetworkStorageReplicas
      The SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Virtual_Guest has access to.
    • getAllowedOsPriceIds
      Used to get a list of OS prices (ids) which are allowed for the Gateway.
    • getAllowedReplicationHardware
      The SoftLayer_Hardware objects which are allowed access to this storage volume's Replicant.
    • getAllowedReplicationHardware
      The SoftLayer_Hardware objects which are allowed access to this storage volume's Replicant.
    • getAllowedReplicationHardware
      The SoftLayer_Hardware objects which are allowed access to this storage volume's Replicant.
    • getAllowedReplicationIpAddresses
      The SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this storage volume's Replicant.
    • getAllowedReplicationIpAddresses
      The SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this storage volume's Replicant.
    • getAllowedReplicationIpAddresses
      The SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this storage volume's Replicant.
    • getAllowedReplicationSubnets
      The SoftLayer_Network_Subnet objects which are allowed access to this storage volume's Replicant.
    • getAllowedReplicationSubnets
      The SoftLayer_Network_Subnet objects which are allowed access to this storage volume's Replicant.
    • getAllowedReplicationSubnets
      The SoftLayer_Network_Subnet objects which are allowed access to this storage volume's Replicant.
    • getAllowedReplicationVirtualGuests
      The SoftLayer_Hardware objects which are allowed access to this storage volume's Replicant.
    • getAllowedReplicationVirtualGuests
      The SoftLayer_Hardware objects which are allowed access to this storage volume's Replicant.
    • getAllowedReplicationVirtualGuests
      The SoftLayer_Hardware objects which are allowed access to this storage volume's Replicant.
    • getAllowedSubnets
      The SoftLayer_Network_Subnet objects which are allowed access to this storage volume.
    • getAllowedSubnets
      The SoftLayer_Network_Subnet objects which are allowed access to this storage volume.
    • getAllowedSubnets
      The SoftLayer_Network_Subnet objects which are allowed access to this storage volume.
    • getAllowedVirtualGuestIds
    • getAllowedVirtualGuestIds
    • getAllowedVirtualGuestIds
    • getAllowedVirtualGuests
      The SoftLayer_Virtual_Guest objects which are allowed access to this storage volume.
    • getAllowedVirtualGuests
      The SoftLayer_Virtual_Guest objects which are allowed access to this storage volume.
    • getAllowedVirtualGuests
      The SoftLayer_Virtual_Guest objects which are allowed access to this storage volume.
    • getAllowIbmIdSilentMigrationFlag
      Indicates whether this account is allowed to silently migrate to use IBMid Authentication.
    • getAllOwnedAccounts
      All accounts owned by the brand.
    • getAllowsBluemixAccountLinkingFlag
      Flag indicating if this account can be linked with Bluemix.
    • getAllPortLabelsWithCurrentUsage
    • getAllPowerComponents
    • getAllPowerComponents
    • getAllPowerComponents
    • getAllPowerComponents
    • getAllPowerComponents
    • getAllPublishedPartners
    • getAllQueryTypes
      Calling this function returns all possible query type objects. These objects are to be used to set the values on the SoftLayer_Network_Monitor_Version1_Query_Host when creating new monitoring instances.
    • getAllRecurringTopLevelBillingItems
      The billing items that will be on an account's next invoice.
    • getAllRecurringTopLevelBillingItemsUnfiltered
      The billing items that will be on an account's next invoice. Does not consider associated items.
    • getAllRequestStatuses
      Retrieves a list of all the possible statuses to which a request may be set.
    • getAllRequestStatuses
      Retrieves a list of all the possible statuses to which a request may be set.
    • getAllResponseTypes
      Calling this function returns all possible response type objects. These objects are to be used to set the values on the SoftLayer_Network_Monitor_Version1_Query_Host when creating new monitoring instances.
    • getAllShipmentStatuses
      Retrieve a a list of shipment statuses.
    • getAllShipmentTypes
      Retrieve a a list of shipment types.
    • getAllStatuses
      This method returns all transcode job statuses.
    • getAllSubnetBillingItems
      The billing items that will be on an account's next invoice.
    • getAllTagTypes
      Returns all tags of a given object type.
    • getAllTicketGroups
      getAllTicketGroups() retrieves a list of all groups that a ticket may be assigned to. Ticket groups represent the internal department at SoftLayer who a ticket is assigned to. Every SoftLayer ticket has groupId and ticketGroup properties that correspond to one of the groups returned by getAllTicketGroups().
    • getAllTicketStatuses
      getAllTicketStatuses() retrieves a list of all statuses that a ticket may exist in. Ticket status represent the current state of a ticket, usually 'open', 'assigned', and 'closed'. Every SoftLayer ticket has statusId and status properties that correspond to one of the statuses returned by getAllTicketStatuses().
    • getAllTicketSubjects
      (DEPRECATED) Use [SoftLayer_Ticket_Subject::getAllObjects](/reference/datatypes/$1/#$2) method.
    • getAllTopLevelBillingItems
      All billing items of an account.
    • getAllTopLevelBillingItemsUnfiltered
      The billing items that will be on an account's next invoice. Does not consider associated items.
    • getAllUpgradesByGatewayId
    • getAllUserTypes
      Returns all possible event log user types
    • getAllVatCountryCodesAndVatIdRegexes
      This method is to get the collection of VAT country codes and VAT ID Regexes.
    • getAlternateCreditCardData
    • getAmount
      This is the amount of this invoice.
    • getAncestorGroups
      A resource group's associated group ancestors.
    • getAntivirusSpywareSoftwareComponent
      Information regarding an antivirus/spyware software component object.
    • getAntivirusSpywareSoftwareComponent
      Information regarding an antivirus/spyware software component object.
    • getAntivirusSpywareSoftwareComponent
      Information regarding an antivirus/spyware software component object.
    • getAntivirusSpywareSoftwareComponent
      Information regarding an antivirus/spyware software component object.
    • getAntivirusSpywareSoftwareComponent
      Information regarding an antivirus/spyware software component object.
    • getAntivirusSpywareSoftwareComponent
      A antivirus / spyware software component object.
    • getApiAuthenticationKeys
      A portal user's API Authentication keys. There is a max limit of one API key per user.
    • getApiAuthenticationKeys
      A portal user's API Authentication keys. There is a max limit of one API key per user.
    • getApiAuthenticationKeys
      A portal user's API Authentication keys. There is a max limit of one API key per user.
    • getApplicationDeliveryController
      A virtual IP address's associated application delivery controller.
    • getApplicationDeliveryController
      The application delivery controller using this address.
    • getApplicationDeliveryController
    • getApplicationDeliveryControllers
      An account's associated application delivery controller records.
    • getApplicationDeliveryControllers
      A virtual IP address's associated application delivery controllers.
    • getApplicationDeliveryControllers
      The Application Delivery Controller contained within a virtual rack.
    • getApplyServerRuleSubnets
      The additional subnets linked to this network component firewall, that inherit rules from the host that the context slot is attached to.
    • getApprovers
    • getApprovers
    • getApproverTypes
    • getArchitectureType
    • getArchiveDiskUsageRatePerGb
      Returns the archive storage disk usage fee rate per gigabyte.
    • getAssignedAgents
    • getAssignedEmployees
    • getAssignedGroups
      The SoftLayer_Network_Storage_Group objects this SoftLayer_Network_Storage_Allowed_Host is present in.
    • getAssignedGroups
      The SoftLayer_Network_Storage_Group objects this SoftLayer_Network_Storage_Allowed_Host is present in.
    • getAssignedGroups
      The SoftLayer_Network_Storage_Group objects this SoftLayer_Network_Storage_Allowed_Host is present in.
    • getAssignedGroups
      The SoftLayer_Network_Storage_Group objects this SoftLayer_Network_Storage_Allowed_Host is present in.
    • getAssignedGroups
      The SoftLayer_Network_Storage_Group objects this SoftLayer_Network_Storage_Allowed_Host is present in.
    • getAssignedIscsiVolumes
      The SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Allowed_Host is allowed access.
    • getAssignedIscsiVolumes
      The SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Allowed_Host is allowed access.
    • getAssignedIscsiVolumes
      The SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Allowed_Host is allowed access.
    • getAssignedIscsiVolumes
      The SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Allowed_Host is allowed access.
    • getAssignedIscsiVolumes
      The SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Allowed_Host is allowed access.
    • getAssignedNfsVolumes
      The SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Allowed_Host is allowed access.
    • getAssignedNfsVolumes
      The SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Allowed_Host is allowed access.
    • getAssignedNfsVolumes
      The SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Allowed_Host is allowed access.
    • getAssignedNfsVolumes
      The SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Allowed_Host is allowed access.
    • getAssignedNfsVolumes
      The SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Allowed_Host is allowed access.
    • getAssignedReplicationVolumes
      The SoftLayer_Network_Storage primary volumes whose replicas are allowed access.
    • getAssignedReplicationVolumes
      The SoftLayer_Network_Storage primary volumes whose replicas are allowed access.
    • getAssignedReplicationVolumes
      The SoftLayer_Network_Storage primary volumes whose replicas are allowed access.
    • getAssignedReplicationVolumes
      The SoftLayer_Network_Storage primary volumes whose replicas are allowed access.
    • getAssignedReplicationVolumes
      The SoftLayer_Network_Storage primary volumes whose replicas are allowed access.
    • getAssignedUser
      The portal user that a ticket is assigned to.
    • getAssignedVolumes
      The SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Allowed_Host is allowed access.
    • getAssignedVolumes
      The SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Allowed_Host is allowed access.
    • getAssignedVolumes
      The SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Allowed_Host is allowed access.
    • getAssignedVolumes
      The SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Allowed_Host is allowed access.
    • getAssignedVolumes
      The SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Allowed_Host is allowed access.
    • getAssociatedBillingItem
      A billing item's associated parent. This is to be used for billing items that are 'floating', and therefore are not child items of any parent billing item. If it is desired to associate an item to another, populate this with the SoftLayer_Billing_Item ID of that associated parent item.
    • getAssociatedBillingItem
      A billing item's associated parent. This is to be used for billing items that are 'floating', and therefore are not child items of any parent billing item. If it is desired to associate an item to another, populate this with the SoftLayer_Billing_Item ID of that associated parent item.
    • getAssociatedBillingItemHistory
      A history of billing items which a billing item has been associated with.
    • getAssociatedBillingItemHistory
      A history of billing items which a billing item has been associated with.
    • getAssociatedChildren
      An Invoice Item's associated child invoice items. Only parent invoice items have associated children. For instance, a server invoice item may have associated children.
    • getAssociatedChildren
      A Billing Item's associated child billing items. This includes 'floating' items that are not necessarily child billing items of this billing item.
    • getAssociatedChildren
      A Billing Item's associated child billing items. This includes 'floating' items that are not necessarily child billing items of this billing item.
    • getAssociatedChildren
      A Billing Item's associated child billing items. This includes 'floating' items that are not necessarily child billing items of this billing item.
    • getAssociatedInvoiceItem
      An Invoice Item's associated invoice item. If this is populated, it means this is an orphaned invoice item, but logically belongs to the associated invoice item.
    • getAssociatedParent
      A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set.
    • getAssociatedParent
      A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set.
    • getAssociatedServiceCount
      The number of services currently associated with the certificate.
    • getAttachedAdditionalEmails
      The list of additional emails to notify when a ticket update is made.
    • getAttachedBillingAgreementFiles
      The files attached to an agreement.
    • getAttachedDedicatedHosts
      The Dedicated Hosts associated with a ticket. This is used in cases where a ticket is directly associated with one or more Dedicated Hosts.
    • getAttachedFile
      Retrieve the contents of the file attached to a SoftLayer event by it's given identifier.
    • getAttachedFile
      Retrieve the file attached to a SoftLayer ticket by it's given identifier. To retrieve a list of files attached to a ticket either call the SoftLayer_Ticket::getAttachedFiles method or call SoftLayer_Ticket::getObject with ''attachedFiles'' defined in an object mask.
    • getAttachedFiles
      The files attached to a ticket.
    • getAttachedHardware
      The hardware associated with a ticket. This is used in cases where a ticket is directly associated with one or more pieces of hardware.
    • getAttachedHardwareCount
    • getAttachedNetworkGateway
      The gateway device this VLAN is associated with for routing purposes.
    • getAttachedNetworkGatewayFlag
      A value of '1' indicates this VLAN is associated with a gateway device for routing purposes.
    • getAttachedNetworkGatewayVlan
      The gateway device VLAN context this VLAN is associated with for routing purposes.
    • getAttachedNetworkStorages
      This method is retrieve a list of SoftLayer_Network_Storage volumes that are authorized access to this SoftLayer_Hardware.
    • getAttachedNetworkStorages
      This method is retrieve a list of SoftLayer_Network_Storage volumes that are authorized access to this SoftLayer_Hardware.
    • getAttachedNetworkStorages
      This method is retrieve a list of SoftLayer_Network_Storage volumes that are authorized access to this SoftLayer_Hardware.
    • getAttachedNetworkStorages
      This method is retrieve a list of SoftLayer_Network_Storage volumes that are authorized access to this SoftLayer_Hardware.
    • getAttachedNetworkStorages
      This method is retrieve a list of SoftLayer_Network_Storage volumes that are authorized access to this SoftLayer_Hardware.
    • getAttachedNetworkStorages
      Retrieves the combination of network storage devices and replicas this subnet has been granted access to. Allows for filtering based on storage device type.
    • getAttachedNetworkStorages
      This method is retrieve a list of SoftLayer_Network_Storage volumes that are authorized access to this SoftLayer_Network_Subnet_IpAddress.
    • getAttachedNetworkStorages
      This method is retrieve a list of SoftLayer_Network_Storage volumes that are authorized access to this SoftLayer_Virtual_Guest.
    • getAttachedResources
    • getAttachedTagsForCurrentUser
      Get all tags with at least one reference attached to it for the current account. The total items header for this method contains the total number of attached tags even if a result limit is applied.
    • getAttachedVirtualGuests
      The virtual guests associated with a ticket. This is used in cases where a ticket is directly associated with one or more virtualized guests installations or Virtual Servers.
    • getAttachedVolumes
      The network storage volumes this group is attached to.
    • getAttachedVolumes
      The network storage volumes this group is attached to.
    • getAttachedVolumes
      The network storage volumes this group is attached to.
    • getAttachments
    • getAttachments
      A collection of attachments for this event which provide supplementary information to impacted users some examples are RFO (Reason For Outage) and root cause analysis documents.
    • getAttributeByType
      Retrieve a single [SoftLayer_Account_Attribute](/reference/datatypes/SoftLayer_Account_Attribute) record by its [SoftLayer_Account_Attribute_Type](/reference/datatypes/SoftLayer_Account_Attribute_Type) key name.
    • getAttributes
      The account attribute values for a SoftLayer customer account.
    • getAttributes
      The saml attribute values for a SoftLayer customer account.
    • getAttributes
    • getAttributes
      Information regarding a piece of hardware's specific attributes.
    • getAttributes
    • getAttributes
      Information regarding a piece of hardware's specific attributes.
    • getAttributes
      Information regarding a piece of hardware's specific attributes.
    • getAttributes
      Information regarding a piece of hardware's specific attributes.
    • getAttributes
      Information regarding a piece of hardware's specific attributes.
    • getAttributes
    • getAttributes
      The attributes for this member.
    • getAttributes
      The attribute values for a product item. These are additional properties that give extra information about the product being sold.
    • getAttributes
    • getAttributes
    • getAttributes
      A resource group's associated attributes.
    • getAttributes
    • getAttributes
      Attributes of an external authentication binding.
    • getAttributes
      Attributes of an external authentication binding.
    • getAttributes
      Attributes of an external authentication binding.
    • getAttributes
      Attributes of an external authentication binding.
    • getAttributes
    • getAuthenticationCode
      The getAuthenticationCode method retrieves the authentication code for the domain.
    • getAuthenticationDefault
      The default authentication type used for both phases of the negotiation process. The default value is set to MD5.
    • getAuthenticationOptions
      Authentication options available for both phases of the negotiation process. The authentication options are as follows: * MD5 * SHA1 * SHA256
    • getAuthenticationRecord
      The SoftLayer account authentication that has an attribute.
    • getAuthenticationToken
      This method generate user authentication token and return [SoftLayer_Container_User_Authentication_Token](/reference/datatypes/SoftLayer_Container_User_Authentication_Token) object which will be used to authenticate user to login to SoftLayer customer portal.
    • getAuthenticationToken
      This method generate user authentication token and return [SoftLayer_Container_User_Authentication_Token](/reference/datatypes/SoftLayer_Container_User_Authentication_Token) object which will be used to authenticate user to login to SoftLayer customer portal.
    • getAuthenticationToken
      This method generate user authentication token and return [SoftLayer_Container_User_Authentication_Token](/reference/datatypes/SoftLayer_Container_User_Authentication_Token) object which will be used to authenticate user to login to SoftLayer customer portal.
    • getAuthenticationUrl
      Returns URL used to authenticate reviewers
    • getAuthorizationUrl
      Gets the URL used to perform manager validation.
    • getAuthorizingUser
      The user that authorized this firewall update request.
    • getAuxiliaryNotifications
    • getAvailabilityAttributes
      Attributes that govern when an item may no longer be available.
    • getAvailableBillingTermChangePrices
      Retrieves a list of available term prices to this hardware. Currently, price terms are only available for increasing term length to monthly billed servers.
    • getAvailableBillingTermChangePrices
      Retrieves a list of available term prices to this hardware. Currently, price terms are only available for increasing term length to monthly billed servers.
    • getAvailableBillingTermChangePrices
      Retrieves a list of available term prices to this hardware. Currently, price terms are only available for increasing term length to monthly billed servers.
    • getAvailableBillingTermChangePrices
      Retrieves a list of available term prices to this hardware. Currently, price terms are only available for increasing term length to monthly billed servers.
    • getAvailableBillingTermChangePrices
      Retrieves a list of available term prices to this hardware. Currently, price terms are only available for increasing term length to monthly billed servers.
    • getAvailableBlockDevicePositions
    • getAvailableBootModes
      Returns a collection of boot modes that are supported for primary disks.
    • getAvailableCountries
      Use this method to retrieve a list of countries and locale information available to the current user.
    • getAvailableFlag
      Flag to indecate whether or not the reserved instance is available or not.
    • getAvailableInstances
      The instances available for guest provisions on this reserved capacity group.
    • getAvailableLocations
      A collection of valid locations for this package. (Deprecated - Use [SoftLayer_Product_Package::getRegions](/reference/services/SoftLayer_Product_Package/getRegions))
    • getAvailableMatchingVlans
    • getAvailableMatchingVlans
    • getAvailableMonitoring
      An object that stores the maximum level for the monitoring query types and response types.
    • getAvailableMonitoring
      An object that stores the maximum level for the monitoring query types and response types.
    • getAvailableMonitoring
      An object that stores the maximum level for the monitoring query types and response types.
    • getAvailableMonitoring
      An object that stores the maximum level for the monitoring query types and response types.
    • getAvailableNetworkStorages
      This method retrieves a list of SoftLayer_Network_Storage volumes that can be authorized to this SoftLayer_Hardware.
    • getAvailableNetworkStorages
      This method retrieves a list of SoftLayer_Network_Storage volumes that can be authorized to this SoftLayer_Hardware.
    • getAvailableNetworkStorages
      This method retrieves a list of SoftLayer_Network_Storage volumes that can be authorized to this SoftLayer_Hardware.
    • getAvailableNetworkStorages
      This method retrieves a list of SoftLayer_Network_Storage volumes that can be authorized to this SoftLayer_Hardware.
    • getAvailableNetworkStorages
      This method retrieves a list of SoftLayer_Network_Storage volumes that can be authorized to this SoftLayer_Hardware.
    • getAvailableNetworkStorages
      Retrieves the combination of network storage devices and replicas this subnet has NOT been granted access to. Allows for filtering based on storage device type.
    • getAvailableNetworkStorages
      This method retrieves a list of SoftLayer_Network_Storage volumes that can be authorized to this SoftLayer_Network_Subnet_IpAddress.
    • getAvailableNetworkStorages
      This method retrieves a list of SoftLayer_Network_Storage volumes that can be authorized to this SoftLayer_Virtual_Guest.
    • getAvailableObjectStorageDatacenters
      Object Storage is only available in select datacenters. This method will return all the datacenters where object storage is available.
    • getAvailableObjectStorageDatacenters
      Object Storage is only available in select datacenters. This method will return all the datacenters where object storage is available.
    • getAvailablePackagesForImageTemplate
    • getAvailablePublicNetworkVlans
      The public network VLANs assigned to an account.
    • getAvailablePushNotificationSubscriptions
      Notification subscriptions available to a mobile device.
    • getAvailableRouters
      This method will get the available backend routers to order a dedicated host.
    • getAvailableRouters
      Returns all routers available for use with placement groups. If a datacenter location ID is provided, this method will further restrict the list of routers to ones contained within that datacenter.
    • getAvailableSecureTransportCiphers
      Yields a list of the SSL/TLS encryption ciphers that are currently supported on this virtual IP address instance.
    • getAvailableSecureTransportProtocols
      Yields a list of the secure communication protocols that are currently supported on this virtual IP address instance. The list of supported ciphers for each protocol is culled to match availability.
    • getAvailableSlots
    • getAvailableStorageUnits
      The maximum number of available disk storage units associated with the servers in a package.
    • getAvailableStorageUnits
    • getAverageArchiveUsageMetricDataByDate
      Returns the average disk space usage for all archive repositories.
    • getAverageDailyBandwidthUsage
      The average daily total bandwidth usage for the current billing cycle.
    • getAverageDailyBandwidthUsage
      The average daily total bandwidth usage for the current billing cycle.
    • getAverageDailyBandwidthUsage
      The average daily total bandwidth usage for the current billing cycle.
    • getAverageDailyPrivateBandwidthUsage
      The average daily private bandwidth usage for the current billing cycle.
    • getAverageDailyPrivateBandwidthUsage
      The average daily private bandwidth usage for the current billing cycle.
    • getAverageDailyPrivateBandwidthUsage
      The average daily private bandwidth usage for the current billing cycle.
    • getAverageDailyPrivateBandwidthUsage
      The average daily private bandwidth usage for the current billing cycle.
    • getAverageDailyPublicBandwidthUsage
      The average daily public bandwidth usage for the current billing cycle.
    • getAverageDailyPublicBandwidthUsage
      The average daily public bandwidth usage for the current billing cycle.
    • getAverageDailyPublicBandwidthUsage
      The average daily public bandwidth usage for the current billing cycle.
    • getAverageDailyPublicBandwidthUsage
      The average daily public bandwidth usage for the current billing cycle.
    • getAverageDailyPublicBandwidthUsage
      The average daily public bandwidth usage for the current billing cycle.
    • getAverageDailyPublicBandwidthUsage
      The average daily public bandwidth usage for the current billing cycle.
    • getAverageDailyPublicBandwidthUsage
      The average daily public bandwidth usage for the current billing cycle.
    • getAverageDailyPublicBandwidthUsage
      The average daily public bandwidth usage for the current billing cycle.
    • getAverageDiskUsageMetricDataFromInfluxByDate
      Returns the average disk space usage for a storage repository.
    • getAverageInstallationDuration
      The average amount of time that a software component takes to install.
    • getAverageInstallationDuration
      The average amount of time that a software component takes to install.
    • getAverageInstallationDuration
      The average amount of time that a software component takes to install.
    • getAverageInstallationDuration
      The average amount of time that a software component takes to install.
    • getAverageInstallationDuration
      The average amount of time that a software description takes to install.
    • getAveragePublicUsageMetricDataByDate
      Returns the average disk space usage for all public repositories.
    • getAverageUsageMetricDataByDate
      Returns the average disk space usage for a storage repository.
    • getAwaitingUserResponseFlag
      Ticket is waiting on a response from a customer flag.
    • getBackboneBandwidthGraph
      [DEPRECATED] Retrieve a PNG image of the last 24 hours of bandwidth usage of one of SoftLayer's network backbones.
    • getBackboneDependents
    • getBackboneDependents
    • getBackbonesForLocationName
      Retrieve a list of all SoftLayer backbone connections for a location name.
    • getBackendBandwidthUsage
      Use this method to return an array of private bandwidth utilization records between a given date range. This method represents the NEW version of getFrontendBandwidthUse
    • getBackendBandwidthUsage
      Use this method to return an array of private bandwidth utilization records between a given date range. This method represents the NEW version of getFrontendBandwidthUse
    • getBackendBandwidthUsage
      Use this method to return an array of private bandwidth utilization records between a given date range. This method represents the NEW version of getFrontendBandwidthUse
    • getBackendHardwareRouters
    • getBackendIncomingBandwidth
      The '''getBackendIncomingBandwidth''' method retrieves the amount of incoming private network traffic used between the given start date and end date parameters. When entering start and end dates, only the month, day and year are used to calculate bandwidth totals - the time (HH:MM:SS) is ignored and defaults to midnight. The amount of bandwidth retrieved is measured in gigabytes.
    • getBackendIncomingBandwidth
      The '''getBackendIncomingBandwidth''' method retrieves the amount of incoming private network traffic used between the given start date and end date parameters. When entering start and end dates, only the month, day and year are used to calculate bandwidth totals - the time (HH:MM:SS) is ignored and defaults to midnight. The amount of bandwidth retrieved is measured in gigabytes.
    • getBackendIncomingBandwidth
      The '''getBackendIncomingBandwidth''' method retrieves the amount of incoming private network traffic used between the given start date and end date parameters. When entering start and end dates, only the month, day and year are used to calculate bandwidth totals - the time (HH:MM:SS) is ignored and defaults to midnight. The amount of bandwidth retrieved is measured in gigabytes.
    • getBackendIncomingBandwidth
      The '''getBackendIncomingBandwidth''' method retrieves the amount of incoming private network traffic used between the given start date and end date parameters. When entering start and end dates, only the month, day and year are used to calculate bandwidth totals - the time (HH:MM:SS) is ignored and defaults to midnight. The amount of bandwidth retrieved is measured in gigabytes.
    • getBackendIncomingBandwidth
      The '''getBackendIncomingBandwidth''' method retrieves the amount of incoming private network traffic used between the given start date and end date parameters. When entering start and end dates, only the month, day and year are used to calculate bandwidth totals - the time (HH:MM:SS) is ignored and defaults to midnight. The amount of bandwidth retrieved is measured in gigabytes.
    • getBackendMacAddresses
      The getBackendMacAddresses method retrieves a list of backend MAC addresses for the resource
    • getBackendNetworkComponents
      A piece of hardware's back-end or private network components.
    • getBackendNetworkComponents
      A piece of hardware's back-end or private network components.
    • getBackendNetworkComponents
      A piece of hardware's back-end or private network components.
    • getBackendNetworkComponents
      A piece of hardware's back-end or private network components.
    • getBackendNetworkComponents
      A piece of hardware's back-end or private network components.
    • getBackendNetworkComponents
      A guests's backend network components.
    • getBackendOutgoingBandwidth
      The '''getBackendOutgoingBandwidth''' method retrieves the amount of outgoing private network traffic used between the given start date and end date parameters. When entering start and end dates, only the month, day and year are used to calculate bandwidth totals - the time (HH:MM:SS) is ignored and defaults to midnight. The amount of bandwidth retrieved is measured in gigabytes.
    • getBackendOutgoingBandwidth
      The '''getBackendOutgoingBandwidth''' method retrieves the amount of outgoing private network traffic used between the given start date and end date parameters. When entering start and end dates, only the month, day and year are used to calculate bandwidth totals - the time (HH:MM:SS) is ignored and defaults to midnight. The amount of bandwidth retrieved is measured in gigabytes.
    • getBackendOutgoingBandwidth
      The '''getBackendOutgoingBandwidth''' method retrieves the amount of outgoing private network traffic used between the given start date and end date parameters. When entering start and end dates, only the month, day and year are used to calculate bandwidth totals - the time (HH:MM:SS) is ignored and defaults to midnight. The amount of bandwidth retrieved is measured in gigabytes.
    • getBackendOutgoingBandwidth
      The '''getBackendOutgoingBandwidth''' method retrieves the amount of outgoing private network traffic used between the given start date and end date parameters. When entering start and end dates, only the month, day and year are used to calculate bandwidth totals - the time (HH:MM:SS) is ignored and defaults to midnight. The amount of bandwidth retrieved is measured in gigabytes.
    • getBackendOutgoingBandwidth
      The '''getBackendOutgoingBandwidth''' method retrieves the amount of outgoing private network traffic used between the given start date and end date parameters. When entering start and end dates, only the month, day and year are used to calculate bandwidth totals - the time (HH:MM:SS) is ignored and defaults to midnight. The amount of bandwidth retrieved is measured in gigabytes.
    • getBackendRouter
      The backend router behind dedicated host's pool of resources.
    • getBackendRouter
      The router the placement group is implemented on.
    • getBackendRouter
      The router the reserved capacity group is implemented on.
    • getBackendRouters
      A hardware's backend or private router.
    • getBackendRouters
      A hardware's backend or private router.
    • getBackendRouters
      A hardware's backend or private router.
    • getBackendRouters
      A hardware's backend or private router.
    • getBackendRouters
      A hardware's backend or private router.
    • getBackendRouters
      A guest's backend or private router.
    • getBalance
      The account balance of a SoftLayer customer account. An account's balance is the amount of money owed to SoftLayer by the account holder, returned as a floating point number with two decimal places, measured in US Dollars ($USD). A negative account balance means the account holder has overpaid and is owed money by SoftLayer.
    • getBandwidthAllocation
      The bandwidth allocation for a billing item.
    • getBandwidthAllocation
      The bandwidth allocation for a billing item.
    • getBandwidthAllocation
      A hardware's allotted bandwidth (measured in GB).
    • getBandwidthAllocation
      A hardware's allotted bandwidth (measured in GB).
    • getBandwidthAllocation
      A hardware's allotted bandwidth (measured in GB).
    • getBandwidthAllocation
      A hardware's allotted bandwidth (measured in GB).
    • getBandwidthAllocation
      A hardware's allotted bandwidth (measured in GB).
    • getBandwidthAllocation
      A firewall's allotted bandwidth (measured in GB).
    • getBandwidthAllocation
      A computing instance's allotted bandwidth (measured in GB).
    • getBandwidthAllotmentDetail
      A hardware's allotted detail record. Allotment details link bandwidth allocation with allotments.
    • getBandwidthAllotmentDetail
      A hardware's allotted detail record. Allotment details link bandwidth allocation with allotments.
    • getBandwidthAllotmentDetail
      A hardware's allotted detail record. Allotment details link bandwidth allocation with allotments.
    • getBandwidthAllotmentDetail
      A hardware's allotted detail record. Allotment details link bandwidth allocation with allotments.
    • getBandwidthAllotmentDetail
      A hardware's allotted detail record. Allotment details link bandwidth allocation with allotments.
    • getBandwidthAllotmentDetail
      A computing instance's allotted detail record. Allotment details link bandwidth allocation with allotments.
    • getBandwidthAllotments
      The bandwidth allotments for an account.
    • getBandwidthAllotmentsOverAllocation
      The bandwidth allotments for an account currently over allocation.
    • getBandwidthAllotmentsProjectedOverAllocation
      The bandwidth allotments for an account projected to go over allocation.
    • getBandwidthAllotmentType
      The bandwidth allotment type of this virtual rack.
    • getBandwidthCategories
    • getBandwidthData
      Retrieve a collection of raw bandwidth data from an individual public or private network tracking object. Raw data is ideal if you with to employ your own traffic storage and graphing systems.
    • getBandwidthDataByDate
    • getBandwidthDataByDate
      Use this method when needing the metric data for bandwidth for a single guest. It will gather the correct input parameters based on the date ranges
    • getBandwidthForDateRange
      Retrieve a collection of bandwidth data from an individual public or private network tracking object. Data is ideal if you with to employ your own traffic storage and graphing systems.
    • getBandwidthForDateRange
      Retrieve a collection of bandwidth data from an individual public or private network tracking object. Data is ideal if you with to employ your own traffic storage and graphing systems.
    • getBandwidthForDateRange
      Retrieve a collection of bandwidth data from an individual public or private network tracking object. Data is ideal if you with to employ your own traffic storage and graphing systems.
    • getBandwidthForDateRange
      Retrieve a collection of bandwidth data from an individual public or private network tracking object. Data is ideal if you with to employ your own traffic storage and graphing systems.
    • getBandwidthForDateRange
      Retrieve a collection of bandwidth data from an individual public or private network tracking object. Data is ideal if you with to employ your own traffic storage and graphing systems.
    • getBandwidthGraph
      Retrieve a PNG image of a bandwidth graph representing the bandwidth usage over time recorded by SofTLayer's bandwidth pollers.
    • getBandwidthImage
      Use this method when needing a bandwidth image for a single server. It will gather the correct input parameters for the generic graphing utility automatically based on the snapshot specified. Use the $draw flag to suppress the generation of the actual binary PNG image.
    • getBandwidthImage
      Use this method when needing a bandwidth image for a single server. It will gather the correct input parameters for the generic graphing utility automatically based on the snapshot specified. Use the $draw flag to suppress the generation of the actual binary PNG image.
    • getBandwidthImage
      Use this method when needing a bandwidth image for a single server. It will gather the correct input parameters for the generic graphing utility automatically based on the snapshot specified. Use the $draw flag to suppress the generation of the actual binary PNG image.
    • getBandwidthImage
      This method recurses through all servers on a Bandwidth Pool for a given snapshot range, gathers the necessary parameters, and then calls the bandwidth graphing server. The return result is a container that includes the min and max dates for all servers to be used in the query, as well as an image in PNG format. This method uses the new and improved drawing routines which should return in a reasonable time frame now that the new backend data warehouse is used.
    • getBandwidthImage
      Use this method when needing a bandwidth image for a single guest. It will gather the correct input parameters for the generic graphing utility automatically based on the snapshot specified.
    • getBandwidthImageByDate
      Use this method when needing a bandwidth image for a single application delivery controller. It will gather the correct input parameters for the generic graphing utility based on the date ranges
    • getBandwidthImageByDate
      Use this method when needing a bandwidth image for a single guest. It will gather the correct input parameters for the generic graphing utility based on the date ranges
    • getBandwidthList
    • getBandwidthTotal
      Retrieve the total amount of bandwidth recorded by a tracking object within the given date range. This method will only work on SoftLayer_Metric_Tracking_Object for SoftLayer_Hardware objects, and SoftLayer_Virtual_Guest objects.
    • getBandwidthTotal
      Returns the total amount of bandwidth used during the time specified for a computing instance.
    • getBareMetalInstances
      An account's associated bare metal server objects.
    • getBareMetalInstances
      The bare metal server instances contained within a virtual rack.
    • getBareMetalReservedCapacityFlag
      Signifies pricing that is only available on a bare metal reserved capacity order.
    • getBareMetalReservedFlag
      When true this preset is for ordering a Bare Metal Reserved server.
    • getBenchmarkCertifications
      Information regarding a piece of hardware's benchmark certifications.
    • getBenchmarkCertifications
      Information regarding a piece of hardware's benchmark certifications.
    • getBenchmarkCertifications
      Information regarding a piece of hardware's benchmark certifications.
    • getBenchmarkCertifications
      Information regarding a piece of hardware's benchmark certifications.
    • getBenchmarkCertifications
      Information regarding a piece of hardware's benchmark certifications.
    • getBgpIpRange
    • getBigDataOsJournalDiskFlag
      Whether the price is for Big Data OS/Journal disks only. (Deprecated)
    • getBillableChildren
      A billing item's recurring child items that have once been billed and are scheduled to be billed in the future.
    • getBillableChildren
      A billing item's recurring child items that have once been billed and are scheduled to be billed in the future.
    • getBillingAgreements
      All billing agreements for an account
    • getBillingCancellationReasonCategory
      An billing cancellation reason category.
    • getBillingCancellationReasons
      The corresponding billing cancellation reasons having the specific billing cancellation reason category.
    • getBillingCycleBandwidthUsage
      The raw bandwidth usage data for the current billing cycle. One object will be returned for each network this server is attached to.
    • getBillingCycleBandwidthUsage
      The raw bandwidth usage data for the current billing cycle. One object will be returned for each network this server is attached to.
    • getBillingCycleBandwidthUsage
      The raw bandwidth usage data for the current billing cycle. One object will be returned for each network this server is attached to.
    • getBillingCycleBandwidthUsage
      A virtual rack's raw bandwidth usage data for an account's current billing cycle. One object is returned for each network this server is attached to.
    • getBillingCycleBandwidthUsage
      The raw bandwidth usage data for the current billing cycle. One object will be returned for each network this firewall is attached to.
    • getBillingCycleBandwidthUsage
      The raw bandwidth usage data for the current billing cycle. One object will be returned for each network this server is attached to.
    • getBillingCyclePrivateBandwidthUsage
      The raw private bandwidth usage data for the current billing cycle.
    • getBillingCyclePrivateBandwidthUsage
      The raw private bandwidth usage data for the current billing cycle.
    • getBillingCyclePrivateBandwidthUsage
      The raw private bandwidth usage data for the current billing cycle.
    • getBillingCyclePrivateBandwidthUsage
      A virtual rack's raw private network bandwidth usage data for an account's current billing cycle.
    • getBillingCyclePrivateBandwidthUsage
      The raw private bandwidth usage data for the current billing cycle.
    • getBillingCyclePrivateBandwidthUsage
      The raw private bandwidth usage data for the current billing cycle.
    • getBillingCyclePublicBandwidthUsage
      The raw public bandwidth usage data for the current billing cycle.
    • getBillingCyclePublicBandwidthUsage
      The raw public bandwidth usage data for the current billing cycle.
    • getBillingCyclePublicBandwidthUsage
      The raw public bandwidth usage data for the current billing cycle.
    • getBillingCyclePublicBandwidthUsage
      A virtual rack's raw public network bandwidth usage data for an account's current billing cycle.
    • getBillingCyclePublicBandwidthUsage
      The raw public bandwidth usage data for the current billing cycle.
    • getBillingCyclePublicBandwidthUsage
      The raw public bandwidth usage data for the current billing cycle.
    • getBillingCyclePublicUsageTotal
      The total public bandwidth used in this virtual rack for an account's current billing cycle.
    • getBillingInfo
      An account's billing information.
    • getBillingItem
      The billing item for the original request.
    • getBillingItem
      An Invoice Item's billing item, from which this item was generated.
    • getBillingItem
      The SoftLayer_Billing_Item tied to the order item.
    • getBillingItem
      Information regarding the billing item for a server.
    • getBillingItem
      Information regarding the billing item for a server.
    • getBillingItem
      Information regarding the billing item for a server.
    • getBillingItem
      Information regarding the billing item for a server.
    • getBillingItem
      Information regarding the billing item for a server.
    • getBillingItem
      The bandwidth allotment that the reservation belongs to.
    • getBillingItem
      The billing item for a Application Delivery Controller.
    • getBillingItem
      The current billing item for the load balancer virtual IP. This is only valid when dedicatedFlag is false. This is an independent virtual IP, and if canceled, will only affect the associated virtual IP.
    • getBillingItem
      A virtual rack's billing item.
    • getBillingItem
      An associated parent billing item which is active.
    • getBillingItem
      The billing item for a Hardware Firewall (Dedicated).
    • getBillingItem
      The active billing item for a network interconnect.
    • getBillingItem
      The current billing item for a Global Load Balancer account.
    • getBillingItem
      The current billing item for the Load Balancer.
    • getBillingItem
      The billing item for a network message delivery account.
    • getBillingItem
      The billing item for a network message delivery account.
    • getBillingItem
      The current billing item for a Storage volume.
    • getBillingItem
      The current billing item for a Storage volume.
    • getBillingItem
      An associated parent billing item which is active. Includes billing items which are scheduled to be cancelled in the future.
    • getBillingItem
      The current billing item for a Storage volume.
    • getBillingItem
      An associated parent billing item which is active. Includes billing items which are scheduled to be cancelled in the future.
    • getBillingItem
      The active billing item for this subnet.
    • getBillingItem
      The billing item for this Global IP.
    • getBillingItem
      The current billing item for network tunnel.
    • getBillingItem
      The billing item for this VLAN.
    • getBillingItem
      The billing item for a Hardware Firewall (Dedicated).
    • getBillingItem
      The billing item for a software account license.
    • getBillingItem
      The billing item for a software component.
    • getBillingItem
      The billing item for a software component.
    • getBillingItem
      The billing item for a software component.
    • getBillingItem
      The billing item for a software component.
    • getBillingItem
      The billing item for a software virtual license.
    • getBillingItem
      Information regarding the billing item for external authentication.
    • getBillingItem
      Information regarding the billing item for external authentication.
    • getBillingItem
      Information regarding the billing item for external authentication.
    • getBillingItem
      Information regarding the billing item for external authentication.
    • getBillingItem
      The billing item for the dedicated host.
    • getBillingItem
      The billing item for a virtual disk image.
    • getBillingItem
      The billing item for a CloudLayer Compute Instance.
    • getBillingItem
      The billing item for the reserved capacity group instance.
    • getBillingItem
      The current billing item for a storage repository.
    • getBillingItem
    • getBillingItemCategory
    • getBillingItemCategory
    • getBillingItemCategory
    • getBillingItemFlag
      A flag indicating that a billing item exists.
    • getBillingItemFlag
      A flag indicating that a billing item exists.
    • getBillingItemFlag
      A flag indicating that a billing item exists.
    • getBillingItemFlag
      A flag indicating that a billing item exists.
    • getBillingItemFlag
      A flag indicating that a billing item exists.
    • getBillingItems
      The billing items associated with an agreement.
    • getBillingItems
      The corresponding billing items having the specific cancellation reason.
    • getBillingItems
      The billing items associated with an account that share a category code with an item category's category code.
    • getBillingItemSnapshots
      Returns snapshots of billing items recorded periodically given an account ID owned by the brand those billing items belong to. Retrieving billing item snapshots is more performant than retrieving billing items directly and performs less relational joins improving retrieval efficiency. The downside is, they are not real time, and do not share relational parity with the original billing item.
    • getBillingItemSnapshotsForSingleOwnedAccount
      This service returns the snapshots of billing items recorded periodically given an account ID. The provided account ID must be owned by the brand that calls this service. In this context, it can be interpreted that the billing items snapshots belong to both the account and that accounts brand. Retrieving billing item snapshots is more performant than retrieving billing items directly and performs less relational joins improving retrieval efficiency. The downside is, they are not real time, and do not share relational parity with the original billing item.
    • getBillingItemSnapshotsWithExternalAccountId
      This service returns the snapshots of billing items recorded periodically given an account ID owned by the brand those billing items belong to. Retrieving billing item snapshots is more performant than retrieving billing items directly and performs less relational joins improving retrieval efficiency. The downside is, they are not real time, and do not share relational parity with the original billing item.
    • getBillingType
      An item's special billing type, if applicable.
    • getBiosPasswordNullFlag
      Determine if BIOS password should be left as null.
    • getBiosPasswordNullFlag
      Determine if BIOS password should be left as null.
    • getBiosPasswordNullFlag
      Determine if BIOS password should be left as null.
    • getBlockCancelBecauseDisconnectedFlag
      Determines whether the hardware is ineligible for cancellation because it is disconnected.
    • getBlockCancelBecauseDisconnectedFlag
      Determines whether the hardware is ineligible for cancellation because it is disconnected.
    • getBlockCancelBecauseDisconnectedFlag
      Determines whether the hardware is ineligible for cancellation because it is disconnected.
    • getBlockCancelBecauseDisconnectedFlag
      Determines whether the hardware is ineligible for cancellation because it is disconnected.
    • getBlockCancelBecauseDisconnectedFlag
      Determines whether the hardware is ineligible for cancellation because it is disconnected.
    • getBlockCancelBecauseDisconnectedFlag
      Determines whether the instance is ineligible for cancellation because it is disconnected.
    • getBlockDevices
      The block devices that a disk image is attached to. Block devices connect computing instances to disk images.
    • getBlockDevices
      A computing instance's block devices. Block devices link [SoftLayer_Virtual_Disk_Image](/reference/datatypes/SoftLayer_Virtual_Disk_Image) to computing instances.
    • getBlockDevices
      The block devices that are part of an image template group
    • getBlockDevicesDiskSpaceTotal
      The total disk space of all images in a image template group.
    • getBlockDeviceTemplateGroup
      The global identifier for the image template that was used to provision or reload a guest.
    • getBlockDeviceTemplateGroups
      Private template group objects (parent and children) and the shared template group objects (parent only) for an account.
    • getBlockDeviceTemplateGroups
      The image template groups that are linked to an SSH key.
    • getBluemixAccountId
    • getBluemixAccountLink
      The Platform account link associated with this SoftLayer account, if one exists.
    • getBluemixLinkedFlag
      Returns true if this account is linked to IBM Bluemix, false if not.
    • getBmsCountries
    • getBmsCountryList
    • getBnppCompliantFlag
      A flag indicating whether or not the datacenter/location is BNPP compliant.
    • getBnppCompliantFlag
      A flag indicating whether or not the datacenter/location is BNPP compliant.
    • getBnppSupportedFlag
      A ticket's associated BNPP compliant record
    • getBootableVolumeFlag
    • getBootMode
      Retrieves the boot mode of the VSI.
    • getBootMode
      This method returns the boot mode, if any, set on a given image template.
    • getBootModeOptions
      Retrieve the valid boot modes for this server
    • getBootModeOptions
      Retrieve the valid boot modes for this server
    • getBootModeOptions
      Retrieve the valid boot modes for this server
    • getBootOrder
    • getBoundDescendants
    • getBoundRouterFlag
      Indicates whether this subnet is associated to a network router and is routable on the network.
    • getBoundRouters
      The list of network routers that this subnet is directly associated with, defining where this subnet may be routed on the network.
    • getBoundSubnets
      Associated subnets for a router object.
    • getBoundSubnets
      Subnets which are directly bound to one or more routers in a given datacenter, and currently allow routing.
    • getBrand
    • getBrand
    • getBrand
      Brand associated with the business partner data
    • getBrand
      This references the brand that has a brand-location-country restriction setup.
    • getBrandAccountFlag
    • getBrandAtInvoiceCreation
    • getBrandCountryRestrictions
      This references relationship between brands, locations and countries associated with a user's account that are ineligible when ordering products. For example, the India datacenter may not be available on this brand for customers that live in Great Britain.
    • getBrandKeyName
      The brand keyName.
    • getBrowserConsoleAccessLogs
      A virtual guest's browser access logs.
    • getBuckets
      Get buckets
    • getBundle
      An item's included product item references. Some items have other items included in them that we specifically detail. They are here called Bundled Items. An example is Plesk unlimited. It as a bundled item labeled 'SiteBuilder'. These are the SoftLayer_Product_Item_Bundles objects. See the SoftLayer_Product_Item::bundleItems property for bundle of SoftLayer_Product_Item of objects.
    • getBundledItems
      A Billing Item's bundled billing items.
    • getBundledItems
      A Billing Item's bundled billing items.
    • getBundledItems
      The other items included with an ordered item.
    • getBundleItems
      An item's included products. Some items have other items included in them that we specifically detail. They are here called Bundled Items. An example is Plesk unlimited. It as a bundled item labeled 'SiteBuilder'. These are the SoftLayer_Product_Item objects.
    • getBundleReferences
      cross reference for bundles
    • getBusinessContinuanceInsuranceFlag
      Status indicating whether or not a piece of hardware has business continuance insurance.
    • getBusinessContinuanceInsuranceFlag
      Status indicating whether or not a piece of hardware has business continuance insurance.
    • getBusinessContinuanceInsuranceFlag
      Status indicating whether or not a piece of hardware has business continuance insurance.
    • getBusinessContinuanceInsuranceFlag
      Status indicating whether or not a piece of hardware has business continuance insurance.
    • getBusinessContinuanceInsuranceFlag
      Status indicating whether or not a piece of hardware has business continuance insurance.
    • getBusinessPartner
      The Business Partner details for the account. Country Enterprise Code, Channel, Segment, Reseller Level.
    • getBusinessPartner
      Business Partner details for the brand. Country Enterprise Code, Channel, Segment, Reseller Level.
    • getBusinessPartnerFlag
      Flag indicating if the brand is a business partner.
    • getByDescription
      The '''getByDescription''' method retrieves all possible partition templates based on the description (required parameter) entered when calling the method. The description is typically the operating system's name. Current recognized values include 'linux', 'windows', 'freebsd', and 'Debian'.
    • getByDomainName
      Search for [SoftLayer_Dns_Domain](/reference/datatypes/SoftLayer_Dns_Domain) records by domain name. getByDomainName() performs an inclusive search for domain records, returning multiple records based on partial name matches. Use this method to locate domain records if you don't have access to their id numbers.
    • getByDomainName
      Search for [SoftLayer_Dns_Secondary](/reference/datatypes/SoftLayer_Dns_Secondary) records by domain name. getByDomainName() performs an inclusive search for secondary domain records, returning multiple records based on partial name matches. Use this method to locate secondary domain records if you don't have access to their id numbers.
    • getByIpAddress
      Search for an IP address record by IP address.
    • getByolFlag
      A flag indicating that customer is providing the software licenses.
    • getBypassRequestStatus
      Administrative bypass request status.
    • getBytesUsed
      The amount of space used by the volume, in bytes.
    • getBytesUsed
      The amount of space used by the volume, in bytes.
    • getBytesUsed
      The amount of space used by the volume, in bytes.
    • getByUsername
      Retrieve network storage accounts by username and storage account type. Use this method if you wish to retrieve a storage record by username rather than by id. The ''type'' parameter must correspond to one of the available ''nasType'' values in the SoftLayer_Network_Storage data type.
    • getByUsername
      Retrieve network storage accounts by username and storage account type. Use this method if you wish to retrieve a storage record by username rather than by id. The ''type'' parameter must correspond to one of the available ''nasType'' values in the SoftLayer_Network_Storage data type.
    • getByUsername
      Retrieve network storage accounts by username and storage account type. Use this method if you wish to retrieve a storage record by username rather than by id. The ''type'' parameter must correspond to one of the available ''nasType'' values in the SoftLayer_Network_Storage data type.
    • getCanceledChildren
      A Billing Item's active child billing items.
    • getCanceledChildren
      A Billing Item's active child billing items.
    • getCancelFailureReasons
      Evaluates this VLAN for cancellation and returns a list of descriptions why this VLAN may not be cancelled. If the result is empty, this VLAN may be cancelled.
    • getCancellationCutoffDate
      Services can be canceled 2 or 3 days prior to your next bill date. This service returns the time by which a cancellation request submission is permitted in the current billing cycle. If the current time falls into the cut off date, this will return next earliest cancellation cut off date. Available category codes are: service, server
    • getCancellationReason
      The billing item's cancellation reason.
    • getCancellationReason
      The billing item's cancellation reason.
    • getCancellationRequest
      A service cancellation request.
    • getCancellationRequests
      This will return any cancellation requests that are associated with this billing item.
    • getCancellationRequests
      This will return any cancellation requests that are associated with this billing item.
    • getCancelledBillingItem
      An associated parent billing item which has been cancelled.
    • getCanOrderAdditionalVlansFlag
      [DEPRECATED] All accounts may order VLANs.
    • getCapabilities
      Provides the list of capabilities a Pod fulfills. See [SoftLayer_Network_Pod::listCapabilities](/reference/services/SoftLayer_Network_Pod/listCapabilities) for more information on capabilities.
    • getCapacity
      Returns the Gbps capacity of the gateway object
    • getCapacityMaximum
      When the product capacity is best described as a range, this holds the ceiling of the range.
    • getCapacityMinimum
      When the product capacity is best described as a range, this holds the floor of the range.
    • getCapacityRestrictedProductFlag
      This flag indicates that this product is restricted by a capacity on a related product.
    • getCapacityRestrictionMaximum
      The maximum capacity value for which this price is suitable.
    • getCapacityRestrictionMinimum
      The minimum capacity value for which this price is suitable.
    • getCapacityRestrictionType
      The type of capacity restriction by which this price must abide.
    • getCapacityUsage
      Returns the capacity usage for an IBM Cloud Object Storage account.
    • getCaptureEnabledFlag
      Determine if the server is able to be image captured. If unable to image capture a reason will be provided.
    • getCaptureEnabledFlag
      Determine if the server is able to be image captured. If unable to image capture a reason will be provided.
    • getCaptureEnabledFlag
      Determine if the server is able to be image captured. If unable to image capture a reason will be provided.
    • getCart
      A cart is similar to a quote, except that it can be continually modified by the customer and does not have locked-in prices. Not all orders will have a cart associated with them. See [SoftLayer_Billing_Order_Cart](/reference/datatypes/SoftLayer_Billing_Order_Cart) for more information.
    • getCartByCartKey
      Retrieve a valid cart record of a SoftLayer order.
    • getCarts
      An account's active carts.
    • getCatalog
      The Product Catalog for the Brand
    • getCatalog
    • getCatalystEnrollments
    • getCategories
      An item's associated item categories.
    • getCategories
      All categories which this item is a member.
    • getCategories
      This is a collection of categories ([SoftLayer_Product_Item_Category](/reference/datatypes/SoftLayer_Product_Item_Category)) associated with a package which can be used for ordering. These categories have several objects prepopulated which are useful when determining the available products for purchase. The categories contain groups ([SoftLayer_Product_Package_Item_Category_Group](/reference/datatypes/SoftLayer_Product_Package_Item_Category_Group)) that organize the products and prices by similar features. For example, operating systems will be grouped by their manufacturer and virtual server disks will be grouped by their disk type (SAN vs. local). Each group will contain prices ([SoftLayer_Product_Item_Price](/reference/datatypes/SoftLayer_Product_Item_Price)) which you can use determine the cost of each product. Each price has a product ([SoftLayer_Product_Item](/reference/datatypes/SoftLayer_Product_Item)) which provides the name and other useful information about the server, service or software you may purchase.
    • getCategories
      The item categories that are included in this package preset configuration.
    • getCategory
      This invoice item's 'item category'.
    • getCategory
      The item category to which the billing item's item belongs.
    • getCategory
      The item category to which the billing item's item belongs.
    • getCategory
      The item category tied to an order item.
    • getCategory
    • getCdnItems
    • getCdnUrls
    • getCdnUrls
    • getCdnUrls
    • getChangeOwnerActivity
    • getChannel
      Channel indicator used to categorize business partner revenue.
    • getChannel
      Channel indicator used to categorize business partner revenue.
    • getChargebackType
      Chargeback type for invoice.
    • getChat
      The chat between the Customer and Agent
    • getChildren
      An Invoice Item's child invoice items. Only parent invoice items have children. For instance, a server invoice item will have children.
    • getChildren
      A Billing Item's child billing items'
    • getChildren
      A Billing Item's child billing items'
    • getChildren
      The child order items for an order item. All server order items should have children. These children are considered a part of the server.
    • getChildren
      Members of the rack.
    • getChildren
      The immediate descendants of this subnet.
    • getChildren
    • getChildren
      A child subject
    • getChildren
      The image template groups that are clones of an image template group.
    • getChildrenHardware
      Child hardware.
    • getChildrenHardware
      Child hardware.
    • getChildrenHardware
      Child hardware.
    • getChildrenHardware
      Child hardware.
    • getChildrenHardware
      Child hardware.
    • getChildrenWithActiveAgreement
      A Billing Item's active child billing items.
    • getChildrenWithActiveAgreement
      A Billing Item's active child billing items.
    • getChildUsers
      A portal user's child users. Some portal users may not have child users.
    • getChildUsers
      A portal user's child users. Some portal users may not have child users.
    • getChildUsers
      A portal user's child users. Some portal users may not have child users.
    • getClosedTickets
      All closed tickets associated with an account.
    • getClosedTickets
      An user's associated closed tickets.
    • getClosedTickets
      An user's associated closed tickets.
    • getClosedTickets
      An user's associated closed tickets.
    • getClosestToLanguageTag
      Get the closest locale for the language tag (ISO 639-1 & 3166-1) format.
    • getCloudInitFlag
      Check if cloud-init is enabled.
    • getCloudObjectStorageMetrics
      Makes a request to Cloud Object Storage metricsAPI service and when successful, returns an associative array with two elements: if 200: [ <response Status Code String>, <JSON from metricsAPI as outlined below as String> ] if not 200: [ <response Status Code String>, <response body as String> ] { 'start': '<timeInMilliseconds>', 'errors': [], 'end': '<timeInMilliseconds>', 'resource_type': 'account', 'warnings': [], 'resources': [{'metrics' : [{'name': 'retrieval', 'value': '<number>'}]}] } Notes: 1) When no data is found for a particular triplet (resource_id, storage_location, storage_class) a JSON element is inserted to the warnings Array. 2) If all queried triplets find data, only the resources Array will be populated, errors and warnings will remain empty.
    • getCloudStorageItems
    • getClusterResource
    • getClusterResource
    • getClusterResource
    • getCoalescedDiskImages
    • getCompanyType
    • getCompanyType
      Catalyst company types.
    • getCompanyTypes
    • getCompanyTypes
    • getCompatibleArrayTypes
    • getCompatibleChildComponentModels
      All the component models that are compatible with a hardware component model.
    • getCompatibleParentComponentModels
      All the component models that a hardware component model is compatible with.
    • getCompatibleSoftwareDescriptions
      A list of the software descriptions that are compatible with this software description.
    • getCompletedFlag
      Indicates that the upgrade request has completed or has been cancelled.
    • getComponentDetailsXML
    • getComponentDetailsXML
    • getComponentDetailsXML
    • getComponentDetailsXML
    • getComponentDetailsXML
    • getComponents
      A piece of hardware's components.
    • getComponents
      A piece of hardware's components.
    • getComponents
      A piece of hardware's components.
    • getComponents
      A piece of hardware's components.
    • getComponents
      A piece of hardware's components.
    • getComputeGroup
      The compute family this configuration belongs to.
    • getComputingCategories
      This method returns a collection of computing categories. These categories are also top level items in a service offering.
    • getConfiguration
      The item categories associated with a package, including information detailing which item categories are required as part of a SoftLayer product order.
    • getConfiguration
      The preset configuration (category and price).
    • getConfigurationHistory
      Previous configurations for an Application Delivery Controller.
    • getConfigurationSection
    • getConfigurationSections
    • getConfigurationTemplates
      Some product items have configuration templates which can be used to during provisioning of that product.
    • getConflicts
      An item's conflicts. For example, McAfee LinuxShield cannot be ordered with Windows. It was not meant for that operating system and as such is a conflict.
    • getConnection
    • getConsoleAccessLog
      Gets the console access logs for a computing instance
    • getConsoleData
      A container for a guest's console data
    • getConsoleIpAddressFlag
      A flag indicating a computing instance's console IP address is assigned.
    • getConsoleIpAddressRecord
      A record containing information about a computing instance's console IP and port number.
    • getContactInformation
      Retrieve the contact information for the brand such as the corporate or support contact. This will include the contact name, telephone number, fax number, email address, and mailing address of the contact.
    • getContacts
      The contacts for the brand.
    • getContainerList
      This method returns a collection of container objects.
    • getContainsSolidStateDrivesFlag
    • getContainsSolidStateDrivesFlag
    • getContainsSolidStateDrivesFlag
    • getContextTunnelTranslations
      An IPSec network tunnel's address translations. These translations use a SoftLayer ip address from an assigned static NAT subnet to deliver the packets to the remote (customer) destination.
    • getContinuousDataProtectionSoftwareComponent
      A continuous data protection/server backup software component object.
    • getContinuousDataProtectionSoftwareComponent
      A continuous data protection/server backup software component object.
    • getContinuousDataProtectionSoftwareComponent
      A continuous data protection/server backup software component object.
    • getContinuousDataProtectionSoftwareComponent
      A continuous data protection/server backup software component object.
    • getContinuousDataProtectionSoftwareComponent
      A continuous data protection/server backup software component object.
    • getContinuousDataProtectionSoftwareComponent
      A continuous data protection software component object.
    • getController
      The application delivery controller that a configuration history record belongs to.
    • getControlPanel
      A server's control panel.
    • getControlPanel
      A server's control panel.
    • getControlPanel
      A server's control panel.
    • getControlPanel
      A guest's control panel.
    • getCopyOnWriteFlag
    • getCoreRestrictedItemFlag
      This flag indicates that this product is restricted by the number of cores on the compute instance. This is deprecated. Use [SoftLayer_Product_Item::getCapacityRestrictedProductFlag](/reference/services/SoftLayer_Product_Item/getCapacityRestrictedProductFlag)
    • getCoreRestrictedItems
      The [SoftLayer_Billing_Order_Item](/reference/datatypes/SoftLayer_Billing_Order_Item) that are core restricted
    • getCoreRestrictedOperatingSystemPrice
      If the virtual server currently has an operating system that has a core capacity restriction, return the associated core-restricted operating system item price. Some operating systems (e.g., Red Hat Enterprise Linux) may be billed by the number of processor cores, so therefore require that a certain number of cores be present on the server.
    • getCost
      The total cost of a server, measured in US Dollars ($USD).
    • getCost
      The total cost of a server, measured in US Dollars ($USD).
    • getCost
      The total cost of a server, measured in US Dollars ($USD).
    • getCountries
      Use this method to retrieve a list of countries and locale information such as country code and state/provinces.
    • getCountriesAndStates
      This method will return a collection of [SoftLayer_Container_Collection_Locale_CountryCode](/reference/datatypes/SoftLayer_Container_Collection_Locale_CountryCode) objects. If the country has states, a [SoftLayer_Container_Collection_Locale_StateCode](/reference/datatypes/SoftLayer_Container_Collection_Locale_StateCode) collection will be provided with the country.
    • getCountriesWithListOfEligibleCurrencies
      Get map between countries and what currencies can be supported for customers in that country.
    • getCountry
      SoftLayer_Locale_Country Id.
    • getCourier
      The courier handling the shipment.
    • getCourier
    • getCpuMetricDataByDate
      Use this method when needing the metric data for a single guest's CPUs. It will gather the correct input parameters based on the date ranges
    • getCpuMetricImage
      Use this method when needing a cpu usage image for a single guest. It will gather the correct input parameters for the generic graphing utility automatically based on the snapshot specified.
    • getCpuMetricImageByDate
      Use this method when needing a CPU usage image for a single guest. It will gather the correct input parameters for the generic graphing utility based on the date ranges
    • getCreateEmployee
      The employee who created the shipment.
    • getCreateEmployee
      The employee who created the tracking datum.
    • getCreateEmployee
      The employee user who created the request.
    • getCreateObjectOptions
      There are many options that may be provided while ordering a server, this method can be used to determine what these options are. Detailed information on the return value can be found on the data type page for [SoftLayer_Container_Hardware_Configuration](/reference/datatypes/SoftLayer_Container_Hardware_Configuration).
    • getCreateObjectOptions
      There are many options that may be provided while ordering a server, this method can be used to determine what these options are. Detailed information on the return value can be found on the data type page for [SoftLayer_Container_Hardware_Configuration](/reference/datatypes/SoftLayer_Container_Hardware_Configuration).
    • getCreateObjectOptions
      There are many options that may be provided while ordering a server, this method can be used to determine what these options are. Detailed information on the return value can be found on the data type page for [SoftLayer_Container_Hardware_Configuration](/reference/datatypes/SoftLayer_Container_Hardware_Configuration).
    • getCreateObjectOptions
      There are many options that may be provided while ordering a server, this method can be used to determine what these options are. Detailed information on the return value can be found on the data type page for [SoftLayer_Container_Hardware_Configuration](/reference/datatypes/SoftLayer_Container_Hardware_Configuration).
    • getCreateObjectOptions
      There are many options that may be provided while ordering a server, this method can be used to determine what these options are. Detailed information on the return value can be found on the data type page for [SoftLayer_Container_Hardware_Configuration](/reference/datatypes/SoftLayer_Container_Hardware_Configuration).
    • getCreateObjectOptions
      There are many options that may be provided while ordering a computing instance, this method can be used to determine what these options are. Detailed information on the return value can be found on the data type page for [SoftLayer_Container_Virtual_Guest_Configuration](/reference/datatypes/SoftLayer_Container_Virtual_Guest_Configuration).
    • getCreateUser
      The customer user who created this address.
    • getCreateUser
      The customer user who created the media object.
    • getCreateUser
      The customer user who created the request.
    • getCreateUser
      The customer user who created the shipment.
    • getCreateUser
      The customer user who created the tracking datum.
    • getCreateUser
      The customer user who created the request.
    • getCreationScheduleId
      The schedule id which was executed to create a snapshot.
    • getCreationScheduleId
      The schedule id which was executed to create a snapshot.
    • getCreationScheduleId
      The schedule id which was executed to create a snapshot.
    • getCredential
      The SoftLayer_Network_Storage_Credential this allowed host uses.
    • getCredential
      The SoftLayer_Network_Storage_Credential this allowed host uses.
    • getCredential
      The SoftLayer_Network_Storage_Credential this allowed host uses.
    • getCredential
      The SoftLayer_Network_Storage_Credential this allowed host uses.
    • getCredential
      The SoftLayer_Network_Storage_Credential this allowed host uses.
    • getCredentialExpirationDate
      The date that a VeriSign credential expires.
    • getCredentialLastUpdateDate
      The last time a VeriSign credential was updated.
    • getCredentialLimit
      Returns credential limits for this IBM Cloud Object Storage account.
    • getCredentials
    • getCredentials
    • getCredentials
      Credentials used for generating an AWS signature. Max of 2.
    • getCredentials
    • getCredentialState
      The current state of a VeriSign credential. This can be 'Enabled', 'Disabled', or 'Locked'.
    • getCredentialType
      The type of VeriSign credential. This can be either 'Hardware' or 'Software'.
    • getCreditCardTransactions
      All credit card transactions associated with this order. If this order was not placed with a credit card, this will be empty.
    • getCurrencies
    • getCurrency
    • getCurrency
      Currency to be used by this customer account.
    • getCurrentBandwidthSummary
      An object that provides commonly used bandwidth summary components for the current billing cycle.
    • getCurrentBandwidthSummary
      An object that provides commonly used bandwidth summary components for the current billing cycle.
    • getCurrentBandwidthSummary
      An object that provides commonly used bandwidth summary components for the current billing cycle.
    • getCurrentBandwidthSummary
      An object that provides commonly used bandwidth summary components for the current billing cycle.
    • getCurrentBandwidthSummary
      An object that provides commonly used bandwidth summary components for the current billing cycle.
    • getCurrentBenchmarkCertificationResultFile
      Attempt to retrieve the file associated with the current benchmark certification result, if such a file exists. If there is no file for this benchmark certification result, calling this method throws an exception.
    • getCurrentBenchmarkCertificationResultFile
      Attempt to retrieve the file associated with the current benchmark certification result, if such a file exists. If there is no file for this benchmark certification result, calling this method throws an exception.
    • getCurrentBenchmarkCertificationResultFile
      Attempt to retrieve the file associated with the current benchmark certification result, if such a file exists. If there is no file for this benchmark certification result, calling this method throws an exception.
    • getCurrentBillableBandwidthUsage
      The current billable public outbound bandwidth for this hardware for the current billing cycle.
    • getCurrentBillableBandwidthUsage
      The current billable public outbound bandwidth for this hardware for the current billing cycle.
    • getCurrentBillableBandwidthUsage
      The current billable public outbound bandwidth for this hardware for the current billing cycle.
    • getCurrentBillableBandwidthUsage
      The current billable public outbound bandwidth for this hardware for the current billing cycle.
    • getCurrentBillableBandwidthUsage
      The current billable public outbound bandwidth for this hardware for the current billing cycle.
    • getCurrentBillingCycle
      Information related to an account's current and previous billing cycles.
    • getCurrentBillingDetail
      Get the billing detail for this hardware for the current billing period. This does not include bandwidth usage.
    • getCurrentBillingDetail
      Get the billing detail for this hardware for the current billing period. This does not include bandwidth usage.
    • getCurrentBillingDetail
      Get the billing detail for this hardware for the current billing period. This does not include bandwidth usage.
    • getCurrentBillingDetail
      Get the billing detail for this hardware for the current billing period. This does not include bandwidth usage.
    • getCurrentBillingDetail
      Get the billing detail for this hardware for the current billing period. This does not include bandwidth usage.
    • getCurrentBillingDetail
      Get the billing detail for this instance for the current billing period. This does not include bandwidth usage.
    • getCurrentBillingTotal
      Get the total bill amount in US Dollars ($) for this hardware in the current billing period. This includes all bandwidth used up to the point the method is called on the hardware.
    • getCurrentBillingTotal
      Get the total bill amount in US Dollars ($) for this hardware in the current billing period. This includes all bandwidth used up to the point the method is called on the hardware.
    • getCurrentBillingTotal
      Get the total bill amount in US Dollars ($) for this hardware in the current billing period. This includes all bandwidth used up to the point the method is called on the hardware.
    • getCurrentBillingTotal
      Get the total bill amount in US Dollars ($) for this hardware in the current billing period. This includes all bandwidth used up to the point the method is called on the hardware.
    • getCurrentBillingTotal
      Get the total bill amount in US Dollars ($) for this hardware in the current billing period. This includes all bandwidth used up to the point the method is called on the hardware.
    • getCurrentBillingTotal
      Get the total bill amount in US Dollars ($) for this instance in the current billing period. This includes all bandwidth used up to the point this method is called on the instance.
    • getCurrentCompatiblePlatformNames
      Get compatible platform names currently set on the template group.
    • getCurrentCyclePeakUsage
      Peak number of bytes used in the vault for the current billing cycle.
    • getCurrentExchangeRate
      The current exchange rate
    • getCurrentHostIpsPolicies
      Get the current Host IPS policies.
    • getCurrentHostIpsPolicies
      Get the current Host IPS policies.
    • getCurrentNotifications
      Retrieve an array of SoftLayer_Auxiliary_Notification_Emergency data types, which contain all current notification events.
    • getCurrentUser
      Retrieve the user record of the user calling the SoftLayer API.
    • getCustomBandwidthDataByDate
      Retrieve bandwidth graph by date.
    • getCustomBandwidthDataByDate
      Retrieve bandwidth graph by date.
    • getCustomBandwidthDataByDate
      Retrieve bandwidth graph by date.
    • getCustomBandwidthDataByDate
      Retrieve bandwidth graph by date.
    • getCustomBandwidthDataByDate
      Retrieve bandwidth graph by date.
    • getCustomBandwidthDataByDate
      Retrieve bandwidth graph by date.
    • getCustomBandwidthDataByDate
      Retrieve bandwidth graph by date.
    • getCustomer
    • getCustomer
      The user this mobile device belongs to.
    • getCustomerCountryLocationRestrictions
      This references relationship between brands, locations and countries associated with a user's account that are ineligible when ordering products. For example, the India datacenter may not be available on this brand for customers that live in Great Britain.
    • getCustomerInstalledOperatingSystemFlag
      Indicates if a server has a Customer Installed OS
    • getCustomerInstalledOperatingSystemFlag
      Indicates if a server has a Customer Installed OS
    • getCustomerInstalledOperatingSystemFlag
      Indicates if a server has a Customer Installed OS
    • getCustomerInvoicingMetrics
      Get the static & dynamic bandwidth and mapping hits of predetermined statistics for direct display (no graph) for a customer's account over a given period of time. Frequency can be 'day', 'aggregate'. If the value 'day' is specified for Frequency, return data will be ordered based on startDate to endDate, and if the value 'aggregate' is specified for Frequency, aggregated data from startDate to endDate will be returned. There is a delay within 3 days(including today) for fetching the metrics data.
    • getCustomerManagedFlag
      If false, this VIP and associated services may be edited via the portal or the API. If true, you must configure this VIP manually on the device.
    • getCustomerOwnedFlag
      Indicates if a server is a customer owned device.
    • getCustomerOwnedFlag
      Indicates if a server is a customer owned device.
    • getCustomerOwnedFlag
      Indicates if a server is a customer owned device.
    • getCustomerOwnedLicenseDescriptions
    • getCustomerRealTimeMetrics
      Get the realtime metrics data for the current account. Takes the startTime and endTime and returns the total metrics data and line graph metrics data divided by the timeInterval.
    • getCustomerSubnets
      Remote subnets that are allowed access through a network tunnel.
    • getCustomerUsageMetrics
      Get the total number of predetermined statistics for direct display (no graph) for a customer's account over a given period of time
    • getCustomGraphData
      Returns a graph container instance that is populated with metric data for the tracking object.
    • getCustomMetricDataByDate
      Retrieve bandwidth graph by date.
    • getCustomUsageRatesCategories
    • getDailyAverage
      The '''getDailyAverage''' method calculates the average daily network traffic used by the selected server. Using the required parameter ''dateTime'' to enter a start and end date, the user retrieves this average, measure in gigabytes (GB) for the specified date range. When entering parameters, only the month, day and year are required - time entries are omitted as this method defaults the time to midnight in order to account for the entire day.
    • getDailyAverage
      The '''getDailyAverage''' method calculates the average daily network traffic used by the selected server. Using the required parameter ''dateTime'' to enter a start and end date, the user retrieves this average, measure in gigabytes (GB) for the specified date range. When entering parameters, only the month, day and year are required - time entries are omitted as this method defaults the time to midnight in order to account for the entire day.
    • getDailyAverage
      The '''getDailyAverage''' method calculates the average daily network traffic used by the selected server. Using the required parameter ''dateTime'' to enter a start and end date, the user retrieves this average, measure in gigabytes (GB) for the specified date range. When entering parameters, only the month, day and year are required - time entries are omitted as this method defaults the time to midnight in order to account for the entire day.
    • getDailyAverage
      The '''getDailyAverage''' method calculates the average daily network traffic used by the selected server. Using the required parameter ''dateTime'' to enter a start and end date, the user retrieves this average, measure in gigabytes (GB) for the specified date range. When entering parameters, only the month, day and year are required - time entries are omitted as this method defaults the time to midnight in order to account for the entire day.
    • getDailyAverage
      The '''getDailyAverage''' method calculates the average daily network traffic used by the selected server. Using the required parameter ''dateTime'' to enter a start and end date, the user retrieves this average, measure in gigabytes (GB) for the specified date range. When entering parameters, only the month, day and year are required - time entries are omitted as this method defaults the time to midnight in order to account for the entire day.
    • getDailySchedule
      The Daily Schedule which is associated with this network storage volume.
    • getDailySchedule
      The Daily Schedule which is associated with this network storage volume.
    • getDailySchedule
      The Daily Schedule which is associated with this network storage volume.
    • getData
      An individual partition for a partition template. This is identical to 'partitionTemplatePartition' except this will sort unix partitions.
    • getDatacenter
      The datacenter where the media resides.
    • getDatacenter
      Information regarding the datacenter in which a piece of hardware resides.
    • getDatacenter
      Information regarding the datacenter in which a piece of hardware resides.
    • getDatacenter
      Information regarding the datacenter in which a piece of hardware resides.
    • getDatacenter
      Information regarding the datacenter in which a piece of hardware resides.
    • getDatacenter
      Information regarding the datacenter in which a piece of hardware resides.
    • getDatacenter
      The datacenter that the application delivery controller resides in.
    • getDatacenter
      Datacenter, where load balancer is located.
    • getDatacenter
      The datacenter this subnet is primarily associated with.
    • getDatacenter
      The datacenter location for one end of the network tunnel that allows access to account's private subnets.
    • getDatacenter
      The datacenter this VLAN is associated with.
    • getDatacenter
      The datacenter that the firewall resides in.
    • getDatacenter
      The getDatacenter method retrieves the name of the datacenter in which the resource is located.
    • getDatacenter
      The datacenter that the dedicated host resides in.
    • getDatacenter
      The datacenter that a virtual guest resides in.
    • getDatacenter
      The location containing this image template group. Will only be populated for child template group objects.
    • getDatacenter
      The datacenter that a virtual storage repository resides in.
    • getDatacenterId
      The getDatacenterId retrieves the ID for the datacenter in which the resource is located.
    • getDatacenterName
      The name of the datacenter in which a piece of hardware resides.
    • getDatacenterName
      The name of the datacenter in which a piece of hardware resides.
    • getDatacenterName
      The name of the datacenter in which a piece of hardware resides.
    • getDatacenterName
      The name of the datacenter in which a piece of hardware resides.
    • getDatacenterName
      The name of the datacenter in which a piece of hardware resides.
    • getDatacenterName
    • getDatacenters
      Retrieve all datacenter locations. SoftLayer's datacenters exist in various cities and each contain one or more server rooms which house network and server infrastructure.
    • getDatacenters
      Retrieve all datacenter locations. SoftLayer's datacenters exist in various cities and each contain one or more server rooms which house network and server infrastructure.
    • getDatacenters
      The datacenters in a group.
    • getDatacenters
      A collection of locations containing a copy of this image template group. Will only be populated for parent template group objects.
    • getDatacentersWithSubnetAllocations
      Datacenters which contain subnets that the account has access to route.
    • getDatacentersWithVirtualImageStoreServiceResourceRecord
    • getDatacentersWithVirtualImageStoreServiceResourceRecord
    • getDay
      The hour parameter of this schedule.
    • getDayOfMonth
      The day of the month parameter of this schedule.
    • getDayOfWeek
      The day of the week parameter of this schedule.
    • getDaysInSparePool
      Number of day(s) a server have been in spare pool.
    • getDaysInSparePool
      Number of day(s) a server have been in spare pool.
    • getDaysInSparePool
      Number of day(s) a server have been in spare pool.
    • getDaysInSparePool
      Number of day(s) a server have been in spare pool.
    • getDaysInSparePool
      Number of day(s) a server have been in spare pool.
    • getDedicatedBillingItem
      The current billing item for the load balancing device housing the virtual IP. This billing item represents a device which could contain other virtual IPs. Caution should be taken when canceling. This is only valid when dedicatedFlag is true.
    • getDedicatedClusterList
    • getDedicatedFirewallFlag
      A value of '1' indicates this VLAN is associated with a firewall device. This does not include Hardware Firewalls.
    • getDedicatedHost
      The dedicated host associated with this guest.
    • getDedicatedHostInstanceFlag
      Signifies pricing that is only available on a dedicated host virtual server order.
    • getDedicatedHosts
      An account's associated virtual dedicated host objects.
    • getDedicatedHosts
      The dedicated hosts to which the user has been granted access.
    • getDedicatedHosts
      The dedicated hosts to which the user has been granted access.
    • getDedicatedHosts
      The dedicated hosts to which the user has been granted access.
    • getDedicatedHostsForImageTemplate
      This returns a collection of dedicated hosts that are valid for a given image template.
    • getDefaultAccount
      This method is not applicable to legacy SoftLayer-authenticated users and can only be invoked for IBMid-authenticated users.
    • getDefaultAccount
      This API gets the account associated with the default user for the OpenIdConnect identity that is linked to the current active SoftLayer user identity. When a single active user is found for that IAMid, it becomes the default user and the associated account is returned. When multiple default users are found only the first is preserved and the associated account is returned (remaining defaults see their default flag unset). If the current SoftLayer user identity isn't linked to any OpenIdConnect identity, or if none of the linked users were found as defaults, the API returns null. Invoke this only on IAMid-authenticated users.
    • getDefaultAccount
      This API gets the account associated with the default user for the OpenIdConnect identity that is linked to the current active SoftLayer user identity. When a single active user is found for that IAMid, it becomes the default user and the associated account is returned. When multiple default users are found only the first is preserved and the associated account is returned (remaining defaults see their default flag unset). If the current SoftLayer user identity isn't linked to any OpenIdConnect identity, or if none of the linked users were found as defaults, the API returns null. Invoke this only on IAMid-authenticated users.
    • getDefaultBootCategoryCode
      The default boot category code for the package.
    • getDefaultBootMode
      This method returns the default boot mode set by the software description
    • getDefaultPool
    • getDefaultPreference
      Details such name, keyname, minimum and maximum values for the preference.
    • getDefaultRamItems
      A collection of valid RAM items available for purchase in this package.
    • getDefaultValue
    • getDefaultValues
    • getDefinedSoftwareLicenseFlag
      Whether this price defines a software license for its product item.
    • getDefinition
    • getDefinitions
    • getDefinitions
    • getDeliveryMethods
      The delivery methods used to send the subscribed notification.
    • getDeliveryMethods
      The delivery methods used to send the subscribed notification.
    • getDeliveryMethods
      The delivery methods used to send the subscribed notification.
    • getDependentDuplicate
      Whether or not a network storage volume is a dependent duplicate.
    • getDependentDuplicate
      Whether or not a network storage volume is a dependent duplicate.
    • getDependentDuplicate
      Whether or not a network storage volume is a dependent duplicate.
    • getDependentDuplicates
      The network storage volumes configured to be dependent duplicates of a volume.
    • getDependentDuplicates
      The network storage volumes configured to be dependent duplicates of a volume.
    • getDependentDuplicates
      The network storage volumes configured to be dependent duplicates of a volume.
    • getDependentLocation
    • getDeployment
      Returns a response object [SoftLayer_Workload_Citrix_Deployment_Response](/reference/datatypes/SoftLayer_Workload_Citrix_Deployment_Response) which represents the CVAD deployment [SoftLayer_Workload_Citrix_Deployment](/reference/datatypes/SoftLayer_Workload_Citrix_Deployment) together with all the resources ordered under the CVAD order. The deployment resources are represented by object [SoftLayer_Workload_Citrix_Deployment_Resource_Response](/reference/datatypes/SoftLayer_Workload_Citrix_Deployment_Resource_Response).
    • getDeployment
    • getDeploymentNodeType
      The node type for a package in a solution deployment.
    • getDeploymentPackages
      The packages that are allowed in a multi-server solution. (Deprecated)
    • getDeployments
      The package that represents a multi-server solution. (Deprecated)
    • getDeploymentType
      The solution deployment type.
    • getDescendants
      The descendants of this subnet, including all parents and children.
    • getDescription
      A brief description of an application delivery controller record.
    • getDestinationAddress
      The address at which the shipment is received.
    • getDestinationBrand
    • getDestinationIpAddress
    • getDetail
      The [SoftLayer_Account_Regional_Registry_Detail](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail) object this property belongs to
    • getDetail
      The related [SoftLayer_Account_Regional_Registry_Detail](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail).
    • getDetailedPdfGeneratedFlag
      A flag that will reflect whether the detailed version of the pdf has been generated.
    • getDetailReferences
      The cross-reference records that tie the [SoftLayer_Account_Regional_Registry_Detail](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail) objects to the registration object.
    • getDetails
      References to the [SoftLayer_Network_Subnet_Registration](/reference/datatypes/SoftLayer_Network_Subnet_Registration) that consume this detail object.
    • getDetails
      The bandwidth allotment detail records associated with this virtual rack.
    • getDetailsForDateRange
      Retrieve a collection of detailed metric data over a date range. Ideal if you want to employ your own graphing systems. Note not all metrics support this method. Those that do not return null.
    • getDetailType
      The associated type of this detail object.
    • getDeviceConfiguration
      The device configurations.
    • getDeviceModel
      The model of device assigned to this request.
    • getDeviceStatus
      The device status of this virtual guest.
    • getDiffieHellmanGroupDefault
      The default Diffie-Hellman group used for both phases of the negotiation process. The default value is set to 2.
    • getDiffieHellmanGroupOptions
      The Diffie-Hellman group options used for both phases of the negotiation process. The diffie-hellman group options are as follows: * 0 (None) * 1 * 2 * 5
    • getDirectLinkSpeeds
    • getDirectoryInformation
      This method returns a collection of SoftLayer_Container_Network_Ftp_Directory objects. You can retrieve directory information for /in and /out directories. A [SoftLayer_Container_Network_Directory_Listing](/reference/datatypes/SoftLayer_Container_Network_Directory_Listing) object contains a type (indicating whether it is a file or a directory), name and file count if it is a directory.
    • getDisablePaymentProcessingFlag
      A flag indicating whether payments are processed for this account.
    • getDisallowCustomDiskPartitions
      This flag indicates the package does not allow custom disk partitions.
    • getDisallowedComputeGroupUpgradeFlag
      When true this preset is only allowed to upgrade/downgrade to other presets in the same compute family.
    • getDisallowedDeletionFlag
    • getDiskFileExtension
      Return disk file extension
    • getDiskImages
      The [SoftLayer_Virtual_Disk_Image](/reference/datatypes/SoftLayer_Virtual_Disk_Image) that are in a storage repository. Disk images are the virtual hard drives for a virtual guest.
    • getDiskImageStorageGroup
    • getDisplayLabel
      [DEPRECATED] The description of this subnet.
    • getDisplaySupportRepresentativeAssignments
      The SoftLayer employees that an account is assigned to.
    • getDistributor
    • getDistributorChildFlag
    • getDistributorFlag
    • getDomain
      The domain that a resource record belongs to.
    • getDomain
      The domain that a resource record belongs to.
    • getDomain
      The domain that a resource record belongs to.
    • getDomain
      The domain record created by zone transfer from a secondary DNS record.
    • getDomain
      The getDomain method retrieves the hostname for the resource.
    • getDomainInformation
      The getDomainInformation method retrieves all the information for a domain.
    • getDomainNameservers
      The getDomainNameservers method retrieve nameservers information for domain.
    • getDomainRegistrations
    • getDomainRegistrationStatus
      The domain registration status.
    • getDomains
      The DNS domains associated with an account.
    • getDomainsWithoutSecondaryDnsRecords
      The DNS domains associated with an account that were not created as a result of a secondary DNS zone transfer.
    • getDoNotContactFlag
      Indicates whether the owner of the quote chosen to no longer be contacted.
    • getDoNotContactFlag
      Indicates whether the owner of the quote chosen to no longer be contacted.
    • getDowngradeItem
      Some product items have a downgrade path. This is the first product item in the downgrade path.
    • getDowngradeItems
      For product items which have a downgrade path defined, this will return those product items.
    • getDowngradeItems
      For product items which have a downgrade path defined, this will return those product items.
    • getDowngradeItems
      Some product items have a downgrade path. These are those product items.
    • getDownlinkComponent
      The network component linking this object to a child device
    • getDownlinkHardware
      All hardware that has uplink network connections to a piece of hardware.
    • getDownlinkHardware
      All hardware that has uplink network connections to a piece of hardware.
    • getDownlinkHardware
      All hardware that has uplink network connections to a piece of hardware.
    • getDownlinkHardware
      All hardware that has uplink network connections to a piece of hardware.
    • getDownlinkHardware
      All hardware that has uplink network connections to a piece of hardware.
    • getDownlinkNetworkHardware
      All hardware that has uplink network connections to a piece of hardware.
    • getDownlinkNetworkHardware
      All hardware that has uplink network connections to a piece of hardware.
    • getDownlinkNetworkHardware
      All hardware that has uplink network connections to a piece of hardware.
    • getDownlinkNetworkHardware
      All hardware that has uplink network connections to a piece of hardware.
    • getDownlinkNetworkHardware
      All hardware that has uplink network connections to a piece of hardware.
    • getDownlinkServers
      Information regarding all servers attached to a piece of network hardware.
    • getDownlinkServers
      Information regarding all servers attached to a piece of network hardware.
    • getDownlinkServers
      Information regarding all servers attached to a piece of network hardware.
    • getDownlinkServers
      Information regarding all servers attached to a piece of network hardware.
    • getDownlinkServers
      Information regarding all servers attached to a piece of network hardware.
    • getDownlinkVirtualGuests
      Information regarding all virtual guests attached to a piece of network hardware.
    • getDownlinkVirtualGuests
      Information regarding all virtual guests attached to a piece of network hardware.
    • getDownlinkVirtualGuests
      Information regarding all virtual guests attached to a piece of network hardware.
    • getDownlinkVirtualGuests
      Information regarding all virtual guests attached to a piece of network hardware.
    • getDownlinkVirtualGuests
      Information regarding all virtual guests attached to a piece of network hardware.
    • getDownstreamHardwareBindings
      All hardware downstream from a network device.
    • getDownstreamHardwareBindings
      All hardware downstream from a network device.
    • getDownstreamHardwareBindings
      All hardware downstream from a network device.
    • getDownstreamHardwareBindings
      All hardware downstream from a network device.
    • getDownstreamHardwareBindings
      All hardware downstream from a network device.
    • getDownstreamNetworkHardware
      All network hardware downstream from the selected piece of hardware.
    • getDownstreamNetworkHardware
      All network hardware downstream from the selected piece of hardware.
    • getDownstreamNetworkHardware
      All network hardware downstream from the selected piece of hardware.
    • getDownstreamNetworkHardware
      All network hardware downstream from the selected piece of hardware.
    • getDownstreamNetworkHardware
      All network hardware downstream from the selected piece of hardware.
    • getDownstreamNetworkHardwareWithIncidents
      All network hardware with monitoring warnings or errors that are downstream from the selected piece of hardware. [DEPRECATED]
    • getDownstreamNetworkHardwareWithIncidents
      All network hardware with monitoring warnings or errors that are downstream from the selected piece of hardware. [DEPRECATED]
    • getDownstreamNetworkHardwareWithIncidents
      All network hardware with monitoring warnings or errors that are downstream from the selected piece of hardware. [DEPRECATED]
    • getDownstreamNetworkHardwareWithIncidents
      All network hardware with monitoring warnings or errors that are downstream from the selected piece of hardware. [DEPRECATED]
    • getDownstreamNetworkHardwareWithIncidents
      All network hardware with monitoring warnings or errors that are downstream from the selected piece of hardware. [DEPRECATED]
    • getDownstreamServers
      Information regarding all servers attached downstream to a piece of network hardware.
    • getDownstreamServers
      Information regarding all servers attached downstream to a piece of network hardware.
    • getDownstreamServers
      Information regarding all servers attached downstream to a piece of network hardware.
    • getDownstreamServers
      Information regarding all servers attached downstream to a piece of network hardware.
    • getDownstreamServers
      Information regarding all servers attached downstream to a piece of network hardware.
    • getDownstreamVirtualGuests
      Information regarding all virtual guests attached to a piece of network hardware.
    • getDownstreamVirtualGuests
      Information regarding all virtual guests attached to a piece of network hardware.
    • getDownstreamVirtualGuests
      Information regarding all virtual guests attached to a piece of network hardware.
    • getDownstreamVirtualGuests
      Information regarding all virtual guests attached to a piece of network hardware.
    • getDownstreamVirtualGuests
      Information regarding all virtual guests attached to a piece of network hardware.
    • getDPart
      This is the DPart for invoice item.
    • getDriveControllers
      The drive controllers contained within a piece of hardware.
    • getDriveControllers
      The drive controllers contained within a piece of hardware.
    • getDriveControllers
      The drive controllers contained within a piece of hardware.
    • getDriveControllers
      The drive controllers contained within a piece of hardware.
    • getDriveControllers
      The drive controllers contained within a piece of hardware.
    • getDriveRetentionItemPrice
      Return a drive retention SoftLayer_Item_Price object for a guest.
    • getDuplexMode
      The duplex mode of a network component.
    • getDuplicateConversionStatus
      This method is used to check, if for the given classic file block storage volume, a transaction performing dependent to independent duplicate conversion is active. If yes, then this returns the current percentage of its progress along with its start time as [SoftLayer_Container_Network_Storage_DuplicateConversionStatusInformation] object with its name, percentage and transaction start timestamp.
    • getDuplicateConversionStatus
      This method is used to check, if for the given classic file block storage volume, a transaction performing dependent to independent duplicate conversion is active. If yes, then this returns the current percentage of its progress along with its start time as [SoftLayer_Container_Network_Storage_DuplicateConversionStatusInformation] object with its name, percentage and transaction start timestamp.
    • getDuplicateConversionStatus
      This method is used to check, if for the given classic file block storage volume, a transaction performing dependent to independent duplicate conversion is active. If yes, then this returns the current percentage of its progress along with its start time as [SoftLayer_Container_Network_Storage_DuplicateConversionStatusInformation] object with its name, percentage and transaction start timestamp.
    • getEditor
      The user or SoftLayer employee who created a ticket update.
    • getEligibilityStrategy
      Eligibility strategy to assess if a customer can order using this price.
    • getEmailAddress
      The contact e-mail address used by SendGrid.
    • getEmailList
    • getEmployeeAccessToken
      Exchanges a code for a token during manager validation.
    • getEmployeeAttachments
    • getEnabled
    • getEncryptionAttributes
      This method returns an array of encryption values, or empty array if none are found
    • getEncryptionDefault
      The default encryption type used for both phases of the negotiation process. The default value is set to 3DES.
    • getEncryptionOptions
      Encryption options available for both phases of the negotiation process. The valid encryption options are as follows: * DES * 3DES * AES128 * AES192 * AES256
    • getEndPointIpAddress
      The IP address target of this statically routed subnet.
    • getEndpoints
      Returns a collection of endpoint URLs available to this IBM Cloud Object Storage account.
    • getEndpointSubnets
      All the subnets routed to an IP address.
    • getEndpointsWithRefetch
      Returns a collection of endpoint URLs available to this IBM Cloud Object Storage account.
    • getEnrollmentRequestAnnualRevenueOptions
    • getEnrollmentRequestUserCountOptions
    • getEnrollmentRequestYearsInOperationOptions
    • getErrorMessages
      The error messages created during secondary DNS record transfer.
    • getEuCompliantFlag
      A flag indicating whether or not the datacenter/location is EU compliant.
    • getEuCompliantFlag
      A flag indicating whether or not the datacenter/location is EU compliant.
    • getEuSupportedFlag
      Boolean flag dictating whether or not this account has the EU Supported flag. This flag indicates that this account uses IBM Cloud services to process EU citizen's personal data.
    • getEuSupportedFlag
      A ticket's associated EU compliant record
    • getEvaultCapacityGB
      The total capacity of Legacy EVault Volumes on an account, in GB.
    • getEvaultMasterUsers
      An account's master EVault user. This is only used when an account has EVault service.
    • getEvaultNetworkStorage
      An account's associated EVault storage volumes.
    • getEvaultNetworkStorage
      Information regarding a piece of hardware's associated EVault network storage service account.
    • getEvaultNetworkStorage
      Information regarding a piece of hardware's associated EVault network storage service account.