Settings
  • 06 Nov 2024
  • 1 Minute to read
  • Dark
    Light
  • PDF

Settings

  • Dark
    Light
  • PDF

Article summary

Get-LiquitSetting

Synopsis

This command displays a list of all settings configured for the zone, context, server or device. Alternatively, you can select a specific setting.

Syntax

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

Get-LiquitSetting 
    [-Context] <Context> 
    [[-ID] <string[]>] 
    [-LiquitContext <LiquitContext>]  
    [<CommonParameters>]

Get-LiquitSetting 
    [-Server] <Server> 
    [[-ID] <string[]>] 
    [-LiquitContext <LiquitContext>]  
    [<CommonParameters>]

Get-LiquitSetting 
    [-Device] <Device> 
    [[-ID] <string[]>] 
    [-LiquitContext <LiquitContext>]  
    [<CommonParameters>]

Get-LiquitSetting 
    [[-ID] <string[]>] 
    [-LiquitContext <LiquitContext>]  
    [<CommonParameters>]

Examples

Example 1: Get-LiquitSetting

 Get-LiquitSetting 

This command displays all settings defined within Liquit Workspace.

Example 2: Get-LiquitSetting

Get-LiquitSetting -id login.background.color

This command displays the settings for the background color of the login page.

For all available settings, see Settings.

Clear-LiquitSetting

Synopsis

This command resets a setting to its default.

Syntax

Clear-LiquitSetting
    [-Setting] <Setting[]>
    [-LiquitContext <LiquitContext>]
    [-WhatIf] 
    [-Confirm]
    [<CommonParameters>]

Clear-LiquitSetting 
    [-Context] <Context> 
    [-ID] <string[]> 
    [-LiquitContext <LiquitContext>]
    [-WhatIf] 
    [-Confirm]
    [<CommonParameters>]

Clear-LiquitSetting 
    [-Server] <Server> 
    [-ID] <string[]> 
    [-LiquitContext <LiquitContext>] 
    [-WhatIf] 
    [-Confirm]
    [<CommonParameters>]

Clear-LiquitSetting
    [-Device] <Device>
    [-ID] <string[]> 
    [-LiquitContext <LiquitContext>] 
    [-WhatIf] 
    [-Confirm]
    [<CommonParameters>]

Clear-LiquitSetting 
    [-ID] <string[]> 
    [-LiquitContext <LiquitContext>] 
    [-WhatIf] 
    [-Confirm]  
    [<CommonParameters>]

Example

 $setting = Get-LiquitSetting -id portal.style
 Clear-LiquitSetting -Setting $setting

This command resets the theme to default.

Parameters

NameValueDescriptionRequiredDefault value
Setting<Setting[]>The setting you want to reset to default.Yes
LiquitContext<LiquitContext>Determines the selected zone.NoDefault

Set-LiquitSetting

Synopsis

This command lets you edit the properties of a scheduled task.

Syntax

Set-LiquitSetting 
    [-Setting] <Setting[]> 
    [[-Value] <Object>] 
    [-Force <bool>] 
    [-LiquitContext <LiquitContext>]
    [-WhatIf] 
    [-Confirm]  
    [<CommonParameters>]

Set-LiquitSetting 
    [-Context] <Context> 
    [-ID] <string[]> 
    [[-Value] <Object>] 
    [-Force <bool>] 
    [-LiquitContext <LiquitContext>] 
    [-WhatIf] 
    [-Confirm]  
    [<CommonParameters>]

Set-LiquitSetting 
    [-Server] <Server> 
    [-ID] <string[]> 
    [[-Value] <Object>] 
    [-Force <bool>] 
    [-LiquitContext <LiquitContext>] 
    [-WhatIf] 
    [-Confirm]  
    [<CommonParameters>]

Set-LiquitSetting 
    [-Device] <Device> 
    [-ID] <string[]> 
    [[-Value] <Object>] 
    [-Force <bool>] 
    [-LiquitContext <LiquitContext>] 
    [-WhatIf] 
    [-Confirm]  
    [<CommonParameters>]

Set-LiquitSetting 
    [-ID] <string[]> 
    [[-Value] <Object>] 
    [-Force <bool>] 
    [-LiquitContext <LiquitContext>] 
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Example

 $setting = Get-LiquitSetting -id portal.style
 Set-LiquitSetting -Setting $setting -Force $true

This command forces the theme setting.

Parameters

NameValueDescriptionRequiredDefault value
Setting<Setting[]>The setting you want to edit.Yes
Value<Object>The new value of the setting.No
Force<bool>Whether or not the end user should be blocked from changing the setting.NoFalse
LiquitContext<LiquitContext>Determines the selected zone.NoDefault

Was this article helpful?

What's Next