Skip to main content

Set-ZrWorkspace

Updates a saved Zaris workspace — rename it, change its managers, or set/clear its admin token. Use it to edit connection details without recreating the workspace.

Syntax​

Set-ZrWorkspace
    -Name <string>
    [-NewName <string>]
    [-Managers <string[]>]
    [-Token <string>]
    [-WhatIf] [-Confirm]

Description​

Set-ZrWorkspace edits an existing saved workspace in local state. Supply -NewName to rename it, -Managers to replace its manager endpoints, or -Token to set (or, with an empty string, clear) its admin token. If the workspace being edited is the active one, the current session's target is refreshed immediately so the change takes effect without reconnecting. When the new managers overlap another workspace, a warning is emitted but the update proceeds. This cmdlet operates purely on local workspace state, so no manager connection is required.

Parameters​

ParameterTypeRequiredDescription
-NamestringYesName of the workspace to update. Position 0.
-NewNamestringNoNew name for the workspace.
-Managersstring[]NoReplacement manager endpoints (host:port or full URLs) for the workspace.
-TokenstringNoSet the admin token; pass an empty string to clear it.

Supports -WhatIf and -Confirm.

Examples​

Replace the managers of the prod workspace with a single endpoint.

Set-ZrWorkspace -Name prod -Managers 10.0.0.12:7801

Rename a workspace.

Set-ZrWorkspace -Name prod -NewName production