IP.Tools

0.0.2

en-US/IP.Tools-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>Add-YourFirstFunction</command:name>
      <command:verb>Add</command:verb>
      <command:noun>YourFirstFunction</command:noun>
      <maml:description>
        <maml:para>{{ Fill in the Synopsis }}</maml:para>
      </maml:description>
    </command:details>
    <maml:description>
      <maml:para>{{ Fill in the Description }}</maml:para>
    </maml:description>
    <command:syntax>
      <command:syntaxItem>
        <maml:name>Add-YourFirstFunction</maml:name>
      </command:syntaxItem>
    </command:syntax>
    <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; {{ Add example code here }}</dev:code>
        <dev:remarks>
          <maml:para>{{ Add example description here }}</maml:para>
        </dev:remarks>
      </command:example>
    </command:examples>
    <command:relatedLinks>
      <maml:navigationLink>
        <maml:linkText>IP.Tools Project</maml:linkText>
        <maml:uri>https://github.com/jberkers42/ip.tools</maml:uri>
      </maml:navigationLink>
    </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>Convert-MaskLenToIp</command:name>
      <command:verb>Convert</command:verb>
      <command:noun>MaskLenToIp</command:noun>
      <maml:description>
        <maml:para>Convert MaskLen from CIDR Notation (IP/MaskLen) to an IP Address object</maml:para>
      </maml:description>
    </command:details>
    <maml:description>
      <maml:para>Convert MaskLen from CIDR (Classless Inter-Domain Routing) Notation (IP/MaskLen) to an IP Address object that represents the netmask.</maml:para>
      <maml:para>This can subsequently be used to perform calculations, like checking if a single IP address belongs to a specific network.</maml:para>
    </maml:description>
    <command:syntax>
      <command:syntaxItem>
        <maml:name>Convert-MaskLenToIp</maml:name>
      </command:syntaxItem>
    </command:syntax>
    <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 &gt; $Mask = Convert-MaskLenToIp -MaskLen 24</dev:code>
        <dev:remarks>
          <maml:para>Assign the ipaddress representation of the maskt to a variable.</maml:para>
        </dev:remarks>
      </command:example>
    </command:examples>
    <command:relatedLinks>
      <maml:navigationLink>
        <maml:linkText>IP.Tools Project</maml:linkText>
        <maml:uri>https://github.com/jberkers42/ip.tools</maml:uri>
      </maml:navigationLink>
    </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-IpBogon</command:name>
      <command:verb>Get</command:verb>
      <command:noun>IpBogon</command:noun>
      <maml:description>
        <maml:para>Get a list of IP Bogon Addresses</maml:para>
      </maml:description>
    </command:details>
    <maml:description>
      <maml:para>Get a list of IP Bogon (Internet non-routable) Addresses in IpNetwork format consisting of IPAddress objects contained in the IpAddress and IpNetmask properties.</maml:para>
    </maml:description>
    <command:syntax>
      <command:syntaxItem>
        <maml:name>Get-IpBogon</maml:name>
      </command:syntaxItem>
    </command:syntax>
    <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>IpNetwork</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 &gt; Get-IpBogon</dev:code>
        <dev:remarks>
          <maml:para>Get a list of the IP Bogon addresses and their respective network masks.</maml:para>
        </dev:remarks>
      </command:example>
    </command:examples>
    <command:relatedLinks>
      <maml:navigationLink>
        <maml:linkText>IP.Tools Project</maml:linkText>
        <maml:uri>https://github.com/jberkers42/ip.tools</maml:uri>
      </maml:navigationLink>
      <maml:navigationLink>
        <maml:linkText>IP Bogon Ranges</maml:linkText>
        <maml:uri>https://ipgeolocation.io/resources/bogon.html</maml:uri>
      </maml:navigationLink>
      <maml:navigationLink>
        <maml:linkText>RFC1112</maml:linkText>
        <maml:uri>https://www.rfc-editor.org/rfc/rfc1112.html</maml:uri>
      </maml:navigationLink>
      <maml:navigationLink>
        <maml:linkText>RFC1122</maml:linkText>
        <maml:uri>https://www.rfc-editor.org/rfc/rfc1122.html</maml:uri>
      </maml:navigationLink>
      <maml:navigationLink>
        <maml:linkText>RFC1918</maml:linkText>
        <maml:uri>https://www.rfc-editor.org/rfc/rfc1918.html</maml:uri>
      </maml:navigationLink>
      <maml:navigationLink>
        <maml:linkText>RFC2544</maml:linkText>
        <maml:uri>https://www.rfc-editor.org/rfc/rfc2544.html</maml:uri>
      </maml:navigationLink>
      <maml:navigationLink>
        <maml:linkText>RFC5736</maml:linkText>
        <maml:uri>https://www.rfc-editor.org/rfc/rfc5736.html</maml:uri>
      </maml:navigationLink>
      <maml:navigationLink>
        <maml:linkText>RFC5737</maml:linkText>
        <maml:uri>https://www.rfc-editor.org/rfc/rfc5737.html</maml:uri>
      </maml:navigationLink>
      <maml:navigationLink>
        <maml:linkText>RFC3927</maml:linkText>
        <maml:uri>https://www.rfc-editor.org/rfc/rfc3927.html</maml:uri>
      </maml:navigationLink>
      <maml:navigationLink>
        <maml:linkText>RFC6598</maml:linkText>
        <maml:uri>https://www.rfc-editor.org/rfc/rfc6598.html</maml:uri>
      </maml:navigationLink>
    </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-IpNetworkBase</command:name>
      <command:verb>Get</command:verb>
      <command:noun>IpNetworkBase</command:noun>
      <maml:description>
        <maml:para>Get an IpAddress object containing the Base Network Address for the CIDR or IP and Mask supplied.</maml:para>
      </maml:description>
    </command:details>
    <maml:description>
      <maml:para>Get an IpAddress object containing the Base Network Address for the CIDR or IP and Mask supplied. The CIDR or IP address provided may not represent the base address of the network.</maml:para>
    </maml:description>
    <command:syntax>
      <command:syntaxItem>
        <maml:name>Get-IpNetworkBase</maml:name>
      </command:syntaxItem>
    </command:syntax>
    <command:parameters>
      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
        <maml:name>CIDR</maml:name>
        <maml:description>
          <maml:para>A CIDR Notation string.</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>IP</maml:name>
        <maml:description>
          <maml:para>A Dotted Quad notation string representing the base address of the network.</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>Mask</maml:name>
        <maml:description>
          <maml:para>A Dotted Quad notation string representing the network mask.</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>IpAddress</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-IpNetworkBase -CIDR "192.168.10.10/24").IPAddressToString

    192.168.100.0</dev:code>
        <dev:remarks>
          <maml:para>Create a new IpNetwork object for the network specified in the CIDR.</maml:para>
        </dev:remarks>
      </command:example>
      <command:example>
        <maml:title>-------------------------- Example 2 --------------------------</maml:title>
        <dev:code>PS C:&gt; $MyNetwork = Get-IpNetworkBase -IP "192.168.10.18" -Mask "255.255.255.248"

    AddressFamily : InterNetwork
    ScopeId :
    IsIPv6Multicast : False
    IsIPv6LinkLocal : False
    IsIPv6SiteLocal : False
    IsIPv6Teredo : False
    IsIPv6UniqueLocal : False
    IsIPv4MappedToIPv6 : False
    Address : 275032256
    IPAddressToString : 192.168.100.16</dev:code>
        <dev:remarks>
          <maml:para>Create a new IpNetwork object for the network specified in the IP and Mask parameters.</maml:para>
        </dev:remarks>
      </command:example>
    </command:examples>
    <command:relatedLinks>
      <maml:navigationLink>
        <maml:linkText>IP.Tools Project</maml:linkText>
        <maml:uri>https://github.com/jberkers42/ip.tools</maml:uri>
      </maml:navigationLink>
    </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-IpNetwork</command:name>
      <command:verb>New</command:verb>
      <command:noun>IpNetwork</command:noun>
      <maml:description>
        <maml:para>Create a new IpNetwork object containing the Address and Mask supplied.</maml:para>
      </maml:description>
    </command:details>
    <maml:description>
      <maml:para>Create a new IpNetwork object using either a supplied CIDR Notation adddress, or a pair of IP and NetMask.</maml:para>
    </maml:description>
    <command:syntax>
      <command:syntaxItem>
        <maml:name>New-IpNetwork</maml:name>
      </command:syntaxItem>
    </command:syntax>
    <command:parameters>
      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
        <maml:name>CIDR</maml:name>
        <maml:description>
          <maml:para>A CIDR Notation string.</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>IP</maml:name>
        <maml:description>
          <maml:para>A Dotted Quad notation string representing the base address of the network.</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>Mask</maml:name>
        <maml:description>
          <maml:para>A Dotted Quad notation string representing the network mask.</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>IpNetwork</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; $MyNetwork = New-IpNetwork -CIDR "192.168.10.0/24"</dev:code>
        <dev:remarks>
          <maml:para>Create a new IpNetwork object for the network specified in the CIDR.</maml:para>
        </dev:remarks>
      </command:example>
      <command:example>
        <maml:title>-------------------------- Example 2 --------------------------</maml:title>
        <dev:code>PS C:&gt; $MyNetwork = New-IpNetwork -IP "192.168.10.0" -Mask "255.255.255.0"</dev:code>
        <dev:remarks>
          <maml:para>Create a new IpNetwork object for the network specified in the IP and Mask parameters.</maml:para>
        </dev:remarks>
      </command:example>
    </command:examples>
    <command:relatedLinks>
      <maml:navigationLink>
        <maml:linkText>IP.Tools Project</maml:linkText>
        <maml:uri>https://github.com/jberkers42/ip.tools</maml:uri>
      </maml:navigationLink>
    </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-IpBogon</command:name>
      <command:verb>Remove</command:verb>
      <command:noun>IpBogon</command:noun>
      <maml:description>
        <maml:para>Filter out Bogons from the provided list of IP addresses</maml:para>
      </maml:description>
    </command:details>
    <maml:description>
      <maml:para>Filter out IP Bogon (Internet non-routable) Addresses from the provided list of IP Addresses in either string or ipaddress format.</maml:para>
    </maml:description>
    <command:syntax>
      <command:syntaxItem>
        <maml:name>Remove-IpBogon</maml:name>
      </command:syntaxItem>
    </command:syntax>
    <command:parameters />
    <command:inputTypes>
      <command:inputType>
        <dev:type>
          <maml:name>String or IpAddress</maml:name>
        </dev:type>
        <maml:description>
          <maml:para></maml:para>
        </maml:description>
      </command:inputType>
    </command:inputTypes>
    <command:returnValues>
      <command:returnValue>
        <dev:type>
          <maml:name>IpAddress</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 &gt; $IPList = Get-ListFromSomewhere
