# 機能設計書 253-Test-DbaPowerPlan

## 概要

本ドキュメントは、dbatools PowerShellモジュールにおける`Test-DbaPowerPlan`コマンドレットの機能設計書です。Windowsの電源プラン設定をSQL Serverベストプラクティスに対してテストし、非準拠のシステムを特定します。

### 本機能の処理概要

`Test-DbaPowerPlan`コマンドは、SQL Serverホストマシンの現在アクティブなWindows電源プランを取得し、推奨される「High Performance」プラン（または指定したカスタムプラン）と比較して、ベストプラクティスへの準拠状況を報告します。

**業務上の目的・背景**：SQL Serverは「High Performance」電源プランで最適に動作します。他の電源プランではCPUスロットリングが発生し、クエリパフォーマンスや応答時間に影響を与える可能性があります。特にWindowsサーバーのデフォルト設定が「Balanced」の場合、意図せずパフォーマンスが低下することがあります。本機能は、SQL Server環境での電源管理設定を監査し、パフォーマンス問題の原因となりうる設定を特定するために使用されます。

**機能の利用シーン**：
- 新規SQL Serverインスタンスのセットアップ時の構成検証
- 定期的なコンプライアンス監査
- パフォーマンス問題のトラブルシューティング
- 環境標準化の検証
- サーバーハードウェア変更後の設定確認

**主要な処理内容**：
1. 対象コンピュータから利用可能な電源プラン一覧を取得
2. 現在アクティブな電源プランを特定
3. 推奨電源プラン（High Performanceまたはカスタム指定）と比較
4. 準拠状況をレポート出力

**関連システム・外部連携**：WMI/CIMを使用してWindows電源プラン情報を取得します。`Get-DbaPowerPlan`コマンドを内部的に使用します。

**権限による制御**：対象コンピュータへのWMI/CIMリモートアクセス権限が必要です。通常、管理者権限が求められます。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| - | - | - | 本機能はPowerShellコマンドレットであり、関連するGUI画面はありません |

## 機能種別

バリデーション / 構成監査

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| ComputerName | DbaInstance[] | Yes | 電源プランをテストするSQL Serverホスト | パイプライン入力可能 |
| Credential | PSCredential | No | リモートコンピュータへの認証情報 | パイプラインプロパティから受け付け |
| PowerPlan | string | No | カスタム比較対象プラン名（デフォルトはHigh Performance） | パイプラインプロパティから受け付け |
| EnableException | switch | No | 例外を有効にする | - |

### 入力データソース

- PowerShellコマンドラインからの直接入力
- パイプライン経由での入力（Get-DbaPowerPlanの出力など）
- プロパティによるパイプラインバインディング

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| ComputerName | string | 対象コンピュータ名 |
| ActivePowerPlan | string | 現在アクティブな電源プラン名 |
| RecommendedPowerPlan | string | 推奨電源プラン名（またはエラーメッセージ） |
| IsBestPractice | bool | アクティブプランが推奨プランと一致する場合$true |
| ActiveInstanceId | string | アクティブプランのUUID（追加プロパティ） |
| RecommendedInstanceId | string | 推奨プランのUUID（追加プロパティ） |
| Credential | PSCredential | 使用された認証情報（追加プロパティ） |

### 出力先

- PowerShellパイプライン（PSCustomObject）
- Select-DefaultViewによりデフォルト表示プロパティが制限

## 処理フロー

### 処理シーケンス

