Request-NsxtAuthentication¶

Synopsis¶

Checks API authentication to NSX Manager cluster.

Syntax¶

All-WorkloadDomains¶

Request-NsxtAuthentication -server <String> -user <String> -pass <String> [-allDomains] [-failureOnly] [<CommonParameters>]

Specific-WorkloadDomains¶

Request-NsxtAuthentication -server <String> -user <String> -pass <String> -workloadDomain <String> [-failureOnly] [<CommonParameters>]

Description¶

The Request-NsxtAuthentication cmdlets checks the authentication to NSX Manager cluster. 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
Validates that network connectivity is available to the NSX Manager cluster

Examples¶

Example 1¶

Request-NsxtAuthentication -server sfo-vcf01.sfo.rainpole.io -user admin@local -pass VMw@re1!VMw@re1! -allDomains

This example will check authentication to NSX Manager API for all NSX Manager clusters managed by SDDC Manager.

Example 2¶

Request-NsxtAuthentication -server sfo-vcf01.sfo.rainpole.io -user admin@local -pass VMw@re1!VMw@re1! -workloadDomain sfo-w01

This example will check authentication to NSX Manager API for a single workload domain

Example 3¶

Request-NsxtAuthentication -server sfo-vcf01.sfo.rainpole.io -user admin@local -pass VMw@re1!VMw@re1! -allDomains -failureOnly

This example will check authentication to NSX Manager API for all NSX Manager clusters but only reports issues.

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-WorkloadDomains
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

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.