Set-Dhcp
Server
Dns
Credential
Syntax
Set-DhcpServerDnsCredential
[-ComputerName <String>]
[-Credential] <PSCredential>
[-PassThru]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The Set-DhcpServerDnsCredential cmdlet sets credentials that the Dynamic Host Configuration Protocol (DHCP) Server service uses to register or deregister client records on a Domain Name System (DNS) server.
Examples
Example 1: Set a credential for a DHCP server
PS C:\> $Credential = Get-Credential
PS C:\> Set-DhcpServerDnsCredential -Credential $Credential -ComputerName "DhcpServer03.Contoso.com"
This example saves a credential on a DHCP server. The DHCP server uses the credential to register or deregister client records on a DNS server.
The first command uses the
Get-Credential
cmdlet to create a
PSCredential
object, and then stores it in the $Credential variable.
The cmdlet prompts you for user name and password.
For more information, type
Get-Help Get-Credential
.
The second command specifies the credential object stored in the $Credential variable for the DHCP server named DhcpServer03.Contoso.com.
Example 2: Prompt the user for a credential for a DHCP server
PS C:\> Set-DhcpServerDnsCredential -ComputerName "DhcpServer03.Contoso.com"
This command sets the DNS credentials that the server that runs DHCP server uses for registering and deregistering client records with the DNS server. The cmdlet prompts you for user name and password.
Required Parameters
Specifies a
PSCredential
object based on a user name and password.
To obtain a
PSCredential
object, use the
Get-Credential
cmdlet.
For more information, type
Get-Help Get-Credential
.
Type: | PSCredential |
Position: | 1 |
Default value: | None |
Accept pipeline input: | True (ByPropertyName) |
Accept wildcard characters: | False |
Optional Parameters
Runs the cmdlet as a background job.
Use this parameter to run commands that take a long time to complete.
The cmdlet immediately returns an object that represents the job and then displays the command prompt.
You can continue to work in the session while the job completes.
To manage the job, use the
*-Job
cmdlets.
To get the job results, use the
Receive-Job
cmdlet.
For more information about Windows PowerShell® background jobs, see
about_Jobs
.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.
Type: | CimSession[] |
Aliases: | Session |
Position: | Named |
Default value: | None |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Specifies the DNS name or IP address of the target computer that runs the DHCP Server service.
Type: | String |
Aliases: | Cn |
Position: | Named |
Default value: | None |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Prompts you for confirmation before running the cmdlet.
Type: | SwitchParameter |
Aliases: | cf |
Position: | Named |
Default value: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Specifies the maximum number of concurrent operations that can be established to run the cmdlet.
If this parameter is omitted or a value of
0
is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer.
The throttle limit applies only to the current cmdlet, not to the session or to the computer.
Type: | Int32 |
Position: | Named |
Default value: | None |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Outputs
Microsoft.Management.Infrastructure.CimInstance#DhcpServerDnsCredential