SIPProxySettings


This type is a class for model objects.

These settings describe the global attributes and policies that define the behavior of the WebSphere SIP (Session Initiation Protocol) proxy server.

Package: sipproxy

Classifier ID:  -1
Instance class name:  * Unspecified *
Instance class:  * Unspecified *



Attributes Summary
defaultClusterName : EString An optional setting required when there are multiple server clusters than can handle SIP requests. A SIP message will be routed to this default cluster when none of the enabled SIP Routing Rules apply to the message. If there is only one server cluster that can handle SIP requests, the SIP Proxy will discover that automatically and this attribute is not required.
enableAccessLog : EBoolean Enable access to the proxy server are logged
proxyAccessLog : EString The location of the SIP Proxy access log in NCSA common or combined format.
accessLogMaximumSize : EInt The size of the access log before it rolls over.
SIPAdvisorIPAddress : EString @since 7.0.0 The IP Address of the Load Balancer used to load balance SIP Proxies. This is used by the SIP Proxy to automatically respond with a 200 OK if the SIP Proxy is able to forward messages to the SIP container cluster or a 503 if it is unable to. This should be a string representation of the IP address ie.. ?192.101.1.5?. This is used in conjunction with the SIPAdvisorMethodName custom property.
SIPAdvisorMethodName : EString @since 7.0.0 This is the string representation of the method name that the Load Balancer is sending to the SIP Proxy used for ?health checks?. This should be in the format of ?OPTIONS? or ?INFO?. This is used in conjunction with the LBIPAddr custom property.
keepAliveInterval : EInt @since 7.0.0 The interval at which the KEEPALIVE packets are sent to the SIP containers. This is specified in milliseconds.
keepAliveFailures : EInt @since 7.0.0 The number of KEEPALIVE requests sent without getting a response, before considering this server down.
maxThroughputFactor : EInt @since 7.0.0 This is used to turn on overload protection at the proxy. This value is a percentage of the SIP Container's Maximum Messages per Averaging Period. The default value of 0 disables this from being used but the standard overload controls are still enabled.
overloadResponseCode : EInt @since 7.0.0 When the proxy detects an overload condition, it doesn't allow dialog-creating requests through to the container. By default, it will respond to the request with a "503 Service Unavailable" error response. If the overloadResponseCode is set, it will respond with this value. For example, if the overloadResponseCode is set to 500, the proxy will respond with "500 Service Unavailable".
overloadResponseReasonPhrase : EString @since 7.0.0 When the proxy detects an overload condition, it doesn't allow dialog-creating requests through to the container. By default, it will respond to the request with a "503 Service Unavailable" error response. If the overloadResponseReasonPhrase is set, it will respond with this string. For example, if the overloadResponseReasonPhrase is set to "Service Overloaded", the proxy will respond with "503 Service Overloaded".
retryAfterValue : EInt @since 7.0.0 This property allows for the modification of the Retry-After header value that gets returned if SIP containers are overloaded or if the SIP proxy can not find any servers up to route a request to. This should be specified in seconds. It defines how long a UAC should wait before sending the same request again.
numAdvisorRequestsBeforeFailure : EInt @since 7.0.0 The number of SIP advisor requests to miss before this SIP proxy informs the other SIP proxies that it is no longer processing data. The valid range for this property is 0 to 10.
tcpSprayer : IPSprayer @ * No description is available *
properties : Property * * No description is available *
externalDomains : ExternalDomain * * No description is available *
routingRules : SIPRoutingRule * * No description is available *
tlsSprayer : IPSprayer @ * No description is available *
udpSprayer : IPSprayer @ * No description is available *



Attribute Details

defaultClusterName  -  An optional setting required when there are multiple server clusters than can handle SIP requests. A SIP message will be routed to this default cluster when none of the enabled SIP Routing Rules apply to the message. If there is only one server cluster that can handle SIP requests, the SIP Proxy will discover that automatically and this attribute is not required.
    Data Type: EString
    Default value:  unspecified
    Required:  false
    Changeable:  true
    Unsettable:  false
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

enableAccessLog  -  Enable access to the proxy server are logged
    Data Type: EBoolean
    Default value:  false
    Required:  false
    Changeable:  true
    Unsettable:  true
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

proxyAccessLog  -  The location of the SIP Proxy access log in NCSA common or combined format.
    Data Type: EString
    Default value:  ${SERVER_LOG_ROOT}/sipproxy.log
    Required:  false
    Changeable:  true
    Unsettable:  false
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

accessLogMaximumSize  -  The size of the access log before it rolls over.
    Data Type: EInt
    Default value:  20
    Required:  false
    Changeable:  true
    Unsettable:  true
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

SIPAdvisorIPAddress  -  @since 7.0.0 The IP Address of the Load Balancer used to load balance SIP Proxies. This is used by the SIP Proxy to automatically respond with a 200 OK if the SIP Proxy is able to forward messages to the SIP container cluster or a 503 if it is unable to. This should be a string representation of the IP address ie.. ?192.101.1.5?. This is used in conjunction with the SIPAdvisorMethodName custom property.
    Data Type: EString
    Default value:  
    Required:  false
    Changeable:  true
    Unsettable:  false
    Many:  true
    Ordered:  true
    Lower bound:  0
    Upper bound:  2
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

