bugzilla - Man Page

command-line interface to Bugzilla over XML-RPC


bugzilla [options] [command] [command-options]


bugzilla is a command-line utility that allows access to the XML-RPC interface provided by Bugzilla.

command is one of:
* login - log into the given bugzilla instance
* new - create a new bug
* query - search for bugs matching given criteria
* modify - modify existing bugs
* attach - attach files to existing bugs, or get attachments
* info - get info about the given bugzilla instance

Global Options


show program's version number and exit

--help, -h

show this help message and exit


bugzilla XMLRPC URI. default: https://bugzilla.redhat.com/xmlrpc.cgi


Don't error on invalid bugzilla SSL certificate


client side certificate file needed by the webserver.


Run interactive "login" before performing the specified command.


Log in with this username


Log in with this password


The session (login token) will be restricted to the current IP address.


Raise an error if we aren't logged in to bugzilla. Consider using this if you are depending on cached credentials, to ensure that when they expire the tool errors, rather than subtly change output.


Don't save any bugzilla cookies or tokens to disk, and don't use any pre-existing credentials.


cookie file to use for bugzilla authentication


token file to use for bugzilla authentication


give more info about what's going on


output bunches of debugging info


show program's version number and exit

Standard bugzilla options

These options are shared by some combination of the 'new', 'query', and 'modify' sub commands. Not every option works for each command though.

--product=PRODUCT, -p PRODUCT

Product name

--version=VERSION, -v VERSION

Product version


Component name

--summary=SUMMARY, -s SUMMARY, --short_desc=SUMMARY

Bug summary


Set initial bug comment/description


Comment tag for the new comment


RHBZ sub component name

--os=OS, -o OS

Operating system


Arch this bug occurs on

--severity=SEVERITY, -x SEVERITY

Bug severity

--priority=PRIORITY, -z PRIORITY

Bug priority


Bug alias (name)

--status=STATUS, -s STATUS, --bug_status=STATUS

Bug status (NEW, ASSIGNED, etc.)

--url=URL, -u URL

URL for further bug info


Target milestone


RHBZ Target release

--blocked=BUGID[, BUGID, ...]

Bug IDs that this bug blocks

--dependson=BUGID[, BUGID, ...]

Bug IDs that this bug depends on

--keywords=KEYWORD[, KEYWORD, ...]

Bug keywords

--groups=GROUP[, GROUP, ...]

Which user groups can view this bug

--cc=CC[, CC, ...]

CC list

--assigned_to=ASSIGNED_TO, -a ASSIGNED_TO, --assignee ASSIGNED_TO

Bug assignee

--qa_contact=QA_CONTACT, -q QA_CONTACT

QA contact


Set or unset a flag. For example, to set a flag named devel_ack, do --flag devel_ack+  Unset a flag with the 'X' value, like --flag needinfoX


Set (personal) tags field

--whiteboard WHITEBOARD, -w WHITEBOARD, --status_whiteboard WHITEBOARD

Whiteboard field

--devel_whiteboard DEVEL_WHITEBOARD

RHBZ devel whiteboard field

--internal_whiteboard INTERNAL_WHITEBOARD

RHBZ internal whiteboard field

--qa_whiteboard QA_WHITEBOARD

RHBZ QA whiteboard field

--fixed_in FIXED_IN, -F FIXED_IN

RHBZ 'Fixed in version' field


Manually specify a bugzilla XMLRPC field. FIELD is the raw name used by the bugzilla instance. For example if your bugzilla instance has a custom field cf_my_field, do: --field cf_my_field=VALUE

Output options

These options are shared by several commands, for tweaking the text output of the command results.

--full, -f

output detailed bug info

--ids, -i

output only bug IDs

--extra, -e

output additional bug information (keywords, Whiteboards, etc.)


one line summary of the bug (useful for scripts)


raw output of the bugzilla contents


Print output in the form given. You can use RPM-style tags that match bug fields, e.g.: '%{id}: %{summary}'.

The output of the bugzilla tool should NEVER BE PARSED unless you are using a custom --outputformat. For everything else, just don't parse it, the formats are not stable and are subject to change.

--outputformat allows printing arbitrary bug data in a user preferred format. For example, to print a returned bug ID, component, and product, separated with ::, do:

--outputformat "%{id}::%{component}::%{product}"

