SipUaProtocolProfile Object

Description:

SIP protocol specific attributes for a SIP UA.

Writable Attributes
Read-Only Attributes

Parents: ClientProfile

Automatically-created children: SipUaDnsProfile, SipUaDomainProfile, SipUaMobileProfile, SipUaRegistrarProfile

SipUaProtocolProfile Writable Attributes

Attribute

Description

Common Writable Attributes

Active, Name

AnonymousCall

Whether to use display name for From header.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Display name will not be used for From header.
FALSE	Display name will be used.

AudioCodec

Emulated audio codec.

Type: enum

Default: G_711

Possible Values:

Value	Description
G_711	G.711 (Mu-law).
G_723_1	G.723.1 (6.3 kbit/s).
G_729	G.729
G_711_LOWRATE	G.711 (LowRate).
G_711_A_LAW	G.711 (A-law).
G_723_1_5_3	G.723.1 (5.3 kbit/s).
G_729_A	G.729A
G_729_B	G.729B
G_729_AB	G.729AB
G_726_32	G.726 (32 kbit/s).
G_711_1_MU_LAW_96	G.711.1 (Mu-law,96 kbit/s).
G_711_1_A_LAW_96	G.711.1 (A-law,96 kbit/s).
AMRNB_0_OA_475	AMR-NB (octet aligned) 4.75 kbit/s.
AMRNB_1_OA_515	AMR-NB (octet aligned) 5.15 kbit/s.
AMRNB_2_OA_590	AMR-NB (octet aligned) 5.90 kbit/s.
AMRNB_3_OA_670	AMR-NB (octet aligned) 6.70 kbit/s.
AMRNB_4_OA_740	AMR-NB (octet aligned) 7.40 kbit/s.
AMRNB_5_OA_795	AMR-NB (octet aligned) 7.95 kbit/s.
AMRNB_6_OA_102	AMR-NB (octet aligned) 10.2 kbit/s.
AMRNB_7_OA_122	AMR-NB (octet aligned) 12.2 kbit/s.
AMRNB_0_BE_475	AMR-NB (bandwidth efficient) 4.75 kbit/s.
AMRNB_1_BE_515	AMR-NB (bandwidth efficient) 5.15 kbit/s.
AMRNB_2_BE_590	AMR-NB (bandwidth efficient) 5.90 kbit/s.
AMRNB_3_BE_670	AMR-NB (bandwidth efficient) 6.70 kbit/s.
AMRNB_4_BE_740	AMR-NB (bandwidth efficient) 7.40 kbit/s.
AMRNB_5_BE_795	AMR-NB (bandwidth efficient) 7.95 kbit/s.
AMRNB_6_BE_102	AMR-NB (bandwidth efficient) 10.2 kbit/s.
AMRNB_7_BE_122	AMR-NB (bandwidth efficient) 12.2 kbit/s.
AMRWB_0_OA_660	AMR-WB (octet aligned) 6.60 kbit/s.
AMRWB_1_OA_885	AMR-WB (octet aligned) 8.85 kbit/s.
AMRWB_2_OA_1265	AMR-WB (octet aligned) 12.65 kbit/s.
AMRWB_3_OA_1425	AMR-WB (octet aligned) 14.25 kbit/s.
AMRWB_4_OA_1585	AMR-WB (octet aligned) 15.85 kbit/s.
AMRWB_5_OA_1825	AMR-WB (octet aligned) 18.25 kbit/s.
AMRWB_6_OA_1985	AMR-WB (octet aligned) 19.85 kbit/s.
AMRWB_7_OA_2305	AMR-WB (octet aligned) 23.05 kbit/s.
AMRWB_8_OA_2385	AMR-WB (octet aligned) 23.85 kbit/s.
AMRWB_0_BE_660	AMR-WB (bandwidth efficient) 6.60 kbit/s.
AMRWB_1_BE_885	AMR-WB (bandwidth efficient) 8.85 kbit/s.
AMRWB_2_BE_1265	AMR-WB (bandwidth efficient) 12.65 kbit/s.
AMRWB_3_BE_1425	AMR-WB (bandwidth efficient) 14.25 kbit/s.
AMRWB_4_BE_1585	AMR-WB (bandwidth efficient) 15.85 kbit/s.
AMRWB_5_BE_1825	AMR-WB (bandwidth efficient) 18.25 kbit/s.
AMRWB_6_BE_1985	AMR-WB (bandwidth efficient) 19.85 kbit/s.
AMRWB_7_BE_2305	AMR-WB (bandwidth efficient) 23.05 kbit/s.
AMRWB_8_BE_2385	AMR-WB (bandwidth efficient) 23.85 kbit/s.
AAC_LD	AAC-LD (64 kbit/s).

