Skip to content

Backup File

github-actions edited this page Jun 11, 2026 · 1 revision

external help file: ModernConveniences-help.xml Module Name: ModernConveniences online version: schema: 2.0.0

Backup-File

SYNOPSIS

Create a backup as a sibling to a file, with date and time values in the name.

SYNTAX

Backup-File [-Path] <String> [-ProgressAction <ActionPreference>] [<CommonParameters>]

DESCRIPTION

This provides a quick way to back up a file, usually before making changes that may need to be reverted.

EXAMPLES

EXAMPLE 1

Backup-File logfile.log

Copies logfile.log to logfile-201612311159.log (on that date & time).

PARAMETERS

-Path

Specifies a path to the items being removed. Wildcards are permitted. The parameter name ("-Path") is optional.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

-ProgressAction

{{ Fill ProgressAction Description }}

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
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

System.String, a file path to back up.

OUTPUTS

System.Void

NOTES

RELATED LINKS

Copy-Item

Split-Path

Join-Path

Resolve-Path

Get-Date

Clone this wiki locally