Azure StorSimple 関連の PowerShell コマンドレット (Set-AzureStorSimpleDeviceBackupPolicy) について

スポンサーリンク

StorSimple は、Microsoft 社が提供するハイブリッドのクラウド ストレージ サービスです。 Microsoft Azure と組み合わせることで、Azure ストレージを拡張領域として利用することが可能であり、また別拠点でのデータ復旧が可能であることから、効率的なデータ管理、災害対策が実現できます。

Azure StorSimple デバイスの管理に使用することが可能な PowerShell コマンドレットが提供されており、設定方法について MSDN サイト上で公開されていますが、PowerShell コマンドレットのヘルプについては英語のみであり、日本語による情報はほとんど公開されていません。

Azure StorSimple 関連の PowerShell コマンドレットの 1 つである「Set-AzureStorSimpleDeviceBackupPolicy」について、本ブログにて日本語の情報として纏めてみました((他の PowerShell コマンドレットについては、「Azure StorSimple 関連の PowerShell コマンドレットについて」を参照) (Windows Azure PowerShell バージョン 0.9.7 で確認しているものとなります)。

■名前

Set-AzureStorSimpleDeviceBackupPolicy

■概要

存在するバックアップ ポリシーを更新します。

■構文

Set-AzureStorSimpleDeviceBackupPolicy [-DeviceName] <String> [-BackupPolicyId] <String> [-BackupPolicyName] <String> [[-BackupSchedulesToAdd] [<PSObject[]>]] [[-BackupSchedulesToUpdate] [<PSObject[]>]] [[-BackupScheduleIdsToDelete] [<PSObject[]>]] [[-VolumeIdsToUpdate] [<PSObject[]>]] [[-WaitForComplete]] [[-NewName] [<System.String>]] [-Profile [<Microsoft.Azure.Common.Authentication.Models.AzureProfile>]] [<CommonParameters>]

■説明

Set-AzureStorSimpleDeviceBackupPolicy コマンドレットは、存在するバックアップ ポリシーを更新します。ポリシーの名前の変更、スケジュールの追加 / 更新 / 削除、およびポリシーに関連付けられたボリュームの更新が可能です。

■パラメーター

-BackupPolicyId <String>
更新する BackupPolicy オブジェクトのインスタンス ID を指定します。

必須true
位置2
既定値なし
パイプライン入力を許可するfalse
ワイルドカード文字を許可するfalse

-BackupPolicyName <String>
バックアップ ポリシーの新しい名前を指定します。

必須true
位置3
既定値なし
パイプライン入力を許可するfalse
ワイルドカード文字を許可するfalse

-BackupScheduleIdsToDelete [<PSObject[]>]
削除する BackupSchedule オブジェクトのインスタンス ID の配列を指定します。

必須false
位置6
既定値なし
パイプライン入力を許可するfalse
ワイルドカード文字を許可するfalse

-BackupSchedulesToAdd [<PSObject[]>]
ポリシーに追加する BackupScheduleBase オブジェクトの配列を指定します。BackupScheduleBase オブジェクトを取得するために、New-AzureStorSimpleDeviceBackupScheduleAddConfig コマンドレットを用います。

必須false
位置4
既定値なし
パイプライン入力を許可するfalse
ワイルドカード文字を許可するfalse

-BackupSchedulesToUpdate [<PSObject[]>]
更新する BackupScheduleUpdateRequest オブジェクトの配列を指定します。BackupScheduleUpdateRequest オブジェクトを指定するために、New-AzureStorSimpleDeviceBackupScheduleUpdateConfig コマンドレットを用います。

必須false
位置5
既定値なし
パイプライン入力を許可するfalse
ワイルドカード文字を許可するfalse

-DeviceName <String>
バックアップ ポリシーを構成する StorSimple デバイス名を指定します。

必須true
位置1
既定値なし
パイプライン入力を許可するfalse
ワイルドカード文字を許可するfalse

-NewName [<System.String>]
デバイス名を指定します。

必須false
位置9
既定値なし
パイプライン入力を許可するfalse
ワイルドカード文字を許可するfalse

-Profile [<Microsoft.Azure.Common.Authentication.Models.AzureProfile>]
Azure プロファイルを指定します。

必須false
位置named
既定値なし
パイプライン入力を許可するfalse
ワイルドカード文字を許可するfalse

-VolumeIdsToUpdate [<PSObject[]>]
バックアップ ポリシーを更新するボリュームの ID の配列を指定します。

必須false
位置7
既定値なし
パイプライン入力を許可するfalse
ワイルドカード文字を許可するfalse

-WaitForComplete [<SwitchParameter>]
Windows PowerShell コンソールに制御を返す前に、このコマンドレットが完了するための操作に対して待機するかを示します。

必須false
位置8
既定値なし
パイプライン入力を許可するfalse
ワイルドカード文字を許可するfalse

<CommonParameters>
このコマンドレットは、次の共通パラメーターをサポートします: –Verbose、-Debug、-ErrorAction-ErrorVariable、-WarningAction、-WarningVariable、-OutBuffer、-PipelineVariable、および -OutVariable。詳細については、about_CommonParameters を参照してください。

■入力

  • なし

■出力

  • TaskStatusInfo, TaskResponse
    このコマンドレットは、-WaitForComplete パラメーターが指定されている場合、TaskStatusInfo オブジェクトを返します。パラメーターが指定されていない場合、TaskResponse オブジェクトを返します。

■メモ

  • 詳細については、「Get-Help Set-AzureStorSimpleDeviceBackupPolicy -detailed」と入力してください。
  • 技術情報については、「Get-Help Set-AzureStorSimpleDeviceBackupPolicy -full」と入力してください。

■エイリアス

  • なし

■例

例 1: バックアップ ポリシー名の変更

Set-AzureStorSimpleDeviceBackupPolicy -DeviceName "Contoso63-AppVm" -BackupPolicyId "e6d9f1b3-a250-4d57-966a-039c8eaef9e9" -BackupPolicyName "UpdatedGeneralPolicy07" -WaitForComplete
VERBOSE: ClientRequestId: f4465b46-26cc-40ff-88da-7a28df88c35c_PS
VERBOSE: ClientRequestId: 5e33a35c-e089-47c1-b760-474635b1ead8_PS
VERBOSE: About to run a task to update your backuppolicy!
VERBOSE: ClientRequestId: e379ebdb-667f-45a9-aafa-a6cd61e5f6f6_PS

JobId        : 9d621bfd-3faa-4d1c-b28b-45c5f4a96975
JobResult    : Succeeded
JobStatus    : Completed
ErrorCode    :
ErrorMessage :
JobSteps     : {Microsoft.WindowsAzure.Management.StorSimple.Models.TaskStep}

VERBOSE: The job created for your update operation has completed successfully.
VERBOSE: ClientRequestId: 4fe965ea-4e12-4869-9d67-e42a24b6c5d8_PS
BackupSchedules          : {58e9cd7c-4c6a-4e33-9109-5ec0b8fcb2cc, b10e1bf4-ef0a-4ad3-8fde-eecfc9971dd2}
Volumes                  : {testvolume03}
BackupPolicyCreationType : BySaaS
LastBackup               : 12/16/2014 2:13:28 PM
NextBackup               : 12/16/2014 3:13:43 PM
SchedulesCount           : 2
SSMHostName              :
VolumesCount             : 1
InstanceId               : e6d9f1b3-a250-4d57-966a-039c8eaef9e9
Name                     : UpdatedGeneralPolicy07
OperationInProgress      : None

このコマンドは、指定した ID に対してバックアップ ポリシー名を「UpdatedGeneralPolicy07」に変更します。このコマンドは、-WaitForComplete パラメーターが指定されているため、コマンドがタスクを完了したら、タスクに対する TaskStatusInfo オブジェクトを返します。

例 2: バックアップ ポリシーのスケジュールの更新

$UpdateConfig = New-AzureStorSimpleDeviceBackupScheduleUpdateConfig -Id "3a6c6247-6b4d-42e2-aa87-16f4f21476ea" -BackupType CloudSnapshot -RecurrenceType Daily -RecurrenceValue 3 -RetentionCount 2 -Enabled $True
$UpdateArray = @()
$UpdateArray += $UpdateConfig
Set-AzureStorSimpleDeviceBackupPolicy -DeviceName "Contoso63-AppVm" -BackupPolicyId "712605f6-eb03-4db8-8f79-e0ce64b2cce1" -BackupSchedulesToUpdate $UpdateArray

Error      : Microsoft.WindowsAzure.Management.StorSimple.Models.ErrorDetails
JobId      : 7b265417-a5f1-45ad-8fbc-33bad4f63ec9
JobSteps   : {Microsoft.WindowsAzure.Management.StorSimple.Models.JobStep,
             Microsoft.WindowsAzure.Management.StorSimple.Models.JobStep,
             Microsoft.WindowsAzure.Management.StorSimple.Models.JobStep,
             Microsoft.WindowsAzure.Management.StorSimple.Models.JobStep…}
Result     : Succeeded
Status     : Completed
TaskResult : Succeeded
StatusCode : OK
RequestId  : d2e10d44e699b371a84db44d19daf1c3

1 番目のコマンドは、New-AzureStorSimpleDeviceBackupScheduleUpdateConfig コマンドレットを用いることで、更新する構成オブジェクトを作成し、変数 $UpdateConfig に格納します。

2 番目のコマンドは、新しい配列変数 $UpdateArray を作成します。次のコマンドは、配列に $UpdateConfig に格納された更新を追加します。

最後のコマンドは、デバイス名「Contoso63-AppVm」上の指定した ID を持つバックアップ ポリシーを更新します。ポリシーは、現在 $UpdateArray に格納されている更新されたスケジュールを持ちます。

■関連するトピック

  • Get-AzureStorSimpleDeviceBackupPolicy
  • New-AzureStorSimpleDeviceBackupPolicy
  • Remove-AzureStorSimpleDeviceBackupPolicy
  • New-AzureStorSimpleDeviceBackupScheduleUpdateConfig

[参考]