Overview¶
AICM provides APIs that retrieve metrics from AIC devices, which can be utilized by various management tools or external frameworks to create dashboards for administration.
The objectives of AICM are to:
- Collect Telemetry: Gather telemetry data from AIC Cards and serve it in a user-friendly manner.
- Monitor Health: Monitor card health and perform a series of diagnostic tests to provide reports. (In progress)
- Enforce Policies/Configurations: Apply configurations to AIC cards based on different conditions. (In progress)
AICM files are located in:
User Guide¶
API Documentation¶
You can access the API documentation in several ways:
Swagger UI¶
Swagger UI enables users to visualize and interact with the APIs.
When operational, AICM provides a Swagger UI interface accessible at <IP>:<PORT>/docs.
Redoc¶
You can achieve the same using Redoc.
When operational, AICM provides a Redoc interface accessible at <IP>:<PORT>/redoc.
Please replace <IP>:<PORT> with the actual IP address and port number where AICM is running.