# Open-VaultConnection

Opens a connection to the vault that is stated in the parameters.

powerJobs extends the powerVault {doc}`powervault:code_reference/commandlets/open-vaultconnection` cmdlet with additional functionality (e.g. it loads the *JobProcessor.exe.config*, special login for JobProcessor, `$vaultExplorerUtil` variable).

## Syntax

```{code-block} PowerShell
:linenos:

Open-VaultConnection [-Vault <string>] [-Server <string>] [-User <string>] [-Password <string>] <CommonParameters>]
```

## Parameters

| Type   | Name     | Description                                                             | Default value | Optional |
| ------ | -------- | ----------------------------------------------------------------------- | ------------- | -------- |
| String | Vault    | The name of the vault for which the connection should be made           | Vault         | yes      |
| String | Server   | The Ip or hostname of the server on which the vault server is installed | localhost     | yes      |
| String | User     | A valid user, that is able to login to the target vault                 | Administrator | yes      |
| String | Password | The users password                                                      | `""`            | yes      |

## Return type

**empty** \<- On failure the Exception/ErrorMessage can be accessed using [\$Error](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_automatic_variables?view=powershell-5.1#error)

## Remarks

In order to debug a job the following powershell variables can be used when the cmdlet is able to successfully establish a connection to Vault:

- {doc}`$vault <powervault:code_reference/objects/vault>`
- {doc}`$vaultconnection <powervault:code_reference/objects/vaultconnection>`
- {doc}`$vaultExplorerUtil <powervault:code_reference/objects/vaultexplorerutil>`