Important

   

Starting from version 8.9.03, BMC Network Automation is renamed to TrueSight Network Automation. This space contains information about TrueSight Network Automation 8.9.03 and the later service packs for 8.9. For earlier releases, see BMC Network Automation 8.9.

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
 Retrieves SNMP manager stations, matching any filter criteria
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

[
   #SnmpManagerStationDTO
]

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

POST /v3.0/snmp_manager_stations
 Adds a new SNMP manager station
Parameters

Name

Located in

Description

Default

Schema

body

body

Complete attributes of the new SNMP manager station

#SnmpManagerStationDTO

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

GET /v3.0/snmp_manager_stations/{addressOrKey}
 Retrieves one SNMP manager station either by address or by database key
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

#SnmpManagerStationDTO

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

PUT /v3.0/snmp_manager_stations/{addressOrKey}
 Modifies all attributes of an existing SNMP manager station
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

#SnmpManagerStationDTO

Authorization

header

Authorization token formatted as 'Bearer [token]'

string *

Responses

Code

Description

Schema

200

successful operation

#SnmpManagerStationDTO

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

DELETE /v3.0/snmp_manager_stations/{addressOrKey}
 Deletes an unreferenced SNMP manager station
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

PATCH /v3.0/snmp_manager_stations/{addressOrKey}
 Modifies only the specified attributes of an existing SNMP manager station, where the changes are specified in JSON Patch format (per RFC 6902)
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

#JsonPatch

Authorization

header

Authorization token formatted as 'Bearer [token]'

string *

Responses

Code

Description

Schema

200

successful operation

#SnmpManagerStationDTO

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

 A dynamic field value

{
     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

 A list of JSON Patch operations

[
     A list of JSON Patch operations
 
     #JsonPatch.OneOperation
   ]

JsonPatch.OneOperation

JsonPatch.Pointer

 Pointer or path to an element or property

string
   Pointer or path to an element or property

JsonPatch.Add

 Add a value to an object or inserts it into an array. In the case of an array, the value is inserted before the given index. The - character can be used instead of an index to insert at the end of an array. The value can be any JSON value.

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

JsonPatch.Remove

 Remove a value from an object or array.

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

JsonPatch.Replace

 Replace an existing value. THe value can be any JSON value.

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

JsonPatch.Move

 Move a value from one location to the other. "path" is the destination.

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

JsonPatch.Copy

 Copy a value from one location to another. "path" is the destination.

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

JsonPatch.Test

 Test that the specified value is set in the document at the specified path. If the test fails, then the patch as a whole is not applied. The Value can be any JSON value.

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

SnmpManagerStationDTO

 Information about an SNMP manager station

{
     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
     ]
}

Was this page helpful? Yes No Submitting... Thank you

Comments