This is an archive version of the document. To get the most up-to-date information, see the current version.Set-VBRSNMPReceiver
Short Description
Modifies SNMP recipient settings.
Product Edition: Standard, Enterprise, Enterprise Plus, Veeam Universal License
Syntax
Set-VBRSNMPReceiver -Receiver <VBRSNMPReceiver> [-ReceiverIP <string>] [-ReceiverPort <int>] [-CommunityString <string>] [<CommonParameters>] |
Detailed Description
This cmdlet modifies SNMP recipient settings.
Parameters
Parameter | Description | Type | Required | Position | Accept Pipeline Input |
|---|---|---|---|---|---|
Receiver | Specifies the SNMP recipient settings that you want to modify. | Accepts the VBRSNMPReceiver[] object. To create this object, run the New-VBRSNMPReceiver cmdlet. | True | Named | False |
ReceiverIP | Specifies an IP addresses of the SNMP recipient. The cmdlet will modify this IP address. | String | False | Named | False |
ReceiverPort | Specifies the port number that Veeam Backup & Replication will use to send messages. The cmdlet will modify this port number. | int | False | Named | False |
CommunityString | Specifies the community identifier. The cmdlet will modify this community identifier. | String | False | Named | False |
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.
Output Object
The cmdlet returns the VBRSNMPReceiver object that defines SNMP recipient settings.
Examples
Modifying SNMP Recipient Settings Recepient IP
This example shows how to modify an IP address of the SNMP recipient from 172.17.53.28 to 172.17.53.23.
$options = New-VBRSNMPReceiver -ReceiverIP 172.17.53.28 -ReceiverPort 22 -CommunityString public Set-VBRSNMPReceiver -Receiver $options -ReceiverIP 172.17.53.23 |
Perform the following steps:
- Run the New-VBRSNMPReceiver cmdlet. Specify the ReceiverIP, ReceiverPort and the CommunityString parameters. Save the result to the $options variable.
- Run the Set-VBRSNMPReceiver cmdlet. Set the $options variable as the Receiver parameter value. Specify the ReceiverIP parameter value.
Related Commands
