Invoke-vRAOnboardingPlan
SYNOPSIS
Execute a vRA Onboarding Plan
SYNTAX
ById (Default)
Invoke-vRAOnboardingPlan -Id <String[]> [-WhatIf] [-Confirm] [<CommonParameters>]
ByName
Invoke-vRAOnboardingPlan -Name <String[]> [-WhatIf] [-Confirm] [<CommonParameters>]
ByPlanLink
Invoke-vRAOnboardingPlan -PlanLink <String[]> [-WhatIf] [-Confirm] [<CommonParameters>]
JSON
Invoke-vRAOnboardingPlan -JSON <String> [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
Execute a vRA Onboarding Plan
EXAMPLES
EXAMPLE 1
Invoke-vRAOnboardingPlan -Name "TestOnboardingPlan"
EXAMPLE 2
Invoke-vRAOnboardingPlan -Id "ecaa2cf0-2f8c-4a79-r4d7-27f13c7d3ee6"
EXAMPLE 3
Invoke-vRAOnboardingPlan -PlanLink "/relocation/onboarding/plan/ecaa2cf0-2f8c-4a79-r4d7-27f13c7d3ee6"
EXAMPLE 4
$JSON = @"
{ "planLink": "/relocation/onboarding/plan/ecaa2cf0-2f8c-4a79-r4d7-27f13c7d3ee6" } "@
$JSON | Invoke-vRAOnboardingPlan
PARAMETERS
-Id
The Id of the Onboarding Plan
Type: String[]
Parameter Sets: ById
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False
-Name
The Name of the Onboarding Plan
Type: String[]
Parameter Sets: ByName
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-PlanLink
The Link of the Onboarding Plan
Type: String[]
Parameter Sets: ByPlanLink
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-JSON
A JSON string with the body payload
Type: String
Parameter Sets: JSON
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Confirm
Prompts you for confirmation before running the cmdlet.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.