Openscape Voice V10 - SOAP Interface Documentation
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Groups Pages
Public Attributes | List of all members
EndpointCreateObject Class Reference

Endpoint Create Data. More...

#include <osv-if-doc.h>

Public Attributes

xsd__string Name
 Endpoint Name. More...
 
xsd__string IpAddress
 Character string with the IP Address of the endpoint. More...
 
xsd__string AltIpAddress
 Optional secondary IP address of the endpoint. More...
 
xsd__string RasIpAddress
 Branch Type. More...
 
xsd__int Port
 Port is the signaling address of the endpoint. More...
 
xsd__int AltPort
 Optional secondary IP address of the endpoint. More...
 
xsd__int RasPort
 Maximum Branch Users. More...
 
xsd__string ManagementIpAddress
 Separate address for the endpoint allowing its management using a different IP address for its configuration than the signaling address (IpAddress field).The ManagementIpAddress can be provisioned in IPv4, IPv6 or FQDN format. More...
 
enum unsp__EndpointType EndpointType
 The type of the endpoint. More...
 
xsd__short Registration
 An integer that represents bitwise assignments of five attributes: More...
 
xsd__double TimeToLive
 Expiration time for the endpoint (if dynamic). More...
 
enum unsp__AccountAuth AccountAuth
 Account authentication. More...
 
xsd__string ProfileName
 Endpoint Profile. More...
 
xsd__int Sessions
 Maximum number of sessions allowed for the endpoint. More...
 
enum unsp__TransportType Transport
 The transport protocol for a SIP endpoint. More...
 
struct unsp__EndpointAttributes Attributes
 A list of boolean attributes of the endpoint. More...
 
xsd__string AddressOfRecord
 The address used by SIP at registration of the endpoint. More...
 
enum unsp__EpFailover ServerFailover
 Indicates whether network server failover is enabled for this endpoint. More...
 
enum unsp__KeysetUse KeysetUse
 Indicates whether the subscriber endpoint is associated with a keyset device, either as a primary or phantom line. More...
 
xsd__string CountryCode
 Country Code of the endpoint. More...
 
xsd__string AssociatedEndpointName
 Associated endpoint. More...
 
xsd__string IvtgNameDomain
 Ivtg Name Domain. More...
 
xsd__string LooseRoutingURI
 Loose Routing URI. More...
 
xsd__int MaxOriginatingSessionLimit
 Max Originating Session Limit. More...
 
xsd__int MaxTerminatingSessionLimit
 Max Terminating Session Limit. More...
 
enum unsp__SrtpSupport SrtpSupport
 "Best-Effort SRTP" attribute to determine whether to include the SRTP media in the SDP offer or not. More...
 
enum unsp__SrtpSupport SdesSrtpSupport
 "Best-Effort SRTP with SDES" attribute to determine whether to include the SRTP media in the SDP offer or not. More...
 
enum unsp__DnsSrv DnsSrv
 The type of the DnsSRV. More...
 
xsd__string DefaultHomeDn
 Default Home Dn. More...
 
xsd__string EndpointLocationName
 Endpoint location. More...
 
xsd__string EndpointLocationCode
 Endpoint Location Code. More...
 
enum unsp__EndpointNNIType EndpointNNIType
 The type of NNI endpoint. More...
 
xsd__string EndpointProviderName
 The name of the Endpoint Provider. More...
 
xsd__string EndpointLocationDomain
 Endpoint Location Domain. More...
 
enum unsp__Anat AnatSupport
 Indicates whether the endpoint supports ANAT. More...
 
xsd__int OutgoingCallSupervisionTimer
 Supervises the time between sending an INVITE request and receiving a provisional (non-100 Trying) or final response from the endpoint. More...
 
