Request-NsxtAuthentication¶

Synopsis¶

Checks API authentication to NSX.

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. 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 NSX.

Examples¶

Example 1¶

Request-NsxtAuthentication -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -allDomains

This example will check authentication to the NSX API for all instances of NSX managed by SDDC Manager.

Example 2¶

Request-NsxtAuthentication -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -workloadDomain [workload_domain_name]

This example will check authentication to the NSX API for a specified workload domain.

Example 3¶

Request-NsxtAuthentication -server [sddc_manager_fqdn] -user [admin_username] -pass [admin_password] -allDomains -failureOnly

This example will check authentication to the NSX API for all instances of NSX managed by SDDC Manager 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.