Skip to content

Commit cab2d45

Browse files
Merge pull request #38 from AnirbanPaul/patch-28
Update invoke-networkcontrollerstate.md
2 parents b2a57e5 + e476b79 commit cab2d45

File tree

1 file changed

+23
-1
lines changed

1 file changed

+23
-1
lines changed

docset/windows/network-controller/invoke-networkcontrollerstate.md

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ ms.assetid: 18D068F1-0DFC-42AE-9EB8-78237ED5AA7F
2020
# Invoke-NetworkControllerState
2121

2222
## SYNOPSIS
23+
This cmdlet dumps the current configuration and state of Network Controller services on the local Network Controller nodes
2324

2425
## SYNTAX
2526

@@ -31,13 +32,20 @@ Invoke-NetworkControllerState [[-Tags] <PSObject>] [-Properties] <NetworkControl
3132
```
3233

3334
## DESCRIPTION
35+
This cmdlet dumps the current configuration and state of Network Controller services on the local Network Controller nodes. This is useful for diagnostic purposes. The state is stored locally in the Network Controller nodes at %windir%/tracing/SDNDiagnostics/NetworkControllerState folder.
3436

3537
## EXAMPLES
36-
38+
This example dumps the state of Network Controller services on the local Network Controller nodes.
39+
```
40+
$state=New-Object Microsoft.Windows.NetworkController.NetworkControllerStateProperties
41+
Invoke-NetworkControllerState -ConnectionUri https://networkcontroller -Properties $state
42+
```
3743

3844
## PARAMETERS
3945

4046
### -CertificateThumbprint
47+
Specifies the digital public key X.509 certificate of a user account that has permission to perform this action.This is the certificate thumbprint of the certificate.This thumbprint must also be provided in the *ClientCertificateThumbprint* parameter in the **Install-NetworkController** or **Set-NetworkController** cmdlet so that Network Controller can authorize this user.
48+
4149
```yaml
4250
Type: String
4351
Parameter Sets: (All)
@@ -66,6 +74,8 @@ Accept wildcard characters: False
6674
```
6775
6876
### -ConnectionUri
77+
Specifies the Uniform Resource Identifier (URI) of the Network Controller, used by all Representational State Transfer (REST) clients to connect to Network Controller.
78+
6979
```yaml
7080
Type: Uri
7181
Parameter Sets: (All)
@@ -79,6 +89,8 @@ Accept wildcard characters: False
7989
```
8090
8191
### -Credential
92+
Specifies a user credential that has permission to perform this action.The default value is the current user.This user must be present in the security group provided in the *ClientSecurityGroup* parameter in the **Install-NetworkController** cmdlet.
93+
8294
```yaml
8395
Type: PSCredential
8496
Parameter Sets: (All)
@@ -92,6 +104,8 @@ Accept wildcard characters: False
92104
```
93105
94106
### -Etag
107+
Specifies the entity tag (ETag) of the resource.An ETag is an HTTP response header returned by an HTTP-compliant web server.An ETag is used to determine change in the content of a resource at a given URL.The value of the header is an opaque string representing the state of the resource at the time the response was generated.
108+
95109
```yaml
96110
Type: String
97111
Parameter Sets: (All)
@@ -105,6 +119,8 @@ Accept wildcard characters: False
105119
```
106120
107121
### -Force
122+
Forces the command to run without asking for user confirmation.
123+
108124
```yaml
109125
Type: SwitchParameter
110126
Parameter Sets: (All)
@@ -131,6 +147,8 @@ Accept wildcard characters: False
131147
```
132148
133149
### -Properties
150+
Specifies the properties of the resource. For this resource, no specific properties have to be assigned
151+
134152
```yaml
135153
Type: NetworkControllerStateProperties
136154
Parameter Sets: (All)
@@ -144,6 +162,8 @@ Accept wildcard characters: False
144162
```
145163
146164
### -ResourceId
165+
Specifies the unique identifier of the resource
166+
147167
```yaml
148168
Type: String
149169
Parameter Sets: (All)
@@ -157,6 +177,8 @@ Accept wildcard characters: False
157177
```
158178
159179
### -ResourceMetadata
180+
Specifies metadata information for the client, such as the tenant ID, group ID, and resource name.
181+
160182
```yaml
161183
Type: ResourceMetadata
162184
Parameter Sets: (All)

0 commit comments

Comments
 (0)