Open-VaultConnection

Connects to the specified Vault Server.

Syntax

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.

Remarks

After the commandlet successfully established a connection to Vault, the following powershell variables are created and let you communicate directly to Vault through it’s API:

The cmdlet can be invoked without arguments in applications that are already connected to Vault (for example within the Vault Explorer), so that the mentioned powershell variables are exposed for the existing Vault connection.