Set-OrchBackupRestoreValue
Introduced in: Citrix Virtual Apps and Desktop 7 2311
Sets a backup restore value to int, string or both.
Syntax
Set-OrchBackupRestoreValue
-Name <String>
[-StringValue <String>]
[-IntValue <Int32>]
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Description
Sets a backup restore value to int, string or both.
Examples
EXAMPLE 1
Sets the Backup Max Pinned Backups value to 10.
Set-OrchBackupRestoreValue -Name MaxPinnedBackups 10
Parameters
-Name
Specifies the name of the backup/restore to set.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-StringValue
The string value to set. Either a string or int value must be specified.
| Type: | String |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-IntValue
The int value to set. Either a string or int value must be specified.
| Type: | Int32 |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-LoggingId
Specifies the identifier of the high-level operation this cmdlet call forms a part of. Citrix Studio and Director typically create high-level operations. PowerShell scripts can also wrap a series of cmdlet calls in a high-level operation by way of the Start-LogHighLevelOperation and Stop-LogHighLevelOperation cmdlets.
| Type: | Guid |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
CitrixCommonParameters
This cmdlet supports the common Citrix parameters: -AdminAddress, -AdminClientIP, -BearerToken, -TraceParent, -TraceState and -VirtualSiteId. For more information, see about_CitrixCommonParameters.
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Inputs
None
You can't pipe objects to this cmdlet.
Outputs
Citrix.Fma.Sdk.Utilities.Service.ServiceStatusInfo
The Set-OrchBackupRestoreValue cmdlet returns an object describing the success or failure of the set call.