Oracle Communications Network Charging and Control

Transcription

1 Oracle Communications Network Charging and Control Product: OCNCC 4.3 Component: PI Commands (VPN) S ware version: Release Guide version: Release date: December 2010 Status: Approved

2 Commercial In Confidence Copyright PI Commands (VPN), Release Copyright 2010, Oracle and/or its affiliates. All rights reserved. This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited. The information contained herein is subject to change without notice and is not warranted to be error-free. If you find any errors, please report them to us in writing. If this software or related documentation is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, the following notice is applicable: U.S. GOVERNMENT RIGHTS Programs, software, databases, and related documentation and technical data delivered to U.S. Government customers are "commercial computer software" or "commercial technical data" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, the use, duplication, disclosure, modification, and adaptation shall be subject to the restrictions and license terms set forth in the applicable Government contract, and, to the extent applicable by the terms of the Government contract, the additional rights set forth in FAR , Commercial Computer Software License (December 2007). Oracle USA, Inc., 500 Oracle Parkway, Redwood City, CA This software is developed for general use in a variety of information management applications. It is not developed or intended for use in any inherently dangerous applications, including applications which may create a risk of personal injury. If you use this software in dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure the safe use of this software. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software in dangerous applications. Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners. This software and documentation may provide access to or information on content, products, and services from third parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party content, products, and services. Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third-party content, products, or services. Page ii PI Commands (VPN)

3 Commercial In Confidence Contents Chapter 1 Chapter 2 Chapter 3 Chapter 4 Chapter 5 Chapter 6 Copyright... Error! Bookmark not defined. About this Document... v Document Conventions... vi PI Commands Overview Overview... 1 Command List... 2 VPN Network Overview... 3 Add a Network... 4 Change a VPN Network Details... 8 Delete a VPN Network Query a VPN Network Network White List Numbers Overview Add Network White List Numbers Delete Network White List Numbers Query Network White List Numbers Network Speed Dial Number Overview Add a Network Speed Dial Number Change a Network Speed Dial Number Delete a Network Speed Dial Number Query Network Speed Dial Numbers VPN Station Overview Add a VPN Station Change a VPN Station Details Delete a VPN Station Query a VPN Station VPN Station White List Overview Add a VPN Station White List Change a VPN Station Restriction Details Delete a VPN Station White List Query a Station White List Continued on next page PI Commands (VPN) Page iii

4 Commercial In Confidence Chapter 7 Chapter 8 Chapter 9 VPN Station Hunting List Overview Add a VPN Station Hunting List Change a VPN Station Hunting List Delete a VPN Station Hunting List Query a VPN Station Hunting List VPN Hunting List Plan Tariff Chapter 10 Overview Add a VPN Station Hunting List Plan Change a VPN Station Hunting List Plan Delete a VPN Station Hunting List Plan Query a VPN Station Hunting List Plan Overview Add a VPN Wide Default Tariff Change the Tariff for all VPN Stations in a Network Error Code Lists Overview PI Chassis Errors PI Command Errors Appendix Overview Glossary of Terms Index Page iv PI Commands (VPN)

5 Commercial In Confidence About this Document Scope Audience Pre-requisites Related documents The scope of this document includes all the information required to configure the VPN PI commands. The audience for this document includes system administrators responsible for the monitoring, maintenance, and configuration of the Oracle IN applications. A solid understanding of UNIX and a familiarity with IN concepts are an essential pre-requisite for safely using the information contained in this technical guide. Although it is not a pre-requisite to using this guide, familiarity with the target platform would be an advantage. This manual describes system tasks that should only be carried out by suitably trained operators. The following documents are related to this document: PI Technical Guide VPN User's Guide PI Commands (VPN) Page v

6 Commercial In Confidence Document Conventions Typographical conventions Before you start using this guide, it is important to understand the terms and typographical conventions used in the documentation. Specialised terms and acronyms are defined in the Glossary at the end of this guide. Formatting convention Special Bold Italics Button Key+Key Monospace variable menu option > menu option > hypertext link Type of information Items you must select such as menu options, or names of tabs. Emphasis within text. Names of database tables and fields. Name of a document, chapter, topic or other publication. The name of a button to click or a key to press. To close the window, either click Close or press Esc. Key combinations for which the user must press and hold down one key and then press another. Ctrl+P, or Alt+F4. Text that you must type and examples of code or standard output. Used to indicate variables or text that should be replaced. Used to indicate the cascading menu option to be selected, or the location path of a file. Operator Functions > Report Functions /IN/html/SMS/Helptext/ Used to indicate a hypertext link on an HTML page. Icons The following icons are used as visual cues to draw attention to important information. Note: Indicates useful and complementary information. Explanation, comment, or short expansion of the text object that is intended to catch your attention. Tip: Indicates practical but non-essential information that makes the solution easier to use or operate (e.g. keyboard shortcut, alternative way to perform a step in a procedure, etc). Warning: Indicates a caution. If this information is ignored, it could cause possible and irreversible damage to the equipment, data or software. Page vi PI Commands (VPN)

7 Commercial In Confidence Chapter 1 PI Commands Overview Overview Introduction In this chapter The provisioning interface uses TCP/IP-based UNIX sockets to receive provisioning commands and. These are translated into SQL commands that update pre-paid application tables of the SMF and BE Oracle databases. This chapter defines the rules and packages required that translate the provisioning commands into SQL commands. This chapter contains the following topics. Command List... 2 PI Commands (VPN) Page 1

8 Chapter 1 Commercial In Confidence Command List Command list The following table lists the available PI commands for provisioning VPN information on the USMS. To use the commands they must have been installed with the pivpnsms package. Function Add a VPN wide default tariff Add a VPN network Modify a VPN network Delete a VPN network Query a VPN network Add a white list number Delete a white list number Query a white list number Add a network speed dial number Change a network speed dial number Delete a network speed dial number Query a network speed dial number Add a VPN station Change a VPN station Delete a VPN station Query a VPN station Add a VPN station white list Change a VPN station white list Delete a VPN station white list Query a VPN station white list Add a VPN station hunting list Change a VPN station hunting list Delete a VPN station hunting list Query a VPN station hunting list Add a VPN station hunting list plan Change a VPN station hunting list plan Delete a VPN station hunting list plan Query a VPN station hunting list plan Change the tariff for all VPN stations on a network Command VPNCU1=ADD VPNNW1=ADD VPNNW1=CHG VPNNW1=DEL VPNNW1=QRY VPNNW2=ADD VPNNW2=DEL VPNNW2=QRY VPNNW3=ADD VPNNW3=CHG VPNNW3=DEL VPNNW3=QRY VPNST1=ADD VPNST1=CHG VPNST1=DEL VPNST1=QRY VPNST2=ADD VPNST2=CHG VPNST2=DEL VPNST2=QRY VPNST5=ADD VPNST5=CHG VPNST5=DEL VPNST5=QRY VPNST6=ADD VPNST6=CHG VPNST6=DEL VPNST6=QRY VPNST7=CHG Page 2 PI Commands (VPN)

9 Commercial In Confidence Chapter 2 VPN Network Overview Introduction In this chapter This chapter explains the VPN PI commands for provisioning VPN Networks. This chapter contains the following topics. Add a Network... 4 Change a VPN Network Details... 8 Delete a VPN Network Query a VPN Network PI Commands (VPN) Page 3

10 Chapter 2 Commercial In Confidence Add a Network Name Description Required VPNNW1=ADD Adds a new VPN Network definition. Here are the required for this command. NAME NAME=name Name of VPN Network. String NAME="VPNNW1" PROVIDER ORIGINATING Constraints: TERMINATING Constraints: MANAGEMENT Constraints: PROVIDER=sp Name of ACS service provider. String PROVIDER="Boss" ORIGINATING=origcp Originating ACS Call Plan. String Should exist in acs_call_plan and start VPN_ ORIGINATING="VPN_Originating" TERMINATING=termcp Terminating ACS Call Plan. String Should exist in acs_call_plan and start VPN_ TERMINATING="VPN_Terminating" MANAGEMENT=mancp Management ACS Call Plan. String Should exist in acs_call_plan and start VPN_ MANAGEMENT="VPN_Management" Continued on next page Page 4 PI Commands (VPN)

11 Commercial In Confidence Chapter 2 Add a Network, Continued Required (continued) SITE_CODE Constraints: SITE_CODE=scode A site code. 10 character string containing only the characters ABCD*# Note: * == B and is stored as B in the database # == C and is stored as C in the database Cannot be a sub or super string of an existing site code. SITE_CODE=" " Constraint required Optional This command accepts the following constraint required parameter. EXTLENGTH EXTLENGTH=len Extension Length for a station extension number. Number Default: 4 EXTLENGTH=4 This command accepts the following optional. PHYSRANGE PHYSRANGE=Y N Physical range needed? Y or N. Default: N PHYSRANGE=N COMMENTS COMMENTS=text Comment field. String COMMENTS="This is a comment" PRESENTONNETADDR PRESENTONNETADDR=Y N Present the on-net address? Y or N Default: N PRESENTONNETADDR=N Continued on next page PI Commands (VPN) Page 5

12 Chapter 2 Commercial In Confidence Add a Network, Continued Optional (continued) RESTRICTCLI Default: RESTRICTCLI=Y N Restrict CLI? Y or N N RESTRICTCLI=N ALLOWSHORTEXT Constraints: Default: ALOWSHORTEXT=Y N Allow station IDs with less than EXTLENGTH digits? Y or N If ALLOWSHORTEXT is specified, then EXTLENGTH must also be specified. Y ALLOWSHORTEXT=Y TARIFFNAME Note: TARIFFNAME=tariff name Default ACS tariff name to use. String Matches ACS_TARIFF_CODE TARIFFNAME="TR1" TAG Allowed: TAG=tag Profile tag(s) to alter. Profile tag name(s). Pre-defined name corresponding to PROFILE_TAG_NAME in the ACS_PROFILE_DETAILS table. Notes: Multiple tags should be separated by the pipe symbol. TAG=LANGUAGE Continued on next page Page 6 PI Commands (VPN)

13 Commercial In Confidence Chapter 2 Add a Network, Continued Optional (continued) VALUE VALUE=val The value of the tag(s). Profile tag value(s). The VALUE should match the type of the TAG specified, as defined in the ACS_PROFILE_DETAILS table. If.. VALUE format is... DATE YYYYMMDDHHMMSS BOOLEAN T (true) or F (false) INTEGER a decimal integer, maximum 4 bytes. BYTE a signed single byte as a decimal integer (- 128 to 127). PREFIX or OPREFIX, STRING the prefix tree data should be specified separated by the colon character. To specify a colon in the data, prefix it with a backslash (\:). To specify a backslash, use two backslashes together (\\). A single backslash will result in a badly formatted parameter error code 68. The maximum number of characters or digits for a single value is 255. If OPREFIX, the value data should be in the desired order. free-form text. NSTRING limited to the digits 0 to 9 For all types, the separator characters comma and pipe cannot be used. Notes: Multiple values should be separated by the pipe symbol and be in the same order as for TAG. VALUE=8 Logic and constraints Success return Error codes When creating a new VPN Network: NAME, PROVIDER, ORIGINATING, TERMINATING, and MANAGEMENT must be specified. An empty Blacklist will be created by default (i.e. no numbers barred) To specify more than one tag to update, the TAG parameter should contain the names of the tags separated by pipe symbols. The VALUE parameter should contain the values separated by pipe symbols in the same order as for TAG The TAG and VALUE must have the same number of items. VPNNW1=ADD:ACK[:NETID=vpn_network.id]; Error Codes: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 19, 20, and 20. See PI Command Errors (on page 78) for a description of error codes. PI Commands (VPN) Page 7

