Onboarding

Synopsis

Get an onboarding.

Syntax

Get-AppSecOnboarding [-OnboardingStatuses <String[]>] [-Hostnames <String[]>] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Get-AppSecOnboarding -OnboardingID <Int32> [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

List all current onboardings, or get details on a specific task by its OnboardingID. Once you've completed all steps in the onboarding process, run this call again to verify onboardingStatus: "COMPLETE".

Parameters

`‑AccountSwitchKey`	StringPipeline input: False An account credential key that lets you move between accounts when using an API client enabled for multiple accounts. To find account switch keys, use Get-AccountSwitchKey.
`‑EdgeRCFile`	StringPipeline input: False Your EdgeGrid resource file to authenticate your command. Defaults to `~/.edgerc`.
`‑Hostnames`	String[]Parameter sets: `Get all`Pipeline input: False List of hostnames to be added to the configuration.
`‑OnboardingID` Conditionally required	IntParameter sets: `Get one`Pipeline input: ByValue, ByPropertyName A unique identifier for an onboarding.
`‑OnboardingStatuses`	String[]Parameter sets: `Get all`Pipeline input: False Lists onboardings for a specific status.
`‑Section`	StringPipeline input: False The section name in your EdgeGrid resource file to retrieve authentication credentials from. Defaults to `default`.

Related Links

Updated 7 days ago