Difference between revisions of "Resource Groups"
(23 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
+ | Click Here to return to the main Screen: '''[[Routing |Back]]''' | ||
− | + | The Resource Group defines the status, direction, translations and other technical parameters needed to identify a carrier in the network. A carrier can have one or more incoming and/or outgoing resource groups. If a carrier is used as for both inbound and outbound traffic, a resource group will need to be defined for each direction. To edit a row, click on the yellow pencil to the left of the row. For other operations, click the appropriate button after selecting the row with a checkbox. | |
− | |||
− | |||
− | The Resource Group defines the status, direction, translations and other technical parameters needed to identify a carrier in the network. A carrier can have one or more incoming and/or outgoing resource groups. If a carrier is used as for both inbound and outbound traffic, a resource group will need to be defined for each direction. | ||
Line 25: | Line 23: | ||
* General | * General | ||
− | ** Id: This is the number that identifies the | + | ** Id: This is the number that identifies the carrier's RG. |
** Description: This field describes the Resource Group. It can tell, for example, the carrier that is associated with the RG, the purpose of the RG and the circuit direction. | ** Description: This field describes the Resource Group. It can tell, for example, the carrier that is associated with the RG, the purpose of the RG and the circuit direction. | ||
** Admin Status: This field tells if the RG is active or not. | ** Admin Status: This field tells if the RG is active or not. | ||
** CIR Direction: This field tells the circuit direction, IN, OUT, IN + OUT. | ** CIR Direction: This field tells the circuit direction, IN, OUT, IN + OUT. | ||
** SIP Proxy - For inbound calls this is the proxy instance being used for handling this call | ** SIP Proxy - For inbound calls this is the proxy instance being used for handling this call | ||
− | ** Proxy Address - This is the listening address that will be used by the SIP Proxy instance for inbound calls. | + | ** Proxy Address - This is the listening address that will be used by the SIP Proxy instance for inbound calls. This address is used in the sky_cli db to index what IPs are available for matching inbound calls. This should match the IP:port in proxy.cfg for route[AUTHENTICATE_IN] |
− | ** Call Count - this is the maximum calls that will be allowed in or out (depending on circuit direction). A | + | |
+ | ** Call Count - this is the maximum calls that will be allowed in or out (depending on circuit direction). A '0' call count means unlimited amount of simultaneous calls. | ||
* IP | * IP | ||
** IP Address, Netmask, Port. | ** IP Address, Netmask, Port. | ||
− | *** For inbound RGs this is the IP address, netmask, and port of the inbound traffic. A | + | *** For inbound RGs this is the IP address, netmask, and port of the inbound traffic. A '0' in the Port means that you process calls from any port. |
− | *** For outbound RGs this | + | *** For outbound RGs this field isn't used currently for outbound. The call is routed out through the Proxy IP address, which will in turn use the gateway table to lookup the final destination address. |
* Partitions | * Partitions | ||
Line 42: | Line 41: | ||
** Pre Translation: This field defines the Called Pre Translation table if required. | ** Pre Translation: This field defines the Called Pre Translation table if required. | ||
** ANI Pre Translation: This field defines the Calling Pre Translation table if required. | ** ANI Pre Translation: This field defines the Calling Pre Translation table if required. | ||
− | ** Post Translation: This field is mandatory for all outbound resource groups | + | ** Post Translation: This field is mandatory for all outbound resource groups. |
** ANI Post Translation: This field defines the Calling Post Translation table if required. | ** ANI Post Translation: This field defines the Calling Post Translation table if required. | ||
Line 48: | Line 47: | ||
− | * | + | * IP |
+ | ** IP Address: In general this is a string field that can be populated by a an alphanumeric string representing the domain or the IP of the equipment you're connecting to. | ||
+ | *** When the Resource Group direction is inbound only or two way: This field should define the IP address of the carrier's SIP server. | ||
+ | *** When the Resource Group direction is outbound only: When you want to route outbound calls through the Sky Proxy and do outbound translations, this should point to the outbound proxy. However, if this Resource Group is being directly terminated to (route type = resource group) and this Resource Group is outbound only then Sky DANCE will try to directly terminate (without using the Sky proxy) to this IP. Special note on setting transport: If this IP is of the format <IP>:<port>;transport=<transport list> then this will be used to set the port and transport of the outbound call. This can be used for example to terminate to an external gateway using TCP or TLS - example: 54.164.171.221:5061;transport=tcp would terminate the call to that IP using tcp. | ||
+ | *** When the Resource Group is used as a Registration gateway (via the Registration Gateway Type - see below): this field can be left blank or as 0.0.0.0. Sky DANCE will populate this field when the remote SIP gateway is authenticated. | ||
+ | *** When the Resource Group is used to terminate to a Sky PBX gateway (gateway's are setup and available in Sky PBX): Setting the resource group to terminate to a gateway requires adding the +REGGW flag in the Custom Flags field. Then in the Gateway setup you will use the resource group number as the gateway name. | ||
+ | ** Netmask: This field defines Netmask which should be used to match the remote SIP gateway IP. | ||
+ | ** Port: This field defines the SIP gateway port which should be used for SIP communication between SIP gateway and Sky DANCE. | ||
+ | |||
+ | * Registration Gateway | ||
+ | ** Registration Gateway Type: Use this pull down list to select if Sky DANCE should be enabled as Registration Server. If so, Registration User ID and Registration User Password field should be populated, and IP Address and Port field for this Resource Group can be left blank. Once the remote gateway registers with Sky DANCE, Sky Proxy will have the remote gateway IP Address and Port fields updated. Before the first SIP REGISTER message comes into Sky DANCE, IP Address field will be shown as 0.0.0.0. | ||
+ | ** Registration User ID: Sky DANCE will use User ID in the SIP REGISTER message to locate the Resource Group which the remote SIP gateway belongs to. | ||
+ | ** Registration Password: Used to authenticate the remote SIP gateway. | ||
+ | |||
+ | * Modifiers | ||
** Flag Pound: Select one of three options, LEAVE_POUND (the DNI is not modified), ADD_POUND and REM_POUND (remove pound). | ** Flag Pound: Select one of three options, LEAVE_POUND (the DNI is not modified), ADD_POUND and REM_POUND (remove pound). | ||
** Pass - pass RTP through the SBC | ** Pass - pass RTP through the SBC | ||
Line 57: | Line 70: | ||
** Forced Codec - only use the first codec in the preferred codec list | ** Forced Codec - only use the first codec in the preferred codec list | ||
** Preferred Codec - select the codec preferred. Put this at the top of the list. | ** Preferred Codec - select the codec preferred. Put this at the top of the list. | ||
− | |||
** Custom Flags - application specific | ** Custom Flags - application specific | ||
Line 63: | Line 75: | ||
− | # Click | + | # Click Add to create a new Resource Group. The following window will appear: |
− | <center>[[Image:]]</center> | + | <center>[[Image:Add_Resource_Group.png]]</center> |
− | <center>' | + | <center>'Resource Group Addition Window.''</center> |
# Select an available ID. The available IDs will appear as you type one. | # Select an available ID. The available IDs will appear as you type one. | ||
− | |||
# Type the description of the Resource Group if required. | # Type the description of the Resource Group if required. | ||
− | |||
# Select the Administration Status, Circuit Direction and Device Driver. | # Select the Administration Status, Circuit Direction and Device Driver. | ||
− | + | # Depending on the RG type (client (inbound) or provider (outbound)), enter the Calling Pre Translation and Called Pre Translation, Calling Post Translation table numbers if required. | |
− | # Depending on the RG type (client or provider), enter the Calling Pre Translation and Called Pre Translation, Calling Post Translation table numbers if required. | ||
− | |||
# Enter the Called Translation table number. | # Enter the Called Translation table number. | ||
− | |||
# Enter the Called Post Translation number for RG Out. | # Enter the Called Post Translation number for RG Out. | ||
− | |||
# Configure the IP address depending on the type of RG. | # Configure the IP address depending on the type of RG. | ||
− | + | #* For inbound RGs this is the IP address, netmask, and port of the inbound traffic. A â0â in the Port means that you process calls from any port. | |
+ | #* For outbound RGs this should be the Sky Dance proxy's IP address as setup in the SIP Proxy table. | ||
# Define the Call Count, the Flag Pound, and the other modifiers. | # Define the Call Count, the Flag Pound, and the other modifiers. | ||
+ | # Click Save to confirm the addition or Cancel to discard them. | ||
− | + | To delete an existing Resource Group select the check box and click Delete. A confirmation window will appear. Click Yes to confirm the deletion or No to cancel it. | |
− | |||
− | To delete an existing Resource Group select the check box and click | ||
To edit an existing Resource Group select the check box next to the Resource Group you want to edit. The Resource Group window will open for that carrier. Edit and save the changes. | To edit an existing Resource Group select the check box next to the Resource Group you want to edit. The Resource Group window will open for that carrier. Edit and save the changes. |
Latest revision as of 08:31, 4 August 2022
Click Here to return to the main Screen: Back
The Resource Group defines the status, direction, translations and other technical parameters needed to identify a carrier in the network. A carrier can have one or more incoming and/or outgoing resource groups. If a carrier is used as for both inbound and outbound traffic, a resource group will need to be defined for each direction. To edit a row, click on the yellow pencil to the left of the row. For other operations, click the appropriate button after selecting the row with a checkbox.
Figure 24 displays the details of a specific RG.
Following is a description of this window:
- General
- Id: This is the number that identifies the carrier's RG.
- Description: This field describes the Resource Group. It can tell, for example, the carrier that is associated with the RG, the purpose of the RG and the circuit direction.
- Admin Status: This field tells if the RG is active or not.
- CIR Direction: This field tells the circuit direction, IN, OUT, IN + OUT.
- SIP Proxy - For inbound calls this is the proxy instance being used for handling this call
- Proxy Address - This is the listening address that will be used by the SIP Proxy instance for inbound calls. This address is used in the sky_cli db to index what IPs are available for matching inbound calls. This should match the IP:port in proxy.cfg for route[AUTHENTICATE_IN]
- Call Count - this is the maximum calls that will be allowed in or out (depending on circuit direction). A '0' call count means unlimited amount of simultaneous calls.
- IP
- IP Address, Netmask, Port.
- For inbound RGs this is the IP address, netmask, and port of the inbound traffic. A '0' in the Port means that you process calls from any port.
- For outbound RGs this field isn't used currently for outbound. The call is routed out through the Proxy IP address, which will in turn use the gateway table to lookup the final destination address.
- IP Address, Netmask, Port.
- Partitions
- Partition: This field defines the Called Translation partition.
- Pre Translation: This field defines the Called Pre Translation table if required.
- ANI Pre Translation: This field defines the Calling Pre Translation table if required.
- Post Translation: This field is mandatory for all outbound resource groups.
- ANI Post Translation: This field defines the Calling Post Translation table if required.
The fields Pre Translation and ANI Pre Translation are used when the RG is used as RG In (client). The fields Post Translation and ANI Post Translation are used when the RG is used as RG Out (provider).
- IP
- IP Address: In general this is a string field that can be populated by a an alphanumeric string representing the domain or the IP of the equipment you're connecting to.
- When the Resource Group direction is inbound only or two way: This field should define the IP address of the carrier's SIP server.
- When the Resource Group direction is outbound only: When you want to route outbound calls through the Sky Proxy and do outbound translations, this should point to the outbound proxy. However, if this Resource Group is being directly terminated to (route type = resource group) and this Resource Group is outbound only then Sky DANCE will try to directly terminate (without using the Sky proxy) to this IP. Special note on setting transport: If this IP is of the format <IP>:<port>;transport=<transport list> then this will be used to set the port and transport of the outbound call. This can be used for example to terminate to an external gateway using TCP or TLS - example: 54.164.171.221:5061;transport=tcp would terminate the call to that IP using tcp.
- When the Resource Group is used as a Registration gateway (via the Registration Gateway Type - see below): this field can be left blank or as 0.0.0.0. Sky DANCE will populate this field when the remote SIP gateway is authenticated.
- When the Resource Group is used to terminate to a Sky PBX gateway (gateway's are setup and available in Sky PBX): Setting the resource group to terminate to a gateway requires adding the +REGGW flag in the Custom Flags field. Then in the Gateway setup you will use the resource group number as the gateway name.
- Netmask: This field defines Netmask which should be used to match the remote SIP gateway IP.
- Port: This field defines the SIP gateway port which should be used for SIP communication between SIP gateway and Sky DANCE.
- IP Address: In general this is a string field that can be populated by a an alphanumeric string representing the domain or the IP of the equipment you're connecting to.
- Registration Gateway
- Registration Gateway Type: Use this pull down list to select if Sky DANCE should be enabled as Registration Server. If so, Registration User ID and Registration User Password field should be populated, and IP Address and Port field for this Resource Group can be left blank. Once the remote gateway registers with Sky DANCE, Sky Proxy will have the remote gateway IP Address and Port fields updated. Before the first SIP REGISTER message comes into Sky DANCE, IP Address field will be shown as 0.0.0.0.
- Registration User ID: Sky DANCE will use User ID in the SIP REGISTER message to locate the Resource Group which the remote SIP gateway belongs to.
- Registration Password: Used to authenticate the remote SIP gateway.
- Modifiers
- Flag Pound: Select one of three options, LEAVE_POUND (the DNI is not modified), ADD_POUND and REM_POUND (remove pound).
- Pass - pass RTP through the SBC
- Spoof - used for far end NAT traversal
- Ringback - provide artificial ringback from the switch
- Clear Max Forward
- Forced Codec - only use the first codec in the preferred codec list
- Preferred Codec - select the codec preferred. Put this at the top of the list.
- Custom Flags - application specific
To add a new Resource Group:
- Click Add to create a new Resource Group. The following window will appear:
- Select an available ID. The available IDs will appear as you type one.
- Type the description of the Resource Group if required.
- Select the Administration Status, Circuit Direction and Device Driver.
- Depending on the RG type (client (inbound) or provider (outbound)), enter the Calling Pre Translation and Called Pre Translation, Calling Post Translation table numbers if required.
- Enter the Called Translation table number.
- Enter the Called Post Translation number for RG Out.
- Configure the IP address depending on the type of RG.
- For inbound RGs this is the IP address, netmask, and port of the inbound traffic. A â0â in the Port means that you process calls from any port.
- For outbound RGs this should be the Sky Dance proxy's IP address as setup in the SIP Proxy table.
- Define the Call Count, the Flag Pound, and the other modifiers.
- Click Save to confirm the addition or Cancel to discard them.
To delete an existing Resource Group select the check box and click Delete. A confirmation window will appear. Click Yes to confirm the deletion or No to cancel it.
To edit an existing Resource Group select the check box next to the Resource Group you want to edit. The Resource Group window will open for that carrier. Edit and save the changes.