15 Transport Connections
15.1 Get-anynodeNodeTransportConnections
Returns detailed information about the selected transport connection.
Required Permissions
-
API
-
Configuration Mode Read Access
Request parameters
-
Address
mandatory if Initialize-anynodeAddress has not been used. Location of the frontend service to be reached.
Type: String
-
Port
mandatory if Initialize-anynodePort has not been used. Port of the frontend service to be reached.
Type: Integer
-
APIVersion = 0
This parameter states which version of the request should be used.
Type: Integer
-
string: Id
The identifier or display name of the transport connection.
Return Value Structure
The response body is structured as StandardTransportConnection JSON object. A description for its fields is at section 29.35.1. For the JSON schema refer to section 29.35.2.
15.2 Add-anynodeStandardTransportConnection
Creates a new standard transport connection.
Required Permissions
-
API
-
Configuration Mode Read/Write Access
Request parameters
-
Address
mandatory if Initialize-anynodeAddress has not been used. Location of the frontend service to be reached.
Type: String
-
Port
mandatory if Initialize-anynodePort has not been used. Port of the frontend service to be reached.
Type: Integer
-
APIVersion = 0
This parameter states which version of the request should be used.
Type: Integer
-
string: DisplayName
The display name of the new transport connection.
-
AssertedAddress
Define your own Asserted-URI. This URI can serve as the basis for special SIP headers (e.g. PAI header) in the case of outgoing calls.
Type: AssertedUri2
-
AuthenticationEnabled
Whether authentication should be enabled or not. This value only applies if a registration is given.
Type: Boolean
-
ConditionId
Optional operational condition. This transport connection is only operational as long as this condition is true.
Type: String
-
AuthenticationPolicy
Credentials to be used for authentication. This value only applies if "authenticationEnabled" is set to true.
Type: SipCredentials section 29.28
-
Proxy
The proxy to be used.
Type: TransportConnectionProxy section 29.37
-
Registration
The registration to be used.
Type: TransportConnectionRegistration
Return Value Structure
The response body is structured as StandardTransportConnection JSON object. A description for its fields is at section 29.35.1. For the JSON schema refer to section 29.35.2.
15.3 Add-anynodePlainTransportConnection
Creates a new plain transport connection.
Required Permissions
-
API
-
Configuration Mode Read/Write Access
Request parameters
-
Address
mandatory if Initialize-anynodeAddress has not been used. Location of the frontend service to be reached.
Type: String
-
Port
mandatory if Initialize-anynodePort has not been used. Port of the frontend service to be reached.
Type: Integer
-
APIVersion = 0
This parameter states which version of the request should be used.
Type: Integer
-
string: DisplayName
The display name of the new transport connection.
-
Uri
Define your own URI. This URI can serve as the basis for special SIP headers (e.g. From header) in the case of outgoing calls.
Type: SipbnAddress section 29.39
-
AssertedUri
Define your own Asserted-URI. This URI can serve as the basis for special SIP headers (e.g. PAI header) in the case of outgoing calls.
Type: SipbnAddress section 29.39
-
Properties
General properties
Type: Array of PlainTransportConnectionProperties
Possible values:
-
FLOW
Establish a fixed transport flow
-
FLOW_PRIVATE
The transport flow is private and is only available for this route. (Only works if "FLOW" is selected)
-
OPTIONS
Send OPTIONS packets to check whether the transport connection is operational.
-
OPTIONS_LOAD
Send OPTIONS packets and if possible (which means that the remote station is an anynode) then use the OPTIONS packets to determine the load of the remote station.
-
OPTIONS_DOWN_ONLY
Send OPTIONS packets only if the remote station is not operational.
-
OPTIONS_FLOW_ADDRESS
Send OPTIONS packets according to 1TR119
-
LYNC_MASTER_DOMAIN_NAME
Check Skype for Business master domai
-
LYNC_INCOMING
Check incoming dialog offers in a Skype for Business specific way
-
-
InitialRouteSet
The initial route set of this transport connection.
Type: Array of SipsnRoute section 29.40
-
SipTransport
The SIP transport object id for this transport connection.
Type: String
-
OptionsErrorFlags
When an OPTIONS error occurs...
Type: Array of PlainTransportConnectionOptionsErrorFlag
Possible values:
-
DOWN
Change the state to non-operational
-
TERMINATE_INCOMING
Terminate incoming traffic
-
TERMINATE_OUTGOING
Terminate outgoing traffic
-
-
TimeoutErrorFlags
In case of a timeout...
Type: Array of PlainTransportConnectionErrorFlag
Possible values:
-
DOWN
Change the state to non-operational.
-
FAILOVER
Perform failover to another transport connection, if possible.
-
TERMINATE_INCOMING
Terminate incoming traffic.
-
TERMINATE_OUTGOING
Terminate outgoing traffic.
-
-
TransportErrorFlags
In case of a transport error...
Type: Array of PlainTransportConnectionErrorFlag
Possible values:
-
DOWN
Change the state to non-operational.
-
FAILOVER
Perform failover to another transport connection, if possible.
-
TERMINATE_INCOMING
Terminate incoming traffic.
-
TERMINATE_OUTGOING
Terminate outgoing traffic.
-
-
StatusCodesErrorFlags
Transport connection behavior when receiving status codes.
Type: Array of TransportConnectionStatusCodeErrorFlags section 29.41
-
Authentication
If the Plain Transport Connection to be created requires separate authentication data then this can be configured here.
Type: TransportConnectionAuthentication section 29.42
Return Value Structure
The response body is structured as PlainTransportConnection JSON object. A description for its fields is at section 29.43.1. For the JSON schema refer to section 29.43.2.
15.4 Add-anynodeLoadBalancingTransportConnection
Create a new load balancing transport connection.
Required Permissions
-
API
-
Configuration Mode Read/Write Access
Request parameters
-
Address
mandatory if Initialize-anynodeAddress has not been used. Location of the frontend service to be reached.
Type: String
-
Port
mandatory if Initialize-anynodePort has not been used. Port of the frontend service to be reached.
Type: Integer
-
APIVersion = 0
This parameter states which version of the request should be used.
Type: Integer
-
string: DisplayName
The display name of the new transport connection.
-
Properties
Determines how the load will be balanced.
Type: Array of LoadBalancerProperties
Possible values:
-
FAILOVER
Activate failover operation mode.
-
SEQUENTIAL_FAILOVER
Select failover targets sequentially. Only works in combination with "FAILOVER".
-
REDIRECT_INVITE
Redirect INVITE requests.
-
REDIRECT_NOTIFY
Redirect NOTIFY requests.
-
REDIRECT_OPTIONS
Redirect OPTIONS requests.
-
REDIRECT_REFER
Redirect REFER requests.
-
REDIRECT_REGISTER
Redirect REGISTER requests.
-
-
Targets
The load balancer target connections.
Type: Array of SipLoadBalancerTarget section 29.44
Return Value Structure
The response body is structured as SipLoadBalancingTransportConnection JSON object. A description for its fields is at section 29.45.1. For the JSON schema refer to section 29.45.2.
15.5 Add-anynodeSipRegistrationAsTransportConnection
Creates a new SIP registration.
Required Permissions
-
API
-
Configuration Mode Read/Write Access
Request parameters
-
Address
mandatory if Initialize-anynodeAddress has not been used. Location of the frontend service to be reached.
Type: String
-
Port
mandatory if Initialize-anynodePort has not been used. Port of the frontend service to be reached.
Type: Integer
-
APIVersion = 0
This parameter states which version of the request should be used.
Type: Integer
-
string: DisplayName
The display name of the new SIP registration.
-
Registrar
The IRI of the registrar, to which you want to register.
Type: String
-
Authentication
The IRI of the registrar, to which you want to register.
Type: TransportConnectionAuthentication section 29.42
-
AorUri
The address-of-record specifies who is to be registered.
Type: SipbnAddress section 29.39
-
AssertedUri
Define your own Asserted-URI. This URI can serve as the basis for special SIP headers (e.g. PAI header) in the case of outgoing calls.
Type: SipbnAddress section 29.39
-
SipUserAgentStackId
The id of the SIP user agent which should be used for the registration.
Type: String
-
InnerTransportConnectionId
If desired, the registration can be established via a transport connection.
Type: String
Return Value Structure
The response body is structured as SipRegistrationAsTransportConnection JSON object. A description for its fields is at section 29.46.1. For the JSON schema refer to section 29.46.2.
15.6 Add-anynodeSrvLoadBalancer
Creates a new SRV Load Balancer.
Required Permissions
-
API
-
Configuration Mode Read/Write Access
Request parameters
-
Address
mandatory if Initialize-anynodeAddress has not been used. Location of the frontend service to be reached.
Type: String
-
Port
mandatory if Initialize-anynodePort has not been used. Port of the frontend service to be reached.
Type: Integer
-
APIVersion = 0
This parameter states which version of the request should be used.
Type: Integer
-
string: DisplayName
The display name of the new transport connection.
-
SipTransportId
The SIP transport object id for this transport connection.
Type: String
-
Domain
Type: String
-
TransportProtocol
The transport protocol for the target transport connections.
Type: SrvLoadBalancerTransportProtocol
Possible values:
-
UDP
-
TCP
-
TLS
-
SCTP
-
SCTP_TLS
-
-
TargetTemplateOptions
Template options for the target transport connections.
Type: SrvLoadBalancerTargetTemplate section 29.47
Return Value Structure
The response body is structured as SrvLoadBalancer JSON object. A description for its fields is at section 29.48.1. For the JSON schema refer to section 29.48.2.
15.7 Remove-anynodeTransportConnection
Removes a transport connection from the current configuration.
Required Permissions
-
API
-
Configuration Mode Read/Write Access
Request parameters
-
Address
mandatory if Initialize-anynodeAddress has not been used. Location of the frontend service to be reached.
Type: String
-
Port
mandatory if Initialize-anynodePort has not been used. Port of the frontend service to be reached.
Type: Integer
-
APIVersion = 0
This parameter states which version of the request should be used.
Type: Integer
-
string: TransportConnection
The id of the transport connection.
-
string: Force
If set to true the transport connection and it's referenced objects will be removed, even if it is referenced by other objects.
15.8 Get-anynodeTransportConnectionAuthentication
Returns the authentication configuration of the requested transport connection.
Required Permissions
-
API
-
Configuration Mode Read Access
Request parameters
-
Address
mandatory if Initialize-anynodeAddress has not been used. Location of the frontend service to be reached.
Type: String
-
Port
mandatory if Initialize-anynodePort has not been used. Port of the frontend service to be reached.
Type: Integer
-
APIVersion = 0
This parameter states which version of the request should be used.
Type: Integer
-
string: TransportConnection
The id of the Transport Connection..
Return Value Structure
The response body is structured as SipCredentials JSON object. A description for its fields is at section 29.28.1. For the JSON schema refer to section 29.28.2.
15.9 Set-anynodeTransportConnectionAuthentication
Modifies the username and password of the selected transport connection.
Required Permissions
-
API
-
Configuration Mode Read/Write Access
Request parameters
-
Address
mandatory if Initialize-anynodeAddress has not been used. Location of the frontend service to be reached.
Type: String
-
Port
mandatory if Initialize-anynodePort has not been used. Port of the frontend service to be reached.
Type: Integer
-
APIVersion = 0
This parameter states which version of the request should be used.
Type: Integer
-
string: TransportConnection
The id of the transport connection.
-
Password
The password. Only works in combination with "username".
Type: String
-
Username
The username. Only works in combination with "password".
Type: String
Return Value Structure
The response body is structured as SipCredentials JSON object. A description for its fields is at section 29.28.1. For the JSON schema refer to section 29.28.2.
15.10 Get-anynodeTransportConnectionAssertedURI
Returns the asserted URI of the selected transport connection.
Required Permissions
-
API
-
Configuration Mode Read Access
Request parameters
-
Address
mandatory if Initialize-anynodeAddress has not been used. Location of the frontend service to be reached.
Type: String
-
Port
mandatory if Initialize-anynodePort has not been used. Port of the frontend service to be reached.
Type: Integer
-
APIVersion = 0
This parameter states which version of the request should be used.
Type: Integer
-
string: TransportConnection
The id of the transport connection.
Return Value Structure
The response body is structured as AssertedUri JSON object. A description for its fields is at section 29.49.1. For the JSON schema refer to section 29.49.2.
15.11 Set-anynodeTransportConnectionAssertedURI
Modifies the asserted URI of the selected transport connection.
Required Permissions
-
API
-
Configuration Mode Read/Write Access
Request parameters
-
Address
mandatory if Initialize-anynodeAddress has not been used. Location of the frontend service to be reached.
Type: String
-
Port
mandatory if Initialize-anynodePort has not been used. Port of the frontend service to be reached.
Type: Integer
-
APIVersion = 0
This parameter states which version of the request should be used.
Type: Integer
-
string: TransportConnection
The id of the transport connection
-
AssertedDisplayName
The desired display name.
Type: String
-
URI
The desired URI.
Type: String
Return Value Structure
The response body is structured as AssertedUri JSON object. A description for its fields is at section 29.49.1. For the JSON schema refer to section 29.49.2.
15.12 Get-anynodeTransportConnectionAddressOfRecord
Returns the Address of Record for the selected transport connection
Required Permissions
-
API
-
Configuration Mode Read Access
Request parameters
-
Address
mandatory if Initialize-anynodeAddress has not been used. Location of the frontend service to be reached.
Type: String
-
Port
mandatory if Initialize-anynodePort has not been used. Port of the frontend service to be reached.
Type: Integer
-
APIVersion = 0
This parameter states which version of the request should be used.
Type: Integer
-
string: TransportConnection
The id of the transport connection.
Return Value Structure
The response body is structured as AssertedUri JSON object. A description for its fields is at section 29.49.1. For the JSON schema refer to section 29.49.2.
15.13 Set-anynodeTransportConnectionAddressOfRecord
Modifies the transport connection of the requested node.
Required Permissions
-
API
-
Configuration Mode Read/Write Access
Request parameters
-
Address
mandatory if Initialize-anynodeAddress has not been used. Location of the frontend service to be reached.
Type: String
-
Port
mandatory if Initialize-anynodePort has not been used. Port of the frontend service to be reached.
Type: Integer
-
APIVersion = 0
This parameter states which version of the request should be used.
Type: Integer
-
string: TransportConnection
The id of the transport connection.
-
AssertedDisplayName
The desired display name.
Type: String
-
URI
The desired URI.
Type: String
Return Value Structure
The response body is structured as AssertedUri JSON object. A description for its fields is at section 29.49.1. For the JSON schema refer to section 29.49.2.