# 機能設計書 685-Get-DbaWsfcCluster

## 概要

本ドキュメントは、dbatools PowerShellモジュールの `Get-DbaWsfcCluster` コマンドレットに関する機能設計書です。Windows Server Failover Cluster (WSFC) の構成およびステータス情報を取得する機能を提供します。

### 本機能の処理概要

**業務上の目的・背景**：SQL Server高可用性環境を管理するDBAにとって、WSFCのクラスター構成と運用状態を把握することは重要です。クォーラム設定、共有ボリューム構成、クラスターの現在の状態など、障害対応やキャパシティプランニングに必要なメタデータを一元的に取得できます。

**機能の利用シーン**：
- クラスター問題のトラブルシューティング
- SQL Serverインストール前のクラスターヘルス検証
- 高可用性構成のドキュメント化
- キャパシティプランニングとディザスタリカバリ準備

**主要な処理内容**：
1. 指定されたコンピュータまたはクラスターへ接続
2. MSCluster_Cluster WMIクラスを照会
3. State プロパティを追加（Get-ResourceStateで変換）
4. Select-DefaultViewで既定プロパティを設定して出力

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

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

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 184 | WSFCクラスター | 主機能 | WSFCクラスターの取得 |

## 機能種別

データ取得（クラスター構成情報の取得）

## 入力仕様

### 入力パラメータ

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

### 入力データソース

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

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| Name | string | クラスター名 |
| Fqdn | string | クラスターFQDN |
| State | string | 運用状態（追加プロパティ） |
| DrainOnShutdown | uint32 | シャットダウン時のリソースドレイン |
| DynamicQuorumEnabled | uint32 | 動的クォーラム有効化 |
| EnableSharedVolumes | uint32 | クラスター共有ボリューム有効化 |
| SharedVolumesRoot | string | CSVルートディレクトリ |
| QuorumPath | string | クォーラムファイルパス |
| QuorumType | string | クォーラムタイプ（文字列） |
| QuorumTypeValue | uint32 | クォーラムタイプ（数値） |
| RequestReplyTimeout | uint32 | リクエスト応答タイムアウト（ミリ秒） |

### 出力先

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

## 処理フロー

### 処理シーケンス

```
1. 各ComputerNameをループ処理
   └─ Get-DbaCmObjectでMSCluster_Cluster照会
2. プロパティ追加
   └─ StateをAdd-Member（Get-ResourceStateで変換）
3. 出力
   └─ Select-DefaultViewで既定プロパティを設定して出力
```

### フローチャート

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

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-001 | 管理者権限必須 | ローカル管理者権限が必要 | 常時 |
| BR-002 | ノードまたはクラスター名 | ComputerNameはノード名でもクラスター名でも可 | 常時 |

### 計算ロジック

なし

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

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

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

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

該当なし（WMI照会のみ）

## エラー処理

### エラーケース一覧

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

### リトライ仕様

リトライ処理なし

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

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

## パフォーマンス要件

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

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

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

## 備考

- Select-DefaultViewで既定表示プロパティを設定
- Select-Object * で追加のWMIプロパティにアクセス可能

---

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

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

### 推奨読解順序

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Get-DbaWsfcCluster.ps1 | `public/Get-DbaWsfcCluster.ps1` | 出力される既定プロパティ（112行目） |

**読解のコツ**: MSCluster_Cluster WMIクラスのオブジェクトに、Add-MemberでStateを追加し、Select-DefaultViewで表示プロパティを設定している。

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

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

**主要処理フロー**:
1. **104行目**: `$ComputerName = $env:COMPUTERNAME` - デフォルトはローカルコンピュータ
2. **109行目**: 各コンピュータに対してループ処理
3. **110行目**: `Get-DbaCmObject` でWMI照会
4. **111行目**: `Add-Member` でState追加
5. **112行目**: `Select-DefaultView` で既定プロパティ設定

#### Step 3: 既定プロパティを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Get-DbaWsfcCluster.ps1 | `public/Get-DbaWsfcCluster.ps1` | Select-DefaultViewのプロパティ一覧（112行目） |

**主要処理フロー**:
- **112行目**: 11個の既定プロパティを設定（Name, Fqdn, State, DrainOnShutdown, DynamicQuorumEnabled, EnableSharedVolumes, SharedVolumesRoot, QuorumPath, QuorumType, QuorumTypeValue, RequestReplyTimeout）

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

```
Get-DbaWsfcCluster
    │
    ├─ Get-DbaCmObject
    │      └─ MSCluster_Cluster WMI照会
    │
    ├─ Get-ResourceState
    │      └─ 状態値の変換
    │
    ├─ Add-Member
    │      └─ Stateプロパティ追加
    │
    └─ Select-DefaultView
           └─ 既定表示プロパティ設定
```

### データフロー図

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

ComputerName ───────▶ Get-DbaCmObject ─────────▶ Cluster情報
                           │
Cluster ──────────────────▶ Add-Member ─────────▶ Cluster
                           │                    (State追加)
Cluster ──────────────────▶ Select-DefaultView ─▶ Cluster
                                                 (既定プロパティ)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| 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` | ソース | リソース状態変換 |
| Select-DefaultView.ps1 | `internal/functions/Select-DefaultView.ps1` | ソース | 出力フォーマット制御 |
