edquota

title: edquota(8)

summary: edit user quotas

text:
# edquota(8)

## NAME
edquota - edit user quotas

## SYNOPSIS
edquota [ -p protoname ] [ -u | -g | -P ] [ -rm ] [ -F format-name ] [ -f filesystem ] username | groupname | projectname...

edquota [ -u | -g | -P ] [ -F format-name ] [ -f filesystem ] -t

edquota [ -u | -g | -P ] [ -F format-name ] [ -f filesystem ] -T username | groupname | projectname...

## DESCRIPTION
edquota is a quota editor. One or more users, groups, or projects may be specified on the command line. If a number is given in the place of user/group/project name it is treated as an UID/GID/Project ID. For each user, group, or project a temporary file is created with an ASCII representation of the current disk quotas for that user, group, or project and an editor is then invoked on the file. The quotas may then be modified, new quotas added, etc. Setting a quota to zero indicates that no quota should be imposed.

Block usage and limits are reported and interpreted as multiples of kibibyte (1024 bytes) blocks by default. Symbols K, M, G, and T can be appended to numeric value to express kibibytes, mebibytes, gibibytes, and tebibytes.

Inode usage and limits are interpreted literally. Symbols k, m, g, and t can be appended to numeric value to express multiples of 10^3, 10^6, 10^9, and 10^12 inodes.

Users are permitted to exceed their soft limits for a grace period that may be specified per filesystem. Once the grace period has expired, the soft limit is enforced as a hard limit.

The current usage information in the file is for informational purposes; only the hard and soft limits can be changed.

Upon leaving the editor, edquota reads the temporary file and modifies the binary quota files to reflect the changes made.

The editor invoked is vitmp(1) unless either the EDITOR or the VISUAL environment variable specifies otherwise.

Only the super-user may edit quotas.

## OPTIONS
-r, --remote

Edit also non-local quota use rpc.rquotad on remote server to set quota. This option is available only if quota tools were compiled with enabled support for setting quotas over RPC. The -n option is equivalent, and is maintained for backward compatibility.

-m, --no-mixed-pathnames

Currently, pathnames of NFSv4 mountpoints are sent without leading slash in the path. rpc.rquotad uses this to recognize NFSv4 mounts and properly prepend pseudoroot of NFS filesystem to the path. If you specify this option, edquota will always send paths with a leading slash. This can be useful for legacy reasons but be aware that quota over RPC will stop working if you are using new rpc.rquotad.

-u, --user

Edit the user quota. This is the default.

-g, --group

Edit the group quota.

-P, --project

Edit the project quota.

-p, --prototype=protoname

Duplicate the quotas of the prototypical user specified for each user specified. This is the normal mechanism used to initialize quotas for groups of users.

--always-resolve

Always try to translate user / group name to uid / gid even if the name is composed of digits only.

-F, --format=format-name

Edit quota for specified format (ie. don't perform format autodetection). Possible format names are: vfsold Original quota format with 16-bit UIDs / GIDs, vfsv0 Quota format with 32-bit UIDs / GIDs, 64-bit space usage, 32-bit inode usage and limits, vfsv1 Quota format with 64-bit quota limits and usage, rpc (quota over NFS), xfs (quota on XFS filesystem)

-f, --filesystem filesystem

Perform specified operations only for given filesystem (default is to perform operations for all filesystems with quota).

-t, --edit-period

Edit the soft time limits for each filesystem. In old quota format if the time limits are zero, the default time limits in <linux/quota.h> are used. In new quota format time limits must be specified (there is no default value set in kernel). Time units of 'seconds', 'minutes', 'hours', and 'days' are understood. Time limits are printed in the greatest possible time unit such that the value is greater than or equal to one.

-T, --edit-times

Edit time for the user/group/project when softlimit is enforced. Possible values are 'unset' or number and unit. Units are the same as in -t option.

## FILES
aquota.user or aquota.group

quota file at the filesystem root (version 2 quota, non-XFS filesystems)

quota.user or quota.group

quota file at the filesystem root (version 1 quota, non-XFS filesystems)

/etc/mtab

mounted filesystems table

## SEE ALSO
quota(1), vitmp(1), quotactl(2), quotacheck(8), quotaon(8), repquota(8), setquota(8)


quotacheck

package: quota

title: quotacheck(8)

text:
# quotacheck(8)

## NAME
quotacheck - scan a filesystem for disk usage, create, check and repair quota files

## SYNOPSIS
quotacheck [ -gubcfinvdMmR ] [ -F quota-format ] -a | filesystem

## DESCRIPTION
quotacheck examines each filesystem, builds a table of current disk usage, and compares this table against that recorded in the disk quota file for the filesystem (this step is omitted if option -c is specified). If any inconsistencies are detected, both the quota file and the current system copy of the incorrect quotas are updated (the latter only occurs if an active filesystem is checked which is not advised). By default, only user quotas are checked. quotacheck expects each filesystem to be checked to have quota files named [a]quota.user and [a]quota.group located at the root of the associated filesystem. If a file is not present, quotacheck will create it.

If the quota file is corrupted, quotacheck tries to save as much data as possible. Rescuing data may need user intervention. With no additional options quotacheck will simply exit in such a situation. When in interactive mode (option -i) , the user is asked for advice. Advice can also be provided from command line (see option -n) , which is useful when quotacheck is run automatically (ie. from script) and failure is unacceptable.

quotacheck should be run each time the system boots and mounts non-valid filesystems. This is most likely to happen after a system crash.

It is strongly recommended to run quotacheck with quotas turned off for the filesystem. Otherwise, possible damage or loss to data in the quota files can result. It is also unwise to run quotacheck on a live filesystem as actual usage may change during the scan. To prevent this, quotacheck tries to remount the filesystem read-only before starting the scan. After the scan is done it remounts the filesystem read-write. You can disable this with option -m. You can also make quotacheck ignore the failure to remount the filesystem read-only with option -M.

## OPTIONS
-b, --backup

Forces quotacheck to make backups of the quota file before writing the new data.

-v, --verbose

quotacheck reports its operation as it progresses. Normally it operates silently. If the option is specified twice, also the current directory is printed (note that printing can slow down the scan measurably).

-d, --debug

Enable debugging mode. It will result in a lot of information which can be used in debugging the program. The output is very verbose and the scan will be slow.

-u, --user

Only user quotas listed in /etc/mtab or on the filesystems specified are to be checked. This is the default action.

-g, --group

Only group quotas listed in /etc/mtab or on the filesystems specified are to be checked.

-c, --create-files

Don't read existing quota files. Just perform a new scan and save it to disk. quotacheck also skips scanning of old quota files when they are not found.

-f, --force

Forces checking and writing of new quota files on filesystems with quotas enabled. This is not recommended as the created quota files may be out of sync.

-M, --try-remount

This flag forces checking of filesystem in read-write mode if a remount fails. Do this only when you are sure no process will write to a filesystem while scanning.

-m, --no-remount

Don't try to remount filesystem read-only. See comment with option -M.

-i, --interactive

Interactive mode. By default quotacheck exits when it finds an error. In interactive mode user is asked for input instead. See option -n.

-n, --use-first-dquot

If the quota files become corrupted, it is possible for duplicate entries for a single user or group ID to exist. Normally in this case, quotacheck exits or asks user for input. When this option is set, the first entry found is always used (this option works in interactive mode too).

-F, --format=format-name

Check and fix quota files of specified format (ie. don't perform format auto-detection). This is recommended as detection might not work well on corrupted quota files. Possible format names are: vfsold Original quota format with 16-bit UIDs / GIDs, vfsv0 Quota format with 32-bit UIDs / GIDs, 64-bit space usage, 32-bit inode usage and limits, vfsv1 Quota format with 64-bit quota limits and usage, rpc (quota over NFS), xfs (quota on XFS filesystem)

-a, --all

Check all mounted non-NFS filesystems in /etc/mtab

-R, --exclude-root

When used together with the -a option, all filesystems except for the root filesystem are checked for quotas.

## NOTE
quotacheck should only be run by super-user. Non-privileged users are presumably not allowed to read all the directories on the given filesystem.

## SEE ALSO
quota(1), quotactl(2), fstab(5), quotaon(8), repquota(8), convertquota(8), setquota(8), edquota(8), fsck(8), efsck(8), e2fsck(8), xfsck(8)

## FILES
aquota.user or aquota.group

located at filesystem root with quotas (version 2 quota, non-XFS filesystems)

quota.user or quota.group

located at filesystem root with quotas (version 1 quota, non-XFS filesystems)

/etc/mtab

names and locations of mounted filesystems

## AUTHOR
Jan Kara <jack@suse.cz>

Based on old quotacheck by:

Edvard Tuinder <ed@elm.net>

Marco van Wieringen <mvw@planets.elm.net>

branch: sisyphus


quotaon

title: quotaon(8)

summary: turn filesystem quotas on and off

text:
# quotaon(8)

## NAME
quotaon, quotaoff - turn filesystem quotas on and off

## SYNOPSIS
quotaon [ -vugfp ] [ -F format-name ] filesystem...

quotaon [ -avugPfp ] [ -F format-name ]

quotaoff [ -vugPp ] [ -x state ] filesystem...

quotaoff [ -avugp ]

## DESCRIPTION

### quotaon
quotaon announces to the system that disk quotas should be enabled on one or more filesystems. The filesystem quota files must be present in the root directory of the specified filesystem and be named either aquota.user (for version 2 user quota), quota.user (for version 1 user quota), aquota.group (for version 2 group quota), or quota.group (for version 1 group quota).

XFS filesystems are a special case - XFS considers quota information as filesystem metadata and uses journaling to provide a higher level guarantee of consistency. There are two components to the XFS disk quota system: accounting and limit enforcement. XFS filesystems require that quota accounting be turned on at mount time. It is possible to enable and disable limit enforcement on an XFS filesystem after quota accounting is already turned on. The default is to turn on both accounting and enforcement.

The XFS quota implementation does not maintain quota information in user-visible files, but rather stores this information internally.

### quotaoff
quotaoff announces to the system that the specified filesystems should have any disk quotas turned off.

## OPTIONS

### quotaon
-F, --format=format-name

Report quota for specified format (ie. don't perform format autodetection). Possible format names are: vfsold Original quota format with 16-bit UIDs / GIDs, vfsv0 Quota format with 32-bit UIDs / GIDs, 64-bit space usage, 32-bit inode usage and limits, vfsv1 Quota format with 64-bit quota limits and usage, xfs (quota on XFS filesystem)

-a, --all

All automatically mounted (no noauto option) non-NFS filesystems in /etc/fstab with quotas will have their quotas turned on. This is normally used at boot time to enable quotas.

-v, --verbose

Display a message for each filesystem where quotas are turned on.

-u, --user

Manipulate user quotas. This is the default.

-g, --group

Manipulate group quotas.

-P, --project

Manipulate project quotas.

-p, --print-state

Instead of turning quotas on just print state of quotas (ie. whether. quota is on or off)

-x, --xfs-command enforce

Switch on limit enforcement for XFS filesystems. This is the default action for any XFS filesystem. This option is only applicable to XFS, and is silently ignored for other filesystem types.

-f, --off

Make quotaon behave like being called as quotaoff.

### quotaoff
-F, --format=format-name

Report quota for specified format (ie. don't perform format autodetection). Possible format names are: vfsold (version 1 quota), vfsv0 (version 2 quota), xfs (quota on XFS filesystem)

-a, --all

Force all filesystems in /etc/fstab to have their quotas disabled.

-v, --verbose

Display a message for each filesystem affected.

-u, --user

Manipulate user quotas. This is the default.

-g, --group

Manipulate group quotas.

-P, --project

Manipulate project quotas.

-p, --print-state

Instead of turning quotas off just print state of quotas (ie. whether. quota is on or off)

-x, --xfs-command delete

Free up the space used to hold quota information (maintained internally) within XFS. This option is only applicable to XFS, and is silently ignored for other filesystem types. It can only be used on a filesystem with quota previously turned off.

-x, --xfs-command enforce

Switch off limit enforcement for XFS filesystems (perform quota accounting only). This is the default action for any XFS filesystem. This option is only applicable to XFS, and is silently ignored for other filesystem types.

-x, --xfs-command account

This option can be used to disable quota accounting. It is not possible to enable quota accounting by quota tools. Use mount(8) for that. This option is only applicable to XFS filesystems, and is silently ignored for other filesystem types.

## NOTES ON XFS FILESYSTEMS
To enable quotas on an XFS filesystem, use mount(8) or /etc/fstab quota option to enable both accounting and limit enforcement. quotaon utility cannot be used for this purpose.

Turning on quotas on an XFS root filesystem requires the quota mount options be passed into the kernel at boot time through the Linux rootflags boot option.

To turn off quota limit enforcement on any XFS filesystem, first make sure that quota accounting and enforcement are both turned on using repquota -v filesystem. Then, use quotaoff -v filesystem to disable limit enforcement. This may be done while the filesystem is mounted.

Turning on quota limit enforcement on an XFS filesystem is achieved using quotaon -v filesystem. This may be done while the filesystem is mounted.

## FILES
aquota.user or aquota.group

quota file at the filesystem root (version 2 quota, non-XFS filesystems)

quota.user or quota.group

quota file at the filesystem root (version 1 quota, non-XFS filesystems)

/etc/fstab

default filesystems

## SEE ALSO
quotactl(2), fstab(5), quota_nld(8), repquota(8), warnquota(8)


quotastats

title: quotastats(8)

summary: Program to query quota statistics

text:
# quotastats(8)

## NAME
quotastats - Program to query quota statistics

## SYNOPSIS
/usr/sbin/quotastats

## DESCRIPTION
quotastats queries the kernel for quota statistics. It displays:

•

Supported kernel quota version

•

Number of dquot lookups

•

Number of dquot drops

•

Number of dquot reads

•

Number of dquot writes

•

Number of quotafile syncs

•

Number of dquot cache hits

•

Number of allocated dquots

•

Number of free dquots

•

Number of in use dquot entries (user/group)

## OPTIONS
None.

## SEE ALSO
quota(1).


repquota

title: repquota(8)

summary: summarize quotas for a filesystem

text:
# repquota(8)

## NAME
repquota - summarize quotas for a filesystem

## SYNOPSIS
/usr/sbin/repquota [ -vspiugP ] [ -c | -C ] [ -t | -n ] [ -F format-name ] filesystem...

/usr/sbin/repquota [ -avtpsiugP ] [ -c | -C ] [ -t | -n ] [ -F format-name ]

## DESCRIPTION
repquota prints a summary of the disc usage and quotas for the specified file systems. For each user the current number of files and amount of space (in kilobytes) is printed, along with any quota limits set with edquota(8) or setquota(8). In the second column repquota prints two characters marking which limits are exceeded. If user is over his space softlimit or reaches his space hardlimit in case softlimit is unset, the first character is '+'. Otherwise the character printed is '-'. The second character denotes the state of inode usage analogously.

repquota has to translate ids of all users/groups/projects to names (unless option -n was specified) so it may take a while to print all the information. To make translating as fast as possible repquota tries to detect (by reading /etc/nsswitch.conf) whether entries are stored in standard plain text file or in a database and either translates chunks of 1024 names or each name individually. You can override this autodetection by -c or -C options.

## OPTIONS
-a, --all

Report on all filesystems indicated in /etc/mtab to be read-write with quotas.

-v, --verbose

Report all quotas, even if there is no usage. Be also more verbose about quotafile information.

-c, --cache

Cache entries to report and translate uids/gids to names in big chunks by scanning all users (default). This is good (fast) behaviour when using /etc/passwd file.

-C, --no-cache

Translate individual entries. This is faster when you have users stored in database.

-t, --truncate-names

Truncate user/group names longer than 9 characters. This results in nicer output when there are such names.

-n, --no-names

Don't resolve UIDs/GIDs to names. This can speedup printing a lot.

-s, --human-readable[=units]

Try to report used space, number of used inodes and limits in more appropriate units than the default ones. Units can be also specified explicitely by an optional argument in format [ kgt ],[ kgt ] where the first character specifies space units and the second character specifies inode units.

-p, --raw-grace

When user is in grace period, report time in seconds since epoch when his grace time runs out (or has run out). Field is '0' when no grace time is in effect. This is especially useful when parsing output by a script.

-i, --no-autofs

Ignore mountpoints mounted by automounter.

-F, --format=format-name

Report quota for specified format (ie. don't perform format autodetection). Possible format names are: vfsold Original quota format with 16-bit UIDs / GIDs, vfsv0 Quota format with 32-bit UIDs / GIDs, 64-bit space usage, 32-bit inode usage and limits, vfsv1 Quota format with 64-bit quota limits and usage, xfs (quota on XFS filesystem)

-g, --group

Report quotas for groups.

-P, --project

Report quotas for projects.

-u, --user

Report quotas for users. This is the default.

-O, --output=format-name

Output quota report in the specified format. Possible format names are: default The default format, optimized for console viewing csv Comma-separated values, a text file with the columns delimited by commas xml Output is XML encoded, useful for processing with XSLT

Only the super-user may view quotas which are not their own.

## FILES
aquota.user or aquota.group

quota file at the filesystem root (version 2 quota, non-XFS filesystems)

quota.user or quota.group

quota file at the filesystem root (version 1 quota, non-XFS filesystems)

/etc/mtab

default filesystems

/etc/passwd

default set of users

/etc/group

default set of groups

## SEE ALSO
quota(1), quotactl(2), edquota(8), quotacheck(8), quotaon(8), quota_nld(8), setquota(8), warnquota(8)


setquota

title: setquota(8)

summary: set disk quotas

text:
# setquota(8)

## NAME
setquota - set disk quotas

## SYNOPSIS
setquota [ -rm ] [ -u | -g | -P ] [ -F quotaformat ] name block-softlimit block-hardlimit inode-softlimit inode-hardlimit -a | filesystem...

setquota [ -rm ] [ -u | -g | -P ] [ -F quotaformat ] [ -p protoname ] name -a | filesystem...

setquota -b [ -rm ] [ -u | -g | -P ] [ -F quotaformat ] -a | filesystem...

setquota -t [ -u | -g | -P ] [ -F quotaformat ] block-grace inode-grace -a | filesystem...

setquota -T [ -u | -g | -P ] [ -F quotaformat ] name block-grace inode-grace -a | filesystem...

## DESCRIPTION
setquota is a command line quota editor. The filesystem, user/group/project name and new quotas for this filesystem can be specified on the command line. Note that if a number is given in the place of a user/group/project name it is treated as an UID/GID/project ID.

-r, --remote

Edit also remote quota use rpc.rquotad on remote server to set quota. This option is available only if quota tools were compiled with enabled support for setting quotas over RPC.

-m, --no-mixed-pathnames

Currently, pathnames of NFSv4 mountpoints are sent without leading slash in the path. rpc.rquotad uses this to recognize NFSv4 mounts and properly prepend pseudoroot of NFS filesystem to the path. If you specify this option, setquota will always send paths with a leading slash. This can be useful for legacy reasons but be aware that quota over RPC will stop working if you are using new rpc.rquotad.

-F, --format=quotaformat

Perform setting for specified format (ie. don't perform format autodetection). Possible format names are: vfsold Original quota format with 16-bit UIDs / GIDs, vfsv0 Quota format with 32-bit UIDs / GIDs, 64-bit space usage, 32-bit inode usage and limits, vfsv1 Quota format with 64-bit quota limits and usage, rpc (quota over NFS), xfs (quota on XFS filesystem)

-u, --user

Set user quotas for named user. This is the default.

-g, --group

Set group quotas for named group.

-P, --project

Set project quotas for named project.

-p, --prototype=protoname

Use quota settings of user, group or project protoname to set the quota for the named user, group or project.

--always-resolve

Always try to translate user / group / project name to uid / gid / project ID even if the name is composed of digits only.

-b, --batch

Read information to set from stdin (input format is name block-softlimit block-hardlimit inode-softlimit inode-hardlimit ). Empty lines and lines starting with # are ignored.

-c, --continue-batch

If parsing of an input line in batch mode fails, continue with processing the next line.

-t, --edit-period

Set grace times for users/groups/projects. Times block-grace and inode-grace are specified in seconds.

-T, --edit-times

Alter times for individual user/group/project when softlimit is enforced. Times block-grace and inode-grace are specified in seconds or can be string 'unset'.

-a, --all

Go through all filesystems with quota in /etc/mtab and perform setting.

block-softlimit and block-hardlimit are interpreted as multiples of kibibyte (1024 bytes) blocks by default. Symbols K, M, G, and T can be appended to numeric value to express kibibytes, mebibytes, gibibytes, and tebibytes.

inode-softlimit and inode-hardlimit are interpreted literally. Symbols k, m, g, and t can be appended to numeric value to express multiples of 10^3, 10^6, 10^9, and 10^12 inodes.

To disable a quota, set the corresponding parameter to 0. To change quotas for several filesystems, invoke once for each filesystem.

Only the super-user may edit quotas.

## FILES
aquota.user or aquota.group

quota file at the filesystem root (version 2 quota, non-XFS filesystems)

quota.user or quota.group

quota file at the filesystem root (version 1 quota, non-XFS filesystems)

/etc/mtab

mounted filesystem table

## SEE ALSO
edquota(8), quota(1), quotactl(2), quotacheck(8), quotaon(8), repquota(8)


warnquota

title: warnquota(8)

summary: send mail to users over quota

text:
# warnquota(8)

## NAME
warnquota - send mail to users over quota

## SYNOPSIS
warnquota [ -ugsid ] [ -F quotaformat ] [ -q quotatab ] [ -c configfile ] [ -a adminsfile ] [ filesystem... ]

## DESCRIPTION
warnquota checks the disk quota for specified local filesystems (or for each local filesystem if none specified) and mails a warning message to those users who have reached their softlimit. It is typically run via cron(8).

-F, --format=quotaformat

Perform setting for specified format (ie. don't perform format autodetection). Possible format names are: vfsold Original quota format with 16-bit UIDs / GIDs, vfsv0 Quota format with 32-bit UIDs / GIDs, 64-bit space usage, 32-bit inode usage and limits, vfsv1 Quota format with 64-bit quota limits and usage, xfs Quota on XFS filesystem.

-q, --quota-tab=quotatab

Use quotatab instead of /etc/quotatab as file with device description strings (see quotatab(5) for syntax).

-c, --config=configfile

Use configfile instead of /etc/warnquota.conf as configuration file (see warnquota.conf(5) for syntax).

-a, --admins-file=adminsfile

Use adminsfile instead of /etc/quotagrpadmins as a file with administrators of the groups (see quotagrpadmins(5) for syntax).

-u, --user

check whether users are not exceeding quotas (default).

-g, --group

check whether groups are not exceeding quotas. If group is exceeding quota a mail is sent to the user specified in /etc/quotagrpadmins.

-s, --human-readable[=units]

Try to report used space, number of used inodes and limits in more appropriate units than the default ones. Units can be also specified explicitely by an optional argument in format [ kgt ],[ kgt ] where the first character specifies space units and the second character specifies inode units.

-i, --no-autofs

ignore mountpoints mounted by automounter.

-d, --no-details

do not attach quota report in email.

## FILES
aquota.user

quota file at the filesystem root (version 2 quota, non-XFS filesystems)

quota.user

quota file at the filesystem root (version 1 quota, non-XFS filesystems)

/etc/warnquota.conf

configuration file

/etc/quotatab

device description

/etc/quotagrpadmins

administrators of the groups

/etc/mtab

default filesystems

/etc/passwd

default set of users

## SEE ALSO
quota(1), quotatab(5), quotagrpadmins(5), warnquota.conf(5), cron(8), edquota(8).

## AUTHORS
warnquota(8) was written by Marco van Wieringen <mvw@planets.elm.net>, modifications by Jan Kara <jack@suse.cz>. This reference page written by Heiko Schlittermann <heiko@lotte.sax.de>, modifications by Jan Kara


xqmstats

title: xqmstats(8)

text:
# xqmstats(8)

## NAME
xqmstats - Display XFS quota manager statistics from /proc

## SYNOPSIS
/usr/sbin/xqmstats

## DESCRIPTION
xqmstat queries the kernel for the XFS Quota Manager dquot statistics. It displays:

•

Reclaims

•

Missed reclaims

•

Dquot dups

•

Cache misses

•

Cache hits

•

Dquot wants

•

Shake reclaims

•

Inact reclaims

## OPTIONS
None.

## SEE ALSO
quotastats(1), quota(1).


rpc.rquotad

package: quota-rpc

title: rpc.rquotad(8)

summary: remote quota server

text:
# rpc.rquotad(8)

## NAME
rpc.rquotad - remote quota server

## SYNOPSIS
/usr/sbin/rpc.rquotad [ -FI ] [ -p port ] [ -s | -S ] [ -x path ]

/usr/sbin/rpc.rquotad [ -h | -V ]

## DESCRIPTION
rpc.rquotad is an rpc(3) server which returns quotas for a user of a local filesystem which is mounted by a remote machine over the NFS. It also allows setting of quotas on NFS mounted filesystem (if configured during compilation and allowed by a command line option -S). The results are used by quota(1) to display user quotas for remote filesystems and by edquota(8) to set quotas on remote filesystems. rquotad daemon uses tcp-wrappers library (under service name rquotad) which allows you to specify hosts allowed/disallowed to use the daemon (see hosts.allow(5) manpage for more information). The rquotad daemon is normally started at boot time from the system startup scripts.

## OPTIONS
-h, --help

Show program usage and exit. -V, --version Show version of quota tools.

-s, --no-setquota

Don't allow setting of quotas (default). This option is available only if utilities were compiled with the rpcsetquota option.

-S, --setquota

Allow setting of quotas. This option is available only if utilities were compiled with the rpcsetquota option.

-F, --foreground

Run daemon in foreground (may be useful for debugging purposes).

-I, --autofs

Do not ignore autofs mountpoints.

-p port, --port port

Listen on alternate port port.

-x path, --xtab path

Set an alternative file with NFSD export table. This file is used to determine pseudoroot of NFSv4 exports. The pseudoroot is then prepended to each relative path (i.e. a path not beginning by '/') received in a quota RPC request.

## FILES
aquota.user or aquota.group

quota file at the filesystem root (version 2 quota, non-XFS filesystems)

quota.user or quota.group

quota file at the filesystem root (version 1 quota, non-XFS filesystems)

/etc/mtab

default filesystems

## SEE ALSO
quota(1), rpc(3), nfs(5), services(5), inetd(8)


rabbitmq-diagnostics

package: rabbitmq-server

title: rabbitmq-diagnostics(8)

text:
# rabbitmq-diagnostics(8)

## NAME
rabbitmq-diagnostics — RabbitMQ diagnostics, monitoring and health checks tools

## SYNOPSIS
rabbitmq-diagnostics

[-q] [-s] [-l] [-n node] [-t timeout] command [command_options]

## DESCRIPTION
rabbitmq-diagnostics is a command line tool that provides commands used for diagnostics, monitoring and health checks of RabbitMQ nodes. See the RabbitMQ documentation guides to learn more about RabbitMQ diagnostics, monitoring and health checks.

rabbitmq-diagnostics allows the operator to inspect node and cluster state. A number of health checks are available to be used interactively and by monitoring tools.

By default if it is not possible to connect to and authenticate with the target node (for example if it is stopped), the operation will fail. To learn more, see the RabbitMQ Monitoring guide

## OPTIONS
-n node

Default node is "rabbit@target-hostname", where target-hostname is the local host. On a host named "myserver.example.com", the node name will usually be "rabbit@myserver" (unless RABBITMQ_NODENAME has been overridden). The output of "hostname -s" is usually the correct suffix to use after the "@" sign. See rabbitmq-server(8) for details of configuring a RabbitMQ node.

-q, --quiet

Quiet output mode is selected. Informational messages are reduced when quiet mode is in effect.

-s, --silent

Silent output mode is selected. Informational messages are reduced and table headers are suppressed when silent mode is in effect.

-t timeout, --timeout timeout

Operation timeout in seconds. Not all commands support timeouts. Default is infinity.

-l, --longnames

Must be specified when the cluster is configured to use long (FQDN) node names. To learn more, see the RabbitMQ Clustering guide

--erlang-cookie cookie

Shared secret to use to authenticate to the target node. Prefer using a local file or the RABBITMQ_ERLANG_COOKIE environment variable instead of specifying this option on the command line. To learn more, see the RabbitMQ CLI Tools guide

## COMMANDS
Most commands provided by rabbitmq-diagnostics inspect node and cluster state or perform health checks.

Commands that list topology entities (e.g. queues) use tab as column delimiter. These commands and their arguments are delegated to rabbitmqctl(8).

Some commands ( list_queues, list_exchanges, list_bindings and list_consumers) accept an optional vhost parameter.

The list_queues, list_exchanges and list_bindings commands accept an optional virtual host parameter for which to display results. The default value is "/".

### Help
help [-l] [command_name]

Prints usage for all available commands.

-l, --list-commands

List command usages only, without parameter explanation.

command_name

Prints usage for the specified command.

version

Displays CLI tools version

### Nodes
wait

See wait in rabbitmqctl(8)

### Cluster
cluster_status

See cluster_status in rabbitmqctl(8)

### Users
list_users

See list_users in rabbitmqctl(8)

### Access Control
list_permissions [-p vhost]

See list_permissions in rabbitmqctl(8)

list_topic_permissions [-p vhost]

See list_topic_permissions in rabbitmqctl(8)

list_user_permissions username

See list_user_permissions in rabbitmqctl(8)

list_user_topic_permissions username

See list_user_topic_permissions in rabbitmqctl(8)

list_vhosts [vhostinfoitem ...]

See list_vhosts in rabbitmqctl(8)

### Monitoring, observability and health checks
alarms

Lists resource alarms, if any, in the cluster.

See RabbitMQ Resource Alarms guide to learn more.

Example:

rabbitmq-diagnostics alarms

certificates

Displays the node certificates for every listener on target node that is configured to use TLS.

Example:

rabbitmq-diagnostics certificates

check_alarms

Health check that fails (returns with a non-zero code) if there are alarms in effect on any of the cluster nodes.

See RabbitMQ Resource Alarms guide to learn more.

Example:

rabbitmq-diagnostics check_alarms

check_certificate_expiration [--unit time_unit] [--within seconds]

Checks the expiration date on the certificates for every listener on target node that is configured to use TLS. Supported time units are:

- days

- weeks

- months

- years

Example:

rabbitmq-diagnostics check_certificate_expiration --unit weeks --within 6

check_local_alarms

Health check that fails (returns with a non-zero code) if there are alarms in effect on the target node.

See RabbitMQ Resource Alarms guide to learn more.

Example:

rabbitmq-diagnostics check_local_alarms

check_port_connectivity

Health check that fails (returns with a non-zero code) if any listener ports on the target node cannot accept a new TCP connection opened by rabbitmq-diagnostics

The check only validates if a new TCP connection is accepted. It does not perform messaging protocol handshake or authenticate.

See RabbitMQ Networking guide to learn more.

Example:

rabbitmq-diagnostics check_port_connectivity

check_port_listener port

Health check that fails (returns with a non-zero code) if the target node is not listening on the specified port (there is no listener that uses that port).

See RabbitMQ Networking guide to learn more.

Example:

rabbitmq-diagnostics check_port_listener 5672

check_protocol_listener protocol

Health check that fails (returns with a non-zero code) if the target node does not have a listener for the specified protocol.

See RabbitMQ Networking guide to learn more.

Example:

rabbitmq-diagnostics check_protocol_listener mqtt

check_running

Health check that fails (returns with a non-zero code) if the RabbitMQ application is not running on the target node.

If rabbitmqctl(8) was used to stop the application, this check will fail.

Example:

rabbitmq-diagnostics check_running

check_virtual_hosts

Health check that checks if all vhosts are running in the target node

Example:

rabbitmq-diagnostics check_virtual_hosts --timeout 60

cipher_suites

Lists cipher suites enabled by default. To list all available cipher suites, add the --all argument.

Example:

rabbitmq-diagnostics cipher_suites --format openssl --all

command_line_arguments

Displays target node's command-line arguments and flags as reported by the runtime.

Example:

rabbitmq-diagnostics command_line_arguments -n rabbit@hostname

consume_event_stream [--duration seconds | -d seconds] [--pattern pattern] [--timeout milliseconds]

Streams internal events from a running node. Output is jq-compatible.

Example:

rabbitmq-diagnostics consume_event_stream -n rabbit@hostname --duration 20 --pattern queue_.*

discover_peers

Runs a peer discovery on the target node and prints the discovered nodes, if any.

See RabbitMQ Cluster Formation guide to learn more.

Example:

rabbitmq-diagnostics discover_peers --timeout 60

environment

See environment in rabbitmqctl(8)

erlang_cookie_hash

Outputs a hashed value of the shared secret used by the target node to authenticate CLI tools and peers. The value can be compared with the hash found in error messages of CLI tools.

See RabbitMQ Clustering guide to learn more.

Example:

rabbitmq-diagnostics erlang_cookie_hash -q

erlang_version

Reports target node's Erlang/OTP version.

Example:

rabbitmq-diagnostics erlang_version -q

is_booting

Reports if RabbitMQ application is currently booting (not booted/running or stopped) on the target node.

Example:

rabbitmq-diagnostics is_booting

is_running

Reports if RabbitMQ application is fully booted and running (that is, not stopped) on the target node.

Example:

rabbitmq-diagnostics is_running

list_bindings [-p vhost] [bindinginfoitem ...]

See list_bindings in rabbitmqctl(8)

list_channels [channelinfoitem ...]

See list_channels in rabbitmqctl(8)

list_ciphers

See list_ciphers in rabbitmqctl(8)

list_connections [connectioninfoitem ...]

See list_connections in rabbitmqctl(8)

list_consumers [-p vhost]

See list_consumers in rabbitmqctl(8)

list_exchanges [-p vhost] [exchangeinfoitem ...]

See list_exchanges in rabbitmqctl(8)

list_hashes

See list_hashes in rabbitmqctl(8)

list_queues [-p vhost] [--offline | --online | --local] [queueinfoitem ...]

See list_queues in rabbitmqctl(8)

list_unresponsive_queues [--local] [--queue-timeout milliseconds] [column ...] [--no-table-headers]

See list_unresponsive_queues in rabbitmqctl(8)

listeners

Lists listeners (bound sockets) on this node. Use this to inspect what protocols and ports the node is listening on for client, CLI tool and peer connections.

See RabbitMQ Networking guide to learn more.

Example:

rabbitmq-diagnostics listeners

log_tail [--number number | -N number [--timeout milliseconds] Prints the last N lines of the log on the node

Example:

rabbitmq-diagnostics log_tail --number 100

]

log_tail_stream [--duration seconds | -d seconds] [--timeout milliseconds]

Streams logs from a running node for a period of time

Example:

rabbitmq-diagnostics log_tail_stream --duration 60

maybe_stuck

Periodically samples stack traces of all Erlang processes ("lightweight threads") on the node. Reports the processes for which stack trace samples are identical.

Identical samples may indicate that the process is not making any progress but is not necessarily an indication of a problem.

Example:

rabbitmq-diagnostics maybe_stuck -q

memory_breakdown [--unit memory_unit]

Displays node's memory usage by category. Supported memory units are:

- bytes

- megabytes

- gigabytes

- terabytes

See RabbitMQ Memory Use guide to learn more.

Example:

rabbitmq-diagnostics memory_breakdown --unit gigabytes

observer [--interval seconds]

Starts a CLI observer interface on the target node

Example:

rabbitmq-diagnostics observer --interval 10

ping

Most basic health check. Succeeds if target node (runtime) is running and rabbitmq-diagnostics can authenticate with it successfully.

report

See report in rabbitmqctl(8)

runtime_thread_stats [--sample-interval interval]

Performs sampling of runtime (kernel) threads' activity for interval seconds and reports it.

For this command to work, Erlang/OTP on the target node must be compiled with microstate accounting support and have the runtime_tools package available.

Example:

rabbitmq-diagnostics runtime_thread_stats --sample-interval 15

schema_info [--no_table_headers] [column ...] [--timeout milliseconds]

See schema_info in rabbitmqctl(8)

server_version

Reports target node's version.

Example:

rabbitmq-diagnostics server_version -q

status

See status in rabbitmqctl(8)

tls_versions

Lists all TLS versions supported by the runtime on the target node. Note that RabbitMQ can be configured to only accept a subset of those versions, for example, SSLv3 is deactivated by default.

See RabbitMQ TLS guide to learn more.

Example:

rabbitmq-diagnostics tls_versions -q

### Parameters
list_global_parameters

See list_global_parameters in rabbitmqctl(8)

list_parameters [-p vhost]

See list_parameters in rabbitmqctl(8)

### Policies
list_operator_policies [-p vhost]

See list_operator_policies in rabbitmqctl(8)

list_policies [-p vhost]

See list_policies in rabbitmqctl(8)

### Virtual hosts
list_vhost_limits [--vhost vhost] [--global] [--no-table-headers]

See list_vhost_limits in rabbitmqctl(8)

### Node configuration
log_location [--all | -a] [--timeout milliseconds]

Shows log file location(s) on target node

Example:

rabbitmq-diagnostics log_location -a

### Feature flags
list_feature_flags [column ...] [--timeout milliseconds]

See list_feature_flags in rabbitmqctl(8)

### Queues
quorum_status queue [--vhost vhost]

See quorum_status in rabbitmq-queues(8)

check_if_cluster_has_classic_queue_mirroring_policy

See check_if_cluster_has_classic_queue_mirroring_policy in rabbitmq-queues(8)

check_if_node_is_quorum_critical

See check_if_node_is_quorum_critical in rabbitmq-queues(8)

## SEE ALSO
rabbitmqctl(8), rabbitmq-server(8), rabbitmq-queues(8), rabbitmq-streams(8), rabbitmq-upgrade(8), rabbitmq-service(8), rabbitmq-env.conf(5)

## AUTHOR
The RabbitMQ Team <contact-tanzu-data.pdl@broadcom.com>


rabbitmq-plugins

title: rabbitmq-plugins(8)

text:
# rabbitmq-plugins(8)

## NAME
rabbitmq-plugins — command line tool for managing RabbitMQ plugins

## SYNOPSIS
rabbitmq-plugins

[-q] [-s] [-l] [-n node] [-t timeout] command [command_options]

## DESCRIPTION
rabbitmq-plugins is a command line tool for managing RabbitMQ plugins. See the RabbitMQ Plugins guide for an overview of RabbitMQ plugins and how they are used.

rabbitmq-plugins allows the operator to enable, disable and inspect plugins. It must be run by a user with write permissions to the RabbitMQ configuration directory.

Plugins can depend on other plugins. rabbitmq-plugins resolves the dependencies and enables or disables all dependencies so that the user doesn't have to manage them explicitly. Plugins listed on the rabbitmq-plugins command line are marked as explicitly enabled; dependent plugins are marked as implicitly enabled. Implicitly enabled plugins are automatically disabled again when they are no longer required.

The enable, disable, and set commands will update the plugins file and then attempt to connect to the broker and ensure it is running all enabled plugins. By default if it is not possible to connect to and authenticate with the target node (for example if it is stopped), the operation will fail. If rabbitmq-plugins is used on the same host as the target node, --offline can be specified to make rabbitmq-plugins resolve and update plugin state directly (without contacting the node). Such changes will only have an effect on next node start. To learn more, see the RabbitMQ Plugins guide

## OPTIONS
-n node

Default node is "rabbit@target-hostname", where target-hostname is the local host. On a host named "myserver.example.com", the node name will usually be "rabbit@myserver" (unless RABBITMQ_NODENAME has been overridden). The output of "hostname -s" is usually the correct suffix to use after the "@" sign. See rabbitmq-server(8) for details of configuring a RabbitMQ node.

-q, --quiet

Quiet output mode is selected. Informational messages are reduced when quiet mode is in effect.

-s, --silent

Silent output mode is selected. Informational messages are reduced and table headers are suppressed when silent mode is in effect.

-t timeout, --timeout timeout

Operation timeout in seconds. Not all commands support timeouts. Default is infinity.

-l, --longnames

Must be specified when the cluster is configured to use long (FQDN) node names. To learn more, see the RabbitMQ Clustering guide

--erlang-cookie cookie

Shared secret to use to authenticate to the target node. Prefer using a local file or the RABBITMQ_ERLANG_COOKIE environment variable instead of specifying this option on the command line. To learn more, see the RabbitMQ CLI Tools guide

## COMMANDS
list [-Eemv] [pattern]

-E

Show only explicitly enabled plugins.

-e

Show only explicitly or implicitly enabled plugins.

-m

Show only plugin names (minimal).

-v

Show all plugin details (verbose).

pattern

Pattern to filter the plugin names by.

Lists all plugins, their versions, dependencies and descriptions. Each plugin is prefixed with two status indicator characters inside [ ]. The first indicator can be:

<space>

to indicate that the plugin is not enabled

E

to indicate that it is explicitly enabled

e

to indicate that it is implicitly enabled

to indicate that it is enabled but missing and thus not operational

The second indicator can be:

<space>

to show that the plugin is not running

*

to show that it is

If the optional pattern is given, only plugins whose name matches pattern are shown.

For example, this command lists all plugins, on one line each

rabbitmq-plugins list

This command lists all plugins:

rabbitmq-plugins list -v

This command lists all plugins whose name contains "management".

rabbitmq-plugins list -v management

This command lists all implicitly or explicitly enabled RabbitMQ plugins.

rabbitmq-plugins list -e rabbit

enable [--offline] [--online] plugin ...

--offline

Modify node's enabled plugin state directly without contacting the node.

--online

Treat a failure to connect to the running broker as fatal.

plugin

One or more plugins to enable separated by a space.

Enables the specified plugins and all their dependencies.

For example, this command enables the "shovel" and "management" plugins and all their dependencies:

rabbitmq-plugins enable rabbitmq_shovel rabbitmq_management

disable [--offline] [--online] plugin ...

--offline

Modify node's enabled plugin state directly without contacting the node.

--online

Treat a failure to connect to the running broker as fatal.

plugin

One or more plugins to disable separated by a space.

Disables the specified plugins and all their dependencies.

For example, this command disables "rabbitmq_management" and all plugins that depend on it:

rabbitmq-plugins disable rabbitmq_management

set [--offline] [--online] [plugin ...]

--offline

Modify node's enabled plugin state directly without contacting the node.

--online

Treat a failure to connect to the running broker as fatal.

plugin

Zero or more plugins to enable separated by a space.

Enables the specified plugins and all their dependencies. Unlike enable, this command ignores and overwrites any existing enabled plugins. set with no plugin arguments is a legal command meaning "disable all plugins".

For example, this command enables the "management" plugin and its dependencies and disables everything else:

rabbitmq-plugins set rabbitmq_management

## SEE ALSO
rabbitmqctl(8), rabbitmq-diagnostics(8), rabbitmq-server(8), rabbitmq-queues(8), rabbitmq-streams(8), rabbitmq-upgrade(8), rabbitmq-service(8), rabbitmq-env.conf(5)

## AUTHOR
The RabbitMQ Team <contact-tanzu-data.pdl@broadcom.com>


rabbitmq-queues

title: rabbitmq-queues(8)

summary: RabbitMQ queue management tools

text:
# rabbitmq-queues(8)

## NAME
rabbitmq-queues — RabbitMQ queue management tools

## SYNOPSIS
rabbitmq-queues

[-q] [-s] [-l] [-n node] [-t timeout] command [command_options]

## DESCRIPTION
rabbitmq-queues is a command line tool that provides commands used to manage queues, for example, grow, shrink or rebalance replicas of replicated queue types. See the RabbitMQ quorum queues guide and the general RabbitMQ queues guide to learn more about queue types in RabbitMQ.

## OPTIONS
-n node

Default node is "rabbit@target-hostname", where target-hostname is the local host. On a host named "myserver.example.com", the node name will usually be "rabbit@myserver" (unless RABBITMQ_NODENAME has been overridden). The output of "hostname -s" is usually the correct suffix to use after the "@" sign. See rabbitmq-server(8) for details of configuring a RabbitMQ node.

-q, --quiet

Quiet output mode is selected. Informational messages are reduced when quiet mode is in effect.

-s, --silent

Silent output mode is selected. Informational messages are reduced and table headers are suppressed when silent mode is in effect.

-t timeout, --timeout timeout

Operation timeout in seconds. Not all commands support timeouts. Default is infinity.

-l, --longnames

Must be specified when the cluster is configured to use long (FQDN) node names. To learn more, see the RabbitMQ Clustering guide

--erlang-cookie cookie

Shared secret to use to authenticate to the target node. Prefer using a local file or the RABBITMQ_ERLANG_COOKIE environment variable instead of specifying this option on the command line. To learn more, see the RabbitMQ CLI Tools guide

## COMMANDS
help

Displays general help and commands supported by rabbitmq-queues.

### Cluster
grow node selector --vhost-pattern pattern --queue-pattern pattern --errors-only

Adds a new replica on the given node for all or a half of matching queues.

Supported selector values are:

all

Selects all replicated queues

even

Selects replicated queues with an even number of replicas

Example:

rabbitmq-queues grow "rabbit@newhost" "all" --vhost-pattern "a-vhost" --queue-pattern ".*"

rebalance type --vhost-pattern pattern --queue-pattern pattern

Rebalances queue leader replicas across cluster nodes.

Supported type values are:

all

All queue types

quorum

Only quorum queues

classic

Only classic queues

stream

Only streams

Example:

rabbitmq-queues rebalance "all" --vhost-pattern "a-vhost" --queue-pattern ".*"

shrink node

Shrinks queue clusters by removing any members (replicas) on the given node.

Example:

rabbitmq-queues shrink "rabbit@decomissioned-node"

### Replication
add_member queue node --vhost virtual-host

Adds a queue member (replica) on the given node.

Example:

rabbitmq-queues add_member --vhost "a-vhost" "a-queue" "rabbit@new-node"

delete_member queue node --vhost virtual-host

Removes a queue member (replica) on the given node.

Example:

rabbitmq-queues delete_member --vhost "a-vhost" "a-queue" "rabbit@decomissioned-node"

### Queues
quorum_status queue --vhost virtual-host

Displays quorum status of a queue.

Example:

rabbitmq-queues quorum_status --vhost "a-vhost" "a-queue"

peek queue position --vhost virtual-host --timeout

Displays the details of a message at the given position in the queue. This command is currently only supported by quorum queues.

Example:

rabbitmq-queues peek --vhost "a-vhost" "a-queue" "1"

check_if_cluster_has_classic_queue_mirroring_policy

Health check that exits with a non-zero code if there are policies in the cluster that enable classic queue mirroring. Classic queue mirroring has been deprecated since 2021 and was completely removed in the RabbitMQ 4.0 development cycle.

Example:

rabbitmq-queues check_if_cluster_has_classic_queue_mirroring_policy

check_if_node_is_quorum_critical

Health check that exits with a non-zero code if there are queues with minimum online quorum (queues that would lose their quorum if the target node is shut down).

Example:

rabbitmq-queues check_if_node_is_quorum_critical

## SEE ALSO
rabbitmqctl(8), rabbitmq-diagnostics(8), rabbitmq-server(8), rabbitmq-streams(8), rabbitmq-upgrade(8), rabbitmq-service(8), rabbitmq-env.conf(5)

## AUTHOR
The RabbitMQ Team <contact-tanzu-data.pdl@broadcom.com>


rabbitmq-server

title: rabbitmq-server(8)

summary: starts a RabbitMQ node

text:
# rabbitmq-server(8)

## NAME
rabbitmq-server — starts a RabbitMQ node

## SYNOPSIS
rabbitmq-server

[-detached]

## DESCRIPTION
RabbitMQ is an open source multi-protocol messaging broker.

Running rabbitmq-server starts a RabbitMQ node in the foreground. The node will display a startup banner and report when startup is complete. To shut down the server, use service management tools or rabbitmqctl(8).

## ENVIRONMENT
RABBITMQ_CONFIG_FILE

Defaults to /etc/rabbitmq/rabbitmq.conf. Node configuration file path. To learn more, see the RabbitMQ Configuration guide

RABBITMQ_MNESIA_BASE

Defaults to /var/lib/rabbitmq/mnesia. Node data directory will be located (or created) in this directory. To learn more, see the RabbitMQ File and Directory guide

RABBITMQ_LOG_BASE

Defaults to /var/log/rabbitmq. Log files generated by the server will be placed in this directory. To learn more, see the RabbitMQ Logging guide

RABBITMQ_NODENAME

Defaults to "rabbit@". followed by the computed hostname. Can be used to run multiple nodes on the same host. Every node in a cluster must have a unique RABBITMQ_NODENAME To learn more, see the RabbitMQ Clustering guide

RABBITMQ_NODE_IP_ADDRESS

By default RabbitMQ will bind to all IPv6 and IPv4 interfaces available. This variable limits the node to one network interface or address family. To learn more, see the RabbitMQ Networking guide

RABBITMQ_NODE_PORT

AMQP 0-9-1 and AMQP 1.0 port. Defaults to 5672. To learn more, see the RabbitMQ Networking guide

## OPTIONS
-detached

Start the server process in the background. Note that this will cause the pid not to be written to the pid file. For example, runs RabbitMQ AMQP server in the background:

rabbitmq-server -detached

## SEE ALSO
rabbitmqctl(8), rabbitmq-diagnostics(8), rabbitmq-plugins(8), rabbitmq-queues(8), rabbitmq-streams(8), rabbitmq-upgrade(8), rabbitmq-service(8), rabbitmq-env.conf(5)

## AUTHOR
The RabbitMQ Team <contact-tanzu-data.pdl@broadcom.com>


rabbitmq-service

title: rabbitmq-service(8)

text:
# rabbitmq-service(8)

## NAME
rabbitmq-service.bat — tool for managing RabbitMQ Windows service

## SYNOPSIS
rabbitmq-service.bat

[command]

## DESCRIPTION
RabbitMQ is an open source multi-protocol messaging broker.

Running rabbitmq-service.bat allows the RabbitMQ broker to be run as a service in Windows® environments. The RabbitMQ broker service can be started and stopped using the Windows® services panel.

By default the service will run in the authentication context of the local system account. It is therefore necessary to synchronise Erlang cookies between the local system account (typically C:\Windows\.erlang.cookie and the account that will be used to run rabbitmqctl(8).

## COMMANDS
help

Display usage information.

install

Install the service. The service will not be started. Subsequent invocations will update the service parameters if relevant environment variables were modified.

remove

Remove the service. If the service is running then it will automatically be stopped before being removed. No files will be deleted as a consequence and rabbitmq-server(8) will remain operable.

start

Start the service. The service must have been correctly installed beforehand.

stop

Stop the service. The service must be running for this command to have any effect.

disable

Disable the service. This is the equivalent of setting the startup type to Disabled using the service control panel.

enable

Enable the service. This is the equivalent of setting the startup type to Automatic using the service control panel.

## ENVIRONMENT
RABBITMQ_SERVICENAME

Defaults to RabbitMQ.

RABBITMQ_BASE

Note: Windows only. Defaults to the application data directory of the current user. This is the location of log and database directories.

RABBITMQ_NODENAME

Defaults to "rabbit@". followed by the computed hostname. Can be used to run multiple nodes on the same host. Every node in a cluster must have a unique RABBITMQ_NODENAME To learn more, see the RabbitMQ Clustering guide

RABBITMQ_NODE_IP_ADDRESS

By default RabbitMQ will bind to all IPv6 and IPv4 interfaces available. This variable limits the node to one network interface or address family. To learn more, see the RabbitMQ Networking guide

RABBITMQ_NODE_PORT

AMQP 0-9-1 and AMQP 1.0 port. Defaults to 5672. To learn more, see the RabbitMQ Networking guide

ERLANG_SERVICE_MANAGER_PATH

Defaults to C:\Program Files\erl{version}\erts-{version}\bin (or C:\Program Files (x86)\erl{version}\erts-{version}\bin for 64-bit environments). This is the installation location of the Erlang service manager.

RABBITMQ_CONSOLE_LOG

Set this variable to new or reuse to have the console output from the server redirected to a file named SERVICENAME.debug in the application data directory of the user that installed the service. Under Vista this will be C:\Users\AppData\username\SERVICENAME. Under previous versions of Windows this will be C:\Documents and Settings\username\Application Data\SERVICENAME. If RABBITMQ_CONSOLE_LOG is set to new then a new file will be created each time the service starts. If RABBITMQ_CONSOLE_LOG is set to reuse then the file will be overwritten each time the service starts. The default behaviour when RABBITMQ_CONSOLE_LOG is not set or set to a value other than new or reuse is to discard the server output.

## SEE ALSO
rabbitmqctl(8), rabbitmq-diagnostics(8), rabbitmq-plugins(8), rabbitmq-server(8), rabbitmq-queues(8), rabbitmq-streams(8), rabbitmq-upgrade(8), rabbitmq-env.conf(5)

## AUTHOR
The RabbitMQ Team <contact-tanzu-data.pdl@broadcom.com>


rabbitmq-streams

title: rabbitmq-streams(8)

summary: RabbitMQ stream management tools

text:
# rabbitmq-streams(8)

## NAME
rabbitmq-streams — RabbitMQ stream management tools

## SYNOPSIS
rabbitmq-streams

[-q] [-s] [-l] [-n node] [-t timeout] command [command_options]

## DESCRIPTION
rabbitmq-streams is a command line tool that provides commands used to manage streams, for example, add or delete stream replicas. See the RabbitMQ streams overview.

## OPTIONS
-n node

Default node is "rabbit@target-hostname", where target-hostname is the local host. On a host named "myserver.example.com", the node name will usually be "rabbit@myserver" (unless RABBITMQ_NODENAME has been overridden). The output of "hostname -s" is usually the correct suffix to use after the "@" sign. See rabbitmq-server(8) for details of configuring a RabbitMQ node.

-q, --quiet

Quiet output mode is selected. Informational messages are reduced when quiet mode is in effect.

-s, --silent

Silent output mode is selected. Informational messages are reduced and table headers are suppressed when silent mode is in effect.

-t timeout, --timeout timeout

Operation timeout in seconds. Not all commands support timeouts. Default is infinity.

-l, --longnames

Must be specified when the cluster is configured to use long (FQDN) node names. To learn more, see the RabbitMQ Clustering guide

--erlang-cookie cookie

Shared secret to use to authenticate to the target node. Prefer using a local file or the RABBITMQ_ERLANG_COOKIE environment variable instead of specifying this option on the command line. To learn more, see the RabbitMQ CLI Tools guide

## COMMANDS
help

Displays general help and commands supported by rabbitmq-streams.

### Replication
add_replica queue node --vhost virtual-host

Adds a stream replica on the given node.

Example:

rabbitmq-streams add_replica --vhost "a-vhost" "a-queue" "rabbit@new-node"

delete_replica queue node --vhost virtual-host

Removes a stream replica on the given node.

Example:

rabbitmq-streams delete_replica --vhost "a-vhost" "a-queue" "rabbit@decomissioned-node"

### Monitoring, observability and health checks
stream_status stream --vhost virtual-host

Displays the status of a stream.

Example:

rabbitmq-streams stream_status --vhost "a-vhost" "a-stream"

restart_stream stream --vhost virtual-host --preferred-leader-node node

Restarts a stream including all of it's replicas. The optional preferred node flag instructs the command to try to place the leader on a specific node during the restart.

Example:

rabbitmq-streams restart_stream --vhost "a-vhost" "a-stream" --preferred-leader-node "node"

### Stream plugin
activate_stream_consumer --stream stream --reference reference [--vhost vhost]

Trigger a rebalancing to activate a consumer in a single active consumer group.

Example:

rabbitmq-streams activate_stream_consumer --stream stream --reference app-1

list_stream_connections [connectioninfoitem ...]

Returns stream protocol connection statistics.

The connectioninfoitem parameter is used to indicate which connection information items to include in the results. The column order in the results will match the order of the parameters. connectioninfoitem can take any value from the list that follows:

auth_mechanism

SASL authentication mechanism used, such as "PLAIN".

client_properties

Informational properties transmitted by the client during connection establishment.

conn_name

Readable name for the connection.

connected_at

Date and time this connection was established, as timestamp.

connection_state

Connection state; one of:

- running

- blocked

frame_max

Maximum frame size (bytes).

heartbeat

Negotiated heartbeat interval, in seconds.

host

Server hostname obtained via reverse DNS, or its IP address if reverse DNS failed or was disabled.

peer_cert_issuer

The issuer of the peer's SSL certificate, in RFC4514 form.

peer_cert_subject

The subject of the peer's SSL certificate, in RFC4514 form.

peer_cert_validity

The period for which the peer's SSL certificate is valid.

peer_host

Peer hostname obtained via reverse DNS, or its IP address if reverse DNS failed or was not enabled.

peer_port

Peer port.

port

Server port.

ssl

Boolean indicating whether the connection is secured with SSL.

ssl_cipher

SSL cipher algorithm (e.g. "aes_256_cbc").

ssl_hash

SSL hash function (e.g. "sha").

ssl_key_exchange

SSL key exchange algorithm (e.g. "rsa").

ssl_protocol

SSL protocol (e.g. "tlsv1").

subscriptions

Number of subscriptions (consumers) on the connection.

user

Username associated with the connection.

vhost

Virtual host name with non-ASCII characters escaped as in C.

If no connectioninfoitem are specified then only conn_name is displayed.

For example, this command displays the connection name and user for each connection:

rabbitmq-streams list_stream_connections conn_name user

list_stream_consumers [-p vhost] [consumerinfoitem ...]

Returns consumers attached to a stream.

The consumerinfoitem parameter is used to indicate which consumer information items to include in the results. The column order in the results will match the order of the parameters. consumerinfoitem can take any value from the list that follows:

active

Boolean indicating whether the consumer is active or not.

activity_status

Consumer activity status; one of:

- up

- single_active

- waiting

connection_pid

Id of the Erlang process associated with the consumer connection.

credits

Available credits for the consumer.

messages_consumed

Number of messages the consumer consumed.

offset

The offset (location in the stream) the consumer is at.

offset_lag

The difference between the last stored offset and the last dispatched offset for the consumer.

properties

The properties of the consumer subscription.

stream

The stream the consumer is attached to.

subscription_id

The connection-scoped ID of the consumer.

If no consumerinfoitem are specified then connection_pid, subscription_id, stream, messages_consumed, offset, offset_lag, credits, active, activity_status, and properties are displayed.

For example, this command displays the connection PID, subscription ID and stream for each consumer:

rabbitmq-streams list_stream_consumers connection_pid subscription_id stream

list_stream_publishers [-p vhost] [publisherinfoitem ...]

Returns registered publishers.

The publisherinfoitem parameter is used to indicate which publisher information items to include in the results. The column order in the results will match the order of the parameters. publisherinfoitem can take any value from the list that follows:

connection_pid

Id of the Erlang process associated with the consumer connection.

messages_confirmed

The number of confirmed messages for the publisher.

messages_errored

The number of errored messages for the publisher.

messages_published

The overall number of messages the publisher published.

publisher_id

The connection-scoped ID of the publisher.

reference

The deduplication reference of the publisher.

stream

The stream the publisher publishes to.

If no publisherinfoitem are specified then connection_pid, publisher_id, stream, reference, messages_published, messages_confirmed, and messages_errored are displayed.

For example, this command displays the connection PID, publisher ID and stream for each producer:

rabbitmq-streams list_stream_publishers connection_pid publisher_id stream

add_super_stream super-stream [--vhost vhost] [--partitions partitions] [--binding-keys binding-keys] [--max-length-bytes max-length-bytes] [--max-age max-age] [--stream-max-segment-size-bytes stream-max-segment-size-bytes] [--leader-locator leader-locator] [--initial-cluster-size initial-cluster-size]

super-stream

The name of the super stream to create.

vhost

The name of the virtual host to create the super stream into.

partitions

The number of partitions the super stream will have.

binding-keys

Comma-separated list of binding keys.

max-length-bytes

The maximum size of partition streams, example values: 20gb, 500mb.

max-age

The maximum age of partition stream segments, using the ISO 8601 duration format, e.g. PT10M30S for 10 minutes 30 seconds, P5DT8H for 5 days 8 hours.

stream-max-segment-size-bytes

The maximum size of partition stream segments, example values: 500mb, 1gb.

leader-locator

Leader locator strategy for partition streams. Possible values are:

- client-local

- balanced

The default is balanced

initial-cluster-size

The initial cluster size of partition streams.

Create a super stream.

delete_super_stream super-stream [--vhost vhost]

Delete a super stream.

super-stream

The name of the super stream to delete.

vhost

The virtual host of the super stream.

list_stream_consumer_groups [-p vhost] [groupinfoitem ...]

Lists groups of stream single active consumers for a vhost.

The groupinfoitem parameter is used to indicate which group information items to include in the results. The column order in the results will match the order of the parameters. groupinfoitem can take any value from the list that follows:

consumers

Number of consumers in the group.

partition_index

The stream partition index if the stream is part of a super stream, -1 if it is not.

reference

The group reference (name).

stream

The stream the consumers are attached to.

If no groupinfoitem are specified then stream, reference, partition_index, and consumers are displayed.

For example, this command displays the stream, reference, and number of consumers for each group:

rabbitmq-streams list_stream_consumer_groups stream reference consumers

list_stream_group_consumers --stream stream --reference reference [--vhost vhost] [consumerinfoitem ...]

Lists consumers of a stream consumer group in a vhost.

stream

The stream the consumers are attached to.

reference

The group reference (name).

vhost

The virtual host of the stream.

The consumerinfoitem parameter is used to indicate which consumer information items to include in the results. The column order in the results will match the order of the parameters. consumerinfoitem can take any value from the list that follows:

connection_name

Readable name of the consumer connection.

state

Consumer state; one of:

- active

- inactive

subscription_id

The connection-scoped ID of the consumer.

If no consumerinfoitem are specified then subscription_id, connection_name, and state are displayed.

For example, this command displays the connection name and state for each consumer attached to the stream-1 stream and belonging to the stream-1 group:

rabbitmq-streams list_stream_group_consumers --stream stream-1 --reference stream-1 connection_name state

list_stream_tracking stream [--all | --offset | --writer] [--vhost vhost]

Lists tracking information for a stream.

stream

The name of the stream.

Tracking information can be filtered by their type using one of the following mutually exclusive options:

--all

List offset tracking and writer deduplication information.

--offset

List only offset tracking information.

--writer

List only writer deduplication tracking information.

Example:

rabbitmq-streams list_stream_tracking stream-1 --offset

reset_offset --stream stream --reference reference [--vhost vhost]

Reset the stored offset for a consumer name on a stream.

Example:

rabbitmq-streams reset_offset --stream stream --reference app-1

## SEE ALSO
rabbitmqctl(8), rabbitmq-diagnostics(8), rabbitmq-server(8), rabbitmq-queues(8), rabbitmq-upgrade(8), rabbitmq-service(8), rabbitmq-env.conf(5)

## AUTHOR
The RabbitMQ Team <contact-tanzu-data.pdl@broadcom.com>


rabbitmq-upgrade

title: rabbitmq-upgrade(8)

summary: RabbitMQ installation upgrade tools

text:
# rabbitmq-upgrade(8)

## NAME
rabbitmq-upgrade — RabbitMQ installation upgrade tools

## SYNOPSIS
rabbitmq-upgrade

[-q] [-s] [-l] [-n node] [-t timeout] command [command_options]

## DESCRIPTION
rabbitmq-upgrade is a command line tool that provides commands used during the upgrade of RabbitMQ nodes. See the RabbitMQ upgrade guide to learn more about RabbitMQ installation upgrades.

## OPTIONS
-n node

Default node is "rabbit@target-hostname", where target-hostname is the local host. On a host named "myserver.example.com", the node name will usually be "rabbit@myserver" (unless RABBITMQ_NODENAME has been overridden). The output of "hostname -s" is usually the correct suffix to use after the "@" sign. See rabbitmq-server(8) for details of configuring a RabbitMQ node.

-q, --quiet

Quiet output mode is selected. Informational messages are reduced when quiet mode is in effect.

-s, --silent

Silent output mode is selected. Informational messages are reduced and table headers are suppressed when silent mode is in effect.

-t timeout, --timeout timeout

Operation timeout in seconds. Not all commands support timeouts. Default is infinity.

-l, --longnames

Must be specified when the cluster is configured to use long (FQDN) node names. To learn more, see the RabbitMQ Clustering guide

--erlang-cookie cookie

Shared secret to use to authenticate to the target node. Prefer using a local file or the RABBITMQ_ERLANG_COOKIE environment variable instead of specifying this option on the command line. To learn more, see the RabbitMQ CLI Tools guide

## COMMANDS
help

Displays general help and commands supported by rabbitmq-upgrade.

post_upgrade

Runs post-upgrade tasks. In the current version, it performs the rebalance of mirrored and quorum queues across all nodes in the cluster.

await_online_quorum_plus_one

Waits for all quorum queues to have an above minimum online quorum. This makes sure that no queues would lose their quorum if the target node is shut down.

drain

Puts the node in maintenance mode. Such nodes will not serve any client traffic or considered for hosting any queue leader replicas.

To learn more, see the RabbitMQ Upgrade guide

revive

Puts the node out of maintenance and into regular operating mode. Such nodes will again serve client traffic and considered for queue leader replica placement.

To learn more, see the RabbitMQ Upgrade guide

## SEE ALSO
rabbitmqctl(8), rabbitmq-diagnostics(8), rabbitmq-server(8), rabbitmq-queues(8), rabbitmq-streams(8), rabbitmq-service(8), rabbitmq-env.conf(5)

## AUTHOR
The RabbitMQ Team <contact-tanzu-data.pdl@broadcom.com>