# 機能設計書 435-Move-DbaRegServer

## 概要

本ドキュメントは、dbatools PowerShellモジュールにおけるMove-DbaRegServer機能の設計仕様を定義する。

### 本機能の処理概要

Move-DbaRegServerは、SQL Server Central Management Server（CMS）内のグループ間で登録サーバーを移動する機能である。

**業務上の目的・背景**：CMS構造の再編成、サーバーの役割変更、組織変更に伴うグループ移動など、登録サーバーの所属グループを変更する必要が生じる場面は多い。この機能は、SSMSでの手動操作を自動化し、複数サーバーの一括移動やスクリプトによる定期的な再編成を可能にする。

**機能の利用シーン**：
- サーバーの役割変更（開発→本番への昇格等）に伴うグループ移動
- CMS構造の再編成時のサーバー移動
- 複数サーバーの一括グループ変更
- 自動化スクリプトでのサーバー分類変更

**主要な処理内容**：
1. 対象サーバーの特定（Name/ServerName/InputObject）
2. 移動先グループの検証
3. SMOのScriptMoveメソッドでSQLスクリプト生成
4. ExecuteNonQueryでスクリプト実行
5. 移動後の登録サーバー情報を返却

**関連システム・外部連携**：SQL Server Central Management Server（CMS）

**権限による制御**：CMSへの変更権限（通常はsysadmin）が必要。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| - | 該当なし（コマンドライン機能） | - | - |

## 機能種別

データ操作 / UPDATE処理

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| SqlInstance | DbaInstanceParameter[] | No | CMSインスタンス | Name/ServerName指定時は必須 |
| SqlCredential | PSCredential | No | 代替認証情報 | - |
| Name | string[] | No | 移動対象の表示名 | SqlInstance指定時は必須（ServerNameと択一） |
| ServerName | string[] | No | 移動対象のサーバーインスタンス名 | SqlInstance指定時は必須（Nameと択一） |
| Group | string | No | 移動先グループ | バックスラッシュで階層指定可能 |
| InputObject | RegisteredServer[] | No | 移動対象オブジェクト | パイプライン入力可能 |
| WhatIf | switch | No | 実行前確認（実行しない） | - |
| Confirm | switch | No | 実行確認プロンプト | - |
| EnableException | switch | No | 例外処理の有効化 | - |

### 入力データソース

- Get-DbaRegServerからのパイプライン入力
- SqlInstance + Name/ServerNameの直接指定

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| ComputerName | string | CMSをホストするコンピュータ名 |
| InstanceName | string | CMSインスタンス名 |
| SqlInstance | string | 完全なCMSインスタンス名 |
| Name | string | 登録サーバーの表示名 |
| ServerName | string | SQL Server接続文字列 |
| Group | string | 移動後の新しいグループパス |

### 出力先

- 移動後の登録サーバーオブジェクトをパイプライン出力

## 処理フロー

### 処理シーケンス

