Get-netipconfiguration PowerShell Command

The Get-NetIPConfiguration command in Windows PowerShell is a powerful tool for managing and configuring network settings. It can be used to view and modify the network configuration of a computer, including IP addresses, DNS servers, and other network settings. In this article, we will discuss the syntax, parameters, inputs, outputs, examples, and tips for using the Get-NetIPConfiguration command.

Syntax

The syntax for the Get-NetIPConfiguration command is as follows:

Get-NetIPConfiguration [-InterfaceIndex <UInt32>] [-AddressFamily <AddressFamily>] [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob] [-IncludeAllCompartments] [-IncludeHidden] [-IncludeLinkLayerInfo] [-IncludeNetAdapter] [-IncludeNetConnection] [-IncludeNetIPAddress] [-IncludeNetIPInterface] [-IncludeNetIPv6Address] [-IncludeNetRoute] [-IncludeNetRouteMetric] [-IncludeNetRouteNextHop] [-IncludeNetSwitchPort] [-IncludeNetTCPConnection] [-IncludeNetUDPEndpoint] [-IncludeNetWinsServer] [-IncludeRouteMetric] [-IncludeSwitchPort] [-IncludeTCPConnection] [-IncludeUDPEndpoint] [-IncludeWinsServer] [-PassThru] [-ComputerName <String[]>] [-Credential <PSCredential>] [-Authentication <AuthenticationLevel>] [-CertificateThumbprint <String>] [-Impersonation <ImpersonationLevel>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [-SkipRevocationCheck] [-UseSSL] [-WhatIf] [-Confirm] [<CommonParameters>]

Parameters

The Get-NetIPConfiguration command has several parameters that can be used to customize the output. These parameters are:

  • -InterfaceIndex: Specifies the interface index of the network adapter.
  • -AddressFamily: Specifies the address family of the network adapter.
  • -CimSession: Specifies the CimSession object to use for the operation.
  • -ThrottleLimit: Specifies the maximum number of concurrent operations that can be established to run the cmdlet.
  • -AsJob: Runs the cmdlet as a background job.
  • -IncludeAllCompartments: Includes all compartments in the output.
  • -IncludeHidden: Includes hidden network adapters in the output.
  • -IncludeLinkLayerInfo: Includes link layer information in the output.
  • -IncludeNetAdapter: Includes network adapter information in the output.
  • -IncludeNetConnection: Includes network connection information in the output.
  • -IncludeNetIPAddress: Includes IP address information in the output.
  • -IncludeNetIPInterface: Includes IP interface information in the output.
  • -IncludeNetIPv6Address: Includes IPv6 address information in the output.
  • -IncludeNetRoute: Includes route information in the output.
  • -IncludeNetRouteMetric: Includes route metric information in the output.
  • -IncludeNetRouteNextHop: Includes route next hop information in the output.
  • -IncludeNetSwitchPort: Includes switch port information in the output.
  • -IncludeNetTCPConnection: Includes TCP connection information in the output.
  • -IncludeNetUDPEndpoint: Includes UDP endpoint information in the output.
  • -IncludeNetWinsServer: Includes WINS server information in the output.
  • -IncludeRouteMetric: Includes route metric information in the output.
  • -IncludeSwitchPort: Includes switch port information in the output.
  • -IncludeTCPConnection: Includes TCP connection information in the output.
  • -IncludeUDPEndpoint: Includes UDP endpoint information in the output.
  • -IncludeWinsServer: Includes WINS server information in the output.
  • -PassThru: Passes the output object through the pipeline.
  • -ComputerName: Specifies the computer name to use for the operation.
  • -Credential: Specifies the credentials to use for the operation.
  • -Authentication: Specifies the authentication level to use for the operation.
  • -CertificateThumbprint: Specifies the certificate thumbprint to use for the operation.
  • -Impersonation: Specifies the impersonation level to use for the operation.
  • -InformationAction: Specifies how the cmdlet responds to an information event.
  • -InformationVariable: Specifies an information variable.
  • -SkipRevocationCheck: Specifies whether to skip the revocation check.
  • -UseSSL: Specifies whether to use SSL for the operation.
  • -WhatIf: Shows what would happen if the cmdlet runs.
  • -Confirm: Prompts you for confirmation before running the cmdlet.
  • <CommonParameters>: This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable.

Inputs

The Get-NetIPConfiguration command does not accept any inputs.

Outputs

The Get-NetIPConfiguration command returns an object containing the network configuration information for the specified computer. The object contains the following properties:

  • InterfaceIndex: The interface index of the network adapter.
  • AddressFamily: The address family of the network adapter.
  • IPAddress: The IP address of the network adapter.
  • SubnetMask: The subnet mask of the network adapter.
  • DefaultGateway: The default gateway of the network adapter.
  • DNSDomain: The DNS domain of the network adapter.
  • DNSServer: The DNS server of the network adapter.
  • DomainSuffixSearchOrder: The domain suffix search order of the network adapter.
  • IPv6Address: The IPv6 address of the network adapter.
  • IPv6DefaultGateway: The IPv6 default gateway of the network adapter.
  • IPv6DNSServer: The IPv6 DNS server of the network adapter.
  • IPv6PrefixLength: The IPv6 prefix length of the network adapter.
  • IPv6Suffix: The IPv6 suffix of the network adapter.
  • LinkLayerAddress: The link layer address of the network adapter.

Leave a Reply