summaryrefslogtreecommitdiffstats
path: root/docs-xml/manpages/winexe.1.xml
blob: ddce91e3fa84f66914b1b7176cc0908a7f6fba26 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc">
<refentry id="winexe.1">

<refmeta>
	<refentrytitle>winexe</refentrytitle>
	<manvolnum>1</manvolnum>
	<refmiscinfo class="source">Samba</refmiscinfo>
	<refmiscinfo class="manual">User Commands</refmiscinfo>
	<refmiscinfo class="version">&doc.version;</refmiscinfo>
</refmeta>


<refnamediv>
	<refname>winexe</refname>
	<refpurpose>Winexe is a Remote Windows-command executor</refpurpose>
</refnamediv>

<refsynopsisdiv>
	<cmdsynopsis>
		<command>winexe</command>
		<arg choice="opt">--uninstall</arg>
		<arg choice="opt">--reinstall</arg>
		<arg choice="opt">--runas [DOMAIN/]USERNAME[%PASSWORD]</arg>
		<arg choice="opt">--runas-file FILE</arg>
		<arg choice="opt">--interactive [0|1]</arg>
		<arg choice="opt">--ostype [0|1]</arg>
		<arg choice="opt">-d|--debuglevel=DEBUGLEVEL</arg>
		<arg choice="opt">--debug-stdout</arg>
		<arg choice="opt">--configfile=CONFIGFILE</arg>
		<arg choice="opt">--option=name=value</arg>
		<arg choice="opt">-l|--log-basename=LOGFILEBASE</arg>
		<arg choice="opt">--leak-report</arg>
		<arg choice="opt">--leak-report-full</arg>
		<arg choice="opt">-R|--name-resolve=NAME-RESOLVE-ORDER</arg>
		<arg choice="opt">-O|--socket-options=SOCKETOPTIONS</arg>
		<arg choice="opt">-m|--max-protocol=MAXPROTOCOL</arg>
		<arg choice="opt">-n|--netbiosname=NETBIOSNAME</arg>
		<arg choice="opt">--netbios-scope=SCOPE</arg>
		<arg choice="opt">-W|--workgroup=WORKGROUP</arg>
		<arg choice="opt">--realm=REALM</arg>
		<arg choice="opt">-U|--user=[DOMAIN/]USERNAME%[PASSWORD]</arg>
		<arg choice="opt">-N|--no-pass</arg>
		<arg choice="opt">--password=STRING</arg>
		<arg choice="opt">--pw-nt-hash</arg>
		<arg choice="opt">-A|--authentication-file=FILE</arg>
		<arg choice="opt">-P|--machine-pass</arg>
		<arg choice="opt">--simple-bind-dn=DN</arg>
		<arg choice="opt">--use-kerberos=desired|required|off</arg>
		<arg choice="opt">--use-krb5-ccache=CCACHE</arg>
		<arg choice="opt">--use-winbind-ccache</arg>
		<arg choice="opt">--client-protection=sign|encrypt|off</arg>
		<arg choice="opt">-V|--version</arg>
		<arg choice="opt">-?|--help</arg>
		<arg choice="opt">--usage</arg>
	</cmdsynopsis>
</refsynopsisdiv>

<refsect1>
	<title>DESCRIPTION</title>

	<para>This tool is part of the <citerefentry><refentrytitle>samba</refentrytitle>
	<manvolnum>7</manvolnum></citerefentry> suite.</para>

	<para>The <command>winexe</command> allows remote command execution on native
	Windows operating systems.</para>
</refsect1>

<refsect1>
	<title>OPTIONS</title>

	<variablelist>
		<varlistentry>
		<term>--uninstall</term>
		<listitem>
			<para>
				Uninstall winexe service after remote execution.
			</para>
		</listitem>
		</varlistentry>

		<varlistentry>
		<term>--reinstall</term>
		<listitem>
			<para>
				Reinstall winexe service before remote execution.
			</para>
		</listitem>
		</varlistentry>

		<varlistentry>
		<term>--runas <replaceable>[DOMAIN/]USERNAME[%PASSWORD]]</replaceable></term>
		<listitem>
			<para>
				Run as the given user (BEWARE: this password is sent in cleartext over the network!)
			</para>
		</listitem>
		</varlistentry>

		<varlistentry>
		<term>--runas-file <replaceable>FILE</replaceable></term>
		<listitem>
			<para>
				Run as user options defined in a file.
			</para>
		</listitem>
		</varlistentry>

		<varlistentry>
		<term>--interactive <replaceable>[0|1]</replaceable></term>
		<listitem>
		<para>
			Desktop interaction.
		</para>

			<para>There are two options:</para>
			<itemizedlist>
				<listitem>
				<para>
					0 - disallow
				</para>
				</listitem>

				<listitem>
				<para>
					1 - allow. If allow, also use the --system switch (Windows requirement). Vista does not support this optoin.
				</para>
				</listitem>
			</itemizedlist>
		</listitem>
		</varlistentry>

		<varlistentry>
			<term>--ostype <replaceable>[0|1|2]</replaceable></term>
			<listitem>
			<para>
				Determines which version (32-bit or 64-bit) of service will be installed.
			</para>

			<para>There are three options:</para>
			<itemizedlist>
				<listitem>
				<para>
					0 - 32-bit
				</para>
				</listitem>

				<listitem>
				<para>
					1 - 64-bit
				</para>
				</listitem>

				<listitem>
				<para>
					2 - winexe will decide
				</para>
				</listitem>
			</itemizedlist>
		</listitem>
		</varlistentry>

		&cmdline.common.samba.client;
		&cmdline.common.connection;
		&cmdline.common.credentials;
		&popt.autohelp;
	</variablelist>
</refsect1>


<refsect1>
	<title>EXIT STATUS</title>

	<para>The winexe program returns 0 if the operation
	succeeded, or 1 if the operation failed. </para>
</refsect1>


<refsect1>
	<title>VERSION</title>

	<para>This man page is part of version &doc.version; of
	the Samba suite.</para>
</refsect1>

<refsect1>
	<title>AUTHOR</title>

	<para>The original Samba software and related utilities
	were created by Andrew Tridgell. Samba is now developed
	by the Samba Team as an Open Source project similar
	to the way the Linux kernel is developed.</para>

	<para>The <command>winexe</command> and it's native Windows counterpart were written by Andrzej Hajda.
	The Samba client tool winexe was later rewritten by Volker Lendecke.</para>

	<para>This manpage was written by Guenther Deschner.</para>
</refsect1>

</refentry>