> ## Documentation Index
> Fetch the complete documentation index at: https://docs.sambanova.ai/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# コマンドリファレンス

本ドキュメントでは、SambaRack システムを管理するためのすべての `snctl` コマンド、グローバルオプション、およびサブコマンドの概要を説明します。

## コマンド構造

基本的なコマンド構造は次のとおりです。

```bash theme={}
snctl [GLOBAL_OPTIONS] <SUBCOMMAND> [SUBCOMMAND_OPTIONS] [ARGUMENTS]
```

## グローバルオプション

グローバルオプションは、任意の `snctl` コマンドで使用できます。

### --log-level

現在のコマンド実行のログレベルを設定します。

| 値 | 説明 |
| - | - |
| `DEBUG` | 詳細なデバッグ情報 |
| `INFO` | 一般的な情報 (デフォルト) |
| `WARNING` | 警告メッセージのみ |
| `ERROR` | エラーメッセージのみ |
| `CRITICAL` | 重大なエラーのみ |

**例:**

```bash theme={}
snctl --log-level DEBUG node list
```

### --snctl-dir

設定とログのベースディレクトリを上書きします。デフォルトは `~/.snctl` です。

**例:**

```bash theme={}
snctl --snctl-dir /custom/path/.snctl node list
```

### --version, -v

CLI のバージョンを表示して終了します。

**例:**

```bash theme={}
snctl --version
```

## サブコマンド

### config

SambaRack Manager の設定を管理します。

| コマンド | 説明 |
| - | - |
| `snctl config init` | 初期セットアップ用の対話型ウィザード |
| `snctl config show` | 現在の設定を表示 |

**config init**

`config init` コマンドは、以下を行う対話型ウィザードを提供します。

* 設定ファイルのフォルダの場所の設定 (デフォルト: `~/.snctl`)
* 新しい暗号鍵の生成
* 空のインベントリファイルの作成
* GCS アクセス用のサービスアカウントの設定 (任意)
* ログディレクトリの設定 (任意)

> [!NOTE]
>
> このコマンドの実行には空のディレクトリが必要です。対象ディレクトリに設定ファイルがすでに存在する場合、初期化は中止されます。

**config show**

現在の設定情報を表示します。

**出力例:**

```text theme={}
                       Current Configuration
+---------------------+-------------------------------------------+
| Setting             | Value                                     |
+---------------------+-------------------------------------------+
| Folder Location     | /home/user1/.snctl                        |
| Encryption Key File | /home/user1/.snctl/encryption.key         |
| Inventory File      | /home/user1/.snctl/inventory.json         |
| Service Account     | None                                      |
| Logs Location       | /home/user1/.snctl/logs                   |
| Version             | 0.0.5                                     |
| Last Updated        | 2025-12-08T11:19:27.403696Z               |
+---------------------+-------------------------------------------+
```

