Start HPOVRemoteSupportCollection - HewlettPackard/POSH-HPEOneView GitHub Wiki
Begin Remote Support collection from endpoints.
Start-HPOVRemoteSupportCollection [-InputObject] <Object> [-Type] <Object>[ [-ApplianceConnection] <Object>][ [-Async] <SwitchParameter>] [<CommonParameters>]Use this Cmdlet to initiate colleciton of remote support data. This will help send collection reports back to HPE that are in between the default scheduled task.
-ApplianceConnection <Object>
Aliases [-Appliance]
Specify one or more HPOneView.Appliance.Connection object(s) or Name property value(s).
Default Value: ${Global:ConnectedSessions} | ? Default
| Aliases | Appliance |
| Required? | false |
| Position? | 2 |
| Default value | (${Global:ConnectedSessions} | ? Default) |
| Accept pipeline input? | true (ByPropertyName) |
| 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 |
-InputObject <Object>
A supported Gen8 or newer compute, HPE BladeSystem enclosure, or HPE Synergy frame.
| Aliases | None |
| Required? | true |
| Position? | 0 |
| Default value | |
| Accept pipeline input? | true (ByValue) |
| Accept wildcard characters? | False |
-Type <Object>
Used to specify the type of remote support collection to start. Allowed values are:
* AHS - Active Health Service collection
* Basic - Basic server configuration collection
| Aliases | None |
| Required? | true |
| Position? | 1 |
| 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)
HPOneView.ServerHardware [System.Management.Automation.PSCustomObject]
A Gen8 or newer generation server hardware resource object from Get-HPOVServer.
HPOneView.Enclosure [System.Management.Automation.PSCustomObject]
A Gen8 or newer generation server hardware resource object from Get-HPOVServer.
HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]
Asyncronous task resource to monitor
-------------------------- EXAMPLE 1 --------------------------Get-HPOVServer -Name Prod-Sql-01 | Start-HPOVRemoteSupportCollection -Type AHS
Start the collection of AHS logs immediately for the specified server.
-------------------------- EXAMPLE 2 --------------------------Get-HPOVEnclosure | Start-HPOVRemoteSupportCollection -Type Basic
Start the collection of basic server configuration immediately.
Begin Remote Support collection from endpoints.
Start-HPOVRemoteSupportCollection [-InputObject] <Object> [-Type] <Object>[ [-ApplianceConnection] <Object>][ [-Async] <SwitchParameter>] [<CommonParameters>]Use this Cmdlet to initiate colleciton of remote support data. This will help send collection reports back to HPE that are in between the default scheduled task.
-ApplianceConnection <Object>
Aliases [-Appliance]
Specify one or more HPOneView.Appliance.Connection object(s) or Name property value(s).
Default Value: ${Global:ConnectedSessions} | ? Default
| Aliases | Appliance |
| Required? | false |
| Position? | 2 |
| Default value | (${Global:ConnectedSessions} | ? Default) |
| Accept pipeline input? | true (ByPropertyName) |
| 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 |
-InputObject <Object>
A supported Gen8 or newer compute, HPE BladeSystem enclosure, or HPE Synergy frame.
| Aliases | None |
| Required? | true |
| Position? | 0 |
| Default value | |
| Accept pipeline input? | true (ByValue) |
| Accept wildcard characters? | False |
-Type <Object>
Used to specify the type of remote support collection to start. Allowed values are:
* AHS - Active Health Service collection
* Basic - Basic server configuration collection
| Aliases | None |
| Required? | true |
| Position? | 1 |
| 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)
HPOneView.ServerHardware [System.Management.Automation.PSCustomObject]
A Gen8 or newer generation server hardware resource object from Get-HPOVServer.
HPOneView.Enclosure [System.Management.Automation.PSCustomObject]
A Gen8 or newer generation server hardware resource object from Get-HPOVServer.
HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]
Asyncronous task resource to monitor
-------------------------- EXAMPLE 1 --------------------------Get-HPOVServer -Name Prod-Sql-01 | Start-HPOVRemoteSupportCollection -Type AHS
Start the collection of AHS logs immediately for the specified server.
-------------------------- EXAMPLE 2 --------------------------Get-HPOVEnclosure | Start-HPOVRemoteSupportCollection -Type Basic
Start the collection of basic server configuration immediately.