# 機能設計書 690-Get-DbaWsfcResource

## 概要

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

### 本機能の処理概要

**業務上の目的・背景**：SQL Serverインスタンス、ディスク、ネットワーク名、その他のサービスなど、フェイルオーバークラスターによって管理されるクラスターリソースの包括的な情報を取得します。現在の状態、所有権、依存関係、再起動ポリシー、タイムアウト設定などを確認でき、クラスター問題のトラブルシューティングやSQL Server FCIのヘルスモニタリングに必須の機能です。

**機能の利用シーン**：
- クラスターリソース障害の診断
- メンテナンスウィンドウの計画
- SQL Serverサービスが正常にフェイルオーバーしない原因の調査
- リソース所有者とホストノードの確認
- スタックしたリソースの特定

**主要な処理内容**：
1. 指定されたコンピュータまたはクラスターへ接続
2. クラスター情報を取得
3. MSCluster_Resource WMIクラスを照会
4. 各リソースにState変換とクラスター名を追加して出力

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

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

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 186 | WSFCリソース | 主機能 | WSFCリソースの取得 |

## 機能種別

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

## 入力仕様

### 入力パラメータ

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

### 入力データソース

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

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| ClusterName | string | クラスター名（追加プロパティ） |
| ClusterFqdn | string | クラスターFQDN（追加プロパティ） |
| Name | string | リソース名 |
| State | string | 運用状態（Online, Offline, Failed等） |
| Type | string | リソースタイプ（Physical Disk, IP Address等） |
| OwnerGroup | string | リソースが所属するリソースグループ |
| OwnerNode | string | 現在このリソースをホストしているノード |
| PendingTimeout | uint32 | オンライン/オフラインタイムアウト（ミリ秒） |
| PersistentState | bool | クラスターサービス開始時にオンラインにするか |
| QuorumCapable | bool | クォーラムリソースとして選択可能か |
| RequiredDependencyClasses | string[] | 依存するリソースクラス |
| RequiredDependencyTypes | string[] | 依存するリソースタイプ |
| RestartAction | int | 失敗時のアクション（0=再起動しない、1=フェイルオーバーなし再起動、2=フェイルオーバーあり再起動） |
| RestartDelay | uint32 | 再起動までの遅延（ミリ秒） |
| RestartPeriod | uint32 | 再起動試行追跡間隔（ミリ秒） |
| RestartThreshold | uint32 | 期間内の最大再起動試行回数 |
| RetryPeriodOnFailure | uint32 | 失敗リソースのリトライ間隔（ミリ秒） |
| SeparateMonitor | bool | 分離されたリソースモニタープロセスが必要か |

### 出力先

PowerShellパイプライン（WMI オブジェクト + 追加プロパティ）

## 処理フロー

### 処理シーケンス

```
1. 各ComputerNameをループ処理
   └─ Get-DbaWsfcClusterでクラスター情報取得
2. リソース情報取得
   └─ Get-DbaCmObjectでMSCluster_Resource照会
3. 各リソースをループ処理
   └─ State変換（Get-ResourceState）
   └─ ClusterName, ClusterFqdn追加
4. 出力
   └─ Select-DefaultViewで既定プロパティを設定して出力
```

### フローチャート

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

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-001 | 管理者権限必須 | ローカル管理者権限が必要 | 常時 |
| BR-002 | 全リソース情報 | クラスター内の全リソース情報を返却 | 常時 |
| BR-003 | State変換 | 数値StateをGet-ResourceStateで文字列に変換 | 常時 |

### 計算ロジック

State変換:
```powershell
$resource | Add-Member -Force -NotePropertyName State -NotePropertyValue (Get-ResourceState $resource.State)
```

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

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

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

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

該当なし（WMI照会のみ）

## エラー処理

### エラーケース一覧

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

### リトライ仕様

リトライ処理なし

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

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

## パフォーマンス要件

- 多数のリソースがある場合、各リソースに対してプロパティ追加処理が発生
- 大規模クラスターでは若干の処理時間増加の可能性

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

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

## 備考

- Select-Object * でMSCluster_Resourceの追加プロパティにアクセス可能
- 他のWSFC関数（Get-DbaWsfcDisk等）がこの関数を内部的に呼び出す

---

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

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

### 推奨読解順序

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Get-DbaWsfcResource.ps1 | `public/Get-DbaWsfcResource.ps1` | 既定プロパティの一覧（107行目） |

**読解のコツ**: MSCluster_Resource WMIクラスのオブジェクトに、Add-MemberでState, ClusterName, ClusterFqdnを追加している。Stateは数値から文字列に変換される。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Get-DbaWsfcResource.ps1 | `public/Get-DbaWsfcResource.ps1` | paramブロックとループ構造（92-98行目、99-109行目） |

**主要処理フロー**:
1. **95行目**: `$ComputerName = $env:COMPUTERNAME` - デフォルトはローカルコンピュータ
2. **100-101行目**: 各コンピュータに対してループ処理
3. **101行目**: `Get-DbaWsfcCluster` でクラスター情報取得
4. **102行目**: `Get-DbaCmObject` でWMI照会
5. **103-107行目**: 各リソースに対してプロパティ追加

#### Step 3: State変換を理解する

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

**主要処理フロー**:
- **104行目**: `Get-ResourceState $resource.State` - 数値StateをOnline/Offline/Failed等の文字列に変換
- **107行目**: 16個の既定プロパティを設定

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

```
Get-DbaWsfcResource
    │
    ├─ Get-DbaWsfcCluster
    │      └─ クラスター情報取得
    │
    ├─ Get-DbaCmObject
    │      └─ MSCluster_Resource WMI照会
    │
    ├─ Get-ResourceState
    │      └─ 状態値の文字列変換
    │
    ├─ Add-Member
    │      └─ State, ClusterName, ClusterFqdn追加
    │
    └─ Select-DefaultView
           └─ 既定表示プロパティ設定
```

### データフロー図

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

ComputerName ───────▶ Get-DbaWsfcCluster ─────▶ Cluster情報
      │                    │
      └──────────────────▶ Get-DbaCmObject ────▶ Resource[]
                           │
Resource[] ─────────────▶ Get-ResourceState ───▶ State文字列
                           │
Resource[] ─────────────▶ Add-Member ──────────▶ Resource[]
                                                 (プロパティ追加済み)
Resource[] ─────────────▶ Select-DefaultView ──▶ 出力
```

### 関連ファイル一覧

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