詳細な手順は [初期セットアップ](https://docs.sambanova.ai/docs/ja/v1.2.0/sambastack/hardware-admin/sambarack-manager/srm-initial-setup.md) をご参照ください。

### doctor

システムの依存関係と環境設定を確認し、システムが SambaRack Manager を使用できる状態かどうかを検査します。

```bash theme={}
snctl doctor
```

このコマンドは、必要なシステムバイナリとツールの有無を確認します。

**出力例:**

```text theme={}
                                         System Dependencies
+-------------------+---------+----------------------------+------------------------------------------------+
| Dependency        | Status  | Path/Details               | Description                                    |
+-------------------+---------+----------------------------+------------------------------------------------+
| ipmitool          | OK      | /usr/bin/ipmitool          | Required for BMC power operations              |
| ssh               | OK      | /usr/bin/ssh               | Required for remote connections                |
| sshpass           | OK      | /usr/bin/sshpass           | Required for password-based SSH authentication |
| ping              | OK      | /usr/bin/ping              | Required for connectivity checks               |
| curl              | OK      | /usr/bin/curl              | Required for HTTP requests                     |
| jq                | OK      | /usr/bin/jq                | Required for JSON processing                   |
| sed               | OK      | /usr/bin/sed               | Required for text processing                   |
| grep              | OK      | /usr/bin/grep              | Required for text filtering                    |
| awk               | OK      | /usr/bin/awk               | Required for text processing                   |
| bc                | OK      | /usr/bin/bc                | Required for floating point arithmetic         |
| screen            | OK      | /usr/bin/screen            | Required for background tasks                  |
| gptipmitool-linux | OK      | /usr/bin/gptipmitool-linux | Required for specific IPMI operations          |
| in.tftpd          | OK      | /usr/sbin/in.tftpd         | Required for TFTP services                     |
+-------------------+---------+----------------------------+------------------------------------------------+

All dependencies are met. Your system is ready to use SambaRack Manager.
```

### secret

暗号化されたデバイス認証情報を管理します。

| コマンド | 説明 |
| - | - |
| `snctl secret set --device-type <type>` | デバイスタイプのシークレットを設定 |
| `snctl secret get --device-type <type>` | シークレットを取得 (デフォルトでマスク表示) |
| `snctl secret get --device-type <type> --show-value` | シークレットを取得 (マスクなし) |

詳細な手順は [デバイス認証情報](https://docs.sambanova.ai/docs/ja/v1.2.0/sambastack/hardware-admin/sambarack-manager/srm-device-credentials.md) をご参照ください。

### rack

ラックおよびラックレベルのデバイスを管理します。

> [!NOTE]
>
> ラック ID には 001 から 255 までの範囲を指定できます。

| コマンド | 説明 |
| - | - |
| `snctl rack add <rack_id> --type <partnumber>` | 新しいラックをインベントリに追加 |
| `snctl rack list` | 設定済みのすべてのラックを一覧表示 |
| `snctl rack show <rack_id>` | ラックの詳細情報を表示 |
| `snctl rack delete <rack_id>` | ラックを削除 |
| `snctl rack add-device <device_path>` | ラック内のデバイスを追加または更新 |
| `snctl rack delete-device <target_id>` | ラックからデバイスを削除 |

詳細な手順は [ラック管理](https://docs.sambanova.ai/docs/ja/v1.2.0/sambastack/hardware-admin/sambarack-manager/srm-rack-admin.md) をご参照ください。

### node

ノードの管理と電源操作を実行します。

> [!NOTE]
>
> ノードは、ラックの追加時に SambaRack Manager へ自動的に追加されます。ノードを直接追加するコマンドはありません。

| コマンド | 説明 |
| - | - |
| `snctl node list` | 設定済みのすべてのノードを一覧表示 |
| `snctl node show <node_name>` | ノードの詳細情報を表示 |
| `snctl node rename <old_name> <new_name>` | ノード名を変更 |
| `snctl node powerstate --node <node_id> --type <type>` | 電源状態を確認 |
| `snctl node poweron --node <node_id> --type <type>` | ノードまたはデバイスの電源をオン |
| `snctl node poweroff --node <node_id> --type <type>` | ノードまたはデバイスの電源をオフ |
| `snctl node powercycle --node <node_id> --type node` | ノードをパワーサイクル |

詳細な手順は [ノード管理](https://docs.sambanova.ai/docs/ja/v1.2.0/sambastack/hardware-admin/sambarack-manager/srm-node-admin.md) をご参照ください。

### group

一括操作のために、ラックのグループを管理します。

| コマンド | 説明 |
| - | - |
| `snctl group create <name> --description <desc>` | 新しいグループを作成 |
| `snctl group list` | すべてのグループを一覧表示 |
| `snctl group show <name>` | グループの詳細を表示 |
| `snctl group delete <name>` | グループを削除 |
| `snctl group add-rack <name> --rack-id <id>` | グループにラックを追加 |
| `snctl group remove-rack <name> --rack-id <id>` | グループからラックを削除 |

> [!NOTE]
>
> グループ名には英数字を使用してください。

詳細な手順は [グループ管理](https://docs.sambanova.ai/docs/ja/v1.2.0/sambastack/hardware-admin/sambarack-manager/srm-group-admin.md) をご参照ください。

### device

デバイスのファームウェアを管理し、デバイスレベルの操作を実行します。

| コマンド | 説明 |
| - | - |
| `snctl device firmware-check --rack-id <id> --type <type>` | ラックのファームウェアバージョンを確認 |
| `snctl device firmware-check --group <name> --type <type>` | グループのファームウェアバージョンを確認 |
| `snctl device firmware-update (--rack-id <id> \| --group <name>) --type <type>` | ラックまたはグループ内のデバイスのファームウェアを更新 |

詳細な手順は [デバイス管理](https://docs.sambanova.ai/docs/ja/v1.2.0/sambastack/hardware-admin/sambarack-manager/srm-device-admin.md) をご参照ください。

## ヘルプの表示

任意のコマンドやサブコマンドのヘルプは、以下のように表示できます。

```bash theme={}
# Show top-level help
snctl --help

# Show subcommand help
snctl <subcommand> --help

# Show command-specific help
snctl <subcommand> <command> --help
```