Resource - ServerPool

About this Resource

Defines an ServerPool managed object.

REST API Methods for this Resource

Resource Schema

Configuration

Parameter Name Required Create Read-Only Data Type Description
Name Yes Yes Yes string Name to uniquely identify the Server Pool. The name must be unique within the DSC Node. It is recommended that the name be set to a short and unique value to facilitate logs and alarms correlation. Valid values: alphanumeric characters, dashes, and underscores (maximum size of 32). TL1Name: NAME
SessionBinding No No No PoolSessionBind Session Binding (DISABLED/SESSION/PCRF). If set to DISABLED, load balancing the chosen load balancing algorithm is applied. If set to SESSION, bind is performed to the Diameter Session-Id AVP. If set to PCRF, bind is performed to the EPC IP-CAN session. Default value: DISABLED. TL1Name: SBIND
LoadBalancing No Yes No LoadBalancingType Load Balancing When Round Robin Cost is selected then the lowest cost record is chosen as the routing destination. If more than one record has the same cost then messages are load shared in a round robin manner across the available destinations. Valid costs are values 1 to 99. When Round Robin Weight is selected, the weights represent the ratio of messages delivered to each destination. For example: Candidate A has weight = 10, B = 20 and C = 5. In a group of messages, the first 10 messages are sent to A, then the next 20 to B and the next 5 to C. The process is then restarted at A for the next messages. With Hash based the routing candidate is selected by hashing a defined AVP value in the message. When Least Loaded is selected, the weights indicate the relative message capacity of each server (in messages per second). Default Value: ROUND ROBIN WEIGHT. TL1Name: LDBALANCE
AVPAlias No Yes No string The name of an AVP Alias. This AVP is used by the hashing algorithm to perform traffic load balancing. Valid values: An AVP Alias which has been created in the DSC AVP Alias Definitions tables. If the AVP is not present in the message, then the hop-by-hop header value is used. Default value: session-id AVP. TL1Name: LBAVP
Status No No Yes ActInactType Server Pool State (INACTIVE/ACTIVE). When accessed as part of default routing, the server pool will require the configuration of Application IDs and must be active. Server Pools which are accessed directly as part of the DSC routing tables do not require Application IDs and do not need to be activated. TL1Name: STATE
InternalID No No Yes int32 Server Pool internal ID. Reserved for internal use. TL1Name: INTERNALID

  • No labels