Class: Ansible::Ruby::Modules::Jenkins_job

Inherits:

Base

• Object
• Ansible::Ruby::Models::Base
• Base
• Ansible::Ruby::Modules::Jenkins_job

Defined in:

lib/ansible/ruby/modules/generated/web_infrastructure/jenkins_job.rb

Overview

Manage Jenkins jobs by using Jenkins REST API.

Instance Method Summary

• #config ⇒ String^?

  Config in XML format.,Required if job does not yet exist.,Mutually exclusive with C(enabled).,Considered if C(state=present).

• #enabled ⇒ Symbol^?

  Whether the job should be enabled or disabled.,Mutually exclusive with C(config).,Considered if C(state=present).

• #name ⇒ String

  Name of the Jenkins job.

• #password ⇒ String^?

  Password to authenticate with the Jenkins server.

• #state ⇒ :present, ...

  Attribute that specifies if the job has to be created or deleted.

• #token ⇒ String^?

  API token used to authenticate alternatively to password.

• #url ⇒ String^?

  URL where the Jenkins server is accessible.

• #user ⇒ String^?

  User to authenticate with the Jenkins server.

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, fix_inclusion, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#config ⇒ String^?

Returns config in XML format.,Required if job does not yet exist.,Mutually exclusive with C(enabled).,Considered if C(state=present).

Returns:

• (String, nil) —

  config in XML format.,Required if job does not yet exist.,Mutually exclusive with C(enabled).,Considered if C(state=present).

# File 'lib/ansible/ruby/modules/generated/web_infrastructure/jenkins_job.rb', line 12

attribute :config

#enabled ⇒ Symbol^?

Returns Whether the job should be enabled or disabled.,Mutually exclusive with C(config).,Considered if C(state=present).

Returns:

• (Symbol, nil) —

  Whether the job should be enabled or disabled.,Mutually exclusive with C(config).,Considered if C(state=present).

# File 'lib/ansible/ruby/modules/generated/web_infrastructure/jenkins_job.rb', line 16

attribute :enabled

#name ⇒ String

Returns Name of the Jenkins job.

Returns:

• (String) —

  Name of the Jenkins job.

# File 'lib/ansible/ruby/modules/generated/web_infrastructure/jenkins_job.rb', line 20

attribute :name

#password ⇒ String^?

Returns Password to authenticate with the Jenkins server.

Returns:

• (String, nil) —

  Password to authenticate with the Jenkins server.

# File 'lib/ansible/ruby/modules/generated/web_infrastructure/jenkins_job.rb', line 24

attribute :password

#state ⇒ :present, ...

Returns Attribute that specifies if the job has to be created or deleted.

Returns:

• (:present, :absent, nil) —

  Attribute that specifies if the job has to be created or deleted.

# File 'lib/ansible/ruby/modules/generated/web_infrastructure/jenkins_job.rb', line 28

attribute :state

#token ⇒ String^?

Returns API token used to authenticate alternatively to password.

Returns:

• (String, nil) —

  API token used to authenticate alternatively to password.

# File 'lib/ansible/ruby/modules/generated/web_infrastructure/jenkins_job.rb', line 32

attribute :token

#url ⇒ String^?

Returns URL where the Jenkins server is accessible.

Returns:

• (String, nil) —

  URL where the Jenkins server is accessible.

# File 'lib/ansible/ruby/modules/generated/web_infrastructure/jenkins_job.rb', line 36

attribute :url

#user ⇒ String^?

Returns User to authenticate with the Jenkins server.

Returns:

• (String, nil) —

  User to authenticate with the Jenkins server.

# File 'lib/ansible/ruby/modules/generated/web_infrastructure/jenkins_job.rb', line 40

attribute :user