en-US/IPv4Toolbox-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>ConvertTo-InverseAddress</command:name> <command:verb>ConvertTo</command:verb> <command:noun>InverseAddress</command:noun> <maml:description> <maml:para>Converts an IPv4 Address or Subnet into Windows PTR Zone compatible domain name.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Converts an IPv4 Address or Subnet into Windows PTR Zone compatible domain name.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>ConvertTo-InverseAddress</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>IPv4Address</maml:name> <maml:description> <maml:para>IPv4 Address to convert to an inverse address</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>127.0.0.1</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>ConvertTo-InverseAddress</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Subnet</maml:name> <maml:description> <maml:para>The subnet id to convert to an inverse address</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.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>Prefix</maml:name> <maml:description> <maml:para>The subnet prefix for the subnet to convert to an inverse address</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>IPv4Address</maml:name> <maml:description> <maml:para>IPv4 Address to convert to an inverse address</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>127.0.0.1</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Prefix</maml:name> <maml:description> <maml:para>The subnet prefix for the subnet to convert to an inverse address</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Subnet</maml:name> <maml:description> <maml:para>The subnet id to convert to an inverse address</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.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>System.String[]</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>ConvertTo-InverseAddress -IPv4Address '192.168.1.1' 1.1.168.192.in-addr.arpa</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>ConvertTo-InverseAddress -Subnet '10.2.2.0' -Prefix 22 0.2.10.in-addr.arpa 1.2.10.in-addr.arpa 2.2.10.in-addr.arpa 3.2.10.in-addr.arpa</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.github.com/roberttoups/IPv4Toolbox</maml:linkText> <maml:uri>http://www.github.com/roberttoups/IPv4Toolbox</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>Find-IPv4Address</command:name> <command:verb>Find</command:verb> <command:noun>IPv4Address</command:noun> <maml:description> <maml:para>Returns all valid IPv4 Address in a string.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Find-IPv4Address will search a block of text for IPv4 Addresses and returns only the IPv4 Addresses found.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Find-IPv4Address</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>Text</maml:name> <maml:description> <maml:para>The block of text to discover IPv4 Addresses</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.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="1" aliases="none"> <maml:name>Text</maml:name> <maml:description> <maml:para>The block of text to discover IPv4 Addresses</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.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>System.String[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>The body of text provided to the Text parameter can be multi-line. The function will only return valid IPv4 Addresses from 0.0.0.0 to 255.255.255.255.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Find-IPv4Address -Text 'Mary had little lamb 192.168.1.1 who fleece was white as snow, 127.0.0.1.' 192.168.1.1 127.0.0.1</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>cat /var/log/fail2ban.log | Find-IPv4Address | Sort-Object -Property @{Expression = { $_ -as [System.Version] } } -Unique 2.90.110.124 14.184.248.97 14.186.84.158 27.147.226.173 37.144.205.31 39.59.34.40 41.228.238.217 ...</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.github.com/roberttoups/IPv4Toolbox</maml:linkText> <maml:uri>http://www.github.com/roberttoups/IPv4Toolbox</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-SubnetInformation</command:name> <command:verb>Get</command:verb> <command:noun>SubnetInformation</command:noun> <maml:description> <maml:para>Returns the information regarding a subnet that an IPv4 Address exists</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns the information regarding a subnet that an IPv4 Address exists and returns information regarding Subnet ID, Broadcast Address, Subnet Mask, Network Prefix, First IP Address, Last IP Address, Total Hosts, and AWS related information.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-SubnetInformation</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="IPAddress"> <maml:name>IPv4Address</maml:name> <maml:description> <maml:para>The IPv4 Address</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.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>NoPrivateAddressSpace</maml:name> <maml:description> <maml:para>This switch omits the reporting of Private Address Space for the subnet and any associated AWS information</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Prefix</maml:name> <maml:description> <maml:para>The network prefix</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>24</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-SubnetInformation</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="IPAddress"> <maml:name>IPv4Address</maml:name> <maml:description> <maml:para>The IPv4 Address</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.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="Mask"> <maml:name>SubnetMask</maml:name> <maml:description> <maml:para>The subnet mask of the network</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.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="True (ByValue)" position="named" aliases="IPAddress"> <maml:name>IPv4Address</maml:name> <maml:description> <maml:para>The IPv4 Address</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.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>NoPrivateAddressSpace</maml:name> <maml:description> <maml:para>This switch omits the reporting of Private Address Space for the subnet and any associated AWS information</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Prefix</maml:name> <maml:description> <maml:para>The network prefix</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>24</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Mask"> <maml:name>SubnetMask</maml:name> <maml:description> <maml:para>The subnet mask of the network</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.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>System.Management.Automation.PSObject</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>This function will only return results for AWS if the subnet has a prefix greater or equal to 16 and less than or equal 28 and resides in the Private Address Space.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Get-SubnetInformation -IPv4Address 192.168.1.120 -SubnetMask 255.255.254.0 SubnetId : 192.168.0.0 BroadcastAddress : 192.168.1.255 SubnetMask : 255.255.254.0 Prefix : 23 Subnet : 192.168.0.0/23 FirstIPv4Address : 192.168.0.1 LastIPv4Address : 192.168.1.254 TotalHosts : 510 AWSFirstIPv4Address : 192.168.0.4 AWSTotalHosts : 507 PrivateAddressSpace : True</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Get-SubnetInformation -IPv4Address 8.8.0.0 -Prefix 21 SubnetId : 8.8.0.0 BroadcastAddress : 8.8.7.255 SubnetMask : 255.255.248.0 Prefix : 21 Subnet : 8.8.0.0/21 FirstIPv4Address : 8.8.0.1 LastIPv4Address : 8.8.7.254 TotalHosts : 2046 AWSFirstIPv4Address : AWSTotalHosts : PrivateAddressSpace : False</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <dev:code>Get-SubnetInformation -IPv4Address 10.0.0.0 -Prefix 12 SubnetId : 10.0.0.0 BroadcastAddress : 10.15.255.255 SubnetMask : 255.240.0.0 Prefix : 12 Subnet : 10.0.0.0/12 FirstIPv4Address : 10.0.0.1 LastIPv4Address : 10.15.255.254 TotalHosts : 1048574 AWSFirstIPv4Address : AWSTotalHosts : PrivateAddressSpace : True</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <dev:code>Get-SubnetInformation -IPv4Address 10.0.0.0 -Prefix 28 -NoPrivateAddressSpace SubnetId : 10.0.0.0 BroadcastAddress : 10.0.0.15 SubnetMask : 255.255.255.240 Prefix : 28 Subnet : 10.0.0.0/28 FirstIPv4Address : 10.0.0.1 LastIPv4Address : 10.0.0.14 TotalHosts : 14 AWSFirstIPv4Address : AWSTotalHosts : PrivateAddressSpace :</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.github.com/roberttoups/IPv4Toolbox</maml:linkText> <maml:uri>http://www.github.com/roberttoups/IPv4Toolbox</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>Invoke-IPv4GeoLookup</command:name> <command:verb>Invoke</command:verb> <command:noun>IPv4GeoLookup</command:noun> <maml:description> <maml:para>Returns GeoIP Information from ip-api.com.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns GeoIP Information from ip-api.com.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-IPv4GeoLookup</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="IPAddress"> <maml:name>IPv4Address</maml:name> <maml:description> <maml:para>The non-RFC 1918 IPv4 Address to obtain the GeoIP information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.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="1" aliases="IPAddress"> <maml:name>IPv4Address</maml:name> <maml:description> <maml:para>The non-RFC 1918 IPv4 Address to obtain the GeoIP information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>Do not use this function multiple times a second or you will be rate limited.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Invoke-IPv4GeoLookup -IPv4Address 1.1.1.1 status : success country : Australia countryCode : AU region : QLD regionName : Queensland city : South Brisbane zip : 4101 lat : -27.4766 lon : 153.0166 timezone : Australia/Brisbane isp : Cloudflare, Inc org : APNIC and Cloudflare DNS Resolver project as : AS13335 Cloudflare, Inc. query : 1.1.1.1 mapReference : https://www.google.com/maps?q=-27.4766,153.0166</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.github.com/roberttoups/IPv4Toolbox</maml:linkText> <maml:uri>http://www.github.com/roberttoups/IPv4Toolbox</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>Invoke-IPv4ListSort</command:name> <command:verb>Invoke</command:verb> <command:noun>IPv4ListSort</command:noun> <maml:description> <maml:para>Sorts an array of IPv4 Addresses.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Sorts an array of IPv4 Addresses.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-IPv4ListSort</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>IPv4AddressList</maml:name> <maml:description> <maml:para>The list of IPv4 Addresses</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.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>Descending</maml:name> <maml:description> <maml:para>This switch will sort the IPv4 Addresses in reverse order</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Descending</maml:name> <maml:description> <maml:para>This switch will sort the IPv4 Addresses in reverse order</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>IPv4AddressList</maml:name> <maml:description> <maml:para>The list of IPv4 Addresses</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <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>Invoke-IPv4ListSort -IPv4AddressList @('192.168.0.1','10.12.2.2','1.1.1.1','8.8.8.8') 1.1.1.1 8.8.8.8 10.12.2.2 192.168.0.1</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Invoke-IPv4ListSort -IPv4AddressList @('192.168.0.1','10.12.2.2','1.1.1.1','8.8.8.8') -Descending 192.168.0.1 10.12.2.2 8.8.8.8 1.1.1.1</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <dev:code>Invoke-IPv4ListSort -IPv4AddressList @('1.1.1.1','192.168.1.0/28','10.12.13.14','8.8.8.8','4.2.2.1','192.168.23.2/29') 1.1.1.1 4.2.2.1 8.8.8.8 10.12.13.14 192.168.1.1 192.168.1.2 192.168.1.3 192.168.1.4 192.168.1.5 192.168.1.6 192.168.1.7 192.168.1.8 192.168.1.9 192.168.1.10 192.168.1.11 192.168.1.12 192.168.1.13 192.168.1.14 192.168.23.1 192.168.23.2 192.168.23.3 192.168.23.4 192.168.23.5 192.168.23.6</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.github.com/roberttoups/IPv4Toolbox</maml:linkText> <maml:uri>http://www.github.com/roberttoups/IPv4Toolbox</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>Out-SubnetRange</command:name> <command:verb>Out</command:verb> <command:noun>SubnetRange</command:noun> <maml:description> <maml:para>Outputs a list of IPv4 Addresses from a CIDR address range.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Outputs a list of IPv4 Addresses from a CIDR address range.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Out-SubnetRange</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="IPv4Address"> <maml:name>Subnet</maml:name> <maml:description> <maml:para>The subnet id of the IPv4 Address range</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.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>Prefix</maml:name> <maml:description> <maml:para>The Prefix of the IPv4 Address range</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>24</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Out-SubnetRange</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="IPv4Address"> <maml:name>Subnet</maml:name> <maml:description> <maml:para>The subnet id of the IPv4 Address range</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.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="Mask"> <maml:name>SubnetMask</maml:name> <maml:description> <maml:para>The Subnet Mask of the IPv4 Address range</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.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="named" aliases="none"> <maml:name>Prefix</maml:name> <maml:description> <maml:para>The Prefix of the IPv4 Address range</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>24</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="IPv4Address"> <maml:name>Subnet</maml:name> <maml:description> <maml:para>The subnet id of the IPv4 Address range</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.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="Mask"> <maml:name>SubnetMask</maml:name> <maml:description> <maml:para>The Subnet Mask of the IPv4 Address range</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>This function will output usable IP space.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Out-SubnetRange -Subnet 192.168.1.0 -Prefix 28 192.168.1.1 192.168.1.2 192.168.1.3 192.168.1.4 192.168.1.5 192.168.1.6 192.168.1.7 192.168.1.8 192.168.1.9 192.168.1.10 192.168.1.11 192.168.1.12 192.168.1.13 192.168.1.14</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.github.com/roberttoups/IPv4Toolbox</maml:linkText> <maml:uri>http://www.github.com/roberttoups/IPv4Toolbox</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>Split-Subnet</command:name> <command:verb>Split</command:verb> <command:noun>Subnet</command:noun> <maml:description> <maml:para>Breaks up a larger CIDR into small CIDRs.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Breaks up a larger CIDR into small CIDRs.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Split-Subnet</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="IPAddress, IPv4Address"> <maml:name>Subnet</maml:name> <maml:description> <maml:para>The Subnet Id to split</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.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>Prefix</maml:name> <maml:description> <maml:para>The network prefix of the source CIDR</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>TargetPrefix</maml:name> <maml:description> <maml:para>The network prefix to split the subnet into</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</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>Prefix</maml:name> <maml:description> <maml:para>The network prefix of the source CIDR</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="IPAddress, IPv4Address"> <maml:name>Subnet</maml:name> <maml:description> <maml:para>The Subnet Id to split</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.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="3" aliases="none"> <maml:name>TargetPrefix</maml:name> <maml:description> <maml:para>The network prefix to split the subnet into</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>0</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <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>Split-Subnet -Subnet 10.2.2.0 -Prefix 24 -TargetPrefix 25 SubnetId : 10.2.2.0 BroadcastAddress : 10.2.2.127 SubnetMask : 255.255.255.128 Prefix : 25 Subnet : 10.2.2.0/25 FirstIPv4Address : 10.2.2.1 LastIPv4Address : 10.2.2.126 TotalHosts : 126 AWSFirstIPv4Address : 10.2.2.4 AWSTotalHosts : 123 SubnetId : 10.2.2.128 BroadcastAddress : 10.2.2.255 SubnetMask : 255.255.255.128 Prefix : 25 Subnet : 10.2.2.128/25 FirstIPv4Address : 10.2.2.129 LastIPv4Address : 10.2.2.254 TotalHosts : 126 AWSFirstIPv4Address : 10.2.2.132 AWSTotalHosts : 123</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.github.com/roberttoups/IPv4Toolbox</maml:linkText> <maml:uri>http://www.github.com/roberttoups/IPv4Toolbox</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-IPv4AddressWithinRange</command:name> <command:verb>Test</command:verb> <command:noun>IPv4AddressWithinRange</command:noun> <maml:description> <maml:para>Evaluates if an IPv4 Address is equal or within an IPv4 Address range.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Evaluates if an IPv4 Address is equal or within an IPv4 Address range.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Test-IPv4AddressWithinRange</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="StartingIpAddress"> <maml:name>FirstIPv4Address</maml:name> <maml:description> <maml:para>The first IPv4 Address</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.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="EndingIpAddress"> <maml:name>LastIPv4Address</maml:name> <maml:description> <maml:para>The last IPv4 Address</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.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="3" aliases="TestingIpAddress"> <maml:name>TestIPv4Address</maml:name> <maml:description> <maml:para>The IPv4 Address to test</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.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="1" aliases="StartingIpAddress"> <maml:name>FirstIPv4Address</maml:name> <maml:description> <maml:para>The first IPv4 Address</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.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="EndingIpAddress"> <maml:name>LastIPv4Address</maml:name> <maml:description> <maml:para>The last IPv4 Address</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.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="3" aliases="TestingIpAddress"> <maml:name>TestIPv4Address</maml:name> <maml:description> <maml:para>The IPv4 Address to test</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.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>System.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>Test-IPv4AddressWithinRange -FirstIPv4Address '192.168.1.1' -LastIPv4Address '192.168.5.21' -TestIPv4Address '192.168.6.1' False</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Test-IPv4AddressWithinRange -FirstIPv4Address '192.168.1.1' -LastIPv4Address '192.168.1.50' -TestIPv4Address '192.168.1.20' True</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.github.com/roberttoups/IPv4Toolbox</maml:linkText> <maml:uri>http://www.github.com/roberttoups/IPv4Toolbox</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-PrivateIPv4Address</command:name> <command:verb>Test</command:verb> <command:noun>PrivateIPv4Address</command:noun> <maml:description> <maml:para>Determines if an IPv4 Address is in a private address space.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Determines if an IPv4 Address is in a private address space.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Test-PrivateIPv4Address</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="IPAddress"> <maml:name>IPv4Address</maml:name> <maml:description> <maml:para>The IPv4 Address</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.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="True (ByValue)" position="1" aliases="IPAddress"> <maml:name>IPv4Address</maml:name> <maml:description> <maml:para>The IPv4 Address</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.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>System.Boolean</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>The function supports RFC 1918 & RFC 6598 address space.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Test-PrivateIPv4Address -IPv4Address 192.168.1.1 True</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Test-PrivateIPv4Address -IPv4Address 8.8.8.8 False</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>http://www.github.com/roberttoups/IPv4Toolbox</maml:linkText> <maml:uri>http://www.github.com/roberttoups/IPv4Toolbox</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> </helpItems> |