SipUaProtocolConfig Object

HOME | TECHNOLOGIES | TEST CONFIGURATION | SEQUENCER COMMANDS | GUI COMMAND NAMES | ALL COMMANDS | RESULT | PDU | ALL | OBJECT TREE

Description:

Create instance of a SIP UA protocol.

Parents: EmulatedDevice

Result children (automatically created): SipUaResults

Relations:

Side name
(Type)		 Relative Description
ClientLoadProfile
(AffiliatedClientLoadProfile)

ClientLoadProfile

Client load profile used by a client.
ClientProfile
(AffiliatedClientProfile)

ClientProfile

Client profile used by a client.
AudioRtcpStreamBlock
(AudioRtcpStreamBlock)

StreamBlock

Audio RTCP stream block relations.
AudioStreamBlock
(AudioStreamBlock)

StreamBlock

Audio RTP stream block relations.
L4L7ProtocolConfigServerBase
(ConnectionDestination)

SipUaProtocolConfig

One SipUaProtocolConfig can have 0..1 associations with another SipUaProtocolConfig.
ViewControlPlaneMplsBindingResult
(ControlPlaneBindingResult)

ViewControlPlaneMplsBindingResult

ConvergenceConfig
(PrimaryPathProtocolConfig)

ConvergenceConfig, ConvergenceConfig

ResultChild
(ResultChild)

SipUaResults

Use this to connect a results object to an object.
TimeComparisonPair
(TimeComparisonPairSrcProtocol)

TsnProtocolsTimeComparisonPair, TsnProtocolsTimeComparisonPair

L4L7ProtocolConfigClientBase
(UseRegistrationCarrier)

SipUaProtocolConfig

UsesIf
(UsesIf)

Aal5If, EthIIIf, FcIf, GreIf, GroupIf, HdlcIf, Ipv4If, Ipv6If, Ipv6SrhIf, ItagIf, L2tpv2If, L2tpv3If, LispIf, MacsecIf, MplsIf, PppIf, PppoeIf, TrillIf, VbrasIf, VlanIf, VxlanGpeIf, VxlanIf

Specifies the interfaces used by the configuration object (configuration object examples: BgpRouterConfig, LdpRouterConfig, and so on).
VideoRtcpStreamBlock
(VideoRtcpStreamBlock)

StreamBlock

Video RTCP stream block relations.
VideoStreamBlock
(VideoStreamBlock)

StreamBlock

Video RTP stream block relations.

SipUaProtocolConfig Writable Attributes

Attribute Description
Common Writable Attributes Active, Name
AuthPasswordDebug

Controls whether display MD5 Password or not in SIP MD5 authentication packet.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

There is Authentication Password field in SIP captured packet for MD5 authentication.
FALSE

There is no Authentication Password field in SIP captured packet for MD5 authentication.

AuthPasswordFormat

Password format for MD5 authorization.

Type: string

Default: spirent%u
AuthPasswordNumStart

UA password for MD5 authorization.

Type: u32

Default: 1
AuthPasswordNumStep

UA password step for MD5 authorization.

Type: u32

Default: 0
AuthType

Authentication type.

Type: enum

Default: MD5_DIGEST

Possible Values:

Value Description
MD5_DIGEST

MD5 digest authentication.
AuthUserNameFormat

UA user name format for MD5 authorization.

Type: string

Default: spirent%u
AuthUserNameNumStart

UA user name start number for MD5 authorization.

Type: u32

Default: 10000
AuthUserNameNumStep

UA user name step for MD5 authorization.

Type: u32

Default: 1
ClientName

A name for the client.

Type: string

Default: "" (empty string)

DynamicLoad

Load value in units of the load profile, only used when Use Dynamic Load is true.

Type: s32

Default: 30

Range: 1 - 1000000
EndpointConnectionPattern

Intra block connection pattern options.

Type: enum

Default: PAIR

Possible Values:

Value Description
PAIR

Pair connection(s).

BACKBONE_SRC_FIRST

Backbone connection(s) - varying the source address first.

BACKBONE_DST_FIRST

Backbone connection(s) - varying the destination address first.
BACKBONE_INTERLEAVED

Backbone connection(s) - varying the source address first.
Imsi

International Mobile Subscriber Identity.

Type: u64

Default: 111222000000000
ImsiStep

IMSI step.

Type: u64

Default: 1
LocalPort

UDP port that emulated SIP UA runs on.

Type: u16

Default: 5060
MncLength

Mobile Network Code length.

Type: enum

Default: MNCLENGTH_2

Possible Values:

Value Description
MNCLENGTH_2

2 digits.
MNCLENGTH_3

3 digits.
RanID

Radio Access Network identifier.

Type: u64

Default: 1
RanIDStep

RAN ID step.

Type: u64

Default: 1
RanType

RAN type.

Type: enum

Default: RANTYPE_GERAN

Possible Values:

Value Description
RANTYPE_GERAN

3GPP GSM EDGE Radio Access Network.
RANTYPE_UTRAN_FDD

3GPP Universal Terrestrial Radio Access Network - Frequency Division Duplexing.
RANTYPE_UTRAN_TDD

3GPP Universal Terrestrial Radio Access Network - Time Division Duplexing.
RealmName

Realm name.

Type: string

Default: "" (empty string)

RegistersFor

User agent block handler registered for gateway.

Type: handle

Default: 1
UaNumFormat

UA number format.

Type: string

Default: spirent%u
UaNumsPerDevice

Number of UAs per device.

Type: u32

Default: 1

Range: 1 - 32768
UaNumStart

Starting UA number.

Type: u64

Default: 10000
UaNumStep

UA number step value when UaNumsPerDevice is set larger than 1.

Type: u64

Default: 1
UsePartialBlockState

Unused.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Unused.
FALSE

Unused.

SipUaProtocolConfig Read-Only Attributes

Read-Only Attribute Description
LoadProfileRunState

Status indicator to show if the client protocol config is actually running.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Client protocol config is running.
FALSE

Client protocol config is not running.
RegState

UA Block's registration state.

Type: enum

Default: NOT_REGISTERED

Possible Values:

Value Description
NOT_REGISTERED

Not registered.
REGISTERING

Registering.
REGISTRATION_SUCCEEDED

Registration succeeded.
REGISTRATION_FAILED

Registration failed.
REGISTRATION_CANCELED

Registration canceled.
UNREGISTERING

Unregistering.