Skip to content

Commit fef3ded

Browse files
Merge pull request #31 from AnirbanPaul/patch-23
Update get-networkcontrollerstate.md
2 parents 5aaccb1 + abdde9a commit fef3ded

File tree

1 file changed

+14
-1
lines changed

1 file changed

+14
-1
lines changed

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

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ ms.assetid: 09F402C6-4773-47F7-B7BB-A85A1D42A26A
2020
# Get-NetworkControllerState
2121

2222
## SYNOPSIS
23+
This cmdlet retrieves the provisioning state of NetworkControllerState resource.
2324

2425
## SYNTAX
2526

@@ -29,13 +30,20 @@ Get-NetworkControllerState [-ConnectionUri <Uri>] [-CertificateThumbprint <Strin
2930
```
3031

3132
## DESCRIPTION
33+
This cmdlet retrieves the provisioning state of NetworkControllerState resource. To get the current configuration and state of the Network Controller services, you need to execute Invoke-NetworkControllerState. After executing Invoke-NetworkControllerState, you can use Get-NetworkControllerState to get the provisioning state of the resource (whether the configuration and state of the Network Controller services were successfully dumped on the Network Controller nodes)
3234

3335
## EXAMPLES
34-
36+
This example shows that the provisioning state of NetworkControllerState resource is succeeded. The state of all the Network Controller services has been dumped on the Network Controller nodes.
37+
```
38+
$state=Get-NetworkControllerState -ConnectionUri https://networkcontroller
39+
$state.Properties
40+
```
3541

3642
## PARAMETERS
3743

3844
### -CertificateThumbprint
45+
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.
46+
3947
```yaml
4048
Type: String
4149
Parameter Sets: (All)
@@ -49,6 +57,8 @@ Accept wildcard characters: False
4957
```
5058
5159
### -ConnectionUri
60+
Specifies the Uniform Resource Identifier (URI) of the Network Controller, used by all Representational State Transfer (REST) clients to connect to Network Controller.
61+
5262
```yaml
5363
Type: Uri
5464
Parameter Sets: (All)
@@ -62,6 +72,8 @@ Accept wildcard characters: False
6272
```
6373
6474
### -Credential
75+
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.
76+
6577
```yaml
6678
Type: PSCredential
6779
Parameter Sets: (All)
@@ -93,6 +105,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
93105
## INPUTS
94106
95107
## OUTPUTS
108+
Provisioning state of the resource
96109
97110
## NOTES
98111

0 commit comments

Comments
 (0)