configure_tsan.py

Use the configure_tsan.py script to add or remove a range of TSAN (Temporary Service Access Number) telephony numbers from the MATRIXX database or generate a list of all the TSANs in the database. In addition to populating the TSANs in the database, the script creates an entry in the Route Cache for each TSAN.

Run the configure_tsan.py script as the mtx user on only one processing server on only the active engine (because memory is shared across processing servers, the same TSAN ranges are populated on each server in the engine). When removing TSANs, the range of TSANs that you specify must exist on the engine. If you are using sub-domains in your MATRIXX environment, you must populate a unique range of TSANs per sub-domain.

Syntax

configure_tsan.py [-h] [-H URI] –-addRemoveList=add|remove|list [--prefix=prefix_number] [--startRange=start_number] [--endRange=end_number] [--maxTsans=max] [--force=0|1] [-–verbose=0|1]

Options

The configure_tsan.py script has the following options:

-h, --help

Show help about the script options.

-H=URI, --host=URI

The MDC Gateway server to connect to. This option specifies the host name, host:port, or IP address of the processing server on which to run the configuration script. The value defaults to the current server.

--addRemoveList=add|remove|list

Specifies whether to add or remove a range of TSANs or to list all the TSANs in the database.

--prefix=prefix_number

When adding TSANs, the prefix_number specifies an optional TSAN telephone number prefix that is prefixed to each number in the TSAN range. The prefix can contain up to 13 digits and use a combination of only the following digits and letters: 0–9, a-e.

When you are removing a range of TSANs, if a prefix was used to add the TSANs, you must specify the same prefix when removing them. You can omit the prefix option when removing TSANS only if this option was not used to add the TSANs.

--startRange=start_number

The start_number specifies the start of the TSAN number range. You must specify a positive integer that is equal to or greater than 1 and uses a maximum of 15 digits. You can include only digits in the range 0–9. This value is set to 10000 by default.

Note: If you are adding TSANs, the total range of provisioned numbers is: endRange - startRange.

--endRange=end_number

The end_number specifies the end of the TSAN number range. You must specify a positive integer that is equal to or greater than the startRange value and uses a maximum of 15 digits. You can include only digits in the range 0–9. This value is set to 20000 by default.

Note: The difference between the startRange value and the endRange value must be equal to or less than the value of maxTsans.

--maxTsans=max

Specifies the maximum number of TSANs allowed in the database. This value defaults to 10000. The value of max must match the value specified when answering the following create_config.py question:

Camel Gateway:How many tsan objects do you want to support?

Note: When adding TSANs, the script exits if the specified maximum is exceeded.

--force=0|1

When removing a range of TSANs, this option determines whether to force the removal of a TSAN object that is in use. If this value is set to:

0 - The TSAN object is not removed.
1 - It forces the removal of the TSAN object.

When removing a range of TSANs, first run the script without using the --force option. If the script tries to remove a TSAN object that is in use, the TSAN object is set to invalid so that it cannot be reused after the current call is completed. When you rerun the script, the invalid TSAN object is removed.

Note: When you are removing a range of TSANs, run the script with the --force option set to 1 only if earlier attempts to remove a TSAN object failed. Forcibly removing TSAN objects could cause calls to be lost.

--verbose=0|1

Enables or disables verbose mode. This value is et to 1 to enable verbose mode.