Get-LiquitZoneDomain
Synopsis
This command displays a list of all the domains associated with a zone. Alternatively, you can select a specific domain.
Syntax
Get-LiquitZoneDomain
[-Zone <Zone>]
[-LiquitContext <LiquitContext>]
[<CommonParameters>]
Get-LiquitZoneDomain
[-Zone <Zone>]
[-ID] <guid[]>
[-LiquitContext <LiquitContext>]
[<CommonParameters>]
Get-LiquitZoneDomain
[-Zone] <Zone>
[-Search] <string>
[-LiquitContext <LiquitContext>]
[<CommonParameters>]
Get-LiquitZoneDomain
[-Zone] <Zone>
[-Name] <string>
[-LiquitContext <LiquitContext>]
[<CommonParameters>]
Examples
The following script displays all the domains defined within Application Workspace:
Get-LiquitZone | Get-LiquitZoneDomain
The following script displays all the domains for the specified zone:
Get-LiquitZone -ID 00000000-0000-0000-0000-000000000000 | Get-LiquitZoneDomain
Parameters
| Name | Value | Description | Required | Default value |
|---|---|---|---|---|
| Search | <string> |
This parameter serves a similar purpose to the search box found in the access policies table from the Application 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, Certificate and columns containing checkboxes. | ||
| Name | <string> |
Searches on the domain name itself. | ||
| LiquitContext | <LiquitContext> |
Determines the selected zone. | No | Default |
New-LiquitZoneDomain
Synopsis
This command creates a new zone.
Syntax
New-LiquitZoneDomain
[-Zone] <Zone>
[-Name] <string>
[-VirtualHost] <string> ]
[-Enabled <bool>]
[-Description <string>]
[-Certificate <Certificate>]
[-AcmeEnabled <bool>]
[-AcmeProvider {LetsEncrypt}]
[-AcmeContacts <string[]>]
[-LiquitContext <LiquitContext>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Example
The following script creates a domain named "PowerShell Zone" in the specified zone:
New-LiquitZoneDomain -Zone (Get-LiquitZone -ID 00000000-0000-0000-0000-000000000000) -Name "PowerShell Domain" -VirtualHost "powershell.liquit.com"
Parameters
| Name | Value | Description | Required | Default value |
|---|---|---|---|---|
| Zone | <Zone> |
Create the domain for the given zone. | Yes | |
| Name | <string> |
The name of the domain. | Yes | |
| VirtualHost | <string> |
The virtual host of the domain. | Yes | |
| Description | <string> |
The description of the domain. | No | |
| Enabled | <bool> |
Whether or not the domain is activated. | No | |
| Certificate | <Certificate> |
The certificate that is applied to the domain. | No | |
| AcmeEnabled | <bool> |
If ACME is used for certificate renewal. | No | false |
| AcmeProvider | AcmeProvider |
What ACME provider is used. | No | LetsEncrypt |
| AcmeContacts | <string[]> |
List of email addresses that can be contacted. | No | |
| LiquitContext | <LiquitContext> |
Determines the selected zone. | No | Default |
Set-LiquitZoneDomain
Synopsis
This command lets you edit the properties of a domain.
Syntax
Set-LiquitZoneDomain
[-Domain] <ZoneDomain[]>
[-Name <string>]
[-VirtualHost <string>]
[-Description <string>]
[-Enabled <bool>]
[-Certificate <Certificate>]
[-AcmeEnabled <bool>]
[-AcmeProvider {LetsEncrypt}]
[-AcmeContacts <string[]>]
[-LiquitContext <LiquitContext>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Example
The following script renames the specified domain as "PowerShell Zone":
$domain = Get-LiquitZoneDomain -Zone (Get-LiquitZone -ID 00000000-0000-0000-0000-000000000000)
Set-LiquitZoneDomain -Domain $domain -Name "PowerShell Zone"
Parameters
| Name | Value | Description | Required | Default value |
|---|---|---|---|---|
| Domain | <ZoneDomain[]> |
Modify the selected domains. | Yes | |
| Name | <string> |
The name of the domain. | Yes | |
| VirtualHost | <string> |
The virtual host of the domain. | Yes | |
| Description | <string> |
The description of the domain. | No | |
| Enabled | <bool> |
Whether or not the domain is activated. | No | |
| Certificate | <Certificate> |
The certificate that is applied to the domain. | No | |
| AcmeEnabled | <bool> |
If ACME is used for certificate renewal. | No | false |
| AcmeProvider | AcmeProvider |
What ACME provider is used. | No | LetsEncrypt |
| AcmeContacts | <string[]> |
List of email addresses that can be contacted. | No | |
| LiquitContext | <LiquitContext> |
Determines the selected zone. | No | Default |
Remove-LiquitZoneDomain
Synopsis
This command removes a domain.
Syntax
Remove-LiquitZoneDomain
[-Domain] <ZoneDomain[]>
[-LiquitContext <LiquitContext>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Example
The following script removes the specified domain:
$domain = Get-LiquitZoneDomain -Zone (Get-LiquitZone -ID 00000000-0000-0000-0000-000000000000)
Remove-LiquitZone -Domain $domain
Parameters
| Name | Value | Description | Required | Default value |
|---|---|---|---|---|
| Domain | <ZoneDomain[]> |
The domain you want to remove. | Yes | |
| LiquitContext | <LiquitContext> |
Determines the selected zone. | No | Default |