< Back
New-UxSipServerEntry
Post
NAME New-UxSipServerEntry
SYNOPSIS
This cmdlet creates a new host/domain in existing sipserver table
SYNTAX
New-UxSipServerEntry [[-uxSession] <PSObject>] [-SipServerTableId] <Int32> [[-ServerLookup] <Int32>]
[[-ServerType] <Int32>] [[-Weight] <Int32>] [-Hostname] <String> [[-HostIpVersion] <Int32>] [[-DomainName]
<String>] [[-ServiceName] <String>] [[-Port] <Int32>] [[-TransportSocket] <Int32>] [[-ReuseTransport] <Int32>]
[[-ReuseTimeout] <Int32>] [-Protocol] <Int32> [[-Monitor] <Int32>] [[-KeepAliveFrequency] <Int32>]
[[-RecoverFrequency] <Int32>] [[-LocalUserName] <String>] [[-PeerUserName] <String>] [-Priority] <Int32>
[[-RemoteAuthorizationTableID] <Int32>] [[-ContactRegistrantTableID] <Int32>] [[-StaggerRegistration] <Int32>]
[[-ClearRemoteRegistrationOnStartup] <Int32>] [[-SessionURIValidation] <Int32>] [[-ContactURIRandomizer] <Int32>]
[[-RetryNonStaleNonce] <Int32>] [[-TLSProfileID] <Int32>] [[-AuthorizationOnRefresh] <Int32>] [-WhatIf] [-Confirm]
[<CommonParameters>]
DESCRIPTION
This cmdlet creates a new host in an existing sipserver table.You need to specify the sipserver table where these
transformation entries should be created.
PARAMETERS
-uxSession <PSObject>
If using multiple servers you will need to pass the uxSession Object created by connect-uxGateway
Else it will look for the last created session using the command above
Required? false
Position? 29
Default value
Accept pipeline input? false
Accept wildcard characters? false
-SipServerTableId <Int32>
Enter here the SIPServer ID of the sipserver table where you want to add a new host entry. This can be
extracted using "get-uxsipservertable" cmdlet
Required? true
Position? 1
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-ServerLookup <Int32>
Enter here the SIPServer ID of the sipserver table where you want to add a new host entry. This can be
extracted using "get-uxsipservertable" cmdlet
Required? false
Position? 2
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-ServerType <Int32>
Specifies the method to use to lookup SIP servers eConventionalSrvr
Required? false
Position? 3
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-Weight <Int32>
Specifies the weight of the server in case it's defined in the SRV record.
Required? false
Position? 4
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-Hostname <String>
Specifies the IP address or FQDN where this Signaling Group sends SIP messages. If an FQDN is configured all
the associated servers are included and used according to the server selection configuration element.
Required? true
Position? 5
Default value
Accept pipeline input? false
Accept wildcard characters? false
-HostIpVersion <Int32>
Enter here the code (integer) of the Field you want to add, eg:If you want to add "CalledNumber" add 0. Full
information on which codes maps to which field please refer http://bit.ly/Iy7JQS
Required? false
Position? 6
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-DomainName <String>
Specifies the Domain where this Signaling Group sends SRV queries.
Required? false
Position? 7
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ServiceName <String>
The name of the service to be placed in the SRV request.
Required? false
Position? 8
Default value sip
Accept pipeline input? false
Accept wildcard characters? false
-Port <Int32>
Enter here the output of the Input value.eg: If you want to change input of "^(2([45]\\d{2}|6[0-5]\\d))$" to
+44123456XXXX, you would enter here +44123456\\1
Required? false
Position? 9
Default value 5060
Accept pipeline input? false
Accept wildcard characters? false
-TransportSocket <Int32>
Enter here if the Transformation entry you will create will be Mandatory(0) or Optional(1). If this parameter
is not specified the transformation table will be created as Optional
Required? false
Position? 10
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-ReuseTransport <Int32>
Enter here if the Transformation entry you will create will be Mandatory(0) or Optional(1). If this parameter
is not specified the transformation table will be created as Optional
Required? false
Position? 11
Default value 1
Accept pipeline input? false
Accept wildcard characters? false
-ReuseTimeout <Int32>
Enter here if the Transformation entry you will create will be Mandatory(0) or Optional(1). If this parameter
is not specified the transformation table will be created as Optional
Required? false
Position? 12
Default value 1000
Accept pipeline input? false
Accept wildcard characters? false
-Protocol <Int32>
Enter here the Description (Name) of the Transformation entry. This is what will be displayed in the Ribbon GUI
Required? true
Position? 13
Default value 1
Accept pipeline input? false
Accept wildcard characters? false
-Monitor <Int32>
Specifies the method to monitor server None
- no monitoring of this server occurs
SIP options
- an Options message is sent to the server
Required? false
Position? 14
Default value 1
Accept pipeline input? false
Accept wildcard characters? false
-KeepAliveFrequency <Int32>
Enter here if the Transformation entry you will create will be Mandatory(0) or Optional(1). If this parameter
is not specified the transformation table will be created as Optional
Required? false
Position? 15
Default value 30
Accept pipeline input? false
Accept wildcard characters? false
-RecoverFrequency <Int32>
Enter here if the Transformation entry you will create will be Mandatory(0) or Optional(1). If this parameter
is not specified the transformation table will be created as Optional
Required? false
Position? 16
Default value 5
Accept pipeline input? false
Accept wildcard characters? false
-LocalUserName <String>
Enter here if the Transformation entry you will create will be Mandatory(0) or Optional(1). If this parameter
is not specified the transformation table will be created as Optional
Required? false
Position? 17
Default value Anonymous
Accept pipeline input? false
Accept wildcard characters? false
-PeerUserName <String>
Enter here if the Transformation entry you will create will be Mandatory(0) or Optional(1). If this parameter
is not specified the transformation table will be created as Optional
Required? false
Position? 18
Default value Anonymous
Accept pipeline input? false
Accept wildcard characters? false
-Priority <Int32>
Enter here the code (integer) of the Field you want to add, eg:If you want to add "CalledNumber" add 0. Full
information on which codes maps to which field please refer http://bit.ly/Iy7JQS
Required? true
Position? 19
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-RemoteAuthorizationTableID <Int32>
Specifies a Remote Authorization table for this SIP Server, from a list of authorization tables defined in the
Remote Authorization Tables. The Remote Authorization table is used by a Signaling group when a challenge
(401/407) is issued by the server. The table contains a realm, user name, and password. There are used to
provide credentials to he server issuing the challenge.
Required? false
Position? 20
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-ContactRegistrantTableID <Int32>
Specifies a Contact Registration Table for this SIP Server,from a list of registration tables defined in the
Contact Registrant Tables. The Contact Registration is used by a Signaling Group to register one or more
contacts to a registrar. The contact information contains the SIP address of record and the methods which can
be used to establish sessions to this Signaling group.
Required? false
Position? 21
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-StaggerRegistration <Int32>
If more than one Contact Registrant Entry is in Contact table, stagger Register Requests by 1 second. Applies
to UnRegister also. This will only be displayed and applicble if Contact Registract Table is something other
than None.
Required? false
Position? 22
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-ClearRemoteRegistrationOnStartup <Int32>
When enabled, a Register with Expires: 0 will be sent to the SIP Server on power up. After the Unregister
(Expires: 0) is complete, a Register (Expires: non-zero) will then be sent.
Required? false
Position? 23
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-SessionURIValidation <Int32>
Enter here if the Transformation entry you will create will be Mandatory(0) or Optional(1). If this parameter
is not specified the transformation table will be created as Optional
Required? false
Position? 24
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-ContactURIRandomizer <Int32>
If enabled, the following will occur: -Random user values will be generated and put into the Contact-URI of
each outgoing Register message. -The random user portion will be saved and compared to incoming Invite
Request-Uri's. If the prefix of the R-URI contains SBCxxxx, then if there is a match, SBCxxxx will be stripped
and the remaining number used to route (if no match, Invite is not accepted). If there is no SBCxxxx in R-URI,
then the number is sent as-is for routing.
Required? false
Position? 25
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-RetryNonStaleNonce <Int32>
This value will only be visible if Remote Authorization Table are defined in SIP Server. When true, if
stale=false is received in 401/407, the SBC Edge will set failed retry timer and re-attempt to send Register
with same credentials at expiration. When false, if stale=false is received in 401/407, the SBC Edge will
never resend a challenged request with the same credentials.(this is RFC behavior)
Required? false
Position? 26
Default value 1
Accept pipeline input? false
Accept wildcard characters? false
-TLSProfileID <Int32>
If TLS is selected this specifies the TLS profile this server will use for secure SIP messages.
This option is available if Protocol is set to TLS.
Required? false
Position? 27
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-AuthorizationOnRefresh <Int32>
This value will only be visible if both Contact Registrant Table and Remote Authorization Table are defined in
SIP Server. When true, the SBC Edge will include authorization headers obtained from previous 401/407 exchange
in registration refresh messages. When false, the SBC Edge will not include authorization headers obtained
from previous 401/407 exchange in registration refresh messages.
Required? false
Position? 28
Default value 1
Accept pipeline input? false
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>
RELATED LINKS
SYNOPSIS
This cmdlet creates a new host/domain in existing sipserver table
SYNTAX
New-UxSipServerEntry [[-uxSession] <PSObject>] [-SipServerTableId] <Int32> [[-ServerLookup] <Int32>]
[[-ServerType] <Int32>] [[-Weight] <Int32>] [-Hostname] <String> [[-HostIpVersion] <Int32>] [[-DomainName]
<String>] [[-ServiceName] <String>] [[-Port] <Int32>] [[-TransportSocket] <Int32>] [[-ReuseTransport] <Int32>]
[[-ReuseTimeout] <Int32>] [-Protocol] <Int32> [[-Monitor] <Int32>] [[-KeepAliveFrequency] <Int32>]
[[-RecoverFrequency] <Int32>] [[-LocalUserName] <String>] [[-PeerUserName] <String>] [-Priority] <Int32>
[[-RemoteAuthorizationTableID] <Int32>] [[-ContactRegistrantTableID] <Int32>] [[-StaggerRegistration] <Int32>]
[[-ClearRemoteRegistrationOnStartup] <Int32>] [[-SessionURIValidation] <Int32>] [[-ContactURIRandomizer] <Int32>]
[[-RetryNonStaleNonce] <Int32>] [[-TLSProfileID] <Int32>] [[-AuthorizationOnRefresh] <Int32>] [-WhatIf] [-Confirm]
[<CommonParameters>]
DESCRIPTION
This cmdlet creates a new host in an existing sipserver table.You need to specify the sipserver table where these
transformation entries should be created.
PARAMETERS
-uxSession <PSObject>
If using multiple servers you will need to pass the uxSession Object created by connect-uxGateway
Else it will look for the last created session using the command above
Required? false
Position? 29
Default value
Accept pipeline input? false
Accept wildcard characters? false
-SipServerTableId <Int32>
Enter here the SIPServer ID of the sipserver table where you want to add a new host entry. This can be
extracted using "get-uxsipservertable" cmdlet
Required? true
Position? 1
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-ServerLookup <Int32>
Enter here the SIPServer ID of the sipserver table where you want to add a new host entry. This can be
extracted using "get-uxsipservertable" cmdlet
Required? false
Position? 2
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-ServerType <Int32>
Specifies the method to use to lookup SIP servers eConventionalSrvr
Required? false
Position? 3
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-Weight <Int32>
Specifies the weight of the server in case it's defined in the SRV record.
Required? false
Position? 4
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-Hostname <String>
Specifies the IP address or FQDN where this Signaling Group sends SIP messages. If an FQDN is configured all
the associated servers are included and used according to the server selection configuration element.
Required? true
Position? 5
Default value
Accept pipeline input? false
Accept wildcard characters? false
-HostIpVersion <Int32>
Enter here the code (integer) of the Field you want to add, eg:If you want to add "CalledNumber" add 0. Full
information on which codes maps to which field please refer http://bit.ly/Iy7JQS
Required? false
Position? 6
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-DomainName <String>
Specifies the Domain where this Signaling Group sends SRV queries.
Required? false
Position? 7
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ServiceName <String>
The name of the service to be placed in the SRV request.
Required? false
Position? 8
Default value sip
Accept pipeline input? false
Accept wildcard characters? false
-Port <Int32>
Enter here the output of the Input value.eg: If you want to change input of "^(2([45]\\d{2}|6[0-5]\\d))$" to
+44123456XXXX, you would enter here +44123456\\1
Required? false
Position? 9
Default value 5060
Accept pipeline input? false
Accept wildcard characters? false
-TransportSocket <Int32>
Enter here if the Transformation entry you will create will be Mandatory(0) or Optional(1). If this parameter
is not specified the transformation table will be created as Optional
Required? false
Position? 10
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-ReuseTransport <Int32>
Enter here if the Transformation entry you will create will be Mandatory(0) or Optional(1). If this parameter
is not specified the transformation table will be created as Optional
Required? false
Position? 11
Default value 1
Accept pipeline input? false
Accept wildcard characters? false
-ReuseTimeout <Int32>
Enter here if the Transformation entry you will create will be Mandatory(0) or Optional(1). If this parameter
is not specified the transformation table will be created as Optional
Required? false
Position? 12
Default value 1000
Accept pipeline input? false
Accept wildcard characters? false
-Protocol <Int32>
Enter here the Description (Name) of the Transformation entry. This is what will be displayed in the Ribbon GUI
Required? true
Position? 13
Default value 1
Accept pipeline input? false
Accept wildcard characters? false
-Monitor <Int32>
Specifies the method to monitor server None
- no monitoring of this server occurs
SIP options
- an Options message is sent to the server
Required? false
Position? 14
Default value 1
Accept pipeline input? false
Accept wildcard characters? false
-KeepAliveFrequency <Int32>
Enter here if the Transformation entry you will create will be Mandatory(0) or Optional(1). If this parameter
is not specified the transformation table will be created as Optional
Required? false
Position? 15
Default value 30
Accept pipeline input? false
Accept wildcard characters? false
-RecoverFrequency <Int32>
Enter here if the Transformation entry you will create will be Mandatory(0) or Optional(1). If this parameter
is not specified the transformation table will be created as Optional
Required? false
Position? 16
Default value 5
Accept pipeline input? false
Accept wildcard characters? false
-LocalUserName <String>
Enter here if the Transformation entry you will create will be Mandatory(0) or Optional(1). If this parameter
is not specified the transformation table will be created as Optional
Required? false
Position? 17
Default value Anonymous
Accept pipeline input? false
Accept wildcard characters? false
-PeerUserName <String>
Enter here if the Transformation entry you will create will be Mandatory(0) or Optional(1). If this parameter
is not specified the transformation table will be created as Optional
Required? false
Position? 18
Default value Anonymous
Accept pipeline input? false
Accept wildcard characters? false
-Priority <Int32>
Enter here the code (integer) of the Field you want to add, eg:If you want to add "CalledNumber" add 0. Full
information on which codes maps to which field please refer http://bit.ly/Iy7JQS
Required? true
Position? 19
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-RemoteAuthorizationTableID <Int32>
Specifies a Remote Authorization table for this SIP Server, from a list of authorization tables defined in the
Remote Authorization Tables. The Remote Authorization table is used by a Signaling group when a challenge
(401/407) is issued by the server. The table contains a realm, user name, and password. There are used to
provide credentials to he server issuing the challenge.
Required? false
Position? 20
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-ContactRegistrantTableID <Int32>
Specifies a Contact Registration Table for this SIP Server,from a list of registration tables defined in the
Contact Registrant Tables. The Contact Registration is used by a Signaling Group to register one or more
contacts to a registrar. The contact information contains the SIP address of record and the methods which can
be used to establish sessions to this Signaling group.
Required? false
Position? 21
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-StaggerRegistration <Int32>
If more than one Contact Registrant Entry is in Contact table, stagger Register Requests by 1 second. Applies
to UnRegister also. This will only be displayed and applicble if Contact Registract Table is something other
than None.
Required? false
Position? 22
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-ClearRemoteRegistrationOnStartup <Int32>
When enabled, a Register with Expires: 0 will be sent to the SIP Server on power up. After the Unregister
(Expires: 0) is complete, a Register (Expires: non-zero) will then be sent.
Required? false
Position? 23
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-SessionURIValidation <Int32>
Enter here if the Transformation entry you will create will be Mandatory(0) or Optional(1). If this parameter
is not specified the transformation table will be created as Optional
Required? false
Position? 24
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-ContactURIRandomizer <Int32>
If enabled, the following will occur: -Random user values will be generated and put into the Contact-URI of
each outgoing Register message. -The random user portion will be saved and compared to incoming Invite
Request-Uri's. If the prefix of the R-URI contains SBCxxxx, then if there is a match, SBCxxxx will be stripped
and the remaining number used to route (if no match, Invite is not accepted). If there is no SBCxxxx in R-URI,
then the number is sent as-is for routing.
Required? false
Position? 25
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-RetryNonStaleNonce <Int32>
This value will only be visible if Remote Authorization Table are defined in SIP Server. When true, if
stale=false is received in 401/407, the SBC Edge will set failed retry timer and re-attempt to send Register
with same credentials at expiration. When false, if stale=false is received in 401/407, the SBC Edge will
never resend a challenged request with the same credentials.(this is RFC behavior)
Required? false
Position? 26
Default value 1
Accept pipeline input? false
Accept wildcard characters? false
-TLSProfileID <Int32>
If TLS is selected this specifies the TLS profile this server will use for secure SIP messages.
This option is available if Protocol is set to TLS.
Required? false
Position? 27
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-AuthorizationOnRefresh <Int32>
This value will only be visible if both Contact Registrant Table and Remote Authorization Table are defined in
SIP Server. When true, the SBC Edge will include authorization headers obtained from previous 401/407 exchange
in registration refresh messages. When false, the SBC Edge will not include authorization headers obtained
from previous 401/407 exchange in registration refresh messages.
Required? false
Position? 28
Default value 1
Accept pipeline input? false
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>
RELATED LINKS