Skip to main content
ZStack
Settings/SNMP Operations

CreateSnmpAgent

CreateSnmpAgent

POST/zstack/v1/snmp/agent

Operation ID

CreateSnmpAgent

Since

4.7.21

Execution Mode

Synchronous

Auth Context

Auth Required

Auth Context

Send these values as request headers when calling this API.

AuthorizationstringRequired

Bearer Token

X-Tenant-IDstring

X-Tenant-ID

Request Inputs

application/json

Body Fields

  • params
    ObjectRequired

    Request body parameter object.

    • version
      StringRequired

      The protocol version.

    • readCommunity
      String

      Optional. The read community (used when for v2c version).

    • userName
      String

      Optional. The user name (used for v3 version).

    • authAlgorithm
      String

      Optional. The authentication algorithm.

    • authPassword
      String

      Optional. The authentication password.

    • privacyAlgorithm
      String

      Optional. The privacy algorithm.

    • privacyPassword
      String

      Optional. The privacy password.

    • port
      intRequired

      The port.

    • resourceUuid
      String

      Optional. The resource UUID.

    • tagUuids
      List

      Optional. The tag UUID.

  • systemTags
    List

    Optional. the system tags.

  • userTags
    List

    Optional. The user tags.

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • success
    booleanRequired

    Whether the operation succeeded.

  • error
    ErrorCodeRequired

    The error code. If not null, the operation fails, or vice versa. For more information, see error.

    • code
      StringRequired

      The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001.

    • description
      StringRequired

      The brief description of the error.

    • details
      StringRequired

      The details about the error.

    • elaboration
      StringRequired

      The reserved field. Default value: null.

    • opaque
      LinkedHashMapRequired

      The reserved field. Default value: null.

    • cause
      ErrorCodeRequired

      The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null.

  • inventory
    SnmpAgentInventoryRequired

    See inventory.

    • uuid
      StringRequired

      The resource UUID.

    • version
      StringRequired

      The protocol version.

    • readCommunity
      StringRequired

      The read community (used for the v2c version).

    • userName
      StringRequired

      The user name (used for the v3 version).

    • authAlgorithm
      StringRequired

      The authentication algorithm.

    • authPassword
      StringRequired

      The authentication password.

    • privacyAlgorithm
      StringRequired

      The privacy algorithm.

    • privacyPassword
      StringRequired

      The privacy password.

    • port
      intRequired

      The port.

    • status
      StringRequired

      The SNMP agent status.

    • securityLevel
      StringRequired

      The security level.

    • createDate
      TimestampRequired

      The creation date.

    • lastOpDate
      TimestampRequired

      The last operation date.