SIPAdvisorMethodName  -  @since 7.0.0 This is the string representation of the method name that the Load Balancer is sending to the SIP Proxy used for ?health checks?. This should be in the format of ?OPTIONS? or ?INFO?. This is used in conjunction with the LBIPAddr custom property.
    Data Type: EString
    Default value:  
    Required:  false
    Changeable:  true
    Unsettable:  false
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

keepAliveInterval  -  @since 7.0.0 The interval at which the KEEPALIVE packets are sent to the SIP containers. This is specified in milliseconds.
    Data Type: EInt
    Default value:  0
    Required:  false
    Changeable:  true
    Unsettable:  true
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

keepAliveFailures  -  @since 7.0.0 The number of KEEPALIVE requests sent without getting a response, before considering this server down.
    Data Type: EInt
    Default value:  0
    Required:  false
    Changeable:  true
    Unsettable:  true
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

maxThroughputFactor  -  @since 7.0.0 This is used to turn on overload protection at the proxy. This value is a percentage of the SIP Container's Maximum Messages per Averaging Period. The default value of 0 disables this from being used but the standard overload controls are still enabled.
    Data Type: EInt
    Default value:  0
    Required:  false
    Changeable:  true
    Unsettable:  true
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

overloadResponseCode  -  @since 7.0.0 When the proxy detects an overload condition, it doesn't allow dialog-creating requests through to the container. By default, it will respond to the request with a "503 Service Unavailable" error response. If the overloadResponseCode is set, it will respond with this value. For example, if the overloadResponseCode is set to 500, the proxy will respond with "500 Service Unavailable".
    Data Type: EInt
    Default value:  503
    Required:  false
    Changeable:  true
    Unsettable:  true
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

overloadResponseReasonPhrase  -  @since 7.0.0 When the proxy detects an overload condition, it doesn't allow dialog-creating requests through to the container. By default, it will respond to the request with a "503 Service Unavailable" error response. If the overloadResponseReasonPhrase is set, it will respond with this string. For example, if the overloadResponseReasonPhrase is set to "Service Overloaded", the proxy will respond with "503 Service Overloaded".
    Data Type: EString
    Default value:  Service Unavailable
    Required:  false
    Changeable:  true
    Unsettable:  false
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

retryAfterValue  -  @since 7.0.0 This property allows for the modification of the Retry-After header value that gets returned if SIP containers are overloaded or if the SIP proxy can not find any servers up to route a request to. This should be specified in seconds. It defines how long a UAC should wait before sending the same request again.
    Data Type: EInt
    Default value:  5
    Required:  false
    Changeable:  true
    Unsettable:  true
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

numAdvisorRequestsBeforeFailure  -  @since 7.0.0 The number of SIP advisor requests to miss before this SIP proxy informs the other SIP proxies that it is no longer processing data. The valid range for this property is 0 to 10.
    Data Type: EInt
    Default value:  0
    Required:  false
    Changeable:  true
    Unsettable:  true
    Many:  false
    Ordered:  true
    Lower bound:  0
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

tcpSprayer  -  * No description is available *
    Reference Type: IPSprayer @
    Containment:  true
    Container:  false
    Required:  true
    Changeable:  true
    Unsettable:  false
    Many:  false
    Ordered:  true
    Lower bound:  1
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

properties  -  * No description is available *
    Reference Type: Property *
    Containment:  true
    Container:  false
    Required:  false
    Changeable:  true
    Unsettable:  false
    Many:  true
    Ordered:  true
    Lower bound:  0
    Upper bound:  Unbounded
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

externalDomains  -  * No description is available *
    Reference Type: ExternalDomain *
    Containment:  true
    Container:  false
    Required:  false
    Changeable:  true
    Unsettable:  false
    Many:  true
    Ordered:  true
    Lower bound:  0
    Upper bound:  Unbounded
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

routingRules  -  * No description is available *
    Reference Type: SIPRoutingRule *
    Containment:  true
    Container:  false
    Required:  false
    Changeable:  true
    Unsettable:  false
    Many:  true
    Ordered:  true
    Lower bound:  0
    Upper bound:  Unbounded
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

tlsSprayer  -  * No description is available *
    Reference Type: IPSprayer @
    Containment:  true
    Container:  false
    Required:  true
    Changeable:  true
    Unsettable:  false
    Many:  false
    Ordered:  true
    Lower bound:  1
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false

udpSprayer  -  * No description is available *
    Reference Type: IPSprayer @
    Containment:  true
    Container:  false
    Required:  true
    Changeable:  true
    Unsettable:  false
    Many:  false
    Ordered:  true
    Lower bound:  1
    Upper bound:  1
    Unique:  true
    Derived:  false
    Transient:  false
    Volatile:  false



(C) COPYRIGHT International Business Machines Corp. 1996-2006