mirror of
https://github.com/lopes/netbox-scanner.git
synced 2025-08-31 22:58:21 +02:00
1.3 KiB
1.3 KiB
Prime
This is the Cisco Prime API wrapper. Prime is self-explanatory and it's highly recommended to read it before start using any endpoints. You can access this documentation page at API's root address (see below).
Prerequisites:
- Tested under Prime 3.4 and API v4
- URL for API (usually
https://prime.corp/webacs/api/v4) - Credentials for API access
To start using this wrapper, you must create a user in Prime with NBI permissions, according to the resources you need to access. Read ?id=authentication-doc under Prime's own documentation to learn more about such privileges.
Remember that Prime's resources are case sensitive, so programmers must be aware when requesting something. Then, reading the documentation is pretty important. At this point, this wrapper only accepts reading requests, but it should be improved in the near future.
Basic Usage
>>> from corsair.cisco.prime import Api
>>> prime = Api('https://prime.corp/webacs/api/v4', 'cors', 'Strong_P4$$w0rd!')
>>> prime.op.read('aaa/tacacsPlusServer')
>>> prime.data.read('Devices')
>>> prime.data.read('Devices', full='true')
>>> prime.data.read('AccessPoints', firstResult=350, full='true')