.png){kind=logo}
Zone Domains
- 16 Mar 2024
- 2 Minutes to read
- Print
- DarkLight
- PDF
Zone Domains
- Updated on 16 Mar 2024
- 2 Minutes to read
- Print
- DarkLight
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
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>]
Examples
Example 1: Get-LiquitZoneDomain
Get-LiquitZone | Get-LiquitZoneDomain
This command displays all the domains defined within Liquit Workspace.
Example 2: Get-LiquitZoneDomain
Get-LiquitZone -ID 00000000-0000-0000-0000-000000000000 | Get-LiquitZoneDomain
This command displays all the domains for the specified zone.
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
New-LiquitZoneDomain -Zone (Get-LiquitZone -ID 00000000-0000-0000-0000-000000000000) -Name "PowerShell Domain" -VirtualHost “powershell.liquit.com"
This command creates a domain named “PowerShell Zone” in the specified zone.
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
$domain = Get-LiquitZoneDomain -Zone (Get-LiquitZone -ID 00000000-0000-0000-0000-000000000000)
Set-LiquitZoneDomain -Domain $domain -Name “PowerShell Zone”
This command renames the specified domain as “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
$domain = Get-LiquitZoneDomain -Zone (Get-LiquitZone -ID 00000000-0000-0000-0000-000000000000)
Remove-LiquitZone -Domain $domain
This command removes the specified 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 |
Was this article helpful?