1REMCTL(1) User Commands REMCTL(1)
2
6 remctl - Remote execution tool
7
9 remctl [-dhv] [-p port] [-s service] host type
10 service [parameters ...]
11
13 remctl is a program that allows a user to execute commands remotely on
14 a server that is running the remctld deamon. remctl does not interpret
15 the commands given to it, it passes them to the server and displays the
16 return message. The commands must be defined on the server-side before
17 a remctl client can execute them, and the user running remctl must be
18 authorized to execute the particular command on the server.
19 Access to remote commands is authenticated via Kerberos v5 GSS-API, so
21 a user must have a ticket granting ticket to use remctl. All transmis‐
22 sions to and from the remctld server are encrypted using GSS-API's
23 security layer.
24 host is the hostname of the target server. type and service together
26 specify the command to run and correspond to the command names in the
27 configuration file on the server. parameters are any additional com‐
28 mand-line parameters to pass to the remote command.
29
31 -d Turn on extra debugging output of the client-server interaction.
32 -h Show a brief usage message and then exit.
34 -p port
36 Connect to the server on port. If this option isn't given, the
37 client first tries the registered remctl port (4373) and then falls
38 back on the legacy port (4444) if that fails.
39 -s service
41 Authenticate to the server with a service ticket for service rather
42 than the default server identity of host/hostname. This may be
43 necessary with, for instance, a server where remctld is not running
44 as root.
45 -v Print the version of remctl and exit.
47
49 remctl will exit with the exit status returned by the remote command.
50 If some network or authentication error occurred and remctl was unable
51 to run the remote command or retrieve its exit status, or if remctl was
52 called with invalid arguments, remctl will exit with status 1.
53
55 Release an afs volume called ls.tripwire:
56 remctl lsdb afs release ls.tripwire
58
60 When using Heimdal with triple-DES keys and talking to old servers that
61 only speak version one of the remctl protocol, remctl may have problems
62 with MIC verification. This doesn't affect new clients and servers
63 since the version two protocol doesn't use MICs. If you are using
64 Heimdal and run into MIC verification problems, see the COMPATIBILITY
65 section of gssapi(3).
66 The default behavior, when the port is not specified, of trying 4373
68 and falling back to 4444 will be removed in a future version of remctl
69 in favor of using the "remctl" service in /etc/services if set and then
70 falling back on only 4373. 4444 was the poorly-chosen original remctl
71 port and should be phased out.
72
74 The remctl port number, 4373, was derived by tracing the diagonals of a
75 QWERTY keyboard up from the letters "remc" to the number row.
76
78 kinit(1), remctld(8)
79 The current version of this program is available from its web page at
81 <http://www.eyrie.org/~eagle/software/remctl/>.
82
84 Anton Ushakov <antonu@stanford.edu> is the original author. Updates
85 and current maintenance are done by Russ Allbery <rra@stanford.edu>.
86
88 Copyright 2002, 2003, 2004, 2005, 2006 Board of Trustees, Leland Stan‐
89 ford Jr. University. All rights reserved.
90 Permission to use, copy, modify, and distribute this software and its
92 documentation for any purpose and without fee is hereby granted, pro‐
93 vided that the above copyright notice appear in all copies and that
94 both that copyright notice and this permission notice appear in sup‐
95 porting documentation, and that the name of Stanford University not be
96 used in advertising or publicity pertaining to distribution of the
97 software without specific, written prior permission. Stanford Univer‐
98 sity makes no representations about the suitability of this software
99 for any purpose. It is provided "as is" without express or implied
100 warranty.
101 THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED
103 WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
104 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
1052.11 2007-09-01 REMCTL(1)