xCAT/xcat-core
2
0
Fork 0
mirror of https://github.com/xcat2/xcat-core.git synced 2025-07-02 19:05:32 +00:00
Code Issues Releases Wiki Activity

Remove trailing spaces in file xCAT-client/pods/man1/xdsh.1.pod

Browse Source
This commit is contained in:
GONG Jie
2017-12-31 23:59:59 +00:00
parent e2805aa282
commit 2e8c168b89
1 changed files with 37 additions and 37 deletions
Download Patch File Download Diff File Expand all files Collapse all files

74
xCAT-client/pods/man1/xdsh.1.pod
View File

@ -8,13 +8,13 @@ B<xdsh> I<noderange> [B<-B> | B<--bypass>] [B<--devicetype> I<type_of_device>]
[B<-L>] [B<-l> I<userID>] [B<-m>] [B<-o> I<node_options>] [B<-Q>] [B<-r> I<node_remote_shell>] [B<-s>] [B<-S> {B<csh>|B<ksh>}] [B<-t> I<timeout>]
[B<-T>] [B<-v>] [B<-X> I<env_list>] [B<-z>] [B<--sudo>] I<command_list>
B<xdsh> I<noderange> [B<-K>]
B<xdsh> I<noderange> [B<-K>]
B<xdsh> I<noderange> [B<-K>] [B<-l> I<userID>] B<--devicetype> I<type_of_device>
B<xdsh> I<noderange> [B<-K>] [B<-l> I<userID>] B<--devicetype> I<type_of_device>
B<xdsh> [B<-i> I<image path | nim image name>] I<command_list>
B<xdsh> I<noderange> [B<-c>]
B<xdsh> I<noderange> [B<-c>]
B<xdsh> [B<-h> | B<-V> | B<-q>]
@ -24,7 +24,7 @@ The B<xdsh> command runs commands in parallel on remote nodes and/or the Managem
remote shell command for each target specified, and returns the output
from all targets,
formatted so that command results from all nodes can be managed.
If the command is to be executed on the Management Node, it does not use a remote shell command, but uses the local OS copy or shell command. The Management Node must be defined in the xCAT database. The best way to do this is to use the xcatconfig -m option.
If the command is to be executed on the Management Node, it does not use a remote shell command, but uses the local OS copy or shell command. The Management Node must be defined in the xCAT database. The best way to do this is to use the xcatconfig -m option.
The B<xdsh> command is an xCAT Distributed Shell Utility.
@ -109,7 +109,7 @@ A timeout value for remote command execution can be specified with the
B<-t> flag or with the B<DSH_TIMEOUT> environment variable. If any remote
target does not provide output to either standard output or standard
error within the timeout value, B<xdsh> displays an error message and
exits.
exits.
If streaming mode is specified with the B<-s> flag, output is returned as
it becomes available from each target, instead of waiting for the
@ -131,7 +131,7 @@ executed on the remote targets are displayed.
No error detection or recovery mechanism is provided for remote
targets. The B<xdsh> command output to standard error and standard output can
be analyzed to determine the appropriate course of action.
be analyzed to determine the appropriate course of action.
B<COMMAND> B<OUTPUT>:
@ -175,13 +175,13 @@ Runs in bypass mode, use if the xcatd daemon is hung.
=item B<-c>|B<--cleanup>
This flag will have xdsh remove all files from the subdirectories of the
the directory on the servicenodes, where xdcp stages the copy to the
the directory on the servicenodes, where xdcp stages the copy to the
compute nodes as defined in the site table SNsyncfiledir and nodesyncfiledir
attribute, when the target is a service node.
attribute, when the target is a service node.
It can also be used to remove the nodesyncfiledir directory on the compute
It can also be used to remove the nodesyncfiledir directory on the compute
nodes, which keeps the backup copies of files for the xdcp APPEND function
support, if a compute node is the target.
support, if a compute node is the target.
=item B<-e>|B<--execute>
@ -196,7 +196,7 @@ command to use to copy the script file to node targets.
Specifies that the I<environment_file> contains environment
variable definitions to export to the target before
executing the I<command_list>.
executing the I<command_list>.
=item B<--devicetype> I<type_of_device>
@ -204,14 +204,14 @@ Specify a user-defined device type that references the location
of relevant device configuration file. The devicetype value must
correspond to a valid device configuration file.
xCAT ships some default configuration files
for Ethernet switches and and IB switches under
for Ethernet switches and and IB switches under
I</opt/xcat/share/xcat/devicetype> directory. If you want to overwrite
any of the configuration files, copy them to I</var/opt/xcat/>
directory and cutomize.
directory and cutomize.
For example, I<base/IBSwitch/Qlogic/config> is the configuration
file location if devicetype is specified as IBSwitch::Qlogic.
xCAT will first search config file using I</var/opt/xcat/> as the base.
If not found, it will search for it using
xCAT will first search config file using I</var/opt/xcat/> as the base.
If not found, it will search for it using
I</opt/xcat/share/xcat/devicetype/> as the base.
=item B<-f>|B<--fanout> I<fanout_value>
@ -226,16 +226,16 @@ Displays usage information.
=item B<-i>|B<--rootimg> I<install image>
For Linux, Specifies the path to the install image on the local node.
For AIX, specifies the name of the osimage on the local node. Run lsnim
For AIX, specifies the name of the osimage on the local node. Run lsnim
for valid names.
xdsh will chroot (xcatchroot for AIX) to this path and run the xdsh command against the
install image. No other xdsh flags, environment variables apply with
this input. A noderange is not accepted. Only runs on the local host,
normally the Management Node. The command you run must not prompt for input, the prompt will not be returned to you, and it will appear that B<xdsh> hangs.
install image. No other xdsh flags, environment variables apply with
this input. A noderange is not accepted. Only runs on the local host,
normally the Management Node. The command you run must not prompt for input, the prompt will not be returned to you, and it will appear that B<xdsh> hangs.
=item B<-K>|B<--ssh-setup>
=item B<-K>|B<--ssh-setup> B<-l>|B<--user> I<user_ID> B<--devicetype> I<type_of_device>
=item B<-K>|B<--ssh-setup> B<-l>|B<--user> I<user_ID> B<--devicetype> I<type_of_device>
Set up the SSH keys for the user running the command to the specified node list.
The userid must have the same uid, gid and password as the userid on the node
@ -247,9 +247,9 @@ If the current user is non-root, the user must be in the policy table and have c
The non-root users public ssh keys and root's public ssh keys will be put in
the authorized_keys* files under the non-root users .ssh directory on the node(s).
Other device types, such as IB switch, are also supported. The
device should be defined as a node and nodetype should be defined
device should be defined as a node and nodetype should be defined
as switch before connecting.
The B<xdsh -K> command must be run from the Management Node.
The B<xdsh -K> command must be run from the Management Node.
=item B<-l>|B<--user> I<user_ID>
@ -307,14 +307,14 @@ If not specified, the B<ksh> syntax is used.
Adding the B<--sudo> flag to the xdsh command will have xdsh run sudo before
running the command. This is particular useful when using the B<-e> option.
This is required when you input B<-l> with a non-root user id and want that id
to be able to run as root on the node. The non-root userid will must be
to be able to run as root on the node. The non-root userid will must be
previously defined as an xCAT user, see process for defining non-root ids in
xCAT and setting up for using xdsh. The userid sudo setup will have
xCAT and setting up for using xdsh. The userid sudo setup will have
to be done by the admin on the node. This includes, allowing all commands that
you would like to run with xdsh by using visudo to edit the /etc/sudoers file.
You must disabl ssh tty requirements by commenting out or removing this line in the /etc/sudoes file "#Defaults requiretty".
You must disabl ssh tty requirements by commenting out or removing this line in the /etc/sudoes file "#Defaults requiretty".
See the document Granting_Users_xCAT_privileges for sudo setup requirements.
This is not supported in a hierarical cluster, that is the nodes are serviced by servicenodes.
This is not supported in a hierarical cluster, that is the nodes are serviced by servicenodes.
=item B<-t>|B<--timeout> I<timeout>
@ -324,8 +324,8 @@ available from any target in the specified I<timeout>, B<xdsh>
displays an error and terminates execution for the remote
targets that failed to respond. If I<timeout> is not specified,
B<xdsh> waits indefinitely to continue processing output from
all remote targets. The exception is the B<-K> flag which defaults
to 10 seconds.
all remote targets. The exception is the B<-K> flag which defaults
to 10 seconds.
=item B<-T>|B<--trace>
@ -455,7 +455,7 @@ Verifies each target before executing any remote commands on the target. If a ta
To provide backward compatibility for scripts written using B<dsh> in
AIX and CSM, a tool has been provided B<groupfiles4dsh>,
which will build node group files from the
xCAT database that can be used by B<dsh>. See B<man groupfiles4dsh>.
xCAT database that can be used by B<dsh>. See B<man groupfiles4dsh>.
=head1 B<SECURITY>
@ -482,7 +482,7 @@ The B<xdsh> command exit code is 0 if the command executed without errors and al
=over 3
=item 1.
To set up the SSH keys for root on node1, run as root:
To set up the SSH keys for root on node1, run as root:
xdsh node1 -K
@ -509,7 +509,7 @@ environment variable except the DSH_NODE_OPTS, enter:
xdsh node1 -X `DSH_NODE_OPTS' ps
=item 6.
To run on Linux, the xdsh command "rpm -qa | grep xCAT"
To run on Linux, the xdsh command "rpm -qa | grep xCAT"
on the service node fedora9 diskless image, enter:
xdsh -i /install/netboot/fedora9/x86_64/service/rootimg "rpm -qa | grep xCAT"
@ -520,13 +520,13 @@ To run on AIX, the xdsh command "lslpp -l | grep bos" on the NIM 611dskls spot,
xdsh -i 611dskls "/usr/bin/lslpp -l | grep bos"
=item 8.
To cleanup the servicenode directory that stages the copy of files to the nodes, enter:
To cleanup the servicenode directory that stages the copy of files to the nodes, enter:
xdsh servicenoderange -c
xdsh servicenoderange -c
=item 9.
To define the QLogic IB switch as a node and to set up the SSH keys for IB switch
To define the QLogic IB switch as a node and to set up the SSH keys for IB switch
B<qswitch> with device configuration file
B</var/opt/xcat/IBSwitch/Qlogic/config> and user name B<username>, enter
@ -540,7 +540,7 @@ To define the Management Node in the database so you can use B<xdsh>, enter
xcatconfig -m
=item 11.
To define the Mellanox switch as a node and run a command to show the ssh keys.
To define the Mellanox switch as a node and run a command to show the ssh keys.
B<mswitch> with and user name B<username>, enter
chdef -t node -o mswitch groups=all nodetype=switch
@ -555,9 +555,9 @@ To define a BNT Ethernet switch as a node and run a command to create a new vlan
tabch switch=myswitch switches.sshusername=admin switches.sshpassword=passw0rd switches.protocol=[ssh|telnet]
where I<admin> and I<passw0rd> are the SSH user name and password for the switch.
where I<admin> and I<passw0rd> are the SSH user name and password for the switch.
If it is for Telnet, add I<tn:> in front of the user name: I<tn:admin>.
If it is for Telnet, add I<tn:> in front of the user name: I<tn:admin>.
dsh myswitch --devicetype EthSwitch::BNT 'enable;configure terminal;vlan 3;end;show vlan'