ツール

目的

unraid

すべての操作のための統合されたアクション/サブアクションルーター

unraid_help

このリファレンスを Markdown で返す

diagnose_subscriptions

WebSocket サブスクリプションシステムの完全な診断ダンプ

test_subscription_query

スキーマ/デバッグ作業のために生の GraphQL サブスクリプションをプローブする

サブアクション

説明

必須パラメータ

overview

OS、CPU、メモリレイアウト、バージョン、マシン ID

—

array

アレイの状態、容量、ディスク健全性サマリー

—

network

アクセス URL、HTTP/HTTPS ポート、LAN/WAN IP

—

registration

ライセンスタイプ、キーファイル、有効期限

—

variables

Unraid 変数セット全体 (タイムゾーン、共有など)

—

metrics

ライブ CPU % およびメモリ使用量

—

services

実行中のサービス (名前、オンライン状態、バージョン)

—

display

現在の UI テーマ名

—

config

設定の妥当性とエラー状態

—

online

到達可能性のブール値チェック

—

owner

オーナーのユーザー名、アバター、プロフィール URL

—

settings

統合された設定のキー/値マップ

—

server

単一呼び出しサマリー: ホスト名、稼働時間、Unraid バージョン、アレイ状態

—

servers

LAN/WAN IP および URL を持つすべての登録済みサーバー

—

flash

フラッシュドライブのベンダーおよび製品情報

—

ups_devices

バッテリーおよび電力メトリクスを持つすべての UPS デバイス

—

ups_device

単一の UPS デバイスの詳細

device_id

ups_config

UPS デーモンの設定

—

サブアクション

説明

必須パラメータ

check

包括的な健全性: API レイテンシ、アレイ状態、アラート、Docker コンテナサマリー

—

test_connection

Unraid API に ping を送信し、レイテンシを ms で返す

—

diagnose

サブスクリプションシステムのステータス、エラー数、再接続状態

—

setup

インタラクティブな資格情報設定 (MCP の引き出しをサポート)

—

サブアクション

説明

必須パラメータ

破壊的

parity_status

現在のパリティチェックの進捗、速度、エラー

—

—

parity_history

過去のパリティチェック結果

—

—

parity_start

パリティチェックを開始する

correct (bool)

—

parity_pause

実行中のパリティチェックを一時停止する

—

—

parity_resume

一時停止中のパリティチェックを再開する

—

—

parity_cancel

実行中のパリティチェックをキャンセルする

—

—

start_array

Unraid アレイを開始する

—

—

stop_array

Unraid アレイを停止する

confirm=True

*

add_disk

アレイにディスクを追加する

disk_id; オプション slot

—

remove_disk

アレイからディスクを削除する (アレイは停止している必要がある)

disk_id, confirm=True

*

mount_disk

アレイディスクをマウントする

disk_id

—

unmount_disk

アレイディスクをアンマウントする

disk_id

—

clear_disk_stats

ディスクの I/O 統計をクリアする (元に戻せません)

disk_id, confirm=True

*

サブアクション

説明

必須パラメータ

破壊的

shares

サイズ、割り当て設定、LUKS 状態を持つすべてのユーザー共有

—

—

disks

物理ディスクリスト (ID、デバイス、名前)

—

—

disk_details

単一ディスク: シリアル、サイズ、温度

disk_id

—

log_files

利用可能なログファイルリスト (名前、パス、サイズ、変更日時)

—

—

logs

行範囲を指定してログファイルの内容を読み取る

log_path; オプション tail_lines (デフォルト 100, 最大 10000)

—

flash_backup

フラッシュドライブからリモートへの rclone バックアップを開始する

remote_name, source_path ( /boot で始まる必要がある), destination_path, confirm=True

*

サブアクション

説明

必須パラメータ

list

すべてのコンテナ: ID、名前、イメージ、状態、ステータス、autoStart

details

コンテナの詳細: ポート、マウント、ラベル、ネットワーク設定

container_id

start

コンテナを開始する

container_id

stop

コンテナを停止する

container_id

restart

コンテナを再起動する (停止してから開始)

