< Back
New-vRAReservation
Post
NAME New-vRAReservation
SYNOPSIS
Create a new reservation
SYNTAX
New-vRAReservation -Type <String> -Name <String> [-Tenant <String>] -BusinessGroup <String> [-ReservationPolicy
<String>] [-Priority <Int32>] -ComputeResourceId <String> [-Quota <Int32>] -MemoryGB <Int32> -Storage <PSObject[]>
[-Network <PSObject[]>] [-ResourcePool <String>] [-EnableAlerts] [-EmailBusinessGroupManager] [-AlertRecipients
<String[]>] [-StorageAlertPercentageLevel <Int32>] [-MemoryAlertPercentageLevel <Int32>] [-CPUAlertPercentageLevel
<Int32>] [-MachineAlertPercentageLevel <Int32>] [-AlertReminderFrequency <Int32>] [-WhatIf] [-Confirm]
[<CommonParameters>]
New-vRAReservation -JSON <String> [-NewName <String>] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
Create a new reservation
PARAMETERS
-Type <String>
The reservation type
Valid types vRA 7.1 and earlier: Amazon, Hyper-V, KVM, OpenStack, SCVMM, vCloud Air, vCloud Director, vSphere,
XenServer
Valid types vRA 7.2 and later: Amazon EC2, Azure, Hyper-V (SCVMM), Hyper-V (Standalone), KVM (RHEV),
OpenStack, vCloud Air, vCloud Director, vSphere (vCenter), XenServer
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Name <String>
The name of the reservation
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Tenant <String>
The tenant that will own the reservation
Required? false
Position? named
Default value $Global:vRAConnection.Tenant
Accept pipeline input? false
Accept wildcard characters? false
-BusinessGroup <String>
The business group that will be associated with the reservation
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ReservationPolicy <String>
The reservation policy that will be associated with the reservation
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Priority <Int32>
The priority of the reservation
Required? false
Position? named
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-ComputeResourceId <String>
The compute resource that will be associated with the reservation
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Quota <Int32>
The number of machines that can be provisioned in the reservation
Required? false
Position? named
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-MemoryGB <Int32>
The amount of memory available to this reservation
Required? true
Position? named
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-Storage <PSObject[]>
The storage that will be associated with the reservation
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Network <PSObject[]>
The network that will be associated with this reservation
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ResourcePool <String>
The resource pool that will be associated with this reservation
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-EnableAlerts [<SwitchParameter>]
Enable alerts
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-EmailBusinessGroupManager [<SwitchParameter>]
Email the alerts to the business group manager
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-AlertRecipients <String[]>
The recipients that will recieve email alerts
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-StorageAlertPercentageLevel <Int32>
The threshold for storage alerts
Required? false
Position? named
Default value 80
Accept pipeline input? false
Accept wildcard characters? false
-MemoryAlertPercentageLevel <Int32>
The threshold for memory alerts
Required? false
Position? named
Default value 80
Accept pipeline input? false
Accept wildcard characters? false
-CPUAlertPercentageLevel <Int32>
The threshold for cpu alerts
Required? false
Position? named
Default value 80
Accept pipeline input? false
Accept wildcard characters? false
-MachineAlertPercentageLevel <Int32>
The threshold for machine alerts
Required? false
Position? named
Default value 80
Accept pipeline input? false
Accept wildcard characters? false
-AlertReminderFrequency <Int32>
Alert frequency in days
Required? false
Position? named
Default value 20
Accept pipeline input? false
Accept wildcard characters? false
-JSON <String>
Body text to send in JSON format
Required? true
Position? named
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
-NewName <String>
If passing a JSON payload NewName can be used to set the reservation name
Required? false
Position? named
Default value
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
System.Int
System.Management.Automation.SwitchParameter
System.Management.Automation.PSObject
OUTPUTS
System.Management.Automation.PSObject
-------------------------- EXAMPLE 1 --------------------------
PS C:\\># --- Create a new Reservation in vRA 7.1
# --- Get the compute resource id
$ComputeResource = Get-vRAReservationComputeResource -Type 'vSphere' -Name 'Cluster01 (vCenter)'
# --- Get the network definition
$NetworkDefinitionArray = @()
$Network1 = New-vRAReservationNetworkDefinition -Type 'vSphere' -ComputeResourceId $ComputeResource.Id
-NetworkPath 'VM Network' -NetworkProfile 'Test-Profile'
$NetworkDefinitionArray += $Network1
# --- Get the storage definition
$StorageDefinitionArray = @()
$Storage1 = New-vRAReservationStorageDefinition -Type 'vSphere' -ComputeResourceId $ComputeResource.Id -Path
'Datastore1' -ReservedSizeGB 10 -Priority 0
$StorageDefinitionArray += $Storage1
# --- Set the parameters and create the reservation
$Param = @{
Type = 'vSphere'
Name = 'Reservation01'
Tenant = 'Tenant01'
BusinessGroup = 'Default Business Group[Tenant01]'
ReservationPolicy = 'ReservationPolicy1'
Priority = 0
ComputeResourceId = $ComputeResource.Id
Quota = 0
MemoryGB = 2048
Storage = $StorageDefinitionArray
ResourcePool = 'Resources'
Network = $NetworkDefinitionArray
EnableAlerts = $false
}
New-vRAReservation @Param -Verbose
-------------------------- EXAMPLE 2 --------------------------
PS C:\\># --- Create a new Reservation in vRA 7.2 and later
# --- Get the compute resource id
$ComputeResource = Get-vRAReservationComputeResource -Type 'vSphere (vCenter)' -Name 'Cluster01 (vCenter)'
# --- Get the network definition
$NetworkDefinitionArray = @()
$Network1 = New-vRAReservationNetworkDefinition -Type 'vSphere (vCenter)' -ComputeResourceId $ComputeResource.Id
-NetworkPath 'VM Network' -NetworkProfile 'Test-Profile'
$NetworkDefinitionArray += $Network1
# --- Get the storage definition
$StorageDefinitionArray = @()
$Storage1 = New-vRAReservationStorageDefinition -Type 'vSphere (vCenter)' -ComputeResourceId $ComputeResource.Id
-Path 'Datastore1' -ReservedSizeGB 10 -Priority 0
$StorageDefinitionArray += $Storage1
# --- Set the parameters and create the reservation
$Param = @{
Type = 'vSphere (vCenter)'
Name = 'Reservation01'
Tenant = 'Tenant01'
BusinessGroup = 'Default Business Group[Tenant01]'
ReservationPolicy = 'ReservationPolicy1'
Priority = 0
ComputeResourceId = $ComputeResource.Id
Quota = 0
MemoryGB = 2048
Storage = $StorageDefinitionArray
ResourcePool = 'Resources'
Network = $NetworkDefinitionArray
EnableAlerts = $false
}
New-vRAReservation @Param -Verbose
RELATED LINKS
SYNOPSIS
Create a new reservation
SYNTAX
New-vRAReservation -Type <String> -Name <String> [-Tenant <String>] -BusinessGroup <String> [-ReservationPolicy
<String>] [-Priority <Int32>] -ComputeResourceId <String> [-Quota <Int32>] -MemoryGB <Int32> -Storage <PSObject[]>
[-Network <PSObject[]>] [-ResourcePool <String>] [-EnableAlerts] [-EmailBusinessGroupManager] [-AlertRecipients
<String[]>] [-StorageAlertPercentageLevel <Int32>] [-MemoryAlertPercentageLevel <Int32>] [-CPUAlertPercentageLevel
<Int32>] [-MachineAlertPercentageLevel <Int32>] [-AlertReminderFrequency <Int32>] [-WhatIf] [-Confirm]
[<CommonParameters>]
New-vRAReservation -JSON <String> [-NewName <String>] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
Create a new reservation
PARAMETERS
-Type <String>
The reservation type
Valid types vRA 7.1 and earlier: Amazon, Hyper-V, KVM, OpenStack, SCVMM, vCloud Air, vCloud Director, vSphere,
XenServer
Valid types vRA 7.2 and later: Amazon EC2, Azure, Hyper-V (SCVMM), Hyper-V (Standalone), KVM (RHEV),
OpenStack, vCloud Air, vCloud Director, vSphere (vCenter), XenServer
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Name <String>
The name of the reservation
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Tenant <String>
The tenant that will own the reservation
Required? false
Position? named
Default value $Global:vRAConnection.Tenant
Accept pipeline input? false
Accept wildcard characters? false
-BusinessGroup <String>
The business group that will be associated with the reservation
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ReservationPolicy <String>
The reservation policy that will be associated with the reservation
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Priority <Int32>
The priority of the reservation
Required? false
Position? named
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-ComputeResourceId <String>
The compute resource that will be associated with the reservation
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Quota <Int32>
The number of machines that can be provisioned in the reservation
Required? false
Position? named
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-MemoryGB <Int32>
The amount of memory available to this reservation
Required? true
Position? named
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-Storage <PSObject[]>
The storage that will be associated with the reservation
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Network <PSObject[]>
The network that will be associated with this reservation
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ResourcePool <String>
The resource pool that will be associated with this reservation
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-EnableAlerts [<SwitchParameter>]
Enable alerts
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-EmailBusinessGroupManager [<SwitchParameter>]
Email the alerts to the business group manager
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-AlertRecipients <String[]>
The recipients that will recieve email alerts
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-StorageAlertPercentageLevel <Int32>
The threshold for storage alerts
Required? false
Position? named
Default value 80
Accept pipeline input? false
Accept wildcard characters? false
-MemoryAlertPercentageLevel <Int32>
The threshold for memory alerts
Required? false
Position? named
Default value 80
Accept pipeline input? false
Accept wildcard characters? false
-CPUAlertPercentageLevel <Int32>
The threshold for cpu alerts
Required? false
Position? named
Default value 80
Accept pipeline input? false
Accept wildcard characters? false
-MachineAlertPercentageLevel <Int32>
The threshold for machine alerts
Required? false
Position? named
Default value 80
Accept pipeline input? false
Accept wildcard characters? false
-AlertReminderFrequency <Int32>
Alert frequency in days
Required? false
Position? named
Default value 20
Accept pipeline input? false
Accept wildcard characters? false
-JSON <String>
Body text to send in JSON format
Required? true
Position? named
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
-NewName <String>
If passing a JSON payload NewName can be used to set the reservation name
Required? false
Position? named
Default value
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
System.Int
System.Management.Automation.SwitchParameter
System.Management.Automation.PSObject
OUTPUTS
System.Management.Automation.PSObject
-------------------------- EXAMPLE 1 --------------------------
PS C:\\># --- Create a new Reservation in vRA 7.1
# --- Get the compute resource id
$ComputeResource = Get-vRAReservationComputeResource -Type 'vSphere' -Name 'Cluster01 (vCenter)'
# --- Get the network definition
$NetworkDefinitionArray = @()
$Network1 = New-vRAReservationNetworkDefinition -Type 'vSphere' -ComputeResourceId $ComputeResource.Id
-NetworkPath 'VM Network' -NetworkProfile 'Test-Profile'
$NetworkDefinitionArray += $Network1
# --- Get the storage definition
$StorageDefinitionArray = @()
$Storage1 = New-vRAReservationStorageDefinition -Type 'vSphere' -ComputeResourceId $ComputeResource.Id -Path
'Datastore1' -ReservedSizeGB 10 -Priority 0
$StorageDefinitionArray += $Storage1
# --- Set the parameters and create the reservation
$Param = @{
Type = 'vSphere'
Name = 'Reservation01'
Tenant = 'Tenant01'
BusinessGroup = 'Default Business Group[Tenant01]'
ReservationPolicy = 'ReservationPolicy1'
Priority = 0
ComputeResourceId = $ComputeResource.Id
Quota = 0
MemoryGB = 2048
Storage = $StorageDefinitionArray
ResourcePool = 'Resources'
Network = $NetworkDefinitionArray
EnableAlerts = $false
}
New-vRAReservation @Param -Verbose
-------------------------- EXAMPLE 2 --------------------------
PS C:\\># --- Create a new Reservation in vRA 7.2 and later
# --- Get the compute resource id
$ComputeResource = Get-vRAReservationComputeResource -Type 'vSphere (vCenter)' -Name 'Cluster01 (vCenter)'
# --- Get the network definition
$NetworkDefinitionArray = @()
$Network1 = New-vRAReservationNetworkDefinition -Type 'vSphere (vCenter)' -ComputeResourceId $ComputeResource.Id
-NetworkPath 'VM Network' -NetworkProfile 'Test-Profile'
$NetworkDefinitionArray += $Network1
# --- Get the storage definition
$StorageDefinitionArray = @()
$Storage1 = New-vRAReservationStorageDefinition -Type 'vSphere (vCenter)' -ComputeResourceId $ComputeResource.Id
-Path 'Datastore1' -ReservedSizeGB 10 -Priority 0
$StorageDefinitionArray += $Storage1
# --- Set the parameters and create the reservation
$Param = @{
Type = 'vSphere (vCenter)'
Name = 'Reservation01'
Tenant = 'Tenant01'
BusinessGroup = 'Default Business Group[Tenant01]'
ReservationPolicy = 'ReservationPolicy1'
Priority = 0
ComputeResourceId = $ComputeResource.Id
Quota = 0
MemoryGB = 2048
Storage = $StorageDefinitionArray
ResourcePool = 'Resources'
Network = $NetworkDefinitionArray
EnableAlerts = $false
}
New-vRAReservation @Param -Verbose
RELATED LINKS