You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 13 Next »

NAME

Set-JobSchedulerCredentials

SYNOPSIS

When sending requests to a JobScheduler Master then authentication might be required.

SYNTAX

Set-JobSchedulerCredentials -UseDefaultCredentials -AskForCredentials [-Credentials <PSCredential>] -ProxyUseDefaultCredentials -ProxyAskForCredentials [[-ProxyCredentia
ls] <PSCredential>] <CommonParameters>

DESCRIPTION

PARAMETERS

UseDefaultCredentials

-UseDefaultCredentials <SwitchParameter>
Specifies that the implicit Windows credentials of the current user are applied for authentication challenges.

Either the parameter -UseDefaultCredentials or -Credentials can be used.

Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters?

AskForCredentials

-AskForCredentials <SwitchParameter>
Specifies that the user is prompted for the account and password that are used for authentication with JobScheduler.

Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters?

Credentials

-Credentials <PSCredential>
Specifies a credentials object that is used for authentication with JobScheduler.

A credentials object can be created e.g. with:

$account = 'John'
$password = ( 'Doe' | ConvertTo-SecureString -AsPlainText -Force)
$credentials = New-Object -typename System.Management.Automation.PSCredential -Argumentlist $account, $password

An existing credentials object can be retrieved from the Windows Credential Manager e.g. with:

$systemCredentials = Get-JobSchedulerSystemCredentials -TargetName 'localhost'
$credentials = ( New-Object -typename System.Management.Automation.PSCredential -Argumentlist $systemCredentials.UserName, $systemCredentials.Password )

Either the parameter -UseDefaultCredentials or -Credentials can be used.

Required? false
Position? 1
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters?

ProxyUseDefaultCredentials

-ProxyUseDefaultCredentials <SwitchParameter>
Specifies that the implicit Windows credentials of the current user are applied for proxy authentication.

Either the parameter -ProxyUseDefaultCredentials or -ProxyCredentials can be used.

Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters?

ProxyAskForCredentials

-ProxyAskForCredentials <SwitchParameter>
Specifies that the user is prompted for the account and password that are used for authentication with a proxy.

Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters?

ProxyCredentials

-ProxyCredentials <PSCredential>
Specifies a credentials object that is used for authentication with a proxy. See parameter -Credentials how to create a credentials object.

Either the parameter -ProxyUseDefaultCredentials or -ProxyCredentials can be used.

Required? false
Position? 2
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters?

EXAMPLES

-------------------------- EXAMPLE 1 --------------------------

C:\PS>Set-JobSchedulerCredentials -UseDefaultCredentials

The implicit Windows credentials are used for authentication. No password is used or stored in memory.

-------------------------- EXAMPLE 2 --------------------------

C:\PS>Set-JobSchedulerCredentials -AskForCredentials

Specifies that the user is prompted for account and password. The password is converted to a secure string
and a credentials object is created for authentication.

-------------------------- EXAMPLE 3 --------------------------

C:\PS>$account = 'John'

$password = ('Doe' | ConvertTo-SecureString -AsPlainText -Force)
$credentials = New-Object -typename System.Management.Automation.PSCredential -ArgumentList $account, $password
Set-JobSchedulerCredentials -Credentials $credentials

An individual credentials object is created that is assigned the -Credentials parameter.

-------------------------- EXAMPLE 4 --------------------------

C:\PS>$account = 'John'

$password = Read-Host 'Enter password for John: ' -AsSecureString
$credentials = New-Object -typename System.Management.Automation.PSCredential -ArgumentList $account, $password
Set-JobSchedulerCredentials -Credentials $credentials

An individual credentials object is created that is assigned the -Credentials parameter.

  • No labels