Important This version of the product has reached end of support. The documentation is available for your convenience. However, you must be logged in to access it. You will not be able to leave comments.

SNMP Manager Stations API

TrueSight Network Automation REST API – Version 3.0 – SNMP Manager Stations
The base URL for the API is:

https://serverName:portNumber/bca-networks/api

GET

 /v3.0/snmp_manager_stations =====

Click here to expand...
Parameters

Name

Located in

Description

Default

Schema

orderBy

query

Sort by the specified attribute (address, port, trapCommunity, versionName, or a listable SNMP manager station dynamic field name) in the specified order (prefix with a '+' for ascending or a '-' for descending)

"+address"

string 
Enum: [
 "+address",
 "-address",
 "+port",
 "-port",
 "+trapCommunity",
 "-trapCommunity",
 "+versionName",
 "-versionName"
]

offset

query

Return the specified page number

1

integer

limit

query

Define the number of rows in a page or the maximum number of SNMP manager stations to return

25

integer

Authorization

header

Authorization token formatted as 'Bearer [token]'

 

string *

Responses

Code

Description

Schema

200

successful operation

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

 

403

Forbidden: Not allowed to access SNMP manager stations

 

500

Internal server error: Unexpected exception occurred

 

{{status colour="Green" title="POST"/}}

 /v3.0/snmp_manager_stations
Click here to expand...
Parameters

Name

Located in

Description

Default

Schema

body

body

Complete attributes of the new SNMP manager station

 

Authorization

header

Authorization token formatted as 'Bearer [token]'

 

string *

Responses

Code

Description

Schema

201

Created: New SNMP manager station successfully added

 

400

Bad request: Input SNMP manager station DTO is missing or new SNMP manager station is invalid

 

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

 

403

Forbidden: Not allowed to add a new SNMP manager station

 

500

Internal server error: Unexpected exception occurred

 

{{status colour="Blue" title="GET"/}}

 /v3.0/snmp_manager_stations/{addressOrKey}
Click here to expand...
Parameters

Name

Located in

Description

Default

Schema

addressOrKey

path

Address or database key of the SNMP manager station of interest

 

string *

Authorization

header

Authorization token formatted as 'Bearer [token]'

 

string *

Responses

Code

Description

Schema

200

successful operation

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

 

403

Forbidden: Not allowed to access SNMP manager stations

 

404

Not found: No single matching SNMP manager station found

 

500

Internal server error: Unexpected exception occurred

 

{{status colour="Yellow" title="PUT"/}}

 /v3.0/snmp_manager_stations/{addressOrKey}
Click here to expand...
Parameters

Name

Located in

Description

Default

Schema

addressOrKey

path

Address or database key of the SNMP manager station to be modified

 

string *

body

body

Complete new attribute values for the SNMP manager station; anything left out will be considered to be null and will be nulled out in the SNMP manager station

 

Authorization

header

Authorization token formatted as 'Bearer [token]'

 

string *

Responses

Code

Description

Schema

200

successful operation

400

Bad request: Input SNMP manager station DTO is missing or modified SNMP manager station is invalid

 

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

 

403

Forbidden: Not allowed to modify the SNMP manager station

 

404

Not found: No single matching SNMP manager station found

 

500

Internal server error: Unexpected exception occurred

 

{{status colour="Red" title="DELETE"/}}

 /v3.0/snmp_manager_stations/{addressOrKey}
Click here to expand...
Parameters

Name

Located in

Description

Default

Schema

addressOrKey

path

Address or database key of the SNMP manager station to be deleted

 

string *

Authorization

header

Authorization token formatted as 'Bearer [token]'

 

string *

Responses

Code

Description

Schema

200

successful operation

string

400

Bad request: SNMP manager station is currently in use

 

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

 

403

Forbidden: Not allowed to delete the SNMP manager station

 

404

Not found: No single matching SNMP manager station found

 

500

Internal server error: Unexpected exception occurred

 

{{status colour="Yellow" title="PATCH"/}}

 /v3.0/snmp_manager_stations/{addressOrKey}
Click here to expand...
Parameters

Name

Located in

Description

Default

Schema

addressOrKey

path

Address or database key of the SNMP manager station to be modified

 

string *

body

body

New attribute values for the SNMP manager station, in JSON Patch format

 

