PSSubnetCarver.Core

1.0.2

en-US/PSSubnetCarver.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>Clear-SCContext</command:name>
      <command:verb>Clear</command:verb>
      <command:noun>SCContext</command:noun>
      <maml:description>
        <maml:para>Clear the named context of it's stored networks, without deleting the context from memory.</maml:para>
      </maml:description>
    </command:details>
    <maml:description>
      <maml:para>Clear the named context of it's stored networks, without deleting the context from memory.</maml:para>
    </maml:description>
    <command:syntax>
      <command:syntaxItem>
        <maml:name>Clear-SCContext</maml:name>
        <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none">
          <maml:name>ContextName</maml:name>
          <maml:description>
            <maml:para>Enter the name of the context stored in memory.</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="0" aliases="none">
        <maml:name>ContextName</maml:name>
        <maml:description>
          <maml:para>Enter the name of the context stored in memory.</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: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.Object</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; Clear-SCContext -ContextName default</dev:code>
        <dev:remarks>
          <maml:para>Clear the 'default' context of it's contents, but leave the empty store in memory.</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>Get-SCContext</command:name>
      <command:verb>Get</command:verb>
      <command:noun>SCContext</command:noun>
      <maml:description>
        <maml:para>Return an object that contains the root network, as well as all of the consumed networks in the named context.</maml:para>
      </maml:description>
    </command:details>
    <maml:description>
      <maml:para>Return an object that contains the root network, as well as all of the consumed networks in the named context.</maml:para>
    </maml:description>
    <command:syntax>
      <command:syntaxItem>
        <maml:name>Get-SCContext</maml:name>
        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none">
          <maml:name>Name</maml:name>
          <maml:description>
            <maml:para>Enter the name of the context stored in memory.</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="True (ByValue)" position="0" aliases="none">
        <maml:name>Name</maml:name>
        <maml:description>
          <maml:para>Enter the name of the context stored in memory.</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:inputType>
        <dev:type>
          <maml:name>System.String[]</maml:name>
        </dev:type>
        <maml:description>
          <maml:para></maml:para>
        </maml:description>
      </command:inputType>
    </command:inputTypes>
    <command:returnValues>
      <command:returnValue>
        <dev:type>
          <maml:name>PSSubnetCarver.Models.SCContextModel</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; Get-SCContext -Name default</dev:code>
        <dev:remarks>
          <maml:para>Return the contents of the default Context</maml:para>
        </dev:remarks>
      </command:example>
      <command:example>
        <maml:title>-------------------------- Example 2 --------------------------</maml:title>
        <dev:code>PS C:\&gt; Get-SCContext</dev:code>
        <dev:remarks>
          <maml:para>Return the contents of the all contexts stored in memory.</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>Get-SCSubnet</command:name>
      <command:verb>Get</command:verb>
      <command:noun>SCSubnet</command:noun>
      <maml:description>
        <maml:para>Reserve an IP address in a stored context.</maml:para>
      </maml:description>
    </command:details>
    <maml:description>
      <maml:para>Reserve an IP address in a stored context. You can either reserve a specific IP, or the next available address space that meets your criteria.</maml:para>
    </maml:description>
    <command:syntax>
      <command:syntaxItem>
        <maml:name>Get-SCSubnet</maml:name>
        <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none">
          <maml:name>ReserveCIDR</maml:name>
          <maml:description>
            <maml:para>Enter the CIDR(s) to reserve.</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:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none">
          <maml:name>ContextName</maml:name>
          <maml:description>
            <maml:para>Enter the name of the context stored in memory.</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:syntaxItem>
        <maml:name>Get-SCSubnet</maml:name>
        <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none">
          <maml:name>ReserveCount</maml:name>
          <maml:description>
            <maml:para>Enter the number of hosts you need to reserve.</maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="false">UInt64[]</command:parameterValue>
          <dev:type>
            <maml:name>UInt64[]</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>ContextName</maml:name>
          <maml:description>
            <maml:para>Enter the name of the context stored in memory.</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:syntaxItem>
        <maml:name>Get-SCSubnet</maml:name>
        <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none">
          <maml:name>ReserveIPAddress</maml:name>
          <maml:description>
            <maml:para>Enter the specific IP Address Range(s) to reserve.</maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="false">IPAddressRange[]</command:parameterValue>
          <dev:type>
            <maml:name>IPAddressRange[]</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>ContextName</maml:name>
          <maml:description>
            <maml:para>Enter the name of the context stored in memory.</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:syntaxItem>
        <maml:name>Get-SCSubnet</maml:name>
        <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none">
          <maml:name>ContextName</maml:name>
          <maml:description>
            <maml:para>Enter the name of the context stored in memory.</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="named" aliases="P2P">
          <maml:name>ReserveNextPointToPoint</maml:name>
          <maml:description>
            <maml:para>Request the next Point-to-Point network available.</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>ContextName</maml:name>
        <maml:description>
          <maml:para>Enter the name of the context stored in memory.</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="True (ByValue)" position="0" aliases="none">
        <maml:name>ReserveCIDR</maml:name>
        <maml:description>
          <maml:para>Enter the CIDR(s) to reserve.</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:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none">
        <maml:name>ReserveCount</maml:name>
        <maml:description>
          <maml:para>Enter the number of hosts you need to reserve.</maml:para>
        </maml:description>
        <command:parameterValue required="true" variableLength="false">UInt64[]</command:parameterValue>
        <dev:type>
          <maml:name>UInt64[]</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>None</dev:defaultValue>
      </command:parameter>
      <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none">
        <maml:name>ReserveIPAddress</maml:name>
        <maml:description>
          <maml:para>Enter the specific IP Address Range(s) to reserve.</maml:para>
        </maml:description>
        <command:parameterValue required="true" variableLength="false">IPAddressRange[]</command:parameterValue>
        <dev:type>
          <maml:name>IPAddressRange[]</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>None</dev:defaultValue>
      </command:parameter>
      <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="P2P">
        <maml:name>ReserveNextPointToPoint</maml:name>
        <maml:description>
          <maml:para>Request the next Point-to-Point network available.</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:inputType>
        <dev:type>
          <maml:name>System.Int32[]</maml:name>
        </dev:type>
        <maml:description>
          <maml:para></maml:para>
        </maml:description>
      </command:inputType>
      <command:inputType>
        <dev:type>
          <maml:name>PSSubnetCarver.Models.IPAddressRange[]</maml:name>
        </dev:type>
        <maml:description>
          <maml:para></maml:para>
        </maml:description>
      </command:inputType>
    </command:inputTypes>
    <command:returnValues>
      <command:returnValue>
        <dev:type>
          <maml:name>PSSubnetCarver.Models.IPAddressRange</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; Get-SCSubnet -ReserveCIDR 16 -ContextName default</dev:code>
        <dev:remarks>
          <maml:para>Reserves and returns the next available /16 in the default context.</maml:para>
        </dev:remarks>
      </command:example>
      <command:example>
        <maml:title>-------------------------- Example 2 --------------------------</maml:title>
        <dev:code>PS C:\&gt; Get-SCSubnet -ReserveNextPointToPoint -ContextName default</dev:code>
        <dev:remarks>
          <maml:para>Reserves and returns the next available point-to-point network (/31) in the default context.</maml:para>
        </dev:remarks>
      </command:example>
      <command:example>
        <maml:title>-------------------------- Example 3 --------------------------</maml:title>
        <dev:code>PS C:\&gt; Get-SCSubnet -ReserveIPAddress "10.0.1.0/24" -ContextName default</dev:code>
        <dev:remarks>
          <maml:para>Reserves and returns the 10.0.1.0/24 network from the default context, if it's available.</maml:para>
        </dev:remarks>
      </command:example>
      <command:example>
        <maml:title>-------------------------- Example 4 --------------------------</maml:title>
        <dev:code>PS C:\&gt; Get-SCSubnet -ReserveCount 250 -ContextName default</dev:code>
        <dev:remarks>
          <maml:para>Reserves the next available network from the default context with at least 250 usable hosts.</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>Set-SCContext</command:name>
      <command:verb>Set</command:verb>
      <command:noun>SCContext</command:noun>
      <maml:description>
        <maml:para>Set or reset a root network in memory to be carved into subnets.</maml:para>
      </maml:description>
    </command:details>
    <maml:description>
      <maml:para>Set or reset a root network in memory to be carved into subnets.</maml:para>
    </maml:description>
    <command:syntax>
      <command:syntaxItem>
        <maml:name>Set-SCContext</maml:name>
        <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none">
          <maml:name>RootAddressSpace</maml:name>
          <maml:description>
            <maml:para>The root IP address space to be carved.</maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="false">IPAddressRange</command:parameterValue>
          <dev:type>
            <maml:name>IPAddressRange</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>Name</maml:name>
          <maml:description>
            <maml:para>Enter the name of the context stored in memory.</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="2" aliases="none">
          <maml:name>ConsumedIPRanges</maml:name>
          <maml:description>
            <maml:para>Any IP ranges that should be considered already consumed when carving the range.</maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="false">IPAddressRange[]</command:parameterValue>
          <dev:type>
            <maml:name>IPAddressRange[]</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="2" aliases="none">
        <maml:name>ConsumedIPRanges</maml:name>
        <maml:description>
          <maml:para>Any IP ranges that should be considered already consumed when carving the range.</maml:para>
        </maml:description>
        <command:parameterValue required="true" variableLength="false">IPAddressRange[]</command:parameterValue>
        <dev:type>
          <maml:name>IPAddressRange[]</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>Name</maml:name>
        <maml:description>
          <maml:para>Enter the name of the context stored in memory.</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="0" aliases="none">
        <maml:name>RootAddressSpace</maml:name>
        <maml:description>
          <maml:para>The root IP address space to be carved.</maml:para>
        </maml:description>
        <command:parameterValue required="true" variableLength="false">IPAddressRange</command:parameterValue>
        <dev:type>
          <maml:name>IPAddressRange</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.Object</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; Set-SCContext -RootAddressSpace "10.0.0.0/8" -Name default</dev:code>
        <dev:remarks>
          <maml:para>Create a context in memory named "default" with a root range of 10.0.0.0/8. This will be an empty network.</maml:para>
        </dev:remarks>
      </command:example>
      <command:example>
        <maml:title>-------------------------- Example 2 --------------------------</maml:title>
        <dev:code>PS C:\&gt; Set-SCContext -RootAddressSpace "10.0.0.0/8" -Name default -ConsumedIPRanges "10.1.0.0/16","10.2.0.0/16"</dev:code>
        <dev:remarks>
          <maml:para>Create a context in memory named "default" with a root range of 10.0.0.0/8, and the ranges 10.1.0.0/16 and 10.2.0.0/16 already occupied.</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>Test-SCNetworkIsValid</command:name>
      <command:verb>Test</command:verb>
      <command:noun>SCNetworkIsValid</command:noun>
      <maml:description>
        <maml:para>Test if a network configuration is valid.</maml:para>
      </maml:description>
    </command:details>
    <maml:description>
      <maml:para>Test if a network configuration is valid given a root network and a list of contained subnetworks.</maml:para>
    </maml:description>
    <command:syntax>
      <command:syntaxItem>
        <maml:name>Test-SCNetworkIsValid</maml:name>
        <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none">
          <maml:name>RootIPRange</maml:name>
          <maml:description>
            <maml:para>The root IP range of the virtual network to test</maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="false">IPAddressRange</command:parameterValue>
          <dev:type>
            <maml:name>IPAddressRange</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>ConsumedRanges</maml:name>
          <maml:description>
            <maml:para>Ranges to be tested.</maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="false">IPAddressRange[]</command:parameterValue>
          <dev:type>
            <maml:name>IPAddressRange[]</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>ConsumedRanges</maml:name>
        <maml:description>
          <maml:para>Ranges to be tested.</maml:para>
        </maml:description>
        <command:parameterValue required="true" variableLength="false">IPAddressRange[]</command:parameterValue>
        <dev:type>
          <maml:name>IPAddressRange[]</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>None</dev:defaultValue>
      </command:parameter>
      <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none">
        <maml:name>RootIPRange</maml:name>
        <maml:description>
          <maml:para>The root IP range of the virtual network to test</maml:para>
        </maml:description>
        <command:parameterValue required="true" variableLength="false">IPAddressRange</command:parameterValue>
        <dev:type>
          <maml:name>IPAddressRange</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>PSSubnetCarver.Models.SCNetworkValidationResult</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; Test-SCNetworkIsValid -RootIPRange "10.0.0.0/8" -ConsumedRanges "10.1.0.0/16","10.2.0.0/16","10.0.1.0/24"</dev:code>
        <dev:remarks>
          <maml:para>Test if a list of consumed ranges can all fit into a given root. This example would fail, and indicate that the 10.0.1.0/24 range doesn't fit.</maml:para>
        </dev:remarks>
      </command:example>
    </command:examples>
    <command:relatedLinks />
  </command:command>
</helpItems>