Jump to

• Request
• Response

Update an SNMP Access Profile

put

/api/discovery/Snmp/{id}

Updates the properties of the SNMP access profile that matches the specified ID.

Request

Path Parameters

• id(required): integer
  The discovery SNMP access profile ID.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AuthPassword: string
  SNMP (v3) User Authentication Password

  Example: *****
• AuthProtocol: string
  SNMP (v3) Authentication Protocol

  Example: oracle.doceng.json.BetterJsonNull@6c46dc02
• Community: string
  SNMP (v1/2) Community String

  Example: public
• Description: string
  Description

  Example: Default Public
• DeviceZoneID: integer
  Device Zone ID

  Example: 1
• EngineID: integer
  Engine ID (default 1)

  Example: oracle.doceng.json.BetterJsonNull@2555a986
• MTU: integer
  MTU (default 1472)

  Example: 1472
• PriorityOrder: integer
  Profile Priority Order (lower goes first)

  Example: 0
• PrivPassword: string
  SNMP (v3) User Privacy Password

  Example: *****
• PrivProtocol: string
  SNMP (v3) Privacy Protocol

  Example: oracle.doceng.json.BetterJsonNull@5cfe28e1
• SecurityLevel: integer
  SNMP (v3) Security Level Allowed Values: - 0 => Not Applicable - 1 => No Authentication & No Privacy - 2 => Authentication & No Privacy - 3 => Authentication & Privacy

  Example: oracle.doceng.json.BetterJsonNull@5868ea91
• SNMPPort: integer
  SNMP UDP Port (default 161)

  Example: 161
• SNMPVersion: integer
  SNMP Version Allowed Values: - 1 - 2 - 3

  Example: 2
• Username: string
  SNMP (v3) Username

  Example: oracle.doceng.json.BetterJsonNull@31a024ea

{
    "type":"object",
    "properties":{
        "Description":{
            "$ref":"#/components/schemas/discoverySNMPRead/properties/Description"
        },
        "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 SuccessfulUpdateOperation
• object type

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

Nested Schema : SuccessfulUpdateOperation

Type: object

Show Source

• message: string
  The response message.

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

  Example: true

{
    "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":"Updated record"
        }
    },
    "type":"object"
}

Nested Schema : type

Type: object

Show Source

• data: array data
  The properties of the updated 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 updated SNMP access profile.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/discoverySNMPRead"
            }
        }
    }
}

Nested Schema : data

Type: array

The properties of the updated SNMP access profile.

Show Source

• Array of: object discoverySNMPRead

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

Nested Schema : discoverySNMPRead

Type: object

Show Source

• AuthPassword: string
  SNMP (v3) User Authentication Password

  Example: *****
• AuthProtocol: string
  SNMP (v3) Authentication Protocol

  Example: oracle.doceng.json.BetterJsonNull@6c46dc02
• Community: string
  SNMP (v1/2) Community String

  Example: public
• Description: string
  Description

  Example: Default Public
• DeviceCount: integer
  Number of devices that matches the SNMP access profile.

  Example: 0
• DeviceSNMPAccessID: integer
  Device SNMP Access ID

  Example: 1
• DeviceZoneID: integer
  Device Zone ID

  Example: 1
• DeviceZoneName: string
  Device Zone Name

  Example: Default First Zone
• EngineID: integer
  Engine ID (default 1)

  Example: oracle.doceng.json.BetterJsonNull@2555a986
• MTU: integer
  MTU (default 1472)

  Example: 1472
• PriorityOrder: integer
  Profile Priority Order (lower goes first)

  Example: 0
• PrivPassword: string
  SNMP (v3) User Privacy Password

  Example: *****
• PrivProtocol: string
  SNMP (v3) Privacy Protocol

  Example: oracle.doceng.json.BetterJsonNull@5cfe28e1
• SecurityLevel: integer
  SNMP (v3) Security Level Allowed Values: - 0 => Not Applicable - 1 => No Authentication & No Privacy - 2 => Authentication & No Privacy - 3 => Authentication & Privacy

  Example: oracle.doceng.json.BetterJsonNull@5868ea91
• SNMPPort: integer
  SNMP UDP Port (default 161)

  Example: 161
• SNMPVersion: integer
  SNMP Version Allowed Values: - 1 - 2 - 3

  Example: 2
• Username: string
  SNMP (v3) Username

  Example: oracle.doceng.json.BetterJsonNull@31a024ea

{
    "type":"object",
    "properties":{
        "Community":{
            "description":"SNMP (v1/2) Community String",
            "type":"string",
            "example":"public"
        },
        "Username":{
            "description":"SNMP (v3) Username",
            "type":"string",
            "example":null,
            "nullable":true
        },
        "SecurityLevel":{
            "description":"SNMP (v3) Security Level\n\nAllowed Values:\n- 0 => Not Applicable\n- 1 => No Authentication & No Privacy\n- 2 => Authentication & No Privacy\n- 3 => Authentication & Privacy",
            "type":"integer",
            "example":null,
            "nullable":true
        },
        "AuthPassword":{
            "description":"SNMP (v3) User Authentication Password",
            "type":"string",
            "example":"*****"
        },
        "AuthProtocol":{
            "description":"SNMP (v3) Authentication Protocol",
            "type":"string",
            "example":null,
            "nullable":true
        },
        "PrivPassword":{
            "description":"SNMP (v3) User Privacy Password",
            "type":"string",
            "example":"*****"
        },
        "PrivProtocol":{
            "description":"SNMP (v3) Privacy Protocol",
            "type":"string",
            "example":null,
            "nullable":true
        },
        "SNMPPort":{
            "description":"SNMP UDP Port (default 161)",
            "type":"integer",
            "example":"161"
        },
        "SNMPVersion":{
            "description":"SNMP Version\n\nAllowed Values:\n- 1\n- 2\n- 3",
            "type":"integer",
            "example":"2"
        },
        "MTU":{
            "description":"MTU (default 1472)",
            "type":"integer",
            "example":"1472"
        },
        "DeviceZoneID":{
            "description":"Device Zone ID",
            "type":"integer",
            "example":"1"
        },
        "DeviceZoneName":{
            "description":"Device Zone Name",
            "type":"string",
            "example":"Default First Zone"
        },
        "DeviceSNMPAccessID":{
            "description":"Device SNMP Access ID",
            "type":"integer",
            "example":"1"
        },
        "Description":{
            "description":"Description",
            "type":"string",
            "example":"Default Public"
        },
        "PriorityOrder":{
            "description":"Profile Priority Order (lower goes first)",
            "type":"integer",
            "example":"0"
        },
        "EngineID":{
            "description":"Engine ID (default 1)",
            "type":"integer",
            "example":null,
            "nullable":true
        },
        "DeviceCount":{
            "description":"Number of devices that matches 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":{
                "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

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

Nested Schema : items

Type: object

Back to Top