AudioPayloadType

RTP dynamic payload type for audio codecs.

Type: u8

Default: 96

Range: 96 - 127

AudioSrcPort

UDP port that RTP/Audio streams should be send out.

Type: u16

Default: 50050

CalleeNumberContext

Callee number context for local tel-URI format.

Type: string

Default: "" (empty string)

CalleeUriScheme

Uniform resource identifier (URI) scheme used to invite callees.

Type: enum

Default: SIP

Possible Values:

Value	Description
SIP	sip:
TEL	tel:

CallIDDomainName

Whether to add domain name in Call-ID.

Type: bool

Default: TRUE

Possible Values:

Value	Description
TRUE	Include domain name in Call-ID.
FALSE	Do not include domain name in Call-ID.

CallTime

Duration (in seconds) of calls.

Type: u32

Default: 300

CallType

Emulated UA call type: signaling only, audio UA or audio/video UA.

Type: enum

Default: AUDIO_ONLY

Possible Values:

Value	Description
SIGNALING_ONLY	Signaling only.
AUDIO_ONLY	Audio.
AUDIO_VIDEO	Audio and video.
TELEPRESENCE	Telepresence.

DefaultRefresher

Default Refresher as UAC or UAS.

Type: enum

Default: REFRESHER_UAC

Possible Values:

Value	Description
REFRESHER_UAC	Default Refresher is UAC.
REFRESHER_UAS	Default Refresher is UAS.

EnableAudioStatistic

Whether to calculate audio statistics.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Calculate audio statistics.
FALSE	Do not calculate audio statistics.

EnableRegRefresh

Enable automatic registration refresh.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Enable automatic registration refresh.
FALSE	Disable automatic registration refresh.

EnableVideoStatistic

Whether to calculate video statistics.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Calculate video statistics.
FALSE	Do not calculate video statistics.

EnableVoiceStatistic

Whether to calculate voice statistics.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Calculate voice statistics.
FALSE	Do not calculate voice statistics.

IncludeSdpStartTs

Includes active time(t) assignment to start timestamp in SDP Time Description.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Active time(t) is set to start timestamp.
FALSE	Active time(t) is set to 0.

LocalTelUriFormat

Enable local tel-URI format (RFC3966).

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Use local tel-URI format.
FALSE	Use global tel-URI format.

MinSessionExpiration

Minimum session expiration (Min-SE) header value for all calls using the session expiration timer. If its value is 0, this function will be disabled, otherwise, it has value 90-4294967295.

Type: u32

Default: 1800

Range: 0 - 86400

ProxyDomain

Domain suffix that is used to build the URI in SIP messages. This is also the SIP proxy server domain name. If this field isn't set, the proxy IP address is used to build the URI.

Type: string

Default: "" (empty string)

ProxyIpv4Addr

SIP Proxy server IPv4 address.

Type: ip

Default: 0.0.0.0

ProxyIpv6Addr

SIP Proxy server IPv6 address.

Type: ipv6

Default: ::

ProxyName

SIP proxy server name.

Type: string

Default: "" (empty string)

ProxyPort

Port that SIP proxy server runs on.

Type: u16

Default: 5060

RegBurstSize

How many registration requests should be send in one second.

Type: u32

Default: 1

RegExpires

How many seconds the registration is valid for.

Type: u32

Default: 3600

Range: 1 - 4294967295

RegRetries

How many registration requests should be send after timeout.

Type: u32

Default: 3

RegsPerSecond

How many registration requests should be send in one second.

Type: u32

Default: 10

ReliableProvisonalResponse

Whether to enable reliable 1XX response domain name in Call-ID.

Type: bool

Default: TRUE

Possible Values:

Value	Description
TRUE	Enable Reliable 1XX response domain name in Call-ID.
FALSE	Do not enable.

RingTime

Waiting time (in seconds) before sending 200 OK after sending "180 Ring" when answering an INVITE request from a caller.

