Get-NetworkControllerCredential

Get-NetworkControllerCredential

Retrieves a specified device credential or all device credentials from Network Controller.

Syntaxe

Parameter Set: Default
Get-NetworkControllerCredential [[-ResourceId] <String[]> ] -ConnectionUri <String> [-CertificateThumbprint <System.String> ] [-Credential <PSCredential> ] [ <CommonParameters>]

Description détaillée

The Get-NetworkControllerCredential retrieves the details of a specified device credential from Network Controller. Network Controller uses this device credential to connect to a southbound device for managing the device.

Get-NetworkControllerCredential retrieves the credential type, and if the credential type is composed of username and password, it retrieves only the user name of the credential.

Paramètres

-CertificateThumbprint<System.String>

Specifies the digital public key X.509 certificate of a user account that has permission to perform this action. This is the certificate thumbprint of the certificate.

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.

Alias

none

Requis ?

false

Position ?

named

Valeur par défaut

none

Accepter l'entrée de pipeline ?

false

Accepter les caractères génériques ?

false

-ConnectionUri<String>

Specifies the Uniform Resource Identifier (URI) of the Network Controller, used by all Representational State Transfer (REST) clients to connect to Network Controller.

Alias

none

Requis ?

true

Position ?

named

Valeur par défaut

none

Accepter l'entrée de pipeline ?

false

Accepter les caractères génériques ?

false

-Credential<PSCredential>

Specifies a user credential that has permission to perform this action. The default value is the current user.This user must be present in the security group provided in the ClientSecurityGroup parameter in the Install-NetworkController cmdlet.

Alias

none

Requis ?

false

Position ?

named

Valeur par défaut

none

Accepter l'entrée de pipeline ?

false

Accepter les caractères génériques ?

false

-ResourceId<String[]>

Specifies an array of one or more credentials to retrieve. If ResourceID is not provided, all the credentials in the Network Controller will be retrieved.

Alias

none

Requis ?

false

Position ?

1

Valeur par défaut

none

Accepter l'entrée de pipeline ?

false

Accepter les caractères génériques ?

false

<CommonParameters>

Cette applet de commande prend en charge les paramètres courants : -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer et -OutVariable. Pour plus d'informations, consultez  . about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Entrées

Le type d'entrée correspond au type des objets que vous pouvez adresser à l'applet de commande.

Sorties

Le type de sortie correspond au type des objets que l'applet de commande émet.

  • The output contains the following fields:
    -- Resource reference uri
    -- Created time of the resource
    -- Instance ID of the resource
    -- Resource Metadata
    -- Resource ID
    -- Properties of the resource

Exemples

This command retrieves a credential with ID cred1.

PS C:\> Get-NetworkControllerCredential -ConnectionUri "https://restserver" -ResourceId "Cred1"

Rubriques connexes

Install-NetworkController

New-NetworkControllerCredential

Remove-NetworkControllerCredential

Set-NetworkController