{"id":1209,"date":"2011-03-10T10:02:47","date_gmt":"2011-03-10T15:02:47","guid":{"rendered":"http:\/\/jdhitsolutions.com\/blog\/?p=1209"},"modified":"2013-06-28T08:36:26","modified_gmt":"2013-06-28T12:36:26","slug":"get-ip-data","status":"publish","type":"post","link":"https:\/\/jdhitsolutions.com\/blog\/powershell\/1209\/get-ip-data\/","title":{"rendered":"Get IP Data"},"content":{"rendered":"

I was doodling in PowerShell this morning and ended up with what I hope is a useful function to retrieve IP configuration information, sort of like IPCONFIG, but using WMI. The beauty is that I can connect to remote machines and the output is an object which leads to all sorts of possibilities.<\/p>\n

My function is called Get-IPData.<\/p>\n

Function Get-IPData {\r\n#this function assumes admin credentials\r\n[cmdletBinding()]\r\nParam(\r\n    [Parameter(Position=0,ValueFromPipeline=$True,ValueFromPipelineByPropertyName=$True)]\r\n    [ValidateNotNullOrEmpty()]\r\n    [Alias(\"name\")]\r\n    [string[]]$computername=$env:computername\r\n)\r\n\r\nProcess {\r\n    ForEach ($computer in $computername) {\r\n        Write-Verbose \"Querying $($computer.ToUpper())\"\r\n        Try \r\n        {\r\n            #get NICS that are IP and DHCP enabled\r\n            Get-WMIObject -Class win32_networkadapterconfiguration -computername $Computer `\r\n            -Filter \"IPEnabled='TRUE' AND DHCPEnabled='TRUE'\" -ErrorAction \"Stop\" | \r\n            Select Description,DNSHostname,\r\n            @{Name=\"IPAddress\";Expression={$_.IPAddress[0]}},\r\n            @{Name=\"SubnetMask\";Expression={$_.IPSubnet[0]}},\r\n            @{Name=\"DefaultGateway\";Expression={$_.DefaultIPGateway[0]}},DNSDomain,\r\n            @{Name=\"PrimaryDNS\";Expression={$_.DNSServerSearchOrder[0]}},DHCPServer,\r\n            @{Name=\"DHCPLease\";Expression={$_.ConvertToDateTime($_.DHCPLeaseObtained)}},\r\n            @{Name=\"DHCPExpires\";Expression={$_.ConvertToDateTime($_.DHCPLeaseExpires)}},\r\n            @{Name=\"DHCPTimeToLive\";Expression={ $_.ConvertToDateTime($_.DHCPLeaseExpires) - (Get-Date)}},\r\n            MACAddress,\r\n            @{Name=\"Speed\";Expression={\r\n            #use an Associators Of query to get the NIC\r\n              $nic=Get-WmiObject -query \"associators of {Win32_NetworkAdapterConfiguration.Index=$($_.index)}\" -computername $computer\r\n              $nic.Speed\r\n              }}\r\n        } #close Try\r\n        Catch\r\n        {\r\n            Write-Warning \"Failed to retrieve IP configuration from $($computer.ToUpper())\"\r\n            Write-Warning $_.Exception.Message\r\n\r\n        } #close Catch\r\n    } #close ForEach\r\n } #close Process\r\n} #end function<\/pre>\n
The function takes computernames as a parameter, uses WMI to get the NetworkAdapterConfiguration for IP and DHCP enabled adapters.<\/p>\n
Get-WMIObject -Class win32_networkadapterconfiguration -computername $Computer -Filter \"IPEnabled='TRUE' AND DHCPEnabled='TRUE'\" -ErrorAction \"Stop\"<\/pre>\n
The rest of the function simply selects key properties including another WMI query to get the associated adapater's speed. Because some items like IP address are stored as arrays, I use a hash table expression to return the first item only.<\/p>\n
PS C:\\> get-ipdata\r\n\r\nDescription    : Atheros AR8131 PCI-E Gigabit Ethernet Controller (NDIS 6.20)\r\nDNSHostname    : SERENITY\r\nIPAddress      : 172.16.10.124\r\nSubnetMask     : 255.255.0.0\r\nDefaultGateway : 172.16.10.254\r\nDNSDomain      : jdhitsolutions.local\r\nPrimaryDNS     : 172.16.10.1\r\nDHCPServer     : 172.16.10.1\r\nDHCPLease      : 3\/10\/2011 7:30:01 AM\r\nDHCPExpires    : 3\/13\/2011 8:30:01 AM\r\nDHCPTimeToLive : 2.22:43:15.9650056\r\nMACAddress     : 00:26:9E:C7:09:76\r\nSpeed          : 1000000000<\/pre>\n
I started to do my usual code polishing but then I realized this might be a good exercise for you. The function works as is with some limited error handling in a Try\/Catch block. But there are several areas for improvement or enhancement. You might want to:<\/p>\n