Skip to content

Commit

Permalink
removed unnecessary files and revised necessary markdown files
Browse files Browse the repository at this point in the history
  • Loading branch information
sliutwotwo authored and sdwheeler committed Jun 26, 2024
1 parent 98b4b4b commit f100c7c
Show file tree
Hide file tree
Showing 9 changed files with 193 additions and 1,155 deletions.
Original file line number Diff line number Diff line change
@@ -1,39 +1,47 @@
---
external help file: Microsoft.NetworkController.Powershell.dll-help.xml
Module Name: NetworkController
online version:
online version: https://learn.microsoft.com/powershell/module/networkcontroller/get-networkcontrollermultisiteconfiguration?view=windowsserver2025-ps
schema: 2.0.0
---

# Get-NetworkControllerMultisiteConfiguration

## SYNOPSIS

Gets Multisite peering configuration parameters

## SYNTAX

```
Get-NetworkControllerMultisiteConfiguration [-ConnectionUri <Uri>] [-CertificateThumbprint <String>]
[-Credential <PSCredential>] [-PassInnerException] [<CommonParameters>]
Get-NetworkControllerMultisiteConfiguration [-ConnectionUri <Uri>]
[-CertificateThumbprint <String>] [-Credential <PSCredential>] [-PassInnerException]
[<CommonParameters>]
```

## DESCRIPTION
The Get-NetworkControllerMultisiteConfiguration cmdlet gets current Multisite settings. Use this cmdlet to obtain site details, site names and encryption details.
This cmdlet can also be used as a sanity check for the state of a deployment, whether it is in an initiated state, failed state, successful state, etc.

The `Get-NetworkControllerMultisiteConfiguration` cmdlet gets current Multisite settings. Use this
cmdlet to obtain site details, site names and encryption details. This cmdlet can also be used as a
sanity check for the state of a deployment.

## EXAMPLES

### Example 1: Check Peering State

```powershell
PS C:\> Get-NetworkControllerMultisiteConfiguration -ConnectionUri "https://site1.com" | ConvertTo-JSON -depth 100
Get-NetworkControllerMultisiteConfiguration -ConnectionUri 'https://site1.com' | ConvertTo-JSON
-depth 100
```


## PARAMETERS

### -CertificateThumbprint
Specifies the digital public key X.509 certificate of a user account that has permission to perform this action.
Specify this parameter only if you run this cmdlet on a computer that is not part of the network controller cluster.

Specifies the digital public key X.509 certificate of a user account that has permission to perform
this action. Specify this parameter only if you run this cmdlet on a computer that is not part of
the network controller cluster.

```yaml
Type: System.String
Expand All @@ -48,6 +56,7 @@ Accept wildcard characters: False
```
### -ConnectionUri
Specifies the Uniform Resource Identifier (URI) of a Network Controller.
```yaml
Expand All @@ -63,8 +72,10 @@ Accept wildcard characters: False
```
### -Credential
Specifies a user credential that has permission to perform this action. The default is the current user.
Specify this parameter only if you run this cmdlet on a computer that is not part of the network controller cluster.
Specifies a user credential that has permission to perform this action. The
default is the current user. Specify this parameter only if you run this cmdlet
on a computer that is not part of the network controller cluster.
```yaml
Type: System.Management.Automation.PSCredential
Expand All @@ -79,9 +90,13 @@ Accept wildcard characters: False
```
### -PassInnerException
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.
The thumbprint must be provided only if the network controller client authentication is X509 certificates.
Get-NetworkController retrieves that client authentication and authorization information.
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. The thumbprint must be provided
only if the network controller client authentication is X509 certificates.
`Get-NetworkController` retrieves that client authentication and authorization
information.

```yaml
Type: System.Management.Automation.SwitchParameter
Expand All @@ -96,7 +111,12 @@ Accept wildcard characters: False
```

### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).

This cmdlet supports the common parameters: -Debug, -ErrorAction,
-ErrorVariable, -InformationAction, -InformationVariable, -OutVariable,
-OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.
For more information, see
[about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).

## INPUTS

Expand All @@ -106,7 +126,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

### System.Object

### System.Object#https://localhost/
### System.Object

## NOTES

Expand Down

This file was deleted.

This file was deleted.

Loading

0 comments on commit f100c7c

Please sign in to comment.