# 機能設計書 686-Get-DbaWsfcDisk

## 概要

本ドキュメントは、dbatools PowerShellモジュールの `Get-DbaWsfcDisk` コマンドレットに関する機能設計書です。Windows Server Failover Cluster (WSFC) のクラスター化された物理ディスクに関する詳細情報を取得する機能を提供します。

### 本機能の処理概要

**業務上の目的・背景**：SQL Server Failover Cluster Instance (FCI) を管理するDBAにとって、クラスターディスクの容量、空き容量、ファイルシステム、マウントポイントなどの詳細情報を把握することは重要です。ストレージのヘルスチェック、キャパシティプランニング、ボトルネック特定などに活用できます。

**機能の利用シーン**：
- SQL Server FCI のストレージヘルスモニタリング
- クラスターディスク容量の監視と計画
- ストレージボトルネックの特定
- キャパシティアップグレードの計画

**主要な処理内容**：
1. Get-DbaWsfcResource で Physical Disk タイプのリソースを取得
2. 各ディスクリソースに関連するMSCluster_Diskを取得
3. さらに関連するMSCluster_DiskPartitionを取得
4. カスタムオブジェクトを構築して出力

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

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

## 関連画面

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

## 機能種別

データ取得（クラスターディスク詳細情報の取得）

## 入力仕様

### 入力パラメータ

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

### 入力データソース

- Get-DbaWsfcResource からの Physical Disk リソース
- WMI MSCluster_Disk および MSCluster_DiskPartition クラス

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| ClusterName | string | クラスター名 |
| ClusterFqdn | string | クラスターFQDN |
| ResourceGroup | string | リソースの所有グループ |
| Disk | string | ディスクリソース名 |
| State | string | ディスクリソースの状態 |
| FileSystem | string | ファイルシステム（NTFS, ReFS等） |
| Path | string | ディスクパーティションのマウントパス |
| Label | string | ボリュームラベル |
| Size | dbasize | ディスク総容量 |
| Free | dbasize | 空き容量 |
| MountPoints | string[] | マウントポイント配列（非表示） |
| SerialNumber | string | 物理ディスクのシリアル番号 |
| ClusterDisk | CIM | MSCluster_Diskオブジェクト（非表示） |
| ClusterDiskPart | CIM | MSCluster_DiskPartitionオブジェクト（非表示） |
| ClusterResource | CIM | MSCluster_Resourceオブジェクト（非表示） |

### 出力先

PowerShellパイプライン（PSCustomObject）

## 処理フロー

### 処理シーケンス

