diff --git a/xCAT-client/pods/man1/nodestat.1.pod b/xCAT-client/pods/man1/nodestat.1.pod index 14519e857..f60de1bfd 100644 --- a/xCAT-client/pods/man1/nodestat.1.pod +++ b/xCAT-client/pods/man1/nodestat.1.pod @@ -40,9 +40,17 @@ Keywords to use: apps -- a list of comma separated application names whose status will be queried. For how to get the status of each app, look for app name in the key filed in a different row. port -- the application daemon port number, if not specified, use internal list, then /etc/services. group -- the name of a node group that needs to get the application status from. If not specified, assume all the nodes in the nodelist table. To specify more than one groups, use group=a,group=b format. - cmd -- the command will be run locally on mn or sn. - dcmd -- the command will be run distributed on the nodes (xdsh ...). + cmd -- the command that will be run locally on mn or sn. + lcmd -- the command that will be run the the mn only. + dcmd -- the command that will be run distributed on the nodes using xdsh .... +For commands specified by 'cmd' and 'lcmd', the input of is a list of comma separated node names, the output must be in the following format: + + node1:string1 + node2:string2 + ... + +For the command specified by 'dcmd', no input is needed, the output can be a string. =head1 B diff --git a/xCAT-client/share/doc/xCAT2-Monitoring.odt b/xCAT-client/share/doc/xCAT2-Monitoring.odt index 96690fce5..4f3465999 100644 Binary files a/xCAT-client/share/doc/xCAT2-Monitoring.odt and b/xCAT-client/share/doc/xCAT2-Monitoring.odt differ diff --git a/xCAT-client/share/doc/xCAT2-Monitoring.pdf b/xCAT-client/share/doc/xCAT2-Monitoring.pdf index 16a83d27b..50fef2b4c 100644 Binary files a/xCAT-client/share/doc/xCAT2-Monitoring.pdf and b/xCAT-client/share/doc/xCAT2-Monitoring.pdf differ diff --git a/xCAT-server/lib/xcat/monitoring/xcatmon.pm b/xCAT-server/lib/xcat/monitoring/xcatmon.pm index a7cb7d335..0df9a34f9 100644 --- a/xCAT-server/lib/xcat/monitoring/xcatmon.pm +++ b/xCAT-server/lib/xcat/monitoring/xcatmon.pm @@ -424,7 +424,16 @@ sub getDescription { group -- the name of a node group that needs to get the application status from. If not specified, assume all the nodes in the nodelist table. To specify more than one groups, use group=a,group=b format. - cmd -- the command will be run locally on mn or sn. - dcmd -- the command will be run distributed on the nodes (xdsh ...)."; + cmd -- the command that will be run locally on mn or sn. + lcmd -- the command that will be run locally on the mn only. + dcmd -- the command that will be run distributed on the nodes using xdsh. + + For commands specified by 'cmd' and 'lcmd', the input of is a list of comma + separated node names, the output must be in the following format: + node1:string1 + node2:string2 + ... + For the command specified by 'dcmd', no input is needed, the output can be a + string."; }