]` | The session closed unexpectedly, with the close code |
## What to use it for
The console exists to cover what the graphical console deliberately does not:
Task Why here Topology inspection and changes Beyond the read-only views and the external-party flows on the Parties tab. Diagnostics health.status and similar commands, when the Participant tab does not give enough detail.One-off administrative operations Anything Canton supports that has no CatalyX equivalent.
### Canton console command reference
The commands themselves — what you type into the terminal — are Canton's, not CatalyX's, so they are documented upstream rather than duplicated here.
{% hint style="info" %}
See the official Canton Network documentation for the full [**Canton console command reference**](https://docs.canton.network/global-synchronizer/reference/canton-console-commands#canton-console-commands) — the admin console commands for participant, mediator, sequencer, and topology nodes.
{% endhint %}
## Session behaviour
**Collapsing does not disconnect.** The panel hides the terminal but keeps the session alive, so you can collapse it, navigate around the console, and come back to the same session with its history intact.
**Sessions are per user and reused.** Reconnecting typically reattaches you to your existing session rather than starting a new one, and recent output is replayed.
**Idle sessions are reclaimed** after roughly ten minutes with nothing attached.
{% hint style="info" %}
The session attaches to a running participant pod. If no participant pod is running, the console reports that instead of connecting — check the validator's [Summary](/catalyx-blockchain-manager/canton-network/version-2.0/console-guide-canton/validators/summary.md) tab first.
{% endhint %}
## Security notes for operators
{% hint style="warning" %}
Two properties of the current implementation are worth knowing when you assess this feature:
* **The session's access token is passed in the connection URL.** It may therefore be recorded in proxy and load-balancer access logs. Review your log retention accordingly.
* **The token is validated once, when the session is established.** An attached session is not re-checked afterwards, so it can outlive the token's expiry. Sessions are reclaimed on idle timeout rather than on token expiry.
If either is unacceptable in your environment, block the console's WebSocket path at your ingress and use a Canton console attached out-of-band instead.
{% endhint %}
---
# 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://docs.catalyx.solutions/catalyx-blockchain-manager/canton-network/version-2.0/console-guide-canton/canton-console.md?ask=&goal=
```
`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.