Set-SCCustomProperty
カスタム プロパティのプロパティを変更します。
構文
Set-SCCustomProperty
[-VMMServer <ServerConnection>]
-CustomProperty <CustomProperty>
[-Name <String>]
[-Description <String>]
[-RunAsynchronously]
[-PROTipID <Guid>]
[-JobVariable <String>]
[<CommonParameters>]
Set-SCCustomProperty
[-VMMServer <ServerConnection>]
-CustomProperty <CustomProperty>
[-Name <String>]
[-Description <String>]
-AddMember <CustomPropertyObjectType[]>
[-RunAsynchronously]
[-PROTipID <Guid>]
[-JobVariable <String>]
[<CommonParameters>]
Set-SCCustomProperty
[-VMMServer <ServerConnection>]
-CustomProperty <CustomProperty>
[-Name <String>]
[-Description <String>]
-RemoveMember <CustomPropertyObjectType[]>
[-RunAsynchronously]
[-PROTipID <Guid>]
[-JobVariable <String>]
[<CommonParameters>]
説明
Set-SCCustomProperty コマンドレットは、カスタム プロパティのプロパティを変更します。 変更できるプロパティは次のとおりです。
- カスタム プロパティの説明
- カスタム プロパティの名前
- カスタム プロパティにメンバーを追加する
- カスタム プロパティからメンバーを削除する
カスタム プロパティの作成については、「.」と入力します Get-Help New-SCCustomProperty -Detailed
。
例
例 1: カスタム プロパティにメンバーを追加する
PS C:\> $CustomProp = Get-SCCustomProperty -Name "Cost Center"
PS C:\> Set-SCCustomProperty -CustomProperty $CustomProp -AddMember "VMHost"
最初のコマンドは、Cost Center という名前のカスタム プロパティ オブジェクトを取得し、$CustomProp変数にオブジェクトを格納します。
2 番目のコマンドは、$CustomPropに格納されているカスタム プロパティに VMHost メンバーを追加します。
例 2: カスタム プロパティからメンバーを削除する
PS C:\> $CustomProp = Get-SCCustomProperty -Name "Cost Center"
PS C:\> Set-SCCustomProperty -CustomProperty $CustomProp -RemoveMember "VM"
最初のコマンドは、Cost Center という名前のカスタム プロパティ オブジェクトを取得し、$CustomProp変数にオブジェクトを格納します。
2 番目のコマンドは、$CustomPropに格納されているカスタム プロパティ オブジェクトから VM メンバーを削除します。
パラメーター
-AddMember
グループなどのメンバーの概念を持つオブジェクトにこのコマンドレットが追加するメンバーの配列を指定します。 たとえば、このコマンドレットでは、1 つ以上の Active Directory® Domain Services ドメイン ユーザーまたはグループをユーザー ロールに追加できます。 次の形式でメンバーを指定します。
- Domain\User
- User
- User@Domain
- Domain\LabGroupAlias
- LabGroupAlias
ラボ グループのエイリアスは、電子メール エイリアスではなく、Active Directory Domain Servicesセキュリティ グループです。
Type: | CustomPropertyObjectType[] |
Accepted values: | VM, Template, VMHost, HostCluster, VMHostGroup, ServiceTemplate, ServiceInstance, ComputerTier, Cloud, ProtectionUnit |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-CustomProperty
カスタム プロパティ オブジェクトを指定します。
Type: | CustomProperty |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Description
指定したオブジェクトの説明を指定します。
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-JobVariable
ジョブの進行状況を追跡して、このパラメーターで示す名前の変数に保管するように指定します。
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Name
VMM オブジェクトの名前を指定します。
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-PROTipID
このアクションをトリガーしたパフォーマンスとリソース最適化のヒント (PRO ヒント) の ID を指定します。 このパラメーターを使用すると、PRO のヒントを監査できます。
Type: | Guid |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-RemoveMember
グループなどのメンバーシップの概念を持つ VMM オブジェクトからこのコマンドレットが削除するメンバーの配列を指定します。 たとえば、このコマンドレットは、ユーザー ロールから 1 つ以上のActive Directory Domain Servicesドメイン ユーザーまたはグループを削除できます。 次の形式でメンバーを指定します。
- Domain\User
- User
- User@Domain
- Domain\LabGroupAlias
- LabGroupAlias
ラボ グループのエイリアスは、電子メール エイリアスではなく、Active Directory Domain Servicesセキュリティ グループです。
Type: | CustomPropertyObjectType[] |
Accepted values: | VM, Template, VMHost, HostCluster, VMHostGroup, ServiceTemplate, ServiceInstance, ComputerTier, Cloud, ProtectionUnit |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-RunAsynchronously
コントロールがコマンド シェルに直ちに戻るように、ジョブが非同期的に実行されることを示します。
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-VMMServer
VMM サーバー オブジェクトを指定します。
Type: | ServerConnection |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |