New-VPASDPASetupScript


Supported Environments:
SelfHosted
SharedServices
PCloudStandard


Synopsis:

GENERATE DPA INSTALLATION SCRIPT


Description:

USE THIS FUNCTION GENERATE AN INSTALLATION SCRIPT THAT WILL DEPLOY A DPA CONNECTOR


Syntax:

New-VPASDPASetupScript -ConnectorType <String> -ConnectorOS <String> [-ExpirationPeriod <Int32>] -ConnectorPoolID <String> [-token <Hashtable>] [<CommonParameters>]

New-VPASDPASetupScript -InputParameters <Hashtable> [-token <Hashtable>] [<CommonParameters>]


Parameters:

-ConnectorType <String>
Platform type the connector will be deployed to
Possible values: AWS, AZURE, ON-PREMISE, GCP

Required: true
Position: named
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-ConnectorOS <String>
Operating system type the connector will be deployed to
Possible values: windows, darwin, linux

Required: true
Position: named
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-ExpirationPeriod <Int32>
Duration the installation script will be valid for in minutes (expiration value must be between 15 and 240)
Default value: 15 minutes

Required: false
Position: named
Default value: 0
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-ConnectorPoolID <String>
UniqueID of the pool the connector will be deployed to
ID is typically a long string value like so: a1bcd234-efg5-67h8-90ij-9876k54lm321

Required: true
Position: named
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-InputParameters <Hashtable>
HashTable of values containing the parameters required to make the API call

Required: true
Position: named
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-token <Hashtable>
HashTable of data containing various pieces of login information (PVWA, LoginToken, HeaderType, etc).
If -token is not passed, function will use last known hashtable generated by New-VPASToken

Required: false
Position: named
Default value:
Accept pipeline input: true (ByPropertyName)
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)


Examples:

$InstallationScript = New-VPASDPASetupScript -ConnectorType ON-PREMISE -ConnectorOS windows -ConnectorPoolID "a1bcd234-efg5-67h8-90ij-9876k54lm321"

$InstallationScript = New-VPASDPASetupScript -ConnectorType ON-PREMISE -ConnectorOS windows -ConnectorPoolID "a1bcd234-efg5-67h8-90ij-9876k54lm321" -ExpirationPeriod 60

$InputParameters = @{
        ConnectorType = "AWS"|"AZURE"|"ON-PREMISE"|"GCP"
         ConnectorOS = "windows"|"darwin"|"linux"
         ExpirationPeriod = 60
         ConnectorPoolID = "1234-abcde-45678-lmnop-09876poiuy"
}
$InstallationScript = New-VPASDPASetupScript -InputParameters $InputParameters


Outputs:

If successful:
{
         "script_url": "***",
         "bash_cmd": "***"
}

$false if failed