1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080
|
.TH squeue "1" "Slurm Commands" "December 2024" "Slurm Commands"
.SH "NAME"
squeue \- view information about jobs located in the Slurm scheduling queue.
.SH "SYNOPSIS"
\fBsqueue\fR [\fIOPTIONS\fR...]
.SH "DESCRIPTION"
\fBsqueue\fR is used to view job and job step information for jobs managed by
Slurm.
.SH "OPTIONS"
.TP
\fB\-A\fR, \fB\-\-account\fR=<\fIaccount_list\fR>
Specify the accounts of the jobs to view. Accepts a comma separated
list of account names. This has no effect when listing job steps.
.IP
.TP
\fB\-a\fR, \fB\-\-all\fR
Display information about jobs and job steps in all partitions.
This causes information to be displayed about partitions that are configured as
hidden, partitions that are unavailable to a user's group, and federated jobs
that are in a "revoked" state.
.IP
.TP
\fB\-r\fR, \fB\-\-array\fR
Display one job array element per line.
Without this option, the display will be optimized for use with job arrays
(pending job array elements will be combined on one line of output with the
array index values printed using a regular expression).
.IP
.TP
\fB\-M\fR, \fB\-\-clusters\fR=<\fIcluster_name\fR>
Clusters to issue commands to. Multiple cluster names may be comma separated.
A value of '\fIall\fR' will query to run on all clusters.
Note that the \fBslurmdbd\fR must be up for this option to work properly, unless
running in a federation with either \fBFederationParameters=fed_display\fR
configured or the \fB\-\-federation\fR option set.
This option implicitly sets the \fB\-\-local\fR option.
.IP
.TP
\fB\-\-expand\-patterns\fR
Expand any filename patterns from in \f3StdOut\fP, \f3StdErr\fP and \f3StdIn\fP.
Fields that map to a range of values will use the first value of the range. For
example "%t" for task id will be replaced by "0".
.IP
.TP
\fB\-\-federation\fR
Show jobs from the federation if a member of one.
.IP
.TP
\fB\-o\fR, \fB\-\-format\fR=<\fIoutput_format\fR>
Specify the information to be displayed, its size and position
(right or left justified).
Also see the \fB\-O\fR, \fB\-\-Format\fR=<\fIoutput_format\fR>
option described below (which supports less flexibility in formatting, but
supports access to all fields).
If the command is executed in a federated cluster environment and information
about more than one cluster is to be displayed and the \fB\-h, \-\-noheader\fR
option is used, then the cluster name will be displayed before the default
output formats shown below.
The default formats with various options are:
.IP
.RS
.TP 15
\fIdefault\fR
"%.18i %.9P %.8j %.8u %.2t %.10M %.6D %R"
.IP
.TP
\fI\-l, \-\-long\fR
"%.18i %.9P %.8j %.8u %.8T %.10M %.9l %.6D %R"
.IP
.TP
\fI\-s, \-\-steps\fR
"%.15i %.8j %.9P %.8u %.9M %N"
.IP
.RE
The format of each field is "%[[.]size]type[suffix]"
.IP
.RS 10
.TP
\fIsize\fR
Minimum field size. If no size is specified, whatever is needed to print the
information will be used.
.IP
.TP
\fI.\fR
Indicates the output should be right justified and size must be specified.
By default output is left justified.
.IP
.TP
\fIsuffix\fR
Arbitrary string to append to the end of the field.
.IP
.RE
Note that many of these \fItype\fR specifications are valid
only for jobs while others are valid only for job steps.
Valid \fItype\fR specifications include:
.IP
.RS
.TP 6
\fB%all\fR
Print all fields available for this data type with a vertical bar separating
each field.
.IP
.TP
\fB%a\fR
Account associated with the job.
(Valid for jobs only)
.IP
.TP
\fB%A\fR
Number of tasks created by a job step.
This reports the value of the \fBsrun \-\-ntasks\fR option.
(Valid for job steps only)
.IP
.TP
\fB%A\fR
Job id.
This will have a unique value for each element of job arrays.
(Valid for jobs only)
.IP
.TP
\fB%B\fR
Executing (batch) host. For an allocated session, this is the host on which
the session is executing (i.e. the node from which the \fBsrun\fR or the
\fBsalloc\fR command was executed). For a batch job, this is the node executing
the batch script. In the case of a typical Linux cluster, this would be the
compute node zero of the allocation.
.IP
.TP
\fB%c\fR
Minimum number of CPUs (processors) per node requested by the job.
This reports the value of the \fBsrun \-\-mincpus\fR option with a
default value of zero.
(Valid for jobs only)
.IP
.TP
\fB%C\fR
Number of CPUs (processors) requested by the job or allocated to
it if already running. As a job is completing this number will
reflect the current number of CPUs allocated.
(Valid for jobs only)
.IP
.TP
\fB%d\fR
Minimum size of temporary disk space (in MB) requested by the job.
(Valid for jobs only)
.IP
.TP
\fB%D\fR
Number of nodes allocated to the job or the minimum number of nodes
required by a pending job. The actual number of nodes allocated to a pending
job may exceed this number if the job specified a node range count (e.g.
minimum and maximum node counts) or the job specifies a processor
count instead of a node count. As a job is completing this number will reflect
the current number of nodes allocated.
(Valid for jobs only)
.IP
.TP
\fB%e\fR
Time at which the job ended or is expected to end (based upon its time limit).
(Valid for jobs only)
.IP
.TP
\fB%E\fR
Job dependencies remaining. This job will not begin execution until these
dependent jobs complete. In the case of a job that can not run due to job
dependencies never being satisfied, the full original job dependency
specification will be reported. Once a dependency is satisfied, it is
removed from the job. A value of NULL implies this job has no
dependencies.
(Valid for jobs only)
.IP
.TP
\fB%f\fR
Features required by the job.
(Valid for jobs only)
.IP
.TP
\fB%F\fR
Job array's job ID. This is the base job ID.
For non\-array jobs, this is the job ID.
(Valid for jobs only)
.IP
.TP
\fB%g\fR
Group name of the job.
(Valid for jobs only)
.IP
.TP
\fB%G\fR
Group ID of the job.
(Valid for jobs only)
.IP
.TP
\fB%h\fR
Can the compute resources allocated to the job be over subscribed by other jobs.
The resources to be over subscribed can be nodes, sockets, cores, or
hyperthreads depending upon configuration.
The value will be "YES" if the job was submitted with the oversubscribe option
or the partition is configured with OverSubscribe=Force,
"NO" if the job requires exclusive node access,
"USER" if the allocated compute nodes are dedicated to a single user,
"MCS" if the allocated compute nodes are dedicated to a single security class
(See MCSPlugin and MCSParameters configuration parameters for more information),
"OK" otherwise (typically allocated dedicated CPUs),
(Valid for jobs only)
.IP
.TP
\fB%H\fR
Number of sockets per node requested by the job.
This reports the value of the \fBsrun \-\-sockets\-per\-node\fR option.
When \-\-sockets\-per\-node has not been set, "*" is displayed.
(Valid for jobs only)
.IP
.TP
\fB%i\fR
Job or job step id.
In the case of job arrays, the job ID format will be of the form
"<base_job_id>_<index>".
By default, the job array index field size will be limited to 64 bytes.
Use the environment variable SLURM_BITSTR_LEN to specify larger field sizes.
(Valid for jobs and job steps)
In the case of heterogeneous job allocations, the job ID format will be of the
form "#+#" where the first number is the "heterogeneous job leader" and the
second number the zero origin offset for each component of the job.
.IP
.TP
\fB%I\fR
Number of cores per socket requested by the job.
This reports the value of the \fBsrun \-\-cores\-per\-socket\fR option.
When \-\-cores\-per\-socket has not been set, "*" is displayed.
(Valid for jobs only)
.IP
.TP
\fB%j\fR
Job or job step name.
(Valid for jobs and job steps)
.IP
.TP
\fB%J\fR
Number of threads per core requested by the job.
This reports the value of the \fBsrun \-\-threads\-per\-core\fR option.
When \-\-threads\-per\-core has not been set, "*" is displayed.
(Valid for jobs only)
.IP
.TP
\fB%k\fR
Comment associated with the job.
(Valid for jobs only)
.IP
.TP
\fB%K\fR
Job array index.
By default, this field size will be limited to 64 bytes.
Use the environment variable SLURM_BITSTR_LEN to specify larger field sizes.
(Valid for jobs only)
.IP
.TP
\fB%l\fR
Time limit of the job or job step in days\-hours:minutes:seconds.
The value may be "NOT_SET" if not yet established or "UNLIMITED" for no limit.
(Valid for jobs and job steps)
.IP
.TP
\fB%L\fR
Time left for the job to execute in days\-hours:minutes:seconds.
This value is calculated by subtracting the job's time used from its time
limit.
The value may be "NOT_SET" if not yet established or "UNLIMITED" for no limit.
(Valid for jobs only)
.IP
.TP
\fB%m\fR
Minimum size of memory (in MB) requested by the job.
(Valid for jobs only)
If memory was request per CPU, or per GPU the value is shown
with the assumption that at least one CPU, GPU will be allocated
respectively.
.IP
.TP
\fB%M\fR
Time used by the job or job step in days\-hours:minutes:seconds.
The days and hours are printed only as needed.
For job steps this field shows the elapsed time since execution began
and thus will be inaccurate for job steps which have been suspended.
Clock skew between nodes in the cluster will cause the time to be inaccurate.
If the time is obviously wrong (e.g. negative), it displays as "INVALID".
(Valid for jobs and job steps)
.IP
.TP
\fB%n\fR
List of node names explicitly requested by the job.
(Valid for jobs only)
.IP
.TP
\fB%N\fR
List of nodes allocated to the job or job step. In the case of a
\fICOMPLETING\fR job, the list of nodes will comprise only those
nodes that have not yet been returned to service.
(Valid for jobs and job steps)
.IP
.TP
\fB%o\fR
The command to be executed.
.IP
.TP
\fB%O\fR
Are contiguous nodes requested by the job.
(Valid for jobs only)
.IP
.TP
\fB%p\fR
Priority of the job (converted to a floating point number between 0.0 and 1.0).
Also see \fB%Q\fR.
(Valid for jobs only)
.IP
.TP
\fB%P\fR
Partition of the job or job step.
(Valid for jobs and job steps)
.IP
.TP
\fB%q\fR
Quality of service associated with the job.
(Valid for jobs only)
.IP
.TP
\fB%Q\fR
Priority of the job (generally a very large unsigned integer).
Also see \fB%p\fR.
(Valid for jobs only)
.IP
.TP
\fB%r\fR
The reason a job is in its current state.
See the \fBJOB REASON CODES\fR section below for more information.
(Valid for jobs only)
.IP
.TP
\fB%R\fR
For pending jobs: the reason a job has not been started by the scheduler
is printed within parenthesis.
For terminated jobs with failure: an explanation as to why the
job failed is printed within parenthesis.
For all other job states: the list of allocate nodes.
See the \fBJOB REASON CODES\fR section below for more information.
(Valid for jobs only)
.IP
.TP
\fB%S\fR
Actual or expected start time of the job or job step.
(Valid for jobs and job steps)
.IP
.TP
\fB%t\fR
Job state in compact form.
See the \fBJOB STATE CODES\fR section below for a list of possible states.
(Valid for jobs only)
.IP
.TP
\fB%T\fR
Job state in extended form.
See the \fBJOB STATE CODES\fR section below for a list of possible states.
(Valid for jobs only)
.IP
.TP
\fB%u\fR
User name for a job or job step.
(Valid for jobs and job steps)
.IP
.TP
\fB%U\fR
User ID for a job or job step.
(Valid for jobs and job steps)
.IP
.TP
\fB%v\fR
Reservation for the job.
(Valid for jobs only)
.IP
.TP
\fB%V\fR
The job's submission time.
.IP
.TP
\fB%w\fR
Workload Characterization Key (wckey).
(Valid for jobs only)
.IP
.TP
\fB%W\fR
Licenses reserved for the job.
(Valid for jobs only)
.IP
.TP
\fB%x\fR
List of node names explicitly excluded by the job.
(Valid for jobs only)
.IP
.TP
\fB%X\fR
Count of cores reserved on each node for system use (core specialization).
(Valid for jobs only)
.IP
.TP
\fB%y\fR
Nice value (adjustment to a job's scheduling priority).
(Valid for jobs only)
.IP
.TP
\fB%Y\fR
For pending jobs, a list of the nodes expected to be used when the job is
started.
.IP
.TP
\fB%z\fR
Number of requested sockets, cores, and threads (S:C:T) per node for the job.
When (S:C:T) has not been set, "*" is displayed.
(Valid for jobs only)
.IP
.TP
\fB%Z\fR
The job's working directory.
.RE
.IP
.TP
\fB\-O\fR, \fB\-\-Format\fR=<\fIoutput_format\fR>
Specify the information to be displayed.
Also see the \fB\-o\fR, \fB\-\-format\fR=<\fIoutput_format\fR>
option described above (which supports greater flexibility in formatting, but
does not support access to all fields because we ran out of letters).
Requests a comma separated list of job information to be displayed.
The format of each field is "type[:[.][size][suffix]]"
.IP
.RS 10
.TP
\fIsize\fR
Minimum field size. If no size is specified, 20 characters will be allocated
to print the information.
.IP
.TP
\fI.\fR
Indicates the output should be right justified and size must be specified.
By default output is left justified.
.IP
.TP
\fIsuffix\fR
Arbitrary string to append to the end of the field.
.IP
.RE
Note that many of these \fItype\fR specifications are valid
only for jobs while others are valid only for job steps.
Valid \fItype\fR specifications include:
.IP
.RS
.TP 7
\fBAccount\fR
Print the account associated with the job.
(Valid for jobs only)
.IP
.TP
\fBAccrueTime\fR
Print the accrue time associated with the job.
(Valid for jobs only)
.IP
.TP
\fBadmin_comment\fR
Administrator comment associated with the job.
(Valid for jobs only)
.IP
.TP
\fBAllocNodes\fR
Print the nodes allocated to the job.
(Valid for jobs only)
.IP
.TP
\fBAllocSID\fR
Print the session ID used to submit the job.
(Valid for jobs only)
.IP
.TP
\fBArrayJobID\fR
Prints the job ID of the job array.
(Valid for jobs and job steps)
.IP
.TP
\fBArrayTaskID\fR
Prints the task ID of the job array.
(Valid for jobs and job steps)
.IP
.TP
\fBAssocID\fR
Prints the ID of the job association.
(Valid for jobs only)
.IP
.TP
\fBBatchFlag\fR
Prints whether the batch flag has been set.
(Valid for jobs only)
.IP
.TP
\fBBatchHost\fR
Executing (batch) host. For an allocated session, this is the host on which
the session is executing (i.e. the node from which the \fBsrun\fR or the
\fBsalloc\fR command was executed). For a batch job, this is the node executing
the batch script. In the case of a typical Linux cluster, this would be the
compute node zero of the allocation.
(Valid for jobs only)
.IP
.TP
\fBBoardsPerNode\fR
Prints the number of boards per node allocated to the job.
(Valid for jobs only)
.IP
.TP
\fBBurstBuffer\fR
Burst Buffer specification
(Valid for jobs only)
.IP
.TP
\fBBurstBufferState\fR
Burst Buffer state
(Valid for jobs only)
.IP
.TP
\fBCluster\fR
Name of the cluster that is running the job or job step.
.IP
.TP
\fBClusterFeature\fR
Cluster features required by the job.
(Valid for jobs only)
.IP
.TP
\fBCommand\fR
The command to be executed.
(Valid for jobs only)
.IP
.TP
\fBComment\fR
Comment associated with the job.
(Valid for jobs only)
.IP
.TP
\fBContiguous\fR
Are contiguous nodes requested by the job.
(Valid for jobs only)
.IP
.TP
\fBContainer\fR
OCI container bundle path.
.IP
.TP
\fBContainerID\fR
OCI container assigned ID.
.IP
.TP
\fBCores\fR
Number of cores per socket requested by the job.
This reports the value of the \fBsrun \-\-cores\-per\-socket\fR option.
When \fB\-\-cores\-per\-socket\fR has not been set, "*" is displayed.
(Valid for jobs only)
.IP
.TP
\fBCoreSpec\fR
Count of cores reserved on each node for system use (core specialization).
(Valid for jobs only)
.IP
.TP
\fBCPUFreq\fR
Prints the frequency of the allocated CPUs.
(Valid for job steps only)
.IP
.TP
\fBcpus\-per\-task\fR
Prints the number of CPUs per tasks allocated to the job.
(Valid for jobs only)
.IP
.TP
\fBcpus\-per\-tres\fR
Print the memory required per trackable resources allocated to the job or job step.
.IP
.TP
\fBDeadline\fR
Prints the deadline affected to the job
(Valid for jobs only)
.IP
.TP
\fBDelayBoot\fR
Delay boot time.
(Valid for jobs only)
.IP
.TP
\fBDependency\fR
Job dependencies remaining. This job will not begin execution until these
dependent jobs complete. In the case of a job that can not run due to job
dependencies never being satisfied, the full original job dependency
specification will be reported. Once a dependency is satisfied, it is
removed from the job. A value of NULL implies this job has no
dependencies.
(Valid for jobs only)
.IP
.TP
\fBDerivedEC\fR
The highest exit code returned by the job's job steps (srun invocations).
Following the colon is the signal that caused the process to terminate if
it was terminated by a signal.
(Valid for jobs only)
.IP
.TP
\fBEligibleTime\fR
Time the job is eligible for running.
(Valid for jobs only)
.IP
.TP
\fBEndTime\fR
The time of job termination, actual or expected.
(Valid for jobs only)
.IP
.TP
\fBExcNodes\fR
The nodes requested to be excluded when allocating this job.
(Valid for jobs only)
.IP
.TP
\fBexit_code\fR
The exit code returned by the job, typically as set by the exit() function.
Following the colon is the signal that caused the process to terminate if it was
terminated by a signal.
(Valid for jobs only)
.IP
.TP
\fBFeature\fR
Features required by the job.
(Valid for jobs only)
.IP
.TP
\fBGroupID\fR
Group ID of the job.
(Valid for jobs only)
.IP
.TP
\fBGroupName\fR
Group name of the job.
(Valid for jobs only)
.IP
.TP
\fBHetJobID\fR
Job ID of the heterogeneous job leader.
.IP
.TP
\fBHetJobIDSet\fR
Expression identifying all components job IDs within a heterogeneous job.
.IP
.TP
\fBHetJobOffset\fR
Zero origin offset within a collection of heterogeneous job components.
.IP
.TP
\fBJobArrayID\fR
Job array's job ID. This is the base job ID.
For non\-array jobs, this is the job ID.
(Valid for jobs only)
.IP
.TP
\fBJobID\fR
Job ID.
This will have a unique value for each element of job arrays and each
component of heterogeneous jobs.
(Valid for jobs only)
.IP
.TP
\fBLastSchedEval\fR
Prints the last time the job was evaluated for scheduling.
(Valid for jobs only)
.IP
.TP
\fBLicenses\fR
Licenses reserved for the job.
(Valid for jobs only)
.IP
.TP
\fBMaxCPUs\fR
Prints the max number of CPUs allocated to the job.
(Valid for jobs only)
.IP
.TP
\fBMaxNodes\fR
Prints the max number of nodes allocated to the job.
(Valid for jobs only)
.IP
.TP
\fBMCSLabel\fR
Prints the MCS_label of the job.
(Valid for jobs only)
.IP
.TP
\fBmem\-per\-tres\fR
Print the memory (in MB) required per trackable resources allocated to the job
or job step.
.IP
.TP
\fBMinCpus\fR
Minimum number of CPUs (processors) per node requested by the job.
This reports the value of the \fBsrun \-\-mincpus\fR option with a
default value of zero.
(Valid for jobs only)
.IP
.TP
\fBMinMemory\fR
Minimum size of memory (in MB) requested by the job.
(Valid for jobs only)
.IP
.TP
\fBMinTime\fR
Minimum time limit of the job
(Valid for jobs only)
.IP
.TP
\fBMinTmpDisk\fR
Minimum size of temporary disk space (in MB) requested by the job.
(Valid for jobs only)
.IP
.TP
\fBName\fR
Job or job step name.
(Valid for jobs and job steps)
.IP
.TP
\fBNetwork\fR
The network that the job is running on.
(Valid for jobs and job steps)
.IP
.TP
\fBNice\fR
Nice value (adjustment to a job's scheduling priority).
(Valid for jobs only)
.IP
.TP
\fBNodeList\fR
List of nodes allocated to the job or job step. In the case of a
\fICOMPLETING\fR job, the list of nodes will comprise only those
nodes that have not yet been returned to service.
(Valid for jobs only)
.IP
.TP
\fBNodes\fR
List of nodes allocated to the job or job step. In the case of a
\fICOMPLETING\fR job, the list of nodes will comprise only those
nodes that have not yet been returned to service.
(Valid job steps only)
.IP
.TP
\fBNTPerBoard\fR
The number of tasks per board allocated to the job.
(Valid for jobs only)
.IP
.TP
\fBNTPerCore\fR
The number of tasks per core allocated to the job.
(Valid for jobs only)
.IP
.TP
\fBNTPerNode\fR
The number of tasks per node allocated to the job.
(Valid for jobs only)
.IP
.TP
\fBNTPerSocket\fR
The number of tasks per socket allocated to the job.
(Valid for jobs only)
.IP
.TP
\fBNumCPUs\fR
Number of CPUs (processors) requested by the job or allocated to
it if already running. As a job is completing, this number will
reflect the current number of CPUs allocated.
(Valid for jobs and job steps)
.IP
.TP
\fBNumNodes\fR
Number of nodes allocated to the job or the minimum number of nodes
required by a pending job. The actual number of nodes allocated to a pending
job may exceed this number if the job specified a node range count (e.g.
minimum and maximum node counts) or the job specifies a processor
count instead of a node count. As a job is completing this number will reflect
the current number of nodes allocated.
(Valid for jobs only)
.IP
.TP
\fBNumTasks\fR
Number of tasks requested by a job or job step.
This reports the value of the \fB\-\-ntasks\fR option.
(Valid for jobs and job steps)
.IP
.TP
\fBOrigin\fR
Cluster name where federated job originated from.
(Valid for federated jobs only)
.IP
.TP
\fBOriginRaw\fR
Cluster ID where federated job originated from.
(Valid for federated jobs only)
.IP
.TP
\fBOverSubscribe\fR
Can the compute resources allocated to the job be over subscribed by other jobs.
The resources to be over subscribed can be nodes, sockets, cores, or
hyperthreads depending upon configuration.
The value will be "YES" if the job was submitted with the oversubscribe option
or the partition is configured with OverSubscribe=Force,
"NO" if the job requires exclusive node access,
"USER" if the allocated compute nodes are dedicated to a single user,
"MCS" if the allocated compute nodes are dedicated to a single security class
(See MCSPlugin and MCSParameters configuration parameters for more information),
"OK" otherwise (typically allocated dedicated CPUs),
(Valid for jobs only)
.IP
.TP
\fBPartition\fR
Partition of the job or job step.
(Valid for jobs and job steps)
.IP
.TP
\fBPendingTime\fR
The time (in seconds) between start time and submit time of the job.
If the job has not started yet, then the time (in seconds) between
now and the submit time of the job.
(Valid for jobs only)
.IP
.TP
\fBPreemptTime\fR
The preempt time for the job.
(Valid for jobs only)
.IP
.TP
\fBPrefer\fR
The preferred features of a pending job.
(Valid for jobs only)
.IP
.TP
\fBPriority\fR
Priority of the job (converted to a floating point number between 0.0 and 1.0).
Also see \fBprioritylong\fR.
(Valid for jobs only)
.IP
.TP
\fBPriorityLong\fR
Priority of the job (generally a very large unsigned integer).
Also see \fBpriority\fR.
(Valid for jobs only)
.IP
.TP
\fBProfile\fR
Profile of the job.
(Valid for jobs only)
.IP
.TP
\fBQOS\fR
Quality of service associated with the job.
(Valid for jobs only)
.IP
.TP
\fBReason\fR
The reason a job is in its current state.
See the \fBJOB REASON CODES\fR section below for more information.
(Valid for jobs only)
.IP
.TP
\fBReasonList\fR
For pending jobs: the reason a job is waiting for execution
is printed within parenthesis.
For terminated jobs with failure: an explanation as to why the
job failed is printed within parenthesis.
For all other job states: the list of allocate nodes.
See the \fBJOB REASON CODES\fR section below for more information.
(Valid for jobs only)
.IP
.TP
\fBReboot\fR
Indicates if the allocated nodes should be rebooted before starting the job.
(Valid on jobs only)
.IP
.TP
\fBReqNodes\fR
List of node names explicitly requested by the job.
(Valid for jobs only)
.IP
.TP
\fBReqSwitch\fR
The max number of requested switches by for the job.
(Valid for jobs only)
.IP
.TP
\fBRequeue\fR
Prints whether the job will be requeued on failure.
(Valid for jobs only)
.IP
.TP
\fBReservation\fR
Reservation for the job.
(Valid for jobs only)
.IP
.TP
\fBResizeTime\fR
The amount of time changed for the job to run.
(Valid for jobs only)
.IP
.TP
\fBRestartCnt\fR
The number of restarts for the job.
(Valid for jobs only)
.IP
.TP
\fBResvPort\fR
Reserved ports of the job.
(Valid for job steps only)
.IP
.TP
\fBSchedNodes\fR
For pending jobs, a list of the nodes expected to be used when the job is
started.
(Valid for jobs only)
.IP
.TP
\fBSCT\fR
Number of requested sockets, cores, and threads (S:C:T) per node for the job.
When (S:C:T) has not been set, "*" is displayed.
(Valid for jobs only)
.IP
.TP
\fBSiblingsActive\fR
Cluster names of where federated sibling jobs exist.
(Valid for federated jobs only)
.IP
.TP
\fBSiblingsActiveRaw\fR
Cluster IDs of where federated sibling jobs exist.
(Valid for federated jobs only)
.IP
.TP
\fBSiblingsViable\fR
Cluster names of where federated sibling jobs are viable to run.
(Valid for federated jobs only)
.IP
.TP
\fBSiblingsViableRaw\fR
Cluster IDs of where federated sibling jobs viable to run.
(Valid for federated jobs only)
.IP
.TP
\fBSockets\fR
Number of sockets per node requested by the job.
This reports the value of the \fBsrun \-\-sockets\-per\-node\fR option.
When \fB\-\-sockets\-per\-node\fR has not been set, "*" is displayed.
(Valid for jobs only)
.IP
.TP
\fBSPerBoard\fR
Number of sockets per board allocated to the job.
(Valid for jobs only)
.IP
.TP
\fBStartTime\fR
Actual or expected start time of the job or job step.
(Valid for jobs and job steps)
.IP
.TP
\fBState\fR
Job state in extended form.
See the \fBJOB STATE CODES\fR section below for a list of possible states.
(Valid for jobs only)
.IP
.TP
\fBStateCompact\fR
Job state in compact form.
See the \fBJOB STATE CODES\fR section below for a list of possible states.
(Valid for jobs only)
.IP
.TP
\fBSTDERR\fR
The directory for standard error to output to.
(Valid for jobs only)
.IP
.TP
\fBSTDIN\fR
The directory for standard in.
(Valid for jobs only)
.IP
.TP
\fBSTDOUT\fR
The directory for standard out to output to.
(Valid for jobs only)
.IP
.TP
\fBStepID\fR
Job or job step ID.
In the case of job arrays, the job ID format will be of the form
"<base_job_id>_<index>".
(Valid for job steps only)
.IP
.TP
\fBStepName\fR
Job step name.
(Valid for job steps only)
.IP
.TP
\fBStepState\fR
The state of the job step.
(Valid for job steps only)
.IP
.TP
\fBSubmitTime\fR
The time that the job was submitted at.
(Valid for jobs only)
.IP
.TP
\fBsystem_comment\fR
System comment associated with the job.
(Valid for jobs only)
.IP
.TP
\fBThreads\fR
Number of threads per core requested by the job.
This reports the value of the \fBsrun \-\-threads\-per\-core\fR option.
When \fB\-\-threads\-per\-core\fR has not been set, "*" is displayed.
(Valid for jobs only)
.IP
.TP
\fBTimeLeft\fR
Time left for the job to execute in days\-hours:minutes:seconds.
This value is calculated by subtracting the job's time used from its time
limit.
The value may be "NOT_SET" if not yet established or "UNLIMITED" for no limit.
(Valid for jobs only)
.IP
.TP
\fBTimeLimit\fR
Timelimit for the job or job step.
(Valid for jobs and job steps)
.IP
.TP
\fBTimeUsed\fR
Time used by the job or job step in days\-hours:minutes:seconds.
The days and hours are printed only as needed.
For job steps this field shows the elapsed time since execution began
and thus will be inaccurate for job steps which have been suspended.
Clock skew between nodes in the cluster will cause the time to be inaccurate.
If the time is obviously wrong (e.g. negative), it displays as "INVALID".
(Valid for jobs and job steps)
.IP
.TP
\fBtres\-alloc\fR
Print the trackable resources allocated to the job if running.
If not running, then print the trackable resources requested by the job.
.IP
.TP
\fBtres\-bind\fR
Print the trackable resources task binding requested by the job or job step.
.IP
.TP
\fBtres\-freq\fR
Print the trackable resources frequencies requested by the job or job step.
.IP
.TP
\fBtres\-per\-job\fR
Print the trackable resources requested by the job.
.IP
.TP
\fBtres\-per\-node\fR
Print the trackable resources per node requested by the job or job step.
.IP
.TP
\fBtres\-per\-socket\fR
Print the trackable resources per socket requested by the job or job step.
.IP
.TP
\fBtres\-per\-step\fR
Print the trackable resources requested by the job step.
.IP
.TP
\fBtres\-per\-task\fR
Print the trackable resources per task requested by the job or job step.
.IP
.TP
\fBUserID\fR
User ID for a job or job step.
(Valid for jobs and job steps)
.IP
.TP
\fBUserName\fR
User name for a job or job step.
(Valid for jobs and job steps)
.IP
.TP
\fBWait4Switch\fR
The amount of time to wait for the desired number of switches.
(Valid for jobs only)
.IP
.TP
\fBWCKey\fR
Workload Characterization Key (wckey).
(Valid for jobs only)
.IP
.TP
\fBWorkDir\fR
The job's working directory.
(Valid for jobs only)
.RE
.IP
.TP
\fB\-\-help\fR
Print a help message describing all options \fBsqueue\fR.
.IP
.TP
\fB\-\-hide\fR
Do not display information about jobs and job steps in all partitions. By default,
information about partitions that are configured as hidden or are not available
to the user's group will not be displayed (i.e. this is the default behavior).
.IP
.TP
\fB\-i\fR, \fB\-\-iterate\fR=<\fIseconds\fR>
Repeatedly gather and report the requested information at the interval
specified (in seconds).
By default, prints a time stamp with the header.
.IP
.TP
\fB\-j\fR, \fB\-\-jobs\fR[=<\fIjob_id_list\fR>]
Specify a comma separated list of job IDs to display. Defaults to all jobs.
The \fB\-\-jobs\fR=<\fIjob_id_list\fR> option may be used in conjunction with
the \fB\-\-steps\fR option to print step information about specific jobs.
Note: If a list of job IDs is provided, the jobs are displayed even if
they are on hidden partitions. Since this option's argument is optional,
for proper parsing the single letter option must be followed immediately
with the value and not include a space between them. For example "\-j1008"
and not "\-j 1008".
The job ID format is "job_id[_array_id]".
Performance of the command can be measurably improved for systems with large
numbers of jobs when a single job ID is specified.
By default, this field size will be limited to 64 bytes.
Use the environment variable SLURM_BITSTR_LEN to specify larger field sizes.
.IP
.TP
\f3\-\-json\fP, \f3\-\-json\fP=\fIlist\fR, \f3\-\-json\fP=<\fIdata_parser\fR>
Dump information as JSON using the default data_parser plugin or explicit
data_parser with parameters. All information is dumped, even if it would
normally not be. Sorting and formatting arguments passed to other options are
ignored; however, most filtering arguments are still used.
.IP
.TP
\fB\-L\fR, \fB\-\-licenses\fR=<\fIlicense_list\fR>
Request jobs requesting or using one or more of the named licenses.
The license list consists of a comma separated list of license names.
.IP
.TP
\fB\-\-local\fR
Show only jobs local to this cluster. Ignore other clusters in this federation
(if any). Overrides \-\-federation.
.IP
.TP
\fB\-l\fR, \fB\-\-long\fR
Report more of the available information for the selected jobs or job steps,
subject to any constraints specified.
.IP
.TP
\fB\-\-me\fR
Equivalent to \fB\-\-user=<my username>\fR.
.IP
.TP
\fB\-n\fR, \fB\-\-name\fR=<\fIname_list\fR>
Request jobs or job steps having one of the specified names. The
list consists of a comma separated list of job names.
.IP
.TP
\fB\-\-noconvert\fR
Don't convert units from their original type (e.g. 2048M won't be converted to
2G).
.IP
.TP
\fB\-w\fR, \fB\-\-nodelist\fR=<\fIhostlist\fR>
Report only on jobs allocated to the specified node or list of nodes.
This may either be the \fBNodeName\fR or \fBNodeHostname\fR
as defined in \fBslurm.conf(5)\fR in the event that they differ.
A node_name of \fBlocalhost\fR is mapped to the current host name.
.IP
.TP
\fB\-h\fR, \fB\-\-noheader\fR
Do not print a header on the output.
.IP
.TP
\fB\-\-notme\fR
Opposite of \fB\-\-me\fR; only display jobs that are not from the invoking user.
.IP
.TP
\fB\-\-only\-job\-state\fR
Only query for the job state. Query utilizes RPC that only retains JobID
and State information, reducing work required by slurmctld to respond.
.IP
.TP
\fB\-p\fR, \fB\-\-partition\fR=<\fIpart_list\fR>
Specify the partitions of the jobs or steps to view. Accepts a comma separated
list of partition names.
.IP
.TP
\fB\-P\fR, \fB\-\-priority\fR
For pending jobs submitted to multiple partitions, list the job once per
partition. In addition, if jobs are sorted by priority, consider both the
partition and job priority. This option can be used to produce a list of
pending jobs in the same order considered for scheduling by Slurm with
appropriate additional options (e.g. "\-\-sort=\-p,i \-\-states=PD").
.IP
.TP
\fB\-q\fR, \fB\-\-qos\fR=<\fIqos_list\fR>
Specify the qos(s) of the jobs or steps to view. Accepts a comma
separated list of qos's.
.IP
.TP
\fB\-R\fR, \fB\-\-reservation\fR=<\fIreservation_name\fR>
Specify the reservation of the jobs to view.
.IP
.TP
\fB\-\-sibling\fR
Show all sibling jobs on a federated cluster. Implies \-\-federation.
.IP
.TP
\fB\-S\fR, \fB\-\-sort\fR=<\fIsort_list\fR>
Specification of the order in which records should be reported.
This uses the same field specification as the <output_format>.
The long format option "cluster" can also be used to sort jobs or job steps by
cluster name (e.g. federated jobs).
Multiple sorts may be performed by listing multiple sort fields
separated by commas.
The field specifications may be preceded by "+" or "\-" for
ascending (default) and descending order respectively.
For example, a sort value of "P,U" will sort the
records by partition name then by user id.
The default value of sort for jobs is "P,t,\-p" (increasing partition
name then within a given partition by increasing job state and then
decreasing priority).
The default value of sort for job steps is "P,i" (increasing partition
name then within a given partition by increasing step id).
.IP
.TP
\fB\-\-start\fR
Report the expected start time and resources to be allocated for pending jobs
in order of increasing start time.
This is equivalent to the following options:
\fB\-\-format="%.18i %.9P %.8j %.8u %.2t %.19S %.6D %20Y %R"\fR,
\fB\-\-sort=S\fR and \fB\-\-states=PENDING\fR.
Any of these options may be explicitly changed as desired by
combining the \fB\-\-start\fR option with other option values
(e.g. to use a different output format).
The expected start time of pending jobs is only available if the
Slurm is configured to use the backfill scheduling plugin.
.IP
.TP
\fB\-t\fR, \fB\-\-states\fR=<\fIstate_list\fR>
Specify the states of jobs to view. Accepts a comma separated list of
state names or "all". If "all" is specified then jobs of all states will be
reported. If no state is specified then pending, running, and completing
jobs are reported. See the \fBJOB STATE CODES\fR section below for a list of
valid states. Both extended and compact forms are valid.
Note the \fB<state_list>\fR supplied is case insensitive ("pd" and "PD" are
equivalent).
.IP
.TP
\fB\-s\fR, \fB\-\-steps\fR[=<\fIstep_list\fR>]
Specify the job steps to view. This flag indicates that a comma separated list
of job steps to view follows without an equal sign (see examples).
The job step format is "job_id[_array_id].step_id". Defaults to all job
steps. Since this option's argument is optional, for proper parsing
the single letter option must be followed immediately with the value
and not include a space between them. For example "\-s1008.0" and not
"\-s 1008.0".
.IP
.TP
\fB\-\-usage\fR
Print a brief help message listing the \fBsqueue\fR options.
.IP
.TP
\fB\-u\fR, \fB\-\-user\fR=<\fIuser_list\fR>
Request jobs or job steps from a comma separated list of users.
The list can consist of user names or user id numbers.
Performance of the command can be measurably improved for systems with large
numbers of jobs when a single user is specified.
.IP
.TP
\fB\-v\fR, \fB\-\-verbose\fR
Report details of squeues actions.
.IP
.TP
\fB\-V\fR , \fB\-\-version\fR
Print version information and exit.
.IP
.TP
\f3\-\-yaml\fP, \f3\-\-yaml\fP=\fIlist\fR, \f3\-\-yaml\fP=<\fIdata_parser\fR>
Dump information as YAML using the default data_parser plugin or explicit
data_parser with parameters. All information is dumped, even if it would
normally not be. Sorting and formatting arguments passed to other options are
ignored; however, most filtering arguments are still used.
.IP
.SH "JOB REASON CODES"
These codes identify the reason that a job has not been started by the scheduler.
There may be multiple reasons why a job cannot start yet, in which case only the
reason that was encountered by the attempted scheduling method will be displayed.
The Reasons listed below are some of the more common ones you might see.
For a full list of Reason codes refer to this page:
<https://slurm.schedmd.com/job_reason_codes.html>
.TP 22
\fBAssocGrp*Limit\fR
The job's association has reached an aggregate limit on some resource.
.IP
.TP
\fBAssociationJobLimit\fR
The job's association has reached its maximum job count.
.IP
.TP
\fBAssocMax*Limit\fR
The job requests a resource that violates a per-job limit on the requested
association.
.IP
.TP
\fBAssociationResourceLimit\fR
The job's association has reached some resource limit.
.IP
.TP
\fBAssociationTimeLimit\fR
The job's association has reached its time limit.
.IP
.TP
\fBBadConstraints\fR
The job's constraints can not be satisfied.
.IP
.TP
\fBBeginTime\fR
The job's earliest start time has not yet been reached.
.IP
.TP
\fBCleaning\fR
The job is being requeued and still cleaning up from its previous execution.
.IP
.TP
\fBDependency\fR
This job has a dependency on another job that has not been satisfied.
.IP
.TP
\fBDependencyNeverSatisfied\fR
This job has a dependency on another job that will never be satisfied.
.IP
.TP
\fBFrontEndDown\fR
No front end node is available to execute this job.
.IP
.TP
\fBInactiveLimit\fR
The job reached the system InactiveLimit.
.IP
.TP
\fBInvalidAccount\fR
The job's account is invalid.
.IP
.TP
\fBInvalidQOS\fR
The job's QOS is invalid.
.IP
.TP
\fBJobHeldAdmin\fR
The job is held by a system administrator.
.IP
.TP
\fBJobHeldUser\fR
The job is held by the user.
.IP
.TP
\fBJobLaunchFailure\fR
The job could not be launched.
This may be due to a file system problem, invalid program name, etc.
.IP
.TP
\fBLicenses\fR
The job is waiting for a license.
.IP
.TP
\fBNodeDown\fR
A node required by the job is down.
.IP
.TP
\fBNonZeroExitCode\fR
The job terminated with a non\-zero exit code.
.IP
.TP
\fBPartitionDown\fR
The partition required by this job is in a DOWN state.
.IP
.TP
\fBPartitionInactive\fR
The partition required by this job is in an Inactive state and not able to
start jobs.
.IP
.TP
\fBPartitionNodeLimit\fR
The number of nodes required by this job is outside of its partition's current
limits.
Can also indicate that required nodes are DOWN or DRAINED.
.IP
.TP
\fBPartitionTimeLimit\fR
The job's time limit exceeds its partition's current time limit.
.IP
.TP
\fBPriority\fR
One or more higher priority jobs exist for this partition or advanced reservation.
.IP
.TP
\fBProlog\fR
Its Prolog program is still running.
.IP
.TP
\fBQOSGrp*Limit\fR
The job's QOS has reached an aggregate limit on some resource.
.IP
.TP
\fBQOSJobLimit\fR
The job's QOS has reached its maximum job count.
.IP
.TP
\fBQOSMax*Limit\fR
The job requests a resource that violates a per-job limit on the requested
QOS.
.IP
.TP
\fBQOSResourceLimit\fR
The job's QOS has reached some resource limit.
.IP
.TP
\fBQOSTimeLimit\fR
The job's QOS has reached its time limit.
.IP
.TP
\fBQOSUsageThreshold\fR
Required QOS threshold has been breached.
.IP
.TP
\fBReqNodeNotAvail\fR
Some node specifically required by the job is not currently available.
The node may currently be in use, reserved for another job, in an advanced
reservation, DOWN, DRAINED, or not responding.
Nodes which are DOWN, DRAINED, or not responding will be identified as part
of the job's "reason" field as "UnavailableNodes". Such nodes will typically
require the intervention of a system administrator to make available.
.IP
.TP
\fBReservation\fR
The job is waiting its advanced reservation to become available.
.IP
.TP
\fBResources\fR
The job is waiting for resources to become available.
.IP
.TP
\fBSystemFailure\fR
Failure of the Slurm system, a file system, the network, etc.
.IP
.TP
\fBTimeLimit\fR
The job exhausted its time limit.
.IP
.TP
\fBWaitingForScheduling\fR
No reason has been set for this job yet.
Waiting for the scheduler to determine the appropriate reason.
.IP
.SH "JOB STATE CODES"
Jobs typically pass through several states in the course of their
execution.
The typical states are PENDING, RUNNING, SUSPENDED, COMPLETING, and COMPLETED.
The following states are recognized by squeue. A full list of possible states
is available at <https://slurm.schedmd.com/job_state_codes.html>.
.TP 20
\fBBF BOOT_FAIL\fR
Job terminated due to launch failure, typically due to a hardware failure
(e.g. unable to boot the node or block and the job can not be requeued).
.IP
.TP
\fBCA CANCELLED\fR
Job was explicitly cancelled by the user or system administrator.
The job may or may not have been initiated.
.IP
.TP
\fBCD COMPLETED\fR
Job has terminated all processes on all nodes with an exit code of zero.
.IP
.TP
\fBCF CONFIGURING\fR
Job has been allocated resources, but are waiting for them to become ready for use
(e.g. booting).
.IP
.TP
\fBCG COMPLETING\fR
Job is in the process of completing. Some processes on some nodes may still be active.
.IP
.TP
\fBDL DEADLINE\fR
Job terminated on deadline.
.IP
.TP
\fBF FAILED\fR
Job terminated with non\-zero exit code or other failure condition.
.IP
.TP
\fBNF NODE_FAIL\fR
Job terminated due to failure of one or more allocated nodes.
.IP
.TP
\fBOOM OUT_OF_MEMORY\fR
Job experienced out of memory error.
.IP
.TP
\fBPD PENDING\fR
Job is awaiting resource allocation.
.IP
.TP
\fBPR PREEMPTED\fR
Job terminated due to preemption.
.IP
.TP
\fBR RUNNING\fR
Job currently has an allocation.
.IP
.TP
\fBRD RESV_DEL_HOLD\fR
Job is being held after requested reservation was deleted.
.IP
.TP
\fBRF REQUEUE_FED\fR
Job is being requeued by a federation.
.IP
.TP
\fBRH REQUEUE_HOLD\fR
Held job is being requeued.
.IP
.TP
\fBRQ REQUEUED\fR
Completing job is being requeued.
.IP
.TP
\fBRS RESIZING\fR
Job is about to change size.
.IP
.TP
\fBRV REVOKED\fR
Sibling was removed from cluster due to other cluster starting the job.
.IP
.TP
\fBSI SIGNALING\fR
Job is being signaled.
.IP
.TP
\fBSE SPECIAL_EXIT\fR
The job was requeued in a special state. This state can be set by
users, typically in EpilogSlurmctld, if the job has terminated with
a particular exit value.
.IP
.TP
\fBSO STAGE_OUT\fR
Job is staging out files.
.IP
.TP
\fBST STOPPED\fR
Job has an allocation, but execution has been stopped with SIGSTOP signal.
CPUS have been retained by this job.
.IP
.TP
\fBS SUSPENDED\fR
Job has an allocation, but execution has been suspended and CPUs have been
released for other jobs.
.IP
.TP
\fBTO TIMEOUT\fR
Job terminated upon reaching its time limit.
.IP
.SH "PERFORMANCE"
.PP
Executing \fBsqueue\fR sends a remote procedure call to \fBslurmctld\fR. If
enough calls from \fBsqueue\fR or other Slurm client commands that send remote
procedure calls to the \fBslurmctld\fR daemon come in at once, it can result in
a degradation of performance of the \fBslurmctld\fR daemon, possibly resulting
in a denial of service.
.PP
Do not run \fBsqueue\fR or other Slurm client commands that send remote
procedure calls to \fBslurmctld\fR from loops in shell scripts or other
programs. Ensure that programs limit calls to \fBsqueue\fR to the minimum
necessary for the information you are trying to gather.
.SH "ENVIRONMENT VARIABLES"
.PP
Some \fBsqueue\fR options may be set via environment variables. These
environment variables, along with their corresponding options, are listed
below. (Note: Command line options will always override these settings.)
.TP 20
\fBSLURM_BITSTR_LEN\fR
Specifies the string length to be used for holding a job array's task ID
expression.
The default value is 64 bytes.
A value of 0 will print the full expression with any length required.
Larger values may adversely impact the application performance.
.IP
.TP
\fBSLURM_CLUSTERS\fR
Same as \fB\-\-clusters\fR
.IP
.TP
\fBSLURM_CONF\fR
The location of the Slurm configuration file.
.IP
.TP
\fBSLURM_DEBUG_FLAGS\fR
Specify debug flags for squeue to use. See DebugFlags in the
\fBslurm.conf\fR(5) man page for a full list of flags. The environment
variable takes precedence over the setting in the slurm.conf.
.IP
.TP
\fBSLURM_TIME_FORMAT\fR
Specify the format used to report time stamps. A value of \fIstandard\fR, the
default value, generates output in the form "year\-month\-dateThour:minute:second".
A value of \fIrelative\fR returns only "hour:minute:second" if the current day.
For other dates in the current year it prints the "hour:minute" preceded by
"Tomorr" (tomorrow), "Ystday" (yesterday), the name of the day for the coming
week (e.g. "Mon", "Tue", etc.), otherwise the date (e.g. "25 Apr").
For other years it returns a date month and year without a time (e.g.
"6 Jun 2012"). All of the time stamps use a 24 hour format.
A valid strftime() format can also be specified. For example, a value of
"%a %T" will report the day of the week and a time stamp (e.g. "Mon 12:34:56").
.IP
.TP
\fBSQUEUE_ACCOUNT\fR
\fB\-A <account_list>, \-\-account=<account_list>\fR
.IP
.TP
\fBSQUEUE_ALL\fR
\fB\-a, \-\-all\fR
.IP
.TP
\fBSQUEUE_ARRAY\fR
\fB\-r, \-\-array\fR
.IP
.TP
\fBSQUEUE_NAMES\fR
\fB\-\-name=<name_list>\fR
.IP
.TP
\fBSQUEUE_FEDERATION\fR
\fB\-\-federation\fR
.IP
.TP
\fBSQUEUE_FORMAT\fR
\fB\-o <output_format>, \-\-format=<output_format>\fR
.IP
.TP
\fBSQUEUE_FORMAT2\fR
\fB\-O <output_format>, \-\-Format=<output_format>\fR
.IP
.TP
\fBSQUEUE_LICENSES\fR
\fB\-p\-l <license_list>, \-\-license=<license_list>\fR
.IP
.TP
\fBSQUEUE_LOCAL\fR
\fB\-\-local\fR
.IP
.TP
\fBSQUEUE_PARTITION\fR
\fB\-p <part_list>, \-\-partition=<part_list>\fR
.IP
.TP
\fBSQUEUE_PRIORITY\fR
\fB\-P\fR, \fB\-\-priority\fR
.IP
.TP
\fBSQUEUE_QOS\fR
\fB\-p <qos_list>, \-\-qos=<qos_list>\fR
.IP
.TP
\fBSQUEUE_SIBLING\fR
\fB\-\-sibling\fR
.IP
.TP
\fBSQUEUE_SORT\fR
\fB\-S <sort_list>, \-\-sort=<sort_list>\fR
.IP
.TP
\fBSQUEUE_STATES\fR
\fB\-t <state_list>, \-\-states=<state_list>\fR
.IP
.TP
\fBSQUEUE_USERS\fR
\fB\-u <user_list>, \-\-users=<user_list>\fR
.IP
.SH "EXAMPLES"
.TP
Print the jobs scheduled in the debug partition and in the \
COMPLETED state in the format with six right justified digits for \
the job id followed by the priority with an arbitrary fields size:
.IP
.nf
$ squeue \-p debug \-t COMPLETED \-o "%.6i %p"
JOBID PRIORITY
65543 99993
65544 99992
65545 99991
.fi
.TP
Print the job steps in the debug partition sorted by user:
.IP
.nf
$ squeue \-s \-p debug \-S u
STEPID NAME PARTITION USER TIME NODELIST
65552.1 test1 debug alice 0:23 dev[1\-4]
65562.2 big_run debug bob 0:18 dev22
65550.1 param1 debug candice 1:43:21 dev[6\-12]
.fi
.TP
Print information only about jobs 12345, 12346 and 12348:
.IP
.nf
$ squeue \-\-jobs 12345,12346,12348
JOBID PARTITION NAME USER ST TIME NODES NODELIST(REASON)
12345 debug job1 dave R 0:21 4 dev[9\-12]
12346 debug job2 dave PD 0:00 8 (Resources)
12348 debug job3 ed PD 0:00 4 (Priority)
.fi
.TP
Print information only about job step 65552.1:
.IP
.nf
$ squeue \-\-steps 65552.1
STEPID NAME PARTITION USER TIME NODELIST
65552.1 test2 debug alice 12:49 dev[1\-4]
.fi
.SH "COPYING"
Copyright (C) 2002\-2007 The Regents of the University of California.
Produced at Lawrence Livermore National Laboratory (cf, DISCLAIMER).
.br
Copyright (C) 2008\-2010 Lawrence Livermore National Security.
.br
Copyright (C) 2010\-2022 SchedMD LLC.
.LP
This file is part of Slurm, a resource management program.
For details, see <https://slurm.schedmd.com/>.
.LP
Slurm is free software; you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free
Software Foundation; either version 2 of the License, or (at your option)
any later version.
.LP
Slurm is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
details.
.SH "SEE ALSO"
\fBscancel\fR(1), \fBscontrol\fR(1), \fBsinfo\fR(1), \fBsrun\fR(1),
\fBslurm_load_ctl_conf\fR (3), \fBslurm_load_jobs\fR (3),
\fBslurm_load_node\fR (3),
\fBslurm_load_partitions\fR (3)
|