# 機能設計書 684-Get-DbaWsfcAvailableDisk

## 概要

本ドキュメントは、dbatools PowerShellモジュールの `Get-DbaWsfcAvailableDisk` コマンドレットに関する機能設計書です。Windows Server Failover Cluster (WSFC) に追加可能な共有ストレージディスクを取得する機能を提供します。

### 本機能の処理概要

**業務上の目的・背景**：SQL Server Failover Cluster Instance (FCI) を構成・拡張する際、クラスターに追加可能な共有ストレージディスクを特定する必要があります。本機能は、全クラスターノードから可視で、まだクラスターのストレージプールに追加されていないディスクを特定し、FCI拡張やストレージトラブルシューティングを支援します。

**機能の利用シーン**：
- SQL Server FCIの新規ストレージ追加計画時
- クラスターストレージの可視性トラブルシューティング
- クラスター拡張前のストレージ検証
- ストレージ接続性の監査

**主要な処理内容**：
1. 指定されたコンピュータまたはクラスターへ接続
2. クラスター情報を取得
3. MSCluster_AvailableDisk WMIクラスを照会
4. クラスター名やFQDNをプロパティに追加して出力

**関連システム・外部連携**：Windows Management Instrumentation (WMI) の root\MSCluster 名前空間を使用してクラスター情報を取得します。

**権限による制御**：WSFC コマンドはすべて、各メンバーノードでのローカル管理者権限が必要です。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 188 | WSFCディスク | 補助機能 | WSFC利用可能ディスクの取得 |

## 機能種別

データ取得（クラスターで利用可能なディスクの一覧取得）

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| ComputerName | DbaInstanceParameter[] | No | 対象クラスターまたはノード | デフォルト: $env:COMPUTERNAME、パイプライン入力可能 |
| Credential | PSCredential | No | 代替認証情報 | ローカル管理者権限必要 |
| EnableException | switch | No | 例外を有効化 | デフォルト: $false |

### 入力データソース

- WMI root\MSCluster 名前空間の MSCluster_AvailableDisk クラス

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| State | string | ディスクの運用状態（追加プロパティ） |
| ClusterName | string | クラスター名（追加プロパティ） |
| ClusterFqdn | string | クラスターFQDN（追加プロパティ） |
| Name | string | ディスクのラベル/名称 |
| Id | string | ディスク一意識別子（GUID） |
| Size | uint64 | ディスク容量（バイト） |
| Number | int | ホストノード上のディスク番号 |
| Status | string | 運用ステータス |
| ConnectedNodes | string[] | ディスクにアクセス可能なノード名配列 |
| Signature | uint32 | MBRディスクシグネチャ |
| GptGuid | string | GPTパーティションのGUID |
| ScsiPort | int | SCSIポート番号 |
| ScsiBus | int | SCSIバス識別子 |
| ScsiTargetID | int | SCSIターゲット識別番号 |
| ScsiLUN | int | SCSI論理ユニット番号 |
| Node | string | ディスク情報を提供するノード名 |
| ResourceName | string | クラスター追加時のリソース名 |

### 出力先

PowerShellパイプライン（CIM Instance オブジェクト）

## 処理フロー

### 処理シーケンス

