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]
[-Enabled <Boolean>]
[-Port <Int32>]
[-ReadOnlyCommunity <String[]>]
[CommonParameters]
Parameters
| Required | Parameter Name | Type | Position | Features | Description |
|---|---|---|---|---|---|
| required |
|
VmHostSnmp[] | named |
|
Specifies the host Snmp object you want to modify. | optional |
|
Boolean | named |
|
Indicates that the SNMP feature is enabled on the specified host. | optional |
|
Int32 | named |
|
Specifies the port on which the host listens to SNMP messages. | optional |
|
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]
-HostSnmp <VmHostSnmp[]>
-TargetCommunity <String>
-TargetHost <String>
[-Enabled <Boolean>]
[-Port <Int32>]
[-ReadOnlyCommunity <String[]>]
[-TargetPort <Int32>]
[CommonParameters]
Parameters
| Required | Parameter Name | Type | Position | Features | Description |
|---|---|---|---|---|---|
| required |
|
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 |
|
VmHostSnmp[] | named |
|
Specifies the host Snmp object you want to modify. | required |
|
String | named |
|
Specifies the community identifier of the trap target. | required |
|
String | named |
|
Specifies the identifier of the target host - a host name or an IP address. | optional |
|
Boolean | named |
|
Indicates that the SNMP feature is enabled on the specified host. | optional |
|
Int32 | named |
|
Specifies the port on which the host listens to SNMP messages. | optional |
|
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 |
|
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]
-RemoveTarget
[-Enabled <Boolean>]
[-Port <Int32>]
[-ReadOnlyCommunity <String[]>]
[-TargetCommunity <String>]
[-TargetHost <String>]
[-TargetPort <Int32>]
[CommonParameters]
Parameters
| Required | Parameter Name | Type | Position | Features | Description |
|---|---|---|---|---|---|
| required |
|
VmHostSnmp[] | named |
|
Specifies the host Snmp object you want to modify. | required |
|
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. * Use a combination of the TargetCommunity, TargetHost, and TargetPort parameters to specify a criteria (for example, remove all trap targets that are using port 162). | optional |
|
Boolean | named |
|
Indicates that the SNMP feature is enabled on the specified host. | optional |
|
Int32 | named |
|
Specifies the port on which the host listens to SNMP messages. | optional |
|
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 |
|
String | named |
|
Specifies the community identifier of the trap target. | optional |
|
String | named |
|
Specifies the identifier of the target host - a host name or an IP address. | optional |
|
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]
-TrapTargetToRemove <TrapTarget>
[-Enabled <Boolean>]
[-Port <Int32>]
[-ReadOnlyCommunity <String[]>]
[-RemoveTarget]
[CommonParameters]
Parameters
| Required | Parameter Name | Type | Position | Features | Description |
|---|---|---|---|---|---|
| required |
|
VmHostSnmp[] | named |
|
Specifies the host Snmp object you want to modify. | required |
|
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 |
|
Boolean | named |
|
Indicates that the SNMP feature is enabled on the specified host. | optional |
|
Int32 | named |
|
Specifies the port on which the host listens to SNMP messages. | optional |
|
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 |
|
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. * Use a combination of the TargetCommunity, TargetHost, and TargetPort parameters to specify a criteria (for example, remove all trap targets that are using port 162). |
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
VMHost
This cmdlet retrieves the hosts on a vCenter Server system.
This cmdlet adds a host to be managed by a vCenter Server system.
This cmdlet moves hosts to another location.
This cmdlet restarts the specified hosts.
This cmdlet modifies the configuration of the host.
This cmdlet starts the specified hosts.
This cmdlet powers off the specified hosts.
This cmdlet suspends hosts.
This cmdlet removes the specified hosts from the inventory.
VMHostAccount
This cmdlet retrieves the host accounts available on a vCenter Server system.
This cmdlet configures a host account.
This cmdlet removes the specified host accounts.
This cmdlet creates a new host user or group account.
VMHostAdvancedConfiguration
This cmdlet retrieves the advanced configuration of the hosts.
This cmdlet modifies the advanced configuration settings of a host.
VMHostAuthentication
This cmdlet retrieves authentication information for the specified hosts.
This cmdlet modifies the host authentication information.
VMHostAvailableTimeZone
This cmdlet retrieves the time zones available on the specified host.
VMHostDiagnosticPartition
This cmdlet retrieves a list of the diagnostic partitions on the specified hosts.
This cmdlet activates or deactivates the diagnostic partitions of hosts.
VMHostDisk
This cmdlet retrieves information about the specified SCSI LUN disk.
VMHostDiskPartition
This cmdlet retrieves the partitions of a host disk (LUN).
This cmdlet formats a new VMFS (Virtual Machine File System) on each of the specified host disk partitions.
VMHostFirewallDefaultPolicy
This cmdlet retrieves the firewall default policy of the specified hosts.
This cmdlet sets the default policy for the specified host firewall.
VMHostFirewallException
This cmdlet retrieves the exceptions from the firewall policy on the specified hosts.
This cmdlet activates or deactivates host firewall exceptions.
VMHostFirmware
This cmdlet retrieves hosts firmware information.
This cmdlet configures hosts firmware settings.
VMHostHardware
This cmdlet retrieves ESXi host hardware and firmware information.
VMHostHba
This cmdlet retrieves information about the available HBAs (Host Bus Adapter).
This cmdlet configures the CHAP properties of the specified iSCSI HBAs.
VMHostModule
This cmdlet retrieves the option strings of the specified host modules.
This cmdlet overrides the host module options with the given ones.
VMHostNetwork
THis cmdlet retrieves the host networks on a vCenter Server system.
This cmdlet updates the specified virtual network.
VMHostNetworkAdapter
This cmdlet retrieves the host network adapters on a vCenter Server system.
This cmdlet configures the specified host network adapter.
This cmdlet removes the specified host network adapters.
This cmdlet creates a new HostVirtualNIC (Service Console or VMKernel) on the specified host.
VMHostNetworkStack
This cmdlet retrieves the host network stacks on a vCenter Server system.
This cmdlet modifies the specified host network stack.
VMHostNtpServer
This cmdlet retrieves the NTP servers on the specified hosts.
This cmdlet adds the specified NTP servers to the NTP server list of the specified hosts.
This cmdlet removes the specified NTP servers from the NTP server list of the specified hosts.
VMHostPatch
This cmdlet retrieves information about the host patches installed on the specified hosts. This cmdlet is deprecated and will not return any results for ESX hosts version 5.0 and later. Use (Get-ESXCli).software.vib.list() as an alternative.
This cmdlet updates the specified hosts.
VMHostPciDevice
This cmdlet retrieves the PCI devices on the specified hosts.
VMHostProfile
This cmdlet retrieves the available host profiles.
This cmdlet exports the specified host profile to a file.
This cmdlet imports a host profile from a file. The file path must be accessible from the VMware PowerCLI client side.
This cmdlet applies a host profile to the specified host or cluster.
This cmdlet modifies the specified host profile.
This cmdlet removes the specified host profiles.
This cmdlet creates a new host profile based on a reference host.
VMHostProfileCompliance
This cmdlet tests hosts for profile compliance.
VMHostProfileImageCacheConfiguration
Retrieves an image cache configuration for the given host profile.
This cmdlet modifies image cache configuration for given host profile.
VMHostProfileRequiredInput
This cmdlet performs a check whether the available information is sufficient to apply a host profile.
VMHostProfileStorageDeviceConfiguration
Retrieves the storage device configuration for the given host profile.
This cmdlet modifies the storage device configuration for the given host profile.
VMHostProfileUserConfiguration
This cmdlet retrieves the user password configuration for the given host profile.
This cmdlet modifies the user password configuration for the specified account within a host profile.
VMHostProfileVmPortGroupConfiguration
Retrieves the virtual machine port group configuration for the given host profile.
This cmdlet modifies the virtual machine port group configuration for the given host profile.
Removes the given virtual machine port group configuration from the host profile.
This cmdlet creates a new virtual machine port group configuration.
VMHostRoute
This cmdlet retrieves the routes from the routing table of the specified hosts.
This cmdlet modifies a route in the host routing table.
This cmdlet removes host routes.
This cmdlet creates a new route in the routing table of a host.
VMHostService
This cmdlet retrieves information about a host service.
This cmdlet restarts the specified host services.
This cmdlet modifies a host service.
This cmdlet starts the specified host services.
This cmdlet stops the specified host services.
VMHostSnmp
This cmdlet retrieves hosts SNMP configuration.
This cmdlet modifies the host SNMP configuration.
This cmdlet tests the host SNMP.
VMHostStartPolicy
This cmdlet retrieves the start policy of hosts.
This cmdlet modifies the host default start policy.
VMHostStorage
This cmdlet retrieves the host storages on a vCenter Server system.
This cmdlet configures a host storage.
VMHostSysLogServer
This cmdlet displays the remote syslog servers of the specified hosts.
This cmdlet configures the remote syslog server of the specified hosts.
