Jump to

• Request
• Response

Create an SNMP Access Profile

post

/api/discovery/Snmp

Creates a new SNMP access profile.
The minimum required properties in the request body are:

• Description
• DeviceZoneID
• MTU
• PriorityOrder
• SNMPPort
• SNMPVersion

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Match All

Show Source

• object schema

{
    "allOf":[
        {
            "$ref":"#/components/schemas/discoverySNMP"
        }
    ],
    "required":[
        "Description",
        "DeviceZoneID",
        "SNMPVersion",
        "MTU",
        "SNMPPort",
        "PriorityOrder"
    ]
}

Nested Schema : schema

Type: object

Show Source

• AuthPassword: string
  The SNMP v3 user authentication password.

  Example: *****
• AuthProtocol: string
  The SNMP v3 authentication protocol.

  Example: oracle.doceng.json.BetterJsonNull@13809363
• Community: string
  The SNMP v1 or v2 community string.

  Example: public
• Description: string
  The SNMP Access Profile description.
  To avoid confusion with numeric IDs, the description value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, 1234, +1234, and -1234 are not valid, but US1234, US+1234 and US_1234 are.

  Example: Default Public
• DeviceZoneID: integer
  The device zone ID.

  Example: 1
• EngineID: integer
  The engine ID. The default is 1.

  Example: oracle.doceng.json.BetterJsonNull@c7cf8c4
• MTU: integer
  The maximum transmission unit (MTU) size. The default value is 1472 bytes.

  Example: 1472
• PriorityOrder: integer
  The profile priority order. A lower value means a higher priority, the lowest value is first in the order.

  Example: 0
• PrivPassword: string
  The SNMP v3 user privacy password.

  Example: *****
• PrivProtocol: string
  The SNMP v3 privacy protocol.

  Example: oracle.doceng.json.BetterJsonNull@12eaa2cd
• SecurityLevel: integer
  The SNMP security level for SNMP v3 authentication. Allowed values are:

  • 0: Not Applicable
  • 1: No Authentication and No Privacy
  • 2: Authentication and No Privacy
  • 3: Authentication and Privacy

  Example: oracle.doceng.json.BetterJsonNull@20f6b6e0
• SNMPPort: integer
  The SNMP UDP port. The default is 161.

  Example: 161
• SNMPVersion: integer
  The SNMP version. Allowed values are:

  • 1
  • 2
  • 3

  Example: 2
• Username: string
  The SNMP v3 user name.

  Example: oracle.doceng.json.BetterJsonNull@3a45308f

{
    "type":"object",
    "properties":{
        "Description":{
            "description":"The SNMP Access Profile description.\n<br>To avoid confusion with numeric IDs, the description value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, <b>1234</b>, <b>+1234</b>, and <b>-1234</b> are not valid, but <b>US1234</b>, <b>US+1234</b> and <b>US_1234</b> are.",
            "type":"string",
            "example":"Default Public"
        },
        "DeviceZoneID":{
            "$ref":"#/components/schemas/discoverySNMPRead/properties/DeviceZoneID"
        },
        "SNMPVersion":{
            "$ref":"#/components/schemas/discoverySNMPRead/properties/SNMPVersion"
        },
        "Community":{
            "$ref":"#/components/schemas/discoverySNMPRead/properties/Community"
        },
        "Username":{
            "$ref":"#/components/schemas/discoverySNMPRead/properties/Username"
        },
        "SecurityLevel":{
            "$ref":"#/components/schemas/discoverySNMPRead/properties/SecurityLevel"
        },
        "AuthPassword":{
            "$ref":"#/components/schemas/discoverySNMPRead/properties/AuthPassword"
        },
        "AuthProtocol":{
            "$ref":"#/components/schemas/discoverySNMPRead/properties/AuthProtocol"
        },
        "PrivPassword":{
            "$ref":"#/components/schemas/discoverySNMPRead/properties/PrivPassword"
        },
        "PrivProtocol":{
            "$ref":"#/components/schemas/discoverySNMPRead/properties/PrivProtocol"
        },
        "MTU":{
            "$ref":"#/components/schemas/discoverySNMPRead/properties/MTU"
        },
        "SNMPPort":{
            "$ref":"#/components/schemas/discoverySNMPRead/properties/SNMPPort"
        },
        "PriorityOrder":{
            "$ref":"#/components/schemas/discoverySNMPRead/properties/PriorityOrder"
        },
        "EngineID":{
            "$ref":"#/components/schemas/discoverySNMPRead/properties/EngineID"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Match All

Show Source

• object SuccessfulAddOperation
  The response body for a successful add operation.
• object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SuccessfulAddOperation"
        },
        {
            "type":"object",
            "properties":{
                "total":{
                    "description":"The total number of results regardless of paging.",
                    "type":"integer",
                    "example":"1"
                },
                "data":{
                    "description":"The properties of the new SNMP access profile.",
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/discoverySNMPRead"
                    }
                }
            }
        }
    ]
}

