Suspend-CantaraScheduler

NAME Suspend-CantaraScheduler



SYNOPSIS

Suspends the Cantara scheduler via the REST API.





SYNTAX

Suspend-CantaraScheduler [-URI] <String> [-WebSession] <WebRequestSession> [<CommonParameters>]





DESCRIPTION

Suspends the Cantara scheduler via the REST API within an existing web reqest session.





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



-WebSession <WebRequestSession>

The established web request session.



Required? true

Position? 2

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, WebRequestSession





OUTPUTS

Boolean





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



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



PS C:\\> Suspend-CantaraScheduler -URI $URI -WebSession CantaraSession

Description

-----------

Suspends the Cantara scheduler via Cantara REST API using the predefined URI and an existing web session

object.











RELATED LINKS