Type: u32

Default: 0

RtpIpv4Tos

IPv4 type of service setting to use for RTP/RTCP traffic.

Type: u8

Default: 192

RtpIpv6TrafficClass

IPv6 traffic class setting to use for RTP/RTCP traffic.

Type: u8

Default: 0

RtpTosType

How the type of service field is used.

Type: enum

Default: TOS

Possible Values:

Value	Description
TOS	Type of service.
DIFFSERV	Differentiated services.

RtpTrafficType

RTP traffic type: Simulated RTP or Media Encoded RTP.

Type: enum

Default: SIMULATED_RTP

Possible Values:

Value	Description
SIMULATED_RTP	Simulated RTP.
ENCODED_RTP	Encoded RTP.

SecureRequestURI

Whether to include transport information presence in SIP message.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Include transport information in the request line/To and From headers.
FALSE	Does not include transport information in the request line/To and From headers.

SipMessagesTransport

SIP messages transport type.

Type: enum

Default: UDP

Possible Values:

Value	Description
UDP	UDP
TCP	TCP

TipDeviceType

Emulated TIP device type. Used for Cisco CM to identify TIP device.

Type: enum

Default: CTS500_37

Possible Values:

Value	Description
CTS500_37	CTS500 with 37 inch screen.
CTS500_32	CTS500 with 32 inch screen.
CTS1000	CTS1000.
CTS1100	CTS1100.
CTS1300_65	CTS1300 with 65 inch screen.
CTS1300_47	CTS1300 with 47 inch screen.
CTS1310_65	CTS1310 with 65 inch screen.
CTS3000	CTS3000.
CTS3200	CTS3200.
CE20	Cisco E20.
CEX60	Cisco EX60.
CEX90	Cisco EX90.
CTQSC90	Cisco TP Quick Set C90.
CTQSC60	Cisco TP Quick Set C60.
CTQSC40	Cisco TP Quick Set C40.
CTQSC20	Cisco TP Quick Set C20.
CTP42C60	Cisco TP Profile 42 (C60).
CTP42C40	Cisco TP Profile 42 (C40).
CTP42C20	Cisco TP Profile 42 (C20).
CTP52C40	Cisco TP Profile 52 (C40).
CTP52C60	Cisco TP Profile 52 (C60).
CTP52DC60	Cisco TP Profile 52 Duo (C60).
CTP65	Cisco TP Profile 65.
CTP65DC90	Cisco TP Profile 65 Duo (C90).
CTMX200	Cisco TP MX200.
CTMX300	Cisco TP MX300.
CTSX20	Cisco TP SX20.
CTX9000	Cisco TX 9000.
CTX9200	Cisco TX 9200.

UseCompactHeaders

Whether to use SIP compact header formats.

Type: bool

Default: FALSE

Possible Values:

Value	Description
TRUE	Use SIP compact header format.
FALSE	Use SIP normal header format.

UseSipQosForRtpTraffic

Whether to use same IPv4 ToS and IPv6 traffic class settings as SIP signaling packets for RTP/RTCP data plane traffic.

Type: bool

Default: TRUE

Possible Values:

Value	Description
TRUE	Use the Ipv4Tos and Ipv6TrafficClass settings used for SIP for RTP/RTCP traffic as well.
FALSE	Use the RtpIpv4Tos and RtpIpv6TrafficClass settings for RTP/RTCP traffic.

UseUaToUaSignaling

Whether to send SIP signaling to another UA or to a SIP server.

Type: bool

Default: TRUE

Possible Values:

Value	Description
TRUE	Send SIP signaling to another UA.
FALSE	Send SIP signaling to a SIP server.

VideoCodec

video codec to be emulated.

Type: enum

Default: H_263

Possible Values:

Value	Description
H_263	H.263
H_264	H.264
MP4V_ES	MP4V-ES
H_264_720p	H.264 720p
H_264_1080p	H.264 1080p
H_264_512_288	H.264 512x288
H_264_768_448	H.264 768x448

VideoPayloadType

RTP dynamic payload type for video codecs.

Type: u8

Default: 112

Range: 96 - 127

VideoSrcPort

UDP port that RTP/Video streams should be send out.

Type: u16

Default: 50052

SipUaProtocolProfile Read-Only Attributes

There are no read-only attributes.