Skip to content
This repository has been archived by the owner on Apr 13, 2023. It is now read-only.

Backup Journal

Nick Spreitzer edited this page Feb 17, 2020 · 11 revisions
external help file: JournalCli.dll-Help.xml
Module Name: JournalCli
online version:
schema: 2.0.0

Backup-Journal

SYNOPSIS

Creates a complete backup of your journal entries.

Alias: bj

SYNTAX

Backup-Journal [-BackupLocation <String>] [-Password <String>] [-SaveParameters] [-Location <String>]
 [<CommonParameters>]

DESCRIPTION

Creates a zip archive, optionally password-protected, that includes all journal entry files and saves it to the specified location.

EXAMPLES

EXAMPLE 1

Backup-Journal -BackupLocation 'C:\My\Secret\Location' -Password "secret123" 
  -SaveParameters

Backup your journal to the specified location with the provided password, and save the location and password values for future use. Saved values are encrypted locally on disk.

EXAMPLE 2

Backup-Journal

Backup your journal using the previously saved location and password. Note that if a password and save location have not both been previously saved, the command will fail.

PARAMETERS

-BackupLocation

The path to the directory where backup files should be saved. This parameters is required if a location has not previously been saved.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Location

The path to the root directory for the journal. This is required if it has not been previously saved using the Set-DefaultJournalLocation cmdlet.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Password

The password to apply to the zip archive. If none is provided, the archive will not be password protected.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-SaveParameters

Saves the specified password and/or location for future use.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

None

OUTPUTS

System.Object

NOTES

RELATED LINKS