summaryrefslogtreecommitdiffstats
path: root/doc/wsman.xml
blob: 5c09954ec261a4fd461686a7ae16729b8f41a9e4 (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
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE refentry SYSTEM "http://www.docbook.org/xml/4.4/docbookx.dtd">
<refentry id="wsman">
    <refmeta>
        <refentrytitle>wsman</refentrytitle>
        <manvolnum>1</manvolnum>
    </refmeta>
    
    <refnamediv>
        <refname>wsman</refname>
        <refpurpose>openwsman command-line client</refpurpose>
    </refnamediv>
    
    <refsynopsisdiv>
        <cmdsynopsis>
            <command>/usr/bin/wsman</command>
            <arg choice="opt">
                <option>options</option>
            </arg>     
            <arg choice="req">action</arg>
            <arg choice="opt">resource uri</arg>
   
        </cmdsynopsis>
    </refsynopsisdiv>
    
    <refsect1><title>Description</title>
        <para>
            Openwsman provides a command-line tool, <command>wsman</command>, to perform basic operations on the command-line. These operations include <literal>Get</literal>, <literal>Put</literal>, <literal>Invoke</literal>, <literal>Identify</literal>, <literal>Delete</literal>, <literal>Create</literal>, and <literal>Enumerate</literal>. The command-line tool also has several switches to allow for optional features of the WS-Management specification and Testing. 
        </para>
        
    </refsect1>
    <refsect1><title>Options</title>
        <para>
            All <command>wsman</command> operations require and <literal>action</literal> and a group of options. The <literal>resource uri</literal> is required for the <literal>Identify</literal> action, otherwise it is required for all actions.
        </para>
        
        <refsect2>
            <title>Support Actions</title>
            <variablelist>
                <varlistentry>
                    <term>get</term>
                    <listitem>
                        <para>Creates and sends a Get request to the specified remote system. In most cases this action requires a <literal>resource uri</literal> with a set of selectors which can be specfied as query paramters in the URI (See below for examples).</para>
                        <para>The result of this action is an XML output of the envelope with the resource and its properties.</para>
                    </listitem>
                </varlistentry>
                <varlistentry>
                    <term>put</term>
                    <listitem>
                        <para>Creates and sends a Put request to the specified remote system. In most cases this action requires a <literal>resource uri</literal> with a set of selectors which can be specfied as query paramters in the URI (See below for examples). This action also requires input which can be specified either as properties or as an XML input representing the new resource.</para>
                        <para>The result of this action is an XML output of the envelope with the new resource and its properties.</para>
                    </listitem>
                </varlistentry>    
                <varlistentry>
                    <term>invoke</term>
                    <listitem>
                        <para>Creates and sends a request with a custom action to the specified remote system. In most cases this action requires a <literal>resource uri</literal> with a set of selectors which can be specfied as query paramters in the URI (See below for examples). This action also requires input which can be specified either as properties or as an XML input representing the arguments of the custom action.</para>
                        <para>The result of this action is an XML output of the envelope with the output of the custom action.</para>
                    </listitem>
                </varlistentry>    
                <varlistentry>
                    <term>enumerate</term>
                    <listitem>
                        <para>Creates and sends an Enumeration request to the specified remote system. This action also peforms Pull actions using the <literal>enumeration context</literal> provided by the enumeration response and following pull responses.</para>
                        <para>The result of this action is an XML output of the envelope with the resource or resources and its/their properties.</para>
                    </listitem>
                </varlistentry>   
                
                <varlistentry>
                    <term>identify</term>
                    <listitem>
                        <para>Creates and sends an Identify request to the specified remote system.</para>
                        <para>The result of this action is an XML output with properties of the services defined by the specification.</para>
                    </listitem>
                </varlistentry>    
            </variablelist>
            
        </refsect2>
        
        <refsect2>
             <title>Basic Startup Options</title>
             <variablelist>
                 <varlistentry>
                     <term>-u <replaceable>username</replaceable>, --username <replaceable>username</replaceable></term>
                     <listitem><para>
                         User name                       
                     </para></listitem>
                 </varlistentry>
                 
                 <varlistentry>
                     <term>-c <replaceable>filename</replaceable>, --cafile=<replaceable>filename</replaceable></term>
                     <listitem><para>
                         Certificate file for SSL connections
                     </para></listitem>
                 </varlistentry>
                 
                 <varlistentry>
                     <term>-g <replaceable>path</replaceable>, --path=<replaceable>path</replaceable></term>
                     <listitem>
                         <para>URL path of the service, for example <literal>/wsman</literal>.</para>
                     </listitem>
                 </varlistentry>
                 <varlistentry>
                     <term>-p <replaceable>password</replaceable>, --password=<replaceable>password</replaceable></term>
                     <listitem>
                         <para>
                             User password.
                         </para>
                     </listitem>
                 </varlistentry>
                 
                 <varlistentry>
                     <term>-J <replaceable>filename</replaceable>, --input=<replaceable>filename</replaceable></term>
                     <listitem>
                         <para>
                             File with resource for Create and Put operations in XML, can be a SOAP envelope
                         </para>
                     </listitem>
                 </varlistentry>
                 
                 <varlistentry>
                     <term>-d 1-6, --debug=1-6 </term>
                     <listitem>
                         <para>
                             Debug level
                         </para>
                     </listitem>
                 </varlistentry>
                 
                 <varlistentry>
                     <term>-h <replaceable>hostname</replaceable>, --hostname=<replaceable>hostname</replaceable> </term>
                     <listitem>
                         
                         <para>Hostname of the remote machine.</para>
                     </listitem>
                 </varlistentry>
                 
                 <varlistentry>
                     <term>-P <replaceable>port</replaceable>, --port=<replaceable>port</replaceable></term>
                     <listitem>
                         <para>Port of the service</para>
                     </listitem>
                 </varlistentry>
                 
                 <varlistentry>
                     <term>-X <replaceable>proxy</replaceable>, --proxy=<replaceable>proxy</replaceable></term>
                     <listitem>
                         <para>
                             Remote proxy address
                         </para>
                     </listitem>
                 </varlistentry>
                 
                 <varlistentry>
                     <term>-Y  <replaceable>user:pass</replaceable>, --proxyauth=<replaceable>user:pass</replaceable></term>
                     <listitem>
                         <para>
                             Remote proxy credentials
                         </para>
                     </listitem>
                 </varlistentry>    
                 
                 
                 <varlistentry>
                     <term>-y <replaceable>basic|digest|gss</replaceable>, --auth=<replaceable>basic|digest|gss</replaceable></term>
                     <listitem>
                         <para>Authentication method to be used. By default the method is selected automatically depending on the challange from the server. This options is used to force an authentication method.</para>
                     </listitem>
                 </varlistentry>
                 
                 <varlistentry>
                     <term>-a <replaceable>custom method</replaceable>, --method=<replaceable>custom method</replaceable></term>
                     <listitem>
                         <para>
                             Custom method name.
                         </para>
                     </listitem>
                 </varlistentry>
                 <varlistentry>
                     <term>-k <replaceable>key=val</replaceable>, --prop=<replaceable>key=val</replaceable></term>
                     <listitem>
                         <para>A key/value pair to pass properties for custom methods and put action.</para>
                     </listitem>
                 </varlistentry>
                 
                 <varlistentry>
                     <term>-C <replaceable>config file</replaceable>, --config-file=<replaceable>config file</replaceable> </term>
                     <listitem>
                         <para>Alternate configuration file.</para>
                     </listitem>
                 </varlistentry>
                 
                 <varlistentry>
                     <term>-O <replaceable>filename</replaceable>, --out-file=<replaceable>filename</replaceable></term>
                     <listitem>
                         <para>
                             Redirect output to a file instead of console.
                         </para>
                     </listitem>
                 </varlistentry>
                 
                 <varlistentry>
                     <term>-V, --noverifypeer</term>
                     <listitem>
                         <para>Do not verify peer certificate with SSL connections</para>
                     </listitem>
                 </varlistentry>
                 
                 
             </variablelist>
             
         </refsect2>
        <refsect2>
            <title>Enumeration Options</title>
        </refsect2>
        
        <refsect2>
            <title>Request flags and options</title>
        </refsect2>
        
        
        <refsect2>
            <title>CIM Options</title>
        </refsect2>
        
        <refsect2>
            <title>Test and Internal Options</title>
        </refsect2>
        
        
        
    </refsect1>   
</refentry>