> For the complete documentation index, see [llms.txt](https://prosbcdocs.telcobridges.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://prosbcdocs.telcobridges.com/tools-tips-and-tricks/tbstatus-api.md).

# TBStatus API

### Role

tbstatus is used to access/set status of the system. It requires a path for you to query.

<br>

### Usage

* To get all status information from the system:

tbstatus -gw [*SystemId*](/appendices/appendix-a-glossary/glossary-toolpack/glossary-tboamapp/glossary-tbtoolpack-service/system-id.md)

```
tbstatus -gw 12358
```

<br>

* General get query:

tbstatus -gw [*SystemId*](/appendices/appendix-a-glossary/glossary-toolpack/glossary-tboamapp/glossary-tbtoolpack-service/system-id.md) /\[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

<br>

* General set query (Settable parameters are shown in purple when doing a get query):

tbstatus -gw [*SystemId*](/appendices/appendix-a-glossary/glossary-toolpack/glossary-tboamapp/glossary-tbtoolpack-service/system-id.md) /\[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*](/appendices/appendix-a-glossary/glossary-toolpack/glossary-tboamapp/glossary-tbtoolpack-service/system-id.md) /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.\ <br>

### Use tbstatus in script

See [Tbstatus Monitoring](/tools-tips-and-tricks/tbstatus-api/tbstatus-monitoring.md).


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://prosbcdocs.telcobridges.com/tools-tips-and-tricks/tbstatus-api.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.