Publish-NsxtTier0BgpStatus¶
Synopsis¶
Request and publish the BGP status for the NSX Tier-0 gateways.
Syntax¶
All-WorkloadDomains¶
Publish-NsxtTier0BgpStatus -server <String> -user <String> -pass <String> [-allDomains] [-failureOnly] [-outputJson <String>] [<CommonParameters>]
Specific-WorkloadDomain¶
Publish-NsxtTier0BgpStatus -server <String> -user <String> -pass <String> -workloadDomain <String> [-failureOnly] [-outputJson <String>] [<CommonParameters>]
Description¶
The Publish-NsxtTier0BgpStatus cmdlet checks the BGP status for the NSX Tier-0 gateways in a VMware Cloud Foundation instance and prepares the data to be published to an HTML report.
The cmdlet connects to the SDDC Manager using the -server, -user, and -pass values:
- Validates that network connectivity is available to the SDDC Manager instance
- Performs checks on the BGP status and outputs the results
Examples¶
Example 1¶
Publish-NsxtTier0BgpStatus -server sfo-vcf01.sfo.rainpole.io -user admin@local -pass VMw@re1!VMw@re1! -allDomains
This example will publish the BGP status for all NSX Tier-0 gateways in a VMware Cloud Foundation instance.
Example 2¶
Publish-NsxtTier0BgpStatus -server sfo-vcf01.sfo.rainpole.io -user admin@local -pass VMw@re1!VMw@re1! -allDomains -failureOnly
This example will publish the BGP status for all NSX Tier-0 gateways in a VMware Cloud Foundation instance but only for the failed items.
Example 3¶
Publish-NsxtTier0BgpStatus -server sfo-vcf01.sfo.rainpole.io -user admin@local -pass VMw@re1!VMw@re1! -workloadDomain sfo-w01
This example will publish the BGP status for the NSX Tier-0 gateways in a VMware Cloud Foundation instance for a workload domain named sfo-w01.
Example 4¶
Publish-NsxtTier0BgpStatus -server sfo-vcf01.sfo.rainpole.io -user admin@local -pass VMw@re1!VMw@re1! -allDomains -outputJson F:\Reporting
This example will generate a json for the BGP status for all NSX Tier-0 gateways in a VMware Cloud Foundation instance.
and saves it under F:\Reporting with filename
Parameters¶
-server¶
The fully qualified domain name of the SDDC Manager.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-user¶
The username to authenticate to the SDDC Manager.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-pass¶
The password to authenticate to the SDDC Manager.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-allDomains¶
Switch to run health checks across all workload domains.
Type: SwitchParameter
Parameter Sets: All-WorkloadDomains
Aliases:
Required: True
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-workloadDomain¶
The name of the workload domain to run against.
Type: String
Parameter Sets: Specific-WorkloadDomain
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-failureOnly¶
Switch to only output issues to the report.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-outputJson¶
The path to save the output as a JSON file.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Common Parameters¶
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.