-
Notifications
You must be signed in to change notification settings - Fork 52
Set HPOVAutomaticBackupConfig
Configure automatic appliance backup.
Set-HPOVAutomaticBackupConfig [-Hostname] <String> [-Username] <String> [-Password] <SecureString> [-HostSSHKey] <String> [-Directory] <String> [-Protocol] <String> [-Interval] <String> [-Days] <Array> [-Time] <String> [[-Async] <SwitchParameter>] [-ApplianceConnection] <Array> [[-WhatIf] <SwitchParameter>] [[-Confirm] <SwitchParameter>] [<CommonParameters>]Set-HPOVAutomaticBackupConfig [[-Disabled] <SwitchParameter>] [[-Async] <SwitchParameter>] [-ApplianceConnection] <Array> [[-WhatIf] <SwitchParameter>] [[-Confirm] <SwitchParameter>] [<CommonParameters>]Introduced in HPE OneView 3.0, an automatic appliance backup schedule can be configured. The automatic backup process will generate the backup file, then transfer it to a host that supports SCP or SFTP. The hosts public SSH key will be needed in order to successfuly configure.
During the configuration process, a test file will be created and stored on the host. This file can be safely deleted once the async task has successfully completed.
-ApplianceConnection <Array>
Specify one or more [HPOneView.Appliance.Connection] object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.
Default Value: ${Global:ConnectedSessions} | ? Default
| Aliases | Appliance |
| Required? | true |
| Position? | named |
| Default value | (${Global:ConnectedSessions} | ? Default) |
| Accept pipeline input? | false |
| Accept wildcard characters? | False |
-Async <SwitchParameter>
Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.
| Aliases | None |
| Required? | false |
| Position? | named |
| Default value | False |
| Accept pipeline input? | false |
| Accept wildcard characters? | False |
-Confirm <SwitchParameter>
| Aliases | cf |
| Required? | false |
| Position? | named |
| Default value | |
| Accept pipeline input? | false |
| Accept wildcard characters? | False |
-Days <Array>
If specifying a Weekly backup, provide the days in an Array. Accepted values are:
* SU or SUN or Sunday
* MO or MON or Monday
* TU or TUE or Tuesday
* WE or WED or Wednesday
* TH or THUR or Thursday
* FR or FRI or Friday
* SA or SAT or Saturday
| Aliases | None |
| Required? | true |
| Position? | named |
| Default value | |
| Accept pipeline input? | false |
| Accept wildcard characters? | False |
-Directory <String>
The remote directory on the host where the file will be saved to. Omit to sepcify the root or default directory the user account is associated with.
| Aliases | None |
| Required? | true |
| Position? | named |
| Default value | |
| Accept pipeline input? | false |
| Accept wildcard characters? | False |
-Disabled <SwitchParameter>
Disable the automatic backup schedule.
| Aliases | None |
| Required? | false |
| Position? | named |
| Default value | False |
| Accept pipeline input? | false |
| Accept wildcard characters? | False |
-HostSSHKey <String>
The SCP/SFTP hosts public key, in OpenSSH String format.
| Aliases | None |
| Required? | true |
| Position? | named |
| Default value | |
| Accept pipeline input? | false |
| Accept wildcard characters? | False |
-Hostname <String>
The IP Address or FQDN of the target SCP or SFTP host.
| Aliases | None |
| Required? | true |
| Position? | named |
| Default value | |
| Accept pipeline input? | false |
| Accept wildcard characters? | False |
-Interval <String>
The frequency the backup will be generated. Supported values are:
* Daily
* Weekly
| Aliases | None |
| Required? | true |
| Position? | named |
| Default value | |
| Accept pipeline input? | false |
| Accept wildcard characters? | False |
-Password <SecureString>
The password of the user.
Specify the Logical Interconnect URI or Object the Support Dump will be generated for, from pipeline.
| Aliases | None |
| Required? | true |
| Position? | named |
| Default value | |
| Accept pipeline input? | false |
| Accept wildcard characters? | False |
-Protocol <String>
The protocol to connect to the remote host with. Supported values are:
* SCP
* SFTP
Default: SCP
| Aliases | None |
| Required? | true |
| Position? | named |
| Default value | SCP |
| Accept pipeline input? | false |
| Accept wildcard characters? | False |
-Time <String>
The time to execute, in 24hr clock.
| Aliases | None |
| Required? | true |
| Position? | named |
| Default value | |
| Accept pipeline input? | false |
| Accept wildcard characters? | False |
-Username <String>
The username to authenticate to the SCP/SFTP host with.
| Aliases | None |
| Required? | true |
| Position? | named |
| Default value | |
| Accept pipeline input? | false |
| Accept wildcard characters? | False |
-WhatIf <SwitchParameter>
| Aliases | wi |
| 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)
None. You cannot pipe objects to this Cmdlet.
HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]
Appliance async task to monitor
System.Collections.Arraylist <HPOneView.Appliance.TaskResource>
Multiple appliance async task to monitor
-------------------------- EXAMPLE 1 --------------------------$HostSSHKey = Get-Content C:\host.key Set-HPOVAutomaticBackupConfig -Hostname scphost.domain.com -Username backupadmin -Password (ConvertTo-SecureString password -AsPlainText -Force) -HostSSHKey $HostSSHKey -Protocol SCP -Interval Weekly -Days "MON","WED","FRI" -Time 18:00
This command will configure automatic appliance backup, based on a weekly Monday, Wednesday and Friday schedule to execute at 18:00 (6:00PM).
-------------------------- EXAMPLE 2 --------------------------$HostSSHKey = Get-Content C:\host.key Set-HPOVAutomaticBackupConfig -Hostname scphost.domain.com -Username backupadmin -Password (ConvertTo-SecureString password -AsPlainText -Force) -HostSSHKey $HostSSHKey -Protocol SCP -Interval Weekly -Days "MON","WED","FRI" -Time 18:00 New-HPOVBackup
This command will configure automatic appliance backup, based on a weekly Monday, Wednesday and Friday schedule to execute at 18:00 (6:00PM). Then, a call to New-HPOVBackup will be made, which will generate and copy the backup file to the remote location configured.
Configure automatic appliance backup.
Set-HPOVAutomaticBackupConfig [-Hostname] <String> [-Username] <String> [-Password] <SecureString> [-HostSSHKey] <String> [-Directory] <String> [-Protocol] <String> [-Interval] <String> [-Days] <Array> [-Time] <String> [[-Async] <SwitchParameter>] [-ApplianceConnection] <Array> [[-WhatIf] <SwitchParameter>] [[-Confirm] <SwitchParameter>] [<CommonParameters>]Set-HPOVAutomaticBackupConfig [[-Disabled] <SwitchParameter>] [[-Async] <SwitchParameter>] [-ApplianceConnection] <Array> [[-WhatIf] <SwitchParameter>] [[-Confirm] <SwitchParameter>] [<CommonParameters>]Introduced in HPE OneView 3.0, an automatic appliance backup schedule can be configured. The automatic backup process will generate the backup file, then transfer it to a host that supports SCP or SFTP. The hosts public SSH key will be needed in order to successfuly configure.
During the configuration process, a test file will be created and stored on the host. This file can be safely deleted once the async task has successfully completed.
-ApplianceConnection <Array>
Aliases [-Appliance]
Specify one or more HPOneView.Appliance.Connection object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.
Default Value: ${Global:ConnectedSessions} | ? Default
| Aliases | Appliance |
| Required? | true |
| Position? | named |
| Default value | (${Global:ConnectedSessions} | ? Default) |
| Accept pipeline input? | false |
| Accept wildcard characters? | False |
-Async <SwitchParameter>
Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.
| Aliases | None |
| Required? | false |
| Position? | named |
| Default value | False |
| Accept pipeline input? | false |
| Accept wildcard characters? | False |
-Confirm <SwitchParameter>
| Aliases | cf |
| Required? | false |
| Position? | named |
| Default value | |
| Accept pipeline input? | false |
| Accept wildcard characters? | False |
-Days <Array>
If specifying a Weekly backup, provide the days in an Array. Accepted values are:
* SU or SUN or Sunday
* MO or MON or Monday
* TU or TUE or Tuesday
* WE or WED or Wednesday
* TH or THUR or Thursday
* FR or FRI or Friday
* SA or SAT or Saturday
| Aliases | None |
| Required? | true |
| Position? | named |
| Default value | |
| Accept pipeline input? | false |
| Accept wildcard characters? | False |
-Directory <String>
The remote directory on the host where the file will be saved to. Omit to sepcify the root or default directory the user account is associated with.
| Aliases | None |
| Required? | true |
| Position? | named |
| Default value | |
| Accept pipeline input? | false |
| Accept wildcard characters? | False |
-Disabled <SwitchParameter>
Disable the automatic backup schedule.
| Aliases | None |
| Required? | false |
| Position? | named |
| Default value | False |
| Accept pipeline input? | false |
| Accept wildcard characters? | False |
-HostSSHKey <String>
The SCP/SFTP hosts public key, in OpenSSH String format.
| Aliases | None |
| Required? | true |
| Position? | named |
| Default value | |
| Accept pipeline input? | false |
| Accept wildcard characters? | False |
-Hostname <String>
The IP Address or FQDN of the target SCP or SFTP host.
| Aliases | None |
| Required? | true |
| Position? | named |
| Default value | |
| Accept pipeline input? | false |
| Accept wildcard characters? | False |
-Interval <String>
The frequency the backup will be generated. Supported values are:
* Daily
* Weekly
| Aliases | None |
| Required? | true |
| Position? | named |
| Default value | |
| Accept pipeline input? | false |
| Accept wildcard characters? | False |
-Password <SecureString>
The password of the user.
Specify the Logical Interconnect URI or Object the Support Dump will be generated for, from pipeline.
| Aliases | None |
| Required? | true |
| Position? | named |
| Default value | |
| Accept pipeline input? | false |
| Accept wildcard characters? | False |
-Protocol <String>
The protocol to connect to the remote host with. Supported values are:
* SCP
* SFTP
Default: SCP
| Aliases | None |
| Required? | true |
| Position? | named |
| Default value | SCP |
| Accept pipeline input? | false |
| Accept wildcard characters? | False |
-Time <String>
The time to execute, in 24hr clock.
| Aliases | None |
| Required? | true |
| Position? | named |
| Default value | |
| Accept pipeline input? | false |
| Accept wildcard characters? | False |
-Username <String>
The username to authenticate to the SCP/SFTP host with.
| Aliases | None |
| Required? | true |
| Position? | named |
| Default value | |
| Accept pipeline input? | false |
| Accept wildcard characters? | False |
-WhatIf <SwitchParameter>
| Aliases | wi |
| 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)
None. You cannot pipe objects to this cmdlet.
HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]
Appliance async task to monitor
System.Collections.Arraylist <HPOneView.Appliance.TaskResource>
Multiple appliance async task to monitor
-------------------------- EXAMPLE 1 --------------------------$HostSSHKey = Get-Content C:\host.key Set-HPOVAutomaticBackupConfig -Hostname scphost.domain.com -Username backupadmin -Password (ConvertTo-SecureString password -AsPlainText -Force) -HostSSHKey $HostSSHKey -Protocol SCP -Interval Weekly -Days "MON","WED","FRI" -Time 18:00
This command will configure automatic appliance backup, based on a weekly Monday, Wednesday and Friday schedule to execute at 18:00 (6:00PM).
-------------------------- EXAMPLE 2 --------------------------$HostSSHKey = Get-Content C:\host.key Set-HPOVAutomaticBackupConfig -Hostname scphost.domain.com -Username backupadmin -Password (ConvertTo-SecureString password -AsPlainText -Force) -HostSSHKey $HostSSHKey -Protocol SCP -Interval Weekly -Days "MON","WED","FRI" -Time 18:00 New-HPOVBackup
This command will configure automatic appliance backup, based on a weekly Monday, Wednesday and Friday schedule to execute at 18:00 (6:00PM). Then, a call to New-HPOVBackup will be made, which will generate and copy the backup file to the remote location configured.
Configure automatic appliance backup.
Set-HPOVAutomaticBackupConfig [-Hostname] <String> [-Username] <String> [-Password] <SecureString> [-HostSSHKey] <String> [-Directory] <String> [-Protocol] <String> [-Interval] <String> [-Days] <Array> [-Time] <String> [[-Async] <SwitchParameter>] [-ApplianceConnection] <Array> [[-WhatIf] <SwitchParameter>] [[-Confirm] <SwitchParameter>] [<CommonParameters>]Set-HPOVAutomaticBackupConfig [[-Disabled] <SwitchParameter>] [[-Async] <SwitchParameter>] [-ApplianceConnection] <Array> [[-WhatIf] <SwitchParameter>] [[-Confirm] <SwitchParameter>] [<CommonParameters>]Introduced in HPE OneView 3.0, an automatic appliance backup schedule can be configured. The automatic backup process will generate the backup file, then transfer it to a host that supports SCP or SFTP. The hosts public SSH key will be needed in order to successfuly configure.
During the configuration process, a test file will be created and stored on the host. This file can be safely deleted once the async task has successfully completed.
-ApplianceConnection <Array>
Aliases [-Appliance]
Specify one or more HPOneView.Appliance.Connection object(s) or Name property value(s). If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.
Default Value: ${Global:ConnectedSessions} | ? Default
| Aliases | Appliance |
| Required? | true |
| Position? | named |
| Default value | (${Global:ConnectedSessions} | ? Default) |
| Accept pipeline input? | false |
| Accept wildcard characters? | False |
-Async <SwitchParameter>
Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.
| Aliases | None |
| Required? | false |
| Position? | named |
| Default value | False |
| Accept pipeline input? | false |
| Accept wildcard characters? | False |
-Confirm <SwitchParameter>
| Aliases | cf |
| Required? | false |
| Position? | named |
| Default value | |
| Accept pipeline input? | false |
| Accept wildcard characters? | False |
-Days <Array>
If specifying a Weekly backup, provide the days in an Array. Accepted values are:
* SU or SUN or Sunday
* MO or MON or Monday
* TU or TUE or Tuesday
* WE or WED or Wednesday
* TH or THUR or Thursday
* FR or FRI or Friday
* SA or SAT or Saturday
| Aliases | None |
| Required? | true |
| Position? | named |
| Default value | |
| Accept pipeline input? | false |
| Accept wildcard characters? | False |
-Directory <String>
The remote directory on the host where the file will be saved to. Omit to sepcify the root or default directory the user account is associated with.
| Aliases | None |
| Required? | true |
| Position? | named |
| Default value | |
| Accept pipeline input? | false |
| Accept wildcard characters? | False |
-Disabled <SwitchParameter>
Disable the automatic backup schedule.
| Aliases | None |
| Required? | false |
| Position? | named |
| Default value | False |
| Accept pipeline input? | false |
| Accept wildcard characters? | False |
-HostSSHKey <String>
The SCP/SFTP hosts public key, in OpenSSH String format.
| Aliases | None |
| Required? | true |
| Position? | named |
| Default value | |
| Accept pipeline input? | false |
| Accept wildcard characters? | False |
-Hostname <String>
The IP Address or FQDN of the target SCP or SFTP host.
| Aliases | None |
| Required? | true |
| Position? | named |
| Default value | |
| Accept pipeline input? | false |
| Accept wildcard characters? | False |
-Interval <String>
The frequency the backup will be generated. Supported values are:
* Daily
* Weekly
| Aliases | None |
| Required? | true |
| Position? | named |
| Default value | |
| Accept pipeline input? | false |
| Accept wildcard characters? | False |
-Password <SecureString>
The password of the user.
Specify the Logical Interconnect URI or Object the Support Dump will be generated for, from pipeline.
| Aliases | None |
| Required? | true |
| Position? | named |
| Default value | |
| Accept pipeline input? | false |
| Accept wildcard characters? | False |
-Protocol <String>
The protocol to connect to the remote host with. Supported values are:
* SCP
* SFTP
Default: SCP
| Aliases | None |
| Required? | true |
| Position? | named |
| Default value | SCP |
| Accept pipeline input? | false |
| Accept wildcard characters? | False |
-Time <String>
The time to execute, in 24hr clock.
| Aliases | None |
| Required? | true |
| Position? | named |
| Default value | |
| Accept pipeline input? | false |
| Accept wildcard characters? | False |
-Username <String>
The username to authenticate to the SCP/SFTP host with.
| Aliases | None |
| Required? | true |
| Position? | named |
| Default value | |
| Accept pipeline input? | false |
| Accept wildcard characters? | False |
-WhatIf <SwitchParameter>
| Aliases | wi |
| 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)
None. You cannot pipe objects to this cmdlet.
HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]
Appliance async task to monitor
System.Collections.Arraylist <HPOneView.Appliance.TaskResource>
Multiple appliance async task to monitor
-------------------------- EXAMPLE 1 --------------------------$HostSSHKey = Get-Content C:\host.key Set-HPOVAutomaticBackupConfig -Hostname scphost.domain.com -Username backupadmin -Password (ConvertTo-SecureString password -AsPlainText -Force) -HostSSHKey $HostSSHKey -Protocol SCP -Interval Weekly -Days "MON","WED","FRI" -Time 18:00
This command will configure automatic appliance backup, based on a weekly Monday, Wednesday and Friday schedule to execute at 18:00 (6:00PM).
-------------------------- EXAMPLE 2 --------------------------$HostSSHKey = Get-Content C:\host.key Set-HPOVAutomaticBackupConfig -Hostname scphost.domain.com -Username backupadmin -Password (ConvertTo-SecureString password -AsPlainText -Force) -HostSSHKey $HostSSHKey -Protocol SCP -Interval Weekly -Days "MON","WED","FRI" -Time 18:00 New-HPOVBackup
This command will configure automatic appliance backup, based on a weekly Monday, Wednesday and Friday schedule to execute at 18:00 (6:00PM). Then, a call to New-HPOVBackup will be made, which will generate and copy the backup file to the remote location configured.