community.general.jira – create and modify issues in a JIRA instance

Note

This plugin is part of the community.general collection (version 3.8.1).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install community.general.

To use it in a playbook, specify: community.general.jira.

Synopsis

Create and modify issues in a JIRA instance.

Parameters

Parameter		Choices/Defaults	Comments
account_id string added in 2.5.0 of community.general			Sets the account identifier for the assignee when operation is `create`, `transition` or `edit`. Note that JIRA may not allow changing field values on specific transitions or states.
assignee string			Sets the the assignee when operation is `create`, `transition` or `edit`. Recent versions of JIRA no longer accept a user name as a user identifier. In that case, use account_id instead. Note that JIRA may not allow changing field values on specific transitions or states.
attachment dictionary added in 2.5.0 of community.general			Information about the attachment being uploaded.
	content string		The Base64 encoded contents of the file to attach. If not specified, the contents of filename will be used instead.
	filename path / required		The path to the file to upload (from the remote node) or, if content is specified, the filename to use for the attachment.
	mimetype string		The MIME type to supply for the upload. If not specified, best-effort detection will be done.
comment string			The comment text to add. Note that JIRA may not allow changing field values on specific transitions or states.
comment_visibility dictionary added in 3.2.0 of community.general			Used to specify comment comment visibility. See https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-issue-comments/#api-rest-api-2-issue-issueidorkey-comment-post for details.
	type string / required	Choices: group role	Use type to specify which of the JIRA visibility restriction types will be used.
	value string / required		Use value to specify value corresponding to the type of visibility restriction. For example name of the group or role.
