Debug-NetworkController
Queries a Network Controller for detailed diagnostic information.
Syntax
Default (Default)
Debug-NetworkController
[-NetworkController] <String>
[-SetupDiagnostics]
[[-IncludeTraces] <Boolean>]
[[-OutputDirectory] <String>]
[[-Credential] <PSCredential>]
[[-RestURI] <String>]
[[-CertificateThumbprint] <String>]
[[-DeviceCredentials] <Hashtable>]
[-ExcludeSlbState]
[<CommonParameters>]
Description
The Debug-NetworkController cmdlet queries a Network Controller for detailed diagnostic information.
You can run this cmdlet from a computer that has Layer-3 connectivity to the Representational State Transfer (REST) IP address of the Network Controller. The computer must have the Network Controller REST certificate installed.
Examples
Example 1: Set up logging on nodes and hosts
PS C:\>Debug-NetworkController -NetworkController "NC-0.contoso.cloud.com" -SetupDiagnostics
This command sets up logging on all Network Controller nodes and hosts.
Example 2: Collect diagnostics data and logs from all nodes and hosts
PS C:\>$Credential = Get-Credential
PS C:\> Debug-NetworkController -NetworkController "NC-0.contoso.cloud.com" -Credential $Credential -OutputDirectory "C:\DiagnosticsData"
The first command creates credentials by using the Get-Credential cmdlet, and then stores it in the $Credential variable. The command prompts you for user name and password.
The second command collects diagnostics data and logs from all Network Controller nodes and hosts.
Example 3: Collect diagnostics data only
PS C:\>$Credential = Get-Credential
PS C:\> Debug-NetworkController -NetworkController "NC-0.contoso.cloud.com" -Credential $Credential -OutputDirectory C:\DiagnosticsData -IncludeTraces:$False
The first command creates credentials, and then stores it in the $Credential variable.
The second command collects diagnostics data only.
Parameters
-CertificateThumbprint
Specifies the certificate thumbprint to use for the Network Controller. Specify this parameter for certificate deployment.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 5 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Credential
Specifies a credential to use for the Network Controller. Specify this parameter for Kerberos deployment.
Parameter properties
| Type: | PSCredential |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 3 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-DeviceCredentials
List of device Credentials. Specify if device credentials are different then Network Controller.
Parameter properties
| Type: | Hashtable |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 6 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ExcludeSlbState
Indicates that this cmdlet excludes SLB State information.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-IncludeTraces
Indicates that this cmdlet includes Host Agent and Network Controller Traces.
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 1 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-NetworkController
Specifies the name or IP address of a Network Controller node.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-OutputDirectory
Specifies the full path of a folder for the results.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 2 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-RestURI
Specifies the URI to use for Network Controller REST APIs. Specify this parameter for wildcard certificate deployment.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 4 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-SetupDiagnostics
Indicates that logging is to be enabled. If you do not specify this parameter, logs are to be collected, but logging is not enabled.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.