Exit status of "puppet agent --test"

62 views
Skip to first unread message

Chris Ritson

unread,
Apr 3, 2023, 5:48:11 AM4/3/23
to puppet...@googlegroups.com
Does a manual puppet agent run (puppet agent --test) have a defined exit status to indicate if errors were detected? This is not described by the built-in help. In two test cases, I have only seen a return code of 2. Both runs made some changes. One had warnings, the other didn't.

--
Chris Ritson (School of Computing and NUIT Cybersecurity team)
Newcastle University, NE1 7RU
Tel: +44(0)1912080073

Marty Ewings

unread,
Apr 3, 2023, 5:51:46 AM4/3/23
to Puppet Users

Yes it does, please see https://www.puppet.com/docs/puppet/7/man/agent.html#usage-notes excerpt below:

'--test' runs once in the foreground with verbose logging, then exits. It also exits if it can't get a valid catalog. --test includes the '--detailed-exitcodes' option by default and exits with one of the following exit codes:

  • 0: The run succeeded with no changes or failures; the system was already in the desired state.

  • 1: The run failed, or wasn't attempted due to another run already in progress.

  • 2: The run succeeded, and some resources were changed.

  • 4: The run succeeded, and some resources failed.

  • 6: The run succeeded, and included both changes and failures.

Marty

Will McDonald

unread,
Apr 3, 2023, 5:52:42 AM4/3/23
to puppet...@googlegroups.com
https://www.puppet.com/docs/puppet/7/man/agent.html#options 

--detailed-exitcodes looks like it might help?

--
You received this message because you are subscribed to the Google Groups "Puppet Users" group.
To unsubscribe from this group and stop receiving emails from it, send an email to puppet-users...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/puppet-users/LO2P302MB004479A539180A1C626DE416C6929%40LO2P302MB0044.GBRP302.PROD.OUTLOOK.COM.

Dirk Heinrichs

unread,
Apr 3, 2023, 5:53:37 AM4/3/23
to puppet...@googlegroups.com
Am Montag, dem 03.04.2023 um 09:47 +0000 schrieb Chris Ritson:

Does a manual puppet agent run (puppet agent --test) have a defined exit status to indicate if errors were detected? This is not described by the built-in help.

Yes, it is:

* --detailed-exitcodes:
  Provide extra information about the run via exit codes; works only if '--test' or '--onetime' is also specified. If enabled, 'puppet agent' uses the following exit codes:

0: The run succeeded with no changes or failures; the system was already in the desired state.
1: The run failed, or wasn't attempted due to another run already in progress.
2: The run succeeded, and some resources were changed.
4: The run succeeded, and some resources failed.
6: The run succeeded, and included both changes and failures.

HTH...

Dirk
-- 
Dirk Heinrichs
Senior Systems Engineer, Delivery Pipeline
OpenText ™ Discovery | Recommind
Phone: +49 2226 15966 18
Email: dhei...@opentext.com
Website: www.recommind.de
Recommind GmbH, Von-Liebig-Straße 1, 53359 Rheinbach
Vertretungsberechtigte Geschäftsführer Gordon Davies, Madhu
Ranganathan, Christian Waida, Registergericht Amtsgericht Bonn,
Registernummer HRB 10646
This e-mail may contain confidential and/or privileged information. If
you are not the intended recipient (or have received this e-mail in
error) please notify the sender immediately and destroy this e-mail.
Any unauthorized copying, disclosure or distribution of the material in
this e-mail is strictly forbidden
Diese E-Mail enthält vertrauliche und/oder rechtlich geschützte
Informationen. Wenn Sie nicht der richtige Adressat sind oder diese E-
Mail irrtümlich erhalten haben, informieren Sie bitte sofort den
Absender und vernichten Sie diese Mail. Das unerlaubte Kopieren sowie
die unbefugte Weitergabe dieser Mail sind nicht gestattet.
Reply all
Reply to author
Forward
0 new messages