Passer au contenu principal

Commandes CLI

Toutes les commandes suivent le modèle : unraid-api <command> [options].

Gestion des services​

Démarrer​

unraid-api start [--log-level <level>]

Démarre le service API Unraid.

Options :

  • --log-level : Définir le niveau de journalisation (trace|debug|info|warn|error|fatal)

Alternative : vous pouvez également définir le niveau du journal à l'aide de la variable d'environnement LOG_LEVEL :

LOG_LEVEL=trace unraid-api start

Arrêter​

unraid-api stop [--delete]

Arrête le service API Unraid.

  • --delete: Optionnel. Supprimer le répertoire racine PM2.

Redémarrer​

unraid-api restart [--log-level <level>]

Redémarre le service API Unraid.

Options :

  • --log-level : Définir le niveau de journalisation (trace|debug|info|warn|error|fatal)

Alternative : vous pouvez également définir le niveau du journal à l'aide de la variable d'environnement LOG_LEVEL :

LOG_LEVEL=trace unraid-api restart

Journaux​

unraid-api logs [-l <lines>]

Afficher les journaux de l'API.

  • -l, --lines: Optionnel. -Nombre de lignes à afficher (défaut : 100)

Commandes de configuration​

Configuration​

unraid-api config

Affiche les valeurs de configuration actuelles.

Changer d'environnement​

unraid-api switch-env [-e <environment>]

Bascule entre les environnements de production et de staging.

  • -e, --environment: Optionnel. Environnement cible (production|staging).

Mode développeur​

Vous pouvez également gérer les options de développeur via l'interface Web à Paramètres → Accès à la gestion → Options du développeur dans la WebGUI.

unraid-api developer                       # Interactive prompt for tools
unraid-api developer --sandbox true        # Enable %%GraphQL|graphql%% sandbox
unraid-api developer --sandbox false       # Disable %%GraphQL|graphql%% sandbox
unraid-api developer --enable-modal        # Enable modal testing tool
unraid-api developer --disable-modal       # Disable modal testing tool

Configurer les fonctionnalités développeur pour l'API :

  • GraphQL Sandbox : Activer/désactiver le bac à sable Apollo GraphQL à /graphql
  • Outil de test modal : Activer/désactiver le test modal de l'UI dans le menu Unraid

Gestion des clés API​

Vous pouvez également gérer les clés API via l'interface Web à Paramètres → Accès à la gestion → Clés API dans la WebGUI.

Commandes des clés API​

unraid-api apikey [options]

Créer et gérer les clés API via CLI.

Options :

  • --name <name> : Nom de la clé
  • --create : Créer une nouvelle clé
  • -r, --roles <roles> : Liste des rôles séparés par des virgules
  • -p, --permissions <permissions> : Liste des permissions séparées par des virgules
  • -d, --description <description> : Description de la clé

Gestion du SSO (Single Sign-On)​

Pour la configuration du fournisseur OIDC/SSO, voir l'interface Web à Paramètres → Accès à la gestion → API → OIDC dans la WebGUI ou consultez le guide Configuration du fournisseur OIDC.

Commande de base SSO​

unraid-api sso

Options :

unraid-api sso add-user
# or
unraid-api sso add
# or
unraid-api sso a

Supprimer un utilisateur SSO:

unraid-api sso remove-user
# or
unraid-api sso remove
# or
unraid-api sso r

Pour la configuration du fournisseur OIDC/SSO, voir l'interface Web à Paramètres → Accès à la gestion → API → OIDC ou se référer au guide Installation du fournisseur OIDC.

unraid-api sso list-users
# or
unraid-api sso list
# or
unraid-api sso l

Valider le jeton SSO:

Validez un jeton SSO et renvoyez son statut.

unraid-api sso validate-token <token>
# or
unraid-api sso validate
# or
unraid-api sso v

Génération de rapport​

Supprimer un utilisateur SSO​

unraid-api report [-r] [-j]

Générer un rapport système.

  • -r, --raw : Afficher la sortie de commande brute
  • -j, --json : Afficher la sortie au format JSON

La plupart des commandes nécessitent les autorisations appropriées pour modifier l'état du système. Certaines commandes exigent que l'API soit en cours d'exécution ou arrêtée. Stockez les clés API en lieu sûr, car elles donnent accès au système. Les changements de configuration SSO peuvent nécessiter un redémarrage du service.