DCImanager Administrator

IPMI Proxy service

ISPSystem
{ "openapi": "3.0.0", "info": { "title": "IPMI Proxy service 6 API", "description": "IPMI Proxy service 6 API", "version": "3.0.0" }, "servers": [ { "url": "https://127.0.0.1/api/ipmiproxy/v3" } ], "components": { "securitySchemes": { "cookieAuth": { "type": "apiKey", "in": "cookie", "name": "ses6" }, "headerHost": { "type": "apiKey", "in": "header", "name": "host" } }, "schemas": { "LocationGetResponse": { "properties": { "location": { "type": "integer", "description": "The location identifier" }, "instance": { "type": "integer", "description": "The instance identifier" }, "status": { "enum": [ "ok", "fail", "setting_up" ], "type": "string" }, "docker_compose": { "description": "Base64-encoded docker-compose file of IPMI proxy server", "type": "string" } }, "type": "object" }, "LocationListResponse": { "properties": { "list": { "items": { "$ref": "#/components/schemas/LocationGetResponse" }, "type": "array" } }, "type": "object" }, "PluginStatusResponse": { "properties": { "is_enabled": { "type": "boolean", "description": "The plugin status" } }, "type": "object" }, "SetupPostParams": { "additionalProperties": false, "properties": { "locations": { "description": "List of locations where proxy should be activated", "type": "array", "items": { "type": "integer" } }, "java_agree": { "description": "Consent to Java Oracle", "type": "boolean" } }, "required": [ "locations", "java_agree" ], "type": "object" }, "UpdatePostParams": { "additionalProperties": false, "properties": { "locations": { "description": "List of locations where the proxy module should be updated", "type": "array", "items": { "type": "integer" } } }, "required": [ "locations" ], "type": "object" }, "ProxyAccessParams": { "additionalProperties": false, "required": [ "listen_web_port" ], "type": "object", "properties": { "listen_web_port": { "description": "The port that the user is trying to connect to", "type": "integer" } } }, "ProxyCloseParams": { "additionalProperties": false, "required": [ "listen_web_port" ], "type": "object", "properties": { "listen_web_port": { "description": "The port that can no longer be connected to", "type": "integer" } } }, "SuccessTaskAndPortSchema": { "properties": { "task": { "type": "integer" }, "listen_web_port": { "type": "integer" } }, "type": "object" }, "SuccessPortSchema": { "properties": { "listen_web_port": { "type": "integer" } }, "type": "object" }, "EmptySchema": { "additionalProperties": false, "properties": {}, "type": "object" }, "ErrorSchema": { "properties": { "error": { "properties": { "code": { "type": "integer" }, "msg": { "type": "string" }, "value": { "type": "string" } }, "type": "object" } }, "type": "object" }, "Id": { "properties": { "id": { "type": "integer" } }, "type": "object" }, "SuccessSchema": { "$ref": "#/components/schemas/Id" }, "SuccessTaskArraySchema": { "properties": { "task": { "items": { "type": "integer" }, "type": "array" } }, "type": "object" }, "SuccessTaskOnlySchema": { "properties": { "task": { "type": "integer" } }, "type": "object" }, "SuccessTaskSchema": { "properties": { "id": { "type": "integer" }, "task": { "type": "integer" } }, "type": "object" } }, "requestBodies": { "EmptyRequest": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmptySchema" } } } } } }, "security": [ { "cookieAuth": [], "headerHost": [] } ], "paths": { "/location": { "get": { "operationId": "location_get", "responses": { "200": { "description": "Locations list has been received", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LocationListResponse" } } } }, "default": { "description": "Error receiving the locations list", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "summary": "Receive the locations list" } }, "/plugin/enable": { "post": { "operationId": "plugin_enable_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmptySchema" } } } }, "responses": { "200": { "description": "Activate the plugin on the specified instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Id" } } } }, "default": { "description": "Error activating the plugin", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "summary": "Activate the plugin for the instance" } }, "/plugin/disable": { "post": { "operationId": "plugin_disable_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmptySchema" } } } }, "responses": { "200": { "description": "Deactivate the plugin on the specified instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Id" } } } }, "default": { "description": "Error deactivating the plugin", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "summary": "Deactivate the plugin for the instance" } }, "/plugin/status": { "get": { "operationId": "plugin_status_get", "responses": { "200": { "description": "Plugin status has been received", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PluginStatusResponse" } } } }, "default": { "description": "Error receiving the plugin status", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "summary": "Receive the plugin status" } }, "/setup": { "post": { "operationId": "setup_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetupPostParams" } } } }, "responses": { "200": { "description": "IPMI proxy server has been successfully installed on the locations", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/SuccessTaskArraySchema" }, { "$ref": "#/components/schemas/EmptySchema" } ] } } } }, "default": { "description": "Error installing IPMI proxy server", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "summary": "IPMI proxy server setting up" } }, "/update": { "post": { "operationId": "update_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePostParams" } } } }, "responses": { "200": { "description": "IPMI proxy server has been successfully updated on the locations", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/SuccessTaskArraySchema" }, { "$ref": "#/components/schemas/EmptySchema" } ] } } } }, "default": { "description": "Error updating IPMI proxy server", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "summary": "IPMI proxy server updating" } }, "/ipmi/{ipmi_id}/proxy/{proxy_type}": { "post": { "operationId": "ipmi_id_proxy_post", "parameters": [ { "description": "The IPMI unique identifier", "in": "path", "name": "ipmi_id", "required": true, "schema": { "type": "integer" } }, { "description": "Proxy type: web - Proxy to the IPMI WEB-interface, console - Proxy to the IPMI console", "in": "path", "name": "proxy_type", "required": true, "schema": { "type": "string", "enum": [ "web", "console" ] } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmptySchema" } } } }, "responses": { "200": { "description": "Start the IPMI proxy session", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/SuccessTaskAndPortSchema" }, { "$ref": "#/components/schemas/SuccessPortSchema" } ] } } } }, "default": { "description": "Error starting the IPMI proxy session", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "summary": "Start the IPMI proxy session" } }, "/proxy/access": { "post": { "operationId": "proxy_access_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProxyAccessParams" } } } }, "responses": { "200": { "description": "Check user access permissions to the session", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmptySchema" } } } }, "default": { "description": "Error checking user access permissions to the session", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "summary": "Check user access permissions to the session" } }, "/proxy/close": { "post": { "operationId": "proxy_close_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProxyCloseParams" } } } }, "responses": { "200": { "description": "Close the IPMI proxy session", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmptySchema" } } } }, "default": { "description": "Error closing the IPMI proxy session", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorSchema" } } } } }, "summary": "Close the IPMI proxy session" } } }}
Thank you for your feedback!
Was the article useful?
Tell us why not:

it does not match the title

it was hard to understand

I didn't find the answer

recommendations from the article did not help

other

Tell us what you didn't like in the article: