From af2fed4f800530348c9a837a2efdd2ce6592f787 Mon Sep 17 00:00:00 2001 From: Wolfpack Date: Tue, 14 May 2024 14:17:47 -0700 Subject: [PATCH 1/5] Made changes to the Multisite commandlets --- .../Get-NetworkControllerLearnedIpAddress.md | 124 ++++++++ ...NetworkControllerMultisiteConfiguration.md | 117 +++++++ .../Get-NetworkControllerMultisitePrimary.md | 109 +++++++ .../Get-NetworkControllerSecurityTag.md | 124 ++++++++ .../New-NetworkControllerLearnedIpAddress.md | 231 ++++++++++++++ .../New-NetworkControllerSecurityTag.md | 231 ++++++++++++++ ...emove-NetworkControllerLearnedIpAddress.md | 183 +++++++++++ .../Remove-NetworkControllerSecurityTag.md | 183 +++++++++++ ...NetworkControllerMultisiteConfiguration.md | 292 ++++++++++++++++++ .../Set-NetworkControllerMultisitePrimary.md | 241 +++++++++++++++ 10 files changed, 1835 insertions(+) create mode 100644 docset/winserver2025-ps/networkcontroller/Get-NetworkControllerLearnedIpAddress.md create mode 100644 docset/winserver2025-ps/networkcontroller/Get-NetworkControllerMultisiteConfiguration.md create mode 100644 docset/winserver2025-ps/networkcontroller/Get-NetworkControllerMultisitePrimary.md create mode 100644 docset/winserver2025-ps/networkcontroller/Get-NetworkControllerSecurityTag.md create mode 100644 docset/winserver2025-ps/networkcontroller/New-NetworkControllerLearnedIpAddress.md create mode 100644 docset/winserver2025-ps/networkcontroller/New-NetworkControllerSecurityTag.md create mode 100644 docset/winserver2025-ps/networkcontroller/Remove-NetworkControllerLearnedIpAddress.md create mode 100644 docset/winserver2025-ps/networkcontroller/Remove-NetworkControllerSecurityTag.md create mode 100644 docset/winserver2025-ps/networkcontroller/Set-NetworkControllerMultisiteConfiguration.md create mode 100644 docset/winserver2025-ps/networkcontroller/Set-NetworkControllerMultisitePrimary.md diff --git a/docset/winserver2025-ps/networkcontroller/Get-NetworkControllerLearnedIpAddress.md b/docset/winserver2025-ps/networkcontroller/Get-NetworkControllerLearnedIpAddress.md new file mode 100644 index 0000000000..a05e54b81f --- /dev/null +++ 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] ] -ConnectionUri + [-CertificateThumbprint ] [-Credential ] [-PassInnerException] [] +``` + +## 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/docset/winserver2025-ps/networkcontroller/Get-NetworkControllerMultisiteConfiguration.md b/docset/winserver2025-ps/networkcontroller/Get-NetworkControllerMultisiteConfiguration.md new file mode 100644 index 0000000000..113618ebe1 --- /dev/null +++ b/docset/winserver2025-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 ] [-CertificateThumbprint ] + [-Credential ] [-PassInnerException] [] +``` + +## 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 new file mode 100644 index 0000000000..48a6d48c12 --- /dev/null +++ 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 ] [-CertificateThumbprint ] + [-Credential ] [-PassInnerException] [] +``` + +## 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 diff --git a/docset/winserver2025-ps/networkcontroller/Get-NetworkControllerSecurityTag.md b/docset/winserver2025-ps/networkcontroller/Get-NetworkControllerSecurityTag.md new file mode 100644 index 0000000000..c78b02d546 --- /dev/null +++ b/docset/winserver2025-ps/networkcontroller/Get-NetworkControllerSecurityTag.md @@ -0,0 +1,124 @@ +--- +external help file: Microsoft.NetworkController.Powershell.dll-help.xml +Module Name: NetworkController +online version: +schema: 2.0.0 +--- + +# Get-NetworkControllerSecurityTag + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Get-NetworkControllerSecurityTag [[-ResourceId] ] -ConnectionUri + [-CertificateThumbprint ] [-Credential ] [-PassInnerException] [] +``` + +## 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/docset/winserver2025-ps/networkcontroller/New-NetworkControllerLearnedIpAddress.md b/docset/winserver2025-ps/networkcontroller/New-NetworkControllerLearnedIpAddress.md new file mode 100644 index 0000000000..4e8d233f07 --- /dev/null +++ b/docset/winserver2025-ps/networkcontroller/New-NetworkControllerLearnedIpAddress.md @@ -0,0 +1,231 @@ +--- +external help file: Microsoft.NetworkController.Powershell.dll-help.xml +Module Name: NetworkController +online version: +schema: 2.0.0 +--- + +# New-NetworkControllerLearnedIpAddress + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +New-NetworkControllerLearnedIpAddress [-ResourceId] [[-Tags] ] + [-Properties] [[-Etag] ] [[-ResourceMetadata] ] + [-Force] -ConnectionUri [-CertificateThumbprint ] [-Credential ] + [-PassInnerException] [-WhatIf] [-Confirm] [] +``` + +## 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 +``` + +### -Etag +{{ Fill Etag Description }} + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 6 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +{{ Fill Force Description }} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: 8 +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 +``` + +### -Properties +{{ Fill Properties Description }} + +```yaml +Type: Microsoft.Windows.NetworkController.LearnedIpAddressProperties +Parameter Sets: (All) +Aliases: + +Required: True +Position: 4 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +{{ Fill ResourceId Description }} + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceMetadata +{{ Fill ResourceMetadata Description }} + +```yaml +Type: Microsoft.Windows.NetworkController.ResourceMetadata +Parameter Sets: (All) +Aliases: + +Required: False +Position: 7 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tags +{{ Fill Tags Description }} + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +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 + +### System.String + +### Microsoft.Windows.NetworkController.LearnedIpAddressProperties + +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS diff --git a/docset/winserver2025-ps/networkcontroller/New-NetworkControllerSecurityTag.md b/docset/winserver2025-ps/networkcontroller/New-NetworkControllerSecurityTag.md new file mode 100644 index 0000000000..c3f4f7c7dd --- /dev/null +++ b/docset/winserver2025-ps/networkcontroller/New-NetworkControllerSecurityTag.md @@ -0,0 +1,231 @@ +--- +external help file: Microsoft.NetworkController.Powershell.dll-help.xml +Module Name: NetworkController +online version: +schema: 2.0.0 +--- + +# New-NetworkControllerSecurityTag + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +New-NetworkControllerSecurityTag [-ResourceId] [[-Tags] ] + [-Properties] [[-Etag] ] [[-ResourceMetadata] ] [-Force] + -ConnectionUri [-CertificateThumbprint ] [-Credential ] [-PassInnerException] + [-WhatIf] [-Confirm] [] +``` + +## 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 +``` + +### -Etag +{{ Fill Etag Description }} + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 6 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +{{ Fill Force Description }} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: 8 +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 +``` + +### -Properties +{{ Fill Properties Description }} + +```yaml +Type: Microsoft.Windows.NetworkController.SecurityTagProperties +Parameter Sets: (All) +Aliases: + +Required: True +Position: 4 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +{{ Fill ResourceId Description }} + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceMetadata +{{ Fill ResourceMetadata Description }} + +```yaml +Type: Microsoft.Windows.NetworkController.ResourceMetadata +Parameter Sets: (All) +Aliases: + +Required: False +Position: 7 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tags +{{ Fill Tags Description }} + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +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 + +### System.String + +### Microsoft.Windows.NetworkController.SecurityTagProperties + +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS diff --git a/docset/winserver2025-ps/networkcontroller/Remove-NetworkControllerLearnedIpAddress.md b/docset/winserver2025-ps/networkcontroller/Remove-NetworkControllerLearnedIpAddress.md new file mode 100644 index 0000000000..6a70be6d3b --- /dev/null +++ b/docset/winserver2025-ps/networkcontroller/Remove-NetworkControllerLearnedIpAddress.md @@ -0,0 +1,183 @@ +--- +external help file: Microsoft.NetworkController.Powershell.dll-help.xml +Module Name: NetworkController +online version: +schema: 2.0.0 +--- + +# Remove-NetworkControllerLearnedIpAddress + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Remove-NetworkControllerLearnedIpAddress [-ResourceId] [[-Etag] ] [-Force] + -ConnectionUri [-CertificateThumbprint ] [-Credential ] [-PassInnerException] + [-WhatIf] [-Confirm] [] +``` + +## 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 +``` + +### -Etag +{{ Fill Etag Description }} + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +{{ Fill Force Description }} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +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: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +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 + +### System.String + +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS diff --git a/docset/winserver2025-ps/networkcontroller/Remove-NetworkControllerSecurityTag.md b/docset/winserver2025-ps/networkcontroller/Remove-NetworkControllerSecurityTag.md new file mode 100644 index 0000000000..e5bff2aed7 --- /dev/null +++ b/docset/winserver2025-ps/networkcontroller/Remove-NetworkControllerSecurityTag.md @@ -0,0 +1,183 @@ +--- +external help file: Microsoft.NetworkController.Powershell.dll-help.xml +Module Name: NetworkController +online version: +schema: 2.0.0 +--- + +# Remove-NetworkControllerSecurityTag + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Remove-NetworkControllerSecurityTag [-ResourceId] [[-Etag] ] [-Force] -ConnectionUri + [-CertificateThumbprint ] [-Credential ] [-PassInnerException] [-WhatIf] [-Confirm] + [] +``` + +## 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 +``` + +### -Etag +{{ Fill Etag Description }} + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +{{ Fill Force Description }} + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +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: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +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 + +### System.String + +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS diff --git a/docset/winserver2025-ps/networkcontroller/Set-NetworkControllerMultisiteConfiguration.md b/docset/winserver2025-ps/networkcontroller/Set-NetworkControllerMultisiteConfiguration.md new file mode 100644 index 0000000000..a35a9ef7f8 --- /dev/null +++ b/docset/winserver2025-ps/networkcontroller/Set-NetworkControllerMultisiteConfiguration.md @@ -0,0 +1,292 @@ +--- +external help file: Microsoft.NetworkController.Powershell.dll-help.xml +Module Name: NetworkController +online version: +schema: 2.0.0 +--- + +# Set-NetworkControllerMultisiteConfiguration + +## SYNOPSIS +Initiates site peering between NC infrastructures across two different locations. + +## SYNTAX + +``` +Set-NetworkControllerMultisiteConfiguration [[-Tags] ] + [-Properties] [[-Etag] ] + [[-ResourceMetadata] ] [[-ResourceId] ] [-Force] -ConnectionUri + [-CertificateThumbprint ] [-Credential ] [-PassInnerException] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +The Set-NetworkControllerMultisiteConfiguration cmdlet initiates a Multisite peering connection between two NC infrastructures. For instance, if you have site A with NC infrastructure A and site B with NC infrastructure B, then you can initiate a peer between NC infrastructure A and NC infrastructure B. This cmdlet can not only initiate peering but can also remove peering and change the status of a NC infrastructure to primary. +Additionally, this cmdlet can also be used to edit site properties once configured. + +## EXAMPLES + +### Example 1: Initiate Peering with Self-Signed Certificates +```powershell +PS C:\> $cert1 = Get-ChildItem “Cert:\LocalMachine\My” | where {$_.Subject -like ‘sdnsite1.contoso.com’} +$base64cert1 = [System.Convert]::ToBase64String($cert1.RawData) +$cert2 = Get-ChildItem “Cert:\LocalMachine\My” | where {$_.Subject -like ‘sdnsite2.contoso.com’} +$base64cert2 = [System.Convert]::ToBase64String($cert2.RawData) + +$prop = new-object Microsoft.Windows.NetworkController.NetworkControllerMultisiteProperties +$prop.certificateSubjectName = "sdnsite1.contoso.com" +$prop.Sites = new-object Microsoft.Windows.NetworkController.NetworkControllerSite +$prop.Sites[0].ResourceId = "site2" +$prop.Sites[0].Properties = new-object Microsoft.Windows.NetworkController.NetworkControllerSiteProperties +$prop.Sites[0].Properties.RestIPAddress = "sdnsite2.contoso.com" +$prop.Sites[0].Properties.CertificateSubjectName = "sdnsite2.contoso.com" +$prop.Sites[0].Properties.EncodedCertificate = $base64cert2 + +Set-NetworkControllerMultisiteConfiguration -ConnectionUri "https://sdnsite1.contoso.com" -Properties $prop -Force + +$prop = new-object Microsoft.Windows.NetworkController.NetworkControllerMultisiteProperties +$prop.certificateSubjectName = "sdnsite2.contoso.com" +$prop.Sites = new-object Microsoft.Windows.NetworkController.NetworkControllerSite +$prop.Sites[0].ResourceId = "site1" +$prop.Sites[0].Properties = new-object Microsoft.Windows.NetworkController.NetworkControllerSiteProperties +$prop.Sites[0].Properties.RestIPAddress = "sdnsite1.contoso.com" +$prop.Sites[0].Properties.CertificateSubjectName = "sdnsite1.contoso.com" +$prop.Sites[0].Properties.EncodedCertificate = $base64cert1 + +Set-NetworkControllerMultisiteConfiguration -ConnectionUri "https://sdnsite2.contoso.com" -Properties $prop -Force +``` + +### Example 2: Removing Peering after Multisite has been set-up +```powershell +PS C:\> $prop = new-object Microsoft.Windows.NetworkController.NetworkControllerMultisiteProperties + +Set-NetworkControllerMultisiteConfiguration -ConnectionUri "https://site1.com" -Properties $prop -Force + +Set-NetworkControllerMultisiteConfiguration -ConnectionUri "https://site2.com" -Properties $prop -Force +``` + +### Example 3: Removing a site where site property is an empty array or has a null value +```powershell +PS C:\> $multisiteProp = new-object Microsoft.Windows.NetworkController.NetworkControllerMultisiteProperties + +Set-NetworkControllerMultisiteConfiguration -ConnectionUri $site2Url -Properties $multisiteProp -Force + +Set-NetworkControllerMultisiteConfiguration -ConnectionUri $site1Url -Properties $multisiteProp -Force +``` + +## 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 +``` + +### -Etag +{{ Fill Etag Description }} + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 5 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: 8 +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 +``` + +### -Properties +Specifies a site configuration for Multisite Peering. Site configuration comes as a NetworkControllerMultisiteProperties object. This object can be defined as new-object Microsoft.Windows.NetworkController.NetworkControllerMultisiteProperties. Here are the following properties that can be changed: +- CertificateSubjectName +- [[Sites] ] + - ResourceID/RESTIPAddress + - IsPrimary + - State + - DeploymentID + - APIVersion + - ConfigurationState + - [[Properties] ] + - RestIPAddress + - CertificateSubjectName + - EncodedCertificate + +```yaml +Type: Microsoft.Windows.NetworkController.NetworkControllerMultisiteProperties +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +{{ Fill ResourceId Description }} + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 7 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceMetadata +{{ Fill ResourceMetadata Description }} + +```yaml +Type: Microsoft.Windows.NetworkController.ResourceMetadata +Parameter Sets: (All) +Aliases: + +Required: False +Position: 6 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tags +{{ Fill Tags Description }} + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +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 + +### Microsoft.Windows.NetworkController.NetworkControllerMultisiteProperties + +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS + +[Get-NetworkControllerMultisiteConfiguration](./Get-NetworkControllerMultisiteConfiguration.md) + +[Set-NetworkControllerMultisitePrimary](./Set-NetworkControllerMultisitePrimary.md) diff --git a/docset/winserver2025-ps/networkcontroller/Set-NetworkControllerMultisitePrimary.md b/docset/winserver2025-ps/networkcontroller/Set-NetworkControllerMultisitePrimary.md new file mode 100644 index 0000000000..6c94704749 --- /dev/null +++ b/docset/winserver2025-ps/networkcontroller/Set-NetworkControllerMultisitePrimary.md @@ -0,0 +1,241 @@ +--- +external help file: Microsoft.NetworkController.Powershell.dll-help.xml +Module Name: NetworkController +online version: +schema: 2.0.0 +--- + +# Set-NetworkControllerMultisitePrimary + +## SYNOPSIS +Sets the primary site of a NetworkController Site. + +## SYNTAX + +``` +Set-NetworkControllerMultisitePrimary [[-Tags] ] + [-Properties] [[-Etag] ] + [[-ResourceMetadata] ] [[-ResourceId] ] [-Force] -ConnectionUri + [-CertificateThumbprint ] [-Credential ] [-PassInnerException] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +The Set-NetworkControllerMultisitePrimary cmdlet is used to change the primary site of a location in a Multisite configuration. +This can be done in the off-chance that your original Primary site has gone offline and policies still need to be pushed and applied. +Note, any policies that were being configured at the moment when the original primary site crashes will be lost and must be redone. + +## EXAMPLES + +### Example 1: Set new Primary site +```powershell +PS C:\> $prop = new-object Microsoft.Windows.NetworkController.NetworkControllerMultisitePrimaryProperties +PS C:\> Set-NetworkControllerMultisitePrimary -ConnectionUri "https://site1.com" -Properties $prop -Force +``` + + +## 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 +``` + +### -Etag +{{ Fill Etag Description }} + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 5 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Forces the command to run without asking for user confirmation + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: 8 +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 +``` + +### -Properties +Specifies the primary site of a location. + +```yaml +Type: Microsoft.Windows.NetworkController.NetworkControllerMultisitePrimaryProperties +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +{{ Fill ResourceId Description }} + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 7 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceMetadata +{{ Fill ResourceMetadata Description }} + +```yaml +Type: Microsoft.Windows.NetworkController.ResourceMetadata +Parameter Sets: (All) +Aliases: + +Required: False +Position: 6 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tags +{{ Fill Tags Description }} + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +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 + +### Microsoft.Windows.NetworkController.NetworkControllerMultisitePrimaryProperties + +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS + +[Set-NetworkControllerMultisiteConfiguration](./Set-NetworkControllerMultisiteConfiguration.md) + +[Get-NetworkControllerMultisiteConfiguration](./Get-NetworkControllerMultisiteConfiguration.md) + From a4512f696c86eb73cf72dc6a26e5f2f2726899c7 Mon Sep 17 00:00:00 2001 From: Wolfpack Date: Tue, 28 May 2024 15:10:53 -0700 Subject: [PATCH 2/5] Remove unnecessary files - test --- .../Get-NetworkControllerLearnedIpAddress.md | 124 ------------------ 1 file changed, 124 deletions(-) delete mode 100644 docset/winserver2025-ps/networkcontroller/Get-NetworkControllerLearnedIpAddress.md diff --git a/docset/winserver2025-ps/networkcontroller/Get-NetworkControllerLearnedIpAddress.md b/docset/winserver2025-ps/networkcontroller/Get-NetworkControllerLearnedIpAddress.md deleted file mode 100644 index a05e54b81f..0000000000 --- a/docset/winserver2025-ps/networkcontroller/Get-NetworkControllerLearnedIpAddress.md +++ /dev/null @@ -1,124 +0,0 @@ ---- -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] ] -ConnectionUri - [-CertificateThumbprint ] [-Credential ] [-PassInnerException] [] -``` - -## 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 From 98b4b4b6f96ba7d4b096b113e50d706975fdb6aa Mon Sep 17 00:00:00 2001 From: sliutwotwo <116886554+sliutwotwo@users.noreply.github.com> Date: Wed, 15 May 2024 17:38:27 -0700 Subject: [PATCH 3/5] Update Set-NetworkControllerMultisiteConfiguration.md --- .../Set-NetworkControllerMultisiteConfiguration.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docset/winserver2025-ps/networkcontroller/Set-NetworkControllerMultisiteConfiguration.md b/docset/winserver2025-ps/networkcontroller/Set-NetworkControllerMultisiteConfiguration.md index a35a9ef7f8..2af1739551 100644 --- a/docset/winserver2025-ps/networkcontroller/Set-NetworkControllerMultisiteConfiguration.md +++ b/docset/winserver2025-ps/networkcontroller/Set-NetworkControllerMultisiteConfiguration.md @@ -28,9 +28,9 @@ Additionally, this cmdlet can also be used to edit site properties once configur ### Example 1: Initiate Peering with Self-Signed Certificates ```powershell -PS C:\> $cert1 = Get-ChildItem “Cert:\LocalMachine\My” | where {$_.Subject -like ‘sdnsite1.contoso.com’} +PS C:\> $cert1 = Get-ChildItem “Cert:\LocalMachine\My” | where {$_.Subject -like ‘sdnsite1.contoso.com’} $base64cert1 = [System.Convert]::ToBase64String($cert1.RawData) -$cert2 = Get-ChildItem “Cert:\LocalMachine\My” | where {$_.Subject -like ‘sdnsite2.contoso.com’} +$cert2 = Get-ChildItem “Cert:\LocalMachine\My” | where {$_.Subject -like ‘sdnsite2.contoso.com’} $base64cert2 = [System.Convert]::ToBase64String($cert2.RawData) $prop = new-object Microsoft.Windows.NetworkController.NetworkControllerMultisiteProperties @@ -173,14 +173,14 @@ Accept wildcard characters: False ### -Properties Specifies a site configuration for Multisite Peering. Site configuration comes as a NetworkControllerMultisiteProperties object. This object can be defined as new-object Microsoft.Windows.NetworkController.NetworkControllerMultisiteProperties. Here are the following properties that can be changed: - CertificateSubjectName -- [[Sites] ] +- [[Sites] \] - ResourceID/RESTIPAddress - IsPrimary - State - DeploymentID - APIVersion - ConfigurationState - - [[Properties] ] + - [[Properties] \] - RestIPAddress - CertificateSubjectName - EncodedCertificate From f100c7ce5e4bd7018073c93d48dbb8e0f8e0b7bc Mon Sep 17 00:00:00 2001 From: Sam Date: Tue, 25 Jun 2024 15:38:01 -0700 Subject: [PATCH 4/5] removed unnecessary files and revised necessary markdown files --- ...NetworkControllerMultisiteConfiguration.md | 50 ++-- .../Get-NetworkControllerMultisitePrimary.md | 109 --------- .../Get-NetworkControllerSecurityTag.md | 124 ---------- .../New-NetworkControllerLearnedIpAddress.md | 231 ------------------ .../New-NetworkControllerSecurityTag.md | 231 ------------------ ...emove-NetworkControllerLearnedIpAddress.md | 183 -------------- .../Remove-NetworkControllerSecurityTag.md | 183 -------------- ...NetworkControllerMultisiteConfiguration.md | 155 ++++++++---- .../Set-NetworkControllerMultisitePrimary.md | 82 +++++-- 9 files changed, 193 insertions(+), 1155 deletions(-) delete mode 100644 docset/winserver2025-ps/networkcontroller/Get-NetworkControllerMultisitePrimary.md delete mode 100644 docset/winserver2025-ps/networkcontroller/Get-NetworkControllerSecurityTag.md delete mode 100644 docset/winserver2025-ps/networkcontroller/New-NetworkControllerLearnedIpAddress.md delete mode 100644 docset/winserver2025-ps/networkcontroller/New-NetworkControllerSecurityTag.md delete mode 100644 docset/winserver2025-ps/networkcontroller/Remove-NetworkControllerLearnedIpAddress.md delete mode 100644 docset/winserver2025-ps/networkcontroller/Remove-NetworkControllerSecurityTag.md diff --git a/docset/winserver2025-ps/networkcontroller/Get-NetworkControllerMultisiteConfiguration.md b/docset/winserver2025-ps/networkcontroller/Get-NetworkControllerMultisiteConfiguration.md index 113618ebe1..d94075e81f 100644 --- a/docset/winserver2025-ps/networkcontroller/Get-NetworkControllerMultisiteConfiguration.md +++ b/docset/winserver2025-ps/networkcontroller/Get-NetworkControllerMultisiteConfiguration.md @@ -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 ] [-CertificateThumbprint ] - [-Credential ] [-PassInnerException] [] +Get-NetworkControllerMultisiteConfiguration [-ConnectionUri ] +[-CertificateThumbprint ] [-Credential ] [-PassInnerException] +[] ``` ## 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 @@ -48,6 +56,7 @@ Accept wildcard characters: False ``` ### -ConnectionUri + Specifies the Uniform Resource Identifier (URI) of a Network Controller. ```yaml @@ -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 @@ -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 @@ -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 @@ -106,7 +126,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ### System.Object -### System.Object#https://localhost/ +### System.Object ## NOTES diff --git a/docset/winserver2025-ps/networkcontroller/Get-NetworkControllerMultisitePrimary.md b/docset/winserver2025-ps/networkcontroller/Get-NetworkControllerMultisitePrimary.md deleted file mode 100644 index 48a6d48c12..0000000000 --- a/docset/winserver2025-ps/networkcontroller/Get-NetworkControllerMultisitePrimary.md +++ /dev/null @@ -1,109 +0,0 @@ ---- -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 ] [-CertificateThumbprint ] - [-Credential ] [-PassInnerException] [] -``` - -## 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 diff --git a/docset/winserver2025-ps/networkcontroller/Get-NetworkControllerSecurityTag.md b/docset/winserver2025-ps/networkcontroller/Get-NetworkControllerSecurityTag.md deleted file mode 100644 index c78b02d546..0000000000 --- a/docset/winserver2025-ps/networkcontroller/Get-NetworkControllerSecurityTag.md +++ /dev/null @@ -1,124 +0,0 @@ ---- -external help file: Microsoft.NetworkController.Powershell.dll-help.xml -Module Name: NetworkController -online version: -schema: 2.0.0 ---- - -# Get-NetworkControllerSecurityTag - -## SYNOPSIS -{{ Fill in the Synopsis }} - -## SYNTAX - -``` -Get-NetworkControllerSecurityTag [[-ResourceId] ] -ConnectionUri - [-CertificateThumbprint ] [-Credential ] [-PassInnerException] [] -``` - -## 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/docset/winserver2025-ps/networkcontroller/New-NetworkControllerLearnedIpAddress.md b/docset/winserver2025-ps/networkcontroller/New-NetworkControllerLearnedIpAddress.md deleted file mode 100644 index 4e8d233f07..0000000000 --- a/docset/winserver2025-ps/networkcontroller/New-NetworkControllerLearnedIpAddress.md +++ /dev/null @@ -1,231 +0,0 @@ ---- -external help file: Microsoft.NetworkController.Powershell.dll-help.xml -Module Name: NetworkController -online version: -schema: 2.0.0 ---- - -# New-NetworkControllerLearnedIpAddress - -## SYNOPSIS -{{ Fill in the Synopsis }} - -## SYNTAX - -``` -New-NetworkControllerLearnedIpAddress [-ResourceId] [[-Tags] ] - [-Properties] [[-Etag] ] [[-ResourceMetadata] ] - [-Force] -ConnectionUri [-CertificateThumbprint ] [-Credential ] - [-PassInnerException] [-WhatIf] [-Confirm] [] -``` - -## 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 -``` - -### -Etag -{{ Fill Etag Description }} - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 6 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -{{ Fill Force Description }} - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: 8 -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 -``` - -### -Properties -{{ Fill Properties Description }} - -```yaml -Type: Microsoft.Windows.NetworkController.LearnedIpAddressProperties -Parameter Sets: (All) -Aliases: - -Required: True -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -{{ Fill ResourceId Description }} - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceMetadata -{{ Fill ResourceMetadata Description }} - -```yaml -Type: Microsoft.Windows.NetworkController.ResourceMetadata -Parameter Sets: (All) -Aliases: - -Required: False -Position: 7 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tags -{{ Fill Tags Description }} - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -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 - -### System.String - -### Microsoft.Windows.NetworkController.LearnedIpAddressProperties - -## OUTPUTS - -### System.Object -## NOTES - -## RELATED LINKS diff --git a/docset/winserver2025-ps/networkcontroller/New-NetworkControllerSecurityTag.md b/docset/winserver2025-ps/networkcontroller/New-NetworkControllerSecurityTag.md deleted file mode 100644 index c3f4f7c7dd..0000000000 --- a/docset/winserver2025-ps/networkcontroller/New-NetworkControllerSecurityTag.md +++ /dev/null @@ -1,231 +0,0 @@ ---- -external help file: Microsoft.NetworkController.Powershell.dll-help.xml -Module Name: NetworkController -online version: -schema: 2.0.0 ---- - -# New-NetworkControllerSecurityTag - -## SYNOPSIS -{{ Fill in the Synopsis }} - -## SYNTAX - -``` -New-NetworkControllerSecurityTag [-ResourceId] [[-Tags] ] - [-Properties] [[-Etag] ] [[-ResourceMetadata] ] [-Force] - -ConnectionUri [-CertificateThumbprint ] [-Credential ] [-PassInnerException] - [-WhatIf] [-Confirm] [] -``` - -## 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 -``` - -### -Etag -{{ Fill Etag Description }} - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 6 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -{{ Fill Force Description }} - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: 8 -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 -``` - -### -Properties -{{ Fill Properties Description }} - -```yaml -Type: Microsoft.Windows.NetworkController.SecurityTagProperties -Parameter Sets: (All) -Aliases: - -Required: True -Position: 4 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceId -{{ Fill ResourceId Description }} - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -ResourceMetadata -{{ Fill ResourceMetadata Description }} - -```yaml -Type: Microsoft.Windows.NetworkController.ResourceMetadata -Parameter Sets: (All) -Aliases: - -Required: False -Position: 7 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tags -{{ Fill Tags Description }} - -```yaml -Type: System.Management.Automation.PSObject -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -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 - -### System.String - -### Microsoft.Windows.NetworkController.SecurityTagProperties - -## OUTPUTS - -### System.Object -## NOTES - -## RELATED LINKS diff --git a/docset/winserver2025-ps/networkcontroller/Remove-NetworkControllerLearnedIpAddress.md b/docset/winserver2025-ps/networkcontroller/Remove-NetworkControllerLearnedIpAddress.md deleted file mode 100644 index 6a70be6d3b..0000000000 --- a/docset/winserver2025-ps/networkcontroller/Remove-NetworkControllerLearnedIpAddress.md +++ /dev/null @@ -1,183 +0,0 @@ ---- -external help file: Microsoft.NetworkController.Powershell.dll-help.xml -Module Name: NetworkController -online version: -schema: 2.0.0 ---- - -# Remove-NetworkControllerLearnedIpAddress - -## SYNOPSIS -{{ Fill in the Synopsis }} - -## SYNTAX - -``` -Remove-NetworkControllerLearnedIpAddress [-ResourceId] [[-Etag] ] [-Force] - -ConnectionUri [-CertificateThumbprint ] [-Credential ] [-PassInnerException] - [-WhatIf] [-Confirm] [] -``` - -## 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 -``` - -### -Etag -{{ Fill Etag Description }} - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -{{ Fill Force Description }} - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -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: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -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 - -### System.String - -## OUTPUTS - -### System.Object -## NOTES - -## RELATED LINKS diff --git a/docset/winserver2025-ps/networkcontroller/Remove-NetworkControllerSecurityTag.md b/docset/winserver2025-ps/networkcontroller/Remove-NetworkControllerSecurityTag.md deleted file mode 100644 index e5bff2aed7..0000000000 --- a/docset/winserver2025-ps/networkcontroller/Remove-NetworkControllerSecurityTag.md +++ /dev/null @@ -1,183 +0,0 @@ ---- -external help file: Microsoft.NetworkController.Powershell.dll-help.xml -Module Name: NetworkController -online version: -schema: 2.0.0 ---- - -# Remove-NetworkControllerSecurityTag - -## SYNOPSIS -{{ Fill in the Synopsis }} - -## SYNTAX - -``` -Remove-NetworkControllerSecurityTag [-ResourceId] [[-Etag] ] [-Force] -ConnectionUri - [-CertificateThumbprint ] [-Credential ] [-PassInnerException] [-WhatIf] [-Confirm] - [] -``` - -## 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 -``` - -### -Etag -{{ Fill Etag Description }} - -```yaml -Type: System.String -Parameter Sets: (All) -Aliases: - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -{{ Fill Force Description }} - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: 3 -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: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: cf - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. - -```yaml -Type: System.Management.Automation.SwitchParameter -Parameter Sets: (All) -Aliases: wi - -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 - -### System.String - -## OUTPUTS - -### System.Object -## NOTES - -## RELATED LINKS diff --git a/docset/winserver2025-ps/networkcontroller/Set-NetworkControllerMultisiteConfiguration.md b/docset/winserver2025-ps/networkcontroller/Set-NetworkControllerMultisiteConfiguration.md index 2af1739551..a6561e6b15 100644 --- a/docset/winserver2025-ps/networkcontroller/Set-NetworkControllerMultisiteConfiguration.md +++ b/docset/winserver2025-ps/networkcontroller/Set-NetworkControllerMultisiteConfiguration.md @@ -1,84 +1,121 @@ --- external help file: Microsoft.NetworkController.Powershell.dll-help.xml Module Name: NetworkController -online version: +online version: https://learn.microsoft.com/powershell/module/networkcontroller/set-networkcontrollermultisiteconfiguration?view=windowsserver2025-ps schema: 2.0.0 --- # Set-NetworkControllerMultisiteConfiguration ## SYNOPSIS + Initiates site peering between NC infrastructures across two different locations. ## SYNTAX ``` -Set-NetworkControllerMultisiteConfiguration [[-Tags] ] - [-Properties] [[-Etag] ] - [[-ResourceMetadata] ] [[-ResourceId] ] [-Force] -ConnectionUri - [-CertificateThumbprint ] [-Credential ] [-PassInnerException] [-WhatIf] [-Confirm] - [] +Set-NetworkControllerMultisiteConfiguration [[-Tags] ] [-Properties] + [[-Etag] ] [[-ResourceMetadata] +] [[-ResourceId] ] [-Force] -ConnectionUri +[-CertificateThumbprint ] [-Credential ] [-PassInnerException] [-WhatIf] +[-Confirm] [] ``` ## DESCRIPTION -The Set-NetworkControllerMultisiteConfiguration cmdlet initiates a Multisite peering connection between two NC infrastructures. For instance, if you have site A with NC infrastructure A and site B with NC infrastructure B, then you can initiate a peer between NC infrastructure A and NC infrastructure B. This cmdlet can not only initiate peering but can also remove peering and change the status of a NC infrastructure to primary. -Additionally, this cmdlet can also be used to edit site properties once configured. + +The `Set-NetworkControllerMultisiteConfiguration` cmdlet initiates a Multisite peering connection +between two NC infrastructures. For instance, if you have site A with NC infrastructure A and +site B with NC infrastructure B, then you can initiate a peer between NC infrastructure A and NC +infrastructure B. This cmdlet can not only initiate peering but can also remove peering and +change the status of a NC infrastructure to primary. Additionally, this cmdlet can also be used +to edit site properties once configured. ## EXAMPLES ### Example 1: Initiate Peering with Self-Signed Certificates + ```powershell -PS C:\> $cert1 = Get-ChildItem “Cert:\LocalMachine\My” | where {$_.Subject -like ‘sdnsite1.contoso.com’} +$cert1 = Get-ChildItem 'Cert:\LocalMachine\My' | where {$_.Subject -like ‘sdnsite1.contoso.com’} $base64cert1 = [System.Convert]::ToBase64String($cert1.RawData) $cert2 = Get-ChildItem “Cert:\LocalMachine\My” | where {$_.Subject -like ‘sdnsite2.contoso.com’} $base64cert2 = [System.Convert]::ToBase64String($cert2.RawData) $prop = new-object Microsoft.Windows.NetworkController.NetworkControllerMultisiteProperties -$prop.certificateSubjectName = "sdnsite1.contoso.com" +$prop.certificateSubjectName = 'sdnsite1.contoso.com' $prop.Sites = new-object Microsoft.Windows.NetworkController.NetworkControllerSite -$prop.Sites[0].ResourceId = "site2" -$prop.Sites[0].Properties = new-object Microsoft.Windows.NetworkController.NetworkControllerSiteProperties -$prop.Sites[0].Properties.RestIPAddress = "sdnsite2.contoso.com" -$prop.Sites[0].Properties.CertificateSubjectName = "sdnsite2.contoso.com" +$prop.Sites[0].ResourceId = 'site2' +$prop.Sites[0].Properties = new-object +Microsoft.Windows.NetworkController.NetworkControllerSiteProperties + +$prop.Sites[0].Properties.RestIPAddress = 'sdnsite2.contoso.com' +$prop.Sites[0].Properties.CertificateSubjectName = 'sdnsite2.contoso.com' $prop.Sites[0].Properties.EncodedCertificate = $base64cert2 -Set-NetworkControllerMultisiteConfiguration -ConnectionUri "https://sdnsite1.contoso.com" -Properties $prop -Force +Set-NetworkControllerMultisiteConfiguration -ConnectionUri 'https://sdnsite1.contoso.com' +-Properties $prop -Force $prop = new-object Microsoft.Windows.NetworkController.NetworkControllerMultisiteProperties -$prop.certificateSubjectName = "sdnsite2.contoso.com" +$prop.certificateSubjectName = 'sdnsite2.contoso.com' $prop.Sites = new-object Microsoft.Windows.NetworkController.NetworkControllerSite -$prop.Sites[0].ResourceId = "site1" -$prop.Sites[0].Properties = new-object Microsoft.Windows.NetworkController.NetworkControllerSiteProperties -$prop.Sites[0].Properties.RestIPAddress = "sdnsite1.contoso.com" -$prop.Sites[0].Properties.CertificateSubjectName = "sdnsite1.contoso.com" +$prop.Sites[0].ResourceId = 'site1' +$prop.Sites[0].Properties = new-object +Microsoft.Windows.NetworkController.NetworkControllerSiteProperties + +$prop.Sites[0].Properties.RestIPAddress = 'sdnsite1.contoso.com' +$prop.Sites[0].Properties.CertificateSubjectName = 'sdnsite1.contoso.com' $prop.Sites[0].Properties.EncodedCertificate = $base64cert1 -Set-NetworkControllerMultisiteConfiguration -ConnectionUri "https://sdnsite2.contoso.com" -Properties $prop -Force +Set-NetworkControllerMultisiteConfiguration -ConnectionUri 'https://sdnsite2.contoso.com' +-Properties $prop -Force ``` ### Example 2: Removing Peering after Multisite has been set-up + ```powershell -PS C:\> $prop = new-object Microsoft.Windows.NetworkController.NetworkControllerMultisiteProperties +$prop = new-object Microsoft.Windows.NetworkController.NetworkControllerMultisiteProperties -Set-NetworkControllerMultisiteConfiguration -ConnectionUri "https://site1.com" -Properties $prop -Force +Set-NetworkControllerMultisiteConfiguration -ConnectionUri 'https://site1.com' -Properties $prop +-Force -Set-NetworkControllerMultisiteConfiguration -ConnectionUri "https://site2.com" -Properties $prop -Force +Set-NetworkControllerMultisiteConfiguration -ConnectionUri 'https://site2.com' -Properties $prop +-Force ``` ### Example 3: Removing a site where site property is an empty array or has a null value + ```powershell -PS C:\> $multisiteProp = new-object Microsoft.Windows.NetworkController.NetworkControllerMultisiteProperties +$multisiteProp = new-object +Microsoft.Windows.NetworkController.NetworkControllerMultisiteProperties -Set-NetworkControllerMultisiteConfiguration -ConnectionUri $site2Url -Properties $multisiteProp -Force +Set-NetworkControllerMultisiteConfiguration -ConnectionUri $site2Url -Properties $multisiteProp +-Force -Set-NetworkControllerMultisiteConfiguration -ConnectionUri $site1Url -Properties $multisiteProp -Force +Set-NetworkControllerMultisiteConfiguration -ConnectionUri $site1Url -Properties $multisiteProp +-Force ``` +### Example 4: **NetworkControllerMultisiteProperties** object properties + +- CertificateSubjectName +- [[Sites] \] + - ResourceID/RESTIPAddress + - IsPrimary + - State + - DeploymentID + - APIVersion + - ConfigurationState + - [[Properties] \] + - RestIPAddress + - CertificateSubjectName + - EncodedCertificate + ## 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 @@ -93,7 +130,8 @@ Accept wildcard characters: False ``` ### -ConnectionUri -Specifies the Uniform Resource Identifier (URI) of a Network Controller. + +Specifies the Uniform Resource Identifier (URI) of a Network Controller. ```yaml Type: System.Uri @@ -108,8 +146,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 @@ -124,7 +164,11 @@ Accept wildcard characters: False ``` ### -Etag -{{ Fill Etag Description }} + +Specifies the entity tag (ETag) parameter of the resource. An ETag (entity tag) is an HTTP +response header returned by an HTTP-compliant web server 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. ```yaml Type: System.String @@ -139,6 +183,7 @@ Accept wildcard characters: False ``` ### -Force + Forces the command to run without asking for user confirmation ```yaml @@ -154,9 +199,12 @@ 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 @@ -171,19 +219,10 @@ Accept wildcard characters: False ``` ### -Properties -Specifies a site configuration for Multisite Peering. Site configuration comes as a NetworkControllerMultisiteProperties object. This object can be defined as new-object Microsoft.Windows.NetworkController.NetworkControllerMultisiteProperties. Here are the following properties that can be changed: -- CertificateSubjectName -- [[Sites] \] - - ResourceID/RESTIPAddress - - IsPrimary - - State - - DeploymentID - - APIVersion - - ConfigurationState - - [[Properties] \] - - RestIPAddress - - CertificateSubjectName - - EncodedCertificate + +Specifies a site configuration for Multisite Peering. Site configuration comes as a +NetworkControllerMultisiteProperties object. This object can be defined as new-object +**Microsoft.Windows.NetworkController.NetworkControllerMultisiteProperties**. ```yaml Type: Microsoft.Windows.NetworkController.NetworkControllerMultisiteProperties @@ -198,7 +237,8 @@ Accept wildcard characters: False ``` ### -ResourceId -{{ Fill ResourceId Description }} + +Specifies the unique identifier for the Multisite configuration ```yaml Type: System.String @@ -213,7 +253,8 @@ Accept wildcard characters: False ``` ### -ResourceMetadata -{{ Fill ResourceMetadata Description }} + +This parameter contains metadata information for the client. ```yaml Type: Microsoft.Windows.NetworkController.ResourceMetadata @@ -228,7 +269,8 @@ Accept wildcard characters: False ``` ### -Tags -{{ Fill Tags Description }} + +@{Text=} ```yaml Type: System.Management.Automation.PSObject @@ -243,6 +285,7 @@ Accept wildcard characters: False ``` ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml @@ -258,6 +301,7 @@ Accept wildcard characters: False ``` ### -WhatIf + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -274,7 +318,11 @@ 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 @@ -283,6 +331,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### System.Object + ## NOTES ## RELATED LINKS diff --git a/docset/winserver2025-ps/networkcontroller/Set-NetworkControllerMultisitePrimary.md b/docset/winserver2025-ps/networkcontroller/Set-NetworkControllerMultisitePrimary.md index 6c94704749..76197e23a8 100644 --- a/docset/winserver2025-ps/networkcontroller/Set-NetworkControllerMultisitePrimary.md +++ b/docset/winserver2025-ps/networkcontroller/Set-NetworkControllerMultisitePrimary.md @@ -1,44 +1,53 @@ --- external help file: Microsoft.NetworkController.Powershell.dll-help.xml Module Name: NetworkController -online version: +online version: https://learn.microsoft.com/powershell/module/networkcontroller/set-networkcontrollermultisiteprimary?view=windowsserver2025-ps schema: 2.0.0 --- # Set-NetworkControllerMultisitePrimary ## SYNOPSIS + Sets the primary site of a NetworkController Site. ## SYNTAX ``` -Set-NetworkControllerMultisitePrimary [[-Tags] ] - [-Properties] [[-Etag] ] - [[-ResourceMetadata] ] [[-ResourceId] ] [-Force] -ConnectionUri - [-CertificateThumbprint ] [-Credential ] [-PassInnerException] [-WhatIf] [-Confirm] - [] +Set-NetworkControllerMultisitePrimary [[-Tags] ] [-Properties] + [[-Etag] ] [[-ResourceMetadata] +] [[-ResourceId] ] [-Force] -ConnectionUri +[-CertificateThumbprint ] [-Credential ] [-PassInnerException] [-WhatIf] +[-Confirm] [] ``` ## DESCRIPTION -The Set-NetworkControllerMultisitePrimary cmdlet is used to change the primary site of a location in a Multisite configuration. -This can be done in the off-chance that your original Primary site has gone offline and policies still need to be pushed and applied. -Note, any policies that were being configured at the moment when the original primary site crashes will be lost and must be redone. + +The `Set-NetworkControllerMultisitePrimary` cmdlet is used to change the primary site of a +location in a Multisite configuration. This can be done in the off-chance that your original +Primary site has gone offline and policies still need to be pushed and applied. Note, any +policies that were being configured at the moment when the original primary site crashes will be +lost and must be redone. ## EXAMPLES ### Example 1: Set new Primary site + ```powershell -PS C:\> $prop = new-object Microsoft.Windows.NetworkController.NetworkControllerMultisitePrimaryProperties -PS C:\> Set-NetworkControllerMultisitePrimary -ConnectionUri "https://site1.com" -Properties $prop -Force -``` +$prop = new-object +Microsoft.Windows.NetworkController.NetworkControllerMultisitePrimaryProperties +Set-NetworkControllerMultisitePrimary -ConnectionUri 'https://site1.com' -Properties $prop +-Force +``` ## 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 @@ -53,6 +62,7 @@ Accept wildcard characters: False ``` ### -ConnectionUri + Specifies the Uniform Resource Identifier (URI) of a Network Controller. ```yaml @@ -68,8 +78,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 @@ -84,7 +96,11 @@ Accept wildcard characters: False ``` ### -Etag -{{ Fill Etag Description }} + +Specifies the entity tag (ETag) parameter of the resource. An ETag (entity tag) is an HTTP +response header returned by an HTTP-compliant web server 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. ```yaml Type: System.String @@ -99,6 +115,7 @@ Accept wildcard characters: False ``` ### -Force + Forces the command to run without asking for user confirmation ```yaml @@ -114,9 +131,12 @@ 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 @@ -131,6 +151,7 @@ Accept wildcard characters: False ``` ### -Properties + Specifies the primary site of a location. ```yaml @@ -146,7 +167,8 @@ Accept wildcard characters: False ``` ### -ResourceId -{{ Fill ResourceId Description }} + +Specifies the unique identifier for the Multisite configuration ```yaml Type: System.String @@ -161,7 +183,8 @@ Accept wildcard characters: False ``` ### -ResourceMetadata -{{ Fill ResourceMetadata Description }} + +This parameter contains metadata information for the client. ```yaml Type: Microsoft.Windows.NetworkController.ResourceMetadata @@ -176,7 +199,8 @@ Accept wildcard characters: False ``` ### -Tags -{{ Fill Tags Description }} + +@{Text=} ```yaml Type: System.Management.Automation.PSObject @@ -191,6 +215,7 @@ Accept wildcard characters: False ``` ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml @@ -206,8 +231,8 @@ Accept wildcard characters: False ``` ### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. + +Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml Type: System.Management.Automation.SwitchParameter @@ -222,7 +247,11 @@ 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 @@ -231,6 +260,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### System.Object + ## NOTES ## RELATED LINKS From 7a1039d899abe06cb22f808081ae5fe9b476a3c6 Mon Sep 17 00:00:00 2001 From: Sean Wheeler Date: Wed, 26 Jun 2024 08:55:41 -0500 Subject: [PATCH 5/5] Editorial changes --- ...NetworkControllerMultisiteConfiguration.md | 38 +++--- ...NetworkControllerMultisiteConfiguration.md | 114 +++++++++--------- .../Set-NetworkControllerMultisitePrimary.md | 59 ++++----- 3 files changed, 108 insertions(+), 103 deletions(-) diff --git a/docset/winserver2025-ps/networkcontroller/Get-NetworkControllerMultisiteConfiguration.md b/docset/winserver2025-ps/networkcontroller/Get-NetworkControllerMultisiteConfiguration.md index d94075e81f..33dfdf6477 100644 --- a/docset/winserver2025-ps/networkcontroller/Get-NetworkControllerMultisiteConfiguration.md +++ b/docset/winserver2025-ps/networkcontroller/Get-NetworkControllerMultisiteConfiguration.md @@ -1,6 +1,7 @@ --- external help file: Microsoft.NetworkController.Powershell.dll-help.xml Module Name: NetworkController +ms.date: 06/26/2024 online version: https://learn.microsoft.com/powershell/module/networkcontroller/get-networkcontrollermultisiteconfiguration?view=windowsserver2025-ps schema: 2.0.0 --- @@ -15,8 +16,8 @@ Gets Multisite peering configuration parameters ``` Get-NetworkControllerMultisiteConfiguration [-ConnectionUri ] -[-CertificateThumbprint ] [-Credential ] [-PassInnerException] -[] + [-CertificateThumbprint ] [-Credential ] [-PassInnerException] + [] ``` ## DESCRIPTION @@ -30,11 +31,10 @@ sanity check for the state of a deployment. ### Example 1: Check Peering State ```powershell -Get-NetworkControllerMultisiteConfiguration -ConnectionUri 'https://site1.com' | ConvertTo-JSON --depth 100 +Get-NetworkControllerMultisiteConfiguration -ConnectionUri 'https://site1.contoso.com' | + ConvertTo-Json -depth 100 ``` - ## PARAMETERS ### -CertificateThumbprint @@ -57,7 +57,7 @@ Accept wildcard characters: False ### -ConnectionUri -Specifies the Uniform Resource Identifier (URI) of a Network Controller. +Specifies the Uniform Resource Identifier (URI) of a Network Controller. ```yaml Type: System.Uri @@ -73,9 +73,9 @@ 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 @@ -91,12 +91,11 @@ 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 @@ -112,10 +111,9 @@ 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 +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 @@ -126,8 +124,6 @@ For more information, see ### System.Object -### System.Object - ## NOTES ## RELATED LINKS diff --git a/docset/winserver2025-ps/networkcontroller/Set-NetworkControllerMultisiteConfiguration.md b/docset/winserver2025-ps/networkcontroller/Set-NetworkControllerMultisiteConfiguration.md index a6561e6b15..3fa2407e59 100644 --- a/docset/winserver2025-ps/networkcontroller/Set-NetworkControllerMultisiteConfiguration.md +++ b/docset/winserver2025-ps/networkcontroller/Set-NetworkControllerMultisiteConfiguration.md @@ -1,6 +1,7 @@ --- external help file: Microsoft.NetworkController.Powershell.dll-help.xml Module Name: NetworkController +ms.date: 06/26/2024 online version: https://learn.microsoft.com/powershell/module/networkcontroller/set-networkcontrollermultisiteconfiguration?view=windowsserver2025-ps schema: 2.0.0 --- @@ -14,100 +15,107 @@ Initiates site peering between NC infrastructures across two different locations ## SYNTAX ``` -Set-NetworkControllerMultisiteConfiguration [[-Tags] ] [-Properties] - [[-Etag] ] [[-ResourceMetadata] -] [[-ResourceId] ] [-Force] -ConnectionUri -[-CertificateThumbprint ] [-Credential ] [-PassInnerException] [-WhatIf] -[-Confirm] [] +Set-NetworkControllerMultisiteConfiguration [[-Tags] ] + [-Properties] [[-Etag] ] + [[-ResourceMetadata] ] [[-ResourceId] ] [-Force] -ConnectionUri + [-CertificateThumbprint ] [-Credential ] [-PassInnerException] [-WhatIf] + [-Confirm] [] ``` ## DESCRIPTION The `Set-NetworkControllerMultisiteConfiguration` cmdlet initiates a Multisite peering connection -between two NC infrastructures. For instance, if you have site A with NC infrastructure A and -site B with NC infrastructure B, then you can initiate a peer between NC infrastructure A and NC -infrastructure B. This cmdlet can not only initiate peering but can also remove peering and -change the status of a NC infrastructure to primary. Additionally, this cmdlet can also be used -to edit site properties once configured. +between two NC infrastructures. For instance, if you have site A with NC infrastructure A and site B +with NC infrastructure B, then you can initiate a peer between NC infrastructure A and NC +infrastructure B. This cmdlet can not only initiate peering but can also remove peering and change +the status of a NC infrastructure to primary. Additionally, this cmdlet can also be used to edit +site properties once configured. ## EXAMPLES ### Example 1: Initiate Peering with Self-Signed Certificates ```powershell -$cert1 = Get-ChildItem 'Cert:\LocalMachine\My' | where {$_.Subject -like ‘sdnsite1.contoso.com’} +$cert1 = Get-ChildItem 'Cert:\LocalMachine\My' | Where-Object Subject -like 'sdnsite1.contoso.com' +$cert2 = Get-ChildItem 'Cert:\LocalMachine\My' | Where-Object Subject -like 'sdnsite2.contoso.com' $base64cert1 = [System.Convert]::ToBase64String($cert1.RawData) -$cert2 = Get-ChildItem “Cert:\LocalMachine\My” | where {$_.Subject -like ‘sdnsite2.contoso.com’} $base64cert2 = [System.Convert]::ToBase64String($cert2.RawData) -$prop = new-object Microsoft.Windows.NetworkController.NetworkControllerMultisiteProperties +$prop = New-Object Microsoft.Windows.NetworkController.NetworkControllerMultisiteProperties $prop.certificateSubjectName = 'sdnsite1.contoso.com' -$prop.Sites = new-object Microsoft.Windows.NetworkController.NetworkControllerSite +$prop.Sites = New-Object Microsoft.Windows.NetworkController.NetworkControllerSite $prop.Sites[0].ResourceId = 'site2' -$prop.Sites[0].Properties = new-object -Microsoft.Windows.NetworkController.NetworkControllerSiteProperties +$prop.Sites[0].Properties = New-Object Microsoft.Windows.NetworkController.NetworkControllerSiteProperties $prop.Sites[0].Properties.RestIPAddress = 'sdnsite2.contoso.com' $prop.Sites[0].Properties.CertificateSubjectName = 'sdnsite2.contoso.com' $prop.Sites[0].Properties.EncodedCertificate = $base64cert2 -Set-NetworkControllerMultisiteConfiguration -ConnectionUri 'https://sdnsite1.contoso.com' --Properties $prop -Force +$parameters = @{ + ConnectionUri = 'https://sdnsite1.contoso.com' + Properties = $prop + Force = $true +} +Set-NetworkControllerMultisiteConfiguration @parameters -$prop = new-object Microsoft.Windows.NetworkController.NetworkControllerMultisiteProperties +$prop = New-Object Microsoft.Windows.NetworkController.NetworkControllerMultisiteProperties $prop.certificateSubjectName = 'sdnsite2.contoso.com' -$prop.Sites = new-object Microsoft.Windows.NetworkController.NetworkControllerSite +$prop.Sites = New-Object Microsoft.Windows.NetworkController.NetworkControllerSite $prop.Sites[0].ResourceId = 'site1' -$prop.Sites[0].Properties = new-object -Microsoft.Windows.NetworkController.NetworkControllerSiteProperties +$prop.Sites[0].Properties = New-Object Microsoft.Windows.NetworkController.NetworkControllerSiteProperties $prop.Sites[0].Properties.RestIPAddress = 'sdnsite1.contoso.com' $prop.Sites[0].Properties.CertificateSubjectName = 'sdnsite1.contoso.com' $prop.Sites[0].Properties.EncodedCertificate = $base64cert1 -Set-NetworkControllerMultisiteConfiguration -ConnectionUri 'https://sdnsite2.contoso.com' --Properties $prop -Force +$parameters.ConnectionUri = 'https://sdnsite2.contoso.com' +Set-NetworkControllerMultisiteConfiguration @parameters ``` ### Example 2: Removing Peering after Multisite has been set-up ```powershell -$prop = new-object Microsoft.Windows.NetworkController.NetworkControllerMultisiteProperties - -Set-NetworkControllerMultisiteConfiguration -ConnectionUri 'https://site1.com' -Properties $prop --Force - -Set-NetworkControllerMultisiteConfiguration -ConnectionUri 'https://site2.com' -Properties $prop --Force +$prop = New-Object Microsoft.Windows.NetworkController.NetworkControllerMultisiteProperties + +$parameters = @{ + ConnectionUri = 'https://site1.contoso.com' + Properties = $prop + Force = $true +} +Set-NetworkControllerMultisiteConfiguration @parameters +$parameters.ConnectionUri = 'https://site2.contoso.com' +Set-NetworkControllerMultisiteConfiguration @parameters ``` ### Example 3: Removing a site where site property is an empty array or has a null value ```powershell -$multisiteProp = new-object -Microsoft.Windows.NetworkController.NetworkControllerMultisiteProperties - -Set-NetworkControllerMultisiteConfiguration -ConnectionUri $site2Url -Properties $multisiteProp --Force - -Set-NetworkControllerMultisiteConfiguration -ConnectionUri $site1Url -Properties $multisiteProp --Force +$multisiteProp = New-Object Microsoft.Windows.NetworkController.NetworkControllerMultisiteProperties +$parameters = @{ + ConnectionUri = 'https://site2.contoso.com' + Properties = $multisiteProp + Force = $true +} +Set-NetworkControllerMultisiteConfiguration @parameters + +$parameters.ConnectionUri = 'https://site1.contoso.com' +Set-NetworkControllerMultisiteConfiguration @parameters ``` ### Example 4: **NetworkControllerMultisiteProperties** object properties - CertificateSubjectName - [[Sites] \] - - ResourceID/RESTIPAddress - - IsPrimary - - State - - DeploymentID - - APIVersion - - ConfigurationState - - [[Properties] \] - - RestIPAddress - - CertificateSubjectName - - EncodedCertificate + - ResourceID/RESTIPAddress + - IsPrimary + - State + - DeploymentID + - APIVersion + - ConfigurationState + - [[Properties] \] + - RestIPAddress + - CertificateSubjectName + - EncodedCertificate ## PARAMETERS @@ -220,9 +228,8 @@ Accept wildcard characters: False ### -Properties -Specifies a site configuration for Multisite Peering. Site configuration comes as a -NetworkControllerMultisiteProperties object. This object can be defined as new-object -**Microsoft.Windows.NetworkController.NetworkControllerMultisiteProperties**. +Specifies a site configuration for Multisite Peering. This parameter takes a +**NetworkControllerMultisiteProperties** object, which you can create using `New-Object`. ```yaml Type: Microsoft.Windows.NetworkController.NetworkControllerMultisiteProperties @@ -302,8 +309,7 @@ Accept wildcard characters: False ### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml Type: System.Management.Automation.SwitchParameter diff --git a/docset/winserver2025-ps/networkcontroller/Set-NetworkControllerMultisitePrimary.md b/docset/winserver2025-ps/networkcontroller/Set-NetworkControllerMultisitePrimary.md index 76197e23a8..aceb6b5772 100644 --- a/docset/winserver2025-ps/networkcontroller/Set-NetworkControllerMultisitePrimary.md +++ b/docset/winserver2025-ps/networkcontroller/Set-NetworkControllerMultisitePrimary.md @@ -14,40 +14,44 @@ Sets the primary site of a NetworkController Site. ## SYNTAX ``` -Set-NetworkControllerMultisitePrimary [[-Tags] ] [-Properties] - [[-Etag] ] [[-ResourceMetadata] -] [[-ResourceId] ] [-Force] -ConnectionUri -[-CertificateThumbprint ] [-Credential ] [-PassInnerException] [-WhatIf] -[-Confirm] [] +Set-NetworkControllerMultisitePrimary [[-Tags] ] + [-Properties] [[-Etag] ] + [[-ResourceMetadata] ] [[-ResourceId] ] [-Force] -ConnectionUri + [-CertificateThumbprint ] [-Credential ] [-PassInnerException] [-WhatIf] + [-Confirm] [] ``` ## DESCRIPTION -The `Set-NetworkControllerMultisitePrimary` cmdlet is used to change the primary site of a -location in a Multisite configuration. This can be done in the off-chance that your original -Primary site has gone offline and policies still need to be pushed and applied. Note, any -policies that were being configured at the moment when the original primary site crashes will be -lost and must be redone. +The `Set-NetworkControllerMultisitePrimary` cmdlet is used to change the primary site of a location +in a Multisite configuration. You can use this command in cases when your original Primary site has +gone offline and policies still need to be pushed and applied. + +> [!NOTE] +> Any policies that were being configured when the original primary site crashed are lost and must +> be reapplied. ## EXAMPLES -### Example 1: Set new Primary site +### Example 1: Set new Primary site ```powershell -$prop = new-object -Microsoft.Windows.NetworkController.NetworkControllerMultisitePrimaryProperties - -Set-NetworkControllerMultisitePrimary -ConnectionUri 'https://site1.com' -Properties $prop --Force +$prop = New-Object Microsoft.Windows.NetworkController.NetworkControllerMultisitePrimaryProperties +$parameters = @{ + ConnectionUri = 'https://site1.contoso.com' + Properties = $prop + Force = $true +} +Set-NetworkControllerMultisitePrimary @parameters ``` ## 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 @@ -63,7 +67,7 @@ Accept wildcard characters: False ### -ConnectionUri -Specifies the Uniform Resource Identifier (URI) of a Network Controller. +Specifies the Uniform Resource Identifier (URI) of a Network Controller. ```yaml Type: System.Uri @@ -79,9 +83,9 @@ 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 @@ -97,10 +101,10 @@ Accept wildcard characters: False ### -Etag -Specifies the entity tag (ETag) parameter of the resource. An ETag (entity tag) is an HTTP -response header returned by an HTTP-compliant web server 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. +Specifies the entity tag (ETag) parameter of the resource. An ETag (entity tag) is an HTTP response +header returned by an HTTP-compliant web server 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. ```yaml Type: System.String @@ -268,4 +272,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Set-NetworkControllerMultisiteConfiguration](./Set-NetworkControllerMultisiteConfiguration.md) [Get-NetworkControllerMultisiteConfiguration](./Get-NetworkControllerMultisiteConfiguration.md) -