Create an SNMP Access Profile
post
/api/discovery/Snmp
Creates a new SNMP access profile.
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Nested Schema : schema
Type:
Show Source
object
-
AuthPassword: string
SNMP (v3) User Authentication PasswordExample:
*****
-
AuthProtocol: string
SNMP (v3) Authentication ProtocolExample:
oracle.doceng.json.BetterJsonNull@6c46dc02
-
Community: string
SNMP (v1/2) Community StringExample:
public
-
Description: string
DescriptionExample:
Default Public
-
DeviceZoneID: integer
Device Zone IDExample:
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 PasswordExample:
*****
-
PrivProtocol: string
SNMP (v3) Privacy ProtocolExample:
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 & PrivacyExample:
oracle.doceng.json.BetterJsonNull@5868ea91
-
SNMPPort: integer
SNMP UDP Port (default 161)Example:
161
-
SNMPVersion: integer
SNMP Version Allowed Values: - 1 - 2 - 3Example:
2
-
Username: string
SNMP (v3) UsernameExample:
oracle.doceng.json.BetterJsonNull@31a024ea
Response
Supported Media Types
- application/json
200 Response
Successful operation
Nested Schema : SuccessfulAddOperation
Type:
Show Source
object
-
message: string
The response message.Example:
Added record
-
success: boolean
Whether the operation was a success (true) or a failure (false).Example:
true
Nested Schema : type
Type:
Show Source
object
-
data: array
data
The properties of the new SNMP access profile.
-
total: integer
The total number of results regardless of paging.Example:
1
Nested Schema : discoverySNMPRead
Type:
Show Source
object
-
AuthPassword: string
SNMP (v3) User Authentication PasswordExample:
*****
-
AuthProtocol: string
SNMP (v3) Authentication ProtocolExample:
oracle.doceng.json.BetterJsonNull@6c46dc02
-
Community: string
SNMP (v1/2) Community StringExample:
public
-
Description: string
DescriptionExample:
Default Public
-
DeviceCount: integer
Number of devices that matches the SNMP access profile.Example:
0
-
DeviceSNMPAccessID: integer
Device SNMP Access IDExample:
1
-
DeviceZoneID: integer
Device Zone IDExample:
1
-
DeviceZoneName: string
Device Zone NameExample:
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 PasswordExample:
*****
-
PrivProtocol: string
SNMP (v3) Privacy ProtocolExample:
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 & PrivacyExample:
oracle.doceng.json.BetterJsonNull@5868ea91
-
SNMPPort: integer
SNMP UDP Port (default 161)Example:
161
-
SNMPVersion: integer
SNMP Version Allowed Values: - 1 - 2 - 3Example:
2
-
Username: string
SNMP (v3) UsernameExample:
oracle.doceng.json.BetterJsonNull@31a024ea
Default Response
Failed operation
Root Schema : schema
Type:
Show Source
object
-
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
Nested Schema : errors
Type:
array
The list of errors reported. Validation errors will be keyed by record field.
Show Source
Nested Schema : items
Type:
object