pwps_dab_remoting

1.0.1.0

en-US/PWPS_DAB_Remoting.dll-Help.xml

<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh">
  <!-- Cmdlet: Request-RemotePWPowerShellExecution -->
  <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>Request-RemotePWPowerShellExecution</command:name>
      <command:verb>Request</command:verb>
      <command:noun>RemotePWPowerShellExecution</command:noun>
      <maml:description>
        <maml:para>Request remote script execution. Request listener service required: PWScriptMonitorSvc (https://pwstoragesouthcentralus.blob.core.windows.net/public/PWScriptMonitorSvcSetup.zip).</maml:para>
      </maml:description>
    </command:details>
    <maml:description>
      <maml:para>Request remote script execution. Request listener service required: PWScriptMonitorSvc (https://pwstoragesouthcentralus.blob.core.windows.net/public/PWScriptMonitorSvcSetup.zip).</maml:para>
    </maml:description>
    <command:syntax>
      <!-- Parameter set: ScriptName -->
      <command:syntaxItem>
        <maml:name>Request-RemotePWPowerShellExecution</maml:name>
        <!-- Parameter: ScriptName -->
        <command:parameter required="false" globbing="false" pipelineInput="false" position="0">
          <maml:name>ScriptName</maml:name>
          <maml:description>
            <maml:para>Script to execute.</maml:para>
          </maml:description>
          <command:parameterValue required="true">string</command:parameterValue>
          <dev:type>
            <maml:name>System.String</maml:name>
            <maml:uri />
          </dev:type>
        </command:parameter>
        <!-- Parameter: RequesterEmail -->
        <command:parameter required="false" globbing="false" pipelineInput="false" position="1">
          <maml:name>RequesterEmail</maml:name>
          <maml:description>
            <maml:para>Requester's Email address (remote script may return status).</maml:para>
          </maml:description>
          <command:parameterValue required="true">string</command:parameterValue>
          <dev:type>
            <maml:name>System.String</maml:name>
            <maml:uri />
          </dev:type>
        </command:parameter>
        <!-- Parameter: AdditionalParameters -->
        <command:parameter required="false" globbing="false" pipelineInput="false" position="2">
          <maml:name>AdditionalParameters</maml:name>
          <maml:description>
            <maml:para>Additional parameters for script add. Use a hashtable like @{Name = "Name value"; Description = "Description value"}</maml:para>
          </maml:description>
          <command:parameterValue required="true">Hashtable</command:parameterValue>
          <dev:type>
            <maml:name>System.Collections.Hashtable</maml:name>
            <maml:uri />
          </dev:type>
        </command:parameter>
        <!-- Parameter: RemoteServerKey -->
        <command:parameter required="true" globbing="false" pipelineInput="false" position="3">
          <maml:name>RemoteServerKey</maml:name>
          <maml:description>
            <maml:para>Remote server key. Required. Will identify the service which will execute your script. You should make as unique as possible.</maml:para>
          </maml:description>
          <command:parameterValue required="true">string</command:parameterValue>
          <dev:type>
            <maml:name>System.String</maml:name>
            <maml:uri />
          </dev:type>
        </command:parameter>
        <!-- Parameter: ServiceBus -->
        <command:parameter required="false" globbing="false" pipelineInput="false" position="4">
          <maml:name>ServiceBus</maml:name>
          <maml:description>
            <maml:para>Service Bus name (optional). Must exist.</maml:para>
          </maml:description>
          <command:parameterValue required="true">string</command:parameterValue>
          <dev:type>
            <maml:name>System.String</maml:name>
            <maml:uri />
          </dev:type>
        </command:parameter>
        <!-- Parameter: Topic -->
        <command:parameter required="false" globbing="false" pipelineInput="false" position="5">
          <maml:name>Topic</maml:name>
          <maml:description>
            <maml:para>Topic name (optional). Will be created if does not exist.</maml:para>
          </maml:description>
          <command:parameterValue required="true">string</command:parameterValue>
          <dev:type>
            <maml:name>System.String</maml:name>
            <maml:uri />
          </dev:type>
        </command:parameter>
        <!-- Parameter: ServiceBusKey -->
        <command:parameter required="false" globbing="false" pipelineInput="false" position="6">
          <maml:name>ServiceBusKey</maml:name>
          <maml:description>
            <maml:para>Service bus key (optional). Provide it here if you are using your own service bus.</maml:para>
          </maml:description>
          <command:parameterValue required="true">string</command:parameterValue>
          <dev:type>
            <maml:name>System.String</maml:name>
            <maml:uri />
          </dev:type>
        </command:parameter>
      </command:syntaxItem>
    </command:syntax>
    <command:parameters>
      <!-- Parameter: ScriptName -->
      <command:parameter required="false" globbing="false" pipelineInput="false" position="0">
        <maml:name>ScriptName</maml:name>
        <maml:description>
          <maml:para>Script to execute.</maml:para>
        </maml:description>
        <command:parameterValue required="true">string</command:parameterValue>
        <dev:type>
          <maml:name>System.String</maml:name>
          <maml:uri />
        </dev:type>
      </command:parameter>
      <!-- Parameter: RequesterEmail -->
      <command:parameter required="false" globbing="false" pipelineInput="false" position="1">
        <maml:name>RequesterEmail</maml:name>
        <maml:description>
          <maml:para>Requester's Email address (remote script may return status).</maml:para>
        </maml:description>
        <command:parameterValue required="true">string</command:parameterValue>
        <dev:type>
          <maml:name>System.String</maml:name>
          <maml:uri />
        </dev:type>
      </command:parameter>
      <!-- Parameter: AdditionalParameters -->
      <command:parameter required="false" globbing="false" pipelineInput="false" position="2">
        <maml:name>AdditionalParameters</maml:name>
        <maml:description>
          <maml:para>Additional parameters for script add. Use a hashtable like @{Name = "Name value"; Description = "Description value"}</maml:para>
        </maml:description>
        <command:parameterValue required="true">Hashtable</command:parameterValue>
        <dev:type>
          <maml:name>System.Collections.Hashtable</maml:name>
          <maml:uri />
        </dev:type>
      </command:parameter>
      <!-- Parameter: RemoteServerKey -->
      <command:parameter required="true" globbing="false" pipelineInput="false" position="3">
        <maml:name>RemoteServerKey</maml:name>
        <maml:description>
          <maml:para>Remote server key. Required. Will identify the service which will execute your script. You should make as unique as possible.</maml:para>
        </maml:description>
        <command:parameterValue required="true">string</command:parameterValue>
        <dev:type>
          <maml:name>System.String</maml:name>
          <maml:uri />
        </dev:type>
      </command:parameter>
      <!-- Parameter: ServiceBus -->
      <command:parameter required="false" globbing="false" pipelineInput="false" position="4">
        <maml:name>ServiceBus</maml:name>
        <maml:description>
          <maml:para>Service Bus name (optional). Must exist.</maml:para>
        </maml:description>
        <command:parameterValue required="true">string</command:parameterValue>
        <dev:type>
          <maml:name>System.String</maml:name>
          <maml:uri />
        </dev:type>
      </command:parameter>
      <!-- Parameter: Topic -->
      <command:parameter required="false" globbing="false" pipelineInput="false" position="5">
        <maml:name>Topic</maml:name>
        <maml:description>
          <maml:para>Topic name (optional). Will be created if does not exist.</maml:para>
        </maml:description>
        <command:parameterValue required="true">string</command:parameterValue>
        <dev:type>
          <maml:name>System.String</maml:name>
          <maml:uri />
        </dev:type>
      </command:parameter>
      <!-- Parameter: ServiceBusKey -->
      <command:parameter required="false" globbing="false" pipelineInput="false" position="6">
        <maml:name>ServiceBusKey</maml:name>
        <maml:description>
          <maml:para>Service bus key (optional). Provide it here if you are using your own service bus.</maml:para>
        </maml:description>
        <command:parameterValue required="true">string</command:parameterValue>
        <dev:type>
          <maml:name>System.String</maml:name>
          <maml:uri />
        </dev:type>
      </command:parameter>
    </command:parameters>
    <command:inputTypes />
    <command:returnValues />
    <command:examples>
      <command:example>
        <maml:title>---------- EXAMPLE 1 ----------</maml:title>
        <maml:introduction>
          <maml:para>Request-RemotePWPowerShellExecution executeaction.ps1 -RemoteServerKey Server1</maml:para>
          <maml:para>Request-RemotePWPowerShellExecution test.ps1 -RequesterEmail dave.brumbaugh@bentley.com -AdditionalParameters @{Key1 = "Key1";Key2 = "Key2"} -RemoteServerKey Server1</maml:para>
          <maml:para>Request-RemotePWPowerShellExecution test.ps1 -RemoteServerKey Server1 -AdditionalParameters @{</maml:para>
          <maml:para>datasource="decide-pwce-us.bentley.com:decide-pwce-us-10";</maml:para>
          <maml:para>folderpath= 'PDFs with QRCodes';</maml:para>
          <maml:para>documentname= "%.pdf";</maml:para>
          <maml:para>documentversion= "A";</maml:para>
          <maml:para>random= "Some random value";</maml:para>
          <maml:para>requesteremail="dave.brumbaugh@bentley.com"</maml:para>
          <maml:para>}</maml:para>
        </maml:introduction>
      </command:example>
    </command:examples>
  </command:command>
</helpItems>