--- external help file: PSProxmoxVE.dll-Help.xml Module Name: PSProxmoxVE online version: schema: 2.0.0 --- # Connect-PveServer ## SYNOPSIS {{ Fill in the Synopsis }} ## SYNTAX ### Credential (Default) ``` Connect-PveServer [-Server] [-Port ] -Credential [-SkipCertificateCheck] [-PassThru] [-ProgressAction ] [] ``` ### ApiToken ``` Connect-PveServer [-Server] [-Port ] -ApiToken [-SkipCertificateCheck] [-PassThru] [-ProgressAction ] [] ``` ## DESCRIPTION {{ Fill in the Description }} ## EXAMPLES ### Example 1 ```powershell PS C:\> {{ Add example code here }} ``` {{ Add example description here }} ## PARAMETERS ### -ApiToken API token in USER@REALM!TOKENID=UUID format. ```yaml Type: String Parameter Sets: ApiToken Aliases: Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -Credential Username and password. Username must include realm (e.g. root@pam). ```yaml Type: PSCredential Parameter Sets: Credential Aliases: Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -PassThru Output the session object to the pipeline. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -Port API port. Defaults to 8006. ```yaml Type: Int32 Parameter Sets: (All) Aliases: Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -Server Hostname or IP of the Proxmox VE server. ```yaml Type: String Parameter Sets: (All) Aliases: Required: True Position: 0 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -SkipCertificateCheck Skip TLS certificate validation. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -ProgressAction {{ Fill ProgressAction Description }} ```yaml Type: ActionPreference Parameter Sets: (All) Aliases: proga 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](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS ### None ## OUTPUTS ### PSProxmoxVE.Core.Authentication.PveSession ## NOTES ## RELATED LINKS