Getting Started
  • 06 Oct 2023
  • 1 Minute to read
  • Dark
    Light
  • PDF

Getting Started

  • Dark
    Light
  • PDF

Article Summary

To run cmdlets against Liquit Workspace and perform administration or monitoring tasks, you must establish a connection to your Liquit System.
Liquit Workspace connectivity is stored in a Context object, which makes it possible to manage multiple systems within a single script.

Using Liquit PowerShell

  1. Start Liquit PowerShell using the shortcut created in Windows Start Menu after installation, or by manually loading the Liquit PowerShell module.
  2. To create a default context object, first run Connect-LiquitWorkspace with the Liquit Workspace URI and valid credentials. The username should use the following syntax: "Identity source name\username":
$liquitContext = Connect-LiquitWorkspace -URI https://workspace.liquit.com -Credential (Get-Credential)

After establishing a connection, all available cmdlet commands will use this default context. Unless explicitly specified by the LiquitContext parameter on every Liquit Workspace cmdlet.

If there are spaces in the identity source name, then Get-Credential will fail as username validation doesn't allow spaces. In this case, you can use the following code to still use spaces within the identity source name:

$username = "Microsoft Entra ID\username@liquit.com"
$password = Read-Host "Enter Password" -AsSecureString
$credentials = New-Object -TypeName System.Management.Automation.PSCredential -ArgumentList $username, $password

$liquitContext = Connect-LiquitWorkspace -URI "https://workspace.liquit.com" -Credential $credentials

Was this article helpful?