< Back
Set-vRAEntitlement
Post
NAME Set-vRAEntitlement
SYNOPSIS
Update an existing entitlement
SYNTAX
Set-vRAEntitlement -Id <String> [-Name <String>] [-Description <String>] [-Principals <String[]>]
[-EntitledCatalogItems <String[]>] [-EntitledResourceOperations <String[]>] [-EntitledServices <String[]>]
[-Status <String>] [-LocalScopeForActions <Boolean>] [-AllUsers <Boolean>] [-WhatIf] [-Confirm]
[<CommonParameters>]
DESCRIPTION
Update an existing entitlement
PARAMETERS
-Id <String>
The id of the entitlement
Required? true
Position? named
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-Name <String>
The name of the entitlement
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Description <String>
A description of the entitlement
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Principals <String[]>
Users or groups that will be associated with the entitlement
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-EntitledCatalogItems <String[]>
One or more entitled catalog item
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-EntitledResourceOperations <String[]>
The externalId of one or more entitled resource operation (e.g. Infrastructure.Machine.Action.PowerOn)
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-EntitledServices <String[]>
One or more entitled service
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Status <String>
The status of the entitlement. Accepted values are ACTIVE and INACTIVE
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-LocalScopeForActions <Boolean>
Determines if the entitled actions are entitled for all applicable service catalog items or only
items in this entitlement
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-AllUsers <Boolean>
Add all users to the entitlement
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
System.String.
OUTPUTS
System.Management.Automation.PSObject
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Set-vRAEntitlement -Id "e5cd1c84-3b76-4ae9-9f2e-35114da6cfd2" -Name "Updated Name"
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Set-vRAEntitlement -Id "e5cd1c84-3b76-4ae9-9f2e-35114da6cfd2" -Name "Updated Name" -Description "Updated
Description" -Principals "user@vsphere.local" -EntitledCatalogItems "Centos" -EntitledServices "A service"
-EntitledResourceOperations "Infrastructure.Machine.Action.PowerOff" -Status ACTIVE
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>Set-vRAEntitlement -Id "e5cd1c84-3b76-4ae9-9f2e-35114da6cfd2" -Name "Updated Name" -Description "Updated
Description" -AllUsers:$true
-------------------------- EXAMPLE 4 --------------------------
PS C:\\>Get-vRAEntitlement -Name "Entitlement 1" | Set-vRAEntitlement -Description "Updated description!"
RELATED LINKS
SYNOPSIS
Update an existing entitlement
SYNTAX
Set-vRAEntitlement -Id <String> [-Name <String>] [-Description <String>] [-Principals <String[]>]
[-EntitledCatalogItems <String[]>] [-EntitledResourceOperations <String[]>] [-EntitledServices <String[]>]
[-Status <String>] [-LocalScopeForActions <Boolean>] [-AllUsers <Boolean>] [-WhatIf] [-Confirm]
[<CommonParameters>]
DESCRIPTION
Update an existing entitlement
PARAMETERS
-Id <String>
The id of the entitlement
Required? true
Position? named
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-Name <String>
The name of the entitlement
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Description <String>
A description of the entitlement
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Principals <String[]>
Users or groups that will be associated with the entitlement
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-EntitledCatalogItems <String[]>
One or more entitled catalog item
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-EntitledResourceOperations <String[]>
The externalId of one or more entitled resource operation (e.g. Infrastructure.Machine.Action.PowerOn)
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-EntitledServices <String[]>
One or more entitled service
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Status <String>
The status of the entitlement. Accepted values are ACTIVE and INACTIVE
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-LocalScopeForActions <Boolean>
Determines if the entitled actions are entitled for all applicable service catalog items or only
items in this entitlement
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-AllUsers <Boolean>
Add all users to the entitlement
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
System.String.
OUTPUTS
System.Management.Automation.PSObject
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Set-vRAEntitlement -Id "e5cd1c84-3b76-4ae9-9f2e-35114da6cfd2" -Name "Updated Name"
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Set-vRAEntitlement -Id "e5cd1c84-3b76-4ae9-9f2e-35114da6cfd2" -Name "Updated Name" -Description "Updated
Description" -Principals "user@vsphere.local" -EntitledCatalogItems "Centos" -EntitledServices "A service"
-EntitledResourceOperations "Infrastructure.Machine.Action.PowerOff" -Status ACTIVE
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>Set-vRAEntitlement -Id "e5cd1c84-3b76-4ae9-9f2e-35114da6cfd2" -Name "Updated Name" -Description "Updated
Description" -AllUsers:$true
-------------------------- EXAMPLE 4 --------------------------
PS C:\\>Get-vRAEntitlement -Name "Entitlement 1" | Set-vRAEntitlement -Description "Updated description!"
RELATED LINKS