14 Chapter 2 Commercial In Confidence Change a VPN Network Details Name Description Required parameter Constraint required VPNNW1=CHG Changes the details associated with a VPN network. Here is the required parameter for this command. NAME NAME=name Name of VPN Network. String NAME="VPNNW1" This command accepts the following constraint required parameter. NEW_NAME NEW_NAME=name The new NAME for VPN Network. String Constraints: New name should not already exist. NEW_NAME="VPNNW2" PROVIDER ORIGINATING Constraints: TERMINATING Constraints: PROVIDER=sp Name of ACS service provider. String PROVIDER="Boss" ORIGINATING=origcp Originating ACS Call Plan. String Should exist in acs_call_plan and start VPN_ ORIGINATING="VPN_Originating" TERMINATING=termcp Terminating ACS Call Plan. String Should exist in acs_call_plan and start VPN_ TERMINATING="VPN_Terminating" Continued on next page Page 8 PI Commands (VPN)

15 Commercial In Confidence Chapter 2 Change a VPN Network Details, Continued Constraint required (continued) MANAGEMENT MANAGEMENT=mancp Management ACS Call Plan. String Constraints: Should exist in acs_call_plan and start VPN_ MANAGEMENT="VPN_Management" PHYSRANGE PHYSRANGE=Y N Physical range needed? Y or N. Default: N PHYSRANGE=N COMMENTS COMMENTS=text Comment field. String COMMENTS="This is a comment" PRESENTONNETADDR PRESENTONNETADDR=Y N Present the on-net address? Y or N Default: N PRESENTONNETADDR=N RESTRICTCLI Default: TARIFFNAME Note: RESTRICTCLI=Y N Restrict CLI? Y or N N RESTRICTCLI=N TARIFFNAME=tariff name Default ACS tariff name to use. String Matches ACS_TARIFF_CODE TARIFFNAME="TR1" Continued on next page PI Commands (VPN) Page 9

16 Chapter 2 Commercial In Confidence Change a VPN Network Details, Continued Constraint required (continued) SITE_CODE Constraints: SITE_CODE=scode A site code. 10 character string containing only the characters ABCD*# Note: * == B and is stored as B in the database # == C and is stored as C in the database Cannot be a sub or super string of an existing site code. SITE_CODE=" " Optional This command accepts the following optional. TAG TAG=tag Profile tag(s) to alter. Profile tag name(s). Allowed: Pre-defined name corresponding to PROFILE_TAG_NAME in the ACS_PROFILE_DETAILS table. Notes: Multiple tags should be separated by the pipe symbol. TAG=LANGUAGE Continued on next page Page 10 PI Commands (VPN)

17 Commercial In Confidence Chapter 2 Change a VPN Network Details, Continued Optional (continued) VALUE VALUE=val The value of the tag(s). Profile tag value(s). The VALUE should match the type of the TAG specified, as defined in the ACS_PROFILE_DETAILS table. If.. VALUE format is... DATE YYYYMMDDHHMMSS BOOLEAN T (true) or F (false) INTEGER a decimal integer, maximum 4 bytes. BYTE a signed single byte as a decimal integer (- 128 to 127). PREFIX or OPREFIX, STRING the prefix tree data should be specified separated by the colon character. To specify a colon in the data, prefix it with a backslash (\:). To specify a backslash, use two backslashes together (\\). A single backslash will result in a badly formatted parameter error code 68. The maximum number of characters or digits for a single value is 255. If OPREFIX, the value data should be in the desired order. free-form text. NSTRING limited to the digits 0 to 9 For all types, the separator characters comma and pipe cannot be used. Notes: Multiple values should be separated by the pipe symbol and be in the same order as for TAG. VALUE=8 Logic and constraints Success return Error codes NAME must exist At least one optional parameter should be specified. NEW_NAME should not already exist PROVIDER should exist in acs_customer.name The TAG and VALUE must have the same number of items To delete a TAG value, the TAG and VALUE should be specified with an empty VALUE. Examples: "TAG=to_delete,VALUE=", or "TAG=set_1 to_delete set_2,value=value_1 value_2" VPNNW1=CHG:ACK; Error codes: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 18, 19, 20, 21, 22, 23. See PI Command Errors (on page 78) for a description of error codes. PI Commands (VPN) Page 11

18 Chapter 2 Commercial In Confidence Delete a VPN Network Name Description Required parameter Constraint required Optional Logic and constraints Success return Error codes VPNNW1=DEL Delete a VPN Network and all stations defined for that network in vpn_station. Here is the required parameter for this command. NAME NAME=name Name of VPN Network. String NAME="VPNNW1" There are no constraint required. There are no optional. NAME must exist. VPNNW1=DEL:ACK; if the network has stations defined. VPNNW1=DEL:ACK:0; if no stations defined for network. Error codes: 1, 19, and 20. See PI Command Errors (on page 78) for a description of error codes. Page 12 PI Commands (VPN)

19 Commercial In Confidence Chapter 2 Query a VPN Network Name Description Required Constraint required VPNNW1=QRY Query a VPN network's details. This command has no required. This command accepts the following constraint required parameter. NAME NAME=name Name of VPN Network. String NAME="VPNNW1" LISTTYPE Allowed: Default: LISTTYPE=type The type of list to return. Valid values: Value Returns.. SHORT a list of network names only. LONG a list of network name (vpn_network.name), white list for each network name, speed dial numbers for each network name. DEFTARIFF the default tariff for that network TARIFF a list of ACS Tariffs used by the Network NAME. This is found by listing a distinct list of Tariffs from every station in the network, the network default, and the customer default. STATION a list of all stations on this network. SHORT LISTTYPE=SHORT Optional parameter This command accepts the following optional parameter. Continued on next page PI Commands (VPN) Page 13

