Toolpack Application:tbstatus
From TBwiki
(Difference between revisions)
(Added note for release 2.7) |
Candy Chan (Talk | contribs) |
||
(2 intermediate revisions by one user not shown) | |||
Line 4: | Line 4: | ||
== Usage == | == Usage == | ||
− | + | *'''To get all status information from the system:''' | |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | *'''To get all | + | |
: tbstatus -gw [[System_Id|''SystemId'']] | : tbstatus -gw [[System_Id|''SystemId'']] | ||
− | + | tbstatus -gw 12358 | |
− | *'''General get query | + | |
+ | *'''General get query:''' | ||
: tbstatus -gw [[System_Id|''SystemId'']] /[StatusPath] | : tbstatus -gw [[System_Id|''SystemId'']] /[StatusPath] | ||
:*Example: Get all naps status: | :*Example: Get all naps status: | ||
− | + | tbstatus -gw 12358 /nap | |
+ | :*Example: To get a SS7 interface circuit group status information: | ||
+ | :: tbstatus isup:ISUP/interface:[ISUP Interface name]/cic_group:[Circuit Group Name] | ||
+ | tbstatus isup:ISUP/interface:ISUP_IF_6009/cic_group:CG_E1_8 | ||
+ | Output: | ||
+ | |||
+ | 0:/isup:ISUP/interface:ISUP_IF_6009/cic_group:CG_E1_8 | ||
+ | CG_E1_8 - | ||
+ | - desired_group_state : Default (Default,Blocked,Unblocked) | ||
+ | - toggle_group_reset : No (No,Yes) | ||
+ | - start_continuity_check : No (No,Yes) | ||
+ | - interface_down true | ||
+ | - idle_cnt 0 | ||
+ | - incoming_cnt 0 | ||
+ | - outgoing_cnt 0 | ||
+ | - locally_blocked_cnt 0 | ||
+ | - remotely_blocked_cnt 0 | ||
+ | - locally_remotely_blocked_cnt 0 | ||
+ | - reset_cnt 0 | ||
+ | - total_ccr_success_cnt 0 | ||
+ | - total_ccr_fail_cnt 0 | ||
+ | - last_ccr_unknown_cnt 0 | ||
+ | - last_ccr_in_progress_cnt 0 | ||
+ | - last_ccr_success_cnt 0 | ||
+ | - last_ccr_fail_cnt 0 | ||
+ | - last_ccr_error_cnt 0 | ||
+ | |||
+ | '''Note:''' Settable parameters are shown in purple when doing a get query | ||
+ | |||
*'''General set query (Settable parameters are shown in purple when doing a get query):''' | *'''General set query (Settable parameters are shown in purple when doing a get query):''' | ||
Line 22: | Line 46: | ||
:*Example: To set the loopback state of a E1 line service to NONE (Meaning enable). NOTE: The path would be different for DS3 or STM1: | :*Example: To set the loopback state of a E1 line service to NONE (Meaning enable). NOTE: The path would be different for DS3 or STM1: | ||
:: tbstatus -gw [[System_Id|''SystemId'']] /adapter:[TmediaSerialNumber]/line_interface:[LineInterfaceName]/line_service:[LineServiceName]::loopback=NONE | :: tbstatus -gw [[System_Id|''SystemId'']] /adapter:[TmediaSerialNumber]/line_interface:[LineInterfaceName]/line_service:[LineServiceName]::loopback=NONE | ||
− | + | tbstatus -gw 12358 /adapter:TB001234/line_interface:LI_TB001234_00/line_service:LS_TB001234_00::loopback=NONE | |
+ | :*Example: To block a SS7 interface circuit group: | ||
+ | :: tbstatus isup:ISUP/interface:[ISUP Interface name]/cic_group:[Circuit Group Name]::desired_group_state=[state name] | ||
+ | ::: state name can be: Default, Blocked, Unblocked (unblocked should not be used in normal circumstances) | ||
+ | tbstatus isup:ISUP/interface:ISUP_IF_6009/cic_group:CG_E1_8::desired_group_state=Default | ||
+ | tbstatus isup:ISUP/interface:ISUP_IF_6009/cic_group:CG_E1_8::desired_group_state=Blocked | ||
+ | :*Example: To change the state of a M3UA Peer Server Process (Default,Asp-up,Asp-down,Abort,Shutdown,Inhibit,Uninhibit): | ||
+ | :'''Note:''' Two commands must be done at the same time and an additional "::" must be used | ||
+ | ./tbstatus /m3ua/psp:M3UA_SGP1::select_sap_for_set_state=M3UA_SAP::set_desired_asp_state=Asp-down | ||
'''Note:''' in release 2.7, you can add a "-0" to get level 0 information. | '''Note:''' in release 2.7, you can add a "-0" to get level 0 information. | ||
+ | <br/><br/> | ||
+ | == Use tbstatus in script == | ||
+ | See [[tbstatus_monitoring|Tbstatus Monitoring]]. |
Latest revision as of 05:05, 29 April 2014
Role
tbstatus is used to access/set status of the system. It requires a path for you to query.
Usage
- To get all status information from the system:
- tbstatus -gw SystemId
tbstatus -gw 12358
- General get query:
- tbstatus -gw SystemId /[StatusPath]
- Example: Get all naps status:
tbstatus -gw 12358 /nap
- Example: To get a SS7 interface circuit group status information:
- tbstatus isup:ISUP/interface:[ISUP Interface name]/cic_group:[Circuit Group Name]
tbstatus isup:ISUP/interface:ISUP_IF_6009/cic_group:CG_E1_8
Output:
0:/isup:ISUP/interface:ISUP_IF_6009/cic_group:CG_E1_8 CG_E1_8 - - desired_group_state : Default (Default,Blocked,Unblocked) - toggle_group_reset : No (No,Yes) - start_continuity_check : No (No,Yes) - interface_down true - idle_cnt 0 - incoming_cnt 0 - outgoing_cnt 0 - locally_blocked_cnt 0 - remotely_blocked_cnt 0 - locally_remotely_blocked_cnt 0 - reset_cnt 0 - total_ccr_success_cnt 0 - total_ccr_fail_cnt 0 - last_ccr_unknown_cnt 0 - last_ccr_in_progress_cnt 0 - last_ccr_success_cnt 0 - last_ccr_fail_cnt 0 - last_ccr_error_cnt 0
Note: Settable parameters are shown in purple when doing a get query
- General set query (Settable parameters are shown in purple when doing a get query):
- tbstatus -gw SystemId /[StatusPath]::[ParameterToSet]=[NewParameterValue]
- Example: To set the loopback state of a E1 line service to NONE (Meaning enable). NOTE: The path would be different for DS3 or STM1:
- tbstatus -gw SystemId /adapter:[TmediaSerialNumber]/line_interface:[LineInterfaceName]/line_service:[LineServiceName]::loopback=NONE
tbstatus -gw 12358 /adapter:TB001234/line_interface:LI_TB001234_00/line_service:LS_TB001234_00::loopback=NONE
- Example: To block a SS7 interface circuit group:
- tbstatus isup:ISUP/interface:[ISUP Interface name]/cic_group:[Circuit Group Name]::desired_group_state=[state name]
- state name can be: Default, Blocked, Unblocked (unblocked should not be used in normal circumstances)
tbstatus isup:ISUP/interface:ISUP_IF_6009/cic_group:CG_E1_8::desired_group_state=Default tbstatus isup:ISUP/interface:ISUP_IF_6009/cic_group:CG_E1_8::desired_group_state=Blocked
- Example: To change the state of a M3UA Peer Server Process (Default,Asp-up,Asp-down,Abort,Shutdown,Inhibit,Uninhibit):
- Note: Two commands must be done at the same time and an additional "::" must be used
./tbstatus /m3ua/psp:M3UA_SGP1::select_sap_for_set_state=M3UA_SAP::set_desired_asp_state=Asp-down
Note: in release 2.7, you can add a "-0" to get level 0 information.
Use tbstatus in script
See Tbstatus Monitoring.