LoopbackAdapter

1.2.1.14

LoopbackAdapter-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>Get-LoopbackAdapter</command:name>

      <command:verb>Get</command:verb>

      <command:noun>LoopbackAdapter</command:noun>

      <maml:description>

        <maml:para>Returns a specified Loopback Network Adapter or all Loopback Adapters.</maml:para>

      </maml:description>

    </command:details>

    <maml:description>

      <maml:para>This function will return either the Loopback Adapter specified in the $Name parameter or all Loopback Adapters. It will only return adapters that use the Microsoft KM-TEST Loopback Adapter driver.</maml:para>

      <maml:para>This function does not use Chocolatey or the DevCon (Device Console) application, so does not require administrator access.</maml:para>

    </maml:description>

    <command:syntax>

      <command:syntaxItem>

        <maml:name>Get-LoopbackAdapter</maml:name>

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

          <maml:name>Name</maml:name>

          <maml:Description>

            <maml:para>The name of the Loopback Adapter to return. If not specified will return all Loopback Adapters.</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>None</dev:defaultValue>

        </command:parameter>

      </command:syntaxItem>

    </command:syntax>

    <command:parameters>

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

        <maml:name>Name</maml:name>

        <maml:Description>

          <maml:para>The name of the Loopback Adapter to return. If not specified will return all Loopback Adapters.</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>None</dev:defaultValue>

      </command:parameter>

    </command:parameters>

    <command:inputTypes />

    <command:returnValues>

      <command:returnValue>

        <dev:type>

          <maml:name>Returns a specific Loopback Adapter or all Loopback adapters.</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:example>

        <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title>

        <dev:code>$Adapter = Get-LoopbackAdapter -Name 'MyNewLoopback'</dev:code>

        <dev:remarks>

          <maml:para>Returns the Loopback Adapter called MyNewLoopback. If this Loopback Adapter does not exist or does not use the Microsoft KM-TEST Loopback Adapter driver then an exception will be thrown.</maml:para>

        </dev:remarks>

      </command:example>

    </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>New-LoopbackAdapter</command:name>

      <command:verb>New</command:verb>

      <command:noun>LoopbackAdapter</command:noun>

      <maml:description>

        <maml:para>Install a new Loopback Network Adapter.</maml:para>

      </maml:description>

    </command:details>

    <maml:description>

      <maml:para>Uses Chocolatey to download the DevCon (Windows Device Console) package and uses it to install a new Loopback Network Adapter with the name specified. The Loopback Adapter will need to be configured like any other adapter (e.g. configure IP and DNS)</maml:para>

    </maml:description>

    <command:syntax>

      <command:syntaxItem>

        <maml:name>New-LoopbackAdapter</maml:name>

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

          <maml:name>Name</maml:name>

          <maml:Description>

            <maml:para>The name of the Loopback Adapter to create.</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>None</dev:defaultValue>

        </command:parameter>

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

          <maml:name>Force</maml:name>

          <maml:Description>

            <maml:para>Force the install of Chocolatey and the Devcon.portable package if not already installed, without confirming with the user.</maml:para>

          </maml:Description>

          <dev:type>

            <maml:name>SwitchParameter</maml:name>

            <maml:uri />

          </dev:type>

          <dev:defaultValue>False</dev:defaultValue>

        </command:parameter>

      </command:syntaxItem>

    </command:syntax>

    <command:parameters>

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

        <maml:name>Name</maml:name>

        <maml:Description>

          <maml:para>The name of the Loopback Adapter to create.</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>None</dev:defaultValue>

      </command:parameter>

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

        <maml:name>Force</maml:name>

        <maml:Description>

          <maml:para>Force the install of Chocolatey and the Devcon.portable package if not already installed, without confirming with the user.</maml:para>

        </maml:Description>

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

        <dev:type>

          <maml:name>SwitchParameter</maml:name>

          <maml:uri />

        </dev:type>

        <dev:defaultValue>False</dev:defaultValue>

      </command:parameter>

    </command:parameters>

    <command:inputTypes />

    <command:returnValues>

      <command:returnValue>

        <dev:type>

          <maml:name>Returns the newly created Loopback Adapter.</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:example>

        <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title>

        <dev:code>$Adapter = New-LoopbackAdapter -Name 'MyNewLoopback'</dev:code>

        <dev:remarks>

          <maml:para>Creates a new Loopback Adapter called MyNewLoopback.</maml:para>

        </dev:remarks>

      </command:example>

    </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>Remove-LoopbackAdapter</command:name>

      <command:verb>Remove</command:verb>

      <command:noun>LoopbackAdapter</command:noun>

      <maml:description>

        <maml:para>Uninstall an existing Loopback Network Adapter.</maml:para>

      </maml:description>

    </command:details>

    <maml:description>

      <maml:para>Uses Chocolatey to download the DevCon (Windows Device Console) package and uses it to uninstall a new Loopback Network Adapter with the name specified.</maml:para>

    </maml:description>

    <command:syntax>

      <command:syntaxItem>

        <maml:name>Remove-LoopbackAdapter</maml:name>

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

          <maml:name>Name</maml:name>

          <maml:Description>

            <maml:para>The name of the Loopback Adapter to uninstall.</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>None</dev:defaultValue>

        </command:parameter>

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

          <maml:name>Force</maml:name>

          <maml:Description>

            <maml:para>Force the install of Chocolatey and the Devcon.portable package if not already installed, without confirming with the user.</maml:para>

          </maml:Description>

          <dev:type>

            <maml:name>SwitchParameter</maml:name>

            <maml:uri />

          </dev:type>

          <dev:defaultValue>False</dev:defaultValue>

        </command:parameter>

      </command:syntaxItem>

    </command:syntax>

    <command:parameters>

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

        <maml:name>Name</maml:name>

        <maml:Description>

          <maml:para>The name of the Loopback Adapter to uninstall.</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>None</dev:defaultValue>

      </command:parameter>

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

        <maml:name>Force</maml:name>

        <maml:Description>

          <maml:para>Force the install of Chocolatey and the Devcon.portable package if not already installed, without confirming with the user.</maml:para>

        </maml:Description>

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

        <dev:type>

          <maml:name>SwitchParameter</maml:name>

          <maml:uri />

        </dev:type>

        <dev:defaultValue>False</dev:defaultValue>

      </command:parameter>

    </command:parameters>

    <command:inputTypes />

    <command:returnValues>

      <command:returnValue>

        <dev:type>

          <maml:name>None</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:example>

        <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title>

        <dev:code>Remove-LoopbackAdapter -Name 'MyNewLoopback'</dev:code>

        <dev:remarks>

          <maml:para>Removes an existing Loopback Adapter called MyNewLoopback.</maml:para>

        </dev:remarks>

      </command:example>

    </command:examples>

    <command:relatedLinks />

  </command:command>

</helpItems>