Zones
  • 16 Mar 2024
  • 2 Minutes to read
  • Dark
    Light
  • PDF

Zones

  • Dark
    Light
  • PDF

Article Summary

Get-LiquitZone

Synopsis

This command displays a list of all the zones available within Liquit Workspace. Alternatively, you can select a specific zone.

Syntax

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

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

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

Examples

Example 1: Get-LiquitZone

 Get-LiquitZone

This command displays all the zones defined within Liquit Workspace.

Example 2: Get-LiquitZone

 Get-LiquitZone -ID 00000000-0000-0000-0000-000000000000

This command displays the selected zone.

New-LiquitZone

Synopsis

This command creates a new zone.

Syntax

 New-LiquitZone 
[-Name] <string> 
[-VirtualHost] <string> 
-Password <string> 
[-Enabled <bool>] 
[-Description <string>] 
[-UserName <string>] 
[-LiquitContext <LiquitContext>] 
[-WhatIf] 
[-Confirm]
[<CommonParameters>]

Example

 New-LiquitZone -Name "PowerShell Zone"  -VirtualHost “powershell.liquit.com" -Password "Password"

This command creates a zone with the name “PowerShell Zone”.

Parameters

NameValueDescriptionRequiredDefault value
Name<string>The name of the zone.Yes
VirtualHost<string>The virtual host of the zone.Yes
Password<string>The password of the zone.Yes
Description<string>The description of the zone.No
Enabled<bool>Whether or not the zone is activated.No
UserName<string>The username of the zone.No
LiquitContext<LiquitContext>Determines the selected zone.NoDefault

Set-LiquitZone

Synopsis

This command lets you edit the properties of a zone.

Syntax

 Set-LiquitZone 
[-Zone] <Zone[]> 
[-Name <string>] 
[-Description <string>] 
[-Enabled <bool>]
[-HstsEnabled <bool>]
[-HstsMaxAge <int>]
[-HstsPreload <bool>]
[-HstsIncludeSubDomains <bool>]
[-CspEnforce <bool>]
[-CspReporting <bool>]
[-CspReportingUrl <uri>]
[-CspForceSecure <bool>]
[-CspFrameSites <List[string]>]
[-CorsAuthEnabled <bool>]
[-CorsAuthSites <List[string]>]
[-LiquitContext <LiquitContext>] 
[-WhatIf] 
[-Confirm]  
[<CommonParameters>]

Example

 $zone = Get-LiquitZone -ID 00000000-0000-0000-0000-000000000000
 Set-LiquitZone -Zone $zone -Value “PowerShell Zone”

This command renames the selected zone as “PowerShell Zone”.

If you change the virtual host of a zone, its license becomes invalid.

Parameters

NameValueDescriptionRequiredDefault value
Zone<Zone[]>The zone you want to update.Yes
Name<string>The name of the zone.No
Description<string>The description of the zone.No
Enabled<bool>Whether or not the zone is activated.No
HstsEnabled<bool>If HTTP Strict Transport Security (HSTS) should be enabled.Nofalse
HstsMaxAge<int>Maximum age of HSTS.No356
HstsPreload<bool>A list with domain names that by default support HSTS.Nofalse
HstsIncludeSubDomains<bool>If subdomains must be included with the HSTS policy.Nofalse
CspEnforce<bool>If CSP policy must be enforced.Notrue
CspReporting<bool>If CSP reporting is enabled.Nofalse
CspReportingUrl<Uri>CSP reporting URL.No
CspForceSecure<bool>If CSP force secure connections is enabled.Nofalse
CspFrameSites<string[]>List of websites that are allowed to embed the zone.No
CorsAuthEnabled<bool>If CORS policy is enabled.Notrue
CorsAuthSites<string[]>List of websites that are allowed to authenticate against the zone.No
LiquitContext<LiquitContext>Determines the selected zone.NoDefault

Remove-LiquitZone

Synopsis

This command removes a zone.

Syntax

 Remove-LiquitZone 
[-Zone] <Zone[]> 
[-LiquitContext <LiquitContext>] 
[-WhatIf] 
[-Confirm]  
[<CommonParameters>]

Example

 $zone = Get-LiquitZone -ID 00000000-0000-0000-0000-000000000000
 Remove-LiquitZone -Zone  $zone 

This command removes the specified zone.

Parameters

NameValueDescriptionRequiredDefault value
Zone<Zone[]>The zone you want to remove.Yes
LiquitContext<LiquitContext>Determines the selected zone.NoDefault

Was this article helpful?

What's Next