description string			The issue description, where appropriate. Note that JIRA may not allow changing field values on specific transitions or states.
fields dictionary			This is a free-form data structure that can contain arbitrary data. This is passed directly to the JIRA REST API (possibly after merging with other required data, as when passed to create). See examples for more information, and the JIRA REST API for the structure required for various fields. Note that JIRA may not allow changing field values on specific transitions or states.
inwardissue string			Set issue from which link will be created.
issue string			An existing issue key to operate on. aliases: ticket
issuetype string			The issue type, for issue creation.
jql string added in 0.2.0 of community.general			Query JIRA in JQL Syntax, e.g. 'CMDB Hostname'='test.example.com'.
linktype string			Set type of link, when action 'link' selected.
maxresults integer added in 0.2.0 of community.general			Limit the result of operation=search. If no value is specified, the default jira limit will be used. Used when operation=search only, ignored otherwise.
operation string / required		Choices: attach comment create edit fetch link search transition update	The operation to perform. aliases: command
outwardissue string			Set issue to which link will be created.
password string / required			The password to log-in with.
project string			The project for this operation. Required for issue creation.
status string			Only used when operation is `transition`, and a bit of a misnomer, it actually refers to the transition name.
summary string			The issue summary, where appropriate. Note that JIRA may not allow changing field values on specific transitions or states.
timeout float		Default: 10	Set timeout, in seconds, on requests to JIRA API.
uri string / required			Base URI for the JIRA instance.
username string / required			The username to log-in with.
validate_certs boolean		Choices: no yes ←	Require valid SSL certificates (set to `false` if you'd like to use self-signed certificates)

Notes

Note

Currently this only works with basic-auth.
To use with JIRA Cloud, pass the login e-mail as the username and the API token as password.

Examples

# Create a new issue and add a comment to it:
- name: Create an issue
  community.general.jira:
    uri: '{{ server }}'
    username: '{{ user }}'
    password: '{{ pass }}'
    project: ANS
    operation: create
    summary: Example Issue
    description: Created using Ansible
    issuetype: Task
  args:
    fields:
        customfield_13225: "test"
        customfield_12931: {"value": "Test"}
  register: issue

- name: Comment on issue
  community.general.jira:
    uri: '{{ server }}'
    username: '{{ user }}'
    password: '{{ pass }}'
    issue: '{{ issue.meta.key }}'
    operation: comment
    comment: A comment added by Ansible

- name: Comment on issue with restricted visibility
  community.general.jira:
    uri: '{{ server }}'
    username: '{{ user }}'
    password: '{{ pass }}'
    issue: '{{ issue.meta.key }}'
    operation: comment
    comment: A comment added by Ansible
    comment_visibility:
      type: role
      value: Developers

# Assign an existing issue using edit
- name: Assign an issue using free-form fields
  community.general.jira:
    uri: '{{ server }}'
    username: '{{ user }}'
    password: '{{ pass }}'
    issue: '{{ issue.meta.key}}'
    operation: edit
    assignee: ssmith

# Create an issue with an existing assignee
- name: Create an assigned issue
  community.general.jira:
    uri: '{{ server }}'
    username: '{{ user }}'
    password: '{{ pass }}'
    project: ANS
    operation: create
    summary: Assigned issue
    description: Created and assigned using Ansible
    issuetype: Task
    assignee: ssmith

# Edit an issue
- name: Set the labels on an issue using free-form fields
  community.general.jira:
    uri: '{{ server }}'
    username: '{{ user }}'
    password: '{{ pass }}'
    issue: '{{ issue.meta.key }}'
    operation: edit
  args:
    fields:
        labels:
          - autocreated
          - ansible

# Updating a field using operations: add, set & remove
- name: Change the value of a Select dropdown
  community.general.jira:
    uri: '{{ server }}'
    username: '{{ user }}'
    password: '{{ pass }}'
    issue: '{{ issue.meta.key }}'
    operation: update
  args:
    fields:
      customfield_12931: [ {'set': {'value': 'Virtual'}} ]
      customfield_13820: [ {'set': {'value':'Manually'}} ]
  register: cmdb_issue
  delegate_to: localhost


# Retrieve metadata for an issue and use it to create an account
- name: Get an issue
  community.general.jira:
    uri: '{{ server }}'
    username: '{{ user }}'
    password: '{{ pass }}'
    project: ANS
    operation: fetch
    issue: ANS-63
  register: issue

# Search for an issue
# You can limit the search for specific fields by adding optional args. Note! It must be a dict, hence, lastViewed: null
- name: Search for an issue
  community.general.jira:
    uri: '{{ server }}'
    username: '{{ user }}'
    password: '{{ pass }}'
    project: ANS
    operation: search
    maxresults: 10
    jql: project=cmdb AND cf[13225]="test"
  args:
    fields:
      lastViewed: null
  register: issue

- name: Create a unix account for the reporter
  become: true
  user:
    name: '{{ issue.meta.fields.creator.name }}'
    comment: '{{ issue.meta.fields.creator.displayName }}'

# You can get list of valid linktypes at /rest/api/2/issueLinkType
# url of your jira installation.
- name: Create link from HSP-1 to MKY-1
  community.general.jira:
    uri: '{{ server }}'
    username: '{{ user }}'
    password: '{{ pass }}'
    operation: link
    linktype: Relates
    inwardissue: HSP-1
    outwardissue: MKY-1

# Transition an issue
- name: Resolve the issue
  community.general.jira:
    uri: '{{ server }}'
    username: '{{ user }}'
    password: '{{ pass }}'
    issue: '{{ issue.meta.key }}'
    operation: transition
    status: Resolve Issue
    account_id: 112233445566778899aabbcc
    fields:
      resolution:
        name: Done
      description: I am done! This is the last description I will ever give you.

# Attach a file to an issue
- name: Attach a file
  community.general.jira:
    uri: '{{ server }}'
    username: '{{ user }}'
    password: '{{ pass }}'
    issue: HSP-1
    operation: attach
    attachment:
      filename: topsecretreport.xlsx

Authors

Steve Smith (@tarka)
Per Abildgaard Toft (@pertoft)
Brandon McNama (@DWSR)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/jira_module.html

Docs

Docs4dev

Title here