Export-HcsSupportPackage
Export-HcsSupportPackage
Bundles logs into a single .zip file.
Sintaxis
Parameter Set: Default
Export-HcsSupportPackage [-Path] <String> -EncryptionPassphrase <SecureString> [-Credential <PSCredential> ] [-Force] [-Include <ElementFlag> ] [-IncludeArchived] [-MinimumTimestamp <DateTime> ] [-PackageTag <String> ] [-Scope <ClusterScope> ] [ <CommonParameters>]
Descripción detallada
The Export-HcsSupportPackage cmdlet bundles the logs of each controller device into a .zip file. This cmdlet creates one .zip file per controller. Microsoft Customer Service and Support uses these logs to help troubleshoot the device.
This cmldet uses an encryption passphrase to encrypt the package. Share this passphrase with Customer Service and Support.
Parámetros
-Credential<PSCredential>
Specifies a PSCredential object. Specify a credential that has write permission for the location that the Path parameter specifies. To obtain a PSCredential object, use the Get-Credential cmdlet. For more information, type Get-Help Get-Credential
.
Alias |
ninguno |
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
ninguno |
¿Aceptar canalización? |
false |
¿Aceptar caracteres comodín? |
false |
-EncryptionPassphrase<SecureString>
Specifies a passphrase, as a secure string. The cmdlet encrypts the support package by using the passphrase. For Customer Service and Support staff to read the file, you must provide them with the passphrase.
Alias |
ninguno |
¿Requerido? |
true |
¿Posición? |
named |
Valor predeterminado |
ninguno |
¿Aceptar canalización? |
false |
¿Aceptar caracteres comodín? |
false |
-Force
Indicates that the cmdlet does not prompt you for confirmation of the encryption passphrase.
Alias |
ninguno |
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
ninguno |
¿Aceptar canalización? |
false |
¿Aceptar caracteres comodín? |
false |
-Include<ElementFlag>
Specifies an element flag. This parameter determines which logs to include in the support package.
Alias |
ninguno |
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
ninguno |
¿Aceptar canalización? |
false |
¿Aceptar caracteres comodín? |
false |
-IncludeArchived
Indicates that the cmdlet includes archived logs.
Alias |
ninguno |
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
ninguno |
¿Aceptar canalización? |
false |
¿Aceptar caracteres comodín? |
false |
-MinimumTimestamp<DateTime>
Specifies the earliest time to include as a DateTime object. To obtain a DateTime object, use the Get-Date cmdlet. For more information, type Get-Help Get-Date
.
Alias |
ninguno |
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
ninguno |
¿Aceptar canalización? |
false |
¿Aceptar caracteres comodín? |
false |
-PackageTag<String>
Specifies the folder of the support package. The cmdlet adds the folder in the folder that the Path parameter specifies. If you do not specify this parameter, the cmdlet uses the default value of [appliance name]-[current date and time:yyyy-MM-dd-HH-mm-ss].
Alias |
ninguno |
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
ninguno |
¿Aceptar canalización? |
false |
¿Aceptar caracteres comodín? |
false |
-Path<String>
Specifies the network location where the cmdlet stores the support package.
If you have trouble accessing a network share by specifying a name (for example, \\mysharehost\temp\), try accessing it by IP address instead (for example, \\192.168.0.25\temp\). Because this device is not joined to a domain, accessing network shares by name does not always work, depending on the configuration of your network. The device cannot communicate over IPSEC enabled networks.
Alias |
ninguno |
¿Requerido? |
true |
¿Posición? |
1 |
Valor predeterminado |
ninguno |
¿Aceptar canalización? |
false |
¿Aceptar caracteres comodín? |
false |
-Scope<ClusterScope>
Specifies the scope. Los valores aceptables para este parámetro son los siguientes:
-- Cluster. Generate a support package for both nodes. This is the default.
-- Controller. Generate a support package for the local node only.
Alias |
ninguno |
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
ninguno |
¿Aceptar canalización? |
false |
¿Aceptar caracteres comodín? |
false |
<CommonParameters>
Este cmdlet admite los siguientes parámetros comunes: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer y -OutVariable. Para obtener más información, consulte about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Entradas
El tipo de entrada es el tipo de los objetos que se pueden canalizar al cmdlet.
Salidas
El tipo de resultado es el tipo de objetos que emite el cmdlet.
Ejemplos
Example 1: Store bundled logs in a location
This command gathers logs into a support package, and then stores that package in the specified path. The cmdlet gathers only the logs defined by the Include parameter. The command specifies a value of Controller for the Scope parameter, so the command gets logs from the local node only.
PS C:\> Export-HcsSupportPackage -Path "\\10.111.172.250\public" -Include Rttdump -Scope Controller
Example 2: Store bundled logs in a location that requires credentials
This command gathers logs into a support package, and then stores that package in the specified path. The path requires you to supply credentials in order to save the file there. Like the previous example, this command specifies the Include and Scope parameters.
When you run this command, a dialog prompts you for your password. After you enter your password, the console displays output.
PS C:\> Export-HcsSupportPackage -Path "\\10.111.172.250\restricted\davidchew" -Credential "contoso\dchew" -Include Rttdump -Scope Controller