New-NetworkControllerCredential

Article
11/16/2015

New-NetworkControllerCredential

Adds or modifies a device credential in Network Controller.

Syntaxe

Parameter Set: Default
New-NetworkControllerCredential [-ResourceId] <String> [-Properties] <CredentialProperties> [[-ResourceMetadata] <ResourceMetadata> ] [[-VersionId] <System.String> ] [[-Force]] -ConnectionUri <String> [-CertificateThumbprint <System.String> ] [-Credential <PSCredential> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Description détaillée

The New-NetworkControllerCredential cmdlet adds a new device credential to the Network Controller. If the credential is already present, this cmdlet will modify the properties of the credential. Network Controller uses the device credential to connect to a southbound device for managing the device. This cmdlet adds or modifies credentials based on username and password, Simple Network Management Protocol (SNMP)-based credentials and certificate-based credentials.

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 the 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 is the current user. This user must be present in the security group provided in the ClientSecurityGroup parameter in the Install-NetworkController cmdlet or the Set-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

-Force

Force l'exécution de la commande sans demander une confirmation de l'utilisateur.

Alias	none
Requis ?	false
Position ?	9
Valeur par défaut	none
Accepter l'entrée de pipeline ?	false
Accepter les caractères génériques ?	false

-Properties<CredentialProperties>

This contains details about the Credential resource, such as the type of credential (can be username and password, SNMP community string or certificate), the user name of the resource (only applicable if the type is username and password) and the value of the credential.

Alias	none
Requis ?	true
Position ?	4
Valeur par défaut	none
Accepter l'entrée de pipeline ?	true(ByPropertyName)
Accepter les caractères génériques ?	false

-ResourceId<String>

This is the ID of the credential that will be created or modified.

Alias	none
Requis ?	true
Position ?	1
Valeur par défaut	none
Accepter l'entrée de pipeline ?	true(ByPropertyName)
Accepter les caractères génériques ?	false

-ResourceMetadata<ResourceMetadata>

This parameter contains metadata information for the client, such as the tenant ID, group ID, and resource name.

Alias	none
Requis ?	false
Position ?	7
Valeur par défaut	none
Accepter l'entrée de pipeline ?	false
Accepter les caractères génériques ?	false

-VersionId<System.String>

Specifies the entity tag (ETag) parameter of the resource. An ETag (entity tag) is an HTTP response header returned by an HTTP-compliant web server used to determine change in the content of a resource at a given URL. The value of the header is an opaque string representing the state of the resource at the time the response was generated.

Alias	none
Requis ?	false
Position ?	8
Valeur par défaut	none
Accepter l'entrée de pipeline ?	false
Accepter les caractères génériques ?	false

-Confirm

Vous invite à confirmer l'exécution de l'applet de commande.

Requis ?	false
Position ?	named
Valeur par défaut	false
Accepter l'entrée de pipeline ?	false
Accepter les caractères génériques ?	false

-WhatIf

Indique ce qui se produit en cas d'exécution de l'applet de commande. L'applet de commande n'est pas exécutée.

Requis ?	false
Position ?	named
Valeur par défaut	false
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.

This cmdlet outputs the following information:
-- Resource reference uri
-- Created time of the resource
-- Instance ID of the resource
-- Resource Metadata
-- Resource ID
-- Properties of the resource

Exemples

Example 1: Create a network credential

This command creates a credential object and uses New-NetworkControllerCredential to add it to the network controller.

To get the Properties, put the output of New-NetworkControllerCredential in a variable (for example, x) and execute x.properties in the Powershell prompt.

PS C:\> $cred=New-Object Microsoft.Windows.Networkcontroller.credentialproperties
$cred.type="usernamepassword"
$cred.username="admin"
$cred.value="abcd"

New-NetworkControllerCredential -ConnectionUri "https://restserver" -Properties $Cred –ResourceId "Cred1"

Rubriques connexes

Get-NetworkControllerCredential

Install-NetworkController

Remove-NetworkControllerCredential

Set-NetworkController

New-NetworkControllerCredential