Managed Object - HostSnmpSystem

Property of: HostConfigManager
See also: HostSnmpConfig

Managed Object Description

The SnmpSystem managed object describes the SNMP configuration of the host.

Properties

Name	Type	Description
snmpConfig	HostSnmpConfig	The current SNMP configuration and runtime information.

Methods

Methods defined in this Managed Object
CheckIfMasterSnmpAgentRunning, RestartMasterSnmpAgent, StopMasterSnmpAgent, UpdateSnmpConfig

CheckIfMasterSnmpAgentRunning

Check whether the master SNMP agent is running

Required Privileges: System.Read

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the HostSnmpSystem used to make the method call.

Return Value

Type	Description
xsd:boolean

Faults

Type	Description
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" name="CheckIfMasterSnmpAgentRunning">
            <complexType>
               <sequence>
                  <element name="_this" type="vim2:ManagedObjectReference"/>
               </sequence>
            </complexType>
         </element>
         <element xmlns="http://www.w3.org/2001/XMLSchema" name="CheckIfMasterSnmpAgentRunningResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="xsd:boolean"/>
               </sequence>
            </complexType>
         </element>

RestartMasterSnmpAgent

Restart the master SNMP agent. If the agent is already running, the service is restarted.

Required Privileges: Host.Config.Snmp

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the HostSnmpSystem used to make the method call.

Return Value

Type	Description
None

Faults

Type	Description
HostConfigFault	Thrown for all other failures
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" name="RestartMasterSnmpAgent">
            <complexType>
               <sequence>
                  <element name="_this" type="vim2:ManagedObjectReference"/>
               </sequence>
            </complexType>
         </element>
         <element xmlns="http://www.w3.org/2001/XMLSchema" name="RestartMasterSnmpAgentResponse">
            <complexType/>
         </element>

StopMasterSnmpAgent

Stop the master SNMP agent

Required Privileges: Host.Config.Snmp

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the HostSnmpSystem used to make the method call.

Return Value

Type	Description
None

Faults

Type	Description
HostConfigFault	Thrown for all other failures
InvalidState	Thrown if the service is not running.
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" name="StopMasterSnmpAgent">
            <complexType>
               <sequence>
                  <element name="_this" type="vim2:ManagedObjectReference"/>
               </sequence>
            </complexType>
         </element>
         <element xmlns="http://www.w3.org/2001/XMLSchema" name="StopMasterSnmpAgentResponse">
            <complexType/>
         </element>

UpdateSnmpConfig

Update the SNMP configuration.

Required Privileges: Host.Config.Snmp

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the HostSnmpSystem used to make the method call.
config	HostSnmpConfig

Return Value

Type	Description
None

Faults

Type	Description
HostConfigFault	Thrown for all other failures
InvalidArgument	Thrown if the configuration is invalid
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" name="UpdateSnmpConfig">
            <complexType>
               <sequence>
                  <element name="_this" type="vim2:ManagedObjectReference"/>
                  <element name="config" type="vim2:HostSnmpConfig"/>
               </sequence>
            </complexType>
         </element>
         <element xmlns="http://www.w3.org/2001/XMLSchema" name="UpdateSnmpConfigResponse">
            <complexType/>
         </element>