IPCalculator

1.0

IPCalculator.dll-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>New-Network</command:name>
      <command:verb>New</command:verb>
      <command:noun>Network</command:noun>
      <maml:description>
        <maml:para>This command will split the subnets you wish in your VLSM Network.</maml:para>
      </maml:description>
    </command:details>
    <maml:description>
      <maml:para>This command will split the subnets you wish in your VLSM Network based on the list of network segments requirements you provided within the scope of the address space.</maml:para>
    </maml:description>
    <command:syntax>
      <command:syntaxItem>
        <maml:name>New-Network</maml:name>
        <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none">
          <maml:name>NetworkSegments</maml:name>
          <maml:Description>
            <maml:para>Type in the Segment Name</maml:para>
          </maml:Description>
          <command:parameterValue required="true" variableLength="false">NetworkSegment[]</command:parameterValue>
          <dev:type>
            <maml:name>NetworkSegment[]</maml:name>
            <maml:uri />
          </dev:type>
          <dev:defaultValue>None</dev:defaultValue>
        </command:parameter>
        <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none">
          <maml:name>AddressSpace</maml:name>
          <maml:Description>
            <maml:para>Type in the Address Space in CIDR notation</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="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none">
        <maml:name>AddressSpace</maml:name>
        <maml:Description>
          <maml:para>Type in the Address Space in CIDR notation</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="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none">
        <maml:name>NetworkSegments</maml:name>
        <maml:Description>
          <maml:para>Type in the Segment Name</maml:para>
        </maml:Description>
        <command:parameterValue required="true" variableLength="false">NetworkSegment[]</command:parameterValue>
        <dev:type>
          <maml:name>NetworkSegment[]</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>System.Collections.Generic.IReadOnlyCollection`1[[IPCalculator.Subnet, IPCalculator, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]</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>PS C:\&gt; $List = @()
PS C:\&gt; $List += New-NetworkSegment -Name 'Test1' -SizeNeeded 29
PS C:\&gt; $List += New-NetworkSegment -Name 'Test2' -SizeNeeded 6
PS C:\&gt; $List += New-NetworkSegment -Name 'Test3' -SizeNeeded 100
PS C:\&gt; $List += New-NetworkSegment -Name 'Test4' -SizeNeeded 140
PS C:\&gt; New-Network -NetworkSegments $List -AddressSpace '192.168.1.0/23'</dev:code>
        <dev:remarks>
          <maml:para>This example will take the list of provided segments and effectively calculate the subnets within the address space.</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-NetworkSegment</command:name>
      <command:verb>New</command:verb>
      <command:noun>NetworkSegment</command:noun>
      <maml:description>
        <maml:para>This command will define the Segment or Segments you wish in your VLSM Network</maml:para>
      </maml:description>
    </command:details>
    <maml:description>
      <maml:para>This command will define the Segment or Segments you wish in your VLSM Network</maml:para>
    </maml:description>
    <command:syntax>
      <command:syntaxItem>
        <maml:name>New-NetworkSegment</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>Type in the Segment Name</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="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none">
          <maml:name>SizeNeeded</maml:name>
          <maml:Description>
            <maml:para>Type in the Amount of hosts needed in the segment</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>None</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>Type in the Segment Name</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="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none">
        <maml:name>SizeNeeded</maml:name>
        <maml:Description>
          <maml:para>Type in the Amount of hosts needed in the segment</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>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>System.Collections.Generic.IReadOnlyCollection`1[[IPCalculator.NetworkSegment, IPCalculator, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]</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>PS C:\&gt; $Segment = New-NetworkSegment -Name 'Test1' -SizeNeeded 29</dev:code>
        <dev:remarks>
          <maml:para>In this example we are using a single segment</maml:para>
        </dev:remarks>
      </command:example>
      <command:example>
        <maml:title>-------------------------- Example 2 --------------------------</maml:title>
        <dev:code>PS C:\&gt; $List = @()
PS C:\&gt; $List += New-NetworkSegment -Name 'Test1' -SizeNeeded 29
PS C:\&gt; $List += New-NetworkSegment -Name 'Test2' -SizeNeeded 6
PS C:\&gt; $List += New-NetworkSegment -Name 'Test3' -SizeNeeded 100
PS C:\&gt; $List += New-NetworkSegment -Name 'Test4' -SizeNeeded 140</dev:code>
        <dev:remarks>
          <maml:para>In this example we are using a list of segment</maml:para>
        </dev:remarks>
      </command:example>
    </command:examples>
    <command:relatedLinks />
  </command:command>
</helpItems>