Disable-JenkinsJob

NAME Disable-JenkinsJob



SYNOPSIS

Disables a Jenkins job.





SYNTAX

Disable-JenkinsJob [-Uri] <String> [[-Credential] <PSCredential>] [[-Crumb] <String>] [[-Folder] <String>] [-Name]

<String> [-Confirm] [-WhatIf] [<CommonParameters>]





DESCRIPTION

This function disables a Jenkins Job.





PARAMETERS

-Confirm [<SwitchParameter>]

Prompts you for confirmation before running the cmdlet.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-Credential <PSCredential>

Contains the credentials to use to authenticate with the Jenkins Master server.



Required? false

Position? 2

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Crumb <String>

Contains a Crumb to pass to the Jenkins Master Server if CSRF is enabled.



Required? false

Position? 3

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Folder <String>

The optional job folder to look for the job in. This requires the Jobs Plugin to be installed on Jenkins.



Required? false

Position? 4

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Name <String>

The name of the job to disable.



Required? true

Position? 5

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Uri <String>

Contains the Uri to the Jenkins Master server to disable the job on.



Required? true

Position? 1

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-WhatIf [<SwitchParameter>]

Shows what would happen if the cmdlet runs. The cmdlet is not run.



Required? false

Position? named

Default value False

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

None







OUTPUTS

System.String







NOTES









-------------------------- Example 1 --------------------------



PS C:\\> {{ Add example code here }}



{{ Add example description here }}



RELATED LINKS