Jump to

• Request
• Response

Get SNMP Profile Results

get

/discovery-service/discovery/request/result/{discovery-context-id}/profile/

Gets the SNMP profile result for the specified discovery context ID. This is a legacy API. It is only available when the ENABLE_LEGACY_API_ENDPOINTS configuration parameter is set to true on the Discovery Service microservice.

Request

Path Parameters

• discovery-context-id(required): string
  The ID for the discovery request.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : DiscoveryContextIDProfiles

Type: object

Additional Properties Allowed

Show Source

• object CustomSNMPAccessProfile
  A custom SNMP access profile.

{
    "type":"object",
    "additionalProperties":{
        "$ref":"#/components/schemas/CustomSNMPAccessProfile"
    },
    "example":{
        "df29b366-c3a4-4a89-8ec8-2f1527276c75":{
            "Version":2,
            "ProfileID":0,
            "UUID":"df29b366-c3a4-4a89-8ec8-2f1527276c75",
            "Priority":1,
            "Port":161,
            "MTU":1456,
            "Auth":{
                "Community":"public",
                "Username":"user",
                "AuthType":"AUTHPRIV",
                "AuthPassphrase":"QXV0aFBhc3N3b3Jk",
                "AuthProtocol":"SHA256",
                "PrivPassphrase":"UHJpdlBhc3N3b3Jk",
                "PrivProtocol":"AES",
                "AuthEngineID":"80001adc802417e202b8613f5400000000"
            }
        },
        "47542a02-6cc6-43f8-b39a-7111136bdcaf":{
            "Version":1,
            "UUID":"47542a02-6cc6-43f8-b39a-7111136bdcaf",
            "Priority":2,
            "Port":161,
            "MTU":1454,
            "Auth":{
                "Community":"public",
                "Username":"user",
                "AuthType":"AUTHPRIV",
                "AuthPassphrase":"QXV0aFBhc3N3b3Jk",
                "AuthProtocol":"SHA256",
                "PrivPassphrase":"UHJpdlBhc3N3b3Jk",
                "PrivProtocol":"AES",
                "AuthEngineID":"80002adc802417e202b8613f5400000000"
            }
        }
    }
}

Example:

{
    "df29b366-c3a4-4a89-8ec8-2f1527276c75":{
        "Version":2,
        "ProfileID":0,
        "UUID":"df29b366-c3a4-4a89-8ec8-2f1527276c75",
        "Priority":1,
        "Port":161,
        "MTU":1456,
        "Auth":{
            "Community":"public",
            "Username":"user",
            "AuthType":"AUTHPRIV",
            "AuthPassphrase":"QXV0aFBhc3N3b3Jk",
            "AuthProtocol":"SHA256",
            "PrivPassphrase":"UHJpdlBhc3N3b3Jk",
            "PrivProtocol":"AES",
            "AuthEngineID":"80001adc802417e202b8613f5400000000"
        }
    },
    "47542a02-6cc6-43f8-b39a-7111136bdcaf":{
        "Version":1,
        "UUID":"47542a02-6cc6-43f8-b39a-7111136bdcaf",
        "Priority":2,
        "Port":161,
        "MTU":1454,
        "Auth":{
            "Community":"public",
            "Username":"user",
            "AuthType":"AUTHPRIV",
            "AuthPassphrase":"QXV0aFBhc3N3b3Jk",
            "AuthProtocol":"SHA256",
            "PrivPassphrase":"UHJpdlBhc3N3b3Jk",
            "PrivProtocol":"AES",
            "AuthEngineID":"80002adc802417e202b8613f5400000000"
        }
    }
}

Nested Schema : CustomSNMPAccessProfile

Type: object

A custom SNMP access profile.

Show Source

• Auth: object CustomSNMPAccessProfileAuth
  Custom SNMP access profile authentication information.
• MTU: integer
  Minimum Value: 484

  Maximum Value: 2147483647

  The MTU for the custom SNMP access profile. The value must be at least 484.

  Example: 1456
• Port: integer
  Minimum Value: 1

  Maximum Value: 65535

  The custom SNMP access profile port.

  Example: 161
• Priority: integer
  Minimum Value: 0

  Maximum Value: 2147483647

  The custom SNMP access profile priority.

  Example: 1
