Gadmin Basics

The TigerGraph Graph Administrator (gadmin) is the primary tool for managing services, checking system health, and modifying configurations.

1. Service Management

The most common use for gadmin is controlling the various TigerGraph services.

Core Commands:

• gadmin start all: Boots up the entire platform (essential after a fresh install or reboot).
• gadmin stop all: Gracefully shuts down all services.
• gadmin status -v: Provides a detailed health check of every service and its process ID (PID).
• gadmin restart <service>: Restarts a specific component (e.g., restpp, gpe).

Bypassing Confirmations

Use the -y flag to skip interactive prompts in scripts or automation:

bashterminal
Copy
gadmin stop all -y

2. Configuration Management

TigerGraph's behavior is governed by a central configuration.

• gadmin config list: View all available configuration parameters.
• gadmin config set <Param> <Value>: Updates a setting.
• gadmin config apply: CRITICAL - You must run this after changing settings to propagate them to the services.

3. License Management

Check or update your TigerGraph license directly from the CLI:

• gadmin license status: Check expiration date and capacity.
• gadmin license set <key>: Installs a new license string.

4. Graceful Shutdowns

When you run gadmin stop, the system doesn't just "kill" processes. It initiates a graceful shutdown:

• RESTPP: Waits for ongoing requests to finish (200s timeout by default).
• GPE: Finalizes graph processing tasks (300s timeout by default).

[!NOTE] You can override these timeouts during a stop command: gadmin stop all --timeout 600