20 Chapter 2 Commercial In Confidence Query a VPN Network, Continued Optional parameter (continued) TAG Allowed: TAG=tag Profile tag(s) to alter. Profile tag name(s). Pre-defined name corresponding to PROFILE_TAG_NAME in the ACS_PROFILE_DETAILS table. Notes: Multiple tags should be separated by the pipe symbol. TAG=LANGUAGE Logic and constraints Success return At least one optional parameter must be specified. NAME can be specified to retrieve a sub set of Network(s) information. If it is not specified then information for all networks are returned. To specify more than one tag to query, the tag parameter should contain the names of the tags separated by pipe symbols DATE values are returned as YYYYMMDDHHMMSS BOOLEAN values are returned as T (true) or F (false) INTEGER values are returned as the decimal integer unaltered BYTE values are returned as a decimal integer PREFIX and OPREFIX values are returned colon separated. Colons in the data are prefixed with a backslash (\:). Backslashes are returned as two backslashes together (\\) STRING and NSTRING values are returned unaltered VPNNW1=QRY:QRYNet:ACK[:][result 1...]; result n for LISTTYPE= SHORT: NETWORK[number]name:name[,tag 1=value 1,...,tag n=value n] LONG: NETWORK[number]name:name, whitelist numbers:number:..., speed dial numbers:number:...[,tag 1=value 1,...,tag n=value n] If no white list numbers are defined, "none defined" appears in place of the first number. DEFTARIFF: NETWORK[number]name:name, default tariff:tariff code[,tag 1=value 1,...,tag n=value n] TARIFF: Continued on next page Page 14 PI Commands (VPN)

21 Commercial In Confidence Chapter 2 Query a VPN Network, Continued Success return (continued) NETWORK[number]name:name, tariff(s) defined:tariff code:...[,tag 1=value 1,...,tag n=value n] If no tariffs are defined, "none defined" appears in place of the first tariff code. STATION: NETWORK[number]stations:station_name_1/physical_address_1:...:station_name_n/physical_address_1[,tag 1=value 1,...,tag n=value n] If no stations are defined, "none defined" appears in place of the first station. Error codes Error codes: 1, 2 3, 4, 19, 20, and 21 See PI Command Errors (on page 78) for a description of error codes. PI Commands (VPN) Page 15

22

23 Commercial In Confidence Chapter 3 Network White List Numbers Overview Introduction In this chapter This chapter explains the VPN PI commands for provisioning VPN Network White List Numbers. This chapter contains the following topics. Add Network White List Numbers Delete Network White List Numbers Query Network White List Numbers PI Commands (VPN) Page 17

24 Chapter 3 Commercial In Confidence Add Network White List Numbers Name Description Required VPNNW2=ADD Adds new white list numbers. Here are the required for this command. NAME NAME=name Name of VPN Network. String NAME="VPNNW1" NUMBER NUMBER=num Number(s) to add to, or delete from, list. Single number or colon separated list of numbers. NUMBER= Constraint required Optional Logic and constraints Success return Error codes There are no constraint required. There are no optional. When adding a white list number: NAME must exist, and NUMBER must be specified. If whitelist is not active for Network NAME, then blacklist will be deactivated, numbers in the blacklist deleted, and the whitelist made active with the number(s) supplied in NUMBER. VPNNW2=ADD:ACK[:number of whitelist numbers added]; Error codes: 1, 2, 19, and 20 See PI Command Errors (on page 78) for a description of error codes. Page 18 PI Commands (VPN)

25 Commercial In Confidence Chapter 3 Delete Network White List Numbers Name Description Required VPNNW2=DEL Deletes white list numbers from a specified VPN Network. Here are the required for this command. NAME NAME=name Name of VPN Network. String NAME="VPNNW1" NUMBER NUMBER=num Number(s) to add to, or delete from, list. Single number or colon separated list of numbers. NUMBER= Constraint required Optional Logic and constraints Success return Error codes There are no constraint required. There are no optional. When removing white list numbers NAME and NUMBER must exist. When deleting all numbers in white list, an empty blacklist will become active. This makes no numbers barred. If delete from white list is used when black list is active, the NUMBER does not exist for NAME error will be used. The NUMBER data must consist of 1 or more values, separated by : It is possible to specify ALL as the list of numbers which will indicate delete all numbers. VPNNW2=DEL:ACK[:number of whitelist numbers deleted]; Error codes: 1, 2, 3, 19, 20. See PI Command Errors (on page 78) for a description of error codes. PI Commands (VPN) Page 19

26 Chapter 3 Commercial In Confidence Query Network White List Numbers Name Description Required Constraint required Optional Logic and constraints Success return Error codes VPNNW2=QRY Queries white list numbersfor a specified VPN Network. Here are the required for this command. NAME NAME=name Name of VPN Network. String NAME="VPNNW1" There are no constraint required. There are no optional. When querying a white list number: NAME must exist. VPNNW2=QRY:ACK:NUMBER=number 1:number 2:...; The list of white list numbers will consist of a NUMBER tag with the data format of each number separated with a : It is possible for the NUMBER tag data to be zero length. Error codes: 1, 2, 19, 20 See PI Command Errors (on page 78) for a description of error codes. Page 20 PI Commands (VPN)

27 Commercial In Confidence Chapter 4 Network Speed Dial Number Overview Introduction In this chapter This chapter explains the VPN PI commands for provisioning VPN Network Speed Dial Numbers. This chapter contains the following topics. Add a Network Speed Dial Number Change a Network Speed Dial Number Delete a Network Speed Dial Number Query Network Speed Dial Numbers PI Commands (VPN) Page 21

28 Chapter 4 Commercial In Confidence Add a Network Speed Dial Number Name Description Required VPNNW3=ADD Adds a new speed dial number to a specified network. Here are the required for this command. NAME NAME=name Name of VPN Network. String NAME="VPNNW1" NUMBER NUMBER=num Number to add to the list. xxx:yyyyy:n where: xxx is the speed dial number yyyyy is the physical address for termination, and n is an On-net/Off-net indicator, where Y=On-net and N=Off-net. NUMBER= Y Constraint required Optional Logic and constraints Success return Error codes There are no constraint required. There are no optional. When adding a speed dial number: NAME must exist, and NUMBER must be specified. VPNNW3=ADD:ACK; Error codes: 1, 2, 19, 20. See PI Command Errors (on page 78) for a description of error codes. Page 22 PI Commands (VPN)