• ProfileID: integer
  Allowed Values: [ 0 ]

  The custom SNMP access profile ID. Custom profiles must use the default value 0.

  Example: 0
• UUID: string (uuid)
  The custom SNMP access profile UUID.

  Example: df29b366-c3a4-4a89-8ec8-2f1527276c75
• Version(required): integer
  Allowed Values: [ 1, 2, 3 ]

  The custom SNMP access profile version.

  Example: 2

{
    "description":"A custom SNMP access profile.",
    "type":"object",
    "required":[
        "Version"
    ],
    "properties":{
        "Version":{
            "description":"The custom SNMP access profile version.",
            "type":"integer",
            "enum":[
                1,
                2,
                3
            ],
            "example":2
        },
        "ProfileID":{
            "description":"The custom SNMP access profile ID. Custom profiles must use the default value <b>0</b>.",
            "type":"integer",
            "enum":[
                0
            ],
            "example":0
        },
        "UUID":{
            "description":"The custom SNMP access profile UUID.",
            "type":"string",
            "format":"uuid",
            "example":"df29b366-c3a4-4a89-8ec8-2f1527276c75"
        },
        "Priority":{
            "description":"The custom SNMP access profile priority.",
            "type":"integer",
            "minimum":0,
            "maximum":2147483647,
            "example":1
        },
        "Port":{
            "description":"The custom SNMP access profile port.",
            "type":"integer",
            "minimum":1,
            "maximum":65535,
            "example":161
        },
        "MTU":{
            "description":"The MTU for the custom SNMP access profile. The value must be at least 484.",
            "type":"integer",
            "minimum":484,
            "maximum":2147483647,
            "example":1456
        },
        "Auth":{
            "$ref":"#/components/schemas/CustomSNMPAccessProfileAuth"
        }
    }
}

Nested Schema : CustomSNMPAccessProfileAuth

Type: object

Custom SNMP access profile authentication information.

Show Source

• AuthEngineID: string
  The custom SNMP access profile authentication engine ID.

  Example: 80001adc802417e202b8613f5400000000
• AuthPassphrase: string
  The custom SNMP access profile authentication passphrase.

  Example: QXV0aFBhc3N3b3Jk
• AuthProtocol: string
  The custom SNMP access profile authentication protocol.

  Example: SHA256
• AuthType: string
  Allowed Values: [ "NOAUTHNOPRIV", "AUTHNOPRIV", "AUTHPRIV" ]

  The custom SNMP access profile authentication type.

  Example: AUTHPRIV
• Community: string
  The custom SNMP access profile community string.

  Example: public
• PrivPassphrase: string
  The custom SNMP access profile private passphrase.

  Example: UHJpdlBhc3N3b3Jk
• PrivProtocol: string
  The custom SNMP access profile private protocol.

  Example: AES
• Username: string
  The custom SNMP access profile user name.

  Example: user

{
    "description":"Custom SNMP access profile authentication information.",
    "type":"object",
    "properties":{
        "Community":{
            "description":"The custom SNMP access profile community string.",
            "type":"string",
            "example":"public"
        },
        "Username":{
            "description":"The custom SNMP access profile user name.",
            "type":"string",
            "example":"user"
        },
        "AuthType":{
            "description":"The custom SNMP access profile authentication type.",
            "type":"string",
            "enum":[
                "NOAUTHNOPRIV",
                "AUTHNOPRIV",
                "AUTHPRIV"
            ],
            "example":"AUTHPRIV"
        },
        "AuthPassphrase":{
            "description":"The custom SNMP access profile authentication passphrase.",
            "type":"string",
            "example":"QXV0aFBhc3N3b3Jk"
        },
        "AuthProtocol":{
            "description":"The custom SNMP access profile authentication protocol.",
            "type":"string",
            "example":"SHA256"
        },
        "PrivPassphrase":{
            "description":"The custom SNMP access profile private passphrase.",
            "type":"string",
            "example":"UHJpdlBhc3N3b3Jk"
        },
        "PrivProtocol":{
            "description":"The custom SNMP access profile private protocol.",
            "type":"string",
            "example":"AES"
        },
        "AuthEngineID":{
            "description":"The custom SNMP access profile authentication engine ID.",
            "type":"string",
            "example":"80001adc802417e202b8613f5400000000"
        }
    }
}

401 Response

Unauthorized operation

500 Response

Internal server error

Back to Top