Skip to content

Get-HomebridgeBackup

SYNOPSIS

Gets scheduled Homebridge backups.

SYNTAX

Named (Default)

Get-HomebridgeBackup [-InstanceName <string>] [-Next]

ExplicitNoAuthentication

Get-HomebridgeBackup -Url <string> -NoAuthentication [-Next]

ExplicitCredential

Get-HomebridgeBackup -Url <string> -Credential <pscredential> [-Next]

DESCRIPTION

This function returns scheduled backup records, or the next scheduled backup when the caller sets Next.

It does not create, download, or remove backups.

EXAMPLES

EXAMPLE 1

Get-HomebridgeBackup -InstanceName home

Returns all scheduled backups from the saved connection named home.

EXAMPLE 2

Get-HomebridgeBackup -InstanceName home -Next

Returns the next scheduled-backup time from the saved connection named home.

PARAMETERS

-Credential

Explicit credentials.

Type: System.Management.Automation.PSCredential
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: ExplicitCredential
  Position: Named
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-InstanceName

The saved connection name.

Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: Named
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Next

Returns the next scheduled backup information.

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: ''

-NoAuthentication

Indicates that the server does not require authentication.

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

-Url

An explicit Homebridge URL.

Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: ExplicitNoAuthentication
  Position: Named
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
- Name: ExplicitCredential
  Position: Named
  IsRequired: true
  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

None.

You cannot pipe objects to this function.

OUTPUTS

PSHomebridge.Backup or PSHomebridge.BackupSchedule.

This function returns complete backup objects.

NOTES

https://pshomebridge.xyz/command-reference/commands/Get-HomebridgeBackup/

https://github.com/angrycuban13/PSHomebridge/blob/main/PSHomebridge/Source/Public/Get-HomebridgeBackup.ps1