unixadm.jenkins

 

lookup

version - return this collection's version

Synopsis

Returns this collection's version

Examples
---
- assert:
    that: "lookup('unixadm.jenkins.version') is version_compare('0.0.1', '>=')"
Return values
Key Returned Description
_raw Success version string

modules

jenkins_credentials - This module creates or deletes a credential

Synopsis

this module creates or deletes a credential

Parameters
Parameter Choices/Defaults Description
domain
(string)
(global) credential domain
key
(string)
the user's ssh key
mutually exclusive with password
name
(string)
required
the user@domain combination to retrieve the id for
passphrase
(string)
the user's ssh key's passphrase
must be specified when key is used
password
(string)
the user's password
mutually exclusive with key
scope
(string)
GLOBAL
SYSTEM
credential scope
ssh_host
(string)
localhost jenkins ssh hostname
ssh_key
(string)
jenkins ssh private key as string
ssh_key_file
(string)
path to the jenkins ssh private key file
ssh_key_passphrase
(string)
passphrase for private key decryption
ssh_pass
(string)
jenkins ssh password
ssh_user
(string)
jenkins jenkins ssh username
state
(string)
present
absent
create ("present") or remove ("absent") the given credential domain

jenkins_credentials_domain - This module creates or deletes a credential domain

Synopsis

this module creates or deletes a credential domain

Parameters
Parameter Choices/Defaults Description
description
(string)
the domain's description
excludes
(string)
something
includes
(string)
something
name
(string)
required
the credential domain name
ssh_host
(string)
localhost jenkins ssh hostname
ssh_key
(string)
jenkins ssh private key as string
ssh_key_file
(string)
path to the jenkins ssh private key file
ssh_key_passphrase
(string)
passphrase for private key decryption
ssh_pass
(string)
jenkins ssh password
ssh_user
(string)
jenkins jenkins ssh username
state
(string)
present
absent
create ("present") or remove ("absent") the given credential domain

jenkins_credentials_id - This module retrieves the credential id

Synopsis

this module retrieves the credential id for a given name (user@domain)

Parameters
Parameter Choices/Defaults Description
name
(string)
required
the user@domain combination to retrieve the id for
ssh_host
(string)
localhost jenkins ssh hostname
ssh_key
(string)
jenkins ssh private key as string
ssh_key_file
(string)
path to the jenkins ssh private key file
ssh_key_passphrase
(string)
passphrase for private key decryption
ssh_pass
(string)
jenkins ssh password
ssh_user
(string)
jenkins jenkins ssh username

jenkins_keypair - generates a keypair for jenkins

Synopsis

generates and returns the jenkins master keypair

Parameters
Parameter Choices/Defaults Description
path
(string)
path to the secrets path (usually /var/lib/jenkins/secrets)

jenkins_plugin - installs a jenkins plugin

Synopsis

installs a jenkins plugin together with its dependencies

Parameters
Parameter Choices/Defaults Description
cache
(string)
path for the updatecenter cache
jenkins_home
(string)
jenkins home directory
name
(string)
name of the plugin to install
state
(string)
install (present) or uninstall (absent) plugin
timeout
(string)
timeout for retrieving the updatecenter information and the plugin file
updates_url
(string)
updatecenter url