net45/VMware.VimAutomation.HA.Commands.dll-Help.xml

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
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
<?xml version="1.0" encoding="utf-8"?>
<helpItems xmlns="http://msh" schema="maml">
<command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">
    <command:details>
        <command:name>Get-DrmInfo</command:name>
        <maml:description>
            <maml:para>This cmdlet retrieves DrmDumpInfo of each cluster from a vCenter Server system.</maml:para>
        </maml:description>
        <maml:copyright>
           <maml:para />
        <!--Add copy right info here.-->
        </maml:copyright>
        <command:verb>Get</command:verb>
        <command:noun>DrmInfo</command:noun>
        <!--Add Dev version info here.-->
        <dev:version />
    </command:details>
    <maml:description>
    <!--This is the Description section-->
        <maml:para>This cmdlet retrieves DrmDumpInfo of each cluster from a vCenter Server system. By default, if you do not provide any specifications, the cmdlet returns information about all available dump files. If you provide the number of files or specify the Start and Finish parameters, the cmdlet filters the dump files information based on the specifications. If DestinationPath is specified, the DRM dump file bundles are downloaded.</maml:para>
    </maml:description>
    <command:syntax>
        <command:syntaxItem>
            <maml:name>Get-DrmInfo</maml:name>
            <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "true (ByValue)" position = "named" >
                <maml:name>Cluster</maml:name>
                <maml:description>
                    <maml:para>Specifies the name of the cluster you want to query or download the DRM dump files from. If not specified, the DRM dump files from all the clusters are queried or downloaded.</maml:para>
                </maml:description>
            <command:parameterValue required="true" variableLength = "true" >Cluster[]</command:parameterValue>
            </command:parameter>
            <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" >
                <maml:name>Start</maml:name>
                <maml:description>
                    <maml:para>Specifies the start time from which you want to request the DRM dump files.</maml:para>
                </maml:description>
            <command:parameterValue required="true" variableLength = "false" >DateTime</command:parameterValue>
            </command:parameter>
            <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" >
                <maml:name>Finish</maml:name>
                <maml:description>
                    <maml:para>Specifies the end time up to which you want to request the DRM dump files.</maml:para>
                </maml:description>
            <command:parameterValue required="true" variableLength = "false" >DateTime</command:parameterValue>
            </command:parameter>
            <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" >
                <maml:name>NumFiles</maml:name>
                <maml:description>
                    <maml:para>Specifies the total number of dump files for which you want to generate the DRM bundle. This limits the number of files to look for in descending order within the time period. If not specified, all files from the time range are queried and bundled.</maml:para>
                </maml:description>
            <command:parameterValue required="true" variableLength = "false" >Int32</command:parameterValue>
            </command:parameter>
        </command:syntaxItem>
        <command:syntaxItem>
            <maml:name>Get-DrmInfo</maml:name>
            <command:parameter required = "false" variableLength = "true" globbing = "false" pipelineInput = "true (ByValue)" position = "named" >
                <maml:name>Cluster</maml:name>
                <maml:description>
                    <maml:para>Specifies the name of the cluster you want to query or download the DRM dump files from. If not specified, the DRM dump files from all the clusters are queried or downloaded.</maml:para>
                </maml:description>
            <command:parameterValue required="true" variableLength = "true" >Cluster[]</command:parameterValue>
            </command:parameter>
            <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" >
                <maml:name>Start</maml:name>
                <maml:description>
                    <maml:para>Specifies the start time from which you want to request the DRM dump files.</maml:para>
                </maml:description>
            <command:parameterValue required="true" variableLength = "false" >DateTime</command:parameterValue>
            </command:parameter>
            <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" >
                <maml:name>Finish</maml:name>
                <maml:description>
                    <maml:para>Specifies the end time up to which you want to request the DRM dump files.</maml:para>
                </maml:description>
            <command:parameterValue required="true" variableLength = "false" >DateTime</command:parameterValue>
            </command:parameter>
            <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" >
                <maml:name>NumFiles</maml:name>
                <maml:description>
                    <maml:para>Specifies the total number of dump files for which you want to generate the DRM bundle. This limits the number of files to look for in descending order within the time period. If not specified, all files from the time range are queried and bundled.</maml:para>
                </maml:description>
            <command:parameterValue required="true" variableLength = "false" >Int32</command:parameterValue>
            </command:parameter>
            <command:parameter required = "false" variableLength = "false" globbing = "false" pipelineInput = "false" position = "named" >
                <maml:name>DestinationPath</maml:name>
                <maml:description>
                    <maml:para>Specifies a local file path where you want to save the DRM dump files. In the file path, a folder with the vCenter Server name and current timestamp is created. Inside this folder, DRM dump bundles are downloaded and named after their respective clusters.</maml:para>
                </maml:description>
            <command:parameterValue required="true" variableLength = "false" >String</command:parameterValue>
            </command:parameter>
        </command:syntaxItem>
    </command:syntax>
    <command:parameters>
        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByValue)" position="named">
            <maml:name>Cluster</maml:name>
            <maml:description>
                <maml:para>Specifies the name of the cluster you want to query or download the DRM dump files from. If not specified, the DRM dump files from all the clusters are queried or downloaded.</maml:para>
            </maml:description>
            <command:parameterValue required="true" variableLength="true">Cluster[]</command:parameterValue>
            <dev:type>
                <maml:name>Cluster[]</maml:name>
                <maml:uri/>
            </dev:type>
            <dev:defaultValue></dev:defaultValue>
        </command:parameter>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
            <maml:name>Start</maml:name>
            <maml:description>
                <maml:para>Specifies the start time from which you want to request the DRM dump files.</maml:para>
            </maml:description>
            <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue>
            <dev:type>
                <maml:name>DateTime</maml:name>
                <maml:uri/>
            </dev:type>
            <dev:defaultValue></dev:defaultValue>
        </command:parameter>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
            <maml:name>Finish</maml:name>
            <maml:description>
                <maml:para>Specifies the end time up to which you want to request the DRM dump files.</maml:para>
            </maml:description>
            <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue>
            <dev:type>
                <maml:name>DateTime</maml:name>
                <maml:uri/>
            </dev:type>
            <dev:defaultValue></dev:defaultValue>
        </command:parameter>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
            <maml:name>NumFiles</maml:name>
            <maml:description>
                <maml:para>Specifies the total number of dump files for which you want to generate the DRM bundle. This limits the number of files to look for in descending order within the time period. If not specified, all files from the time range are queried and bundled.</maml:para>
            </maml:description>
            <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue>
            <dev:type>
                <maml:name>Int32</maml:name>
                <maml:uri/>
            </dev:type>
            <dev:defaultValue></dev:defaultValue>
        </command:parameter>
        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
            <maml:name>DestinationPath</maml:name>
            <maml:description>
                <maml:para>Specifies a local file path where you want to save the DRM dump files. In the file path, a folder with the vCenter Server name and current timestamp is created. Inside this folder, DRM dump bundles are downloaded and named after their respective clusters.</maml:para>
            </maml:description>
            <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
            <dev:type>
                <maml:name>String</maml:name>
                <maml:uri/>
            </dev:type>
            <dev:defaultValue></dev:defaultValue>
        </command:parameter>
    </command:parameters>
    <command:inputTypes>
        <command:inputType>
            <dev:type>
                <maml:name></maml:name>
                <maml:uri/>
                <maml:description>
                    <maml:para></maml:para>
                </maml:description>
            </dev:type>
            <maml:description></maml:description>
        </command:inputType>
    </command:inputTypes>
    <command:returnValues>
        <command:returnValue>
            <dev:type>
                <maml:name>One DrmDumpInfo per cluster for QueryInfo or One DrmDumpBundle per cluster for DownloadFiles</maml:name>
                <maml:uri />
                <maml:description>
                    <maml:para></maml:para>
                </maml:description>
            </dev:type>
            <maml:description></maml:description>
        </command:returnValue>
    </command:returnValues>
    <command:terminatingErrors>
    </command:terminatingErrors>
    <command:nonTerminatingErrors>
    </command:nonTerminatingErrors>
    <maml:alertSet>
        <maml:title></maml:title>
        <maml:alert>
            <maml:para></maml:para>
        </maml:alert>
    </maml:alertSet>
    <command:examples>
        <command:example>
            <maml:title>
