This section describes Number Portability Gateway (NPGW) TL1 commands.
NPGW Command Groupings
The following figure shows the NPGW objects that can be configured using TL1 commands.
This section includes information for the NPGW command set.
NPGW Configuration
VFY-NPGW-CFG
VFY-NPGW-CFG:::[CTAG];
CHG-NPGW-CFG
CHG-NPGW-CFG:::[CTAG]:::::[PSXGW_TIMEOUT=<int>],[E164_INAPGW=<string>],[INAPGW_TIMEOUT=<int>],[ERRORS=<LogBoolean>],[SETUPMGMT=<LogBoolean>],[EXECTRACE=<LogBoolean>],[DISTMGMT=<LogBoolean>];
SET-NPGW-CFG
SET-NPGW-CFG:::[CTAG]:::[ACTIVATE/DEACTIVATE/RESTORE_DBG];
:::<LIC_INAP=NPGWLicense>,<LIC_PSX_TISUP=NPGWLicense>,<PSXGW_TIMEOUT=int>,<MTP3_STATUS=NPGWConnStatus>,<SCCP_STATUS=NPGWConnStatus>,<E164_INAPGW=string>,<INAPGW_TIMEOUT=int>,<ERRORS=LogBoolean>,<SETUPMGMT=LogBoolean>,<EXECTRACE=LogBoolean>,<DISTMGMT=LogBoolean>;
Attribute Details
LIC_INAP - INAP Gateway
Permissions: Read-only
Type: NPGWLicense={UNLICENSED,LICENSED}
Description: INAP Gateway feature license (UNLICENSED/LICENSED). If all gateways are unlicensed, the SS7 traffic cannot be activated.
LIC_PSX_TISUP - PSX NP Gateway
Permissions: Read-only
Type: NPGWLicense={UNLICENSED,LICENSED}
Description: PSX NP Gateway feature license (UNLICENSED/LICENSED). If the gateway is unlicensed, the SS7 traffic cannot be activated.
PSXGW_TIMEOUT - PSX Gateway Timeout
Permissions: Writeable Type: int(Range: [100..5000])
Description: PSX NP Gateway Transaction Timeout (100 to 5000). Pending transaction timeout for the PSX NP service queries in milliseconds (ms). Note: A fallback lifetime timeout will also be initialized based on the Transaction Timeout plus 500 ms. Default: 1000 ms.
MTP3_STATUS - MTP3 Traffic Status
Permissions: Read-only
Type: NPGWConnStatus={INACTIVE,NOT CONNECTED,CONNECTED,PARTIALLY CONNECTED}
Description: MTP3 connectivity status (INACTIVE, NOT CONNECTED, CONNECTED). Based on the per NA connectivity status. CONNECTED will be displayed as soon as an MTP3 NA on any slot is connected. Associated to alarm 1617 (NPGW MTP3 Down).
SCCP_STATUS - SCCP Traffic Status
Permissions: Read-only
Type: NPGWConnStatus={INACTIVE,NOT CONNECTED,CONNECTED,PARTIALLY CONNECTED}
Description: SCCP connectivity status (INACTIVE, NOT CONNECTED, CONNECTED). Based on the per NA connectivity status. CONNECTED will be displayed as soon as an SCCP NA on any slot is connected. Associated to alarm 1601 (NPGW SCCP Down).
E164_INAPGW - INAP Gateway E164
Permissions: Writeable
Type: string
Description: INAP Gateway E.164 number. Must be unique on each mate-STP. The generated INAP Initial-DP query will include these digits in the SCCP Calling Party Address parameter. Must be defined to activate traffic.
INAPGW_TIMEOUT - INAP Gateway Timeout
Permissions: Writeable
Type: int(Range: [1000..10000])
Description: INAP Gateway Transaction Timeout (1000 to 10000). Pending transaction timeout for the INAP queries in milliseconds (ms). Default: 2000 ms.
ERRORS - Errors
Permissions: Writeable
Type: LogBoolean={NOT LOGGED,LOGGED}
Description: If set to LOGGED, the system logs to debug all NPGW errors. Should be set to LOGGED for live systems.
SETUPMGMT - Setup Management
Permissions: Writeable
Type: LogBoolean={NOT LOGGED,LOGGED}
Description: If set to LOGGED, the system logs to debug the NPGW setup information. Should be set to LOGGED for live systems.
EXECTRACE - Execution Trace
Permissions: Writeable
Type: LogBoolean={NOT LOGGED,LOGGED}
Description: If set to LOGGED, the system logs to debug the execution trace during the processing of incoming NPGW traffic. Must be set to NOT LOGGED for live systems.
DISTMGMT - Distribution Management
Permissions: Writeable
Type: LogBoolean={NOT LOGGED,LOGGED}
Description: If set to LOGGED, the system logs to debug the NPGW distribution information. Must be set to NOT LOGGED for live systems.
MTP3 NAs
VFY-NPGW-MTP3NAs
VFY-NPGW-MTP3NAS:::[CTAG];
:::;
Attribute Details
N/A
MTP3 NA
VFY-NPGW-MTP3NA
VFY-NPGW-MTP3NA::[<MTP3 NA/NA>]:[CTAG];
DLT-NPGW-MTP3NA
DLT-NPGW-MTP3NA::[<MTP3 NA/NA>]:[CTAG];
ADD-NPGW-MTP3NA
ADD-NPGW-MTP3NA::[<MTP3 NA/NA>]:[CTAG]::;
SET-NPGW-MTP3NA
SET-NPGW-MTP3NA::[<MTP3 NA/NA>]:[CTAG]:::[ACTIVATE/DEACTIVATE];
::[<MTP3 NA/NA>]:<NA=int>,<STATUS=NPGWConnStatus>;
AID Description
NA - Position 1
Type: int(Range: [1..99])
Description: MTP3 Network Appearance
Attribute Details
NA - NA
Permissions: Createable
Type: int(Range: [1..99])
Description: MTP3 Network Appearance
STATUS - Status
Permissions: Read-only
Type: NPGWConnStatus={INACTIVE,NOT CONNECTED,CONNECTED,PARTIALLY CONNECTED}
Description: MTP3 NA connectivity status (INACTIVE, NOT CONNECTED, CONNECTED). Based on the per NA connection connectivity status. CONNECTED will be displayed as soon as an MTP3 NA connection is connected. Associated to alarm 1611 (NPGW MTP3 NA Down).
MTP3 NA Connection
VFY-NPGW-MTP3CONN
VFY-NPGW-MTP3CONN::[<MTP3 NA/NA>]-[<MTP3 NA Connection/Slot>]:[CTAG];
::[<MTP3 NA/NA>]-[<MTP3 NA Connection/Slot>]:<SLOT=int>,<STATUS=NPGWConnStatus>;
AID Description
Slot - Position 1
Type: int
Description: Associated slot of the routing CPU for this MTP3 NA connection.
Attribute Details
SLOT - Slot
Permissions: Createable
Type: int
Description: Associated slot of the routing CPU for this MTP3 NA connection.
STATUS - Status
Permissions: Read-only
Type: NPGWConnStatus={INACTIVE,NOT CONNECTED,CONNECTED,PARTIALLY CONNECTED}
Description: MTP3 connectivity status (INACTIVE, NOT CONNECTED, CONNECTED). Based on the per slot connectivity status. CONNECTED will be displayed as soon as an MTP3 connection on any slot is connected. Associated to alarm 1613 (NPGW MTP3 NA Connection Down).
MTP3 Registrations
VFY-NPGW-MTP3REGS
VFY-NPGW-MTP3REGS:::[CTAG];
:::;
Attribute Details
N/A
MTP3 AppID Registration
VFY-NPGW-MTP3APPID
VFY-NPGW-MTP3APPID::[<MTP3 Registration/NA>-<MTP3 Registration/Application ID>]:[CTAG];
::[<MTP3 Registration/NA>-<MTP3 Registration/Application ID>]:<NA=int>,<APPID=string>,<STATUS=NPGWRegStatus>;
AID Description
NA - Position 1
Type: int
Description: Network Appearance of the NPGW MTP3 service registration
Application ID - Position 2
Type: string
Description: Application ID of the NPGW MTP3 service registration. Associated with the GWST redirection feature. Valid values: alphanumeric string with - and _ with a maximum of 16 characters (including the null terminating character).
Attribute Details
NA - NA
Permissions: Read-only
Type: int
Description: Network Appearance of the NPGW MTP3 service registration
APPID - Application ID
Permissions: Read-only
Type: string
Description: Application ID of the NPGW MTP3 service registration. Associated with the GWST redirection feature. Valid values: alphanumeric string with - and _ with a maximum of 16 characters (including the null terminating character).
STATUS - Status
Permissions: Read-only
Type: NPGWRegStatus={NOT REGISTERED,PARTIALLY REGISTERED,REGISTERED}
Description: Status of the Application ID registration. Fully registered when all MTP3 connections have successfully registered the Application ID. Valid values: NOT REGISTERED, PARTIALLY REGISTERED, REGISTERED.
PSX NP Services
VFY-NPGW-PSX_NPS
VFY-NPGW-PSX_NPS:::[CTAG];
:::;
Atribute Details
N/A
PSX NP Service
VFY-NPGW-PSX_NP
VFY-NPGW-PSX_NP::[<PSX NP Service/Application ID>]:[CTAG];
DLT-NPGW-PSX_NP
DLT-NPGW-PSX_NP::[<PSX NP Service/Application ID>]:[CTAG];
ADD-NPGW-PSX_NP
ADD-NPGW-PSX_NP::[<PSX NP Service/Application ID>]:[CTAG]:::::[TYPE=<PSXNPType>],[PSX1=<string>],[PSX2=<string>];
CHG-NPGW-PSX_NP
CHG-NPGW-PSX_NP::[<PSX NP Service/Application ID>]:[CTAG]:::::[PSX1=<string>],[PSX2=<string>];
::[<PSX NP Service/Application ID>]:<TYPE=PSXNPType>,<APPID=string>,<PSX1=string>,<PSX2=string>;
AID Description
Application ID - Position 1
Type: string
Description: Application ID representing the PSX NP. Associated with the GWST redirection feature. Valid values: alphanumeric string with - and _ with a maximum of 16 characters.
Attribute Details
TYPE - Service Type
Permissions: Createable
Type: PSXNPType={TRIGGERLESS ISUP}
Description: PSX NP Service Type (ISUP TRIGGERLESS)
APPID - Application ID
Permissions: Createable
Type: string
Description: Application ID representing the PSX NP. Associated with the GWST redirection feature. Valid values: alphanumeric string with - and _ with a maximum of 16 characters.
PSX1 - Primary PSX Name
Permissions: Writeable and Createable
Type: string
Description: Primary PSX Name used for PSX connections. The PSX Host Connections will be used in a round-robin implementation for query handling. If the primary PSX is unavailable, congested, or licensed full, the secondary PSX is used if defined, else error handling is applied. Valid values: existing PSX Name attribute value.
PSX2 - Secondary PSX Name
Permissions: Writeable and Createable
Type: string
Description: Secondary PSX Name used for PSX connections. Optional PSX to handle traffic if primary PSX is unavailable, congested, or licensed full. Set to an empty string to disable the backup PSX. Valid values: empty string or existing PSX Name attribute value.
PSXs
VFY-NPGW-PSXS
VFY-NPGW-PSXS:::[CTAG];
:::;
Attribute Details
N/A
PSX
VFY-NPGW-PSX
VFY-NPGW-PSX::[<PSX/Name>]:[CTAG];
DLT-NPGW-PSX
DLT-NPGW-PSX::[<PSX/Name>]:[CTAG];
ADD-NPGW-PSX
ADD-NPGW-PSX::[<PSX/Name>]:[CTAG]::;
SET-NPGW-PSX
SET-NPGW-PSX::[<PSX/Name>]:[CTAG]:::[ACTIVATE/DEACTIVATE/STATS/RESET_STATS];
::[<PSX/Name>]:<NAME=string>,<CONG=PSXCong>,<STATUS=NPGWConnStatus>;
AID Description
Name - Position 1
Type: string
Description: Name of the PSX. Used to associate a PSX connection setup to a PSX NP Service. Valid values: alphanumeric string with - and _ with a maximum of 16 characters.
Attribute Details
NAME - Name
Permissions: Createable
Type: string
Description: Name of the PSX. Used to associate a PSX connection setup to a PSX NP Service. Valid values: alphanumeric string with - and _ with a maximum of 16 characters.
CONG - Congestion
Permissions: Read-only
Type: PSXCong={DISABLED,ENABLED,TPS BLOCKED}
Description: Congestion status of the PSX. Set to highest severity if at least one of the PSX Host is in that state. Valid values: DISABLED, ENABLED, TPS BLOCKED.
STATUS - Status
Permissions: Read-only
Type: NPGWConnStatus={INACTIVE,NOT CONNECTED,CONNECTED}
Description: Connection status of the PSX. Set based on the PSX Host status. Valid values: INACTIVE, NOT CONNECTED, and CONNECTED
PSX Host
DLT-NPGW-PSX_HOST
DLT-NPGW-PSX_HOST::[<PSX/Name>]-[<PSX Host/Host>-<PSX Host/Port>]:[CTAG];
ADD-NPGW-PSX_HOST
ADD-NPGW-PSX_HOST::[<PSX/Name>]-[<PSX Host/Host>-<PSX Host/Port>]:[CTAG]:::::[NAME=<string>];
CHG-NPGW-PSX_HOST
CHG-NPGW-PSX_HOST::[<PSX/Name>]-[<PSX Host/Host>-<PSX Host/Port>]:[CTAG]:::::[KA=<int>];
SET-NPGW-PSX_HOST
SET-NPGW-PSX_HOST::[<PSX/Name>]-[<PSX Host/Host>-<PSX Host/Port>]:[CTAG]:::[ACTIVATE/DEACTIVATE];
VFY-NPGW-PSX_HOST
VFY-NPGW-PSX_HOST::[<PSX/Name>]-[<PSX Host/Host>-<PSX Host/Port>]:[CTAG];
::[<PSX/Name>]-[<PSX Host/Host>-<PSX Host/Port>]:<HOST=string>,<PORT=int>,<NAME=string>,<KA=int>,<CONG=PSXCong>,<STATUS=NPGWConnStatus>,<USR_ACTIVATED=FeatureBoolean>;
AID Description
Host - Position 1
Type: string
Description: Host name for the PSX Host. Valid values: Hostname or IP address.
Port - Position 2
Type: int
Description: Port for the PSX Host. Valid values: 1 to 65535.
Attribute Details
HOST - Host
Permissions: Createable
Type: string
Description: Host name for the PSX Host. Valid values: Hostname or IP address.
PORT - Port
Permissions: Createable
Type: int
Description: Port for the PSX Host. Valid values: 1 to 65535.
NAME - Gateway Name
Permissions: Createable
Type: string
Description: Gateway name for the PSX Host. Used by the PSX Host Connection with slot distinction to register with the PSX. Valid values: alphanumeric string with - and _ with a maximum of 22 characters.
CONG - Congestion
Permissions: Read-only
Type: PSXCong={DISABLED,ENABLED,TPS BLOCKED}
Description: Congestion status of the PSX Host. Valid values: DISABLED, ENABLED, TPS BLOCKED.
KA - Keep Alive Timer
Permissions: Writeable
Type: int(Range: [500..5000])
Description: Keep alive timer for the PSX Host connections (500-5000ms). Default value: 1000 ms.
STATUS - Status
Permissions: Read-only
Type: NPGWConnStatus={INACTIVE,NOT CONNECTED,CONNECTED}
Description: Connectivity status of the PSX Host. Set based on the PSX Host Connections status. Valid values: INACTIVE, NOT CONNECTED, and CONNECTED.
USR_ACTIVATED - User Activated
Permissions: Read-only
Type: FeatureBoolean={DISABLED,ENABLED}
Description: Activation state configured by the Activate and Deactivate actions. Valid values: ENABLED and DISABLED.
PSX Host Connection
VFY-NPGW-PSX_HOST_CONN
VFY-NPGW-PSX_HOST_CONN::[<PSX/Name>]-[<PSX Host/Host>-<PSX Host/Port>]-[<PSX Host Connection/Slot>]:[CTAG];
::[<PSX/Name>]-[<PSX Host/Host>-<PSX Host/Port>]-[<PSX Host Connection/Slot>]:<SLOT=int>,<NAME=string>,<CONG=PSXCong>,<STATUS=NPGWConnStatus>,<LHOST=string>,<LPORT=int>;
AID Description
Slot - Position 1
Type: int
Description: Slot of the PSX Host Connection.
Attribute Details
Slot - Slot
Permissions: Read-only
Type: int
Description: Slot of the PSX Host Connection.
NAME - Gateway Name
Permissions: Read-only
Type: string
Description: Gateway name for the PSX Host Connection. Defined in the PSX Host with slot distinction to register with the PSX.
CONG - Congestion
Permissions: Read-only
Type: PSXCong={NOT CONGESTED,CONGESTED}
Description: Congestion status of the PSX Host Connection. Valid values: NOT CONGESTED, CONGESTED.
STATUS - Status
Permissions: Read-only
Type: NPGWConnStatus={INACTIVE,NOT CONNECTED,CONNECTED,PARTIALLY CONNECTED}
Description: Connection status of the PSX Host Connection. Valid values: INACTIVE, NOT CONNECTED, and CONNECTED
LHOST - Local Host
Permissions: Read-only
Type: string
Description: Local address used by the PSX Host Connection. This value is assigned by the operating system based on the remote host and the IP routing configured on the slot. This string will be empty if the local address is not assigned or the connection is inactive. Valid values: IP address and empty string.
LPORT - Local Port
Permissions: Read-only
Type: int
Description: Local port for the PSX Host Connection. Ephemeral value provided by the operating system. The values will be 0 if the local port is not assigned or the connection is inactive. Valid values: 0 to 65535.