ITGSerialTerminalTools

0.2.4

ru-RU/ITGSerialTerminalTools-help.xml

                                <?xml version="1.0" encoding="utf-8"?>

<helpItems schema="maml" xmlns="http://msh">

  <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">

    <command:details>

      <command:name>Invoke-RemoteCommand</command:name>

      <command:verb>Invoke</command:verb>

      <command:noun>RemoteCommand</command:noun>

      <maml:description>

        <maml:para>Выполняет в удалённой консоли команду и возвращает результат. Генерирует исключение в случае таймаута.</maml:para>

      </maml:description>

    </command:details>

    <maml:description>

      <maml:para>Выполняет в удалённой консоли команду Command и возвращает результат. Генерирует исключение в случае таймаута. Следует использовать для подачи команды на удалённую консоль. С ключом PassThru возвращает в качестве результата вывод удалённой консоли до строки, соответствующей PromptPattern.</maml:para>

    </maml:description>

    <command:syntax>

      <command:syntaxItem>

        <maml:name>Invoke-RemoteCommand</maml:name>

      </command:syntaxItem>

    </command:syntax>

    <command:parameters>

      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">

        <maml:name>ConsoleStreamReader</maml:name>

        <maml:Description>

          <maml:para>Читатель потока удалённой консоли.</maml:para>

        </maml:Description>

        <command:parameterValue required="true" variableLength="false"></command:parameterValue>

        <dev:type>

          <maml:name></maml:name>

          <maml:uri />

        </dev:type>

        <dev:defaultValue>None</dev:defaultValue>

      </command:parameter>

      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">

        <maml:name>ConsoleStreamWriter</maml:name>

        <maml:Description>

          <maml:para>Писатель потока удалённой консоли.</maml:para>

        </maml:Description>

        <command:parameterValue required="true" variableLength="false"></command:parameterValue>

        <dev:type>

          <maml:name></maml:name>

          <maml:uri />

        </dev:type>

        <dev:defaultValue>None</dev:defaultValue>

      </command:parameter>

      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">

        <maml:name>Command</maml:name>

        <maml:Description>

          <maml:para>Команда для передачи в удалённую консоль.</maml:para>

        </maml:Description>

        <command:parameterValue required="true" variableLength="false"></command:parameterValue>

        <dev:type>

          <maml:name></maml:name>

          <maml:uri />

        </dev:type>

        <dev:defaultValue>None</dev:defaultValue>

      </command:parameter>

      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">

        <maml:name>PromptPattern</maml:name>

        <maml:Description>

          <maml:para>Шаблон ожидаемой строки (регулярное выражение). По умолчанию - `'[.+?] &gt;'`.</maml:para>

        </maml:Description>

        <command:parameterValue required="true" variableLength="false"></command:parameterValue>

        <dev:type>

          <maml:name></maml:name>

          <maml:uri />

        </dev:type>

        <dev:defaultValue>None</dev:defaultValue>

      </command:parameter>

      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">

        <maml:name>Timeout</maml:name>

        <maml:Description>

          <maml:para>Таймаут. По умолчанию - без таймаута.</maml:para>

        </maml:Description>

        <command:parameterValue required="true" variableLength="false"></command:parameterValue>

        <dev:type>

          <maml:name></maml:name>

          <maml:uri />

        </dev:type>

        <dev:defaultValue>None</dev:defaultValue>

      </command:parameter>

      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">

        <maml:name>PassThru</maml:name>

        <maml:Description>

          <maml:para>Ключ, указывающий на необходимость возврата вывода консоли в качестве результата.</maml:para>

        </maml:Description>

        <command:parameterValue required="true" variableLength="false"></command:parameterValue>

        <dev:type>

          <maml:name></maml:name>

          <maml:uri />

        </dev:type>

        <dev:defaultValue>None</dev:defaultValue>

      </command:parameter>

    </command:parameters>

    <command:inputTypes>

      <command:inputType>

        <dev:type>

          <maml:name>None</maml:name>

        </dev:type>

        <maml:description>

          <maml:para></maml:para>

        </maml:description>

      </command:inputType>

    </command:inputTypes>

    <command:returnValues>

      <command:returnValue>

        <dev:type>

          <maml:name>String</maml:name>

        </dev:type>

        <maml:description>

          <maml:para>Вывод удалённой консоли.</maml:para>

        </maml:description>

      </command:returnValue>

    </command:returnValues>

    <maml:alertSet>

      <maml:alert>

        <maml:para></maml:para>

      </maml:alert>

    </maml:alertSet>

    <command:examples />

    <command:relatedLinks />

  </command:command>

  <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">

    <command:details>

      <command:name>Wait-ExpectedMessage</command:name>

      <command:verb>Wait</command:verb>

      <command:noun>ExpectedMessage</command:noun>

      <maml:description>

        <maml:para>Командлета ожидает в выводе консоли строки, соответствующей шаблону PromptPattern.</maml:para>

      </maml:description>

    </command:details>

    <maml:description>

      <maml:para>Командлета ожидает в выводе консоли строки, соответствующей шаблону PromptPattern. С учётом указанного таймаута.</maml:para>

    </maml:description>

    <command:syntax>

      <command:syntaxItem>

        <maml:name>Wait-ExpectedMessage</maml:name>

      </command:syntaxItem>

    </command:syntax>

    <command:parameters>

      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">

        <maml:name>ConsoleStreamReader</maml:name>

        <maml:Description>

          <maml:para>Читатель потока удалённой консоли.</maml:para>

        </maml:Description>

        <command:parameterValue required="true" variableLength="false"></command:parameterValue>

        <dev:type>

          <maml:name></maml:name>

          <maml:uri />

        </dev:type>

        <dev:defaultValue>None</dev:defaultValue>

      </command:parameter>

      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">

        <maml:name>PromptPattern</maml:name>

        <maml:Description>

          <maml:para>Шаблон ожидаемой строки (регулярное выражение). По умолчанию - `'[.+?] &gt;'`.</maml:para>

        </maml:Description>

        <command:parameterValue required="true" variableLength="false"></command:parameterValue>

        <dev:type>

          <maml:name></maml:name>

          <maml:uri />

        </dev:type>

        <dev:defaultValue>None</dev:defaultValue>

      </command:parameter>

      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">

        <maml:name>Timeout</maml:name>

        <maml:Description>

          <maml:para>Таймаут. По умолчанию - без таймаута.</maml:para>

        </maml:Description>

        <command:parameterValue required="true" variableLength="false"></command:parameterValue>

        <dev:type>

          <maml:name></maml:name>

          <maml:uri />

        </dev:type>

        <dev:defaultValue>None</dev:defaultValue>

      </command:parameter>

      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">

        <maml:name>PassThru</maml:name>

        <maml:Description>

          <maml:para>Ключ, указывающий на необходимость возврата вывода консоли в качестве результата.</maml:para>

        </maml:Description>

        <command:parameterValue required="true" variableLength="false"></command:parameterValue>

        <dev:type>

          <maml:name></maml:name>

          <maml:uri />

        </dev:type>

        <dev:defaultValue>None</dev:defaultValue>

      </command:parameter>

    </command:parameters>

    <command:inputTypes>

      <command:inputType>

        <dev:type>

          <maml:name>None</maml:name>

        </dev:type>

        <maml:description>

          <maml:para></maml:para>

        </maml:description>

      </command:inputType>

    </command:inputTypes>

    <command:returnValues>

      <command:returnValue>

        <dev:type>

          <maml:name>String</maml:name>

        </dev:type>

        <maml:description>

          <maml:para>Вывод удалённой консоли.</maml:para>

        </maml:description>

      </command:returnValue>

    </command:returnValues>

    <maml:alertSet>

      <maml:alert>

        <maml:para></maml:para>

      </maml:alert>

    </maml:alertSet>

    <command:examples />

    <command:relatedLinks />

  </command:command>

</helpItems>