Authorization

header

Authorization token formatted as 'Bearer [token]'

 

string *

Responses

Code

Description

Schema

200

successful operation

400

Bad request: Input JSON patch information is missing or modified SNMP manager station is invalid

 

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

 

403

Forbidden: Not allowed to modify the SNMP manager station

 

404

Not found: No single matching SNMP manager station found

 

500

Internal server error: Unexpected exception occurred

 

Object Definitions

Object

Schema

DynamicFieldValueDTO

Click here to expand...

{ 
    id: string 
    The database key of the dynamic field whose value this is (read-only) 

     name: string 
    The name of the dynamic field (read-only) 

     values: [ 
      The value(s) for the dynamic field; for a single-value field, only the first entry is relevant; read-only for Auto Derived and Configuration Profiled types 

       string 
    ] 

     dynamicFieldDetailsLink: string 
    Link to get more detailed information about the dynamic field (read-only) 
}

JsonPatch

Click here to expand...

[ 
    A list of JSON Patch operations 

     #JsonPatch.OneOperation 
  ]

JsonPatch.OneOperation

JsonPatch.Pointer

Click here to expand...

string 
  Pointer or path to an element or property

JsonPatch.Add

Click here to expand...

{ 
    op: string * 
   Enum: [
     "add"
   ]
    value: any * 
    path: #JsonPatch.Pointer *
}

JsonPatch.Remove

Click here to expand...

{ 
    op: string * 
   Enum: [
     "remove"
   ]
    path: #JsonPatch.Pointer *
}

JsonPatch.Replace

Click here to expand...

{ 
    op: string * 
   Enum: [
     "replace"
   ]
    value: any * 
    path: #JsonPatch.Pointer *
}

JsonPatch.Move

Click here to expand...

{ 
    op: string * 
   Enum: [
     "move"
   ]
    path: #JsonPatch.Pointer *
    from: #JsonPatch.Pointer *
}

JsonPatch.Copy

Click here to expand...

{ 
    op: string * 
   Enum: [
     "copy"
   ]
    path: #JsonPatch.Pointer *
    from: #JsonPatch.Pointer *
}

JsonPatch.Test

Click here to expand...

{ 
    op: string * 
   Enum: [
     "test"
   ]
    value: any * 
    path: #JsonPatch.Pointer *
}

SnmpManagerStationDTO

Click here to expand...

{ 
    id: string 
    The SNMP manager station's unique database key (read-only) 

     address: string * 
    The unique address of the SNMP manager station 

     port: string * 
    The port number where the SNMP manager station sends traps/notifications 

     trapCommunity: string 
    The community name for traps/notifications sent by this SNMP manager station; required when the version is SNMPv1 or SNMPv2C 

     versionId: integer * 
    The SNMP version 

     versionName: string 
    The meaning of the numeric versionId (read-only) 

     v3AuthenticationAlgorithm: string 
    The authentication algorithm used when connecting to the engine; required when the version is SNMPv3; legal values are NO-AUTH and HMAC-SHA-1 

     v3AuthenticationPassword: string 
    The authentication password; required when the version is SNMPv3 and the authentication algorithm is HMAC-SHA-1 

     v3AuthenticationPasswordEncryptedFlag: boolean 
    Whether or not the authenticationPassword value is encrypted; when false, authenticationPassword is in clear text 

     v3EngineID: string 
    The engine ID in hexadecimal format per RFC 3411 (for example, 0x1234567890ab); required when the version is SNMPv3 

     v3PrivilegedAlgorithmId: integer 
    The privileged algorithm used when connecting to the engine; required when the version is SNMPv3; legal values are NoPriv, AES, AES192, and AES256 

     v3PrivilegedAlgorithmName: string 
    The meaning of the numeric v3PrivilegedAlgorithmId 

     v3PrivilegedPassword: string 
    The SNMPv3 privileged password; required when the version is SNMPv3 and the privileged algorithm is AES* 

     v3PrivilegedPasswordEncryptedFlag: boolean 
    Whether or not the privilegedPassword value is encrypted; when false, privilegedPassword is in clear text 

     v3Username: string 
    The SNMPv3 username; required when the version is SNMPv3 

     dynamicFields: [ 
      The dynamic fields 

       #DynamicFieldValueDTO 
    ] 
}

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*