< Back
Invoke-iBMCFileDownload
Post
NAME Invoke-iBMCFileDownload
SYNOPSIS
Download a BMC file.
SYNTAX
Invoke-iBMCFileDownload [-Session] <RedfishSession[]> [-BMCFileUri] <String[]> [-LocalFileUri] <String[]>
[<CommonParameters>]
DESCRIPTION
Download a BMC file to local storage.
PARAMETERS
-Session <RedfishSession[]>
iBMC redfish session object which is created by Connect-iBMC cmdlet.
A session object identifies an iBMC server to which this cmdlet will be executed.
Required? true
Position? 1
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-BMCFileUri <String[]>
Indicates the BMC storage file uri.
BMCFileUri should start with "/tmp/"
Required? true
Position? 2
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-LocalFileUri <String[]>
Indicates the local storage file uri.
LocalFileUri examples:
- C:\\2288H_V5_5288_V5-iBMC-V318.hpm
- \\\\192.168.1.2\\2288H_V5_5288_V5-iBMC-V318.hpm
Required? true
Position? 3
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
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 (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
None
Returns None if cmdlet executes successfully.
In case of an error or warning, exception will be returned.
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>$credential = Get-Credential
PS C:\\> $session = Connect-iBMC -Address 10.1.1.2 -Credential $credential -TrustCert
PS C:\\> $BMCFilePath = "/tmp/web/2288H_V5_5288_V5-iBMC-V318.hpm"
PS C:\\> $LocalFilePath = "E:\\2288H_V5_5288_V5-iBMC-V318.hpm"
PS C:\\> Invoke-iBMCFileDownload -Session $session `
-BMCFileUri $BMCFilePath -LocalFileUri $LocalFilePath
RELATED LINKS
https://github.com/Huawei/Huawei-iBMC-Cmdlets
Invoke-iBMCFileUpload
Connect-iBMC
Disconnect-iBMC
SYNOPSIS
Download a BMC file.
SYNTAX
Invoke-iBMCFileDownload [-Session] <RedfishSession[]> [-BMCFileUri] <String[]> [-LocalFileUri] <String[]>
[<CommonParameters>]
DESCRIPTION
Download a BMC file to local storage.
PARAMETERS
-Session <RedfishSession[]>
iBMC redfish session object which is created by Connect-iBMC cmdlet.
A session object identifies an iBMC server to which this cmdlet will be executed.
Required? true
Position? 1
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-BMCFileUri <String[]>
Indicates the BMC storage file uri.
BMCFileUri should start with "/tmp/"
Required? true
Position? 2
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-LocalFileUri <String[]>
Indicates the local storage file uri.
LocalFileUri examples:
- C:\\2288H_V5_5288_V5-iBMC-V318.hpm
- \\\\192.168.1.2\\2288H_V5_5288_V5-iBMC-V318.hpm
Required? true
Position? 3
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
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 (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
None
Returns None if cmdlet executes successfully.
In case of an error or warning, exception will be returned.
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>$credential = Get-Credential
PS C:\\> $session = Connect-iBMC -Address 10.1.1.2 -Credential $credential -TrustCert
PS C:\\> $BMCFilePath = "/tmp/web/2288H_V5_5288_V5-iBMC-V318.hpm"
PS C:\\> $LocalFilePath = "E:\\2288H_V5_5288_V5-iBMC-V318.hpm"
PS C:\\> Invoke-iBMCFileDownload -Session $session `
-BMCFileUri $BMCFilePath -LocalFileUri $LocalFilePath
RELATED LINKS
https://github.com/Huawei/Huawei-iBMC-Cmdlets
Invoke-iBMCFileUpload
Connect-iBMC
Disconnect-iBMC