PowerShellでvCenterのカスタム属性を編集してVM情報を整理する方法を徹底解説

# PowerCLIのインストール
Install-Module -Name VMware.PowerCLI -Scope CurrentUser

# SSL証明書の警告を無視する設定（必要に応じて）
Set-PowerCLIConfiguration -InvalidCertificateAction Ignore -Confirm:$false

# vCenterに接続
Connect-VIServer -Server "vcenter.example.com" -User "[email protected]" -Password "password"

Name                           Port  User
----                           ----  ----
vcenter.example.com            443   [email protected]

# 仮想マシンの情報を取得
$vm = Get-VM -Name "VM_Name"

# 拡張属性を確認
Get-Annotation -Entity $vm

Name                 Value
----                 -----
Project              Alpha
CostCenter           CC001
MaintenanceContact   [email protected]

# 全仮想マシンの拡張属性を取得
Get-VM | ForEach-Object {
    $vmName = $_.Name
    $annotations = Get-Annotation -Entity $_
    Write-Output "VM: $vmName"
    $annotations | ForEach-Object {
        Write-Output "  $_.Name : $_.Value"
    }
}

# 特定の拡張属性の値を取得
Get-VM | ForEach-Object {
    $vm = $_
    $annotation = Get-Annotation -Entity $vm | Where-Object { $_.Name -eq "Project" }
    if ($annotation) {
        Write-Output "$($vm.Name) - Project: $($annotation.Value)"
    }
}

# 拡張属性をCSVファイルにエクスポート
Get-VM | ForEach-Object {
    $vm = $_
    $annotations = Get-Annotation -Entity $vm
    foreach ($annotation in $annotations) {
        [PSCustomObject]@{
            VMName  = $vm.Name
            Name    = $annotation.Name
            Value   = $annotation.Value
        }
    }
} | Export-Csv -Path "annotations.csv" -NoTypeInformation -Encoding UTF8

# 新しい拡張属性を作成
New-CustomAttribute -Name "Environment" -TargetType VirtualMachine

# 仮想マシンの拡張属性を編集
$vm = Get-VM -Name "VM_Name"
Set-Annotation -Entity $vm -CustomAttribute "Environment" -Value "Production"

# 一括で属性を設定
Get-VM -Name "VM1", "VM2", "VM3" | ForEach-Object {
    Set-Annotation -Entity $_ -CustomAttribute "Environment" -Value "Test"
}

# 属性がなければ追加して設定
$vm = Get-VM -Name "VM_Name"
$attribute = Get-Annotation -Entity $vm | Where-Object { $_.Name -eq "Owner" }

if (-not $attribute) {
    New-CustomAttribute -Name "Owner" -TargetType VirtualMachine
}

Set-Annotation -Entity $vm -CustomAttribute "Owner" -Value "[email protected]"

# 属性を削除
Remove-CustomAttribute -Name "Environment"

# 属性の確認
Get-Annotation -Entity (Get-VM -Name "VM_Name")

# 全仮想マシンの情報を取得
$vmData = @()

Get-VM | ForEach-Object {
    $vm = $_
    $annotations = Get-Annotation -Entity $vm

    # 拡張属性をハッシュテーブルに変換
    $annotationData = @{}
    foreach ($annotation in $annotations) {
        $annotationData[$annotation.Name] = $annotation.Value
    }

    # 仮想マシンの情報を構造化
    $vmInfo = [PSCustomObject]@{
        Name          = $vm.Name
        PowerState    = $vm.PowerState
        CPU           = $vm.NumCpu
        MemoryGB      = $vm.MemoryGB
        Environment   = $annotationData["Environment"]
        Owner         = $annotationData["Owner"]
        Project       = $annotationData["Project"]
    }

    # 結果を配列に追加
    $vmData += $vmInfo
}

# 結果をCSVにエクスポート
$vmData | Export-Csv -Path "VM_Details.csv" -NoTypeInformation -Encoding UTF8

Write-Output "仮想マシン情報が 'VM_Details.csv' にエクスポートされました。"

# "Environment" が "Production" の仮想マシンを取得
$productionVMs = $vmData | Where-Object { $_.Environment -eq "Production" }

# 結果を表示
$productionVMs | Format-Table -AutoSize

# 必要に応じてCSVエクスポート
$productionVMs | Export-Csv -Path "Production_VMs.csv" -NoTypeInformation -Encoding UTF8

# 仮想マシンのコメントを一括更新
Get-VM | ForEach-Object {
    if ((Get-Annotation -Entity $_ -CustomAttribute "Environment").Value -eq "Production") {
        Set-VM -VM $_ -Notes "This VM is in production" -Confirm:$false
    }
}

# エラーハンドリング例
try {
    Set-Annotation -Entity $vm -CustomAttribute "Environment" -Value "Production"
} catch {
    Write-Output "Error: Failed to set annotation for VM: $($vm.Name)"
}

