Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

NAME

Use-JobSchedulerWebService

SYNOPSIS

Connects to the JobScheduler Web Service.

SYNTAX

Use-JobSchedulerWebService -Url <Uri> [-Id <String>] [-Credentials <PSCredential>] [-ProxyUrl <Uri>] [[-ProxyCr
edentialsProxyCredentials] <PSCredential>] [-Base <String>] -Disconnect <CommonParameters>

DESCRIPTION

This cmdlet can be used with the JobScheduler Web Service starting from release 1.11.

...

The cmdlet authenticates a user and returns an access token in case of successful authentication
that can be used for subsequent requests to the Web Service.

PARAMETERS

Url

-Url <Uri>
Specifies the URL to access the Web Service.

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

Id

-Id <String>
Specifies the ID of a JobScheduler Master.

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

Credentials

-Credentials <PSCredential>
Specifies a credentials object that is used to authenticate the account with the JobScheduler Web Service.

...

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

ProxyUrl

-ProxyUrl <Uri>

Required? false
Position? 4
Default value
Accept pipeline input? false
Accept wildcard characters?

ProxyCredentials

-ProxyCredentials <PSCredential>

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

Base

-Base <String>
The Base is used as a prefix to the Path for web service URLs and is configured with the web server
that hosts the JobScheduler Web Service.

...

Required? false
Position? 6
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters?

Disconnect

-Disconnect <SwitchParameter>
This parameter is used to disconnect from a previously connected JobScheduler Web Service.

...

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

about_jobscheduler

EXAMPLES

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

...