Nested Schema : SuccessfulAddOperation

Type: object

The response body for a successful add operation.

Show Source

• message: string
  The response message.

  Example: Added record
• success: boolean
  Whether the operation was a success (true) or a failure (false).

  Example: true

{
    "description":"The response body for a successful add operation.",
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"true"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Added record"
        }
    },
    "type":"object"
}

Nested Schema : type

Type: object

Show Source

• data: array data
  The properties of the new SNMP access profile.
• total: integer
  The total number of results regardless of paging.

  Example: 1

{
    "type":"object",
    "properties":{
        "total":{
            "description":"The total number of results regardless of paging.",
            "type":"integer",
            "example":"1"
        },
        "data":{
            "description":"The properties of the new SNMP access profile.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/discoverySNMPRead"
            }
        }
    }
}

Nested Schema : data

Type: array

The properties of the new SNMP access profile.

Show Source

• Array of: object discoverySNMPRead

{
    "description":"The properties of the new SNMP access profile.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/discoverySNMPRead"
    }
}

Nested Schema : discoverySNMPRead

Type: object

Show Source

• AuthPassword: string
  The SNMP v3 user authentication password.

  Example: *****
• AuthProtocol: string
  The SNMP v3 authentication protocol.

  Example: oracle.doceng.json.BetterJsonNull@13809363
• Community: string
  The SNMP v1 or v2 community string.

  Example: public
• Description: string
  The SNMP Access Profile description.

  Example: Default Public
• DeviceCount: integer
  The number of devices that match the SNMP access profile.

  Example: 0
• DeviceSNMPAccessID: integer
  The device SNMP access ID.

  Example: 1
• DeviceZoneID: integer
  The device zone ID.

  Example: 1
• DeviceZoneName: string
  The device zone name.

  Example: Default First Zone
• EngineID: integer
  The engine ID. The default is 1.

  Example: oracle.doceng.json.BetterJsonNull@c7cf8c4
• MTU: integer
  The maximum transmission unit (MTU) size. The default value is 1472 bytes.

  Example: 1472
• PriorityOrder: integer
  The profile priority order. A lower value means a higher priority, the lowest value is first in the order.

  Example: 0
• PrivPassword: string
  The SNMP v3 user privacy password.

  Example: *****
• PrivProtocol: string
  The SNMP v3 privacy protocol.

  Example: oracle.doceng.json.BetterJsonNull@12eaa2cd
• SecurityLevel: integer
  The SNMP security level for SNMP v3 authentication. Allowed values are:

  • 0: Not Applicable
  • 1: No Authentication and No Privacy
  • 2: Authentication and No Privacy
  • 3: Authentication and Privacy

  Example: oracle.doceng.json.BetterJsonNull@20f6b6e0
• SNMPPort: integer
  The SNMP UDP port. The default is 161.

  Example: 161
