Get SdnGateway

Get-SdnGateway

SYNOPSIS

Returns a list of gateways from network controller.

SYNTAX

Default (Default)

Get-SdnGateway -NcUri <Uri> [-NcRestCertificate <X509Certificate>] [-NcRestCredential <PSCredential>]
 [-ManagementAddressOnly] [<CommonParameters>]

ResourceRef

Get-SdnGateway -NcUri <Uri> -ResourceRef <String> [-NcRestCertificate <X509Certificate>]
 [-NcRestCredential <PSCredential>] [-ManagementAddressOnly] [<CommonParameters>]

ResourceId

Get-SdnGateway -NcUri <Uri> -ResourceId <String> [-NcRestCertificate <X509Certificate>]
 [-NcRestCredential <PSCredential>] [-ManagementAddressOnly] [<CommonParameters>]

DESCRIPTION

{{ Fill in the Description }}

EXAMPLES

EXAMPLE 1

Get-SdnGateway -NcUri 'https://NC.FQDN' -NcRestCredential (Get-Credential)

EXAMPLE 2

Get-SdnGateway -NcUri 'https://NC.FQDN' -NcRestCredential (Get-Credential) -ManagementAddressOnly

EXAMPLE 3

Get-SdnGateway -NcUri 'https://NC.FQDN' -NcRestCredential (Get-Credential) -ResourceId 'f5e3b3e0-1b7a-4b9e-8b9e-5b5e3b3e0f5e'

EXAMPLE 4

Get-SdnGateway -NcUri 'https://NC.FQDN' -NcRestCredential (Get-Credential) -ResourceRef 'gateways/f5e3b3e0-1b7a-4b9e-8b9e-5b5e3b3e0f5e'

EXAMPLE 5

Get-SdnGateway -NcUri 'https://NC.FQDN' -NcRestCredential (Get-Credential) -ResourceId 'f5e3b3e0-1b7a-4b9e-8b9e-5b5e3b3e0f5e' -ManagementAddressOnly

EXAMPLE 6

Get-SdnGateway -NcUri 'https://NC.FQDN' -NcRestCredential (Get-Credential) -ResourceRef 'gateways/f5e3b3e0-1b7a-4b9e-8b9e-5b5e3b3e0f5e' -ManagementAddressOnly

PARAMETERS

-NcUri

Specifies the Uniform Resource Identifier (URI) of the network controller that all Representational State Transfer (REST) clients use to connect to that controller.

Type: Uri
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ResourceId

Specifies the unique identifier for the resource.

Type: String
Parameter Sets: ResourceId
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ResourceRef

Specifies the resource reference for the resource.

Type: String
Parameter Sets: ResourceRef
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-NcRestCertificate

Specifies the client certificate that is used for a secure web request to Network Controller REST API. Enter a variable that contains a certificate or a command or expression that gets the certificate.

Type: X509Certificate
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-NcRestCredential

Specifies a user account that has permission to perform this action against the Network Controller REST API. The default is the current user.

Type: PSCredential
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: [System.Management.Automation.PSCredential]::Empty
Accept pipeline input: False
Accept wildcard characters: False

-ManagementAddressOnly

Optional parameter to only return back the Management Address value.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
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.

INPUTS

OUTPUTS

NOTES

RELATED LINKS