Connect-CantaraRESTAPI

NAME Connect-CantaraRESTAPI



SYNOPSIS

Connects to the Cantara REST API.





SYNTAX

Connect-CantaraRESTAPI [-URI] <String> [-Credential] <PSCredential> [-SessionName] <String> [<CommonParameters>]





DESCRIPTION

Authtenticates with the Catara scheduler REST API and generates a web request session for subsequent

interactions, such as getting the status of the scheduler, suspending, resuming, and shutting down.





PARAMETERS

-URI <String>

The URI for the Cantara Scheduler REST API endpoint.



Required? true

Position? 1

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Credential <PSCredential>

The username and password for the Cantara scheduler REST API endpoint.



Required? true

Position? 2

Default value

Accept pipeline input? true (ByValue)

Accept wildcard characters? false



-SessionName <String>

The name to be used for the web request session.



Required? true

Position? 3

Default value

Accept pipeline input? false

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

System.String, pscredential





OUTPUTS

WebRequestSession





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



PS C:\\>$URI = "http://servername.somedomain:1234/cantaraendpoint"



PS C:\\> $Cred = Get-Credential

PS C:\\> Connect-CantaraRESTAPI -URI $URI -Credential $Cred -SessionName CantaraSession

Description

-----------

Authenticates with the Cantara scheduler REST API using the pre-defined URI and credential objects.











RELATED LINKS