.png){kind=logo}
Server
- 06 Nov 2024
- 1 Minute to read
- Print
- DarkLight
- PDF
Server
- Updated on 06 Nov 2024
- 1 Minute to read
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Get-LiquitServer
Synopsis
This command displays a list of all the servers known within the Liquit zone, or select a specific server.
Syntax
Get-LiquitServer
[-LiquitContext <LiquitContext>]
[<CommonParameters>]
Get-LiquitServer
[-ID] <guid[]>
[-LiquitContext <LiquitContext>]
[<CommonParameters>]
Get-LiquitServer
[-EntityRef] <EntityRef[]>
[-LiquitContext <LiquitContext>]
[<CommonParameters>]
Get-LiquitServer
[-Search] <string>
[-LiquitContext <LiquitContext>]
[<CommonParameters>]
Get-LiquitServer
[-Name] <string>
[-LiquitContext <LiquitContext>]
[<CommonParameters>]
Examples
Example 1: Get-LiquitServer
Get-LiquitServer | Select id, name
This command displays a table with the id and name columns.
Example 2: Get-LiquitServer
Get-LiquitServer -id 00000000-0000-0000-0000-000000000000
This command selects a specific server.
Parameters
| Name | Value | Description | Required | Default value |
|---|---|---|---|---|
| Search | <string> | This parameter serves a similar purpose to the search box found in the servers table from the Liquit Workspace UI. It enables users to search multiple columns within the table, such as Name and Maintenance. 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 server name itself. | ||
| LiquitContext | <LiquitContext> | Determines the selected zone. | No | Default |
Set-LiquitServer
Synopsis
This command lets you edit the properties of a server.
Syntax
Set-LiquitServer
[-Server] <Server[]>
[-Name <string>]
[-Description <string>]
[-Maintenance <bool>]
[-LiquitContext <LiquitContext>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Parameters
| Name | Value | Description | Required | Default value |
|---|---|---|---|---|
| Server | <Server[]> | The server you wish to update. | Yes | |
| Maintenance | <bool> | When enabled, the server starts to run in maintenance mode, meaning that the server will operate as normal for users but will report to the Load balancing solution that the server is unavailable. During maintenance mode, tasks are not executed. | ||
| LiquitContext | <LiquitContext> | Determines the selected zone. | No | Default |
Examples
$server = Get-LiquitServer -id 00000000-0000-0000-0000-000000000000
Set-LiquitServer –Server $server –Maintenance $true
This command will update an existing server and place it in Maintenance mode.
$Server = Get-LiquitServer -Name "Server01 Liquit"
Set-LiquitServer -Server $Server -Name "Server0001 Liquit"
This command will update the name of the selected server.
Remove-LiquitServer
Synopsis
Removes a server from Liquit Workspace.
Syntax
Remove-LiquitServer
[-Server] <Server[]>
[-LiquitContext <LiquitContext>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Example
$server = Get-LiquitServer -id 00000000-0000-0000-0000-000000000000
Remove-LiquitServer -server $server
This command removes the selected server from Liquit Workspace.
Parameters
| Name | Value | Description | Required | Default value |
|---|---|---|---|---|
| Server | <Server[]> | The server you wish to remove. | Yes | |
| LiquitContext | <LiquitContext> | Determines the selected zone | No | Default |
Was this article helpful?