Skip to main content

Get SNMP Agent on Element (v2.0)



List the configured SNMP agent on an element.


Path Parameters

    tenant_id stringrequired

    ID of the tenant.

    site_id stringrequired

    ID of the site.

    element_id stringrequired

    ID of the element.


Successful Operation

    count int32

    The actual count.

    id string

    The ID.

    tenant_id string

    The tenant ID.

    items SNMPAgent[]
  • Array [
  • description

    The description of the SNMP agent. Max characters = 256.

    id string

    The ID of the SNMP agent.

    tags string[]

    A information field that can be added to identify the SNMP agent configuration.

    v2_config SNMPV2Config

    Indicates if SNMP v2 is enabled.

    community stringrequired

    If V2 is enabled, community is configured. If community is not configured, then public will be set as the default community. White spaces not allowed in community name. Max characters = 32.

    v3_config SNMPV3Config

    Indicates if SNMP v3 is enabled.

    user_access SNMPUserAccessrequired

    The SNMP configuration user access.

    auth_phrase string

    The authentication phrase of 8 to 25 characters if auth type is selected.

    auth_type stringrequired

    Possible values: [NONE, MD5, SHA]

    The authentication type. Auth Type may be MD5, SHA, or None.

    enc_phrase string

    The encryption phrase of 8 to 25 characters if encryption type is selected.

    enc_type stringrequired

    Possible values: [NONE, AES, DES]

    The encrption type.

    engine_id string

    The SNMP configuration supported engine ID. Hexadecimal value should be in pairs (multiple of two) with minimum length 10 and maximum length 256.

    security_level stringrequired

    Possible values: [NOAUTH, AUTH, PRIVATE]

    The security level of the SNMP configuration.

    user_name stringrequired

    The user name to identify the device. User name length should be between 4 and 256.

  • ]