Test-VPASSQLConnectionDetails


Supported Environments:
SelfHosted
SharedServices
PCloudStandard


Synopsis:

CHECK SQL CONNECTION DETAILS


Description:

USE THIS FUNCTION TO CHECK THE DATABASE CONNECTION DETAILS


Syntax:

Test-VPASSQLConnectionDetails [[-NoSSL]] [<CommonParameters>]


Parameters:

-NoSSL [<SwitchParameter>]
If the environment is not set up for SSL, API calls will be made via HTTP not HTTPS (Not Recommended!)

Required: false
Position: 1
Default value: False
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:

$CheckSQLConnectionDetails = Test-VPASSQLConnectionDetails -SQLServer {SQLSERVER VALUE} -SQLDatabase {SQLDATABASE VALUE} -SQLUsername {SQLUSERNAME VALUE} -AAM {AAM VALUE} -AppID {APPID VALUE} -Folder {FOLDER VALUE} -SafeID {SAFEID VALUE} -ObjectName {OBJECTNAME VALUE} -AIMServer {AIMSERVER VALUE}

$CheckSQLConnectionDetails = Test-VPASSQLConnectionDetails


Outputs:

$true if successful

$false if failed