Get-NetworkControllerCredential

Get-NetworkControllerCredential

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

構文

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

詳細説明

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.

パラメーター

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

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

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

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

<CommonParameters>

このコマンドレットは共通のパラメーターをサポートしています(-Verbose、-Debug、-ErrorAction、-ErrorVariable、-OutBuffer、および -OutVariable)。詳細については、TechNet の「 「about_CommonParameters」 (https://go.microsoft.com/fwlink/p/?LinkID=113216) を参照してください。

入力

入力型は、コマンドレットにパイプできるオブジェクトの型です。

出力

出力型は、コマンドレットが出力するオブジェクトの型です。

• 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

使用例

This command retrieves a credential with ID cred1.

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

関連項目

Install-NetworkController

New-NetworkControllerCredential

Remove-NetworkControllerCredential

Set-NetworkController