```
1. 各ComputerNameをループ処理
   └─ クラスター情報取得（Get-DbaWsfcCluster）
2. 利用可能ディスク取得
   └─ Get-DbaCmObjectでMSCluster_AvailableDisk照会
3. プロパティ追加
   └─ State, ClusterName, ClusterFqdnをAdd-Member
4. 出力
   └─ パイプラインに出力（PassThru）
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B{各ComputerNameをループ}
    B --> C[Get-DbaWsfcCluster呼び出し]
    C --> D[Get-DbaCmObject呼び出し]
    D --> E[MSCluster_AvailableDisk取得]
    E --> F[Add-Member: State]
    F --> G[Add-Member: ClusterName]
    G --> H[Add-Member: ClusterFqdn]
    H --> I[パイプライン出力]
    I --> B
    B -->|完了| J[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-001 | 管理者権限必須 | ローカル管理者権限が必要 | 常時 |
| BR-002 | ディスク可視性 | 全ノードから可視のディスクのみが利用可能として表示 | 常時 |
| BR-003 | 未割り当てディスク | クラスターストレージプールに未追加のディスクのみ対象 | 常時 |

### 計算ロジック

なし

## データベース操作仕様

### 操作別データベース影響一覧

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| なし | - | - | WMI照会のみでDB操作なし |

### テーブル別操作詳細

該当なし（WMI照会のみ）

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| WMIError | 接続エラー | WMI名前空間へのアクセス失敗 | dbatoolsエラーハンドリングに委任 |
| PermissionError | 権限エラー | ローカル管理者権限なし | 適切な権限で再実行 |

### リトライ仕様

リトライ処理なし

## トランザクション仕様

読み取り専用操作のため、トランザクション管理不要

## パフォーマンス要件

特になし（WMI単一クエリ）

## セキュリティ考慮事項

- ローカル管理者権限が必要
- 認証情報はSecureStringとして扱われる
- クラスターノード間の信頼関係が必要

## 備考

- ソースコードコメントによると、利用可能ディスクがない環境ではテストが困難
- Get-ResourceState関数でState値を変換（$resource.Stateの参照だが、$resourceは未定義の可能性あり）

---

## コードリーディングガイド

本機能を理解するために参照すべきファイルと、推奨する読み解き順序を以下に示す。

### 推奨読解順序

#### Step 1: データ構造を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Get-DbaWsfcAvailableDisk.ps1 | `public/Get-DbaWsfcAvailableDisk.ps1` | WMIオブジェクトに追加されるプロパティ（83-85行目） |

**読解のコツ**: MSCluster_AvailableDisk WMIクラスのオブジェクトに、Add-MemberでState, ClusterName, ClusterFqdnを追加している。

#### Step 2: エントリーポイントを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Get-DbaWsfcAvailableDisk.ps1 | `public/Get-DbaWsfcAvailableDisk.ps1` | paramブロックとデフォルト値（71-76行目） |

**主要処理フロー**:
1. **73行目**: `$ComputerName = $env:COMPUTERNAME` - デフォルトはローカルコンピュータ
2. **78-79行目**: 各コンピュータに対してループ処理
3. **80行目**: `Get-DbaWsfcCluster` でクラスター情報取得
4. **80行目**: `Get-DbaCmObject` でWMI照会

#### Step 3: WMI照会を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Get-DbaWsfcAvailableDisk.ps1 | `public/Get-DbaWsfcAvailableDisk.ps1` | Get-DbaCmObject呼び出し（80行目） |

**主要処理フロー**:
- **80行目**: `Get-DbaCmObject -Namespace root\MSCluster -ClassName MSCluster_AvailableDisk` - WMI照会
- **83行目**: `Get-ResourceState` 関数呼び出し（State変換）
- **85行目**: `-PassThru` でオブジェクトをそのまま出力

### プログラム呼び出し階層図

```
Get-DbaWsfcAvailableDisk
    │
    ├─ Get-DbaWsfcCluster
    │      └─ クラスター情報取得
    │
    ├─ Get-DbaCmObject
    │      └─ MSCluster_AvailableDisk WMI照会
    │
    ├─ Get-ResourceState
    │      └─ 状態値の変換
    │
    └─ Add-Member
           └─ プロパティ追加
```

### データフロー図

```
[入力]               [処理]                    [出力]

ComputerName ───────▶ Get-DbaWsfcCluster ─────▶ Cluster情報
      │                    │
      └──────────────────▶ Get-DbaCmObject ────▶ AvailableDisk[]
                           │
AvailableDisk[] ─────────▶ Add-Member ─────────▶ AvailableDisk[]
                                                 (プロパティ追加済み)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Get-DbaWsfcAvailableDisk.ps1 | `public/Get-DbaWsfcAvailableDisk.ps1` | ソース | メイン機能実装 |
| Get-DbaWsfcCluster.ps1 | `public/Get-DbaWsfcCluster.ps1` | ソース | クラスター情報取得 |
| Get-DbaCmObject.ps1 | `internal/functions/Get-DbaCmObject.ps1` | ソース | WMI/CIM照会ユーティリティ |
| Get-ResourceState.ps1 | `internal/functions/Get-ResourceState.ps1` | ソース | リソース状態変換 |
