Made changes to the Multisite commandlets

MicrosoftDocs · May 14, 2024 · faf6a8e · faf6a8e
1 parent de61ebb
commit faf6a8e
Show file tree

Hide file tree

Showing 10 changed files with 1,835 additions and 0 deletions.
diff --git a/docset/winserver2025-ps/networkcontroller/Get-NetworkControllerLearnedIpAddress.md b/docset/winserver2025-ps/networkcontroller/Get-NetworkControllerLearnedIpAddress.md
@@ -0,0 +1,124 @@
+---
+external help file: Microsoft.NetworkController.Powershell.dll-help.xml
+Module Name: NetworkController
+online version:
+schema: 2.0.0
+---
+
+# Get-NetworkControllerLearnedIpAddress
+
+## SYNOPSIS
+{{ Fill in the Synopsis }}
+
+## SYNTAX
+
+```
+Get-NetworkControllerLearnedIpAddress [[-ResourceId] <String[]>] -ConnectionUri <Uri>
+ [-CertificateThumbprint <String>] [-Credential <PSCredential>] [-PassInnerException] [<CommonParameters>]
+```
+
+## DESCRIPTION
+{{ Fill in the Description }}
+
+## EXAMPLES
+
+### Example 1
+```powershell
+PS C:\> {{ Add example code here }}
+```
+
+{{ Add example description here }}
+
+## PARAMETERS
+
+### -CertificateThumbprint
+{{ Fill CertificateThumbprint Description }}
+
+```yaml
+Type: System.String
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -ConnectionUri
+{{ Fill ConnectionUri Description }}
+
+```yaml
+Type: System.Uri
+Parameter Sets: (All)
+Aliases:
+
+Required: True
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -Credential
+{{ Fill Credential Description }}
+
+```yaml
+Type: System.Management.Automation.PSCredential
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -PassInnerException
+{{ Fill PassInnerException Description }}
+
+```yaml
+Type: System.Management.Automation.SwitchParameter
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -ResourceId
+{{ Fill ResourceId Description }}
+
+```yaml
+Type: System.String[]
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: 1
+Default value: None
+Accept pipeline input: False
+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).
+
+## INPUTS
+
+### None
+
+## OUTPUTS
+
+### System.Object
+
+### System.Object#https://localhost/
+
+## NOTES
+
+## RELATED LINKS
diff --git a/...nserver2025-ps/networkcontroller/Get-NetworkControllerMultisiteConfiguration.md b/...nserver2025-ps/networkcontroller/Get-NetworkControllerMultisiteConfiguration.md
@@ -0,0 +1,117 @@
+---
+external help file: Microsoft.NetworkController.Powershell.dll-help.xml
+Module Name: NetworkController
+online version:
+schema: 2.0.0
+---
+
+# Get-NetworkControllerMultisiteConfiguration
+
+## SYNOPSIS
+Gets Multisite peering configuration parameters
+
+## SYNTAX
+
+```
+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.
+
+## EXAMPLES
+
+### Example 1: Check Peering State
+```powershell
+PS C:\> 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.
+
+```yaml
+Type: System.String
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -ConnectionUri
+Specifies the Uniform Resource Identifier (URI) of a Network Controller. 
+
+```yaml
+Type: System.Uri
+Parameter Sets: (All)
+Aliases:
+
+Required: True
+Position: Named
+Default value: None
+Accept pipeline input: False
+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.
+
+```yaml
+Type: System.Management.Automation.PSCredential
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+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.
+
+```yaml
+Type: System.Management.Automation.SwitchParameter
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+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).
+
+## INPUTS
+
+### None
+
+## OUTPUTS
+
+### System.Object
+
+### System.Object#https://localhost/
+
+## NOTES
+
+## RELATED LINKS
+
+[Set-NetworkControllerMultisitePrimary](./Set-NetworkControllerMultisitePrimary.md)
+
+[Set-NetworkControllerMultisiteConfiguration](./Set-NetworkControllerMultisiteConfiguration.md)
diff --git a/docset/winserver2025-ps/networkcontroller/Get-NetworkControllerMultisitePrimary.md b/docset/winserver2025-ps/networkcontroller/Get-NetworkControllerMultisitePrimary.md
@@ -0,0 +1,109 @@
+---
+external help file: Microsoft.NetworkController.Powershell.dll-help.xml
+Module Name: NetworkController
+online version:
+schema: 2.0.0
+---
+
+# Get-NetworkControllerMultisitePrimary
+
+## SYNOPSIS
+{{ Fill in the Synopsis }}
+
+## SYNTAX
+
+```
+Get-NetworkControllerMultisitePrimary [-ConnectionUri <Uri>] [-CertificateThumbprint <String>]
+ [-Credential <PSCredential>] [-PassInnerException] [<CommonParameters>]
+```
+
+## DESCRIPTION
+{{ Fill in the Description }}
+
+## EXAMPLES
+
+### Example 1
+```powershell
+PS C:\> {{ Add example code here }}
+```
+
+{{ Add example description here }}
+
+## PARAMETERS
+
+### -CertificateThumbprint
+{{ Fill CertificateThumbprint Description }}
+
+```yaml
+Type: System.String
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -ConnectionUri
+{{ Fill ConnectionUri Description }}
+
+```yaml
+Type: System.Uri
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -Credential
+{{ Fill Credential Description }}
+
+```yaml
+Type: System.Management.Automation.PSCredential
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -PassInnerException
+{{ Fill PassInnerException Description }}
+
+```yaml
+Type: System.Management.Automation.SwitchParameter
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+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).
+
+## INPUTS
+
+### None
+
+## OUTPUTS
+
+### System.Object
+
+### System.Object#https://localhost/
+
+## NOTES
+
+## RELATED LINKS