Session Agent

The following table lists SOAP attributes and sub-elements for the session agent.

SOAP Attributes/Sub-elements ACLI session-router->session-agent Default Values Valid Values SBC Version
hostname *#

ipAddress #

port

state

appProtocol #

appType

transMethod

realmID

description

options

SessionAgentMediaProfile

acliObjectName *#

SessionAgentCarriers

acliObjectName *#

allowNextHop

inTranslationId

outTranslationId

useConstraints

maxNumSessions

maxOutbSessions

maxBurstRate

maxSustainedRate

timeToResume

noResponseTo

inServicePeriod

burstWindow

sustainedWindow

hostname

ip-address

port

state

app-protocol

app-type

transport-method

realm-id

description

options

media-profiles

carriers

allow-next-hop-ip

in-translationid

outtranslationId

constraints

max-sessions

max-outbound-sessions

max-burst-rate

max-sustain-rate

time-to-resume

ttr-no-response

in-service-period

burst-rate-window

sustain-rate-window

5060

enabled

UDP

disabled

disabled

0

0

0

0

0

0

0

0

0

FQDN or ipv4

0.0.0.0 or Ipv4

0, 1025-65535

enabled/disabled

SIP or H323

H323-GK or H323-GW for H323 only

UDP, UDP+TCP, dynamicTCP, staticTCP

empty or <realm>

list of comma seperated options

List of <media-profiles> for H323 only

<media-profile>

List of carriers

<carrier-code>

enabled/disabled

empty or <translation-profile>

enabled/disabled

0-999999999

0-999999999

0-999999999

0-999999999

0-999999999

0-999999999

0-999999999

0-999999999

0-999999999

4.0.0 and above
trustMe

proxyMode

redirectAct

allocMedia

responseMap

looseRouter

inclCarrierAs

pingMethod

pingInterval

trust-me

proxy-mode

redirect-action

send-media-session

response-map

loose-routing

req-uri-carrier-mode

ping-method

ping-interval

enabled

enabled

disabled

None

0

enabled/disabled

empty, proxy, redirect, record-route

empty, proxy, recurse

enabled/disabled

empty or <sip-response-code-profile>

enabled, disabled

None, URI-param, Prefix

INFO, OPTIONS

0-999999999

4.0.0 and above (for SIP only)
localresponseMap

pingToUserPart

pingFromUserPart

RequesturiHeader

acliObjectName *#

stopRecurse

local-response-map

ping-to-user-part

ping-from-user-part

request-uri-headers

stop-recurse

  empty or <sip-response-code-profile>

list of headers

list of response codes, 300-599

 
trustMeForLI li-trust-me disabled enabled/disabled  
assertedID

SessionAgentTrunkGroup

acliObjectName *#

inManipulationId

outManipulationId

maxRegisterSustainedRate

p-asserted-id

trunk-group

in-manipulationid

out-manipulationid

max-register-sustain-rate

0 sip:name@acme.com or tel:+1234

list of trunk groups or group:context

empty or <sip-manipulation>

0-999999999

 
earlyMediaAllow invalidateRegistrations early-media-allow

invalidate-registrations

disabled empty, none, reverse, both

enabled/disabled

4.0.1 and above (for SIP only)
minSeizure minAnswerSeizureRatio min-seizures

min-asr

5

0

1-999999999

0-100

4.0.1 and above
rfc2833-mode

rfc2833-payload

rfc2833-mode

rfc2833-payload

none

0

none, transparent, preferred

0, 96-127

4.1.0 and above for H323
maxInbSessions

maxInbBurstRate

maxOutbBurstRate

maxInbSustainedRate

maxOutbSustainedRate

max-inbound-sessions

max-inbounds-burst-rate

max-outbound-burst-rate

max-outbound-sustain-rate

0

0

0

0

0

0-999999999

0-999999999

0-999999999

0-999999999

0-999999999

4.0.1; 4.1.1 and above
codecPolicy

inServiceCodes

outServicecodes

codec-policy

in-service-response-codes

out-service-response-codes

  empty or <codec-policy>

list of comma-separated response codes, 200-699

4.1.1 and above (for SIP only)
rfc2833-mode

rfc2833-payload

rfc2833-mod

rfc2833-payload

None

0

none, transparent, preferred, dual

0, 96-127

 
reuse-connections

tcp-keepalive

tcp-reconn-Interval

enforcementProfile

reuse-connections

tcp-keepalive

tcp-reconn-interval

enforcement-profile

NONE

none

0

NONE, TCP

none, disabled, enabled

0, 2-300

empty or <enforcement-profile>

4.1.4; 5.1.0 and above (for SIP only)
maxRegisterBurstRate

registerBurstWindow

max-register-burst-rate

register-burst-window

0

0

0-999999999

0-999999999

4.1.4, 5.1.1 and above (for SIP only)
referCallTransfer

pingSendMode

egressRealmID

refer-call-transfer

ping-send-mode

egress-realm-id

disabled

keep-alive

enabled, disabled

keep-alive, continuous

empty or <realm>

5.1.1 and above (for SIP only)
SessionAgentRateConstraints

method

maxInBurstRate

maxOutBurstRate

maxInSustainedRate

maxOutSustainedRate

rate-constraints

method

max-inbound-burst-rate

max-outbound-burst-rate

max-inbound-sustain-rate

max-outbound-sustain-rate

  INVITE, ACK, BYE, REGISTER, CANCEL, PRACK, OPTIONS, INFO, SUBSCRIBE, NOTIFY, REFER, UPDATE, MESSAGE, PUBLISH

0-999999999

0-999999999

0-999999999

0-999999999

5.1.1 and above
hmrString

transMethod

reuse-connections

manipulation-string

transport-method

reuse-connections

UDP

NONE

UDP, UDP+TCP, dynamicTCP, staticTCP, dynamicTLS, staticTLS, staticSCTP, NONE, TCP, SCTP 6.1.0 and above (for SIP only)
pingAllAddresses

sipProfile

sipIsupProfile

manipPattern

referCallTransfer

ping-all-addresses

sip-profile

sip-isup-profile

manipulation-pattern

refer-call-transfer

disabled

disabled

enabled, disabled

empty or <sip-profile>

empty or <sip-isup-profile>

disabled, enabled, dynamic

6.2.0 above (for SIP only)
hostname *#

ipAddress

hostname

ip-address

  fqdn, ipv4, ipv6

ipv4, ipv6

CX6.2.0 and above