Request-vRACatalogItem

NAME Request-vRACatalogItem



SYNOPSIS

Request a vRA catalog item





SYNTAX

Request-vRACatalogItem -Id <String> [-RequestedFor <String>] [-Description <String>] [-Reasons <String>] [-Wait]

[-WhatIf] [-Confirm] [<CommonParameters>]



Request-vRACatalogItem -JSON <String> [-Wait] [-WhatIf] [-Confirm] [<CommonParameters>]





DESCRIPTION

Request a vRA catalog item with a given request template payload.



If the wait switch is passed the cmdlet will wait until the request has completed. If successful informaiton

about the new resource will be returned



If no switch is passed then the request id will be returned





PARAMETERS

-Id <String>

The Id of the catalog item to request



Required? true

Position? named

Default value

Accept pipeline input? true (ByPropertyName)

Accept wildcard characters? false



-RequestedFor <String>

The user principal that the request is for (e.g. user@vsphere.local). If not specified the current user is used



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Description <String>

A description for the request



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Reasons <String>

Reasons for the request



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-JSON <String>

JSON string containing the request template



Required? true

Position? named

Default value

Accept pipeline input? true (ByValue)

Accept wildcard characters? false



-Wait [<SwitchParameter>]

Wait for the request to complete



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:\\>$Template = Get-vRAEntitledCatalogItem -Id "dab4e578-57c5-4a30-b3b7-2a5cefa52e9e" |

Get-vRACatalogItemRequestTemplate



$Resource = Request-vRACatalogItem -JSON $Template -Wait -Verbose









-------------------------- EXAMPLE 2 --------------------------



PS C:\\>$Template = Get-vRAEntitledCatalogItem -Id "dab4e578-57c5-4a30-b3b7-2a5cefa52e9e" |

Get-vRACatalogItemRequestTemplate



$RequestId = Request-vRACatalogItem -JSON $Template -Verbose









-------------------------- EXAMPLE 3 --------------------------



PS C:\\>Request-vRACatalogItem -Id "dab4e578-57c5-4a30-b3b7-2a5cefa52e9e"













-------------------------- EXAMPLE 4 --------------------------



PS C:\\>Request-vRACatalogItem -Id "dab4e578-57c5-4a30-b3b7-2a5cefa52e9e" -Wait













-------------------------- EXAMPLE 5 --------------------------



PS C:\\>Request-vRACatalogItem -Id "dab4e578-57c5-4a30-b3b7-2a5cefa52e9e" -Description "Test" -Reasons "Test Reason"















RELATED LINKS