Equipment service

DCImanager 6

Documentation

DCImanager 6

Developer section

API

Equipment service

Add to Favorites

Documentation

DCImanager 6

Developer section

API

Equipment service

{"openapi":"3.0.0","info":{"title":"Equip service HTTP server","version":"0.1.0"},"paths":{"\/custom_equipment":{"get":{"tags":["Custom equipment"],"summary":"Get Custom Equipment List Handler","description":"Returns list of custom equipments","operationId":"get_custom_equipment_list_handler_custom_equipment_get","responses":{"200":{"description":"Successful Response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/CustomEquipmentListResponse"}}}}}},"post":{"tags":["Custom equipment"],"summary":"Create Custom Equipment","description":"Creates new custom equipment handler","operationId":"create_custom_equipment_custom_equipment_post","requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/CreateCustomEquipment"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application\/json":{"schema":[]}}},"422":{"description":"Validation Error","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/HTTPValidationError"}}}}}}},"\/custom_equipment\/{custom_equipment_identifier}":{"get":{"tags":["Custom equipment"],"summary":"Get Custom Equipment Handler","description":"Returns custom equipment handler info","operationId":"get_custom_equipment_handler_custom_equipment__custom_equipment_identifier__get","parameters":[{"name":"custom_equipment_identifier","in":"path","required":true,"schema":{"anyOf":[{"type":"integer"},{"type":"string"}],"description":"Custom equipment unique identifier or internal handler name","title":"Custom Equipment Identifier"},"description":"Custom equipment unique identifier or internal handler name"}],"responses":{"200":{"description":"Successful Response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/CustomEquipmentResponse"}}}},"422":{"description":"Validation Error","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/HTTPValidationError"}}}}}},"post":{"tags":["Custom equipment"],"summary":"Edit Custom Equipment","description":"Edits custom equipment","operationId":"edit_custom_equipment_custom_equipment__custom_equipment_identifier__post","parameters":[{"name":"custom_equipment_identifier","in":"path","required":true,"schema":{"anyOf":[{"type":"integer"},{"type":"string"}],"description":"Custom equipment unique identifier or internal handler name","title":"Custom Equipment Identifier"},"description":"Custom equipment unique identifier or internal handler name"}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/EditCustomEquipment"}}}},"responses":{"200":{"description":"Successful Response","content":{"application\/json":{"schema":[]}}},"422":{"description":"Validation Error","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/HTTPValidationError"}}}}}},"delete":{"tags":["Custom equipment"],"summary":"Delete Custom Equipment","description":"Deletes custom equipment","operationId":"delete_custom_equipment_custom_equipment__custom_equipment_identifier__delete","parameters":[{"name":"custom_equipment_identifier","in":"path","required":true,"schema":{"anyOf":[{"type":"integer"},{"type":"string"}],"description":"Custom equipment unique identifier or internal handler name","title":"Custom Equipment Identifier"},"description":"Custom equipment unique identifier or internal handler name"}],"responses":{"200":{"description":"Successful Response","content":{"application\/json":{"schema":[]}}},"422":{"description":"Validation Error","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/HTTPValidationError"}}}}}}},"\/custom_equipment\/{custom_equipment_identifier}\/content":{"post":{"tags":["Custom equipment"],"summary":"Set Custom Equipment Content","description":"Sets custom equipment content which is handler archive with python files","operationId":"set_custom_equipment_content_custom_equipment__custom_equipment_identifier__content_post","parameters":[{"name":"custom_equipment_identifier","in":"path","required":true,"schema":{"anyOf":[{"type":"integer"},{"type":"string"}],"description":"Custom equipment unique identifier or internal handler name","title":"Custom Equipment Identifier"},"description":"Custom equipment unique identifier or internal handler name"}],"requestBody":{"required":true,"content":{"multipart\/form-data":{"schema":{"$ref":"#\/components\/schemas\/Body_set_custom_equipment_content_custom_equipment__custom_equipment_identifier__content_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application\/json":{"schema":[]}}},"422":{"description":"Validation Error","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/HTTPValidationError"}}}}}},"get":{"tags":["Custom equipment"],"summary":"Get Custom Equipment Content","description":"Returns custom equipment handler content","operationId":"get_custom_equipment_content_custom_equipment__custom_equipment_identifier__content_get","parameters":[{"name":"custom_equipment_identifier","in":"path","required":true,"schema":{"anyOf":[{"type":"integer"},{"type":"string"}],"description":"Custom equipment unique identifier or internal handler name","title":"Custom Equipment Identifier"},"description":"Custom equipment unique identifier or internal handler name"}],"responses":{"200":{"description":"Successful Response","content":{"application\/json":{"schema":[]}}},"422":{"description":"Validation Error","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/HTTPValidationError"}}}}}}},"\/dashboards":{"get":{"tags":["Grafana dashboard"],"summary":"Get Grafana Dashboards","description":"Returns list of grafana dashboards","operationId":"get_grafana_dashboards_dashboards_get","parameters":[{"name":"internal-auth","in":"header","required":true,"schema":{"type":"string","title":"Internal-Auth"}}],"responses":{"200":{"description":"Successful Response","content":{"application\/json":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/GrafanaDashboardResponse"},"title":"Response Get Grafana Dashboards Dashboards Get"}}}},"422":{"description":"Validation Error","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/HTTPValidationError"}}}}}}},"\/ipmi\/{ipmi_id}\/sensor_value":{"get":{"tags":["BMC"],"summary":"Get Bmc Sensors","description":"Returns BMC sensors","operationId":"get_bmc_sensors_ipmi__ipmi_id__sensor_value_get","parameters":[{"name":"ipmi_id","in":"path","required":true,"schema":{"type":"integer","title":"Ipmi Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/BmcSensorsResponse"}}}},"422":{"description":"Validation Error","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/HTTPValidationError"}}}}}},"post":{"tags":["BMC"],"summary":"Update Bmc Sensors","description":"Creates task to update BMC sensors","operationId":"update_bmc_sensors_ipmi__ipmi_id__sensor_value_post","parameters":[{"name":"ipmi_id","in":"path","required":true,"schema":{"type":"integer","title":"Ipmi Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application\/json":{"schema":[]}}},"422":{"description":"Validation Error","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/HTTPValidationError"}}}}}}},"\/ipmi\/{ipmi_id}\/update_sensor_values":{"post":{"tags":["BMC"],"summary":"Update Bmc Sensor Values","description":"Updates BMC sensors values","operationId":"update_bmc_sensor_values_ipmi__ipmi_id__update_sensor_values_post","parameters":[{"name":"ipmi_id","in":"path","required":true,"schema":{"type":"integer","title":"Ipmi Id"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/BmcSensorsRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application\/json":{"schema":[]}}},"422":{"description":"Validation Error","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/HTTPValidationError"}}}}}}},"\/ipmi\/{ipmi_id}\/log":{"get":{"tags":["BMC"],"summary":"Get Bmc Logs","description":"Returns BMC logs","operationId":"get_bmc_logs_ipmi__ipmi_id__log_get","parameters":[{"name":"ipmi_id","in":"path","required":true,"schema":{"type":"integer","title":"Ipmi Id"}},{"name":"log_format","in":"query","required":false,"schema":{"type":"string","default":"text","title":"Log Format"}}],"responses":{"200":{"description":"Successful Response","content":{"application\/json":{"schema":{"anyOf":[{"$ref":"#\/components\/schemas\/BmcJsonLogResponse"},{"$ref":"#\/components\/schemas\/BmcTextLogResponse"}],"title":"Response Get Bmc Logs Ipmi  Ipmi Id  Log Get"}}}},"422":{"description":"Validation Error","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/HTTPValidationError"}}}}}}},"\/ipmi\/{ipmi_id}\/fru":{"get":{"tags":["BMC"],"summary":"Get Bmc Fru","description":"Returns BMC FRU information","operationId":"get_bmc_fru_ipmi__ipmi_id__fru_get","parameters":[{"name":"ipmi_id","in":"path","required":true,"schema":{"type":"integer","title":"Ipmi Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/BmcFruResponse"}}}},"422":{"description":"Validation Error","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/HTTPValidationError"}}}}}},"post":{"tags":["BMC"],"summary":"Update Bmc Fru","description":"Creates task to update BMC FRU information","operationId":"update_bmc_fru_ipmi__ipmi_id__fru_post","parameters":[{"name":"ipmi_id","in":"path","required":true,"schema":{"type":"integer","title":"Ipmi Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application\/json":{"schema":[]}}},"422":{"description":"Validation Error","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/HTTPValidationError"}}}}}}},"\/ipmi\/fru":{"get":{"tags":["BMC"],"summary":"Get Bmc Fru Chunk","description":"Returns limited number of BMC FRU information chunks","operationId":"get_bmc_fru_chunk_ipmi_fru_get","parameters":[{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/BmcFruListResponse"}}}},"422":{"description":"Validation Error","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/HTTPValidationError"}}}}}}},"\/ipmi\/{ipmi_id}\/info":{"post":{"tags":["BMC"],"summary":"Update Bmc Info","description":"Updates BMC info. Currently, updates only BMC model","operationId":"update_bmc_info_ipmi__ipmi_id__info_post","parameters":[{"name":"ipmi_id","in":"path","required":true,"schema":{"type":"integer","title":"Ipmi Id"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/BmcInfoRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application\/json":{"schema":[]}}},"422":{"description":"Validation Error","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/HTTPValidationError"}}}}}}},"\/ipmi\/model":{"get":{"tags":["BMC"],"summary":"Get Bmc Model","description":"Returns list of BMC models","operationId":"get_bmc_model_ipmi_model_get","responses":{"200":{"description":"Successful Response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/BmcModelsResponse"}}}}}}},"\/ipmi\/{ipmi_id}\/sensor_limits":{"post":{"tags":["BMC"],"summary":"Set Custom Sensor Limits","description":"Sets BMC sensor limits","operationId":"set_custom_sensor_limits_ipmi__ipmi_id__sensor_limits_post","parameters":[{"name":"ipmi_id","in":"path","required":true,"schema":{"type":"integer","title":"Ipmi Id"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/BmcSensorLimitRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application\/json":{"schema":[]}}},"422":{"description":"Validation Error","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/HTTPValidationError"}}}}}}},"\/ipmi\/sensor_limits":{"get":{"tags":["BMC"],"summary":"Get Custom Sensor Limits","description":"Gets BMC sensor limits","operationId":"get_custom_sensor_limits_ipmi_sensor_limits_get","responses":{"200":{"description":"Successful Response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/BmcSensorLimitResponse"}}}}}}},"\/ipmi\/{ipmi_id}\/sensor_limits\/{sensor_name}":{"delete":{"tags":["BMC"],"summary":"Delete Custom Sensor Limits","description":"Deletes custom BMC sensor limits","operationId":"delete_custom_sensor_limits_ipmi__ipmi_id__sensor_limits__sensor_name__delete","parameters":[{"name":"ipmi_id","in":"path","required":true,"schema":{"type":"integer","title":"Ipmi Id"}},{"name":"sensor_name","in":"path","required":true,"schema":{"type":"string","title":"Sensor Name"}}],"responses":{"200":{"description":"Successful Response","content":{"application\/json":{"schema":[]}}},"422":{"description":"Validation Error","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/HTTPValidationError"}}}}}}},"\/instance\/{instance_id}\/pdu\/{pdu_id}\/phase\/{phase_id}\/raw_statistic":{"get":{"tags":["PDU"],"summary":"Get Pdu Raw Statistic","description":"Returns PDU raw statistic","operationId":"get_pdu_raw_statistic_instance__instance_id__pdu__pdu_id__phase__phase_id__raw_statistic_get","parameters":[{"name":"pdu_id","in":"path","required":true,"schema":{"type":"integer","title":"Pdu Id"}},{"name":"phase_id","in":"path","required":true,"schema":{"type":"string","title":"Phase Id"}},{"name":"from","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"From"}},{"name":"to","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"To"}},{"name":"metric_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":"all","title":"Metric Type"}}],"responses":{"200":{"description":"Successful Response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/PduRawStatisticResponse"}}}},"422":{"description":"Validation Error","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/HTTPValidationError"}}}}}}},"\/instance\/{instance_id}\/pdu\/{pdu_id}\/raw_statistic":{"get":{"tags":["PDU"],"summary":"Get Pdu Raw Statistic","description":"Returns PDU raw statistic","operationId":"get_pdu_raw_statistic_instance__instance_id__pdu__pdu_id__raw_statistic_get","parameters":[{"name":"pdu_id","in":"path","required":true,"schema":{"type":"integer","title":"Pdu Id"}},{"name":"phase_id","in":"query","required":false,"schema":{"type":"string","default":"*","title":"Phase Id"}},{"name":"from","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"From"}},{"name":"to","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"To"}},{"name":"metric_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":"all","title":"Metric Type"}}],"responses":{"200":{"description":"Successful Response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/PduRawStatisticResponse"}}}},"422":{"description":"Validation Error","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/HTTPValidationError"}}}}}}},"\/pdu\/{pdu_id}\/phase\/{phase_id}\/raw_statistic":{"get":{"tags":["PDU"],"summary":"Get Pdu Raw Statistic","description":"Returns PDU raw statistic","operationId":"get_pdu_raw_statistic_pdu__pdu_id__phase__phase_id__raw_statistic_get","parameters":[{"name":"pdu_id","in":"path","required":true,"schema":{"type":"integer","title":"Pdu Id"}},{"name":"phase_id","in":"path","required":true,"schema":{"type":"string","title":"Phase Id"}},{"name":"from","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"From"}},{"name":"to","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"To"}},{"name":"metric_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":"all","title":"Metric Type"}}],"responses":{"200":{"description":"Successful Response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/PduRawStatisticResponse"}}}},"422":{"description":"Validation Error","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/HTTPValidationError"}}}}}}},"\/pdu\/{pdu_id}\/raw_statistic":{"get":{"tags":["PDU"],"summary":"Get Pdu Raw Statistic","description":"Returns PDU raw statistic","operationId":"get_pdu_raw_statistic_pdu__pdu_id__raw_statistic_get","parameters":[{"name":"pdu_id","in":"path","required":true,"schema":{"type":"integer","title":"Pdu Id"}},{"name":"phase_id","in":"query","required":false,"schema":{"type":"string","default":"*","title":"Phase Id"}},{"name":"from","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"From"}},{"name":"to","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"To"}},{"name":"metric_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":"all","title":"Metric Type"}}],"responses":{"200":{"description":"Successful Response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/PduRawStatisticResponse"}}}},"422":{"description":"Validation Error","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/HTTPValidationError"}}}}}}},"\/instance\/{instance_id}\/server\/{server_id}\/netflow_statistic":{"get":{"tags":["Server netflow statistic"],"summary":"Get Server Netflow Statistic","description":"Returns server's netflow statistic","operationId":"get_server_netflow_statistic_instance__instance_id__server__server_id__netflow_statistic_get","parameters":[{"name":"server_id","in":"path","required":true,"schema":{"type":"integer","title":"Server Id"}},{"name":"from","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"From"}},{"name":"to","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"To"}},{"name":"ip_address","in":"query","required":false,"schema":{"type":"string","default":"all","title":"Ip Address"}},{"name":"x-forwarded-for","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Forwarded-For"}},{"name":"internal-auth","in":"header","required":true,"schema":{"type":"string","title":"Internal-Auth"}}],"responses":{"200":{"description":"Successful Response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ServerNetflowStatisticResponse"}}}},"422":{"description":"Validation Error","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/HTTPValidationError"}}}}}}},"\/server\/{server_id}\/netflow_statistic":{"get":{"tags":["Server netflow statistic"],"summary":"Get Server Netflow Statistic","description":"Returns server's netflow statistic","operationId":"get_server_netflow_statistic_server__server_id__netflow_statistic_get","parameters":[{"name":"server_id","in":"path","required":true,"schema":{"type":"integer","title":"Server Id"}},{"name":"from","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"From"}},{"name":"to","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"To"}},{"name":"ip_address","in":"query","required":false,"schema":{"type":"string","default":"all","title":"Ip Address"}},{"name":"x-forwarded-for","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Forwarded-For"}},{"name":"internal-auth","in":"header","required":true,"schema":{"type":"string","title":"Internal-Auth"}}],"responses":{"200":{"description":"Successful Response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ServerNetflowStatisticResponse"}}}},"422":{"description":"Validation Error","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/HTTPValidationError"}}}}}}},"\/instance\/{instance_id}\/server\/{server_id}\/ip\/{ip_address}\/raw_netflow_statistic":{"get":{"tags":["Server netflow statistic"],"summary":"Get Server Raw Netflow Statistic","description":"Returns server's netflow raw statistic","operationId":"get_server_raw_netflow_statistic_instance__instance_id__server__server_id__ip__ip_address__raw_netflow_statistic_get","parameters":[{"name":"server_id","in":"path","required":true,"schema":{"type":"integer","title":"Server Id"}},{"name":"ip_address","in":"path","required":true,"schema":{"type":"string","title":"Ip Address"}},{"name":"from","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"From"}},{"name":"to","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"To"}},{"name":"metric_type","in":"query","required":false,"schema":{"allOf":[{"$ref":"#\/components\/schemas\/handlers__server_netflow_statistic_handler__MetricType"}],"default":"all","title":"Metric Type"}},{"name":"x-forwarded-for","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Forwarded-For"}},{"name":"internal-auth","in":"header","required":true,"schema":{"type":"string","title":"Internal-Auth"}}],"responses":{"200":{"description":"Successful Response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ServerNetflowRawStatisticResponse"}}}},"422":{"description":"Validation Error","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/HTTPValidationError"}}}}}}},"\/instance\/{instance_id}\/server\/{server_id}\/raw_netflow_statistic":{"get":{"tags":["Server netflow statistic"],"summary":"Get Server Raw Netflow Statistic","description":"Returns server's netflow raw statistic","operationId":"get_server_raw_netflow_statistic_instance__instance_id__server__server_id__raw_netflow_statistic_get","parameters":[{"name":"server_id","in":"path","required":true,"schema":{"type":"integer","title":"Server Id"}},{"name":"ip_address","in":"query","required":false,"schema":{"type":"string","default":"all","title":"Ip Address"}},{"name":"from","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"From"}},{"name":"to","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"To"}},{"name":"metric_type","in":"query","required":false,"schema":{"allOf":[{"$ref":"#\/components\/schemas\/handlers__server_netflow_statistic_handler__MetricType"}],"default":"all","title":"Metric Type"}},{"name":"x-forwarded-for","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Forwarded-For"}},{"name":"internal-auth","in":"header","required":true,"schema":{"type":"string","title":"Internal-Auth"}}],"responses":{"200":{"description":"Successful Response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ServerNetflowRawStatisticResponse"}}}},"422":{"description":"Validation Error","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/HTTPValidationError"}}}}}}},"\/server\/{server_id}\/ip\/{ip_address}\/raw_netflow_statistic":{"get":{"tags":["Server netflow statistic"],"summary":"Get Server Raw Netflow Statistic","description":"Returns server's netflow raw statistic","operationId":"get_server_raw_netflow_statistic_server__server_id__ip__ip_address__raw_netflow_statistic_get","parameters":[{"name":"server_id","in":"path","required":true,"schema":{"type":"integer","title":"Server Id"}},{"name":"ip_address","in":"path","required":true,"schema":{"type":"string","title":"Ip Address"}},{"name":"from","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"From"}},{"name":"to","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"To"}},{"name":"metric_type","in":"query","required":false,"schema":{"allOf":[{"$ref":"#\/components\/schemas\/handlers__server_netflow_statistic_handler__MetricType"}],"default":"all","title":"Metric Type"}},{"name":"x-forwarded-for","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Forwarded-For"}},{"name":"internal-auth","in":"header","required":true,"schema":{"type":"string","title":"Internal-Auth"}}],"responses":{"200":{"description":"Successful Response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ServerNetflowRawStatisticResponse"}}}},"422":{"description":"Validation Error","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/HTTPValidationError"}}}}}}},"\/server\/{server_id}\/raw_netflow_statistic":{"get":{"tags":["Server netflow statistic"],"summary":"Get Server Raw Netflow Statistic","description":"Returns server's netflow raw statistic","operationId":"get_server_raw_netflow_statistic_server__server_id__raw_netflow_statistic_get","parameters":[{"name":"server_id","in":"path","required":true,"schema":{"type":"integer","title":"Server Id"}},{"name":"ip_address","in":"query","required":false,"schema":{"type":"string","default":"all","title":"Ip Address"}},{"name":"from","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"From"}},{"name":"to","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"To"}},{"name":"metric_type","in":"query","required":false,"schema":{"allOf":[{"$ref":"#\/components\/schemas\/handlers__server_netflow_statistic_handler__MetricType"}],"default":"all","title":"Metric Type"}},{"name":"x-forwarded-for","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Forwarded-For"}},{"name":"internal-auth","in":"header","required":true,"schema":{"type":"string","title":"Internal-Auth"}}],"responses":{"200":{"description":"Successful Response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ServerNetflowRawStatisticResponse"}}}},"422":{"description":"Validation Error","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/HTTPValidationError"}}}}}}},"\/instance\/{instance_id}\/server\/{server_id}\/port\/{port_id}\/statistic":{"get":{"tags":["Server statistic"],"summary":"Get Server Statistic","description":"Returns server's statistic","operationId":"get_server_statistic_instance__instance_id__server__server_id__port__port_id__statistic_get","parameters":[{"name":"server_id","in":"path","required":true,"schema":{"type":"integer","title":"Server Id"}},{"name":"port_id","in":"path","required":true,"schema":{"type":"string","title":"Port Id"}},{"name":"pdu_port_id","in":"query","required":false,"schema":{"type":"string","default":"*","title":"Pdu Port Id"}},{"name":"from","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"From"}},{"name":"to","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"To"}},{"name":"x-forwarded-for","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Forwarded-For"}},{"name":"internal-auth","in":"header","required":true,"schema":{"type":"string","title":"Internal-Auth"}}],"responses":{"200":{"description":"Successful Response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ServerStatisticResponse"}}}},"422":{"description":"Validation Error","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/HTTPValidationError"}}}}}}},"\/instance\/{instance_id}\/server\/{server_id}\/statistic":{"get":{"tags":["Server statistic"],"summary":"Get Server Statistic","description":"Returns server's statistic","operationId":"get_server_statistic_instance__instance_id__server__server_id__statistic_get","parameters":[{"name":"server_id","in":"path","required":true,"schema":{"type":"integer","title":"Server Id"}},{"name":"port_id","in":"query","required":false,"schema":{"type":"string","default":"*","title":"Port Id"}},{"name":"pdu_port_id","in":"query","required":false,"schema":{"type":"string","default":"*","title":"Pdu Port Id"}},{"name":"from","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"From"}},{"name":"to","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"To"}},{"name":"x-forwarded-for","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Forwarded-For"}},{"name":"internal-auth","in":"header","required":true,"schema":{"type":"string","title":"Internal-Auth"}}],"responses":{"200":{"description":"Successful Response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ServerStatisticResponse"}}}},"422":{"description":"Validation Error","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/HTTPValidationError"}}}}}}},"\/server\/{server_id}\/port\/{port_id}\/statistic":{"get":{"tags":["Server statistic"],"summary":"Get Server Statistic","description":"Returns server's statistic","operationId":"get_server_statistic_server__server_id__port__port_id__statistic_get","parameters":[{"name":"server_id","in":"path","required":true,"schema":{"type":"integer","title":"Server Id"}},{"name":"port_id","in":"path","required":true,"schema":{"type":"string","title":"Port Id"}},{"name":"pdu_port_id","in":"query","required":false,"schema":{"type":"string","default":"*","title":"Pdu Port Id"}},{"name":"from","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"From"}},{"name":"to","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"To"}},{"name":"x-forwarded-for","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Forwarded-For"}},{"name":"internal-auth","in":"header","required":true,"schema":{"type":"string","title":"Internal-Auth"}}],"responses":{"200":{"description":"Successful Response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ServerStatisticResponse"}}}},"422":{"description":"Validation Error","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/HTTPValidationError"}}}}}}},"\/server\/{server_id}\/statistic":{"get":{"tags":["Server statistic"],"summary":"Get Server Statistic","description":"Returns server's statistic","operationId":"get_server_statistic_server__server_id__statistic_get","parameters":[{"name":"server_id","in":"path","required":true,"schema":{"type":"integer","title":"Server Id"}},{"name":"port_id","in":"query","required":false,"schema":{"type":"string","default":"*","title":"Port Id"}},{"name":"pdu_port_id","in":"query","required":false,"schema":{"type":"string","default":"*","title":"Pdu Port Id"}},{"name":"from","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"From"}},{"name":"to","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"To"}},{"name":"x-forwarded-for","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Forwarded-For"}},{"name":"internal-auth","in":"header","required":true,"schema":{"type":"string","title":"Internal-Auth"}}],"responses":{"200":{"description":"Successful Response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ServerStatisticResponse"}}}},"422":{"description":"Validation Error","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/HTTPValidationError"}}}}}}},"\/instance\/{instance_id}\/server\/{server_id}\/port\/{port_id}\/raw_statistic":{"get":{"tags":["Server statistic"],"summary":"Get Server Raw Statistic","description":"Returns server's raw statistic","operationId":"get_server_raw_statistic_instance__instance_id__server__server_id__port__port_id__raw_statistic_get","parameters":[{"name":"server_id","in":"path","required":true,"schema":{"type":"integer","title":"Server Id"}},{"name":"port_id","in":"path","required":true,"schema":{"type":"string","title":"Port Id"}},{"name":"from","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"From"}},{"name":"to","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"To"}},{"name":"metric_type","in":"query","required":false,"schema":{"allOf":[{"$ref":"#\/components\/schemas\/handlers__server_statistic_handler__MetricType"}],"default":"all","title":"Metric Type"}},{"name":"x-forwarded-for","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Forwarded-For"}},{"name":"internal-auth","in":"header","required":true,"schema":{"type":"string","title":"Internal-Auth"}}],"responses":{"200":{"description":"Successful Response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ServerRawStatisticResponse"}}}},"422":{"description":"Validation Error","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/HTTPValidationError"}}}}}}},"\/instance\/{instance_id}\/server\/{server_id}\/raw_statistic":{"get":{"tags":["Server statistic"],"summary":"Get Server Raw Statistic","description":"Returns server's raw statistic","operationId":"get_server_raw_statistic_instance__instance_id__server__server_id__raw_statistic_get","parameters":[{"name":"server_id","in":"path","required":true,"schema":{"type":"integer","title":"Server Id"}},{"name":"port_id","in":"query","required":false,"schema":{"type":"string","default":"*","title":"Port Id"}},{"name":"from","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"From"}},{"name":"to","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"To"}},{"name":"metric_type","in":"query","required":false,"schema":{"allOf":[{"$ref":"#\/components\/schemas\/handlers__server_statistic_handler__MetricType"}],"default":"all","title":"Metric Type"}},{"name":"x-forwarded-for","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Forwarded-For"}},{"name":"internal-auth","in":"header","required":true,"schema":{"type":"string","title":"Internal-Auth"}}],"responses":{"200":{"description":"Successful Response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ServerRawStatisticResponse"}}}},"422":{"description":"Validation Error","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/HTTPValidationError"}}}}}}},"\/server\/{server_id}\/port\/{port_id}\/raw_statistic":{"get":{"tags":["Server statistic"],"summary":"Get Server Raw Statistic","description":"Returns server's raw statistic","operationId":"get_server_raw_statistic_server__server_id__port__port_id__raw_statistic_get","parameters":[{"name":"server_id","in":"path","required":true,"schema":{"type":"integer","title":"Server Id"}},{"name":"port_id","in":"path","required":true,"schema":{"type":"string","title":"Port Id"}},{"name":"from","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"From"}},{"name":"to","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"To"}},{"name":"metric_type","in":"query","required":false,"schema":{"allOf":[{"$ref":"#\/components\/schemas\/handlers__server_statistic_handler__MetricType"}],"default":"all","title":"Metric Type"}},{"name":"x-forwarded-for","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Forwarded-For"}},{"name":"internal-auth","in":"header","required":true,"schema":{"type":"string","title":"Internal-Auth"}}],"responses":{"200":{"description":"Successful Response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ServerRawStatisticResponse"}}}},"422":{"description":"Validation Error","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/HTTPValidationError"}}}}}}},"\/server\/{server_id}\/raw_statistic":{"get":{"tags":["Server statistic"],"summary":"Get Server Raw Statistic","description":"Returns server's raw statistic","operationId":"get_server_raw_statistic_server__server_id__raw_statistic_get","parameters":[{"name":"server_id","in":"path","required":true,"schema":{"type":"integer","title":"Server Id"}},{"name":"port_id","in":"query","required":false,"schema":{"type":"string","default":"*","title":"Port Id"}},{"name":"from","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"From"}},{"name":"to","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"To"}},{"name":"metric_type","in":"query","required":false,"schema":{"allOf":[{"$ref":"#\/components\/schemas\/handlers__server_statistic_handler__MetricType"}],"default":"all","title":"Metric Type"}},{"name":"x-forwarded-for","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Forwarded-For"}},{"name":"internal-auth","in":"header","required":true,"schema":{"type":"string","title":"Internal-Auth"}}],"responses":{"200":{"description":"Successful Response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ServerRawStatisticResponse"}}}},"422":{"description":"Validation Error","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/HTTPValidationError"}}}}}}},"\/supported_pdu":{"get":{"tags":["Supported equipment"],"summary":"Get Supported Pdu","description":"Returns supported PDU handlers","operationId":"get_supported_pdu_supported_pdu_get","responses":{"200":{"description":"Successful Response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/SupportedEquipmentResponse"}}}}}}},"\/supported_switch":{"get":{"tags":["Supported equipment"],"summary":"Get Supported Switch","description":"Returns supported switch handlers","operationId":"get_supported_switch_supported_switch_get","responses":{"200":{"description":"Successful Response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/SupportedEquipmentResponse"}}}}}}},"\/supported_vpu":{"get":{"tags":["Supported equipment"],"summary":"Get Supported Vpu","description":"Returns supported VPU handlers","operationId":"get_supported_vpu_supported_vpu_get","responses":{"200":{"description":"Successful Response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/SupportedEquipmentResponse"}}}}}}},"\/supported_ups":{"get":{"tags":["Supported equipment"],"summary":"Get Supported Ups","description":"Returns supported UPS handlers","operationId":"get_supported_ups_supported_ups_get","responses":{"200":{"description":"Successful Response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/SupportedEquipmentResponse"}}}}}}},"\/supported_ipmi":{"get":{"tags":["Supported equipment"],"summary":"Get Supported Ipmi","description":"Returns supported BMC handlers","operationId":"get_supported_ipmi_supported_ipmi_get","responses":{"200":{"description":"Successful Response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/SupportedEquipmentResponse"}}}}}}},"\/supported_dss":{"get":{"tags":["Supported equipment"],"summary":"Get Supported Dss","description":"Returns supported DSS handlers","operationId":"get_supported_dss_supported_dss_get","responses":{"200":{"description":"Successful Response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/SupportedEquipmentResponse"}}}}}}},"\/switch\/{switch_id}\/port\/{port_id}\/statistic":{"get":{"tags":["Switch statistic"],"summary":"Get Switch Statistic","description":"Returns switch statistic","operationId":"get_switch_statistic_switch__switch_id__port__port_id__statistic_get","parameters":[{"name":"switch_id","in":"path","required":true,"schema":{"type":"integer","title":"Switch Id"}},{"name":"port_id","in":"path","required":true,"schema":{"type":"string","title":"Port Id"}},{"name":"location_id","in":"query","required":false,"schema":{"type":"string","default":"*","title":"Location Id"}},{"name":"rack_id","in":"query","required":false,"schema":{"type":"string","default":"*","title":"Rack Id"}},{"name":"from","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"From"}},{"name":"to","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"To"}}],"responses":{"200":{"description":"Successful Response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/SwitchStatisticResponse"}}}},"422":{"description":"Validation Error","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/HTTPValidationError"}}}}}}},"\/switch\/{switch_id}\/statistic":{"get":{"tags":["Switch statistic"],"summary":"Get Switch Statistic","description":"Returns switch statistic","operationId":"get_switch_statistic_switch__switch_id__statistic_get","parameters":[{"name":"switch_id","in":"path","required":true,"schema":{"type":"integer","title":"Switch Id"}},{"name":"port_id","in":"query","required":false,"schema":{"type":"string","default":"*","title":"Port Id"}},{"name":"location_id","in":"query","required":false,"schema":{"type":"string","default":"*","title":"Location Id"}},{"name":"rack_id","in":"query","required":false,"schema":{"type":"string","default":"*","title":"Rack Id"}},{"name":"from","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"From"}},{"name":"to","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"To"}}],"responses":{"200":{"description":"Successful Response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/SwitchStatisticResponse"}}}},"422":{"description":"Validation Error","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/HTTPValidationError"}}}}}}},"\/instance\/{instance_id}\/ups\/{ups_id}\/raw_statistic":{"get":{"tags":["UPS statistic"],"summary":"Get Ups Raw Statistic","description":"Returns UPS raw statistic","operationId":"get_ups_raw_statistic_instance__instance_id__ups__ups_id__raw_statistic_get","parameters":[{"name":"ups_id","in":"path","required":true,"schema":{"type":"integer","title":"Ups Id"}},{"name":"metric_type","in":"query","required":false,"schema":{"type":"string","default":"all","title":"Metric Type"}},{"name":"from","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"From"}},{"name":"to","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"To"}}],"responses":{"200":{"description":"Successful Response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/UpsRawStatisticResponse"}}}},"422":{"description":"Validation Error","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/HTTPValidationError"}}}}}}},"\/ups\/{ups_id}\/raw_statistic":{"get":{"tags":["UPS statistic"],"summary":"Get Ups Raw Statistic","description":"Returns UPS raw statistic","operationId":"get_ups_raw_statistic_ups__ups_id__raw_statistic_get","parameters":[{"name":"ups_id","in":"path","required":true,"schema":{"type":"integer","title":"Ups Id"}},{"name":"metric_type","in":"query","required":false,"schema":{"type":"string","default":"all","title":"Metric Type"}},{"name":"from","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"From"}},{"name":"to","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"To"}}],"responses":{"200":{"description":"Successful Response","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/UpsRawStatisticResponse"}}}},"422":{"description":"Validation Error","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/HTTPValidationError"}}}}}}}},"components":{"schemas":{"BmcFruListResponse":{"properties":{"list":{"items":{"$ref":"#\/components\/schemas\/BmcFruResponse"},"type":"array","title":"List"},"size":{"type":"integer","title":"Size","description":"Size of list","default":0,"examples":[4]}},"type":"object","required":["list","size"],"title":"BmcFruListResponse","description":"Model of BMC FRU list"},"BmcFruResponse":{"properties":{"ipmi_id":{"type":"integer","title":"Ipmi Id","description":"BMC ID","examples":[1]},"update_time":{"type":"string","format":"date-time","title":"Update Time","description":"BMC FRU information update time","examples":["2024-12-31T23:59:59"]},"status":{"allOf":[{"$ref":"#\/components\/schemas\/FruStatus"}],"description":"BMC FRU update status","examples":["ok"]},"status_info":{"anyOf":[{"type":"object"},{"type":"null"}],"title":"Status Info","description":"BMC FRU update additional information"},"board":{"type":"object","title":"Board","description":"Server board information"},"chassis":{"type":"object","title":"Chassis","description":"Server chassis information"},"device":{"type":"object","title":"Device","description":"Server device information"},"firmware":{"type":"object","title":"Firmware","description":"Server firmware information"},"product":{"type":"object","title":"Product","description":"Server product information"}},"type":"object","required":["ipmi_id","update_time","status","status_info","board","chassis","device","firmware","product"],"title":"BmcFruResponse","description":"Model of BMC FRU information"},"BmcInfoRequest":{"properties":{"model":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Model","description":"BMC model"}},"type":"object","required":["model"],"title":"BmcInfoRequest","description":"Model of BMC general information"},"BmcJsonLogResponse":{"anyOf":[{"type":"object"},{"type":"null"}],"title":"BmcJsonLogResponse","description":"Model of equipment handlers list"},"BmcModelsResponse":{"properties":{"list":{"items":{"type":"string"},"type":"array","title":"List","description":"List of all BMC's models"}},"type":"object","required":["list"],"title":"BmcModelsResponse","description":"Model of BMC models list"},"BmcSensorLimitRequest":{"properties":{"name":{"type":"string","title":"Name","description":"Sensor name"},"lower_threshold":{"type":"string","title":"Lower Threshold","description":"Lower sensor threshold"},"higher_threshold":{"type":"string","title":"Higher Threshold","description":"Higher sensor threshold"}},"type":"object","required":["name","lower_threshold","higher_threshold"],"title":"BmcSensorLimitRequest","description":"Model to set BMC sensor limits"},"BmcSensorLimitResponse":{"properties":{"sensors_info":{"additionalProperties":{"type":"object"},"type":"object","title":"Sensors Info"}},"type":"object","required":["sensors_info"],"title":"BmcSensorLimitResponse","description":"Model to get custom BMC sensor limits"},"BmcSensorsRequest":{"properties":{"sensors_info":{"type":"object","title":"Sensors Info","description":"BMC sensors"}},"type":"object","required":["sensors_info"],"title":"BmcSensorsRequest","description":"Model to edit BMC sensors"},"BmcSensorsResponse":{"properties":{"ipmi_id":{"type":"integer","title":"Ipmi Id","description":"BMC ID","examples":[1]},"update_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Update Time","description":"BMC sensors update time","examples":["2024-12-31T23:59:59"]},"sensors_info":{"type":"object","title":"Sensors Info","description":"BMC sensors"}},"type":"object","required":["ipmi_id","update_time","sensors_info"],"title":"BmcSensorsResponse","description":"Model of BMC sensors"},"BmcTextLogResponse":{"properties":{"log":{"anyOf":[{"type":"string"},{"type":"object"},{"type":"null"}],"title":"Log","description":"BMC text log"}},"type":"object","required":["log"],"title":"BmcTextLogResponse","description":"Model of BMC logs"},"Body_set_custom_equipment_content_custom_equipment__custom_equipment_identifier__content_post":{"properties":{"data":{"type":"string","format":"binary","title":"Data","description":"The equipment handler archive in \"tar.gz\" format"},"handler_import":{"type":"string","title":"Handler Import","description":"The relative python handler path to you custom handler inside your archive"}},"type":"object","required":["data","handler_import"],"title":"Body_set_custom_equipment_content_custom_equipment__custom_equipment_identifier__content_post"},"CreateCustomEquipment":{"properties":{"name":{"type":"string","title":"Name","description":"The human readable custom equipment handler name","examples":["Custom Cisco Catalyst"]},"handler":{"type":"string","pattern":"^\\w+$","title":"Handler","description":"The internal handler name for DCImanager","examples":["custom_cisco_catalyst"]},"protocol":{"items":{"$ref":"#\/components\/schemas\/ProtocolEnum"},"type":"array","maxItems":1,"minItems":1,"title":"Protocol","description":"The protocol of your handler","examples":["snmp"]},"device_type":{"allOf":[{"$ref":"#\/components\/schemas\/DeviceEnum"}],"description":"The equipment handler type","examples":["switch"]},"features":{"items":{"$ref":"#\/components\/schemas\/FeatureEnum"},"type":"array","title":"Features","description":"The features, available in your handlers","examples":[["collect_mac"]]}},"type":"object","required":["name","handler","protocol","device_type"],"title":"CreateCustomEquipment","description":"Model to create custom equipment"},"CustomEquipmentListResponse":{"properties":{"list":{"items":{"$ref":"#\/components\/schemas\/CustomEquipmentResponse"},"type":"array","title":"List"},"size":{"type":"integer","title":"Size","description":"Size of list","default":0,"examples":[4]}},"type":"object","required":["list","size"],"title":"CustomEquipmentListResponse","description":"Model of custom equipment list"},"CustomEquipmentResponse":{"properties":{"id":{"type":"integer","title":"Id","description":"The equipment handler ID","examples":[1]},"name":{"type":"string","title":"Name","description":"The human readable custom equipment handler name","examples":["Custom Cisco Catalyst"]},"device_type":{"anyOf":[{"type":"string"},{"$ref":"#\/components\/schemas\/DeviceType"},{"$ref":"#\/components\/schemas\/DeviceEnum"}],"title":"Device Type","description":"The equipment handler type","examples":["switch"]},"version":{"type":"string","title":"Version","description":"The equipment handler version","examples":["2021.08.1629980241282"]},"update_time":{"type":"string","format":"date-time","title":"Update Time","description":"The equipment handler create or update time","examples":["2021-08-26T12:17:21"]},"handler":{"type":"string","title":"Handler","description":"The internal handler name for DCImanager","examples":["custom_cisco_catalyst"]},"handler_import":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Handler Import","description":"The relative python handler path to you custom handler inside your archive","examples":["custom_cisco_catalyst.main"]},"protocol":{"items":{"$ref":"#\/components\/schemas\/ProtocolEnum"},"type":"array","title":"Protocol","description":"The protocol of your handler","examples":[["snmp"]]},"features":{"items":{"$ref":"#\/components\/schemas\/FeatureEnum"},"type":"array","title":"Features","description":"The features, available in your handlers","examples":[["collect_mac"]]}},"type":"object","required":["id","name","device_type","version","update_time","handler","handler_import","protocol","features"],"title":"CustomEquipmentResponse","description":"Model of custom equipment"},"DeviceEnum":{"type":"string","enum":["switch","pdu","ipmi","vpu"],"title":"DeviceEnum","description":"Supported devices"},"DeviceType":{"type":"string","enum":["switch","pdu","ups","vpu","ipmi","dss"],"title":"DeviceType","description":"Типы устройств."},"EditCustomEquipment":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"The human readable custom equipment handler name","examples":["Custom Cisco Catalyst"]},"features":{"anyOf":[{"items":{"$ref":"#\/components\/schemas\/FeatureEnum"},"type":"array"},{"type":"null"}],"title":"Features","description":"The features, available in your handlers","examples":[["collect_mac"]]}},"type":"object","title":"EditCustomEquipment","description":"Model to edit custom equipment"},"EquipmentHandler":{"properties":{"name":{"type":"string","title":"Name","description":"Equipment handler's name"},"handler":{"type":"string","title":"Handler","description":"Equipment handler"},"protocol":{"items":{"type":"string"},"type":"array","title":"Protocol","description":"Equipment handler's protocol"},"features":{"items":{"type":"string"},"type":"array","title":"Features","description":"Equipment handler's features"}},"type":"object","required":["name","handler","protocol","features"],"title":"EquipmentHandler","description":"Model of equipment handler"},"FeatureEnum":{"type":"string","enum":["port_aggregation","statistic_per_port","collect_mac"],"title":"FeatureEnum","description":"Switch supported features"},"FruStatus":{"type":"string","enum":["ok","updating_failed"],"title":"FruStatus","description":"Статусы информации о FRU"},"GrafanaDashboardResponse":{"properties":{"id":{"type":"integer","title":"Id","description":"Grafana dashboard ID","examples":[1]},"uid":{"type":"string","title":"Uid","description":"Grafana dashboard unique ID","examples":["dci6_netflow"]},"title":{"type":"string","title":"Title","description":"Grafana dashboard title","examples":["Netflow"]},"tags":{"items":{"type":"string"},"type":"array","title":"Tags","description":"Grafana dashboard tags","examples":["dci6","netflow"]},"panels":{"additionalProperties":{"$ref":"#\/components\/schemas\/GrafanaDashboardUrl"},"type":"object","title":"Panels","description":"Grafana dashboard panels"}},"type":"object","required":["id","uid","title","tags","panels"],"title":"GrafanaDashboardResponse","description":"Model of grafana dashboards"},"GrafanaDashboardUrl":{"properties":{"url":{"type":"string","title":"Url","description":"Grafana dashboard URL","examples":["\/grafana\/d-solo\/dci6_netflow\/netflow"]}},"type":"object","required":["url"],"title":"GrafanaDashboardUrl","description":"Model stores grafana dashboard URL"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#\/components\/schemas\/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"PduRawStatisticResponse":{"properties":{"metric_consumption":{"anyOf":[{"items":[],"type":"array"},{"type":"null"}],"title":"Metric Consumption","description":"PDU consumption statistics"},"metric_phase":{"anyOf":[{"items":[],"type":"array"},{"type":"null"}],"title":"Metric Phase","description":"PDU phase statistics"}},"type":"object","required":["metric_consumption","metric_phase"],"title":"PduRawStatisticResponse","description":"Model of PDU raw statistic"},"ProtocolEnum":{"type":"string","enum":["snmp","nxapi","eapi","netconf","routerosapi","redfish_v1","lan","lanplus","custom"],"title":"ProtocolEnum","description":"Supported protocols of devices"},"ServerNetflowRawStatisticResponse":{"properties":{"metric_rx_volume":{"anyOf":[{"items":[],"type":"array"},{"type":"null"}],"title":"Metric Rx Volume","description":"Server netflow RX volume statistic"},"metric_tx_volume":{"anyOf":[{"items":[],"type":"array"},{"type":"null"}],"title":"Metric Tx Volume","description":"Server netflow TX volume statistic"},"metric_rx_load":{"anyOf":[{"items":[],"type":"array"},{"type":"null"}],"title":"Metric Rx Load","description":"Server netflow RX load statistic"},"metric_tx_load":{"anyOf":[{"items":[],"type":"array"},{"type":"null"}],"title":"Metric Tx Load","description":"Server netflow TX load statistic"}},"type":"object","required":["metric_rx_volume","metric_tx_volume","metric_rx_load","metric_tx_load"],"title":"ServerNetflowRawStatisticResponse","description":"Model of server's netflow raw statistic"},"ServerNetflowStatisticResponse":{"properties":{"sum_volume_rx":{"type":"number","title":"Sum Volume Rx","description":"Sum of the recieved traffic volume"},"sum_volume_tx":{"type":"number","title":"Sum Volume Tx","description":"Sum of the transmitted traffic volume"},"avg_load_rx":{"type":"number","title":"Avg Load Rx","description":"Average of the recieved traffic load"},"avg_load_tx":{"type":"number","title":"Avg Load Tx","description":"Average of the transmitted traffic load"},"sum_volume_rx_converted":{"type":"string","title":"Sum Volume Rx Converted","description":"Sum of the recieved converted traffic volume"},"sum_volume_tx_converted":{"type":"string","title":"Sum Volume Tx Converted","description":"Sum of the transmitted converted traffic volume"},"avg_load_rx_converted":{"type":"string","title":"Avg Load Rx Converted","description":"Average of the recieved converted traffic load"},"avg_load_tx_converted":{"type":"string","title":"Avg Load Tx Converted","description":"Average of the transmitted converted traffic load"},"max_burstable_rx":{"type":"number","title":"Max Burstable Rx","description":"Maximum of the recieved burstable traffic"},"max_burstable_tx":{"type":"number","title":"Max Burstable Tx","description":"Maximum of the transmitted burstable traffic"}},"type":"object","required":["sum_volume_rx","sum_volume_tx","avg_load_rx","avg_load_tx","sum_volume_rx_converted","sum_volume_tx_converted","avg_load_rx_converted","avg_load_tx_converted","max_burstable_rx","max_burstable_tx"],"title":"ServerNetflowStatisticResponse","description":"Model of server's netflow statistic"},"ServerRawStatisticResponse":{"properties":{"metric_rx_volume":{"anyOf":[{"items":[],"type":"array"},{"type":"null"}],"title":"Metric Rx Volume","description":"Server RX volume statistic"},"metric_tx_volume":{"anyOf":[{"items":[],"type":"array"},{"type":"null"}],"title":"Metric Tx Volume","description":"Server TX volume statistic"},"metric_rx_load":{"anyOf":[{"items":[],"type":"array"},{"type":"null"}],"title":"Metric Rx Load","description":"Server RX load statistic"},"metric_tx_load":{"anyOf":[{"items":[],"type":"array"},{"type":"null"}],"title":"Metric Tx Load","description":"Server TX load statistic"}},"type":"object","required":["metric_rx_volume","metric_tx_volume","metric_rx_load","metric_tx_load"],"title":"ServerRawStatisticResponse","description":"Model of server's raw statistic"},"ServerStatisticResponse":{"properties":{"sum_volume_rx":{"type":"number","title":"Sum Volume Rx","description":"Sum of the recieved traffic volume"},"sum_volume_tx":{"type":"number","title":"Sum Volume Tx","description":"Sum of the transmitted traffic volume"},"avg_load_rx":{"type":"number","title":"Avg Load Rx","description":"Average of the recieved traffic load"},"avg_load_tx":{"type":"number","title":"Avg Load Tx","description":"Average of the transmitted traffic load"},"sum_volume_rx_converted":{"type":"string","title":"Sum Volume Rx Converted","description":"Sum of the recieved converted traffic volume"},"sum_volume_tx_converted":{"type":"string","title":"Sum Volume Tx Converted","description":"Sum of the transmitted converted traffic volume"},"avg_load_rx_converted":{"type":"string","title":"Avg Load Rx Converted","description":"Average of the recieved converted traffic load"},"avg_load_tx_converted":{"type":"string","title":"Avg Load Tx Converted","description":"Average of the transmitted converted traffic load"},"max_burstable_rx":{"type":"number","title":"Max Burstable Rx","description":"Maximum of the recieved burstable traffic"},"max_burstable_tx":{"type":"number","title":"Max Burstable Tx","description":"Maximum of the transmitted burstable traffic"},"sum_consumption":{"type":"number","title":"Sum Consumption","description":"Sum of the consumption power"}},"type":"object","required":["sum_volume_rx","sum_volume_tx","avg_load_rx","avg_load_tx","sum_volume_rx_converted","sum_volume_tx_converted","avg_load_rx_converted","avg_load_tx_converted","max_burstable_rx","max_burstable_tx","sum_consumption"],"title":"ServerStatisticResponse","description":"Model of server's statistic"},"SupportedEquipmentResponse":{"items":{"$ref":"#\/components\/schemas\/EquipmentHandler"},"type":"array","title":"SupportedEquipmentResponse","description":"Model of equipment handlers list"},"SwitchStatisticResponse":{"properties":{"sum_volume_rx":{"type":"number","title":"Sum Volume Rx","description":"Sum of the recieved traffic volume"},"sum_volume_tx":{"type":"number","title":"Sum Volume Tx","description":"Sum of the transmitted traffic volume"},"avg_load_rx":{"type":"number","title":"Avg Load Rx","description":"Average of the recieved traffic load"},"avg_load_tx":{"type":"number","title":"Avg Load Tx","description":"Average of the transmitted traffic load"},"sum_volume_rx_converted":{"type":"string","title":"Sum Volume Rx Converted","description":"Sum of the recieved converted traffic volume"},"sum_volume_tx_converted":{"type":"string","title":"Sum Volume Tx Converted","description":"Sum of the transmitted converted traffic volume"},"avg_load_rx_converted":{"type":"string","title":"Avg Load Rx Converted","description":"Average of the recieved converted traffic load"},"avg_load_tx_converted":{"type":"string","title":"Avg Load Tx Converted","description":"Average of the transmitted converted traffic load"},"max_burstable_rx":{"type":"number","title":"Max Burstable Rx","description":"Maximum of the recieved burstable traffic"},"max_burstable_tx":{"type":"number","title":"Max Burstable Tx","description":"Maximum of the transmitted burstable traffic"}},"type":"object","required":["sum_volume_rx","sum_volume_tx","avg_load_rx","avg_load_tx","sum_volume_rx_converted","sum_volume_tx_converted","avg_load_rx_converted","avg_load_tx_converted","max_burstable_rx","max_burstable_tx"],"title":"SwitchStatisticResponse","description":"Model of switch's statistic"},"UpsRawStatisticResponse":{"properties":{"metric_load_percentage":{"anyOf":[{"items":[],"type":"array"},{"type":"null"}],"title":"Metric Load Percentage","description":"Ups load percentage"},"metric_charge_time":{"anyOf":[{"items":[],"type":"array"},{"type":"null"}],"title":"Metric Charge Time","description":"Ups charge time"},"metric_input_power":{"anyOf":[{"items":[],"type":"array"},{"type":"null"}],"title":"Metric Input Power","description":"Ups input power"},"metric_output_power":{"anyOf":[{"items":[],"type":"array"},{"type":"null"}],"title":"Metric Output Power","description":"Ups output power"}},"type":"object","required":["metric_load_percentage","metric_charge_time","metric_input_power","metric_output_power"],"title":"UpsRawStatisticResponse","description":"Model of UPS raw statistic"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"handlers__server_netflow_statistic_handler__MetricType":{"type":"string","enum":["all","volume","load"],"title":"MetricType","description":"Server netflow metric type"},"handlers__server_statistic_handler__MetricType":{"type":"string","enum":["all","volume","load"],"title":"MetricType","description":"Server metric type"}}},"tags":[{"name":"Equip service","description":"handlers for events"}]}

The article was last updated on 11.17.2025. The article was prepared by technical writers of ISPsystem