```
1. パラメータ検証
   └─ SqlInstance指定時はName/ServerNameが必須
2. 対象サーバーの取得
   └─ Get-DbaRegServerで登録サーバーを取得
3. 親サーバーの取得
   └─ Get-RegServerParent内部関数で親サーバーオブジェクト取得
4. 移動先グループの取得
   └─ Get-DbaRegServerGroupで移動先グループオブジェクト取得
5. ShouldProcess確認
   └─ WhatIf/Confirmサポート
6. 移動スクリプト生成・実行
   └─ ScriptMoveメソッドでSQLスクリプト生成、ExecuteNonQuery実行
7. 結果返却
   └─ Get-DbaRegServerで移動後の情報を取得
8. 接続切断
   └─ Disconnect実行
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B{SqlInstance指定?}
    B -->|Yes| C{Name/ServerName指定?}
    C -->|No| D[Stop-Function エラー]
    C -->|Yes| E[Get-DbaRegServerで取得]
    B -->|No| F[InputObjectを使用]
    E --> G[regserverループ]
    F --> G
    G --> H[Get-RegServerParent]
    H --> I{parentserver取得成功?}
    I -->|No| J[Stop-Function]
    I -->|Yes| K{Group指定?}
    K -->|Yes| L[Get-DbaRegServerGroup]
    K -->|No| M[ルートグループ取得 Id=1]
    L --> N{グループ存在?}
    N -->|No| O[Stop-Function]
    N -->|Yes| P[ShouldProcess確認]
    M --> P
    P -->|No| Q{次のサーバー?}
    P -->|Yes| R[ScriptMove実行]
    R --> S[ExecuteNonQuery実行]
    S --> T[Get-DbaRegServer結果取得]
    T --> U[Disconnect]
    U --> Q
    J --> Q
    O --> Q
    Q -->|Yes| G
    Q -->|No| V[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-001 | 必須パラメータ | SqlInstance指定時はName/ServerNameのいずれかが必須 | begin block |
| BR-002 | グループ存在確認 | 移動先グループは事前に存在する必要がある | Group指定時 |
| BR-003 | ルート移動 | Group未指定時はルートレベル（Id=1）に移動 | Group未指定時 |
| BR-004 | ShouldProcess | 変更操作のためWhatIf/Confirmをサポート | 常時 |

### 計算ロジック

特になし。

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

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

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| サーバー移動 | msdb系システムテーブル | UPDATE | 登録サーバーのグループ所属を変更 |

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

SMOを介した間接的な操作のため、直接のテーブル操作仕様は非公開。ScriptMoveメソッドが生成するSQLを実行。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | パラメータエラー | SqlInstance指定時にName/ServerNameなし | Name/ServerNameを指定 |
| - | 親サーバー取得失敗 | Get-RegServerParentがnullを返却 | 登録サーバーの状態を確認 |
| - | グループ不存在 | 移動先グループがCMSに存在しない | グループを事前に作成 |
| - | 移動失敗 | ExecuteNonQuery実行エラー | 権限、接続を確認 |

### リトライ仕様

リトライ機能は実装されていない。

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

トランザクション管理はSMOに委譲。

## パフォーマンス要件

特定のパフォーマンス要件は定義されていない。

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

- CMSへの変更権限（sysadmin推奨）が必要
- ShouldProcessサポートにより誤操作を防止

## 備考

- NewGroupエイリアスでGroup指定可能
- Get-DbaRegServerからパイプラインで直接移動可能

---

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

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

### 推奨読解順序

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | Microsoft.SqlServer.Management.RegisteredServers.RegisteredServer | (SMO) | ScriptMoveメソッドの理解 |

**読解のコツ**: RegisteredServerオブジェクトのScriptMoveメソッドは、移動先グループを引数に取り、移動用SQLスクリプトを生成する。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Move-DbaRegServer.ps1 | `public/Move-DbaRegServer.ps1` | パラメータ定義、begin/processブロック構造 |

**主要処理フロー**:
1. **82-93行目**: パラメータ定義
2. **94-98行目**: begin block - パラメータ検証
3. **99-104行目**: SqlInstanceからサーバー取得

#### Step 3: 移動処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | Move-DbaRegServer.ps1 | `public/Move-DbaRegServer.ps1` | 移動処理のコアロジック |

**主要処理フロー**:
- **106-111行目**: Get-RegServerParentで親サーバー取得
- **115-123行目**: 移動先グループ取得
- **125-134行目**: ShouldProcess、ScriptMove、ExecuteNonQuery実行

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

```
Move-DbaRegServer
    │
    ├─ Get-DbaRegServer
    │      └─ 移動対象サーバー取得
    │
    ├─ Get-RegServerParent (内部関数)
    │      └─ 親サーバーオブジェクト取得
    │
    ├─ Get-DbaRegServerGroup
    │      └─ 移動先グループ取得
    │
    ├─ [RegisteredServer].ScriptMove()
    │      └─ 移動SQLスクリプト生成
    │
    ├─ [ServerConnection].ExecuteNonQuery()
    │      └─ スクリプト実行
    │
    └─ Disconnect-RegServer (内部関数)
           └─ 接続切断
```

### データフロー図

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

SqlInstance + Name ─────▶ Get-DbaRegServer ──────────┐
                                                     │
InputObject ────────────▶ 直接使用 ──────────────────┤
                                                     │
Group ──────────────────▶ Get-DbaRegServerGroup ────┤
                                                     │
                         ScriptMove() ───────────────┤
                                                     │
                         ExecuteNonQuery() ──────────┼──▶ RegisteredServer
                                                     │    (移動後)
                         Get-DbaRegServer ───────────┘
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Move-DbaRegServer.ps1 | `public/Move-DbaRegServer.ps1` | ソース | メイン機能実装 |
| Get-DbaRegServer.ps1 | `public/Get-DbaRegServer.ps1` | ソース | サーバー取得 |
| Get-DbaRegServerGroup.ps1 | `public/Get-DbaRegServerGroup.ps1` | ソース | グループ取得 |
