Citrix Virtual Apps and Desktops SDK

Set-OrchBackupRestoreValue

March 11, 2024

Contributed by:

Sets a backup restore value to int, string or both.

Syntax

Set-OrchBackupRestoreValue
   -Name <String>
   [-StringValue <String>]
   [-IntValue <Int32>]
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

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
<!--NeedCopy-->

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 cannot pipe input into this cmdlet.

Outputs

Citrix.Fma.Sdk.Utilities.Service.ServiceStatusInfo

The Set-BackupRestoreValue cmdlet returns an object describing the success or failure of the set call.

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

Set-OrchBackupRestoreValue

March 11, 2024

Contributed by:

March 11, 2024

Contributed by:

Set-OrchBackupRestoreValue

Syntax

Description

Examples

EXAMPLE 1

Parameters

-Name

-StringValue

-IntValue

-LoggingId

CitrixCommonParameters

CommonParameters

Inputs

None

Outputs

Citrix.Fma.Sdk.Utilities.Service.ServiceStatusInfo

Related Links

In this article