25 JSON Objects
25.1 SoftwareVersion
25.1.1 SoftwareVersion Field Description
-
VersionMajor
Type: Integer
-
VersionMinor
Type: Integer
-
VersionRelease
Type: Integer
25.1.2 SoftwareVersion Powershell class
25.2 TracingOptionsJson
25.2.1 TracingOptionsJson Field Description
-
Selection
Selects how tracing records will be stored.
Type: TracingSelection
Possible values:
-
FILE
Single file, no size limit.
-
SPLIT
Rolling files of limited size.
-
-
TraceActive
Type: Boolean
-
Options
Type: TracingFileOptions
25.2.2 TracingOptionsJson Powershell class
25.3 TracingFileOptions
25.3.1 TracingFileOptions Field Description
-
Count
Determines how many trace files will be kept. Only for selection=SPLIT
Type: Integer
-
Flags
Possible values: TRIO_FLAG_MARKED (only trace sessions that are marked for tracing) and TRIO_FLAG_IGNORE_HIGH_VOLUME_MESSAGES (removes high-volume trace messages) seperated by '|'
Type: String
-
Size
Determines the maximum size for trace files. Only for selection=SPLIT
Type: Integer
25.3.2 TracingFileOptions Powershell class
25.4 DialStringRewrite
The available fields for DialStringRewrite objects depend on the selected rewriteType. The fields for each type are:
-
prefixAndSuffix
-
prefix
-
suffix
-
deleteLeadingCharacters
-
deleteTrailingCharacters
-
addPrefix
-
addSuffix
-
-
wildcardPattern
-
wildcardPattern
-
deleteLeadingCharacters
-
deleteTrailingCharacters
-
addPrefix
-
addSuffix
-
-
matchAndModify
-
matchType
-
rewriteSegments
-
-
matchAndBranch
-
matchType
-
rewriteSegments
-
branchRewrites
-
branchElseRewrites
-
-
available for all types:
-
skipFurtherRules
-
applyToAllDialStrings
-
applyToSourceDialString
-
applyToDestinationDialString
-
applyTo
-
comment
-
-
available for all types excluding cutExtensionNumber:
-
matchTags
-
tagRewrite
-
case
-
clearDisplayName
-
displayName
-
25.4.1 DialStringRewrite Field Description
-
RewriteType
Type of dial string rewrite
Type: RewriteTypeJson
Possible values:
-
prefixAndSuffix
-
wildcardPattern
-
cutExtensionNumber
-
matchAndModify
-
matchAndBranch
-
-
MatchType
If the selected rewriteType allows to select the matchType additional fields are available for the DialStringRewrite object. The available fields for each matchType are:
-
prefixSuffix
-
prefix
-
suffix
-
deleteLeadingCharacters
-
deleteTrailingCharacters
-
addPrefix
-
addSuffix
-
-
dialStringList
-
matchDialStringList
-
-
structuralPattern
-
structuralPattern
-
-
wildcardPattern
-
wildcardPattern
-
deleteLeadingCharacters
-
deleteTrailingCharacters
-
addPrefix
-
addSuffix
-
-
extensionRange
-
matchExtensionRange
-
Type: TelMatchTypeJson
Possible values:
-
anything
-
never
-
list
-
prefixSuffix
-
dialStringList
-
structuralPattern
-
wildcardPattern
-
extensionRange
-
-
Prefix
The rewrite rule will only match dial strings that begin with the prefix you specify here.
Type: String
-
Suffix
The rewrite rule will only match dial strings that end with the suffix you specify here.
Type: String
-
WildcardPattern
Matches any dial string from a list of eligible dial strings.
Type: String
-
MatchDirectory
Matches any dial string from a list of eligible dial strings.
Type: Array of String
-
MatchExtensionRange
Type: TelMatchExtensionRange section 25.6
-
StructuralPattern
The rewrite rule will only match dial strings according to the pattern you specify.
Type: Array of MatchPatternSegment section 25.7
-
DeleteLeadingCharacters
This parameter controls the number of characters that anynode will remove from the beginning of the dial string.
Type: Integer
-
DeleteTrailingCharacters
This parameter controls the number of characters that anynode will remove from the end of the dial string.
Type: Integer
-
AddPrefix
This parameter controls which prefix anynode will append to the dial string.
Type: String
-
AddSuffix
This parameter controls which suffix anynode will append to the dial string.
Type: String
-
DisplayName
The display name of the dial string can be modified with this value.
Type: String
-
RewriteSegments
This setting determines how the rewritten dial string is structured.
Type: Array of TelRewriteSegment section 25.8
-
BranchRewrites
Rewrites that are processed if the dial string matches the condition.
Type: Array of DialStringRewrite section 25.4
-
BranchElseRewrites
Rewrites that are processed if the dial string does not match the condition.
Type: Array of DialStringRewrite section 25.4
-
MatchTags
Use this option to control which tag (or set of tags) needs to be present for this rewrite rule to apply.
Type: TagMatch section 25.9
-
TagRewrite
Use this option to control which changes to the set of tags carried along with the dial string anynode performs when this rewrite rule is aplied.
Type: TagRewrite section 25.10
-
ApplyTo
You can choose the dial strings to which the dial string rewrite rules should be applied.
Type: Array of TelRewriteAddressContextsJson
Possible values:
-
unspecified
-
sessionSource
-
sessionAsserted
-
sessionDestination
-
sessionConnected
-
sessionElin
-
sessionRedirectHistory
-
sessionTransferrer
-
reasonRedirection
-
reasonSelected
-
mwiSource
-
mwiDestination
-
-
ApplyToAllDialStrings
Apply the rewrite rules to all dial strings.
Type: Boolean
-
ApplyToDestinationDialString
Apply the rewrite rules to the destination dial string.
Type: Boolean
-
ApplyToSourceDialString
Apply the rewrite rules to the source dial string.
Type: Boolean
-
SkipFurtherRules
If the condition matches the dial string, all further rewrite rules will be skipped.
Type: Boolean
-
SkipRulesBelow
If the condition matches the dial string, skip succeeding rewrite rules.
Type: Boolean
-
ClearDisplayName
If the display name of the dial string should be removed.
Type: Boolean
-
Case
Any comparisions on dial strings are case-sensitive. Use this parameter to transform the dial strings in the respective case.
Type: RewriteCaseJson
Possible values:
-
lowercase
-
uppercase
-
casefold
-
-
Comment
A display name for this dial string rewrite rule to identify it later on.
Type: String
-
Index
Type: Integer
25.4.2 DialStringRewrite Powershell class
25.5 DialStringRewriting
25.5.1 DialStringRewriting Field Description
-
DisplayName
Set up a name that helps you identify this object.
Type: String
-
Id
Type: String
-
Rules
Type: Array of DialStringRewrite section 25.4
25.5.2 DialStringRewriting Powershell class
25.6 TelMatchExtensionRange
25.6.1 TelMatchExtensionRange Field Description
-
FirstExtension
Type: String
-
LastExtension
Type: String
-
Trunk
Type: String
-
ZeroExtend
Type: Boolean
25.6.2 TelMatchExtensionRange Powershell class
25.7 MatchPatternSegment
25.7.1 MatchPatternSegment Field Description
-
Comment
Type: String
-
Digits
Must only contain numeric digits (0-9)
Type: String
-
GreedyMatch
Type: Boolean
-
MaxCount
Type: Integer
-
MinCount
Type: Integer
-
Text
Type: String
-
Type
Type: TelMatchPatternSegmentType
Possible values:
-
anything
-
discard
-
digits
-
text
-
25.7.2 MatchPatternSegment Powershell class
25.8 TelRewriteSegment
25.8.1 TelRewriteSegment Field Description
-
Capture
Type: Integer
-
DelLeading
Type: Integer
-
DelTrailing
Type: Integer
-
KeepLeading
Type: Integer
-
KeepTrailing
Type: Integer
-
Prefix
Type: String
-
Suffix
Type: String
25.8.2 TelRewriteSegment Powershell class
25.9 TagMatch
25.9.1 TagMatch Field Description
-
TagSet
Tags may only contain alphabetic and numeric characters and have to start with a lowercase character
Type: Array of String
-
Type
The operator applied to the matched tags to determine the result of the TagMatch.
Type: TagMatchTye
Possible values:
-
or
-
xor
-
and
-
not
-
25.9.2 TagMatch Powershell class
25.10 TagRewrite
25.10.1 TagRewrite Field Description
-
ClearTags
Incicates if the existing tags should be removed.
Type: Boolean
-
Operations
Type: Array of TagRewriteOperation section 25.55
25.10.2 TagRewrite Powershell class
25.11 AnynodeConfigState
25.11.1 AnynodeConfigState Field Description
-
Committed
Indicates if all changes to the configuration are committed.
Type: Boolean
25.11.2 AnynodeConfigState Powershell class
25.12 License
25.12.1 License Field Description
-
Status
Type: LicenseStatus
Possible values:
-
CONFIGURED
License is configured but is not active yet.
-
ACTIVE
License is active.
-
SIGNATURE
Signature is invalid.
-
PRODUCT
License belongs to a different product.
-
APPLICATION
License belongs to a different application
-
SYSTEM_ID
System ID does not exist
-
VALID_FROM
License is not valid yet.
-
VALID_UNTIL
License is expired.
-
SUS_UNTIL
Software Update Service (SUS) is expired.
-
INVALIDATED
License is invalidated by another license.
-
MUTEX
This license or another license which is invalidated by this license is bound to another process.
-
-
Identifier
The identifier for this license.
Type: String
-
Name
Type: String
-
ValidFrom
The time this license is valid from onwards.
Type: Date
-
ValidUntil
The time when this license expires.
Type: Date
-
SoftwareUpdateServiceUntil
The time this license will be renewed.
Type: Date
-
RequiredSystemIds
A list of system IDs that were given on license activation this license is bound to.
Type: String
-
InvalidatedLicences
The amount of invalidated licenses.
Type: String
-
Products
The products this license is meant for.
Type: String
-
Facilities
The facilities this license is active for
Type: Array of LicenseFacility section 25.56
-
Constaints
The constraints for this license.
Type: String
25.12.2 License Powershell class
25.13 MaintenanceMode
25.13.1 MaintenanceMode Field Description
-
ModeActive
Indicates if the maintenance mode should be activated or deactivated.
Type: Boolean
25.13.2 MaintenanceMode Powershell class
25.14 LdapUserJson
25.14.1 LdapUserJson Field Description
-
Name
Type: String
-
LdapAuthorityId
Type: String
25.14.2 LdapUserJson Powershell class
25.15 CustomUserOptions
25.15.1 CustomUserOptions Field Description
-
BlockedUntil
Type: Date
-
DisplayName
Type: String
-
EmailAddress
Type: String
-
Enabled
Type: Boolean
-
FailedLogins
Type: Integer
-
Id
Type: String
-
LastFailedLogin
Type: Date
-
LastLogin
Type: Date
-
LdapUsers
Type: Array of LdapUserJson
-
Local
Type: LocalUser section 25.58
-
LocalUserName
Type: String
-
LocalV0
Type: LocalV0User section 25.59
-
RoleBuiltIns
Type: String
-
Roles
Type: Array of String
25.15.2 CustomUserOptions Powershell class
25.16 Role
25.16.1 Role Field Description
-
DisplayName
The displayname of the role..
Type: String
-
Id
A unique identifier for the role.
Type: String
-
Permissions
The permission that users with this role have.
Type: Permissions
25.16.2 Role Powershell class
25.17 Permissions
25.17.1 Permissions Powershell class
25.18 MediaRecording
25.18.1 MediaRecording Field Description
-
MediaRecordingActive
Type: Boolean
25.18.2 MediaRecording Powershell class
25.19 MsTeamsSbaOptions
25.19.1 MsTeamsSbaOptions Field Description
-
Fingerprint
The trusted certificate fingerprint source. This needs to be the fingerprint of the Teams node, that is using the SBA service.
Type: MsTeamsSbaFingerprint
-
Identity
The identity / FQDN of the SBA
Type: String
-
TenantId
Directory (tenant) ID
Type: String
-
Application
Application (client) ID
Type: String
-
Secret
Application (client) secrect
Type: String
-
Log
Settings for the SBA log.
Type: MsTeamsSbaLog section 25.21
-
Certificate
The certificate for the SBA service
Type: CryCertificate section 25.22
-
IpAddress
The IP address for the SBA service. It is recommended to choose a local IP address.
Type: String
-
PrivateKey
The private key for the SBA service
Type: CryPrivateKey section 25.23
25.19.2 MsTeamsSbaOptions Powershell class
25.20 MsTeamsSbaFingerprint
25.20.1 MsTeamsSbaFingerprint Field Description
-
Source
Determines the source of the fingerprint.
Type: FingerprintSource
Possible values:
-
NONE
-
CUSTOM
-
MS_TEAMS_NODE
-
-
Value
The fingerprint for "source"="CUSTOM"
Type: String
-
MsTeamsNodeId
Only for "source"="MS_TEAMS_NODE". The id of the Teams node, that uses the certificate. The fingerprint will be extracted automatically.
Type: String
25.20.2 MsTeamsSbaFingerprint Powershell class
25.21 MsTeamsSbaLog
25.21.1 MsTeamsSbaLog Field Description
-
Directory
The directory where log files should be stored.
Type: String
-
Level
The log level
Type: MsTeamsSbaLogLevel
Possible values:
-
TRACE
-
DEBUG
-
INFO
-
WARN
-
ERROR
-
FATAL
-
-
MaxArchiveFiles
The maximum amount of log files that will be stored.
Type: Integer
25.21.2 MsTeamsSbaLog Powershell class
25.22 CryCertificate
25.22.1 CryCertificate Field Description
-
Pem
The PEM of the certificate.
Type: String
25.22.2 CryCertificate Powershell class
25.23 CryPrivateKey
25.23.1 CryPrivateKey Field Description
-
Pem
The PEM of the private key.
Type: String
25.23.2 CryPrivateKey Powershell class
25.24 MsTeamsSbaStatus
25.24.1 MsTeamsSbaStatus Field Description
-
State
Type: String
-
Status
Type: String
25.24.2 MsTeamsSbaStatus Powershell class
25.25 PortRange
25.25.1 PortRange Field Description
-
FirstPort
First port of the port range
Type: Integer
-
LastPort
Last port of the port range
Type: Integer
25.25.2 PortRange Powershell class
25.26 RemoteSipDomain
25.26.1 RemoteSipDomain Field Description
-
Host
Type: String
-
Iri
Type: String
-
Port
Type: Integer
-
Transport
Type: RemoteSipDomainTransport
Possible values:
-
udp
-
tcp
-
tls
-
sctp
-
tls-sctp
-
25.26.2 RemoteSipDomain Powershell class
25.27 SipCredentials
25.27.1 SipCredentials Field Description
-
AuthenticationProfileId
The identifier of a authentication profile. This can be set to use a existing authentication profile instead of creating a new one.
Type: String
-
DirectoryName
The identifier of the directory. This value only works in combination with "userIdentifier".
Type: String
-
Password
This value only works in combination with "username".
Type: String
-
UserIdentifier
The identifier of the user in a directory. This value only works in combination with "directoryName".
Type: String
-
Username
This value only works in combination with "password".
Type: String
25.27.2 SipCredentials Powershell class
25.28 TelMatch
25.28.1 TelMatch Field Description
-
Directory
Mandatory for "type=DIRECTORY".
Type: Array of String
-
ExtensionRange
Mandatory for "type=EXTENSION_RANGE".
Type: TelMatchExtensionRange section 25.6
-
List
Mandatory for "type=LIST".
Type: TelMatchList section 25.64
-
Plain
Mandatory for "type=PLAIN".
Type: TelMatchPlain
-
Type
Type: TelMatchType
Possible values:
-
anything
-
never
-
list
-
prefixSuffix
-
dialStringList
-
structuralPattern
-
wildcardPattern
-
extensionRange
-
-
WildcardPattern
Mandatory for "type=WILDCARD".
Type: String
25.28.2 TelMatch Powershell class
25.29 NetworkPeerWhitelistEntry
25.29.1 NetworkPeerWhitelistEntry Field Description
-
DnsLookup
Additional protocol prefixes.
Type: Array of String
-
Host
The hostname or ip address.
Type: String
-
IpVersion
If you specify an IP version, then only IP addresses with this version will be accepted. (This makes especially sense when a host name is set.)
Type: IpVersion
Possible values:
-
[Any Address Version]
-
IN_ADDRESS_VERSION_4
-
IN_ADDRESS_VERSION_6
-
-
SubnetPrefixLength
Type: Integer
25.29.2 NetworkPeerWhitelistEntry Powershell class
25.30 SipUserCredentials
25.30.1 SipUserCredentials Field Description
-
Username
The SIP username
Type: String
-
Password
The SIP password
Type: String
25.30.2 SipUserCredentials Powershell class
25.31 TelstraNthTrunkOptions
25.31.1 TelstraNthTrunkOptions Field Description
-
SipProxyIri
The uri of the SIP proxy server.
Type: String
-
RegistrarIri
The uri of the SIP registrar.
Type: String
-
AorUserName
The user part of the Address-Of-Record. The host part of the Address-Of-Record depends on the registrar uri.
Type: String
-
AuthenticationEnabled
Activates client authentication.
Type: Boolean
-
Credentials
These authentication settings determine how the node authenticates to a remote station.
Type: SipUserCredentials section 25.30
25.31.2 TelstraNthTrunkOptions Powershell class
25.32 SipNodeTransportConnection
25.32.1 SipNodeTransportConnection Field Description
-
MatchingCondition
The matching condition is used to filter for which calls the transport connection will be used.
Type: TelMatch section 25.28
-
TransportConnectionId
The id of the transport connection
Type: String
25.32.2 SipNodeTransportConnection Powershell class
25.33 StandardTransportConnection
25.33.1 StandardTransportConnection Field Description
-
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
-
Credentials
Credentials to be used for authentication. This value only applies if "authenticationEnabled" is set to true.
Type: SipCredentials section 25.27
-
Proxy
The proxy to be used.
Type: TransportConnectionProxy section 25.35
-
Registration
The registration to be used.
Type: TransportConnectionRegistration
25.33.2 StandardTransportConnection Powershell class
25.34 AssertedUri2
25.34.1 AssertedUri2 Field Description
-
DisplayName
The desired display name.
Type: String
-
Iri
The desired URI.
Type: String
25.34.2 AssertedUri2 Powershell class
25.35 TransportConnectionProxy
25.35.1 TransportConnectionProxy Field Description
-
Flow
Whether a transport flow should be established. A flow is a kind of fixed virtual channel through which the entire SIP signaling takes place.
Type: Boolean
-
Iri
Optional Proxy-URI. Otherwise, the remote SIP domain is used.
Type: String
-
OmitInitialRouteSet
Omit the initial route set.
Type: Boolean
-
Options
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.
Type: Boolean
-
OptionsNextHop
OPTIONS packets must be answered by the next hop.
Type: Boolean
25.35.2 TransportConnectionProxy Powershell class
25.36 TransportConnectionRegistration
25.36.1 TransportConnectionRegistration Field Description
-
AddressOfRecord
Address-Of-Record (to be registered URI)
Type: String
-
SipDomain
SIP Domain (Registrar)
Type: String
25.36.2 TransportConnectionRegistration Powershell class
25.37 SipbnAddress
25.37.1 SipbnAddress Field Description
-
Iri
The IRI for this address.
Type: String
-
DisplayName
The display name for this address.
Type: String
25.37.2 SipbnAddress Powershell class
25.38 SipsnRoute
25.38.1 SipsnRoute Field Description
-
Iri
The URI of this route.
Type: String
25.38.2 SipsnRoute Powershell class
25.39 TransportConnectionStatusCodeErrorFlags
25.39.1 TransportConnectionStatusCodeErrorFlags Field Description
-
StatusCode
These status codes can be listed individually or as a range (e.g.: 486, 501-503).
Type: String
-
ErrorHandling
The flags determine the behavior if the status codes occur.
Type: Array of TransportConnectionStatusCodeErrorFlag section 25.69
25.39.2 TransportConnectionStatusCodeErrorFlags Powershell class
25.40 TransportConnectionAuthentication
25.40.1 TransportConnectionAuthentication Field Description
-
AuthenticationProfileId
The identifier of a authentication profile. This can be set to use a existing authentication profile instead of creating a new one.
Type: String
-
Password
This value only works in combination with "username".
Type: String
-
Username
This value only works in combination with "password".
Type: String
25.40.2 TransportConnectionAuthentication Powershell class
25.41 PlainTransportConnection
25.41.1 PlainTransportConnection Field Description
-
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 25.37
-
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 25.37
-
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 25.38
-
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 25.39
-
Authentication
If the Plain Transport Connection to be created requires separate authentication data then this can be configured here.
Type: TransportConnectionAuthentication section 25.40
25.41.2 PlainTransportConnection Powershell class
25.42 SipLoadBalancerTarget
25.42.1 SipLoadBalancerTarget Field Description
-
RouteId
The id of the target transport connection.
Type: String
-
TargetIriFlags
Specifies how certain parts of the SIP request IRI should be treated on redirection.
Type: Array of SipLoadBalancerTargetIriFlag
Possible values:
-
USER_INFO
Transfer user info part of original request IRI to new target IRI (e.g. alice@).
-
USER_PARAMETER
Transfer user parameter of original request IRI to new target IRI (e.g. "user=phone"). Only Works together with "USER_INFO".
-
-
DefaultLoad
The default load that is assumed if no load can determined.
Type: SipLoadBalancerDefaultLoad section 25.70
25.42.2 SipLoadBalancerTarget Powershell class
25.43 SipLoadBalancingTransportConnection
25.43.1 SipLoadBalancingTransportConnection Field Description
-
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 25.42
25.43.2 SipLoadBalancingTransportConnection Powershell class
25.44 SipRegistrationAsTransportConnection
25.44.1 SipRegistrationAsTransportConnection Field Description
-
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 25.40
-
AorUri
The address-of-record specifies who is to be registered.
Type: SipbnAddress section 25.37
-
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 25.37
-
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
25.44.2 SipRegistrationAsTransportConnection Powershell class
25.45 SrvLoadBalancerTargetTemplate
25.45.1 SrvLoadBalancerTargetTemplate Field Description
-
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
-
-
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 25.39
25.45.2 SrvLoadBalancerTargetTemplate Powershell class
25.46 SrvLoadBalancer
25.46.1 SrvLoadBalancer Field Description
-
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 25.45
25.46.2 SrvLoadBalancer Powershell class
25.47 AssertedUri
25.47.1 AssertedUri Field Description
-
DisplayName
The desired display name.
Type: String
-
Iri
The desired URI.
Type: String
25.47.2 AssertedUri Powershell class
25.48 Resources
25.48.1 Resources Field Description
-
Cpu
Type: Integer
-
Disk
Type: ResourcesMemory section 25.71
-
Ram
Type: ResourcesMemory section 25.71
25.48.2 Resources Powershell class
25.49 GetRoutingDomainOptions
25.49.1 GetRoutingDomainOptions Field Description
-
DisplayName
Type: String
-
Id
Type: String
-
Routes
Type: Array of RoutingDomainRoute
-
SourceNodes
Type: Array of String
25.49.2 GetRoutingDomainOptions Powershell class
25.50 RoutingDomainRouteEstablishment
25.50.1 RoutingDomainRouteEstablishment Field Description
-
AdjustRoutingForwardProfileSettings
Only for "routingForwardProfileSelection=CREATE_NEW". If set to true the handling of media channels can be modified.
Type: Boolean
-
DestinationDialStringRewriting
Only for "type=ROUTE".
Type: Array of RoutingTelRewrite section 25.73
-
DestinationNodeId
The identifier of the destination node. This is mandatory for the value "type=ROUTE".
Type: String
-
ParallelCallDialStringDirectoryId
Only for ype=ESTABLISH_PARALLEL". The identifier of the directory to determine dial strings for parallel calls.
Type: String
-
ParallelCalls
Only for ype=ESTABLISH_PARALLEL". A list of dial strings for parallel calls.
Type: Array of String
-
RejectStatus
Only for "type=REJECT".
Type: RouteRejectStatus
Possible values:
-
SUCCESS
Success.
-
DIAL_STRING
Erroneous dial string, user not found, no route, etc.
-
NETWORK_PERMISSION
No permission.
-
NETWORK_CONGESTION
A network congestion.
-
NETWORK_EQUIPMENT
Device error.
-
USER_BUSY
User busy.
-
USER_REDIRECTED
Redirected.
-
USER_NOT_RESPONDING
No reaction.
-
USER_NOT_SELECTED
A different user received the call.
-
USER_REJECTED
Rejected
-
USER_TERMINATED
Terminated
-
MEDIA_NEGOTIATION
Media negotiation error.
-
ERROR
Generic error
-
DOMAIN_SPECIFIC_0
Domain specific 0
-
DOMAIN_SPECIFIC_1
Domain specific 1
-
DOMAIN_SPECIFIC_2
Domain specific 2
-
DOMAIN_SPECIFIC_3
Domain specific 3
-
DOMAIN_SPECIFIC_4
Domain specific 4
-
DOMAIN_SPECIFIC_5
Domain specific 5
-
DOMAIN_SPECIFIC_6
Domain specific 6
-
DOMAIN_SPECIFIC_7
Domain specific 7
-
DOMAIN_SPECIFIC_8
Domain specific 8
-
DOMAIN_SPECIFIC_9
Domain specific 9
-
DOMAIN_SPECIFIC_10
Domain specific 10
-
DOMAIN_SPECIFIC_11
Domain specific 11
-
DOMAIN_SPECIFIC_12
Domain specific 12
-
DOMAIN_SPECIFIC_13
Domain specific 13
-
DOMAIN_SPECIFIC_14
Domain specific 14
-
DOMAIN_SPECIFIC_15
Domain specific 15
-
DOMAIN_SPECIFIC_16
Domain specific 16
-
DOMAIN_SPECIFIC_17
Domain specific 17
-
DOMAIN_SPECIFIC_18
Domain specific 18
-
DOMAIN_SPECIFIC_19
Domain specific 19
-
-
RoutingForwardProfileDisplayName
Only for "routingForwardProfileSelection=CREATE_NEW". The display name for the new routing forward profile.
Type: String
-
RoutingForwardProfileId
Only for "routingForwardProfileSelection=USE_REFERENCE". The identifier of the routing forward profile.
Type: String
-
RoutingForwardProfileMode
Only for "adjustRoutingForwardProfileSettings=true". This is the media channel handling mode.
Type: RoutingForwardProfileMode
Possible values:
-
PASSTHROUGH
-
TRANSCODING
-
BYPASS
-
PASSTHROUGH_WITH_FALLBACK_TO_BYPASS
-
-
RoutingForwardProfileSelection
Only for "type=ROUTE". An Routing forward profile can added for this route.
Type: RoutingDomainRoutingForwardProfileSelection
Possible values:
-
CREATE_NEW
Create a new profile.
-
USE_REFERENCE
Use an existing profile.
-
NONE
Don't select a file.
-
-
SkipIfNodeNotOperational
If set to "true" this route will be skipped if the destination node is not operational.
Type: Boolean
-
SourceDialStringRewriting
Only for "type=ROUTE".
Type: Array of RoutingTelRewrite section 25.73
-
Type
This is the type of action which is executed after the route filter was passed.
Type: RoutingDomainRouteEstablishmentType
Possible values:
-
ROUTE
Route call
-
IGNORE
Ignore call
-
REJECT
Reject call
-
REDIRECT
Redirect call
-
ESTABLISH_PARALLEL
Establish parallel calls
-
25.50.2 RoutingDomainRouteEstablishment Powershell class
25.51 RoutingDomainRouteFilter
25.51.1 RoutingDomainRouteFilter Field Description
-
AssertedDialString
You can specify a required structure of the asserted dial string.
Type: Array of TelMatch section 25.28
-
ConditionId
A condition can be selected. Only if this condition is met, this route is taken.
Type: String
-
DestinationDialString
You can specify a required structure of the destination dial string.
Type: Array of TelMatch section 25.28
-
FirstDiversionDialString
You can specify a required structure of the first diversion dial string
Type: Array of TelMatch section 25.28
-
LastDiversionDialString
You can specify a required structure of the last diversion dial string
Type: Array of TelMatch section 25.28
-
LookupDirectories
If a lookup directory is selected then the dial string must be included in the directory.
Type: RoutingDomainRouteLookupDirectories section 25.74
-
SourceDialString
You can specify a required structure of the source dial string.
Type: Array of TelMatch section 25.28
-
SourceNodeIds
Optionally you can restrict the set of source nodes which are used for this route. Otherwise, all nodes are accepted.
Type: Array of String
-
TransferrerDialString
You can specify a required structure of the transferrer dial string
Type: Array of TelMatch section 25.28
25.51.2 RoutingDomainRouteFilter Powershell class
25.52 RoutingDomainRoutePathReplacement
25.52.1 RoutingDomainRoutePathReplacement Field Description
-
AdjustAcceptNewForwarderDomain
Type: Boolean
-
RoutingForwardProfileDisplayName
Only for "routingForwardProfileSelection=CREATE_NEW". The display name for the new routing forward profile.
Type: String
-
RoutingForwardProfileSelection
Only for "type=REPLACE". An Routing forward profile can added for this route.
Type: RoutingDomainRoutingForwardProfileSelection
Possible values:
-
CREATE_NEW
Create a new profile.
-
USE_REFERENCE
Use an existing profile.
-
NONE
Don't select a file.
-
-
Type
The action that is carried out if the route filter matches.
Type: RoutePathReplacementType
Possible values:
-
REPLACE
-
REJECT
-
25.52.2 RoutingDomainRoutePathReplacement Powershell class
25.53 RoutingDomainRoute
25.53.1 RoutingDomainRoute Field Description
-
DisplayName
Type: String
-
Establishment
Only for "mode=establishment".
Type: RoutingDomainRouteEstablishment section 25.50
-
Filters
Filters determine when this route will be used for incoming or outgoing calls.
Type: Array of RoutingDomainRouteFilter section 25.51
-
PathReplacement
Only for "mode=pathReplacement".
Type: RoutingDomainRoutePathReplacement section 25.52
-
SupervisionId
The identifier of the supervision for this route.
Type: String
-
UseRouteSupervision
This value determines if this route uses route supervision. If set to "true" the parameter "supervisionId" must be provided.
Type: Boolean
-
UseUnconditionalRouting
This value determines if filters apply to this route.
Type: Boolean
25.53.2 RoutingDomainRoute Powershell class
25.54 SignalingForwardingOptions
25.54.1 SignalingForwardingOptions Field Description
-
ACTIVE_APPARENT_STATE
Type: Boolean
-
ADDRESS
Type: Boolean
-
ASSERTED_ADDRESS
Type: Boolean
-
DESTINATION_ADDRESS
Type: Boolean
-
DESTINATION_USER
Type: Boolean
-
END_REASON
Type: Boolean
-
HOLD
Type: Boolean
-
MWI_REQUEST_SIP_DESTINATION_ADDRESS
Type: Boolean
-
MWI_REQUEST_SIP_SOURCE_ADDRESS
Type: Boolean
-
MWI_RESPONSE_REASON
Type: Boolean
-
MWI_RESPONSE_SIP_REASON
Type: Boolean
-
NOTIFY_SIP_INFO
Type: Boolean
-
PRIORITY
Type: Boolean
-
PROCEEDING
Type: Boolean
-
PROCEEDING_RINGING
Type: Boolean
-
REDIRECT_HISTORY
Type: Boolean
-
RINGING
Type: Boolean
-
SIP_ADDRESS
Type: Boolean
-
SIP_ASSERTED_ADDRESS
Type: Boolean
-
SIP_DESTINATION_ADDRESS
Type: Boolean
-
SIP_END_REASON
Type: Boolean
-
SIP_HEADER_CALL_INFO
Type: Boolean
-
SIP_HEADER_DIVERSION
Type: Boolean
-
SIP_HEADER_HISTORY_INFO
Type: Boolean
-
SIP_HEADER_ORGANIZATION
Type: Boolean
-
SIP_HEADER_PRIORITY
Type: Boolean
-
SIP_HEADER_PRIVACY
Type: Boolean
-
SIP_HEADER_P_ASSERTED_IDENTITY
Type: Boolean
-
SIP_HEADER_P_CALLED_PARTY_ID
Type: Boolean
-
SIP_HEADER_REFERRED_BY
Type: Boolean
-
SIP_HEADER_REMOTE_PARTY_ID
Type: Boolean
-
SIP_HEADER_SERVER
Type: Boolean
-
SIP_HEADER_SUBJECT
Type: Boolean
-
SIP_HEADER_USER_AGENT
Type: Boolean
-
SIP_MSFT_GEOLOCATION
Type: Boolean
-
SIP_PRIORITY
Type: Boolean
-
SIP_PRIVACY
Type: Boolean
-
SIP_REDIRECT_HISTORY
Type: Boolean
-
SIP_REFERRER_ADDRESS
Type: Boolean
-
SIP_SIPSNX_HEADER_P_ACCESS_NETWORK_INFO
Type: Boolean
-
SIP_SIPSNX_HEADER_P_RECORDING_FROM
Type: Boolean
-
SIP_SIPSNX_HEADER_P_RECORDING_TAPPED
Type: Boolean
-
SIP_SIPSNX_HEADER_P_RECORDING_TO
Type: Boolean
-
TRANSFERRER_ADDRESS
Type: Boolean
-
USER
Type: Boolean
-
NotifySipInfoFilters
Type: Array of NotifySipInfoFilter section 25.76
-
Profile
Type: SignalingForwardingOptionsProfile
Possible values:
-
STANDARD
-
FULL
-
25.54.2 SignalingForwardingOptions Powershell class
25.55 TagRewriteOperation
25.55.1 TagRewriteOperation Field Description
-
Type
Indicates which rewrite operation will be carried out on the tag.
Type: TagRewriteOperationType
Possible values:
-
add
-
delete
-
keep
-
-
Tag
Tags may only contain alphabetic and numeric characters and have to start with a lowercase character
Type: String
25.55.2 TagRewriteOperation Powershell class
25.56 LicenseFacility
25.56.1 LicenseFacility Field Description
-
Name
Type: String
-
Value
Type: Integer
25.56.2 LicenseFacility Powershell class
25.57 SystemId
25.57.1 SystemId Field Description
-
DisplayName
Type: String
-
Id
Type: String
25.57.2 SystemId Powershell class
25.58 LocalUser
25.58.1 LocalUser Field Description
-
Name
Type: String
25.58.2 LocalUser Powershell class
25.59 LocalV0User
25.59.1 LocalV0User Field Description
-
Name
Type: String
25.59.2 LocalV0User Powershell class
25.60 LdapAuthority
25.60.1 LdapAuthority Field Description
-
DisplayName
Type: String
-
Id
Type: String
25.60.2 LdapAuthority Powershell class
25.61 MsTeamsSbaUser
25.61.1 MsTeamsSbaUser Field Description
-
LastActiveTime
Type: String
-
LastSyncTime
Type: String
-
SipUri
Type: String
-
UserId
Type: String
25.61.2 MsTeamsSbaUser Powershell class
25.62 GetNodesNode
25.62.1 GetNodesNode Field Description
-
DisplayName
Type: String
-
Id
Type: String
25.62.2 GetNodesNode Powershell class
25.63 GetSystemsProfilesProfile
25.63.1 GetSystemsProfilesProfile Field Description
-
CreateNewNetworkController
Create new network controller or select an existing one.
Type: Boolean
-
NetworkControllerDisplayName
The display name of the newly created network controller.
Type: String
-
NetworkControllerInterface
The interface of the newly created network controller.
Type: String
-
NetworkControllerIpVersion
The IP version of the newly created network controller.
Type: IpVersion
Possible values:
-
[Any Address Version]
-
IN_ADDRESS_VERSION_4
-
IN_ADDRESS_VERSION_6
-
-
NetworkControllerIpAddress
The IP address of the newly created network controller.
Type: String
-
EnableReverseDnsLookup
Specify whether reverse DNS lookup is enabled for the newly created network controller.
Type: Boolean
-
NetworkControllerId
In case no new network controller is created, this value must be provided.
Type: String
-
UdpTcpPort
The UDP/TCP Port.
Type: Integer
-
TlsPort
The TLS Port.
Type: Integer
-
UdpPortRange
Restricts the udp port range
Type: PortRange section 25.25
-
TcpPortRange
Restricts the tcp port range
Type: PortRange section 25.25
-
SipInterconnection
Type: SipInterconnection
Possible values:
-
REGISTRAR
The node provides a registration server (registrar) at which the remote station must register.
-
REGISTRATION
The node registers at a remote station as a client. In this case the remote station has to provide a registrar.
-
TRUNK
The node uses SIP trunking to interconnect with the remote station. In this way, full dial stringranges can be linked at once.
-
-
RemoteSipDomain
Please choose the remote SIP URI which will be used in SIP URIs of outgoing calls and which describes where the remote endpoint can be reached.
Type: RemoteSipDomain section 25.26
-
LocalSipDomain
Optionally you can choose the local SIP domain. The local SIP domain will be added to all SIP addresses which belong to the local system (e.g. the calling number of outgoing calls).
Type: String
-
ActivateClientAuthentication
Activate client authentication. These authentication settings determine how the node authenticate to a remote station.
Type: Boolean
-
ClientCredentials
Credentials for client authentication.
Type: SipCredentials section 25.27
-
ActivateServerAuthentication
Activate server authentication. These authentication settings determine how a remote station has to authenticate to anynode. They will be stored in a User Directory.
Type: Boolean
-
ServerCredentials
Credentials for server authentication
Type: SipCredentials section 25.27
-
RegistrarUri
The node will register as a client at a remote station. Select the necessary settings for this registration.
Type: String
-
AddressOfRecord
User Part of Address-Of-Record for registration.
Type: String
-
SipRegistrar
Dial string matching condition that determines which calls are to be forwarded to the registered remote stations.
Type: TelMatch section 25.28
-
UseNetworkPeerWhitelist
Type: Boolean
-
IncludeRemoteSipDomainInWhitelist
Include the remote SIP domain in the whitelist.
Type: Boolean
-
IncludeSipRegistrarInWhitelist
Include the SIP registrar in the whitelist.
Type: Boolean
-
IncludeOwnSubnetInWhitelist
Include the own subnet in the whitelist.
Type: Boolean
-
NetworkPeerWhitelist
Type: Array of NetworkPeerWhitelistEntry
-
AllowOnlyNegotiatedPeersForRtpRtcp
Allow only negotiated peers for RTP/RTCP.
Type: Boolean
-
IncomingDialStringRewriteRules
Type: Array of DialStringRewrite section 25.4
-
OutgoingDialStringRewriteRules
Type: Array of DialStringRewrite section 25.4
-
RoutingDomains
Here, the routing domains (their IDs) can be selected which listen for incoming calls on this new node.
Type: Array of String
-
DisplayName
Enter a meaningful name for your new node. The name is arbitrary. You will use it to uniquely identify this node later during configuration.
Type: String
-
CreateNewTeamsCarrierNode
Whether to create a new Teams carrier node or use an existing one. If an existing one is used, the value eamsCarrierNodeId" must be given.
Type: Boolean
-
TeamsCarrierNodeId
Select an existing MS Teams carrier node to share the Microsoft Teams Connectivity.
Type: String
-
CreateNewMsOperatorConnectNode
Whether to create a new Microsoft Teams Connectivity or use an existing one. If an existing one is used, the value "msOperatorConnectNodeId" must be given.
Type: Boolean
-
MsOperatorConnectNodeId
Select an existing Node to share the Microsoft Teams Connectivity.
Type: String
-
TenantId
The tenant ID is mandatory if you want to setup multiple Microsoft Operator Connect nodes, using a single SBC FQDN.
Type: String
-
SbcFqdn
Determine the name for the FQDN of the SBC.
Type: String
-
TenantFqdn
Enter the tenant FQDN for the desired customer.
Type: String
-
Region
Type: AddSystemRegion
Possible values:
-
North America
For the profiles Zoom Phone Premise Peering, Zoom Contact Center and Zoom Phone Provider Exchange.
-
EMEA
For the profiles Zoom Phone Premise Peering, Zoom Contact Center and Zoom Phone Provider Exchange.
-
Australia
For the profiles Zoom Phone Premise Peering, Zoom Contact Center and Zoom Phone Provider Exchange.
-
APAC
For the profiles Zoom Phone Premise Peering and Zoom Phone Provider Exchange.
-
LATAM
For the profiles Zoom Phone Premise Peering and Zoom Phone Provider Exchange.
-
China
For the profile Zoom Phone Premise Peering.
-
Japan
For the profiles Zoom Phone Premise Peering, Zoom Contact Center and Zoom Phone Provider Exchange.
-
-
XGooglePbxTrunkSecretKey
The X-Google-Pbx-Trunk-Secret-Key. Only used for the Google Voice profile.
Type: String
-
DisplayName
Type: String
-
Id
Type: String
25.63.2 GetSystemsProfilesProfile Powershell class
25.64 TelMatchList
25.64.1 TelMatchList Field Description
-
Matches
Type: Array of TelMatch section 25.28
-
Operator
The operator applied to the results of the "matches".
Type: TelMatchListOperator
Possible values:
-
OR
-
XOR
-
AND
-
NOT
-
25.64.2 TelMatchList Powershell class
25.65 TelMatchPlain
25.65.1 TelMatchPlain Field Description
-
Prefix
Prefix which must be present in the dial string.
Type: String
-
Suffix
Suffix which must be present in the dial string.
Type: String
25.65.2 TelMatchPlain Powershell class
25.66 AddNodeResult
25.66.1 AddNodeResult Field Description
-
DisplayName
Type: String
-
Id
Type: String
25.66.2 AddNodeResult Powershell class
25.67 GetProviderProfilesProfile
25.67.1 GetProviderProfilesProfile Field Description
-
DeutscheTelekomNumberExtensionRange
Number Extension Range for seperating incomming calls. This parameter can only be used with the "Deutsche Telekom CompanyFlex SIP-Trunk" profile.
Type: TelMatchExtensionRange section 25.6
-
CreateNewDeutscheTelekomSipTrunk
Create new Deutsche Telekom Sip Trunk or select an existing one. This parameter can only be used with the "Deutsche Telekom CompanyFlex SIP-Trunk" profile.
Type: Boolean
-
DeutscheTelekomSipTrunkId
In case no new Deutsche Telekom SipTrunk is created, this value must be given. This parameter can only be used with the "Deutsche Telekom CompanyFlex SIP-Trunk" profile
Type: String
-
CreateNewNetworkController
Create new network controller or select an existing one.
Type: Boolean
-
NetworkControllerDisplayName
The display name of the newly created network controller.
Type: String
-
NetworkControllerInterface
The interface of the newly created network controller.
Type: String
-
NetworkControllerIpVersion
The IP version of the newly created network controller.
Type: IpVersion
Possible values:
-
[Any Address Version]
-
IN_ADDRESS_VERSION_4
-
IN_ADDRESS_VERSION_6
-
-
NetworkControllerIpAddress
The IP address of the newly created network controller.
Type: String
-
EnableReverseDnsLookup
Specify whether reverse DNS lookup is enabled for the newly created network controller.
Type: Boolean
-
NetworkControllerId
In case no new network controller is created, this value must be given.
Type: String
-
UdpTcpPort
The UDP/TCP Port.
Type: Integer
-
TlsPort
The TLS port.
Type: Integer
-
UdpPortRange
The UDP port range.
Type: PortRange section 25.25
-
TcpPortRange
The TCP port range.
Type: PortRange section 25.25
-
ActivateNatTraversal
When anynode is located behind a NAT gateway you can determine how this gateway can be traversed. Please ensure that the gateway is configured accordingly.
Type: Boolean
-
ExternalHost
External Host or IP Address
Type: String
-
NatDeviceHasFixedPortMapping
In the NAT device (firewall/router) a fixed port mapping is defined.
Type: Boolean
-
FixedUdpTcpPort
Map the UDP/TCP Port to this.
Type: Integer
-
FixedTlsPort
Map the TLS Port to this.
Type: Integer
-
FixedUdpPortRangeStart
Map dynamic UDP Ports to this.
Type: Integer
-
FixedTcpPortRangeStart
Map dynamic TCP Ports to this.
Type: Integer
-
NodeViaSipTrunking
true
The node uses SIP trunking to interconnect with the remote station. In this way, full dial string ranges can be linked at once.
false
The node registers at a remote station as a client. In this case the remote station has to provide a registrar.
Type: Boolean
-
RemoteSipDomain
Please choose the remote SIP URI which will be used in SIP URIs of outgoing calls and which describes where the remote endpoint can be reached.
Type: RemoteSipDomain section 25.26
-
LocalSipDomain
The local SIP domain will be added to all SIP addresses which belong to the local system (e.g. the calling number of outgoing calls.
Type: String
-
ActivateClientAuthentication
Activate client authentication. These authentication settings determine how the node authenticate to a remote station.
Type: Boolean
-
Credentials
Client SIP User Name and Password.
Type: SipUserCredentials section 25.30
-
RegistrarUri
The node will register as a client at a remote station. Select the necessary settings for this registration.
Type: String
-
AddressOfRecord
User Part of Address-Of-Record for registration.
Type: String
-
ProxyUri
Optional proxy server. Outgoing calls will be forwarded to this proxy. The specified value must begin with "sip:".
Type: String
-
PrimaryProxyUri
Primary proxy URI for the "Deutsche Telekom CompanyFlex SIP-Trunk" profile. The specified value must begin with "sip:".
Type: String
-
SecondaryProxyUri
Secondary proxy URI for the "Deutsche Telekom CompanyFlex SIP-Trunk" profile. The specified value must begin with "sip:".
Type: String
-
DefineAssertedUri
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: Boolean
-
AssertedUriHost
Mandatory, if the URI is not based on the registrar uri or proxy uri.
Type: String
-
AssertedUri
User Part of Asserted-URI.
Type: String
-
UseNetworkPeerWhitelist
If the interconnection to the VoIP peer takes place over a public IP access, it is strictly recommended to minimize the IP addresses from which SIP messages are allowed by this whitelist.
Type: Boolean
-
IncludeRemoteSipDomainInWhitelist
Whether to include the remote SIP domain in the whitelist.
Type: Boolean
-
IncludeSipRegistrarInWhitelist
Whether to include the SIP registrar in the whitelist.
Type: Boolean
-
IncludeProxyInWhitelist
Whether to include the configured proxy in the whitelist.
Type: Boolean
-
NetworkPeerWhitelist
The whitelist.
Type: Array of NetworkPeerWhitelistEntry
-
AllowOnlyNegotiatedPeersForRtpRtcp
Allow only negotiated peers for RTP/RTCP.
Type: Boolean
-
IncomingDialStringRewriteRules
Type: Array of DialStringRewrite section 25.4
-
OutgoingDialStringRewriteRules
Type: Array of DialStringRewrite section 25.4
-
Region
Only for the profile Speedcom AG - Speedvoice
Type: AddProviderRegion
Possible values:
-
Schweiz
For the profile Speedcom AG - Speedvoice.
-
Liechtenstein
For the profile Speedcom AG - Speedvoice.
-
sipcall CH
For the profile sipcall.
-
sipcall AT
For the profile sipcall.
-
-
Telstra1thTrunkGroup
Only for the Telstra EP (SIP Connect) profile. Connection options for the first trunk group.
Type: TelstraNthTrunkOptions section 25.31
-
Telstra2ndTrunkGroup
Only for the Telstra EP (SIP Connect) profile. Connection options for the second trunk group.
Type: TelstraNthTrunkOptions section 25.31
-
RoutingDomains
Here, the routing domains (their IDs) can be selected which listen for incoming calls on this new node.
Type: Array of String
-
DisplayName
Type: String
-
DisplayName
Type: String
-
Id
Type: String
25.67.2 GetProviderProfilesProfile Powershell class
25.68 CertificateListEntry
25.68.1 CertificateListEntry Field Description
-
Issuer
Type: String
-
Subject
Type: String
-
ValidFrom
Type: String
-
ValidUntil
Type: String
25.68.2 CertificateListEntry Powershell class
25.69 TransportConnectionStatusCodeErrorFlag
25.69.1 TransportConnectionStatusCodeErrorFlag Field Description
-
DOWN
Change the state to non-operational.
Type: TransportConnectionStatusCodeErrorFlag section 25.69
-
DOWN_RETRY_AFTER
Change the state to non-operational if the response message contains a Retry-After header.
Type: TransportConnectionStatusCodeErrorFlag section 25.69
-
FAILOVER
Perform failover to another transport connection, if possible.
Type: TransportConnectionStatusCodeErrorFlag section 25.69
-
TERMINATE_INCOMING
Terminate incoming traffic.
Type: TransportConnectionStatusCodeErrorFlag section 25.69
-
TERMINATE_OUTGOING
Terminate outgoing traffic.
Type: TransportConnectionStatusCodeErrorFlag section 25.69
25.69.2 TransportConnectionStatusCodeErrorFlag Powershell class
25.70 SipLoadBalancerDefaultLoad
25.70.1 SipLoadBalancerDefaultLoad Field Description
-
HIGH
Type: SipLoadBalancerDefaultLoad section 25.70
-
LOW
Type: SipLoadBalancerDefaultLoad section 25.70
-
MEDIUM
Type: SipLoadBalancerDefaultLoad section 25.70
25.70.2 SipLoadBalancerDefaultLoad Powershell class
25.71 ResourcesMemory
25.71.1 ResourcesMemory Field Description
-
Total
Type: long
-
Used
Type: long
25.71.2 ResourcesMemory Powershell class
25.72 String
25.72.1 String Field Description
-
CASE_INSENSITIVE_ORDER
Type: Comparator
25.72.2 String Powershell class
25.73 RoutingTelRewrite
25.73.1 RoutingTelRewrite Field Description
-
DelLeading
How many of the leading characters will be deleted.
Type: Integer
-
DelTrailing
How many of the trailing characters will be deleted.
Type: Integer
-
KeepLeading
Keep aditional leading characters of the matched part. This happens before the removal of leading characters.
Type: Integer
-
KeepTrailing
Keep aditional trailing characters of the matched part. This happens before the removal of trailing characters.
Type: Integer
-
MatchedPart
The matched part of the dial string that will be rewritten. Setting this to 0 will select the whole dial string.
Type: Integer
-
Prefix
Adds a prefix to the dial string
Type: String
-
Source
This determines which dial string will be rewritten.
Type: RoutingTelRewriteSource
Possible values:
-
MOST_APPROPRIATE
-
FIRST_DIVERSION
-
LAST_DIVERSION
-
SOURCE
-
DESTINATION
-
TRANSFERRER
-
-
Suffix
Adds a suffix to the dial string
Type: String
25.73.2 RoutingTelRewrite Powershell class
25.74 RoutingDomainRouteLookupDirectories
25.74.1 RoutingDomainRouteLookupDirectories Field Description
-
AssertedUriDirectoryId
The identifier of the directory to lookup the asserted dial string
Type: String
-
DestinationDialStringDirectoryId
The identifier of the directory to lookup the destination dial string
Type: String
-
FirstDiversionNumberDirectoryId
The identifier of the directory to lookup the first diversion dial string
Type: String
-
LastDiversionNumberDirectoryId
The identifier of the directory to lookup the last diversion dial string
Type: String
-
SourceDialStringDirectoryId
The identifier of the directory to lookup the source dial string
Type: String
-
TransferrerDialStringDirectoryId
The identifier of the directory to lookup the transferrer dial string
Type: String
25.74.2 RoutingDomainRouteLookupDirectories Powershell class
25.75 RoutingForwardProfile
25.75.1 RoutingForwardProfile Field Description
-
AnnouncementIncoming
Play an announcement at the incoming node.
Type: Boolean
-
AnnouncementMediaSourceId
The id of the Announcement Media Source used as specified.
Type: String
-
AnnouncementOutgoing
Play an announcement at the outgoing node.
Type: Boolean
-
DisplayName
Display name of the object.
Type: String
-
EarlyMediaPassThrough
Specify whether early media should be already passed through during call setup.
Type: Boolean
-
Id
Identifier of the object.
Type: String
-
MediaRecorderId
The id of the Media Recorder used to record as specified.
Type: String
-
RemoveAnynodeFromSignalingPath
Type: Boolean
-
TelephonyForwardingStack
A Telephony Forwarding is a collection of protocol specific settings which influence the way forwarding of signaling information or media data is going to take place.
Type: TelephonyForwarding section 25.80
-
TelephonyForwardingStackId
This value will be used instead of telephonyForwardingStack if the object is not complete. The id of a Telephony Forwarding is a collection of protocol specific settings which influence the way forwarding of signaling information or media data is going to take place.
Type: String
25.75.2 RoutingForwardProfile Powershell class
25.76 NotifySipInfoFilter
25.76.1 NotifySipInfoFilter Field Description
-
MaxContentLength
Type: Integer
-
MimeContentTypeName
Type: String
25.76.2 NotifySipInfoFilter Powershell class
25.77 Backend
25.77.1 Backend Field Description
-
DisplayName
Type: String
-
Id
Type: String
25.77.2 Backend Powershell class
25.78 NetworkInterface
25.78.1 NetworkInterface Field Description
-
DisplayName
Type: String
-
Id
Type: String
25.78.2 NetworkInterface Powershell class
25.79 NetworkController
25.79.1 NetworkController Field Description
-
DisplayName
Type: String
-
Id
Type: String
-
Interface
Type: String
25.79.2 NetworkController Powershell class
25.80 TelephonyForwarding
25.80.1 TelephonyForwarding Field Description
-
MediaNegotiationForwarder
Type: MediaNegotiationForwarder section 25.81
-
MediaNegotiationForwarderId
Type: String
-
SignalingForwardingFromCalledToCalling
Type: SignalingForwardingOptions section 25.54
-
SignalingForwardingFromCallingToCalled
Type: SignalingForwardingOptions section 25.54
25.80.2 TelephonyForwarding Powershell class
25.81 MediaNegotiationForwarder
25.81.1 MediaNegotiationForwarder Field Description
-
DisplayName
The name shown in the anynode frontend.
Type: String
-
Id
The id of this object.
Type: String
-
MediaMode
Type: MediaMode
Possible values:
-
TRANSCODING
-
BYPASS
-
PASSTHROUGH
-
PASSTHROUGH_WITH_FALLBACK_TO_BYPASS
-
-
MediaTranscodingOptions
The Media Transcoding Options to be used.
Type: MediaTranscodingOptions section 25.82
-
MediaTranscodingOptionsId
This value will be used instead of mediaTranscodingOptions, if the object cannot be found. Id of the media transcoding options object to be used.
Type: String
25.81.2 MediaNegotiationForwarder Powershell class
25.82 MediaTranscodingOptions
25.82.1 MediaTranscodingOptions Field Description
-
DisplayName
The name shown in the anynode frontend.
Type: String
-
Id
The id of this object.
Type: String