VMware.VimAutomation.HA

6.5.4.7567193

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

                                <?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>