Set-OBPolicy

Set-OBPolicy

Sets the OBPolicy object as the backup policy that will be used for scheduled backups.

Syntax

Parameter Set: Default
Set-OBPolicy [-Policy] <CBPolicy> [-Confirm] [-WhatIf] [ <CommonParameters>]




Detailed Description

Sets the OBPolicy object as the backup policy that will be used for scheduled backups.

This cmdlet supports WhatIf and Confirm parameters with a high impact. The high impact signifies that the cmdlet will prompt the user for confirmation by default. The WhatIf parameter gives a verbose description of what the cmdlet does without performing any operation. The Confirm parameter specifies whether the cmdlet should prompt the user. Using –Confirm:$FALSE will override the prompt.

Parameters

-Policy<CBPolicy>

Specifies the current OBPolicy object be set as the active backup policy for the server.


Aliases

none

Required?

true

Position?

2

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

-Confirm

Prompts you for confirmation before running the cmdlet.


Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.


Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<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

The input type is the type of the objects that you can pipe to the cmdlet.

  • Microsoft.Internal.CloudBackup.Commands.OBPolicy

Outputs

The output type is the type of the objects that the cmdlet emits.

  • Microsoft.Internal.CloudBackup.Commands.OBPolicy

    This cmdlet sets the OBPolicy object as the backup policy to use for scheduled backups.


Examples

EXAMPLE 1

This example sets a new online backup policy for a server.


PS C:\> $fspec = New-OBFileSpec –FileSpec C:\test\texttext1.txt
PS C:\> $rpolicy = New-OBRetentionPolicy
PS C:\> $sch = New-OBSchedule
PS C:\> New-OBPolicy | Add-OBFileSpec -FileSPec $fspec | Set-OBRetentionPolicy -RetentionPolicy $rpolicy | Set-OBSchedule -Schedule $sch | Set-OBPolicy

Related topics

Community Additions

ADD
Show: