deleteLiveLoadBalancerService

Classes SoftLayer_Network_Application_Delivery_Controller
Tags method sldn network

SoftLayer_Network_Application_Delivery_Controller::deleteLiveLoadBalancerService

Remove load balancer service

Description

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.

Parameters

Name Type Description
service SoftLayer_Network_LoadBalancer_Service The load balancer service you wish to remove with at least one ‘‘vip’’ property populated.

Required Headers

Optional Headers

  • None

Return Values

  • boolean

Error Handling

  • Throw the exception “The vip name must be specified for this service in order to remove it from the load balancer.” is the ‘’name’’ property within the ‘‘vip’’ property in the service parameter is not populated.
  • Throw the exception “‘’name’’” if the API is unable to locate the virtual IP address with the name specified in the ‘’name’’ property within the ‘‘vip’’ property in the service parameter.
  • Throw the exception “‘’name’’” if the API is unable to locate the load balancer service with the name specified in the ‘’name’’ property in the service parameter.

Associated Methods

curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [SoftLayer_Network_LoadBalancer_Service]}' \
'https://api.softlayer.com/rest/v3.1/SoftLayer_Network_Application_Delivery_Controller/{SoftLayer_Network_Application_Delivery_ControllerID}/deleteLiveLoadBalancerService'