snctl コマンド、引数、フラグの完全なリファレンスです。
snctl は、ラックベースのインフラストラクチャインベントリ、電源操作、およびファームウェアの確認とアップグレードを管理します。
グローバルフラグ
すべてのコマンドで使用できます。-o wide はすべてのコマンドでサポートされているわけではありません。power on、power off、power cycle、firmware upgrade、group create、group add-rack、group remove-rack、group delete は text または json のみを受け付けます。rack export では -o の用法が異なります — rack export をご参照ください。コマンド索引
共通の値
複数のコマンドから参照される値です。デバイスタイプ
access_switch、bmc、data_switch、host、pdu、serial_terminal、xrdu
firmware version はこれらに加えて bios、card、all を受け付けます。firmware upgrade は bios、bmc、xrdu、card、all のみを受け付けます。
デバイスパス
PDU は 1 始まり、XRDU は 0 始まり (
0〜7) です。host と bmc はインデックスを取りません。
同時実行フラグ
すべてのpower および firmware サブコマンドで使用できます。
環境変数
config
snctl の設定を管理します。config init
暗号鍵、空のインベントリ、設定を作成して snctl を初期化します。config.yaml を作成します。ラックの登録や認証情報の設定を行う前に、一度だけ実行してください。
初期化済みのディレクトリに対して再実行するとエラーになります。既存の設定を確認するには
config show を使用してください。config show
現在の snctl 設定を表示します。config.yaml、インベントリファイル、暗号鍵、シークレットファイルへのパスに加え、GCS サービスアカウントやログディレクトリなどの任意設定を表示します。snctl が初期化されていない場合は、その旨を表示して正常終了します。
コマンド固有のフラグはありません。
config update
既存の snctl 設定のフィールドを更新します。diag
snctl のインストールと環境の健全性を診断します。diag doctor
システムの依存関係と環境の健全性を確認します。ipmitool などのツールを含め、snctl が必要とするすべてのシステム依存関係がインストールされていることを検証し、その状態を報告します。コマンドが予期せず失敗する場合に実行してください。
コマンド固有のフラグはありません。
rack
ラックインベントリを管理します。rack add
新しいラックをインベントリに追加します。--partnumber はハードウェアモデルを識別し、これによってラックに自動生成されるコンポーネントレイアウトが決まります。
rack add-device
ラック内のデバイスを追加または更新します。<target> は デバイスパス です。フィールドを省略すると現在の値が維持されます (部分更新)。
rack delete
ラックをインベントリから削除します。rack delete-device
ラックからデバイスを削除します。rack export
ラックを JSON または YAML ファイルにエクスポートします。パスワードは常にプレースホルダ値に置き換えられるため、エクスポートファイルは安全に共有できます。
rack import
JSON または YAML ファイルからラックとグループをインポートします。- を使用します。
認証情報の扱い。ソースファイル内の、プレースホルダになっていないデバイスパスワードは、デバイス単位の認証情報として暗号化された認証情報ストアにインポートされます。インベントリ自体にはプレースホルダのみが保存されます。デフォルトの認証情報が未設定のデバイス種別については、その種別で最も番号の小さいラックのパスワードが、その種別のデフォルトにもなります。シークレットが出力されることはありません。
--dry-run は、何も書き込まずに、インポートされるシークレットの件数を報告します。
rack list
インベントリ内のすべてのラックを一覧表示します。rack show
ラック内のすべてのデバイスを表示します。node
インベントリ内のノードを管理します。node list
インベントリ内のすべてのノードを一覧表示します。node rename
ノードの名前を変更します。ローカルのインベントリに対する操作のみです。ハードウェア自体のホスト名は変更されません。
node show
ノード内のすべてのデバイスを表示します。group
ラックグループを管理します。グループを使用すると、ファームウェアコマンドと電源コマンドを単一の操作で複数のラックに一括展開できます。group create
グループを作成するか、その説明を更新します。group add-rack
1 つ以上のラックをグループに追加します。group remove-rack
グループからラックを削除します。group list
インベントリ内のすべてのグループを一覧表示します。group show
グループとその所属ラックを表示します。group delete
グループをインベントリから削除します。所属ラックは削除されません — グループのレコードのみが削除されます。スクリプト内でプロンプトを抑制するには、
SNCTL_NON_INTERACTIVE=1 を設定してください。secret
デバイスシークレットを管理します。認証情報は AES-GCM で暗号化され、~/.snctl/credentials.json.enc に保存されます。
secret set
デバイスシークレットを設定または削除します。
デバイス単位の認証情報は、種別レベルのデフォルトよりも優先されます。未設定の認証情報をクリアしてもエラーにはならず正常に完了します。デバイス単位のオーバーライドをクリアすると、そのデバイスは種別レベルの認証情報にフォールバックします。
secret get
デバイスシークレットを取得します。*** にマスクされます。
power
ノードの電源オン、電源オフ、パワーサイクル、状態照会を行います。操作は IPMI または Redfish 経由で実行されます。すべての電源コマンドでは、
--node または --group のいずれか一方の指定が必須です (同時には指定できません)。また、事前に secret set でデバイス認証情報を設定しておく必要があります。power state
ノード、ホスト、または XRDU の電源状態を照会します。power on
ノード、ホスト、または XRDU の電源を入れます。snd.service (SambaNova Daemon) がアクティブになるのを待ってから完了します。
power off
ノード、ホスト、または XRDU の電源を切ります。power cycle
ノード全体のパワーサイクルを実行します。--type フラグはありません。完了前に snd.service を待機します。
firmware
ノードのファームウェアの照会と更新を行います。どちらのコマンドでも、
--rack-id または --group のいずれか一方の指定が必須です (同時には指定できません)。また、事前に secret set でデバイス認証情報を設定しておく必要があります。firmware version
ラックのコンポーネントにインストールされているファームウェアバージョンを照会します。CURR) がプランオブレコード (Plan of Record; POR) のバージョン (POR) と並べて表示されるため、乖離を一目で把握できます。
firmware upgrade
ラックのコンポーネントにファームウェアイメージを適用します。--image の動作。省略した場合、各コンポーネントの POR バージョンに対応する正しいファイルが GCS から自動的にダウンロードされ、チェックサム検証のうえキャッシュされます。代わりに特定のローカルファイルを書き込むには --image を渡します。エアギャップ環境では必須です。
--index の制約。xrdu と card でのみ使用できます。bios、bmc、all では拒否されます。BIOS と BMC はスロットを持たないノードレベルのコンポーネントであり、all は両方の種別が混在するため、インデックスを指定するとアップグレードの一部だけが絞り込まれてしまうためです。
version
バージョンとビルド情報を表示します。-o json を使用してください。
コマンド固有のフラグはありません。

