> For the complete documentation index, see [llms.txt](https://tmediadocs.telcobridges.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://tmediadocs.telcobridges.com/telecom-references/developer-reference/toolpack-api/tbstatus.md).

# tbstatus

### 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*](https://tmediadocs.telcobridges.com/products/tmedia/features-and-solutions/features/redundancy-and-high-availability/system-id) tbstatus -gw 12358

* **General get query:**

> tbstatus -gw [*SystemId*](https://tmediadocs.telcobridges.com/products/tmedia/features-and-solutions/features/redundancy-and-high-availability/system-id) /\[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*](https://tmediadocs.telcobridges.com/products/tmedia/features-and-solutions/features/redundancy-and-high-availability/system-id) /\[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*](https://tmediadocs.telcobridges.com/products/tmedia/features-and-solutions/features/redundancy-and-high-availability/system-id) /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](/telecom-references/developer-reference/toolpack-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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://tmediadocs.telcobridges.com/telecom-references/developer-reference/toolpack-api/tbstatus.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.