Set-VMHostSnmp

This cmdlet modifies the host SNMP configuration. If specified, adds or removes a trap target (removing can be specified by either TrapTargetToRemove parameter or by any of the following parameters (or combination of them): TargetCommunity, TargetHost, TargetPort). If the user passes $null, an empty array or string to the ReadOnlyCommunities parameter, the old values of this property are erased. This results in a NULL value of this property of the output object.

Syntax

-HostSnmp  <VmHostSnmp[]>
[-Enabled  <Boolean>]
[-Port  <Int32>]
[-ReadOnlyCommunity  <String[]>]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
required
HostSnmp
VmHostSnmp[] named
  • pipeline
  • Specifies the host Snmp object you want to modify.
    optional
    Enabled
    Boolean named Indicates that the SNMP feature is enabled on the specified host.
    optional
    Port
    Int32 named Specifies the port on which the host listens to SNMP messages.
    optional
    ReadOnlyCommunity
    String[] named Provide a list of communities, identifying who is able to send SNMP requests to that host. If $null, an empty array or string are passed to this parameter, its old values are erased and the output object for the ReadOnlyCommunity property is an empty array. In PowerShell an empty array is defined by @().

    -AddTarget
    -HostSnmp  <VmHostSnmp[]>
    -TargetCommunity  <String>
    -TargetHost  <String>
    [-Enabled  <Boolean>]
    [-Port  <Int32>]
    [-ReadOnlyCommunity  <String[]>]
    [-TargetPort  <Int32>]
    [CommonParameters]

    Parameters

    Required Parameter Name Type Position Features Description
    required
    AddTarget
    SwitchParameter named Indicates that you want to add a new trap target to the host SNMP configuration. A trap target consists of three elements - Community (mandatory), HostName (mandatory), Port (optional - defaults to 162), specified by the TargetCommunity, TargetHost, and TargetPort parameters.
    required
    HostSnmp
    VmHostSnmp[] named
  • pipeline
  • Specifies the host Snmp object you want to modify.
    required
    TargetCommunity
    String named Specifies the community identifier of the trap target.
    required
    TargetHost
    String named Specifies the identifier of the target host - a host name or an IP address.
    optional
    Enabled
    Boolean named Indicates that the SNMP feature is enabled on the specified host.
    optional
    Port
    Int32 named Specifies the port on which the host listens to SNMP messages.
    optional
    ReadOnlyCommunity
    String[] named Provide a list of communities, identifying who is able to send SNMP requests to that host. If $null, an empty array or string are passed to this parameter, its old values are erased and the output object for the ReadOnlyCommunity property is an empty array. In PowerShell an empty array is defined by @().
    optional
    TargetPort
    Int32 named Specifies the port on which the target host listens to SNMP messages.

    -HostSnmp  <VmHostSnmp[]>
    -RemoveTarget
    [-Enabled  <Boolean>]
    [-Port  <Int32>]
    [-ReadOnlyCommunity  <String[]>]
    [-TargetCommunity  <String>]
    [-TargetHost  <String>]
    [-TargetPort  <Int32>]
    [CommonParameters]

    Parameters

    Required Parameter Name Type Position Features Description
    required
    HostSnmp
    VmHostSnmp[] named
  • pipeline
  • Specifies the host Snmp object you want to modify.
    required
    RemoveTarget
    SwitchParameter named Indicates that you want to remove a trap target from the host SNMP configuration. There are two ways to specify a trap target: * Pass the trap target to the TrapTargetToRemove parameter.
    optional
    Enabled
    Boolean named Indicates that the SNMP feature is enabled on the specified host.
    optional
    Port
    Int32 named Specifies the port on which the host listens to SNMP messages.
    optional
    ReadOnlyCommunity
    String[] named Provide a list of communities, identifying who is able to send SNMP requests to that host. If $null, an empty array or string are passed to this parameter, its old values are erased and the output object for the ReadOnlyCommunity property is an empty array. In PowerShell an empty array is defined by @().
    optional
    TargetCommunity
    String named Specifies the community identifier of the trap target.
    optional
    TargetHost
    String named Specifies the identifier of the target host - a host name or an IP address.
    optional
    TargetPort
    Int32 named Specifies the port on which the target host listens to SNMP messages.

    -HostSnmp  <VmHostSnmp[]>
    -TrapTargetToRemove  <TrapTarget>
    [-Enabled  <Boolean>]
    [-Port  <Int32>]
    [-ReadOnlyCommunity  <String[]>]
    [-RemoveTarget]
    [CommonParameters]

    Parameters

    Required Parameter Name Type Position Features Description
    required
    HostSnmp
    VmHostSnmp[] named
  • pipeline
  • Specifies the host Snmp object you want to modify.
    required
    TrapTargetToRemove
    TrapTarget named Specifies the trap target you want to remove. The trap target can be obtained from the "TrapTargets" property of the HostSNMP object (an array of TrapTarget objects).
    optional
    Enabled
    Boolean named Indicates that the SNMP feature is enabled on the specified host.
    optional
    Port
    Int32 named Specifies the port on which the host listens to SNMP messages.
    optional
    ReadOnlyCommunity
    String[] named Provide a list of communities, identifying who is able to send SNMP requests to that host. If $null, an empty array or string are passed to this parameter, its old values are erased and the output object for the ReadOnlyCommunity property is an empty array. In PowerShell an empty array is defined by @().
    optional
    RemoveTarget
    SwitchParameter named Indicates that you want to remove a trap target from the host SNMP configuration. There are two ways to specify a trap target: * Pass the trap target to the TrapTargetToRemove parameter.

    Output

    VMware.VimAutomation.ViCore.Types.V1.Host.VmHostSnmp

    Examples


    Example 1

    $vmhostSNMP = Get-VMHostSNMP
    Set-VMHostSNMP $vmhostSNMP -Enabled:$true -ReadOnlyCommunity 'example-community'

    Enables SNMP on a virtual machine host.

    Example 2

    Get-VMHostSnmp | Set-VMHostSnmp -ReadonlyCommunity @()

    Sets the virtual machine host SNMP by erasing the old value of the ReadOnlyCommunity parameter.

    Related Commands

    Feedback

    Was this page helpful?