-------------- Example 1 -------------- </maml:title>
            <maml:introduction>
                <maml:para>C:\PS&gt;</maml:para>
C:\PS&gt; </maml:introduction>
              <dev:code>Get-DrmInfo -Cluster cls -Start 2015-01-07T14:15:01Z -Finish 2015-01-07T14:15:01Z -DestinationPath &quot;C:\temp&quot;</dev:code>
              <dev:remarks>
                <maml:para>Downloads all DRM bundles from the cls cluster, that are created in the specified time range, to the specified destination path.</maml:para>
                <maml:para></maml:para>
                <maml:para></maml:para>
                <maml:para>
                </maml:para>
                <maml:para></maml:para>
              </dev:remarks>
            <command:commandLines>
                <command:commandLine>
                    <command:commandText>
                    </command:commandText>
                </command:commandLine>
            </command:commandLines>
        </command:example>
        <command:example>
            <maml:title>
-------------- Example 2 -------------- </maml:title>
            <maml:introduction>
                <maml:para>C:\PS&gt;</maml:para>
C:\PS&gt; </maml:introduction>
              <dev:code>Get-Cluster cls | Get-DrmInfo -Start 2015-01-07T14:15:01Z -Finish 2015-01-07T14:15:01Z -DestinationPath &quot;C:\temp&quot;</dev:code>
              <dev:remarks>
                <maml:para>Downloads all DRM bundles from the cls cluster, that are created in the specified time range, to the specified destination path.</maml:para>
                <maml:para></maml:para>
                <maml:para></maml:para>
                <maml:para>
                </maml:para>
                <maml:para></maml:para>
              </dev:remarks>
            <command:commandLines>
                <command:commandLine>
                    <command:commandText>
                    </command:commandText>
                </command:commandLine>
            </command:commandLines>
        </command:example>
        <command:example>
            <maml:title>
