Get-SNMPAgent

Synopsis

Gets the SNMP agent details from a local or remote computer.

Syntax

• Get-SNMPAgent [-ComputerName] [-Credential]

Description

The Get-SNMPAgent cmdlet is used to retrieve the SNMP agent details, such as contact, location and services, from the local or a remote computer.

Parameters

• ComputerName The computer against which to run the cmdlet. By default this parameter will be populated with the name of the local computer.
• Credential The credentials under which to run the cmdlet. By default this cmdlet will run as the current user. Using this parameter and the Get-PSCredential cmdlet you can specify an alternate set of credentials under which to execute this command.

Inputs

Get-SNMPAgent accepts pipeline input only for the ComputerName parameter and requires that the input object contain a property named either Computer, CN or ComputerName.

Outputs

Get-SNMPAgent outputs a Vexasoft.SNMPAgent object detailing the agent settings of the target computer.

Notes

The Get-SNMPAgent cmdlet requires that the RPC service is started on the computer it is trying to access and that DNS services are available to resolve target host names.

Example 1

This command will retrieve the SNMP Agent settings of the local computer:

C:\PS>Get-SNMPAgent

Example 2

This command will retrieve the SNMP Agent settings of the remote computer PC01:

C:\PS>Get-SNMPAgent -Computer PC01