.nh
.TH "apptainer" "1" "Apr 2024" "Auto generated by spf13/cobra" ""

.SH NAME
.PP
apptainer-instance-stop - Stop a named instance of a given container image


.SH SYNOPSIS
.PP
\fBapptainer instance stop [stop options...] [instance]\fP


.SH DESCRIPTION
.PP
The command apptainer instance stop allows you to stop and clean up a named,
  running instance of a given container image.


.SH OPTIONS
.PP
\fB-a\fP, \fB--all\fP[=false]
	stop all user's instances

.PP
\fB-F\fP, \fB--force\fP[=false]
	force kill instance

.PP
\fB-h\fP, \fB--help\fP[=false]
	help for stop

.PP
\fB-s\fP, \fB--signal\fP=""
	signal sent to the instance

.PP
\fB-t\fP, \fB--timeout\fP=10
	force kill non stopped instances after X seconds

.PP
\fB-u\fP, \fB--user\fP=""
	if running as root, stop instances belonging to user


.SH EXAMPLE
.EX

  $ apptainer instance start my-sql.sif mysql1
  $ apptainer instance start my-sql.sif mysql2
  $ apptainer instance stop mysql*
  Stopping mysql1 instance of my-sql.sif (PID=23845)
  Stopping mysql2 instance of my-sql.sif (PID=23858)

  $ apptainer instance start my-sql.sif mysql1

  Force instance to shutdown
  $ apptainer instance stop -f mysql1 (may corrupt data)

  Send SIGTERM to the instance
  $ apptainer instance stop -s SIGTERM mysql1
  $ apptainer instance stop -s TERM mysql1
  $ apptainer instance stop -s 15 mysql1

.EE


.SH SEE ALSO
.PP
\fBapptainer-instance(1)\fP


.SH HISTORY
.PP
1-Apr-2024 Auto generated by spf13/cobra