-------------- Example 3 -------------- </maml:title>
            <maml:introduction>
                <maml:para>C:\PS&gt;</maml:para>
C:\PS&gt; </maml:introduction>
              <dev:code>Get-DrmInfo -Start 2015-01-07T14:15:01Z -Finish 2015-01-07T14:15:01Z -NumFiles 30</dev:code>
              <dev:remarks>
                <maml:para>Lists the DrmDumpInfo of the latest 30 dump files from all clusters for the specified time period.</maml:para>
                <maml:para></maml:para>
                <maml:para></maml:para>
                <maml:para>
                </maml:para>
                <maml:para></maml:para>
              </dev:remarks>
            <command:commandLines>
                <command:commandLine>
                    <command:commandText>
                    </command:commandText>
                </command:commandLine>
            </command:commandLines>
        </command:example>
        <command:example>
            <maml:title>
-------------- Example 4 -------------- </maml:title>
            <maml:introduction>
                <maml:para>C:\PS&gt;</maml:para>
C:\PS&gt; </maml:introduction>
              <dev:code>Get-DrmInfo -DestinationPath &quot;C:\temp&quot;</dev:code>
              <dev:remarks>
                <maml:para>Downloads all dump files collected from all clusters to the specified destination path.</maml:para>
                <maml:para></maml:para>
                <maml:para></maml:para>
                <maml:para>
                </maml:para>
                <maml:para></maml:para>
              </dev:remarks>
            <command:commandLines>
                <command:commandLine>
                    <command:commandText>
                    </command:commandText>
                </command:commandLine>
            </command:commandLines>
        </command:example>
    </command:examples>
    <maml:relatedLinks>
        <maml:navigationLink>
            <maml:linkText>Online version:</maml:linkText>
            <maml:uri>https://code.vmware.com/doc/preview?id=5975#/doc/Get-DrmInfo.html</maml:uri>
        </maml:navigationLink>
    </maml:relatedLinks>
</command:command>
</helpItems>