29 Commercial In Confidence Chapter 4 Change a Network Speed Dial Number Name Description Required VPNNW3=CHG Change a speed dial number for a specified network. Here are the required for this command. NAME NAME=name Name of VPN Network. String NAME="VPNNW1" NUMBER NEW_NUMBER NUMBER=num Number to change from speed dial list. xxx NUMBER=1 NEW_NUMBER=num New Number. xxx:yyyyy:n where: xxx is the speed dial number yyyyy is the physical address for termination, and n is an On-net/Off-net indicator, where Y=On-net and N=Off-net. NEW_NUMBER= Y Constraint required Optional Logic and constraints Success return Error codes There are no constraint required. There are no optional. When changing a speed dial number: NAME, NUMBER must exist, and NEW_NUMBER must not already exist. NUMBER should be a single existing speed dial number. VPNNW3=CHG:ACK; Error codes: 1, 2, 3, 18, 19, 20. See PI Command Errors (on page 78) for a description of error codes. PI Commands (VPN) Page 23

30 Chapter 4 Commercial In Confidence Delete a Network Speed Dial Number Name Description Required VPNNW3=DEL Delete a speed dial number from a specified network. Here are the required for this command. NAME NAME=name Name of VPN Network. String NAME="VPNNW1" NUMBER NUMBER=num Number(s) to delete from speed dial list. Colon separated list of numbers. NUMBER=1:2:3 Constraint required Optional Logic and constraints Success return Error codes There are no constraint required. There are no optional. NUMBER may be a colon separated list of speed dial numbers. VPNNW3=DEL:ACK[:number of speed dials deleted]; Error codes: 1, 2, 19, 20. See PI Command Errors (on page 78) for a description of error codes. Page 24 PI Commands (VPN)

31 Commercial In Confidence Chapter 4 Query Network Speed Dial Numbers Name Description Required Constraint required Optional Logic and constraints Success return VPNNW3=QRY Queries speed dial numbers for a specified network. Here are the required for this command. NAME NAME=name Name of VPN Network. String NAME="VPNNW1" There are no constraint required. There are no optional. NAME must be specified. VPNNW3=QRY:ACK[:list of speed dials]; The list of speed dial numbers will consist of NUMBER tags with the data format xxx:yyyyy:n where xxx is the speed dial number, yyyyy is the physical address for termination and n is an On-net/Off-net indicator where Y=On-net and N=Off-net. NUMBER=<number 1> <number 2>... An ACK may be returned with no NUMBER tags if no Speed dial numbers are defined for this network. Error codes Error codes: 1, 19, 20. See PI Command Errors (on page 78) for a description of error codes. PI Commands (VPN) Page 25

32

33 Commercial In Confidence Chapter 5 VPN Station Overview Introduction In this chapter This chapter explains the VPN PI commands for provisioning VPN Stations. This chapter contains the following topics. Add a VPN Station Change a VPN Station Details Delete a VPN Station Query a VPN Station PI Commands (VPN) Page 27

34 Chapter 5 Commercial In Confidence Add a VPN Station Name Description Required VPNST1=ADD Adds a new VPN Station definition. Here are the required for this command. NETNAME NETNAME=network name The name of the VPN Network. String NETNAME="Net1" STNNAME PHYSADDR STNNAME=station name The name of VPN Station. (Extension number field in VPN Screen). Extension number. STNNAME=123 PHYSADDR=msisdn The Physical Address, usually real MSISDN. MSISDN number. PHYSADDR= Constraint required Optional There are no constraint required. This command accepts the following optional. GVNSADDR GVNSADDR=gvns address The GVNS Address name. String GVNSADDR=" " VDDIADDR VDDIADDR=vddi address The VDDI Address. String VDDIADDR=" " Continued on next page Page 28 PI Commands (VPN)

35 Commercial In Confidence Chapter 5 Add a VPN Station, Continued Optional (continued) COMMENTS COMMENTS=text Comment field. String COMMENTS="This is a comment" OFFNET OFFNET=Y N Allow or deny off net calls. Y, or N. Default: Y OFFNET=Y INOFFNET INOFFNET=Y N Allow or deny all incoming calls from off net. Y, or N. INOFFNET=N TARIFFNAME Note: WHITELIST TARIFFNAME=tariff name Default ACS tariff name to use. String Matches ACS_TARIFF_CODE TARIFFNAME="TR1" WHITELIST=whitelist The numbers to add to, or delete from, the white list. Single number, or colon separated list of numbers. WHITELIST= : TAG Allowed: TAG=tag Profile tag(s) to alter. Profile tag name(s). Pre-defined name corresponding to PROFILE_TAG_NAME in the ACS_PROFILE_DETAILS table. Notes: Multiple tags should be separated by the pipe symbol. TAG=LANGUAGE Continued on next page PI Commands (VPN) Page 29

