Edit

Share via

Get-NetLldpAgent

  • Reference
Module:
NetLldpAgent

Gets the settings of the LLDP agent on a network interface on a host computer.

Syntax

Get-NetLldpAgent
   [[-NetAdapterName] <String[]>]
   [[-AddressScope] <AddressScope[]>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [<CommonParameters>]
Get-NetLldpAgent
   [[-AddressScope] <AddressScope[]>]
   [[-InterfaceIndex] <UInt32[]>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [<CommonParameters>]

Description

The Get-NetLldpAgent cmdlet gets the settings of the Logical Link Discovery Protocol (LLDP) agent on a network interface on a host computer.

Examples

Example 1: Get LLDP agent settings on the local computer

PS C:\>Get-NetLldpAgent -NetAdapterName "Ethernet1"

This command gets LLDP agent settings on a network interface named Ethernet1 on the local computer.

Parameters

-AddressScope

Specifies an array of neighbor scopes of the adapter for which this cmdlet gets the LLDP agent settings. The acceptable values for this parameter are:

  • NearestNeighbor
  • NearestNonTpmrBridge
  • NearestCustomerBridge
Type:AddressScope[]
Accepted values:NearestBridge, NearestNonTpmrBridge, NearestCustomerBridge
Position:1
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-AsJob

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.

The cmdlet immediately returns an object that represents the job and then displays the command prompt. You can continue to work in the session while the job completes. To manage the job, use the *-Job cmdlets. To get the job results, use the Receive-Job cmdlet.

For more information about Windows PowerShell background jobs, see about_Jobs.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-CimSession

Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.

Type:CimSession[]
Aliases:Session
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InterfaceIndex

Specifies an array of indexes for which this cmdlet gets LLDP agent settings.

Type:UInt32[]
Position:0
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-NetAdapterName

Specifies an array of names of the interfaces for which this cmdlet gets LLDP agent settings.

Type:String[]
Position:0
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-ThrottleLimit

Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Outputs

CimInstance

This cmdlet retrieves the following settings:

  • Interface Alias
  • Interface Index
  • Scope
  • MAC address