Skip to content

Get HPOVBackup

Chris Lynch edited this page Mar 31, 2020 · 19 revisions

ℹ️ Note: This Wiki is no longer the source for HPE OneView PowerShell Library documentation. The new location is here.

Please update your local offline help system using Get-Help <ModuleName> to dwonload the latest offline help contents.

HPE OneView

Library

5.00

Get-HPOVBackup

Syntax

Get-HPOVBackup [[-Before] <DateTime>] [[-After] <DateTime>] [[-ApplianceConnection] <Array>] [<CommonParameters>]

Description

HPE OneView provides the ability to save your configuration settings and management data to a backup file and enables you to use that backup to restore a corrupted appliance in the event of a catastrophic failure.

The backup process involves creating a backup file and then downloading that file so that you can store it to a safe and secure (off-appliance) location for future use. You can schedule automatic backup operations and designate a remote location for the backup file.

Use this Cmdlet to return any existing backups that have not been downloaded or offloaded on the appliance.

Minimum required privileges: Read only

Parameters

-After <DateTime>

Specify the DateTime object of when to locate backups created after.

Aliases None
Required? False
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters?    False

-ApplianceConnection <Array>

Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s).

Aliases Appliance
Required? False
Position? named
Default value (${Global:ConnectedSessions} | ? Default)
Accept pipeline input? false
Accept wildcard characters?    False

-Before <DateTime>

Specify the DateTime object of when to locate backups created before.

Aliases None
Required? False
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters?    False

<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216)

Input Types

None. You cannot pipe objects to this Cmdlet.

Return Values

The generated backup File if appliance is not setup for remote storage or the Force parameter is used.

Examples

 -------------------------- EXAMPLE 1 --------------------------

Get-HPOVBackup

This command will return any appliance backs present on the appliance.

 -------------------------- EXAMPLE 2 --------------------------

Get-HPOVBackup -Before [datetime]"2017/01/01"

This command will return appliance backups that were created before 2017/01/01.

Related Links


HPE OneView

Library

4.20

Get-HPOVBackup

Syntax

Get-HPOVBackup [[-Before] <DateTime>] [[-After] <DateTime>] [-ApplianceConnection] <Array> [<CommonParameters>]

Description

HPE OneView provides the ability to save your configuration settings and management data to a backup file and enables you to use that backup to restore a corrupted appliance in the event of a catastrophic failure.

The backup process involves creating a backup file and then downloading that file so that you can store it to a safe and secure (off-appliance) location for future use. You can schedule automatic backup operations and designate a remote location for the backup file.

Use this cmdlet to return any existing backups that have not been downloaded or offloaded on the appliance.

Parameters

-After <DateTime>

Specify the DateTime object of when to locate backups created after.

Aliases None
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters?    False

-ApplianceConnection <Array>

Aliases [-Appliance]

Specify one or more HPOneView.Appliance.Connection object(s) or Name property value(s).

Default Value: ${Global:ConnectedSessions} | ? Default

Aliases Appliance
Required? true
Position? named
Default value (${Global:ConnectedSessions} | ? Default)
Accept pipeline input? false
Accept wildcard characters?    False

-Before <DateTime>

Specify the DateTime object of when to locate backups created before.

Aliases None
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters?    False

<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216)

Input Types

None. You cannot pipe objects to this cmdlet.

Return Values

The generated backup File if appliance is not setup for remote storage or the Force parameter is used.

Examples

 -------------------------- EXAMPLE 1 --------------------------

Get-HPOVBackup

This command will return any appliance backs present on the appliance.

 -------------------------- EXAMPLE 2 --------------------------

Get-HPOVBackup -Before [datetime]"2017/01/01"

This command will return applinace backups that were created before 2017/01/01.

Related Links


HPE OneView

Library

4.10

Get-HPOVBackup

Syntax

Get-HPOVBackup [[-Before] <DateTime>] [[-After] <DateTime>] [-ApplianceConnection] <Array> [<CommonParameters>]

Description

HPE OneView provides the ability to save your configuration settings and management data to a backup file and enables you to use that backup to restore a corrupted appliance in the event of a catastrophic failure.

The backup process involves creating a backup file and then downloading that file so that you can store it to a safe and secure (off-appliance) location for future use. You can schedule automatic backup operations and designate a remote location for the backup file.

Use this cmdlet to return any existing backups that have not been downloaded or offloaded on the appliance.

Parameters

-After <DateTime>

Specify the DateTime object of when to locate backups created after.

Aliases None
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters?    False

-ApplianceConnection <Array>

Aliases [-Appliance]

Specify one or more HPOneView.Appliance.Connection object(s) or Name property value(s).

Default Value: ${Global:ConnectedSessions} | ? Default

Aliases Appliance
Required? true
Position? named
Default value (${Global:ConnectedSessions} | ? Default)
Accept pipeline input? false
Accept wildcard characters?    False

-Before <DateTime>

Specify the DateTime object of when to locate backups created before.

Aliases None
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters?    False

<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216)

Input Types

None. You cannot pipe objects to this cmdlet.

Return Values

The generated backup File if appliance is not setup for remote storage or the Force parameter is used.

Examples

 -------------------------- EXAMPLE 1 --------------------------

Get-HPOVBackup

This command will return any appliance backs present on the appliance.

 -------------------------- EXAMPLE 2 --------------------------

Get-HPOVBackup -Before [datetime]"2017/01/01"

This command will return applinace backups that were created before 2017/01/01.

Related Links


Wiki Table of Contents

Clone this wiki locally