Skip to content

New-TriliumBackup

SYNOPSIS

Creates a new backup for a specific Trilium instance.

SYNTAX

__AllParameterSets

New-TriliumBackup [-BackupID] <string> [-SkipCertCheck] [-WhatIf] [-Confirm] [<CommonParameters>]

ALIASES

This cmdlet has no aliases.

DESCRIPTION

This function creates a new backup for a specific Trilium instance based on the provided backup ID.

EXAMPLES

EXAMPLE 1

New-TriliumBackup -BackupID "MyBackup"

Creates a new backup with the ID "MyBackup" for the Trilium instance.

PARAMETERS

-BackupID

The backup ID to create a new backup for.

Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: 0
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: System.Management.Automation.SwitchParameter
DefaultValue: ''
SupportsWildcards: false
Aliases:
- cf
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-SkipCertCheck

Option to skip certificate check.

Type: System.Management.Automation.SwitchParameter
DefaultValue: False
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-WhatIf

Tells PowerShell to run the command in a mode that only reports what would happen, but not actually let the command run or make changes.

Type: System.Management.Automation.SwitchParameter
DefaultValue: ''
SupportsWildcards: false
Aliases:
- wi
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

System.String

You can pipe a backup ID string to this cmdlet.

OUTPUTS

System.Management.Automation.PSCustomObject

Returns information about the created backup.

NOTES

This function requires that the authentication has been set using Connect-TriliumAuth.