36 Chapter 5 Commercial In Confidence Add a VPN Station, Continued Optional (continued) VALUE VALUE=val The value of the tag(s). Profile tag value(s). The VALUE should match the type of the TAG specified, as defined in the ACS_PROFILE_DETAILS table. If.. VALUE format is... DATE YYYYMMDDHHMMSS BOOLEAN T (true) or F (false) INTEGER a decimal integer, maximum 4 bytes. BYTE a signed single byte as a decimal integer (- 128 to 127). PREFIX or OPREFIX, STRING the prefix tree data should be specified separated by the colon character. To specify a colon in the data, prefix it with a backslash (\:). To specify a backslash, use two backslashes together (\\). A single backslash will result in a badly formatted parameter error code 68. The maximum number of characters or digits for a single value is 255. If OPREFIX, the value data should be in the desired order. free-form text. NSTRING limited to the digits 0 to 9 For all types, the separator characters comma and pipe cannot be used. Notes: Multiple values should be separated by the pipe symbol and be in the same order as for TAG. VALUE=8 Logic and constraints The number of digits in the STNNAME must equal EXTLENGTH in the add network command (VPNNW1=ADD) if ALLOWSHORTEXT = N The number of digits in the STNNAME must be less than or equal to the EXTLENGTH defined in the add network command (VPNNW1=ADD) if ALLOWSHORTEXT = Y If no COMMENTS are supplied, PI will insert an automatic comment to show PI was used. If OFFNET is not specified it will be set to Y (default). If INOFFNET is not specified it will be set to N (default). If WHITELIST is not specified, an empty blacklist will be created and activated. This means no numbers are barred. To specify more than one tag to update, the TAG parameter should contain the names of the tags separated by pipe symbols. The VALUE parameter should contain the values separated by pipe symbols in the same order as for TAG. Continued on next page Page 30 PI Commands (VPN)

37 Commercial In Confidence Chapter 5 Add a VPN Station, Continued Logic and constraints (continued) The TAG and VALUE must have the same number of items. Success return Error codes VPNST1=ADD:ACK[:STNID=vpn_station.id]; Error codes: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 17, 19, 20, 21, 22, 23. See PI Command Errors (on page 78) for a description of error codes. PI Commands (VPN) Page 31

38 Chapter 5 Commercial In Confidence Change a VPN Station Details Name Description Required Constraint required VPNST1=CHG Changes the details associated with a VPN station. This command has no required. This command accepts the following constraint required parameter. PHYSADDR PHYSADDR=msisdn The Physical Address, usually real MSISDN. MSISDN number. PHYSADDR= STNNAME NEW_NAME Constraints: NEW_STNNAME NEW_PHYSADDR STNNAME=station name The name of VPN Station. (Extension number field in VPN Screen). Extension number. STNNAME=123 NEW_NAME=name The new NETNAME for VPN station. String New name should already exist. NEW_NAME="Net2" NEW_STNNAME=exnum The new STNNAME for VPN station. Extension number. NEW_STNNAME=124 NEW_PHYSADDR=addr The new PHYSADDR for the VPN station. MSISDN number. NEW_PHYSADDR= Continued on next page Page 32 PI Commands (VPN)

39 Commercial In Confidence Chapter 5 Change a VPN Station Details, Continued Constraint required (continued) GVNSADDR GVNSADDR=gvns address The GVNS Address name. String GVNSADDR=" " VDDIADDR COMMENTS TARIFFNAME Note: VDDIADDR=vddi address The VDDI Address. String VDDIADDR=" " COMMENTS=text Comment field. String COMMENTS="This is a comment" TARIFFNAME=tariff name Default ACS tariff name to use. String Matches ACS_TARIFF_CODE TARIFFNAME="TR1" Optional This command accepts the following optional. TAG TAG=tag Profile tag(s) to alter. Profile tag name(s). Allowed: Pre-defined name corresponding to PROFILE_TAG_NAME in the ACS_PROFILE_DETAILS table. Notes: Multiple tags should be separated by the pipe symbol. TAG=LANGUAGE Continued on next page PI Commands (VPN) Page 33

40 Chapter 5 Commercial In Confidence Change a VPN Station Details, Continued Optional (continued) VALUE VALUE=val The value of the tag(s). Profile tag value(s). The VALUE should match the type of the TAG specified, as defined in the ACS_PROFILE_DETAILS table. If.. VALUE format is... DATE YYYYMMDDHHMMSS BOOLEAN T (true) or F (false) INTEGER a decimal integer, maximum 4 bytes. BYTE a signed single byte as a decimal integer (- 128 to 127). PREFIX or OPREFIX, STRING the prefix tree data should be specified separated by the colon character. To specify a colon in the data, prefix it with a backslash (\:). To specify a backslash, use two backslashes together (\\). A single backslash will result in a badly formatted parameter error code 68. The maximum number of characters or digits for a single value is 255. If OPREFIX, the value data should be in the desired order. free-form text. NSTRING limited to the digits 0 to 9 For all types, the separator characters comma and pipe cannot be used. Notes: Multiple values should be separated by the pipe symbol and be in the same order as for TAG. VALUE=8 Logic and constraints At least one optional parameter should be specified. If specified, NETNAME must exist. It is used in conjunction with STNNAME and PHYSADDR to determine a unique station. Either or both STNNAME and PHYSADDR must be specified, exist, and define a unique station NETNAME should exist in vpn_network.name PHYSADDR must exist in vpn_network_physical_range table. GVNSADDR must exist in vpn_network_gvns_range table. VDDIADDR must exist in vpn_network_vddi_range table. TARIFFNAME should exist in the acs_tariff table. TAG is a pre-defined name corresponding to PROFILE_TAG_NAME in the ACS_PROFILE_DETAILS table. Continued on next page Page 34 PI Commands (VPN)

41 Commercial In Confidence Chapter 5 Change a VPN Station Details, Continued Logic and constraints (continued) To specify more than one tag to update, the TAG parameter should contain the names of the tags separated by pipe symbols. The VALUE parameter should contain the values separated by pipe symbols in the same order as for TAG The TAG and VALUE must have the same number of items To delete a TAG value, the TAG and VALUE should be specified with an empty VALUE. e.g. "TAG=to_delete,VALUE=", or "TAG=set_1 to_delete set_2,value=value_1 value_2" Success return Error codes VPNST1=CHG:ACK Error codes: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 17, 18, 19, 20, 21, 22, 23. See PI Command Errors (on page 78) for a description of error codes. PI Commands (VPN) Page 35

