14 Node
14.1 Get-anynodeNodes
Returns all configured nodes.
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
Return Value Structure
The response body is strutured as an array. The array consists of GetNodesNode JSON objects. A description for its fields is at section 29.76.1. For the JSON schema refer to section 29.76.2.
14.2 Enable-anynodeNode
Enables a 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: Node
The id or display name of the node that will be enabled.
14.3 Disable-anynodeNode
Disables a 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: Node
The id or display name of the node that will be disabled.
14.4 Get-anynodeSystemNodeProfiles
Retrieves a list of all possible system profiles that can be used to add a PBX or Voice over IP System.
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
-
bool: CompleteData
Indicates if additional data for each node should be included.
Return Value Structure
The response body is strutured as an array. The array consists of GetSystemsProfilesProfile JSON objects. A description for its fields is at section 29.77.1. For the JSON schema refer to section 29.77.2.
14.5 Get-anynodeMsTeamsCarriers
Retrieves a list of all configured Nodes using Microsoft Teams Carrier Nodes.
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
Return Value Structure
The response body is strutured as an array. The array consists of GetNodesNode JSON objects. A description for its fields is at section 29.76.1. For the JSON schema refer to section 29.76.2.
14.6 Add-anynodeSystemNode
Adds a new PBX or Voice over IP System node to 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 = 3
This parameter states which version of the request should be used.
Type: Integer
-
string: Profile
The id of the profile, that should be used. To get a list of availabled profiles use section 14.4.
-
SipTransport
Create a SIP transport object or select an existing one.
Type: AddSystemSipTransport section 29.25
-
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 29.26
-
TcpPortRange
Restricts the tcp port range
Type: PortRange section 29.26
-
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 29.27
-
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 29.28
-
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 29.28
-
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 29.29
-
SrvProxyDomain
The proxy address for nodes that are using an SRV loadbalancer.
Type: String
-
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
-
SipNodeNetworkPeerWhitelist
Network peer whitelist for filtering of incoming calls. Only applies when creating a shared SIP transport or using an existing SIP transport.
Type: AddSystemSipNodeWhitelist section 29.31
-
IncomingDialStringRewriteRules
Type: Array of DialStringRewrite section 29.4
-
OutgoingDialStringRewriteRules
Type: Array of DialStringRewrite section 29.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
Return Value Structure
The response body is strutured as an array. The array consists of AddNodeResult JSON objects. A description for its fields is at section 29.80.1. For the JSON schema refer to section 29.80.2.
14.7 Get-anynodeProviderNodeProfiles
Retrieves a list of all possible provider profiles that can be used to add a provider.
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
-
bool: CompleteData
Indicates if additional data for each node should be included.
Return Value Structure
The response body is strutured as an array. The array consists of GetProviderProfilesProfile JSON objects. A description for its fields is at section 29.81.1. For the JSON schema refer to section 29.81.2.
14.8 Add-anynodeProviderNode
Adds a Provider Node to 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 = 2
This parameter states which version of the request should be used.
Type: Integer
-
string: Profile
The id of the profile, that should be used. To get a list of availabled profiles use section 14.7.
-
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 29.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 29.26
-
TcpPortRange
The TCP port range.
Type: PortRange section 29.26
-
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 29.27
-
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
-
ClientCredentials
Client SIP User Name and Password.
Type: SipUserCredentials section 29.32
-
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
Deprecated use "proxyUri" instead.
Primary 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 29.4
-
OutgoingDialStringRewriteRules
Type: Array of DialStringRewrite section 29.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 29.33
-
Telstra2ndTrunkGroup
Only for the Telstra EP (SIP Connect) profile. Connection options for the second trunk group.
Type: TelstraNthTrunkOptions section 29.33
-
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
Return Value Structure
The response body is strutured as an array. The array consists of AddNodeResult JSON objects. A description for its fields is at section 29.80.1. For the JSON schema refer to section 29.80.2.
14.9 Add-anynodeSipPhoneRegistrar
Adds a new SIP phones registrar to 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
-
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 29.26
-
TcpPortRange
The TCP port range.
Type: PortRange section 29.26
-
SipPhoneRegistrarDirectoryId
The identifiert of the directory that determines how SIP phones authenticate.
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
-
IncludeOwnSubnetInWhitelist
Whether to include the own subnet 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 29.4
-
OutgoingDialStringRewriteRules
Type: Array of DialStringRewrite section 29.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
Type: String
Return Value Structure
The response body is strutured as an array. The array consists of AddNodeResult JSON objects. A description for its fields is at section 29.80.1. For the JSON schema refer to section 29.80.2.
14.10 Remove-anynodeNode
Removes a node 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: Node
The id or display name of the node that should be removed
-
bool: Force
If this is true, objects will be deleted even if they have other references than this node. This can cause errors inside the configuration.
14.11 Get-anynodeNodePort
Returns the UDP/TCP port of the requested node.
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: Node
The id or display name of the node that should be removed
14.12 Set-anynodeNodePort
Modifies the UDP/TCP port 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: Node
The id or displayName of the Node which port should be modified.
-
string: NewPort
The new UDP/TCP port for the given node.
14.13 Get-anynodeNodeTlsPort
Returns the TLS port of the requested node.
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: Node
The id or display name of the node that should be removed
14.14 Set-anynodeNodeTlsPort
Modifies the TLS port 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: Node
The id or displayName of the Node which port should be modified.
-
string: NewPort
The new TLS port for the given node.
14.15 Get-anynodeNodeFQDN
Returns the FQDN of the requested Teams node.
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: Node
The id or display name of the Teams node which FQDN should be returned.
14.16 Set-anynodeNodeFQDN
Modifies the FQDN of the requested Teams 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: Node
The id or display name of the Teams node which FQDN should be returned.
-
string: NewFQDN
The new FQDN for the Teams node.
14.17 Get-anynodeNodeOverrideHostname
Returns the hostname/FQDN of the requested node.
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: Node
The id or display name of the node which hostname/FQDN should be returned.
14.18 Set-anynodeNodeOverrideHostname
Modifies the hostname/FQDN 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: Node
The id or display name of the node which hostname/FQDN should be modified.
-
string: NewOverrideHostname
The new hostname/FQDN for the requested node.
14.19 Get-anynodeNodeNetworkSecurityProfilename
Returns the id of the current network security profile for the requested node.
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: Node
The id or display name of the node which network security profile name will be returned
14.20 Set-aynodeNetworkSecurityProfileName
Modifies the network security profile for 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: Node
The id or displayName of the Node which network security profile should be modified.
-
string: NetworkSecurityProfileId
The new network security profile id.
14.21 Get-anynodeNodeCertificate
Returns the certificate of the requested node.
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: Node
The id or display name of the node which certificate should be returned.
14.22 Set-anynodeNodeCertificate
Modifies the certificate 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: Mode
Determines which items will be modified with the uploaded file.
Type: mode
Possible Values:
-
CERTIFICATES_AND_PRIVATE_KEY
-
CERTIFICATES_ONLY
-
PRIVATE_KEY_ONLY
-
-
string: Node
The id or displayName of the Node to be modified.
-
string: CertificatePassword
The password of the certificate file.
-
string: Filepath
The path to the file that will be imported.
14.23 Get-anynodeNodeTransportConnections
Returns the transport connection of the requested node.
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: Node
The id or displayName of the Node whose transport connections should be returned.
Return Value Structure
The response body is strutured as an array. The array consists of SipNodeTransportConnection JSON objects. A description for its fields is at section 29.34.1. For the JSON schema refer to section 29.34.2.
14.24 Add-anynodeNodeTransportConnection
Adds a transport connection to 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: Node
The id or displayName of the Node where the Transport Connection will be added..
-
MatchingCondition
The matching condition is used to filter for which calls the transport connection will be used.
Type: TelMatch section 29.29
-
TransportConnectionId
The id of the transport connection
Type: String
Return Value Structure
The response body is structured as SipNodeTransportConnection JSON object. A description for its fields is at section 29.34.1. For the JSON schema refer to section 29.34.2.
14.25 Clear-anynodeNodeTransportConnections
Removes all transport connections 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: Node
The id or displayName of the Node whose transport connections should be returned.
-
string: RemoveRoutes
Decide if the routes should be removed or not.
14.26 Set-anynodeNodeTransportConnections
Replaces the Transport Connections 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: Node
The id or displayName of the Node whose Transport Connections will be modified.
-
TransportConnections
Array of type section 29.34.1
Return Value Structure
The response body is strutured as an array. The array consists of SipNodeTransportConnection JSON objects. A description for its fields is at section 29.34.1. For the JSON schema refer to section 29.34.2.
14.27 Remove-anynodeNodeTransportConnections
Removes a Transport Connection and it's matching condition from 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: Node
The id or displayName of the Node.
-
string: Index
The index of the Transport Connection that will be removed.
Return Value Structure
The response body is strutured as an array. The array consists of SipNodeTransportConnection JSON objects. A description for its fields is at section 29.34.1. For the JSON schema refer to section 29.34.2.
14.28 Add-anynodeNodeTrustedCertificate
Adds a new certificate to the list of trusted certificates for the requested node.
Required Permissions
-
API
-
Administration
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: Node
The id or displayName of the Node to be modified.
-
string: CertificatePassword
The password of the certificate file.
14.29 Clear-anynodeNodeTrustedCertificates
Removes all trusted certificates from 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: Node
The id or displayName of the Node to be modified.
14.30 Get-anynodeNodeIncomingDialStringRewriteRules
Returns the incoming dial string rewrite rules of the requested node
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: Node
The id or displayName of the Node
-
string: IncludeDefaults
Whether default values should be displayed or not.
Return Value Structure
The response body is strutured as an array. The array consists of DialStringRewrite JSON objects. A description for its fields is at section 29.4.1. For the JSON schema refer to section 29.4.2.
14.31 Set-anynodeNodeIncomingDialStringRewriteRules
Modifies the incoming dial string rewrite rules 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: Node
The id or displayName of the Node.
-
DialStringRewriteRules
Array of type section 29.4.1
Return Value Structure
The response body is strutured as an array. The array consists of DialStringRewrite JSON objects. A description for its fields is at section 29.4.1. For the JSON schema refer to section 29.4.2.
14.32 Add-anynodeNodeIncomingDialStringRewriteRules
Adds additional dial string rewrite rules to 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: Node
The id or displayName of the Node
-
DialStringRewriteRules
Array of type section 29.4.1
Return Value Structure
The response body is strutured as an array. The array consists of DialStringRewrite JSON objects. A description for its fields is at section 29.4.1. For the JSON schema refer to section 29.4.2.
14.33 Remove-anynodeNodeIncomingDialStringRewriteRules
Removes incoming dial string rewrite rules to 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: Node
The id or displayName of the Node.
-
string: DisplayName
The displayName or id of the incoming dial string rewrite rule to be removed.
-
string: Index
The index of the incoming dial string rewrite rule to be removed.
14.34 Get-anynodeNodeOutgoingDialStringRewriteRules
Returns the outgoing dial string rewrite rules of the requested node
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: Node
The id or displayName of the Node.
Return Value Structure
The response body is strutured as an array. The array consists of DialStringRewrite JSON objects. A description for its fields is at section 29.4.1. For the JSON schema refer to section 29.4.2.
14.35 Set-anynodeNodeOutgoingDialStringRewriteRules
Modifies the outgoing dial string rewrite rules 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: Node
The id or displayName of the Node.
-
DialStringRewriteRules
Array of type section 29.4.1
Return Value Structure
The response body is strutured as an array. The array consists of DialStringRewrite JSON objects. A description for its fields is at section 29.4.1. For the JSON schema refer to section 29.4.2.
14.36 Add-anynodeNodeOutgoingDialStringRewriteRules
Adds additional dial string rewrite rules to 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: Node
The id or displayName of the Node.
-
DialStringRewriteRules
Array of type section 29.4.1
Return Value Structure
The response body is strutured as an array. The array consists of DialStringRewrite JSON objects. A description for its fields is at section 29.4.1. For the JSON schema refer to section 29.4.2.
14.37 Remove-anynodeNodeOutgoingDialStringRewriteRules
Removes outgoing dial string rewrite rules to 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: Node
The id or displayName of the Node.
-
string: DisplayName
The displayName or id of the incoming dial string rewrite rule to be removed.
-
string: Index
The index of the incoming dial string rewrite rule to be removed.
14.38 Get-anynodeNodeNetworkPeerWhitelist
Returns the network peer whitelist of the requested node.
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: Node
The id or displayName of the Node.
Return Value Structure
The response body is strutured as an array. The array consists of NetworkPeerWhitelistEntry JSON objects. A description for its fields is at section 29.30.1. For the JSON schema refer to section 29.30.2.
14.39 Set-anynodeNodeNetworkPeerWhitelist
Modifies the network peer whitelist 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: Node
The id or displayName of the Node.
-
NetworkPeerWhitelist
Array of type section 29.30.1
Return Value Structure
The response body is strutured as an array. The array consists of NetworkPeerWhitelistEntry JSON objects. A description for its fields is at section 29.30.1. For the JSON schema refer to section 29.30.2.
14.40 Add-anynodeNodeNetworkPeerWhitelistEntry
Adds a new entry to the network peer whitelist 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: Node
The id or displayName of the Node
-
NetworkPeerWhitelist
Object of type section 29.30.1
Return Value Structure
The response body is strutured as an array. The array consists of NetworkPeerWhitelistEntry JSON objects. A description for its fields is at section 29.30.1. For the JSON schema refer to section 29.30.2.
14.41 Remove-anynodeNodeNetworkPeerWhitelistEntry
Removes a entry from the network peer whitelist 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: Node
The id or displayName of the Node.
-
psobject: Hostname
The host of the network peer whitelist entry to be removed.
-
string: Index
The index of the network peer whitelist entry to be removed.
Return Value Structure
The response body is strutured as an array. The array consists of NetworkPeerWhitelistEntry JSON objects. A description for its fields is at section 29.30.1. For the JSON schema refer to section 29.30.2.
14.42 Get-anynodeNodeChainCertificates
Returns the chain certificate information for the requested node.
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: Node
The id or displayName of the Node whose certificate chain should be returned.
Return Value Structure
The response body is strutured as an array. The array consists of CertificateListEntry JSON objects. A description for its fields is at section 29.82.1. For the JSON schema refer to section 29.82.2.
14.43 Add-anynodeNodeChainCertificate
Adds Certificates to the certificate chain of the requested node.
Required Permissions
-
API
-
Administration
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: Node
The id or displayName of the Node to be modified.
-
string: CertificateFilePath
The path to the file that will be imported.
Return Value Structure
The response body is strutured as an array. The array consists of CertificateListEntry JSON objects. A description for its fields is at section 29.82.1. For the JSON schema refer to section 29.82.2.
14.44 Remove-anynodeNodeChainCertificate
Removes a certificate from the certificate chain 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
Return Value Structure
The response body is strutured as an array. The array consists of CertificateListEntry JSON objects. A description for its fields is at section 29.82.1. For the JSON schema refer to section 29.82.2.
14.45 Clear-anynodeNodeChainCertificates
Removes all certificates from the certificate chain 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: Node
The id or displayName of the Node to be modified.
14.46 Request-anynodeNodeChainCertificates
Requests the certificate chain for the configured certificate 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: Node
The id or displayName of the Node to be modified.