> For the complete documentation index, see [llms.txt](https://cortex-docs.paloaltonetworks.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://cortex-docs.paloaltonetworks.com/cortex-xdr/configure-cortex-xdr/data-management/broker-vm/manage-broker-vm/broker-vm-tui-administration-console.md). # Broker VM TUI administration console Learn more about when and why to use the Text User Interface (TUI) in the Broker VM. The Broker VM provides a restricted Text User Interface (TUI) for the admin account when accessing the broker locally or via SSH. The TUI provides a controlled and secured local management experience. {% hint style="info" %} #### Note The TUI is primarily intended for deep troubleshooting and local configuration. For standard operations, you should continue to use the Cortex management console (tenant UI) or the Broker VM Web UI. {% endhint %} ### Why use the TUI? * **Secure administration**: The TUI exposes only approved administrative operations. * **Troubleshooting and connectivity**: It is the essential tool for resolving "offline" scenarios. If a broker cannot reach the Cortex management console, you use the TUI to fix local networking, proxy, or DNS settings. * **Diagnostic integrity**: It provides a safe environment to run packet captures (pcap) and connectivity probes as requested by Palo Alto Networks Support. ### Accessing the TUI There are two ways to access the TUI. In both cases, the menu-driven console launches automatically upon login, replacing the traditional command prompt. #### 1. Local serial console Access the console through your hypervisor's management interface (such as the VMware vSphere console, Microsoft Hyper-V Manager, or the AWS/Azure serial console). This method is typically used for initial setup or as a last resort when network issues prevent any other form of access. * **Access**: The serial console logs you in directly as the admin user; you do not need to log in manually to reach the TUI. #### 2. SSH remote access If SSH access is enabled, you can connect remotely using an SSH client. * **Command**: `ssh admin@` * **Behavior**: Upon successful login, the system immediately presents the TUI menu. ### TUI options and capabilities The TUI organizes essential broker operations into a menu-driven structure: #### Networking Configure and manage the broker's local network settings. * **Network configuration**: Set a static IP, netmask, gateway, and DNS for specific interfaces, or enable DHCP. * **Restart routes**: Edit and re-apply the broker's static routing table manually. * **NTP configuration**: Define the NTP time servers used for clock synchronization and monitor the status of the NTP daemon. #### Diagnostics Run read-only probes and verify the health of the broker deployment. * **System/health status**: View a dashboard showing real-time disk, memory, and CPU usage. * **Network health check**: Probe connectivity to a specific host or IP address and summarize the results. * **Denied URLs check**: Verify if the broker can reach required Palo Alto Networks cloud endpoints, either directly or through a configured proxy. * **Upload bandwidth test**: Measure the log-upload throughput from the broker to the cloud. * **Packet capture (pcap)**: Capture network traffic on a specific interface using optional filters to troubleshoot complex connectivity issues. #### Support and Security Manage administrative maintenance and secure access sessions. * **Generate log bundle**: Collect a diagnostic log bundle to the data partition for investigation. * **Secure support session**: Start a challenge/response support shell when formally instructed by Palo Alto Networks Support. * **Renew shared secret**: Regenerate the authentication secret shared between the broker and the cloud during the secure support session. * **Set console password**: Configure or change an optional local password to lock the TUI console. #### Boot Options Manage the power state and core services of the virtual machine. * **Shutdown / Reboot**: Power off or restart the Broker VM. * **Persistence layer hard reset**: A destructive operation used to wipe persistence-layer state and restart dependent services.

Important

Do not use this option unless formally instructed by Palo Alto Networks Support.

--- # 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://cortex-docs.paloaltonetworks.com/cortex-xdr/configure-cortex-xdr/data-management/broker-vm/manage-broker-vm/broker-vm-tui-administration-console.md?ask=&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.