container_id

networks

すべての Docker ネットワーク: ID、名前、ドライバー、スコープ

—

network_details

IPv6、コンテナ、オプション、ラベルを持つ単一ネットワーク

network_id

サブアクション

説明

必須パラメータ

破壊的

list

すべての VM: ID、名前、状態、UUID

—

—

details

単一 VM の詳細

vm_id

—

start

VM を開始する

vm_id

—

stop

VM を正常に停止する

vm_id

—

pause

実行中の VM を一時停止する

vm_id

—

resume

一時停止中の VM を再開する

vm_id

—

reboot

VM を再起動する

vm_id

—

force_stop

VM を強制終了する (データ損失の可能性あり)

vm_id, confirm=True

*

reset

正常なシャットダウンなしで VM をハードリセットする

vm_id, confirm=True

*

サブアクション

説明

必須パラメータ

破壊的

overview

重要度別の未読およびアーカイブ数 (INFO/WARNING/ALERT)

—

—

list

ページ分割された通知リスト

list_type (UNREAD または ARCHIVE, デフォルト UNREAD); オプション importance, offset, limit

—

create

通知を作成する

title (≤200), subject (≤500), description (≤2000), importance (INFO/WARNING/ALERT)

—

archive

単一の通知をアーカイブする

notification_id

—

mark_unread

アーカイブされた通知を未読に戻す

notification_id

—

recalculate

概要のカウントを再計算する

—

—

archive_all

すべての未読通知をアーカイブする

オプション importance でフィルタリング

—

archive_many

ID で特定の通知をアーカイブする

notification_ids (リスト)

—

unarchive_many

ID で特定の通知をアーカイブ解除する

notification_ids (リスト)

—

unarchive_all

すべてのアーカイブ済み通知を未読に戻す

オプション importance でフィルタリング

—

delete

単一の通知を完全に削除する

notification_id, notification_type, confirm=True

*

delete_archived

すべてのアーカイブ済み通知を完全に削除する

confirm=True

*

サブアクション

説明

必須パラメータ

破壊的

list

ロールと権限を持つすべての API キー

—

—

get

単一の API キーの詳細

key_id

—

create

API キーを作成する

name; オプション roles, permissions

—

update

名前、ロール、または権限を更新する

key_id; オプション name, roles, permissions

—

delete

API キーを削除する (即座にアクセスを取り消す)

key_id, confirm=True

*

add_role

既存のキーにロールを追加する

key_id, roles (最初の要素を使用)

—

remove_role

既存のキーからロールを削除する

key_id, roles (最初の要素を使用)

—

サブアクション

説明

必須パラメータ

破壊的

list

バージョンとモジュールフラグを持つすべてのインストール済みプラグイン

—

—

add

名前でプラグインをインストールする

names (リスト); オプション bundled, restart

—

remove

名前でプラグインをアンインストールする (再インストールなしでは元に戻せません)

names (リスト), confirm=True

*

サブアクション

説明

必須パラメータ

破壊的

list_remotes

タイプとパラメータを持つすべての設定済み rclone リモート

—

—

config_form

プロバイダータイプの設定フォームスキーマ

オプション provider_type

—

create_remote

新しい rclone リモートを作成する

name, provider_type, config_data (文字列/数値/ブールの辞書; 最大 50 キー)

—

delete_remote

rclone リモート設定を削除する (リモートデータは削除しません)

name, confirm=True

*

サブアクション

説明

必須パラメータ

破壊的

update

システム設定を更新する (JSON キー/値入力)

settings_input (辞書; 最大 100 キー、スカラー値のみ)

—

configure_ups

UPS 監視設定を上書きする

ups_config (辞書), confirm=True

*

サブアクション

説明

必須パラメータ

theme

完全なテーマ、パートナー情報、およびアクティベーションコード

—

public_theme

公開向けテーマおよびパートナー情報 (未認証ビュー)

—

is_initial_setup

初期設定ウィザードが完了しているかどうか

—

sso_enabled

SSO が有効かどうか

—

set_theme

アクティブな UI テーマを設定する