xsd__int ProxyBypassSupervisionTimer
 Supervises the time between sending an INVITE request to a SIP proxy and receiving a provisional (incl. More...
 
enum unsp__ICESupport ICESupport
 Indicates whether the endpoint supports ICE . More...
 
xsd__boolean * RedSkyE911Manager
 Is Endpoint a Red Sky manager
required: false
default value[range]: false. More...
 
enum unsp__DTLSSupport DTLSSupport
 Indicates whether the endpoint supports DTLS. More...
 
enum unsp__SipUAForkingSupport * SipUAForkingSupport
 Indicates the SIP UA Forking Support mechanism used. More...
 
enum unsp__SrtpMode * SrtpMode
 Indicates the SRTP mode used. More...
 
xsd__string AssociatedSubscriberDn
 Associated Subscriber DN. More...
 

Detailed Description

Endpoint Create Data.

Member Data Documentation

enum unsp__AccountAuth EndpointCreateObject::AccountAuth

Account authentication.

This field is not modifiable after creation. AccountAuthBasedOnSub applies only to subscriber type endpoints.
required: true
default value[range]: AccountAuthUnused

xsd__string EndpointCreateObject::AddressOfRecord

The address used by SIP at registration of the endpoint.


required: false
default value[range]: NA [1..63]

xsd__string EndpointCreateObject::AltIpAddress

Optional secondary IP address of the endpoint.

The same uniqueness rule (as in IpAddress) applies in AltIpAddress.
required: false
default value[range]: NA [1..255]

xsd__int EndpointCreateObject::AltPort

Optional secondary IP address of the endpoint.


required: false
default value[range]: 0

enum unsp__Anat EndpointCreateObject::AnatSupport

Indicates whether the endpoint supports ANAT.


required: false
default value[range]: AnatUnassigned

xsd__string EndpointCreateObject::AssociatedEndpointName

Associated endpoint.


required: false

See Also
unsp__EndpointName
xsd__string EndpointCreateObject::AssociatedSubscriberDn

Associated Subscriber DN.


required: false
default value[range]: [1..15]

struct unsp__EndpointAttributes EndpointCreateObject::Attributes

A list of boolean attributes of the endpoint.


required: false

xsd__string EndpointCreateObject::CountryCode

Country Code of the endpoint.


required: false
default value[range]: NA [1..7]

xsd__string EndpointCreateObject::DefaultHomeDn

Default Home Dn.


required: false
default value[range]: [1..15]

enum unsp__DnsSrv EndpointCreateObject::DnsSrv

The type of the DnsSRV.


required: false
default value[range]: DnsSrvDisabled

enum unsp__DTLSSupport EndpointCreateObject::DTLSSupport

Indicates whether the endpoint supports DTLS.


required: false
default value[range]: DTLSUnassigned

xsd__string EndpointCreateObject::EndpointLocationCode

Endpoint Location Code.


required: false

See Also
unsp__EndpointLocationCode
xsd__string EndpointCreateObject::EndpointLocationDomain

Endpoint Location Domain.


required: false
default value[range]: NA

xsd__string EndpointCreateObject::EndpointLocationName

Endpoint location.


required: false

See Also
unsp__EndpointLocationName
enum unsp__EndpointNNIType EndpointCreateObject::EndpointNNIType

The type of NNI endpoint.


required: false
default value[range]: NNITypeOther

xsd__string EndpointCreateObject::EndpointProviderName

The name of the Endpoint Provider.

Note that in order to set the provider the NNIType should be set to PSTNGateway.
required: false

See Also
unsp__EndpointProviderName
enum unsp__EndpointType EndpointCreateObject::EndpointType

The type of the endpoint.


required: false
default value[range]: EtUnassigned

enum unsp__ICESupport EndpointCreateObject::ICESupport

Indicates whether the endpoint supports ICE .


required: false
default value[range]: ICEUnassigned

xsd__string EndpointCreateObject::IpAddress

Character string with the IP Address of the endpoint.

If the IP address and port are provided with non-default value, it must be unique in the set of addresses that include: {IpAddress, Port} combinations.
required: true
default value[range]: NA [1..255]

xsd__string EndpointCreateObject::IvtgNameDomain

Ivtg Name Domain.


required: false
default value[range]: NA [1..127]

enum unsp__KeysetUse EndpointCreateObject::KeysetUse

Indicates whether the subscriber endpoint is associated with a keyset device, either as a primary or phantom line.


required: false
default value[range]: KeysetNone

xsd__string EndpointCreateObject::LooseRoutingURI

Loose Routing URI.


required: false
default value[range]: NA [1..259]

xsd__string EndpointCreateObject::ManagementIpAddress

Separate address for the endpoint allowing its management using a different IP address for its configuration than the signaling address (IpAddress field).The ManagementIpAddress can be provisioned in IPv4, IPv6 or FQDN format.

If this field is not configured, the IpAddress of the endpoint is used as the management Ip address as well.
required: false
default value[range]: NA [1..255]

xsd__int EndpointCreateObject::MaxOriginatingSessionLimit

Max Originating Session Limit.


required: false
default value[range]: 0

xsd__int EndpointCreateObject::MaxTerminatingSessionLimit

Max Terminating Session Limit.


required: false
default value[range]: 0

xsd__string EndpointCreateObject::Name

Endpoint Name.


required: true

See Also
unsp__EndpointName
xsd__int EndpointCreateObject::OutgoingCallSupervisionTimer

Supervises the time between sending an INVITE request and receiving a provisional (non-100 Trying) or final response from the endpoint.


required: false
default value[range]: 0 [0, 500-64000]

xsd__int EndpointCreateObject::Port

Port is the signaling address of the endpoint.

If the IP address and port are provided with non-default value, it must be unique in the set of addresses that include: {IpAddress, Port} combinations for endpoint.
required: true
default value[range]: 0

xsd__string EndpointCreateObject::ProfileName

Endpoint Profile.


required: true
default value[range]: NA [1..15]

xsd__int EndpointCreateObject::ProxyBypassSupervisionTimer

Supervises the time between sending an INVITE request to a SIP proxy and receiving a provisional (incl.

100 Trying) or final response from the endpoint. This applies only to SIP proxies for which the Route Via Proxy and the Proxy Bypass Allowed endpoint attributes are set.
required: false
default value[range]: 0 [0, 500-32000]

xsd__string EndpointCreateObject::RasIpAddress

Branch Type.


required: false
default value[range]: NA [1..255]

xsd__int EndpointCreateObject::RasPort

Maximum Branch Users.


required: false
default value[range]: 0

xsd__boolean* EndpointCreateObject::RedSkyE911Manager

Is Endpoint a Red Sky manager
required: false
default value[range]: false.

xsd__short EndpointCreateObject::Registration

An integer that represents bitwise assignments of five attributes:

  • Operational state of the endpoint (highest 2 bits): UNNASIGNED, ACTIVE, BLOCKED_NEW, BLOCKED_ALL
  • Administrative state of the dynamic endpoint (next 2 bits): UNNASIGNED, ACTIVE, BLOCKED_NEW, BLOCKED_ALL
  • Authentication pre-granted: indicates whether authentication is pregranted for a dynamic endpoint (next 3 bits): UNNASIGNED, NEITHER_SIDE, A_SIDE, B_SIDE, BOTH_SIDES
  • RRQ state: indicates whether a dynamic endpoint is (URQ, RRQ) (next 2 bits): UNNASIGNED, UNREGISTERED, REGISTERED
  • RRQ type: indicates whether the endpoint is static or dynamic (lowest 2 bits): UNNASIGNED, STATIC, DYNAMIC_PORT (static IP), DYNAMIC.


required: false
default value[range]: 0

enum unsp__SrtpSupport EndpointCreateObject::SdesSrtpSupport

"Best-Effort SRTP with SDES" attribute to determine whether to include the SRTP media in the SDP offer or not.


required: false
default value[range]: SrtpEnabled

enum unsp__EpFailover EndpointCreateObject::ServerFailover

Indicates whether network server failover is enabled for this endpoint.


required: false
default value[range]: EpFailoverOff

xsd__int EndpointCreateObject::Sessions

Maximum number of sessions allowed for the endpoint.

Represents the number of messaging sessions, not the number of voice (audio) sessions.
required: false
default value[range]: 0

enum unsp__SipUAForkingSupport* EndpointCreateObject::SipUAForkingSupport

Indicates the SIP UA Forking Support mechanism used.


required: false
default value[range]: SipUAForkingUnassigned

enum unsp__SrtpMode* EndpointCreateObject::SrtpMode

Indicates the SRTP mode used.


required: false
default value[range]: SrtpModeAuto

enum unsp__SrtpSupport EndpointCreateObject::SrtpSupport

"Best-Effort SRTP" attribute to determine whether to include the SRTP media in the SDP offer or not.


required: false
default value[range]: SrtpUnassigned

xsd__double EndpointCreateObject::TimeToLive

Expiration time for the endpoint (if dynamic).


required: false
default value[range]: 0

enum unsp__TransportType EndpointCreateObject::Transport

The transport protocol for a SIP endpoint.


required: false
default value[range]: TtTcp


The documentation for this class was generated from the following file: