Skip to content

zpool status: add -E flag for pool exclusion #17902

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

zpool status: add -E flag for pool exclusion #17902

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
66 changes: 63 additions & 3 deletions cmd/zpool/zpool_main.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -522,7 +522,7 @@ get_usage(zpool_help_t idx)
"<-a | <pool> [<device> ...]>\n"));
case HELP_STATUS:
return (gettext("\tstatus [-DdegiLPpstvx] "
"[-c script1[,script2,...]] ...\n"
"[-E pool1[,pool2,...]] [-c script1[,script2,...]] ...\n"
"\t [-j|--json [--json-flat-vdevs] [--json-int] "
"[--json-pool-key-guid]] ...\n"
"\t [-T d|u] [--power] [pool] [interval [count]]\n"));
Expand Down Expand Up @@ -2608,6 +2608,8 @@ typedef struct status_cbdata {
nvlist_t *cb_jsobj;
boolean_t cb_json_as_int;
boolean_t cb_json_pool_key_guid;
char **cb_exclude_pools;
int cb_exclude_count;
} status_cbdata_t;

/* Return 1 if string is NULL, empty, or whitespace; return 0 otherwise. */
Expand Down Expand Up @@ -10813,6 +10815,15 @@ status_callback_json(zpool_handle_t *zhp, void *data)
zpool_status_t reason;
zpool_errata_t errata;
uint_t c;

/* Skip excluded pools */
if (cbp->cb_exclude_pools != NULL && cbp->cb_exclude_count > 0) {
const char *poolname = zpool_get_name(zhp);
for (int i = 0; i < cbp->cb_exclude_count; i++) {
if (strcmp(poolname, cbp->cb_exclude_pools[i]) == 0)
return (0);
}
}
vdev_stat_t *vs;
nvlist_t *item, *d, *load_info, *vds;

Expand Down Expand Up @@ -10935,6 +10946,15 @@ status_callback(zpool_handle_t *zhp, void *data)
uint_t c;
vdev_stat_t *vs;

/* Skip excluded pools */
if (cbp->cb_exclude_pools != NULL && cbp->cb_exclude_count > 0) {
const char *poolname = zpool_get_name(zhp);
for (int i = 0; i < cbp->cb_exclude_count; i++) {
if (strcmp(poolname, cbp->cb_exclude_pools[i]) == 0)
return (0);
}
}

/* If dedup stats were requested, also fetch dedupcached. */
if (cbp->cb_dedup_stats > 1)
zpool_add_propname(zhp, ZPOOL_DEDUPCACHED_PROP_NAME);
Expand Down Expand Up @@ -11124,6 +11144,7 @@ zpool_do_status(int argc, char **argv)
status_cbdata_t cb = { 0 };
nvlist_t *data;
char *cmd = NULL;
char *exclude_str = NULL;

struct option long_options[] = {
{"power", no_argument, NULL, ZPOOL_OPTION_POWER},
Expand All @@ -11137,7 +11158,7 @@ zpool_do_status(int argc, char **argv)
};

/* check options */
while ((c = getopt_long(argc, argv, "c:jdDegiLpPstT:vx", long_options,
while ((c = getopt_long(argc, argv, "c:jdDeE:giLpPstT:vx", long_options,
NULL)) != -1) {
switch (c) {
case 'c':
Expand Down Expand Up @@ -11180,6 +11201,32 @@ zpool_do_status(int argc, char **argv)
case 'i':
cb.cb_print_vdev_init = B_TRUE;
break;
case 'E':
/* Exclude comma-separated pools from output */
if (cb.cb_exclude_pools != NULL) {
(void) fprintf(stderr,
gettext("Can't set -E flag twice\n"));
exit(1);
}
if (optarg[0] == '-') {
(void) fprintf(stderr, gettext("-E: invalid "
"pool name '%s'\n"), optarg);
usage(B_FALSE);
}
int i = 0;
cb.cb_exclude_count = 1;
for (char *p = optarg; *p; p++)
cb.cb_exclude_count += (*p == ',');
cb.cb_exclude_pools =
safe_malloc(cb.cb_exclude_count * sizeof (char *));
exclude_str = strdup(optarg);
char *arg_ptr = exclude_str;
for (char *pool; (pool = strsep(&arg_ptr, ",")); ) {
if (pool[0] != '\0')
cb.cb_exclude_pools[i++] = pool;
}
cb.cb_exclude_count = i;
break;
case 'L':
cb.cb_name_flags |= VDEV_NAME_FOLLOW_LINKS;
break;
Expand Down Expand Up @@ -11224,6 +11271,10 @@ zpool_do_status(int argc, char **argv)
if (optopt == 'c') {
print_zpool_script_list("status");
exit(0);
} else if (optopt == 'E') {
(void) fprintf(stderr,
gettext("-E requires pool names\n"));
usage(B_FALSE);
} else {
fprintf(stderr,
gettext("invalid option '%c'\n"), optopt);
Expand Down Expand Up @@ -11317,8 +11368,13 @@ zpool_do_status(int argc, char **argv)
}
}

if (ret != 0)
if (ret != 0) {
if (exclude_str != NULL)
free(exclude_str);
if (cb.cb_exclude_pools != NULL)
free(cb.cb_exclude_pools);
return (ret);
}

if (interval == 0)
break;
Expand All @@ -11330,6 +11386,10 @@ zpool_do_status(int argc, char **argv)
(void) fsleep(interval);
}

if (exclude_str != NULL)
free(exclude_str);
if (cb.cb_exclude_pools != NULL)
free(cb.cb_exclude_pools);
return (0);
}

Expand Down
17 changes: 17 additions & 0 deletions man/man8/zpool-status.8
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@
.Nm zpool
.Cm status
.Op Fl DdegiLPpstvx
.Op Fl E Ar pool1 Ns Oo , Ns Ar pool2 Ns ,… Oc
.Op Fl c Ar script1 Ns Oo , Ns Ar script2 Ns ,… Oc
.Oo Fl j|--json
.Oo Ns Fl -json-flat-vdevs Oc
Expand Down Expand Up @@ -95,6 +96,22 @@ Direct I/O reads checksum verify errors can also occur if the contents of the
buffer are being manipulated after the I/O has been issued and is in flight.
In the case of Direct I/O read checksum verify errors, the I/O will be reissued
through the ARC.
.It Fl E Ar pool Ns Oo , Ns Ar pool Oc Ns ...
Exclude specified pools from output.
Multiple pool names can be specified separated by commas.
.Pp
Examples:
.Bl -bullet -compact
.It
.Ql zpool status -E tank
shows all pools except tank.
.It
.Ql zpool status -E tank,backup
shows all pools except tank and backup.
.It
.Ql zpool status pool1 pool2 -E pool1
shows only pool2 (pool1 is excluded).
.El
.It Fl e
Only show unhealthy vdevs (not-ONLINE or with errors).
.It Fl g
Expand Down
Loading