• SNMPVersion: integer
  The SNMP version. Allowed values are:

  • 1
  • 2
  • 3

  Example: 2
• Username: string
  The SNMP v3 user name.

  Example: oracle.doceng.json.BetterJsonNull@3a45308f

{
    "type":"object",
    "properties":{
        "Community":{
            "description":"The SNMP v1 or v2 community string.",
            "type":"string",
            "example":"public"
        },
        "Username":{
            "description":"The SNMP v3 user name.",
            "type":"string",
            "example":null,
            "nullable":true
        },
        "SecurityLevel":{
            "description":"The SNMP security level for SNMP v3 authentication.\nAllowed values are:\n<ul><li><b>0</b>: Not Applicable</li>\n<li><b>1</b>: No Authentication and No Privacy</li>\n<li><b>2</b>: Authentication and No Privacy</li>\n<li><b>3</b>: Authentication and Privacy</li></ul>",
            "type":"integer",
            "example":null,
            "nullable":true
        },
        "AuthPassword":{
            "description":"The SNMP v3 user authentication password.",
            "type":"string",
            "example":"*****"
        },
        "AuthProtocol":{
            "description":"The SNMP v3 authentication protocol.",
            "type":"string",
            "example":null,
            "nullable":true
        },
        "PrivPassword":{
            "description":"The SNMP v3 user privacy password.",
            "type":"string",
            "example":"*****"
        },
        "PrivProtocol":{
            "description":"The SNMP v3 privacy protocol.",
            "type":"string",
            "example":null,
            "nullable":true
        },
        "SNMPPort":{
            "description":"The SNMP UDP port. The default is 161.",
            "type":"integer",
            "example":"161"
        },
        "SNMPVersion":{
            "description":"The SNMP version.\nAllowed values are:\n<ul><li>1</li>\n<li>2</li>\n<li>3</li></ul>",
            "type":"integer",
            "example":"2"
        },
        "MTU":{
            "description":"The maximum transmission unit (MTU) size. The default value is 1472 bytes.",
            "type":"integer",
            "example":"1472"
        },
        "DeviceZoneID":{
            "description":"The device zone ID.",
            "type":"integer",
            "example":"1"
        },
        "DeviceZoneName":{
            "description":"The device zone name.",
            "type":"string",
            "example":"Default First Zone"
        },
        "DeviceSNMPAccessID":{
            "description":"The device SNMP access ID.",
            "type":"integer",
            "example":"1"
        },
        "Description":{
            "description":"The SNMP Access Profile description.",
            "type":"string",
            "example":"Default Public"
        },
        "PriorityOrder":{
            "description":"The profile priority order. A lower value means a higher priority, the lowest value is first in the order.",
            "type":"integer",
            "example":"0"
        },
        "EngineID":{
            "description":"The engine ID. The default is 1.",
            "type":"integer",
            "example":null,
            "nullable":true
        },
        "DeviceCount":{
            "description":"The number of devices that match the SNMP access profile.",
            "type":"integer",
            "example":"0"
        }
    }
}

Default Response

Failed operation

Body ()

Root Schema : schema

Type: object

Show Source

• errors: array errors
  The list of errors reported. Validation errors will be keyed by record field.
• message: string
  The response message.

  Example: Exception thrown
• success: boolean
  Whether the operation was a success (true) or a failure (false).

  Example: false

{
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"false"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Exception thrown"
        },
        "errors":{
            "description":"The list of errors reported. Validation errors will be keyed by record field.",
            "type":"array",
            "items":{
                "description":"An error.",
                "type":"object"
            }
        }
    },
    "type":"object"
}

Nested Schema : errors

Type: array

The list of errors reported. Validation errors will be keyed by record field.

Show Source

• Array of: object items
  An error.

{
    "description":"The list of errors reported. Validation errors will be keyed by record field.",
    "type":"array",
    "items":{
        "description":"An error.",
        "type":"object"
    }
}

Nested Schema : items

Type: object

An error.

Back to Top