Connectors

30 Oct 2024
3 Minutes to read

Print
Share
Dark
Light
PDF

Connectors

Updated on 30 Oct 2024
3 Minutes to read

Print
Share
Dark
Light
PDF

Article summary

Did you find this summary helpful?

Thank you for your feedback

Get-LiquitConnector

Synopsis

This command displays a list of all connectors known within the Liquit Workspace, or you can select a specific connector.

Syntax

Get-LiquitConnector 
    [-LiquitContext <LiquitContext>]  
    [<CommonParameters>]

Get-LiquitConnector 
    [-ID] <guid[]> 
    [-LiquitContext <LiquitContext>] 
    [<CommonParameters>]

Get-LiquitConnector 
    [-EntityRef] <EntityRef[]> 
    [-LiquitContext <LiquitContext>]  
    [<CommonParameters>]

Get-LiquitConnector 
    [-Type] <string[]> 
    [-LiquitContext <LiquitContext>]  
    [<CommonParameters>]
    
Get-LiquitAccessPolicy 
    [-Search] <string> 
    [-LiquitContext <LiquitContext>]
    [<CommonParameters>]

Get-LiquitAccessPolicy 
    [-Name] <string> 
    [-LiquitContext <LiquitContext>]  
    [<CommonParameters>]

Examples

Example 1: Get-LiquitConnector

 Get-LiquitConnector

This command displays a table with the ID and name columns of all connectors.

Example 2: Get-LiquitConnector

 Get-LiquitConnector -type liquitworkspace

This command selects all the Liquit Workspace type of connectors.

Example 3: Get-LiquitConnector

 Get-LiquitConnector -id 00000000-0000-0000-0000-000000000000

This command selects a specific connector.

Parameters

Name	Value	Description	Required	Default value
Type	`<string>`	Provide a type for the connector: citrixstorefront liquitsetupstore liquitworkspace microsoftprintserver microsoftrds microsoftwvd okta microsoftsccm vmwarehorizon nutanixframe microsoftstore	Yes
Search	`<string>`	This parameter serves a similar purpose to the search box found in the connectors table from the Liquit Workspace UI. It enables users to search multiple columns within the table, such as Name and Type. When a search term is provided, the parameter filters records by matching values in these indexed columns. However, it's important to note that not all columns in the table are indexed, meaning that searches for values in these non-indexed columns will not return results. Non-indexed columns include for example the ID and columns containing checkboxes.
Name	`<string>`	Searches on the connector name itself.
LiquitContext	`<LiquitContext>`	Determines the selected zone.	No	Default

New-LiquitConnector

Synopsis

This command creates a new connector.

Syntax

 New-LiquitConnector
    [-Name] <string> 
    [-Type] <string> 
    [-Method {Ondemand | Synchronize}]
    [-Direction {Pull | Push}]
    [-Target <Entity>]
    [-PackageType { Managed | Unmanaged}] 
    [-Prefix <string>] 
    [-Description <string>] 
    [-Enabled <bool>] 
    [-Settings <hashtable>]
    [-LiquitContext <LiquitContext>] 
    [-WhatIf] 
    [-Confirm] 
    [<CommonParameters>]

Example

 New-LiquitConnector -Name 'PowerShell Connector' -Type 'liquitworkspace' -Method 'Ondemand' -PackageType 'Default' -Prefix 'PS-Connector-' -Enabled $true -Settings @{url = 'https://workspace.liquit.com'; username='username'; password='password'}

This command creates a new connector with the name "PowerShell Connector".

Parameters

Name	Value	Description	Required	Default value
Name	`<string>`	Provide a name for the connector.	Yes
Type	`<string>`	Provide a type for the connector: citrixstorefront liquitsetupstore liquitworkspace microsoftprintserver microsoftrds microsoftwvd okta microsoftsccm vmwarehorizon nutanixframe microsoftstore	Yes
Method	`{Ondemand \| Synchronize}`	Defines the method used for the connector.	No	Ondemand
Direction	`{Pull \| Push}`	Determines in which direction the connector sends information. Push - The connector will create packages in the remote system. Pull - Packages can be created from resources or imported from the remote system.	Yes	No
Target	`<Entity>`	The satellite server.		No
PackageType	`{Managed \| Unmanaged}`	Determines if the packages coming from the connector are Managed or not. Managed - the package is managed by the connector; several options cannot be changed to allow easy updates. Unmanaged - the package will be created based on the resource and you can make any changes to it.	No	Managed
Description	`<string>`	Provide a description for the connector.	No
Enabled	`<bool>`	Determines whether or not the connector is enabled.	No	True
Settings	`<hashtable>`	The settings for the connector; this is required for all connector types except for Liquit Setup Store type connectors.	Yes
LiquitContext	`<LiquitContext>`	Determines the selected zone.	No	Default

Set-LiquitConnector

Synopsis

This command edits the properties of a connector.

Syntax

 Set-LiquitConnector 
    [-Connector] <Connector[]> 
    [-Name <string>] 
    [-PackageType { Managed | Unmanaged}] 
    [-Direction {Pull | Push}]
    [-Target <Entity>]
    [-Prefix <string>] 
    [-Description <string>] 
    [-Enabled <bool>] 
    [-Settings <hashtable>] 
    [-LiquitContext <LiquitContext>] 
    [-WhatIf] 
    [-Confirm]  
    [<CommonParameters>]

Example

$connector = Get-LiquitConnector -id 00000000-0000-0000-0000-000000000000
Set-LiquitConnector -Connector $connector -Name “Updated PowerShell Connector”

This command updates an existing connector and renames it "Updated PowerShell Connector”.

Parameters

Name	Value	Description	Required	Default value
Name	`<string>`	Provide a name for the connector.	Yes
PackageType	`{ Managed \| Unmanaged}`	Determines if the packages coming from the connector are Managed or not.	No	Managed
Direction	`{Pull \| Push}`	Determines in which direction the connector sends information. Push - The connector will create packages in the remote system. Pull - Packages can be created from resources or imported from the remote system.	Yes	No
Target	`<Entity>`	The satellite server.		No
Description	`<string>`	Provide a description for the connector.	No
Enabled	`<bool>`	Determines whether or not the connector is enabled.	No	True
Settings	`<hashtable>`	The settings for the connector; this is required for all connector types except for Liquit Setup Store type connectors.	Yes
LiquitContext	`<LiquitContext>`	Determines the selected zone.	No	Default

Remove-LiquitConnector

Synopsis

Removes a connector from the Liquit Workspace.

Syntax

 Remove-LiquitConnector 
	[-Connector] <Connector[]>  
	[-LiquitContext <LiquitContext>] 
	[-WhatIf] 
	[-Confirm]  
	[<CommonParameters>]

Example

	 $connector = Get-LiquitConnector -id 00000000-0000-0000-0000-000000000000
	 Remove-LiquitConnector -Connector $connector

This command removes the selected connector from the Liquit Workspace.

Parameters

Name	Value	Description	Required	Default value
Connector	`<Connector[]>`	The connector you wish to remove.	Yes
LiquitContext	`<LiquitContext>`	Determines the selected zone.	No	Default

Was this article helpful?

What's Next

Content

Table of contents

Get-LiquitConnector
New-LiquitConnector
Set-LiquitConnector
Remove-LiquitConnector