# 機能設計書 688-Get-DbaWsfcNetworkInterface

## 概要

本ドキュメントは、dbatools PowerShellモジュールの `Get-DbaWsfcNetworkInterface` コマンドレットに関する機能設計書です。Windows Server Failover Cluster (WSFC) ノードのネットワークインターフェース構成を取得する機能を提供します。

### 本機能の処理概要

**業務上の目的・背景**：クラスターノードのネットワークアダプター情報を詳細に把握することで、SQL Server Failover Cluster Instance の接続性問題の診断やクラスターネットワーク構成の検証が可能になります。IPアドレス、DHCP設定、ネットワーク割り当てなどの情報を一元的に取得できます。

**機能の利用シーン**：
- SQL Server FCI の接続性問題のトラブルシューティング
- クラスターネットワークトポロジのドキュメント化
- クラスターノード間の通信問題診断
- コンプライアンス監査のためのネットワーク構成確認

**主要な処理内容**：
1. 指定されたコンピュータまたはクラスターへ接続
2. クラスター情報を取得
3. MSCluster_NetworkInterface WMIクラスを照会
4. クラスター名とFQDNをプロパティに追加して出力

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

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

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 189 | WSFCネットワーク | 補助機能 | WSFCネットワークインターフェースの取得 |

## 機能種別

データ取得（クラスターノードのネットワークインターフェース構成取得）

## 入力仕様

### 入力パラメータ

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

### 入力データソース

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

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| ClusterName | string | クラスター名（追加プロパティ） |
| ClusterFqdn | string | クラスターFQDN（追加プロパティ） |
| Name | string | ネットワークインターフェース名 |
| Network | string | 所属ネットワーク名/識別子 |
| Node | string | 所属クラスターノード名 |
| Adapter | string | ネットワークアダプター名 |
| Address | string | IPアドレス |
| DhcpEnabled | bool | DHCP有効化フラグ |
| IPv4Addresses | string[] | IPv4アドレス配列 |
| IPv6Addresses | string[] | IPv6アドレス配列 |

### 出力先

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

## 処理フロー

### 処理シーケンス

```
1. 各ComputerNameをループ処理
   └─ Get-DbaWsfcClusterでクラスター情報取得
2. ネットワークインターフェース情報取得
   └─ Get-DbaCmObjectでMSCluster_NetworkInterface照会
3. プロパティ追加
   └─ ClusterName, ClusterFqdnをAdd-Member
4. 出力
   └─ Select-DefaultViewで既定プロパティを設定して出力
```

### フローチャート

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

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-001 | 管理者権限必須 | ローカル管理者権限が必要 | 常時 |
| BR-002 | 全ノードのNIC | クラスター全ノードのネットワークインターフェースを返却 | 常時 |

### 計算ロジック

なし

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

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

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

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

該当なし（WMI照会のみ）

## エラー処理

### エラーケース一覧

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

### リトライ仕様

リトライ処理なし

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

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

## パフォーマンス要件

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

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

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

## 備考

- Select-Object * でMSCluster_NetworkInterfaceの追加プロパティにアクセス可能
- 既定プロパティでIPv6Addressesが2回記述されている（ソースコードの誤記の可能性）

---

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

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

### 推奨読解順序

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

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

**読解のコツ**: MSCluster_NetworkInterface WMIクラスのオブジェクトに、Add-MemberでClusterName, ClusterFqdnを追加している。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Get-DbaWsfcNetworkInterface.ps1 | `public/Get-DbaWsfcNetworkInterface.ps1` | paramブロックとループ構造（67-72行目、73-81行目） |

**主要処理フロー**:
1. **70行目**: `$ComputerName = $env:COMPUTERNAME` - デフォルトはローカルコンピュータ
2. **75-76行目**: 各コンピュータに対してループ処理
3. **76行目**: `Get-DbaWsfcCluster` でクラスター情報取得
4. **77行目**: `Get-DbaCmObject` でWMI照会

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

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

**主要処理フロー**:
- **80行目**: 11個のプロパティを設定（ClusterName, ClusterFqdn, Name, Network, Node, Adapter, Address, DhcpEnabled, IPv4Addresses, IPv6Addresses, IPv6Addresses）
- **注意**: IPv6Addressesが2回記述されている（意図的か誤記か要確認）

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

```
Get-DbaWsfcNetworkInterface
    │
    ├─ Get-DbaWsfcCluster
    │      └─ クラスター情報取得
    │
    ├─ Get-DbaCmObject
    │      └─ MSCluster_NetworkInterface WMI照会
    │
    ├─ Add-Member
    │      └─ ClusterName, ClusterFqdn追加
    │
    └─ Select-DefaultView
           └─ 既定表示プロパティ設定
```

### データフロー図

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

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

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| Get-DbaWsfcNetworkInterface.ps1 | `public/Get-DbaWsfcNetworkInterface.ps1` | ソース | メイン機能実装 |
| Get-DbaWsfcCluster.ps1 | `public/Get-DbaWsfcCluster.ps1` | ソース | クラスター情報取得 |
| Get-DbaCmObject.ps1 | `internal/functions/Get-DbaCmObject.ps1` | ソース | WMI/CIM照会ユーティリティ |
| Select-DefaultView.ps1 | `internal/functions/Select-DefaultView.ps1` | ソース | 出力フォーマット制御 |
