openstack.net API Reference Documentation
API Reference
net.openstack.Providers.Rackspace
ILoadBalancerService Interface
ILoadBalancerService Methods
AddLoadBalancerMetadataAsync Method
AddNodeAsync Method
AddNodeMetadataAsync Method
AddNodeRangeAsync Method
AddVirtualAddressAsync Method
ClearAccessListAsync Method
CreateAccessListAsync Method
CreateLoadBalancerAsync Method
GetConnectionLoggingAsync Method
GetContentCachingAsync Method
GetErrorPageAsync Method
GetHealthMonitorAsync Method
GetLoadBalancerAsync Method
GetLoadBalancerMetadataItemAsync Method
GetNodeAsync Method
GetNodeMetadataItemAsync Method
GetSessionPersistenceAsync Method
GetSslConfigurationAsync Method
GetStatisticsAsync Method
ListAccessListAsync Method
ListAccountLevelUsageAsync Method
ListAlgorithmsAsync Method
ListAllowedDomainsAsync Method
ListBillableLoadBalancersAsync Method
ListCurrentUsageAsync Method
ListHistoricalUsageAsync Method
ListLoadBalancerMetadataAsync Method
ListLoadBalancersAsync Method
ListNodeMetadataAsync Method
ListNodesAsync Method
ListNodeServiceEventsAsync Method
ListProtocolsAsync Method
ListThrottlesAsync Method
ListVirtualAddressesAsync Method
RemoveAccessListAsync Method
RemoveAccessListRangeAsync Method
RemoveErrorPageAsync Method
RemoveHealthMonitorAsync Method
RemoveLoadBalancerAsync Method
RemoveLoadBalancerMetadataItemAsync Method
RemoveLoadBalancerRangeAsync Method
RemoveNodeAsync Method
RemoveNodeMetadataItemAsync Method
RemoveNodeRangeAsync Method
RemoveSessionPersistenceAsync Method
RemoveSslConfigurationAsync Method
RemoveThrottlesAsync Method
RemoveVirtualAddressAsync Method
RemoveVirtualAddressRangeAsync Method
SetConnectionLoggingAsync Method
SetContentCachingAsync Method
SetErrorPageAsync Method
SetHealthMonitorAsync Method
SetSessionPersistenceAsync Method
UpdateLoadBalancerAsync Method
UpdateLoadBalancerMetadataItemAsync Method
UpdateNodeAsync Method
UpdateNodeMetadataItemAsync Method
UpdateSslConfigurationAsync Method
UpdateThrottlesAsync Method
Click or drag to resize
ILoadBalancerServiceSetSessionPersistenceAsync Method
This API is preliminary and subject to change.
Sets the session persistence configuration for a load balancer.

Namespace: net.openstack.Providers.Rackspace
Assembly: openstacknet (in openstacknet.dll) Version: 1.7.7+Branch.master.Sha.25d803f397c8693c2c13777ef6675f796f520f2c
Syntax
Copy
Task SetSessionPersistenceAsync(
	LoadBalancerId loadBalancerId,
	SessionPersistence sessionPersistence,
	AsyncCompletionOption completionOption,
	CancellationToken cancellationToken,
	IProgress<LoadBalancer> progress
)

Parameters

loadBalancerId
Type: net.openstack.Providers.Rackspace.Objects.LoadBalancersLoadBalancerId
The load balancer ID. This is obtained from LoadBalancer.Id.
sessionPersistence
Type: net.openstack.Providers.Rackspace.Objects.LoadBalancersSessionPersistence
The session persistence configuration.
completionOption
Type: net.openstack.CoreAsyncCompletionOption
Specifies when the Task representing the asynchronous server operation should be considered complete.
cancellationToken
Type: System.ThreadingCancellationToken
The CancellationToken that the task will observe.
progress
Type: SystemIProgressLoadBalancer
An optional callback object to receive progress notifications, if completionOption is RequestCompleted. If this is , no progress notifications are sent.

Return Value

Type: Task
A Task object representing the asynchronous operation. If completionOption is RequestCompleted, the task will not be considered complete until the load balancer transitions out of the PendingUpdate state.
Exceptions
ExceptionCondition
ArgumentNullException If loadBalancerId is .

-or-

If sessionPersistence is .

ArgumentException If completionOption is not a valid AsyncCompletionOption.
WebExceptionIf the REST request does not return successfully.
Remarks
You can only set one of the session persistence modes on a load balancer, and it can only support one protocol, so if you set HttpCookie mode for an HTTP load balancer, then it will support session persistence for HTTP requests only. Likewise, if you set SourceAddress mode for an HTTPS load balancer, then it will support session persistence for HTTPS requests only.

If you want to support session persistence for both HTTP and HTTPS requests concurrently, then you have 2 choices:

  • Use two load balancers, one configured for session persistence for HTTP requests and the other configured for session persistence for HTTPS requests. That way, the load balancers together will support session persistence for both HTTP and HTTPS requests concurrently, with each load balancer supporting one of the protocols.
  • Use one load balancer, configure it for session persistence for HTTP requests, and then enable SSL termination for that load balancer (refer to Section 4.17, "SSL Termination" for details). The load balancer will then support session persistence for both HTTP and HTTPS requests concurrently.
Version Information

.NET Framework

Supported in: 4.5

openstack.net

Supported in: 1.6, 1.5, 1.4
See Also