.png){kind=logo}
Zones
- 07 Nov 2024
- 3 Minutes to read
- Print
- DarkLight
- PDF
Zones
- Updated on 07 Nov 2024
- 3 Minutes to read
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Get-LiquitZone
Synopsis
This command displays a list of all the zones available within Liquit Workspace. Alternatively, you can select a specific zone. Note that this command displays also the license usage information.
Syntax
Get-LiquitZone
[-LiquitContext <LiquitContext>]
[<CommonParameters>]
Get-LiquitZone
[-ID] <guid[]>
[-LiquitContext <LiquitContext>]
[<CommonParameters>]
Get-LiquitZone
[-EntityRef] <EntityRef[]>
[-LiquitContext <LiquitContext>]
[<CommonParameters>]
Get-LiquitZone
[-Search] <string>
[-LiquitContext <LiquitContext>]
[<CommonParameters>]
Get-LiquitZone
[-Name] <string>
[-LiquitContext <LiquitContext>]
[<CommonParameters>]
Get-LiquitZone
[-Primary]
[-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.
Parameters
| Name | Value | Description | Required | Default value |
|---|---|---|---|---|
| Search | <string> | This parameter serves a similar purpose to the search box found in the zones table from the Liquit Workspace UI. It enables users to search multiple columns within the table, such as Name and Virtual host. 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, License state and Expires and columns containing checkboxes. | ||
| Name | <string> | Searches on the zone name itself. | ||
| Primary | A switch parameter that filters the zones by the primary type. | |||
| LiquitContext | <LiquitContext> | Determines the selected zone. | No | Default |
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
| Name | Value | Description | Required | Default 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. | No | Default |
Set-LiquitZone
Synopsis
This command lets you edit the properties of a zone.
Syntax
Set-LiquitZone
[-Zone] <Zone[]>
[-Name <string>]
[-Primary]
[-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
| Name | Value | Description | Required | Default 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 | |
| Primary | A switch parameter that filters the zones by the primary type. | |||
| Enabled | <bool> | Whether or not the zone is activated. | No | |
| HstsEnabled | <bool> | If HTTP Strict Transport Security (HSTS) should be enabled. | No | false |
| HstsMaxAge | <int> | Maximum age of HSTS. | No | 356 |
| HstsPreload | <bool> | A list with domain names that by default support HSTS. | No | false |
| HstsIncludeSubDomains | <bool> | If subdomains must be included with the HSTS policy. | No | false |
| CspEnforce | <bool> | If CSP policy must be enforced. | No | true |
| CspReporting | <bool> | If CSP reporting is enabled. | No | false |
| CspReportingUrl | <Uri> | CSP reporting URL. | No | |
| CspForceSecure | <bool> | If CSP force secure connections is enabled. | No | false |
| CspFrameSites | <string[]> | List of websites that are allowed to embed the zone. | No | |
| CorsAuthEnabled | <bool> | If CORS policy is enabled. | No | true |
| CorsAuthSites | <string[]> | List of websites that are allowed to authenticate against the zone. | No | |
| LiquitContext | <LiquitContext> | Determines the selected zone. | No | Default |
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
| Name | Value | Description | Required | Default value |
|---|---|---|---|---|
| Zone | <Zone[]> | The zone you want to remove. | Yes | |
| LiquitContext | <LiquitContext> | Determines the selected zone. | No | Default |
Was this article helpful?