@itentialopensource/adapter-openstack_nova
Version:
This adapter integrates with system described as: Opensatck Compute (Nova) Service.
1,699 lines (1,698 loc) • 285 kB
JSON
{
"id": "@itentialopensource/adapter-openstack_nova",
"type": "Adapter",
"export": "OpenstackNova",
"title": "Openstack_nova",
"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": "showDetailsOfSpecificAPIVersion",
"summary": "Show Details of Specific API Version",
"description": "Show Details of Specific API Version",
"input": [
{
"name": "apiVersion",
"type": "string",
"info": "The API version as returned in the links from the GET / call.: string",
"required": true,
"schema": {
"title": "apiVersion",
"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": "/showDetailsOfSpecificAPIVersion"
},
"task": true
},
{
"name": "listServers",
"summary": "List Servers",
"description": "List Servers",
"input": [
{
"name": "accessIpV4",
"type": "string",
"info": "Filter server list result by IPv4 address that should be used to access the server.: string",
"required": false,
"schema": {
"title": "accessIpV4",
"type": "string"
}
},
{
"name": "accessIpV6",
"type": "string",
"info": "Filter server list result by IPv6 address that should be used to access the server.: string",
"required": false,
"schema": {
"title": "accessIpV6",
"type": "string"
}
},
{
"name": "allTenants",
"type": "boolean",
"info": "Specify the all_tenants query parameter to list all instances for all projects. By default this is only allowed by administrators. If this parameter is specified without ...(description truncated): boolean",
"required": false,
"schema": {
"title": "allTenants",
"type": "boolean"
}
},
{
"name": "autoDiskConfig",
"type": "string",
"info": "Filter the server list result by the disk_config setting of the server, Valid values are:: string",
"required": false,
"schema": {
"title": "autoDiskConfig",
"type": "string"
}
},
{
"name": "availabilityZone",
"type": "string",
"info": "Filter the server list result by server availability zone.: string",
"required": false,
"schema": {
"title": "availabilityZone",
"type": "string"
}
},
{
"name": "changesSince",
"type": "string",
"info": "Filters the response by a date and time stamp when the server last changed status. To help keep track of changes this may also return recently deleted servers.: string",
"required": false,
"schema": {
"title": "changesSince",
"type": "string"
}
},
{
"name": "configDrive",
"type": "string",
"info": "Filter the server list result by the config drive setting of the server.: string",
"required": false,
"schema": {
"title": "configDrive",
"type": "string"
}
},
{
"name": "createdAt",
"type": "string",
"info": "Filter the server list result by a date and time stamp when server was created.: string",
"required": false,
"schema": {
"title": "createdAt",
"type": "string"
}
},
{
"name": "deleted",
"type": "boolean",
"info": "Show deleted items only. In some circumstances deleted items will still be accessible via the backend database, however there is no contract on how long, so this paramete...(description truncated): boolean",
"required": false,
"schema": {
"title": "deleted",
"type": "boolean"
}
},
{
"name": "description",
"type": "string",
"info": "Filter the server list result by description.: string",
"required": false,
"schema": {
"title": "description",
"type": "string"
}
},
{
"name": "flavor",
"type": "string",
"info": "Filters the response by a flavor, as a UUID. A flavor is a combination of memory, disk size, and CPUs.: string",
"required": false,
"schema": {
"title": "flavor",
"type": "string"
}
},
{
"name": "host",
"type": "string",
"info": "Filter the server list result by the host name of compute node.: string",
"required": false,
"schema": {
"title": "host",
"type": "string"
}
},
{
"name": "hostname",
"type": "string",
"info": "Filter the server list result by the host name of server.: string",
"required": false,
"schema": {
"title": "hostname",
"type": "string"
}
},
{
"name": "image",
"type": "string",
"info": "Filters the response by an image, as a UUID.: string",
"required": false,
"schema": {
"title": "image",
"type": "string"
}
},
{
"name": "ip",
"type": "string",
"info": "An IPv4 address to filter results by.: string",
"required": false,
"schema": {
"title": "ip",
"type": "string"
}
},
{
"name": "ip6",
"type": "string",
"info": "An IPv6 address to filter results by.: string",
"required": false,
"schema": {
"title": "ip6",
"type": "string"
}
},
{
"name": "kernelId",
"type": "string",
"info": "Filter the server list result by the UUID of the kernel image when using an AMI.: string",
"required": false,
"schema": {
"title": "kernelId",
"type": "string"
}
},
{
"name": "keyName",
"type": "string",
"info": "Filter the server list result by keypair name.: string",
"required": false,
"schema": {
"title": "keyName",
"type": "string"
}
},
{
"name": "launchIndex",
"type": "number",
"info": "Filter the server list result by the sequence in which the servers were launched.: 123",
"required": false,
"schema": {
"title": "launchIndex",
"type": "number"
}
},
{
"name": "launchedAt",
"type": "string",
"info": "Filter the server list result by a date and time stamp when the instance was launched. The date and time stamp format is ISO 8601:: string",
"required": false,
"schema": {
"title": "launchedAt",
"type": "string"
}
},
{
"name": "limit",
"type": "number",
"info": "Requests a page size of items. Returns a number of items up to a limit value. Use the limit parameter to make an initial limited request and use the ID of the last-seen i...(description truncated): 123",
"required": false,
"schema": {
"title": "limit",
"type": "number"
}
},
{
"name": "lockedBy",
"type": "string",
"info": "Filter the server list result by who locked the server, possible value could be admin or owner.: string",
"required": false,
"schema": {
"title": "lockedBy",
"type": "string"
}
},
{
"name": "marker",
"type": "string",
"info": "The ID of the last-seen item. Use the limit parameter to make an initial limited request and use the ID of the last-seen item from the response as the marker parameter va...(description truncated): string",
"required": false,
"schema": {
"title": "marker",
"type": "string"
}
},
{
"name": "name",
"type": "string",
"info": "Filters the response by a server name, as a string. You can use regular expressions in the query. For example, the ?name=bob regular expression returns both bob and bobb....(description truncated): string",
"required": false,
"schema": {
"title": "name",
"type": "string"
}
},
{
"name": "node",
"type": "string",
"info": "Filter the server list result by the node.: string",
"required": false,
"schema": {
"title": "node",
"type": "string"
}
},
{
"name": "powerState",
"type": "number",
"info": "Filter the server list result by server power state.: 123",
"required": false,
"schema": {
"title": "powerState",
"type": "number"
}
},
{
"name": "progress",
"type": "number",
"info": "Filter the server list result by the progress of the server. The value could be from 0 to 100 as integer.: 123",
"required": false,
"schema": {
"title": "progress",
"type": "number"
}
},
{
"name": "projectId",
"type": "string",
"info": "Filter the list of servers by the given project ID.: string",
"required": false,
"schema": {
"title": "projectId",
"type": "string"
}
},
{
"name": "ramdiskId",
"type": "string",
"info": "Filter the server list result by the UUID of the ramdisk image when using an AMI.: string",
"required": false,
"schema": {
"title": "ramdiskId",
"type": "string"
}
},
{
"name": "reservationId",
"type": "string",
"info": "A reservation id as returned by a servers multiple create call.: string",
"required": false,
"schema": {
"title": "reservationId",
"type": "string"
}
},
{
"name": "rootDeviceName",
"type": "string",
"info": "Filter the server list result by the root device name of the server.: string",
"required": false,
"schema": {
"title": "rootDeviceName",
"type": "string"
}
},
{
"name": "softDeleted",
"type": "boolean",
"info": "Filter the server list by SOFT_DELETED status. This parameter is only valid when the deleted=True filter parameter is specified.: boolean",
"required": false,
"schema": {
"title": "softDeleted",
"type": "boolean"
}
},
{
"name": "sortDir",
"type": "string",
"info": "Sort direction. A valid value is asc (ascending) or desc (descending). Default is desc. You can specify multiple pairs of sort key and sort direction query parameters. If...(description truncated): string",
"required": false,
"schema": {
"title": "sortDir",
"type": "string"
}
},
{
"name": "sortKey",
"type": "string",
"info": "Sorts by a server attribute. Default attribute is created_at. You can specify multiple pairs of sort key and sort direction query parameters. If you omit the sort directi...(description truncated): string",
"required": false,
"schema": {
"title": "sortKey",
"type": "string"
}
},
{
"name": "status",
"type": "string",
"info": "Filters the response by a server status, as a string. For example, ACTIVE.: string",
"required": false,
"schema": {
"title": "status",
"type": "string"
}
},
{
"name": "taskState",
"type": "string",
"info": "Filter the server list result by task state.: string",
"required": false,
"schema": {
"title": "taskState",
"type": "string"
}
},
{
"name": "terminatedAt",
"type": "string",
"info": "Filter the server list result by a date and time stamp when instance was terminated. The date and time stamp format is ISO 8601:: string",
"required": false,
"schema": {
"title": "terminatedAt",
"type": "string"
}
},
{
"name": "userId",
"type": "string",
"info": "Filter the list of servers by the given user ID.: string",
"required": false,
"schema": {
"title": "userId",
"type": "string"
}
},
{
"name": "uuid",
"type": "string",
"info": "Filter the server list result by the UUID of the server.: string",
"required": false,
"schema": {
"title": "uuid",
"type": "string"
}
},
{
"name": "vmState",
"type": "string",
"info": "Filter the server list result by vm state.: string",
"required": false,
"schema": {
"title": "vmState",
"type": "string"
}
},
{
"name": "notTags",
"type": "string",
"info": "A list of tags to filter the server list by. Servers that don’t match all tags in this list will be returned. Boolean expression in this case is ‘NOT (t1 AND t2)’. Tags i...(description truncated): string",
"required": false,
"schema": {
"title": "notTags",
"type": "string"
}
},
{
"name": "notTagsAny",
"type": "string",
"info": "A list of tags to filter the server list by. Servers that don’t match any tags in this list will be returned. Boolean expression in this case is ‘NOT (t1 OR t2)’. Tags in...(description truncated): string",
"required": false,
"schema": {
"title": "notTagsAny",
"type": "string"
}
},
{
"name": "tags",
"type": "string",
"info": "A list of tags to filter the server list by. Servers that match all tags in this list will be returned. Boolean expression in this case is ‘t1 AND t2’. Tags in query must...(description truncated): string",
"required": false,
"schema": {
"title": "tags",
"type": "string"
}
},
{
"name": "tagsAny",
"type": "string",
"info": "A list of tags to filter the server list by. Servers that match any tag in this list will be returned. Boolean expression in this case is ‘t1 OR t2’. Tags in query must b...(description truncated): string",
"required": false,
"schema": {
"title": "tagsAny",
"type": "string"
}
},
{
"name": "changesBefore",
"type": "string",
"info": "Filters the response by a date and time stamp when the server last changed. Those servers that changed before or equal to the specified date and time stamp are returned. ...(description truncated): string",
"required": false,
"schema": {
"title": "changesBefore",
"type": "string"
}
},
{
"name": "locked",
"type": "boolean",
"info": "Specify the locked query parameter to list all locked or unlocked instances. If the value is specified, 1, t, true, on, y and yes are treated as True. 0, f, false, off, n...(description truncated): boolean",
"required": false,
"schema": {
"title": "locked",
"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": "/listServers"
},
"task": true
},
{
"name": "createServer",
"summary": "Create Server",
"description": "Create Server",
"input": [
{
"name": "body",
"type": "object",
"info": ": object",
"required": false,
"schema": {
"definitions": {}
}
}
],
"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": "/createServer"
},
"task": true
},
{
"name": "listServersDetailed",
"summary": "List Servers Detailed",
"description": "List Servers Detailed",
"input": [
{
"name": "accessIpV4",
"type": "string",
"info": "Filter server list result by IPv4 address that should be used to access the server.: string",
"required": false,
"schema": {
"title": "accessIpV4",
"type": "string"
}
},
{
"name": "accessIpV6",
"type": "string",
"info": "Filter server list result by IPv6 address that should be used to access the server.: string",
"required": false,
"schema": {
"title": "accessIpV6",
"type": "string"
}
},
{
"name": "allTenants",
"type": "boolean",
"info": "Specify the all_tenants query parameter to list all instances for all projects. By default this is only allowed by administrators. If this parameter is specified without ...(description truncated): boolean",
"required": false,
"schema": {
"title": "allTenants",
"type": "boolean"
}
},
{
"name": "autoDiskConfig",
"type": "string",
"info": "Filter the server list result by the disk_config setting of the server, Valid values are:: string",
"required": false,
"schema": {
"title": "autoDiskConfig",
"type": "string"
}
},
{
"name": "availabilityZone",
"type": "string",
"info": "Filter the server list result by server availability zone.: string",
"required": false,
"schema": {
"title": "availabilityZone",
"type": "string"
}
},
{
"name": "changesSince",
"type": "string",
"info": "Filters the response by a date and time stamp when the server last changed status. To help keep track of changes this may also return recently deleted servers.: string",
"required": false,
"schema": {
"title": "changesSince",
"type": "string"
}
},
{
"name": "configDrive",
"type": "string",
"info": "Filter the server list result by the config drive setting of the server.: string",
"required": false,
"schema": {
"title": "configDrive",
"type": "string"
}
},
{
"name": "createdAt",
"type": "string",
"info": "Filter the server list result by a date and time stamp when server was created.: string",
"required": false,
"schema": {
"title": "createdAt",
"type": "string"
}
},
{
"name": "deleted",
"type": "boolean",
"info": "Show deleted items only. In some circumstances deleted items will still be accessible via the backend database, however there is no contract on how long, so this paramete...(description truncated): boolean",
"required": false,
"schema": {
"title": "deleted",
"type": "boolean"
}
},
{
"name": "description",
"type": "string",
"info": "Filter the server list result by description.: string",
"required": false,
"schema": {
"title": "description",
"type": "string"
}
},
{
"name": "flavor",
"type": "string",
"info": "Filters the response by a flavor, as a UUID. A flavor is a combination of memory, disk size, and CPUs.: string",
"required": false,
"schema": {
"title": "flavor",
"type": "string"
}
},
{
"name": "host",
"type": "string",
"info": "Filter the server list result by the host name of compute node.: string",
"required": false,
"schema": {
"title": "host",
"type": "string"
}
},
{
"name": "hostname",
"type": "string",
"info": "Filter the server list result by the host name of server.: string",
"required": false,
"schema": {
"title": "hostname",
"type": "string"
}
},
{
"name": "image",
"type": "string",
"info": "Filters the response by an image, as a UUID.: string",
"required": false,
"schema": {
"title": "image",
"type": "string"
}
},
{
"name": "ip",
"type": "string",
"info": "An IPv4 address to filter results by.: string",
"required": false,
"schema": {
"title": "ip",
"type": "string"
}