@itentialopensource/adapter-efficientip_solidserver

{ "id": "@itentialopensource/adapter-efficientip_solidserver", "type": "Adapter", "export": "EfficientipSolidserver", "title": "Efficientip_solidserver", "src": "adapter.js", "roles": [ "admin" ], "methods": [ { "name": "iapUpdateAdapterConfiguration", "summary": "Updates the adapter configuration", "description": "Updates the adapter configuration file with the provided changes", "input": [ { "name": "configFile", "type": "string", "info": "The name of the file to change", "required": true, "schema": { "title": "configFile", "type": "string" } }, { "name": "changes", "type": "object", "info": "JSON object containing the configuration changes", "required": true, "schema": { "title": "changes", "type": "object" } }, { "name": "entity", "type": "string", "info": "The entity in which the changes are being made", "required": false, "schema": { "title": "entity", "type": "string" } }, { "name": "type", "type": "string", "info": "The type of file to change - action, schema, or mock", "required": false, "schema": { "title": "type", "type": "string" } }, { "name": "action", "type": "string", "info": "The action to be changed", "required": false, "schema": { "title": "action", "type": "string" } }, { "name" : "replace", "type": "boolean", "info": "True to replace entire mock data, false to merge/append", "required": false, "schema": { "title": "replace", "type" : "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapUpdateAdapterConfiguration" }, "task": true }, { "name": "iapSuspendAdapter", "summary": "Suspends the adapter", "description": "Suspends the adapter", "input": [ { "name": "mode", "type": "enum", "enumerals": [ "pause", "error" ], "info": "How incoming requests are handled. Defaults to 'pause'", "description": "How incoming requests are handled. Defaults to 'pause'", "schema": { "title": "mode", "type": "string" }, "required": false } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the adapter suspended status", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapSuspendAdapter" }, "task": true }, { "name": "iapUnsuspendAdapter", "summary": "Unsuspends the adapter", "description": "Unsuspends the adapter", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the adapter suspended status", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapUnsuspendAdapter" }, "task": true }, { "name": "iapGetAdapterQueue", "summary": "Return the requests that are waiting in the queue if throttling is enabled", "description": "Return the requests that are waiting in the queue if throttling is enabled", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the adapter queue", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapGetAdapterQueue" }, "task": true }, { "name": "iapFindAdapterPath", "summary": "Provides the ability to see if a particular API path is supported by the adapter", "description": "Provides the ability to see if a particular API path is supported by the adapter", "input": [ { "name": "apiPath", "type": "string", "info": "The API Path you want to check - make sure to not include base path and version", "description": "The API Path you want to check - make sure to not include base path and version", "schema": { "title": "apiPath", "type": "string" }, "required": true } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapFindAdapterPath" }, "task": true }, { "name": "iapTroubleshootAdapter", "summary": "Runs troubleshoot script for adapter", "description": "Runs troubleshoot script for adapter", "input": [ { "name": "props", "type": "object", "info": "Object containing configuration, healthcheck and auth properties {'connProps':{'host': 'api.service.com', 'base_path': '/', 'protocol': 'http', 'port': 443, 'version': 'v1'},'healthCheckEndpoint': '/healthcheck', 'auth': {'auth_method': 'no authentication', 'username': 'username', 'password': 'password'}}", "required": true, "schema": { "title": "props", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the test results", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapTroubleshootAdapter" }, "task": true }, { "name": "iapRunAdapterHealthcheck", "summary": "Runs healthcheck script for adapter", "description": "Runs healthcheck script for adapter", "input": [], "output": { "name": "result", "type": "boolean", "description": "Whether healthcheck passed or failed", "schema": { "title": "result", "type": "boolean" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapRunAdapterHealthcheck" }, "task": true }, { "name": "iapRunAdapterConnectivity", "summary": "Runs connectivity check script for adapter", "description": "Runs connectivity check script for adapter", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the test results", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapRunAdapterConnectivity" }, "task": true }, { "name": "iapRunAdapterBasicGet", "summary": "Runs basicGet script for adapter", "description": "Runs basicGet script for adapter", "input": [ { "name": "maxCalls", "required": false, "type": "number", "info": "How many GET endpoints to test (defaults to 5)", "schema": { "title": "maxCalls", "type": "number", "default": 5 } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the test results", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapRunAdapterBasicGet" }, "task": true }, { "name": "iapMoveAdapterEntitiesToDB", "summary": "Moves entities from an adapter into the Itential Platform database", "description": "Moves entities from an adapter into the Itential Platform database", "input": [], "output": { "name": "res", "type": "object", "description": "A JSON Object containing status, code and the response from the mongo transaction", "schema": { "title": "res", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapMoveAdapterEntitiesToDB" }, "task": true }, { "name": "iapDeactivateTasks", "summary": "Deactivate the inputted tasks", "description": "Deactivate the inputted tasks", "input": [ { "name": "tasks", "type": "array", "description": "Tasks to deactivate", "schema": { "title": "tasks", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing success status", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapDeactivateTasks" }, "task": true }, { "name": "iapActivateTasks", "summary": "Activate the inputted tasks", "description": "activate the inputted tasks", "input": [ { "name": "tasks", "type": "array", "description": "Tasks to activate", "schema": { "title": "tasks", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing success status", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapActivateTasks" }, "task": true }, { "name": "iapPopulateEntityCache", "summary": "Populate the cache for the given entities", "description": "Populate the cache for the given entities", "input": [ { "name": "entityTypes", "type": "array", "info": "the entity type(s) to populate", "required": true, "schema": { "title": "entityTypes", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapPopulateEntityCache" }, "task": true }, { "name": "iapRetrieveEntitiesCache", "summary": "Retrieves data from cache for specified entity type", "description": "Retrieves data from cache for specified entity type", "input": [ { "name": "entityType", "type": "string", "info": "entity of which to retrieve", "required": true, "schema": { "title": "entityType", "type": "string" } }, { "name": "options", "type": "object", "info": "settings of which data to return and how to return it", "required": false, "schema": { "title": "options", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapRetrieveEntitiesCache" }, "task": true }, { "name": "getDevice", "summary": "Get the Appliance", "description": "Get the Appliance", "input": [ { "name": "deviceName", "type": "string", "info": "An Appliance Device Name", "required": true, "schema": { "title": "deviceName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getDevice" }, "task": false }, { "name": "getDevicesFiltered", "summary": "Get Appliances that match the filter", "description": "Get Appliances that match the filter", "input": [ { "name": "options", "type": "object", "info": "options - e.g. { 'start': 1, 'limit': 20, 'filter': { 'name': 'abc123' } }", "required": true, "schema": { "title": "options", "type": "object" } } ], "output": { "name": "result", "type": "array", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getDevicesFiltered" }, "task": false }, { "name": "isAlive", "summary": "Checks the status for the provided Appliance", "description": "Checks the status for the provided Appliance", "input": [ { "name": "deviceName", "type": "string", "info": "An Appliance Device Name", "required": true, "schema": { "title": "deviceName", "type": "string" } } ], "output": { "name": "result", "type": "boolean", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "boolean" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/isAlive" }, "task": false }, { "name": "getConfig", "summary": "Gets a config for the provided Appliance", "description": "Gets a config for the provided Appliance", "input": [ { "name": "deviceName", "type": "string", "info": "An Appliance Device Name", "required": true, "schema": { "title": "deviceName", "type": "string" } }, { "name": "format", "type": "string", "info": "The format to be returned - this is ignored as we always return json", "required": false, "schema": { "title": "format", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getConfig" }, "task": false }, { "name": "iapGetDeviceCount", "summary": "Gets a device count from the system", "description": "Gets a device count from the system", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapGetDeviceCount" }, "task": false }, { "name": "iapExpandedGenericAdapterRequest", "summary": "Makes the requested generic call with additional options", "description": "Makes the requested generic call with additional options via metadata", "input": [ { "name": "metadata", "type": "object", "info": "metadata for the call (optional)", "description": "metadata for the call - allows for many enhancements (optional)", "schema": { "title": "metadata", "type": "object" }, "required": false }, { "name": "uriPath", "type": "string", "info": "the path of the api call - do not include the host, port, base path or version", "description": "the path of the api call", "schema": { "title": "uriPath", "type": "string" }, "required": false }, { "name": "restMethod", "type": "string", "info": "the rest method (GET, POST, PUT, PATCH, DELETE)", "description": "the rest method (GET, POST, PUT, PATCH, DELETE)", "schema": { "title": "restMethod", "type": "string" }, "required": false }, { "name": "pathVars", "type": "object", "info": "the parameters to be put within the url path (optional)", "description": "the parameters to be put within the url path (optional)", "schema": { "title": "pathVars", "type": "object" }, "required": false }, { "name": "queryData", "type": "object", "info": "the query parameters to be put on the url (optional)", "description": "the query parameters to be put on the url (optional)", "schema": { "title": "queryData", "type": "object" }, "required": false }, { "name": "requestBody", "type": "object", "info": "the payload to be sent with the request (optional)", "description": "the payload to be sent with the request (optional)", "schema": { "title": "requestBody", "type": "object" }, "required": false }, { "name": "addlHeaders", "type": "object", "info": "additional headers to be put on the call (optional)", "description": "additional headers to be put on the call (optional)", "schema": { "title": "addlHeaders", "type": "object" }, "required": false } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapExpandedGenericAdapterRequest" }, "task": true }, { "name": "genericAdapterRequest", "summary": "Makes the requested generic call", "description": "Makes the requested generic call", "input": [ { "name": "uriPath", "type": "string", "info": "the path of the api call - do not include the host, port, base path or version", "description": "the path of the api call", "schema": { "title": "uriPath", "type": "string" }, "required": true }, { "name": "restMethod", "type": "string", "info": "the rest method (GET, POST, PUT, PATCH, DELETE)", "description": "the rest method (GET, POST, PUT, PATCH, DELETE)", "schema": { "title": "restMethod", "type": "string" }, "required": true }, { "name": "queryData", "type": "object", "info": "the query parameters to be put on the url (optional)", "description": "the query parameters to be put on the url (optional)", "schema": { "title": "queryData", "type": "object" }, "required": false }, { "name": "requestBody", "type": "object", "info": "the payload to be sent with the request (optional)", "description": "the payload to be sent with the request (optional)", "schema": { "title": "requestBody", "type": "object" }, "required": false }, { "name": "addlHeaders", "type": "object", "info": "additional headers to be put on the call (optional)", "description": "additional headers to be put on the call (optional)", "schema": { "title": "addlHeaders", "type": "object" }, "required": false } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/genericAdapterRequest" }, "task": true }, { "name": "genericAdapterRequestNoBasePath", "summary": "Makes the requested generic call", "description": "Makes the requested generic call", "input": [ { "name": "uriPath", "type": "string", "info": "the path of the api call - do not include the host, port, base path or version", "description": "the path of the api call", "schema": { "title": "uriPath", "type": "string" }, "required": true }, { "name": "restMethod", "type": "string", "info": "the rest method (GET, POST, PUT, PATCH, DELETE)", "description": "the rest method (GET, POST, PUT, PATCH, DELETE)", "schema": { "title": "restMethod", "type": "string" }, "required": true }, { "name": "queryData", "type": "object", "info": "the query parameters to be put on the url (optional)", "description": "the query parameters to be put on the url (optional)", "schema": { "title": "queryData", "type": "object" }, "required": false }, { "name": "requestBody", "type": "object", "info": "the payload to be sent with the request (optional)", "description": "the payload to be sent with the request (optional)", "schema": { "title": "requestBody", "type": "object" }, "required": false }, { "name": "addlHeaders", "type": "object", "info": "additional headers to be put on the call (optional)", "description": "additional headers to be put on the call (optional)", "schema": { "title": "addlHeaders", "type": "object" }, "required": false } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/genericAdapterRequestNoBasePath" }, "task": true }, { "name": "iapRunAdapterLint", "summary": "Run the adapter lint script to return the results", "description": "Run the adapter lint script to return the results", "input": [], "output": { "name": "result", "type": "string", "description": "A string containing the run results", "schema": { "title": "result", "type": "string" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/iapRunAdapterLint" }, "task": true }, { "name": "iapRunAdapterTests", "summary": "Run the adapter test scripts (baseunit and unit) to return the results", "description": "Run the adapter test scripts (baseunit and unit) to return the results", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/iapRunAdapterTests" }, "task": true }, { "name": "iapGetAdapterInventory", "summary": "Provide inventory information abbout the adapter", "description": "Provide inventory information abbout the adapter", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/iapGetAdapterInventory" }, "task": true }, { "name": "getIpamSpaceList", "summary": "List the spaces", "description": "This service allows to list the objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", "input": [ { "name": "orderby", "type": "string", "info": "A clause that allows to sort the result. You can include any output parameter of the service in this clause, except class parameters.To sort the result using class parame...(description truncated): string", "required": false, "schema": { "title": "orderby", "type": "string" } }, { "name": "where", "type": "string", "info": "A clause that allows to filter the result. You can include any output parameter of the service in this clause, except class parameters.To filter the result using class pa...(description truncated): string", "required": false, "schema": { "title": "where", "type": "string" } }, { "name": "limit", "type": "number", "info": "The maximum number of results to be returned. Depending on the user resources and the database content, it can return less results than the value you have specified.The i...(description truncated): 123", "required": false, "schema": { "title": "limit", "type": "number" } }, { "name": "offset", "type": "number", "info": "The number of rows to skip in the service output.The input parameter offset must be specified in lowercase.: 123", "required": false, "schema": { "title": "offset", "type": "number" } }, { "name": "tags", "type": "string", "info": "The list of class parameters to tag in the call, separated by a comma. Each parameter must be specified following the format <object-type>.<parameter>, e.g. s...(description truncated): string", "required": false, "schema": { "title": "tags", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "success": { "description": "state true/false indicate if action succeed", "type": "boolean" }, "messages": { "description": "List or notice/warning/error messages", "type": "array", "items": { "type": "object", "properties": { "code": { "type": "integer" }, "msg": { "type": "string" }, "type": { "type": "string", "enum": [ "error", "warning", "notice" ] }, "extra": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "space_multistatus": { "type": "string", "description": "The Multi-status information is displayed as follows: <i><number-of-instances>@<message-number>@<multi-status-severity>@<module></i>. The different severity levels are:<br><b>Multi-status severity levels</b> <table border=1> <thead> <tr > <td><b>Message number</b></td> <td><b>Severity</b></td> <td><b>Description</b></td> </tr> </thead> <tbody> <tr valign=middle> <td>0 - 16</td> <td>Emergency</td> <td>The object configuration prevents the system from running properly. Action is required.</td> </tr> <tr valign=middle> <td>17 - 33</td> <td>Critical</td> <td>The object configuration is in critical conditions. Immediate action is recommended.</td> </tr> <tr valign=middle> <td>34 - 50</td> <td>Error</td> <td>The object configuration failed at some level. Action is recommended.</td> </tr> <tr valign=middle> <td>51 - 66</td> <td>Warning</td> <td>The object configuration triggers error messages if no action is taken. Action to be taken at your discretion.</td> </tr> <tr valign=middle> <td>67 - 83</td> <td>Notice</td> <td>The object configuration is normal but undergoing events that might trigger errors. No immediate action required.</td> </tr> <tr valign=middle> <td>84 - 100</td> <td>Informational</td> <td>The object configuration is normal, operational messages (might inform you about potential incompatibilities with other modules, etc). No action required.</td> </tr> </tbody></table>" }, "parent_space_class_name": { "type": "string", "description": "The name of the class applied to the VLSM parent space, it can be preceded by the class directory." }, "parent_space_class_parameters": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string" }, "inheritance": { "type": "string", "enum": [ "set", "inherited" ] }, "propagation": { "type": "string", "enum": [ "propagate", "restrict" ] }, "source": { "type": "string" } } }, "description": "The class parameters applied to the VLSM parent space and their value." }, "parent_space_id": { "type": "string", "description": "The database identifier (ID) of the VLSM parent space. 0 indicates that space has no parent space." }, "parent_space_name": { "type": "string", "description": "The name of the VLSM parent space. # indicates that space has no parent space." }, "space_class_name": { "type": "string", "description": "The name of the class applied to the space, it can be preceded by the class directory." }, "space_class_parameters": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string" }, "inheritance": { "type": "string", "enum": [ "set", "inherited" ] }, "propagation": { "type": "string", "enum": [ "propagate", "restrict" ] }, "source": { "type": "string" } } }, "description": "The class parameters applied to the space and their value." }, "space_description": { "type": "string", "description": "The description of the space." }, "space_id": { "type": "string", "description": "The database identifier (ID) of the space." }, "space_is_template": { "type": "string", "description": "The template status of the space. If the space is used as template (1), all the IPv4 networks, pools and IP addresses it contains are also used as template." }, "space_name": { "type": "string", "description": "The name of the space." } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getIpamSpaceList" }, "task": true }, { "name": "getIpamSpaceCount", "summary": "Count the number of spaces", "description": "This service allows to return the number of objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", "input": [ { "name": "where", "type": "string", "info": "A clause that allows to filter the result. You can include any output parameter of the service *_list of the object in this clause, except class parameters.To filter the ...(description truncated): string", "required": false, "schema": { "title": "where", "type": "string" } }, { "name": "tags", "type": "string", "info": "The list of class parameters to tag in the call, separated by a comma. Each parameter must be specified following the format <object-type>.<parameter>, e.g. s...(description truncated): string", "required": false, "schema": { "title": "tags", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "messages": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "integer" }, "msg": { "type": "string" }, "type": { "type": "string", "enum": [ "error", "warning", "notice" ] }, "extra": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "data": { "type": "array", "minItems": 1, "maxItems": 1, "items": { "type": "object", "properties": { "count": { "type": "integer" } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getIpamSpaceCount" }, "task": true }, { "name": "getIpamSpaceInfo", "summary": "Display the properties of a space", "description": "This service allows to display the properties of an object.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", "input": [ { "name": "spaceId", "type": "number", "info": "The database identifier (ID) of the space, a unique numeric key value automatically incremented when you add a space. Use the ID to specify the space of your choice.: 123", "required": false, "schema": { "title": "spaceId", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object", "properties": { "success": { "description": "state true/false indicate if action succeed", "type": "boolean" }, "messages": { "description": "List or notice/warning/error messages", "type": "array", "items": { "type": "object", "properties": { "code": { "type": "integer" }, "msg": { "type": "string" }, "type": { "type": "string", "enum": [ "error", "warning", "notice" ] }, "extra": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "space_multistatus": { "type": "string", "description": "The Multi-status information is displayed as follows: <i><number-of-instances>@<message-number>@<multi-status-severity>@<module></i>. The different severity levels are:<br><b>Multi-status severity levels</b> <table border=1> <thead> <tr > <td><b>Message number</b></td> <td><b>Severity</b></td> <td><b>Description</b></td> </tr> </thead> <tbody> <tr valign=middle> <td>0 - 16</td> <td>Emergency</td> <td>The object configuration prevents the system from running properly. Action is required.</td> </tr> <tr valign=middle> <td>17 - 33</td> <td>Critical</td> <td>The object configuration is in critical conditions. Immediate action is recommended.</td> </tr> <tr valign=middle> <td>34 - 50</td> <td>Error</td> <td>The object configuration failed at some level. Action is recommended.</td> </tr> <tr valign=middle> <td>51 - 66</td> <td>Warning</td> <td>The object configuration triggers error messages if no action is taken. Action to be taken at your discretion.</td> </tr> <tr valign=middle> <td>67 - 83</td> <td>Notice</td> <td>The object configuration is normal but undergoing events that might trigger errors. No immediate action required.</td> </tr> <tr valign=middle> <td>84 - 100</td> <td>Informational</td> <td>The object configuration is normal, operational messages (might inform you about potential incompatibilities with other modules, etc). No action required.</td> </tr> </tbody></table>" }, "parent_space_class_name": { "type": "string", "description": "The name of the class applied to the VLSM parent space, it can be preceded by the class directory." }, "parent_space_class_parameters": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string" }, "inheritance": { "type": "string", "enum": [ "set", "inherited" ] }, "propagation": { "type": "string", "enum": [ "propagate", "restrict" ] }, "source": { "type": "string" } } }, "description": "The class parameters applied to the VLSM parent space and their value." }, "parent_space_id": { "type": "string", "description": "The database identifier (ID) of the VLSM parent space. 0 indicates that space has no parent space." }, "parent_space_name": { "type": "string", "description": "The name of the VLSM parent space. # indicates that space has no parent space." }, "space_class_name": { "type": "string", "description": "The name of the class applied to the space, it can be preceded by the class directory." }, "space_class_parameters": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string" }, "inheritance": { "type": "string", "enum": [ "set", "inherited" ] }, "propagation": { "type": "string", "enum": [ "propagate", "restrict" ] }, "source": { "type": "string" } } }, "description": "The class parameters applied to the space and their value." }, "space_description": { "type": "string", "description": "The description of the space." }, "space_id": { "type": "string", "description": "The database identifier (ID) of the space." }, "space_is_template": { "type": "string", "description": "The template status of the space. If the space is used as template (1), all the IPv4 networks, pools and IP addresses it contains are also used as template." }, "space_name": { "type": "string", "description": "The name of the space." } } } } } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getIpamSpaceInfo" }, "task": true }, { "name": "createIpamSpace", "summary": "Add a space", "description": "This service allows to add objects. A call can only add one object. To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to. Mandatory Parameters : space_name", "input": [ { "name": "body", "type": "object", "info": ": {\"space_name\": \"string\", \"parent_space_id\": 123, \"parent_space_name\": \"string\", \"space_description\": \"string\", \"space_is_template\": 123, \"class_parameters_to_delete\": \"array\", \"space_class_name\": \"string\", \"space_class_parameters\": [{\"name\": \"string\", \"value\": \"string\", \"inheritance\": \"Must be one of [set, inherited]\", \"propagation\": \"Must be one of [propagate, restrict]\"}], \"warnings\": \"Must be one of [accept]\"}", "required": false, "schema": { "type": "object", "properties": { "space_name": { "description": "The name of the space, each space must have a unique name.", "type": "string" }, "parent_space_id": { "description": "The database identifier (ID) of an existing space you want to set as the VLSM parent of the space you are adding. This sets up a space-based VLSM organization.", "type": "integer" }, "parent_space_name": { "description": "The name of an existing space you want to set as the VLSM parent of the space you are adding. This sets up a space-based VLSM orga