The fields (like 'id', 'component', etc.) are the names of the values returned by bugzilla's XMLRPC interface. To see a list of all fields, check the API documentation in the 'See Also' section. Alternatively, run a 'bugzilla --debug query ...' and look at the key names returned in the query results. Also, in most cases, using the name of the associated command line switch should work, like --bug_status becomes %{bug_status}, etc.

‘query’ specific options

Certain options can accept a comma separated list to query multiple values, including --status, --component, --product, --version, --id.

Note: querying via explicit command line options will only get you so far. See the --from-url option for a way to use powerful Web UI queries from the command line.

--id ID, -b ID, --bug_id ID

specify individual bugs by IDs, separated with commas

--reporter REPORTER, -r REPORTER

Email: search reporter email for given address

--quicksearch QUICKSEARCH

Search using bugzilla's quicksearch functionality.

--savedsearch SAVEDSEARCH

Name of a bugzilla saved search. If you don't own this saved search, you must passed --savedsearch_sharer_id.

--savedsearch-sharer-id SAVEDSEARCH_SHARER_ID

Owner ID of the --savedsearch. You can get this ID from the URL bugzilla generates when running the saved search from the web UI.

--from-url WEB_QUERY_URL

Make a working query via bugzilla's 'Advanced search' web UI, grab the url from your browser (the string with query.cgi or buglist.cgi in it), and --from-url will run it via the bugzilla API. Don't forget to quote the string! This only works for Bugzilla 5 and Red Hat bugzilla

‘modify’ specific options

Fields that take multiple values have a special input format.

Append:    --cc=foo@example.com
Overwrite: --cc==foo@example.com
Remove:    --cc=-foo@example.com

Options that accept this format: --cc, --blocked, --dependson, --groups, --tags, whiteboard fields.


Close with the given resolution (WONTFIX, NOTABUG, etc.)


ID of original bug. Implies --close DUPLICATE


Mark new comment as private


Reset assignee to component default


Reset QA contact to component default

‘attach’ options


File to attach, or filename for data provided on stdin


A short description of the file being attached


Mime-type for the file being attached


Download the attachment with the given ID

--getall=BUGID, --get-all=BUGID

Download all attachments on the given bug

--comment=COMMENT, -l COMMENT

Add comment with attachment

‘info’ options

--products, -p

Get a list of products

--components=PRODUCT, -c PRODUCT

List the components in the given product

--component_owners=PRODUCT, -o PRODUCT

List components (and their owners)

--versions=PRODUCT, -v PRODUCT

List the versions for the given product


Only show active components. Combine with --components*

Authentication Cache and API Keys

Some command usage will require an active login to the bugzilla instance. For example, if the bugzilla instance has some private bugs, those bugs will be missing from 'query' output if you do not have an active login.

If you are connecting to a bugzilla 5.0 or later instance, the best option is to use bugzilla API keys. From the bugzilla web UI, log in, navigate to Preferences->API Keys, and generate a key (it will be a long string of characters and numbers). Then create a ~/.config/python-bugzilla/bugzillarc like this:

 $ cat ~/.config/python-bugzilla/bugzillarc

Replace 'bugzilla.example.com' with your bugzilla host name, and YOUR_API_KEY with the generated API Key from the Web UI.

For older bugzilla instances, you will need to cache a login cookie or token with the "login" subcommand or the "--login" argument.

Additionally, the --no-cache-credentials option will tell the bugzilla tool to _not_ save or use any authentication cache, including the bugzillarc file.


bugzilla query --bug_id 62037

bugzilla query --version 15 --component python-bugzilla

# All boolean options can be formatted like this
bugzilla query --blocked "123456 | 224466"

bugzilla login

bugzilla new -p Fedora -v rawhide -c python-bugzilla \
        --summary "python-bugzilla causes headaches" \
        --comment "python-bugzilla made my brain hurt when I used it."

bugzilla attach --file ~/Pictures/cam1.jpg --desc "me, in pain" $BUGID

bugzilla attach --getall $BUGID

bugzilla modify --close NOTABUG --comment "Actually, you're hungover." $BUGID

Exit Status

bugzilla normally returns 0 if the requested command was successful. Otherwise, exit status is 1 if bugzilla is interrupted by the user (or a login attempt fails), 2 if a socket error occurs (e.g. TCP connection timeout), and 3 if the server returns an XML-RPC fault.


Please report any bugs as github issues at
to the mailing list at

See Also


Referenced By


Mar 30, 2017 version 2.1.0