< Back

Get-JenkinsPluginsList

Wed Jan 15, 2020 10:31 am

NAME Get-JenkinsPluginsList



SYNOPSIS

Get a list of installed plugins in a Jenkins master server.





SYNTAX

Get-JenkinsPluginsList [-Uri] <String> [[-Credential] <PSCredential>] [[-Crumb] <String>] [[-Api] <String>]

[[-Depth] <String>] [<CommonParameters>]





DESCRIPTION

Returns the list of installed plugins from a jenkins server, the list containing the name and version of each

plugin.





PARAMETERS

-Uri <String>

Contains the Uri to the Jenkins Master server to execute the command on.



Required? true

Position? 2

Default value None

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? 3

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? 4

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Api <String>

The API to use. Can be XML, JSON or Python. Defaults to JSON.



Required? false

Position? 5

Default value Json

Accept pipeline input? False

Accept wildcard characters? false



-Depth <String>

The depth of the tree to return (must be at least 1). Defaults to 1.



Required? false

Position? 6

Default value 1

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



OUTPUTS

An array of Jenkins objects.







NOTES









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



PS C:\\>$Plugins = Get-JenkinsPluginsList `

-Uri 'https://jenkins.contoso.com' \\`

-Credential (Get-Credential) \\`

-Verbose



Returns the list of installed plugins on https://jenkins.contoso.com using the credentials provided by the user.



RELATED LINKS