Host Snmp System Reconfigure Snmp Agent

Required privileges: Global.Settings

Request

URI

POST

https://{vcenter-host}/sdk/vim25/{release}/HostSnmpSystem/{moId}/ReconfigureSnmpAgent

COPY

Path Parameters

string

moId

Required

The unique identifier for the managed object to which the method attaches; the serialized managed object reference for a request has the form moType/moId, in this case HostSnmpSystem/{moId}.

string

release

Required

The vSphere release schema. The current specification covers vSphere 8.0.3.0 APIs.

Request Body

ReconfigureSnmpAgentRequestType of type(s) application/json

Required

Show optional properties

{
    "spec": {}
}

{
    "spec": {
        "_typeName": "string",
        "enabled": false,
        "port": 0,
        "readOnlyCommunities": [
            "string"
        ],
        "trapTargets": [
            {
                "_typeName": "string",
                "hostName": "string",
                "port": 0,
                "community": "string"
            }
        ],
        "option": [
            {
                "_typeName": "string",
                "key": "string",
                "value": "string"
            }
        ]
    }
}

HostSnmpConfigSpec

spec

Required

spec

Authentication

This operation uses the following authentication methods.

Session

Responses

204

No Content

Operation doesn't return any data structure

500

Failure

Returns VimFault of type(s) application/json

This response body class contains all of the following: MethodFault

{
    "_typeName": "string",
    "faultCause": "MethodFault Object",
    "faultMessage": [
        {
            "_typeName": "string",
            "key": "string",
            "arg": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "value": {
                        "_typeName": "string"
                    }
                }
            ],
            "message": "string"
        }
    ]
}

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

204 Response Body

Errors

Virtual Infrastructure Operations

GET

Host Snmp System Get Configuration