```
1. begin ブロック
   └─ High Performanceプランの既知UUID初期化
2. process ブロック
   └─ 各ComputerNameに対してループ処理
      ├─ Get-DbaPowerPlanで電源プラン一覧取得
      ├─ エラー時はStop-FunctionでContinue
      ├─ カスタムPowerPlan指定の場合
      │   ├─ 指定プランを検索
      │   └─ 見つからない場合はエラーメッセージ設定
      ├─ デフォルト（High Performance）の場合
      │   ├─ UUIDでHigh Performanceプランを検索
      │   └─ 見つからない場合はエラーメッセージ設定
      ├─ アクティブプランを特定
      ├─ UUID比較でIsBestPractice判定
      └─ PSCustomObject出力
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B[bpPowerPlanオブジェクト初期化]
    B --> C{ComputerNameループ}
    C -->|次のコンピュータ| D[Get-DbaPowerPlan -List]
    D -->|成功| E{PowerPlan指定あり?}
    D -->|失敗| F[Stop-Function/Continue]
    F --> C
    E -->|Yes| G[カスタムプラン検索]
    E -->|No| H[High Performanceプラン検索]
    G --> I{プラン見つかった?}
    H --> I
    I -->|Yes| J[推奨プラン設定]
    I -->|No| K[エラーメッセージ設定]
    J --> L[アクティブプラン取得]
    K --> L
    L --> M[UUID比較]
    M --> N[IsBestPractice設定]
    N --> O[PSCustomObject出力]
    O --> C
    C -->|完了| P[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-001 | デフォルト推奨プラン | High Performance（UUID: 8c5e7fda-e8bf-4a96-9a85-a6e23a8c635c） | PowerPlan未指定時 |
| BR-002 | UUID比較判定 | InstanceIDの一致でベストプラクティス判定 | 常に適用 |
| BR-003 | カスタムプラン対応 | PowerPlanパラメータで任意のプラン名を指定可能 | PowerPlan指定時 |

### 計算ロジック

- `IsBestPractice` = ActiveInstanceId == RecommendedInstanceId

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

本機能はデータベース操作を行いません。WMI/CIM経由でWindowsオペレーティングシステムの情報を取得します。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| namespace | 名前空間エラー | サポートされないOS | Stop-FunctionでスキップしてContinue |
| credentials | 認証エラー | 資格情報が正しくない | Stop-FunctionでスキップしてContinue |
| その他 | 一般エラー | その他の接続失敗 | Stop-FunctionでスキップしてContinue |

### リトライ仕様

本機能にはリトライ機能はありません。

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

本機能は読み取り専用であり、トランザクション管理は不要です。

## パフォーマンス要件

- 各コンピュータへのWMI/CIM接続は通常数秒以内に完了
- 複数コンピュータを処理する場合は順次処理

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

- リモートコンピュータへのWMI/CIMアクセス権限が必要
- 資格情報はPSCredentialオブジェクトとして安全に受け渡し
- 読み取り専用操作のため、システム変更のリスクなし

## 備考

- 参考URL: https://support.microsoft.com/en-us/kb/2207548
- 参考URL: http://www.sqlskills.com/blogs/glenn/windows-power-plan-effects-on-newer-intel-processors/
- High Performanceプランが存在しない場合（一部のWindows 10/11環境）はエラーメッセージを返却

---

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

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

### 推奨読解順序

#### Step 1: パラメータとエントリーポイントを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Test-DbaPowerPlan.ps1 | `public/Test-DbaPowerPlan.ps1` | 関数全体の構造とパラメータ定義 |

**主要処理フロー**:
1. **85-94行目**: パラメータ定義（ComputerName、Credential、PowerPlan、EnableException）
2. **96-101行目**: beginブロックでHigh Performance UUID初期化

**読解のコツ**:
- `[parameter(ValueFromPipelineByPropertyName)]`によりGet-DbaPowerPlanの出力をそのままパイプできる
- `[Alias("CustomPowerPlan")]`で旧パラメータ名もサポート

#### Step 2: 電源プラン取得と比較ロジックを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Test-DbaPowerPlan.ps1 | `public/Test-DbaPowerPlan.ps1` | 103-152行目：processブロックのメインロジック |

**主要処理フロー**:
- **106-107行目**: Get-DbaPowerPlan -Listで全プラン取得
- **118-132行目**: 推奨プラン（カスタムまたはHigh Performance）の検索
- **134行目**: アクティブプランのフィルタリング
- **137-141行目**: IsBestPractice判定

#### Step 3: 出力オブジェクト構築を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Test-DbaPowerPlan.ps1 | `public/Test-DbaPowerPlan.ps1` | 143-151行目：PSCustomObject生成と出力 |

**主要処理フロー**:
- **143-150行目**: 出力オブジェクトの構築
- **151行目**: Select-DefaultViewによるデフォルト表示プロパティの制限

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

```
Test-DbaPowerPlan
    │
    ├─ Get-DbaPowerPlan -List
    │      └─ WMI/CIM経由で電源プラン一覧取得
    │
    └─ Select-DefaultView
           └─ 出力プロパティのフィルタリング
```

### データフロー図

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

ComputerName    ───▶ Get-DbaPowerPlan -List
                            │
Credential      ───────────┘
                            │
PowerPlan       ───▶ 推奨プラン特定     ───▶ UUID比較
                            │                     │
                            ▼                     ▼
                     全プランリスト          IsBestPractice判定
                            │                     │
                            ▼                     ▼
                     アクティブプラン特定   PSCustomObject ───▶ 出力
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Test-DbaPowerPlan.ps1 | `public/Test-DbaPowerPlan.ps1` | ソース | メイン関数定義 |
| Get-DbaPowerPlan.ps1 | `public/Get-DbaPowerPlan.ps1` | ソース | 電源プラン取得関数 |
| Stop-Function.ps1 | `internal/functions/flowcontrol/Stop-Function.ps1` | ソース | エラーハンドリング関数 |