PS &gt; $FilteredList = $IPList | Remove-IpBogon</dev:code>
        <dev:remarks>
          <maml:para>Obtain a list of addresses from somewhere (such as a SIEM) and filter out the IP Bogons from this list.</maml:para>
        </dev:remarks>
      </command:example>
      <command:example>
        <maml:title>-------------------------- Example 2 --------------------------</maml:title>
        <dev:code>PS &gt; $IPList = Get-ListFromSomewhere
PS &gt; $FilteredList = ($IPList | Remove-IpBogon).IpAddressToString</dev:code>
        <dev:remarks>
          <maml:para>Obtain a list of addresses from somewhere (such as a SIEM) and filter out the IP Bogons from this list, keeping only the string representations of the addresses.</maml:para>
        </dev:remarks>
      </command:example>
    </command:examples>
    <command:relatedLinks>
      <maml:navigationLink>
        <maml:linkText>IP.Tools Project</maml:linkText>
        <maml:uri>https://github.com/jberkers42/ip.tools</maml:uri>
      </maml:navigationLink>
      <maml:navigationLink>
        <maml:linkText>IP Bogon Ranges</maml:linkText>
        <maml:uri>https://ipgeolocation.io/resources/bogon.html</maml:uri>
      </maml:navigationLink>
      <maml:navigationLink>
        <maml:linkText>RFC1112</maml:linkText>
        <maml:uri>https://www.rfc-editor.org/rfc/rfc1112.html</maml:uri>
      </maml:navigationLink>
      <maml:navigationLink>
        <maml:linkText>RFC1122</maml:linkText>
        <maml:uri>https://www.rfc-editor.org/rfc/rfc1122.html</maml:uri>
      </maml:navigationLink>
      <maml:navigationLink>
        <maml:linkText>RFC1918</maml:linkText>
        <maml:uri>https://www.rfc-editor.org/rfc/rfc1918.html</maml:uri>
      </maml:navigationLink>
      <maml:navigationLink>
        <maml:linkText>RFC2544</maml:linkText>
        <maml:uri>https://www.rfc-editor.org/rfc/rfc2544.html</maml:uri>
      </maml:navigationLink>
      <maml:navigationLink>
        <maml:linkText>RFC5736</maml:linkText>
        <maml:uri>https://www.rfc-editor.org/rfc/rfc5736.html</maml:uri>
      </maml:navigationLink>
      <maml:navigationLink>
        <maml:linkText>RFC5737</maml:linkText>
        <maml:uri>https://www.rfc-editor.org/rfc/rfc5737.html</maml:uri>
      </maml:navigationLink>
      <maml:navigationLink>
        <maml:linkText>RFC3927</maml:linkText>
        <maml:uri>https://www.rfc-editor.org/rfc/rfc3927.html</maml:uri>
      </maml:navigationLink>
      <maml:navigationLink>
        <maml:linkText>RFC6598</maml:linkText>
        <maml:uri>https://www.rfc-editor.org/rfc/rfc6598.html</maml:uri>
      </maml:navigationLink>
    </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-IpBogon</command:name>
      <command:verb>Test</command:verb>
      <command:noun>IpBogon</command:noun>
      <maml:description>
        <maml:para>Test if the provided IP is a Bogon</maml:para>
      </maml:description>
    </command:details>
    <maml:description>
      <maml:para>Test whether the provided IP is an IP Bogon (Internet non-routable) Addresses.</maml:para>
    </maml:description>
    <command:syntax>
      <command:syntaxItem>
        <maml:name>Test-IpBogon</maml:name>
      </command:syntaxItem>
    </command:syntax>
    <command:parameters />
    <command:inputTypes>
      <command:inputType>
        <dev:type>
          <maml:name>IpAddress or String to test</maml:name>
        </dev:type>
        <maml:description>
          <maml:para></maml:para>
        </maml:description>
      </command:inputType>
    </command:inputTypes>
    <command:returnValues>
      <command:returnValue>
        <dev:type>
          <maml:name>IpNetwork</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 &gt; Test-IpBogon -Address "192.168.10.10"</dev:code>
        <dev:remarks>
          <maml:para>Test if the provided address is a Bogon, with RFC1918 address.</maml:para>
          <maml:para>Returns $true</maml:para>
        </dev:remarks>
      </command:example>
      <command:example>
        <maml:title>-------------------------- Example 2 --------------------------</maml:title>
        <dev:code>PS &gt; Test-IpBogon -Address "8.8.8.8"</dev:code>
        <dev:remarks>
          <maml:para>Test if the provided address is a Bogon, with Google DNS address.</maml:para>
          <maml:para>Returns $false</maml:para>
        </dev:remarks>
      </command:example>
    </command:examples>
    <command:relatedLinks>
      <maml:navigationLink>
        <maml:linkText>IP.Tools Project</maml:linkText>
        <maml:uri>https://github.com/jberkers42/ip.tools</maml:uri>
      </maml:navigationLink>
      <maml:navigationLink>
        <maml:linkText>IP Bogon Ranges</maml:linkText>
        <maml:uri>https://ipgeolocation.io/resources/bogon.html</maml:uri>
      </maml:navigationLink>
      <maml:navigationLink>
        <maml:linkText>RFC1112</maml:linkText>
        <maml:uri>https://www.rfc-editor.org/rfc/rfc1112.html</maml:uri>
      </maml:navigationLink>
      <maml:navigationLink>
        <maml:linkText>RFC1122</maml:linkText>
        <maml:uri>https://www.rfc-editor.org/rfc/rfc1122.html</maml:uri>
      </maml:navigationLink>
      <maml:navigationLink>
        <maml:linkText>RFC1918</maml:linkText>
        <maml:uri>https://www.rfc-editor.org/rfc/rfc1918.html</maml:uri>
      </maml:navigationLink>
      <maml:navigationLink>
        <maml:linkText>RFC2544</maml:linkText>
        <maml:uri>https://www.rfc-editor.org/rfc/rfc2544.html</maml:uri>
      </maml:navigationLink>
      <maml:navigationLink>
        <maml:linkText>RFC5736</maml:linkText>
        <maml:uri>https://www.rfc-editor.org/rfc/rfc5736.html</maml:uri>
      </maml:navigationLink>
      <maml:navigationLink>
        <maml:linkText>RFC5737</maml:linkText>
        <maml:uri>https://www.rfc-editor.org/rfc/rfc5737.html</maml:uri>
      </maml:navigationLink>
      <maml:navigationLink>
        <maml:linkText>RFC3927</maml:linkText>
        <maml:uri>https://www.rfc-editor.org/rfc/rfc3927.html</maml:uri>
      </maml:navigationLink>
      <maml:navigationLink>
        <maml:linkText>RFC6598</maml:linkText>
        <maml:uri>https://www.rfc-editor.org/rfc/rfc6598.html</maml:uri>
      </maml:navigationLink>
    </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-IpInNetwork</command:name>
      <command:verb>Test</command:verb>
      <command:noun>IpInNetwork</command:noun>
      <maml:description>
        <maml:para>Test if the provided IP is part of the provided network</maml:para>
      </maml:description>
    </command:details>
    <maml:description>
      <maml:para>Test whether the provided IP is a part of the provided network</maml:para>
    </maml:description>
    <command:syntax>
      <command:syntaxItem>
        <maml:name>Test-IpInNetwork</maml:name>
      </command:syntaxItem>
    </command:syntax>
    <command:parameters>
      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none">
        <maml:name>Address</maml:name>
        <maml:description>
          <maml:para>String of dotted quad notation for an IP Address, or an IpAddress object. Address to test.</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>Network</maml:name>
        <maml:description>
          <maml:para>IpNetwork object, consisting of an IpAddress and a Netmask or String in CIDR Notation. Network to test against.</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>IpAddress or String to test</maml:name>
        </dev:type>
        <maml:description>
          <maml:para></maml:para>
        </maml:description>
      </command:inputType>
    </command:inputTypes>
    <command:returnValues>
      <command:returnValue>
        <dev:type>
          <maml:name>boolean</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 &gt; Test-IpInNetwork -Address "192.168.10.10" -Network (New-IpNetwork "192.168.10.0/24")</dev:code>
        <dev:remarks>
          <maml:para>Test if the provided address is a part of the provided network.</maml:para>
          <maml:para>Returns $true</maml:para>
        </dev:remarks>
      </command:example>
      <command:example>
        <maml:title>-------------------------- Example 2 --------------------------</maml:title>
        <dev:code>PS &gt; Test-IpInNetwork -Address "8.8.8.8" -Network "192.168.10.0/24"</dev:code>
        <dev:remarks>
          <maml:para>Test if the provided address is apart of the specified network.</maml:para>
          <maml:para>Returns $false</maml:para>
        </dev:remarks>
      </command:example>
    </command:examples>
    <command:relatedLinks>
      <maml:navigationLink>
        <maml:linkText>IP.Tools Project</maml:linkText>
        <maml:uri>https://github.com/jberkers42/ip.tools</maml:uri>
      </maml:navigationLink>
    </command:relatedLinks>
  </command:command>
</helpItems>