```
1. 各ComputerNameをループ処理
   └─ Get-DbaWsfcResourceでPhysical Diskリソースを取得
2. 各リソースをループ処理
   └─ Get-CimAssociatedInstanceでMSCluster_Disk取得
3. 各ディスクをループ処理
   └─ Get-CimAssociatedInstanceでMSCluster_DiskPartition取得
4. カスタムオブジェクト構築
   └─ サイズをdbasizeオブジェクトに変換
5. 出力
   └─ Select-DefaultViewで非表示プロパティを除外して出力
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B{各ComputerNameをループ}
    B --> C[Get-DbaWsfcResource -Type Physical Disk]
    C --> D{各リソースをループ}
    D --> E[Get-CimAssociatedInstance MSCluster_Disk]
    E --> F{各ディスクをループ}
    F --> G[Get-CimAssociatedInstance MSCluster_DiskPartition]
    G --> H[PSCustomObject構築]
    H --> I[Size/Freeをdbasizeに変換]
    I --> J[Select-DefaultViewで出力]
    J --> F
    F -->|完了| D
    D -->|完了| B
    B -->|完了| K[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-001 | 管理者権限必須 | ローカル管理者権限が必要 | 常時 |
| BR-002 | Physical Diskのみ | タイプが 'Physical Disk' のリソースのみ対象 | 常時 |
| BR-003 | サイズ変換 | TotalSize と FreeSpace は MB 単位で返されるため 1MB 乗算 | 常時 |

### 計算ロジック

サイズ変換:
```powershell
Size = [dbasize]($diskpart.TotalSize * 1MB)
Free = [dbasize]($diskpart.FreeSpace * 1MB)
```

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

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

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

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

該当なし（WMI照会のみ）

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| WMIError | 接続エラー | WMI名前空間へのアクセス失敗 | dbatoolsエラーハンドリングに委任 |
| PermissionError | 権限エラー | ローカル管理者権限なし | 適切な権限で再実行 |
| NoDiskError | ディスクなし | Physical Diskリソースが存在しない | 情報メッセージ（暗黙的にスキップ） |

### リトライ仕様

リトライ処理なし

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

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

## パフォーマンス要件

- 多数のディスクがある場合は複数のWMI照会が発生
- CIM関連インスタンス照会はネットワーク遅延に影響を受ける

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

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

## 備考

- dbasize型はバイト、KB、MB、GB、TB間の単位変換に対応
- ClusterDisk, ClusterDiskPart, ClusterResourceは非表示だがアクセス可能

---

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

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

### 推奨読解順序

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Get-DbaWsfcDisk.ps1 | `public/Get-DbaWsfcDisk.ps1` | PSCustomObjectの構造（77-93行目） |

**読解のコツ**: [dbasize]型へのキャストに注意。TotalSizeとFreeSpaceはMB単位で返されるため1MBを乗算している。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Get-DbaWsfcDisk.ps1 | `public/Get-DbaWsfcDisk.ps1` | paramブロックとループ構造（64-69行目、70-96行目） |

**主要処理フロー**:
1. **66行目**: `$ComputerName = $env:COMPUTERNAME` - デフォルトはローカルコンピュータ
2. **71-72行目**: Get-DbaWsfcResourceでPhysical Diskリソースを取得
3. **74行目**: Get-CimAssociatedInstanceでMSCluster_Disk取得
4. **76行目**: Get-CimAssociatedInstanceでMSCluster_DiskPartition取得

#### Step 3: 関連クラスの取得を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Get-DbaWsfcDisk.ps1 | `public/Get-DbaWsfcDisk.ps1` | Get-CimAssociatedInstanceの使用（74, 76行目） |

**主要処理フロー**:
- **74行目**: `$resource | Get-CimAssociatedInstance -ResultClassName MSCluster_Disk` - リソースからディスク情報取得
- **76行目**: `$disk | Get-CimAssociatedInstance -ResultClassName MSCluster_DiskPartition` - ディスクからパーティション情報取得
- **93行目**: `Select-DefaultView -ExcludeProperty ClusterDisk, ClusterDiskPart, ClusterResource` - 非表示プロパティ設定

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

```
Get-DbaWsfcDisk
    │
    ├─ Get-DbaWsfcResource
    │      └─ Physical Disk タイプでフィルタ
    │
    ├─ Get-CimAssociatedInstance
    │      ├─ MSCluster_Disk
    │      └─ MSCluster_DiskPartition
    │
    └─ Select-DefaultView
           └─ 非表示プロパティ除外
```

### データフロー図

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

ComputerName ───────▶ Get-DbaWsfcResource ────▶ Resource[]
                           │                    (Physical Disk)
Resource ──────────────▶ Get-CimAssociatedInstance ─▶ Disk[]
                           │
Disk ──────────────────▶ Get-CimAssociatedInstance ─▶ DiskPartition[]
                           │
Data ──────────────────▶ PSCustomObject ───────▶ 出力
                           (Size/Free変換)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Get-DbaWsfcDisk.ps1 | `public/Get-DbaWsfcDisk.ps1` | ソース | メイン機能実装 |
| Get-DbaWsfcResource.ps1 | `public/Get-DbaWsfcResource.ps1` | ソース | リソース取得 |
| Select-DefaultView.ps1 | `internal/functions/Select-DefaultView.ps1` | ソース | 出力フォーマット制御 |