42 Chapter 5 Commercial In Confidence Delete a VPN Station Name Description Required Constraint required VPNST1=DEL Deletes a VPN station. This command has no required. This command accepts the following constraint required parameter. PHYSADDR PHYSADDR=msisdn The Physical Address, usually real MSISDN. MSISDN number. PHYSADDR= STNNAME STNNAME=station name The name of VPN Station. (Extension number field in VPN Screen). Extension number. STNNAME=123 Optional parameter Logic and constraints Success return Error codes This command accepts the following optional parameter. NETNAME NETNAME=network name The name of the VPN Network. String NETNAME="Net1" If specified, NETNAME must exist. It is used in conjunction with STNNAME and PHYSADDR to determine a unique station. Either or both STNNAME and PHYSADDR must be specified, exist, and define a unique station for a single station to be deleted. No optional specified will delete all stations for the specified Network in NETNAME. VPNST1=DEL:ACK Error codes: 1, 17, 19, 20. See PI Command Errors (on page 78) for a description of error codes. Page 36 PI Commands (VPN)

43 Commercial In Confidence Chapter 5 Query a VPN Station Name Description Required Constraint required VPNST1=QRY Queries a VPN station's details. This command has no required. This command accepts the following constraint required parameter. STNNAME STNNAME=station name The name of VPN Station. (Extension number field in VPN Screen). Extension number. STNNAME=123 PHYSADDR PHYSADDR=msisdn The Physical Address, usually real MSISDN. MSISDN number. PHYSADDR= Optional This command accepts the following optional. NETNAME NETNAME=network name The name of the VPN Network. String NETNAME="Net1" LISTTYPE Allowed: Default: PHYSADDR LISTTYPE=type The type of list to return. Valid values: GROUP BASIC ALL GROUP LISTTYPE=GROUP PHYSADDRMASK=pref The Prefix to search for MSISDNs (PHYSADDR list). MSISDN number. PHYSADDRMASK=64941 Continued on next page PI Commands (VPN) Page 37