# 特定の仮想マシンのみを対象に設定
Get-VM -Name "VM1", "VM2" | Set-Annotation -CustomAttribute "Project" -Value "Alpha"

# ログファイルへの記録
Start-Transcript -Path "script-log.txt"

# スクリプト実行部分
try {
    Set-Annotation -Entity $vm -CustomAttribute "Owner" -Value "[email protected]"
} catch {
    Write-Output "Error occurred for VM: $($vm.Name)" >> "script-log.txt"
}

Stop-Transcript

# 負荷軽減の例
Get-VM | ForEach-Object {
    Set-Annotation -Entity $_ -CustomAttribute "Environment" -Value "Production"
    Start-Sleep -Milliseconds 500
}

Set-PowerCLIConfiguration -InvalidCertificateAction Ignore -Confirm:$false

# 拡張属性のバックアップ例
Get-VM | ForEach-Object {
    $vm = $_
    $annotations = Get-Annotation -Entity $vm
    $annotations | Export-Csv -Path "Backup.csv" -Append -NoTypeInformation
}

Connect-VIServer: Could not connect to one or more vCenter Server systems.

# 再接続の例
Connect-VIServer -Server "vcenter.example.com" -User "[email protected]" -Password "password"

Set-Annotation: The custom attribute 'Environment' does not exist.

# 属性が存在しない場合に作成
New-CustomAttribute -Name "Environment" -TargetType VirtualMachine

The term 'Get-VM' is not recognized as the name of a cmdlet.

# モジュールのインストールとインポート
Install-Module -Name VMware.PowerCLI -Scope CurrentUser
Import-Module VMware.PowerCLI

The SSL connection could not be established.

Set-PowerCLIConfiguration -InvalidCertificateAction Ignore -Confirm:$false

The operation is not allowed in the current state.

# VMの強制シャットダウン（注意が必要）
Stop-VM -VM "VM_Name" -Confirm:$false

The request could not be completed because the server reached its API call limit.

# 遅延を追加してリクエストを分散
Get-VM | ForEach-Object {
    Set-Annotation -Entity $_ -CustomAttribute "Environment" -Value "Production"
    Start-Sleep -Milliseconds 500
}

Cannot convert value 'XYZ' to type 'System.Int32'.

# データ型を正しく指定
Set-Annotation -Entity $vm -CustomAttribute "Priority" -Value "1"

# 仮想マシンの電源状態に応じて属性を更新
Get-VM | ForEach-Object {
    $vm = $_
    $powerState = $vm.PowerState

    if ($powerState -eq "PoweredOn") {
        Set-Annotation -Entity $vm -CustomAttribute "Status" -Value "Active"
    } elseif ($powerState -eq "PoweredOff") {
        Set-Annotation -Entity $vm -CustomAttribute "Status" -Value "Inactive"
    }
}

# 毎日更新するスクリプトの例
$script = {
    Get-VM | ForEach-Object {
        $vm = $_
        $powerState = $vm.PowerState

        if ($powerState -eq "PoweredOn") {
            Set-Annotation -Entity $vm -CustomAttribute "Status" -Value "Active"
        } elseif ($powerState -eq "PoweredOff") {
            Set-Annotation -Entity $vm -CustomAttribute "Status" -Value "Inactive"
        }
    }
}

# スケジュールに登録
Register-ScheduledJob -Name "UpdateVMStatus" -ScriptBlock $script -Trigger (New-JobTrigger -Daily -At "02:00")

# 仮想マシン情報を収集してレポート作成
$vmReport = Get-VM | ForEach-Object {
    $vm = $_
    $annotations = Get-Annotation -Entity $vm

    # レポート用オブジェクト
    [PSCustomObject]@{
        VMName       = $vm.Name
        PowerState   = $vm.PowerState
        CPU          = $vm.NumCpu
        MemoryGB     = $vm.MemoryGB
        Environment  = ($annotations | Where-Object { $_.Name -eq "Environment" }).Value
        Owner        = ($annotations | Where-Object { $_.Name -eq "Owner" }).Value
    }
}

# レポートをCSVファイルにエクスポート
$vmReport | Export-Csv -Path "VM_Report.csv" -NoTypeInformation -Encoding UTF8

Write-Output "レポートが 'VM_Report.csv' に保存されました。"

# ダッシュボードに必要なデータを抽出
$dashboardData = $vmReport | Where-Object { $_.Environment -eq "Production" } | 
    Select-Object VMName, PowerState, Owner

# 抽出結果を表示
$dashboardData | Format-Table -AutoSize

# メール送信設定
$smtpServer = "smtp.example.com"
$from = "[email protected]"
$to = "[email protected]"
$subject = "VM Report"
$body = "最新の仮想マシンレポートを添付しています。"

# レポート送信
Send-MailMessage -SmtpServer $smtpServer -From $from -To $to -Subject $subject -Body $body -Attachments "VM_Report.csv"