Get-NetLldpAgent
Gets the settings of the LLDP agent on a network interface on a host computer.
Syntax
ByName (Default)
Get-NetLldpAgent
[[-NetAdapterName] <String[]>]
[[-AddressScope] <AddressScope[]>]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[<CommonParameters>]
ByIfIndex
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
Parameter properties
Type: | AddressScope[] |
Default value: | None |
Accepted values: | NearestBridge, NearestNonTpmrBridge, NearestCustomerBridge |
Supports wildcards: | False |
DontShow: | False |
Parameter sets
(All)
Position: | 1 |
Mandatory: | False |
Value from pipeline: | False |
Value from pipeline by property name: | True |
Value from remaining arguments: | 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.
Parameter properties
Type: | SwitchParameter |
Default value: | None |
Supports wildcards: | False |
DontShow: | False |
Parameter sets
(All)
Position: | Named |
Mandatory: | False |
Value from pipeline: | False |
Value from pipeline by property name: | False |
Value from remaining arguments: | 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.
Parameter properties
Type: | CimSession[] |
Default value: | None |
Supports wildcards: | False |
DontShow: | False |
Aliases: | Session |
Parameter sets
(All)
Position: | Named |
Mandatory: | False |
Value from pipeline: | False |
Value from pipeline by property name: | False |
Value from remaining arguments: | False |
-InterfaceIndex
Specifies an array of indexes for which this cmdlet gets LLDP agent settings.
Parameter properties
Type: | UInt32[] |
Default value: | None |
Supports wildcards: | False |
DontShow: | False |
Parameter sets
ByIfIndex
Position: | 0 |
Mandatory: | False |
Value from pipeline: | False |
Value from pipeline by property name: | True |
Value from remaining arguments: | False |
-NetAdapterName
Specifies an array of names of the interfaces for which this cmdlet gets LLDP agent settings.
Parameter properties
Type: | String[] |
Default value: | None |
Supports wildcards: | False |
DontShow: | False |
Parameter sets
ByName
Position: | 0 |
Mandatory: | False |
Value from pipeline: | False |
Value from pipeline by property name: | True |
Value from remaining arguments: | 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.
Parameter properties
Type: | Int32 |
Default value: | None |
Supports wildcards: | False |
DontShow: | False |
Parameter sets
(All)
Position: | Named |
Mandatory: | False |
Value from pipeline: | False |
Value from pipeline by property name: | False |
Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Outputs
CimInstance
This cmdlet retrieves the following settings:
- Interface Alias
- Interface Index
- Scope
- MAC address