44 Chapter 5 Commercial In Confidence Query a VPN Station, Continued Optional (continued) TAG Allowed: TAG=tag Profile tag(s) to alter. Profile tag name(s). Pre-defined name corresponding to PROFILE_TAG_NAME in the ACS_PROFILE_DETAILS table. Notes: Multiple tags should be separated by the pipe symbol. TAG=LANGUAGE Logic and constraints Success return One or both of STNNAME or PHYSADDR must be specified. If PHYSADDRMASK is specified: STNNAME must also be specified. LISTTYPE must be specified as BASIC. LISTTYPE = BASIC can only be used if PHYSADDRMASK is specified. TAG is a pre-defined name corresponding to PROFILE_TAG_NAME in the ACS_PROFILE_DETAILS table. To specify more than one tag to query, the tag parameter should contain the names of the tags separated by pipe symbols. DATE values are returned as YYYYMMDDHHMMSS BOOLEAN values are returned as T (true) or F (false) INTEGER values are returned as the decimal integer unaltered BYTE values are returned as a decimal integer PREFIX and OPREFIX values are returned colon separated. Colons in the data are prefixed with a backslash (\:). Backslashes are returned as two backslashes together (\\) STRING and NSTRING values are returned unaltered VPNST1=QRY:ACK[:result of query returned; The result may contain one or more of the following comma separated values. There may be more than one of each tag. Records always start with STNNAME: For LISTTYPE= BASIC: STNNAME=station name NETNAME=network name tag=value GROUP: STNNAME=station name NETNAME=network name PHYSADDR=physical address (MSISDN) Continued on next page Page 38 PI Commands (VPN)

45 Commercial In Confidence Chapter 5 Query a VPN Station, Continued Success return (continued) tag=value ALL: STNNAME=station name NETNAME=network name PHYSADDR=physical address (MSISDN) VDDIADDR=vddi address GVNSADDR=gvns address COMMENTS=comment TARIFFNAME=tariff name OFFNET=Y or N INOFFNET=Y or N WHITELIST=whitelist tag=value Error codes Error codes: 1, 2, 3, 4, 5, 19, 20, 21. See PI Command Errors (on page 78) for a description of error codes. PI Commands (VPN) Page 39

46

47 Commercial In Confidence Chapter 6 VPN Station White List Overview Introduction In this chapter This chapter explains the VPN PI commands for provisioning VPN Station White Lists. This chapter contains the following topics. Add a VPN Station White List Change a VPN Station Restriction Details Delete a VPN Station White List Query a Station White List PI Commands (VPN) Page 41

48 Chapter 6 Commercial In Confidence Add a VPN Station White List Name Description Required Constraint required VPNST2=ADD Adds a new VPN Station whitelist definition. This command has no required. This command accepts the following constraint required parameter. STNNAME STNNAME=station name The name of VPN Station. (Extension number field in VPN Screen). Extension number. STNNAME=123 PHYSADDR PHYSADDR=msisdn The Physical Address, usually real MSISDN. MSISDN number. PHYSADDR= Optional This command accepts the following optional. NETNAME NETNAME=network name The name of the VPN Network. String NETNAME="Net1" WHITELIST WHITELIST=whitelist The numbers to add to, or delete from, the white list. Single number, or colon separated list of numbers. WHITELIST= : Logic and constraints Success return If specified, NETNAME must exist. It is used in conjunction with STNNAME and PHYSADDR to determine a unique station. Either or both STNNAME and PHYSADDR must be specified, exist, and define a unique station. WHITELIST number must not already exist for the defined STNNAME and PHYSADDR pair. WHITELIST should be a single number, or a colon separated list of valid white list numbers. If white list is not active, then black list will be deleted (including numbers), and the white list made active with the number(s) specified by WHITELIST. VPNST2=ADD:ACK:number of whitelist numbers added; Continued on next page Page 42 PI Commands (VPN)

49 Commercial In Confidence Chapter 6 Add a VPN Station White List, Continued Error codes Error codes: 1, 3, 7, 17, 19, 20. See PI Command Errors (on page 78) for a description of error codes. PI Commands (VPN) Page 43

50 Chapter 6 Commercial In Confidence Change a VPN Station Restriction Details Name Description Required Constraint required VPNST2=CHG Changes the details associated with a VPN station restrictions. This command has no required. This command accepts the following constraint required parameter. STNNAME STNNAME=station name The name of VPN Station. (Extension number field in VPN Screen). Extension number. STNNAME=123 PHYSADDR PHYSADDR=msisdn The Physical Address, usually real MSISDN. MSISDN number. PHYSADDR= OFFNET OFFNET=Y N Allow or deny off net calls. Y, or N. Default: Y OFFNET=Y INOFFNET INOFFNET=Y N Allow or deny all incoming calls from off net. Y, or N. INOFFNET=N WHITELIST WHITELIST=whitelist The existing value in the white list. Single number. WHITELIST= Continued on next page Page 44 PI Commands (VPN)

51 Commercial In Confidence Chapter 6 Change a VPN Station Restriction Details, Continued Constraint required (continued) NEW_OFFNET NEW_OFFNET=Y N New value for allow/deny off net calls. Y, or N. NEW_OFFNET=Y NEW_INOFFNET INOFFNET=Y N New value for Allow or deny all incoming calls from off net. Y, or N. INOFFNET=N NEW_WHITELIST NEW_WHITELIST=tname New value for the white list, replacing old value. Single number. NEW_WHITELIST= Optional Logic and constraints Success return Error codes This command accepts the following optional. NETNAME NETNAME=network name The name of the VPN Network. String NETNAME="Net1" If specified, NETNAME must exist. It is used in conjuction with STNNAME and PHYSADDR to determine a unique station. Either or both STNNAME and PHYSADDR must be specified, exist, and define a unique station At least one of OFFNET, INOFFNET or WHITELIST should be specified. If OFFNET is specified, NEW_OFFNET must also be specified. If INOFFNET is specified, NEW_INOFFNET must also be specified. If WHITELIST is specified, NEW_WHITELIST must also be specified. VPNST2=CHG:ACK Error codes: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 17, 18, 19, 20. See PI Command Errors (on page 78) for a description of error codes. PI Commands (VPN) Page 45

52 Chapter 6 Commercial In Confidence Delete a VPN Station White List Name Description Required Constraint required VPNST2=DEL Deletes a VPN station white list number. This command has no required. This command accepts the following constraint required parameter. STNNAME STNNAME=station name The name of VPN Station. (Extension number field in VPN Screen). Extension number. STNNAME=123 PHYSADDR PHYSADDR=msisdn The Physical Address, usually real MSISDN. MSISDN number. PHYSADDR= Optional This command accepts the following optional. NETNAME NETNAME=network name The name of the VPN Network. String NETNAME="Net1" WHITELIST WHITELIST=whitelist The numbers to add to, or delete from, the white list. Single number, or colon separated list of numbers. WHITELIST= : Logic and constraints Success return Error codes If specified, NETNAME must exist. It is used in conjuction with STNNAME and PHYSADDR to determine a unique station. Either or both STNNAME and PHYSADDR must be specified, exist, and define a unique station Number(s) in WHITELIST must exist in a PHYSADDR range for the Network in NETNAME. Either a single number or colon seperated list of numbers must be specified for WHITELIST. VPNST2=DEL:ACK[:number of whitelist numbers deleted]; Error codes: 1, 3, 7, 17, 19, 20. See PI Command Errors (on page 78) for a description of error codes. Page 46 PI Commands (VPN)

53 Commercial In Confidence Chapter 6 Query a Station White List Name Description Required Constraint required VPNST2=QRY Query a white list number for a specified VPN Station. This command has no required. This command accepts the following constraint required parameter. STNNAME STNNAME=station name The name of VPN Station. (Extension number field in VPN Screen). Extension number. STNNAME=123 PHYSADDR PHYSADDR=msisdn The Physical Address, usually real MSISDN. MSISDN number. PHYSADDR= Optional parameter Logic and constraints Success return This command accepts the following optional parameter. NETNAME NETNAME=network name The name of the VPN Network. String NETNAME="Net1" If specified, NETNAME must exist. It is used in conjuction with STNNAME and PHYSADDR to determine a unique station. Either or both STNNAME and PHYSADDR must be specified, exist, and define a unique station VPNST2=QRY:ACK[:result list]; result list contains one or more of the following: OFFNET=Y or N INOFFNET=Y or N WHITELIST=number1:number2:... Error codes Error codes: 1, 7, 17, 19, 20. See PI Command Errors (on page 78) for a description of error codes. PI Commands (VPN) Page 47

54

55 Commercial In Confidence Chapter 7 VPN Station Hunting List Overview Introduction In this chapter This chapter explains the VPN PI commands for provisioning VPN Station Hunting Lists. This chapter contains the following topics. Add a VPN Station Hunting List Change a VPN Station Hunting List Delete a VPN Station Hunting List Query a VPN Station Hunting List PI Commands (VPN) Page 49

56 Chapter 7 Commercial In Confidence Add a VPN Station Hunting List Name Description Required VPNST5=ADD Adds a new VPN Station hunting list. Here are the required for this command. HUNTLIST HUNTLIST=name The name of the Hunt list. String HUNTLIST="HL1" RANK TERMNUM RANK=order The order to apply entries, in ascending order. Number RANK=1 TERMNUM=num The terminating number. Terminating number. TERMNUM= TIMEOUT TIMEOUT=num The timeout. Number of seconds. Integer value between 1 and 99. TIMEOUT=5 Constraint required This command accepts the following constraint required parameter. STNNAME STNNAME=station name The name of VPN Station. (Extension number field in VPN Screen). Extension number. STNNAME=123 PHYSADDR PHYSADDR=msisdn The Physical Address, usually real MSISDN. MSISDN number. PHYSADDR= Optional This command accepts the following optional. Continued on next page Page 50 PI Commands (VPN)