@itentialopensource/adapter-openstack_neutron
Version:
This adapter integrates with system described as: Openstack Networking (Neutron) Service
1,769 lines • 509 kB
JSON
{
"id": "@itentialopensource/adapter-openstack_neutron",
"type": "Adapter",
"export": "OpenstackNeutron",
"title": "Openstack_neutron",
"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": "listAPIVersions",
"summary": "List API versions",
"description": "List API versions",
"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": "/listAPIVersions"
},
"task": true
},
{
"name": "showAPIV2Details",
"summary": "Show API v2 details",
"description": "Show API v2 details",
"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": "/showAPIV2Details"
},
"task": true
},
{
"name": "listExtensions",
"summary": "List extensions",
"description": "List extensions",
"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": "/listExtensions"
},
"task": true
},
{
"name": "showExtensionDetails",
"summary": "Show extension details",
"description": "Show extension details",
"input": [
{
"name": "alias",
"type": "string",
"info": "The alias of an extension.: string",
"required": true,
"schema": {
"title": "alias",
"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": "/showExtensionDetails"
},
"task": true
},
{
"name": "showNetworkDetails",
"summary": "Show network details",
"description": "Show network details",
"input": [
{
"name": "fields",
"type": "string",
"info": "The fields that you want the server to return.\nIf no fields query parameter is specified,\nthe networking API returns all attributes allowed by the policy settings.\nBy usi...(description truncated): string",
"required": false,
"schema": {
"title": "fields",
"type": "string"
}
},
{
"name": "networkId",
"type": "string",
"info": "The ID of the network.: string",
"required": true,
"schema": {
"title": "networkId",
"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": "/showNetworkDetails"
},
"task": true
},
{
"name": "updateNetwork",
"summary": "Update network",
"description": "Update network",
"input": [
{
"name": "networkId",
"type": "string",
"info": "The ID of the network.: string",
"required": true,
"schema": {
"title": "networkId",
"type": "string"
}
},
{
"name": "body",
"type": "object",
"info": ": {\"network\": {\"dns_domain\": \"string\", \"name\": \"string\", \"qos_policy_id\": \"string\", \"mtu\": 123}}",
"required": false,
"schema": {
"type": "object",
"properties": {
"network": {
"type": "object",
"properties": {
"dns_domain": {
"type": "string"
},
"name": {
"type": "string"
},
"qos_policy_id": {
"type": "string"
},
"mtu": {
"type": "integer"
}
}
}
},
"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": "/updateNetwork"
},
"task": true
},
{
"name": "deleteNetwork",
"summary": "Delete network",
"description": "Delete network",
"input": [
{
"name": "networkId",
"type": "string",
"info": "The ID of the network.: string",
"required": true,
"schema": {
"title": "networkId",
"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": "/deleteNetwork"
},
"task": true
},
{
"name": "listNetworks",
"summary": "List networks",
"description": "List networks",
"input": [
{
"name": "adminStateUp",
"type": "boolean",
"info": "Filter the list result by the administrative state of the resource,\nwhich is up (true) or down (false).: boolean",
"required": false,
"schema": {
"title": "adminStateUp",
"type": "boolean"
}
},
{
"name": "id",
"type": "string",
"info": "Filter the list result by the ID of the resource.: string",
"required": false,
"schema": {
"title": "id",
"type": "string"
}
},
{
"name": "mtu",
"type": "number",
"info": "Filter the network list result by the maximum transmission unit (MTU)\nvalue to address fragmentation. Minimum value is 68 for IPv4,\nand 1280 for IPv6.: 123",
"required": false,
"schema": {
"title": "mtu",
"type": "number"
}
},
{
"name": "name",
"type": "string",
"info": "Filter the list result by the human-readable name of the resource.: string",
"required": false,
"schema": {
"title": "name",
"type": "string"
}
},
{
"name": "projectId",
"type": "string",
"info": "Filter the list result by the ID of the project that owns the resource.: string",
"required": false,
"schema": {
"title": "projectId",
"type": "string"
}
},
{
"name": "providerNetworkType",
"type": "string",
"info": "Filter the list result by the type of physical network that this\nnetwork/segment is mapped to. For example, flat, vlan, vxlan,\nor gre. Valid values depend on a networking...(description truncated): string",
"required": false,
"schema": {
"title": "providerNetworkType",
"type": "string"
}
},
{
"name": "providerPhysicalNetwork",
"type": "string",
"info": "Filter the list result by the physical network where\nthis network/segment is implemented.: string",
"required": false,
"schema": {
"title": "providerPhysicalNetwork",
"type": "string"
}
},
{
"name": "providerSegmentationId",
"type": "number",
"info": "Filter the list result by the ID of the isolated segment\non the physical network.: 123",
"required": false,
"schema": {
"title": "providerSegmentationId",
"type": "number"
}
},
{
"name": "revisionNumber",
"type": "number",
"info": "Filter the list result by the revision number of the resource.: 123",
"required": false,
"schema": {
"title": "revisionNumber",
"type": "number"
}
},
{
"name": "routerExternal",
"type": "boolean",
"info": "Filter the network list result based on whether the network has an\nexternal routing facility that’s not managed by the networking service.: boolean",
"required": false,
"schema": {
"title": "routerExternal",
"type": "boolean"
}
},
{
"name": "shared",
"type": "boolean",
"info": "Filter the network list result based on if the network is shared across\nall tenants.: boolean",
"required": false,
"schema": {
"title": "shared",
"type": "boolean"
}
},
{
"name": "status",
"type": "string",
"info": "Filter the network list result by network status. Values are ACTIVE,\nDOWN, BUILD or ERROR.: string",
"required": false,
"schema": {
"title": "status",
"type": "string"
}
},
{
"name": "tenantId",
"type": "string",
"info": "Filter the list result by the ID of the project that owns the resource.: string",
"required": false,
"schema": {
"title": "tenantId",
"type": "string"
}
},
{
"name": "vlanTransparent",
"type": "boolean",
"info": "Filter the network list by the VLAN transparency mode of the network,\nwhich is VLAN transparent (true) or not VLAN transparent (false).: boolean",
"required": false,
"schema": {
"title": "vlanTransparent",
"type": "boolean"
}
},
{
"name": "description",
"type": "string",
"info": "Filter the list result by the human-readable description of the resource.: string",
"required": false,
"schema": {
"title": "description",
"type": "string"
}
},
{
"name": "isDefault",
"type": "boolean",
"info": "Filter the network list result based on if the network is default pool\nor not.: boolean",
"required": false,
"schema": {
"title": "isDefault",
"type": "boolean"
}
},
{
"name": "tags",
"type": "string",
"info": "A list of tags to filter the list result by.\nResources that match all tags in this list will be returned.\nTags in query must be separated by comma.: string",
"required": false,
"schema": {
"title": "tags",
"type": "string"
}
},
{
"name": "tagsAny",
"type": "string",
"info": "A list of tags to filter the list result by.\nResources that match any tag in this list will be returned.\nTags in query must be separated by comma.: string",
"required": false,
"schema": {
"title": "tagsAny",
"type": "string"
}
},
{
"name": "notTags",
"type": "string",
"info": "A list of tags to filter the list result by.\nResources that match all tags in this list will be excluded.\nTags in query must be separated by comma.: string",
"required": false,
"schema": {
"title": "notTags",
"type": "string"
}
},
{
"name": "notTagsAny",
"type": "string",
"info": "A list of tags to filter the list result by.\nResources that match any tag in this list will be excluded.\nTags in query must be separated by comma.: string",
"required": false,
"schema": {
"title": "notTagsAny",
"type": "string"
}
},
{
"name": "sortDir",
"type": "string",
"info": "Sort direction. A valid value is asc (ascending) or desc\n(descending). You can specify multiple pairs of sort key and\nsort direction query parameters.: string",
"required": false,
"schema": {
"title": "sortDir",
"type": "string"
}
},
{
"name": "sortKey",
"type": "string",
"info": "Sorts by a network attribute. You can specify multiple pairs of sort key\nand sort direction query parameters. The sort keys are limited to:: string",
"required": false,
"schema": {
"title": "sortKey",
"type": "string"
}
},
{
"name": "fields",
"type": "string",
"info": "The fields that you want the server to return.\nIf no fields query parameter is specified,\nthe networking API returns all attributes allowed by the policy settings.\nBy usi...(description truncated): string",
"required": false,
"schema": {
"title": "fields",
"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": "/listNetworks"
},
"task": true
},
{
"name": "createNetwork",
"summary": "Create network",
"description": "Create network",
"input": [
{
"name": "body",
"type": "object",
"info": ": {\"network\": {\"admin_state_up\": \"boolean\", \"name\": \"string\", \"provider:network_type\": \"string\", \"provider:physical_network\": \"string\", \"provider:segmentation_id\": 123, \"qos_policy_id\": \"string\"}}",
"required": false,
"schema": {
"type": "object",
"properties": {
"network": {
"type": "object",
"properties": {
"admin_state_up": {
"type": "boolean"
},
"name": {
"type": "string"
},
"provider:network_type": {
"type": "string"
},
"provider:physical_network": {
"type": "string"
},
"provider:segmentation_id": {
"type": "integer"
},
"qos_policy_id": {
"type": "string"
}
}
}
},
"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": "/createNetwork"
},
"task": true
},
{
"name": "showNetworkSegmentRangeDetails",
"summary": "Show network segment range details",
"description": "Show network segment range details",
"input": [
{
"name": "networkSegmentRangeId",
"type": "string",
"info": "The ID of the network segment range.: string",
"required": true,
"schema": {
"title": "networkSegmentRangeId",
"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": "/showNetworkSegmentRangeDetails"
},
"task": true
},
{
"name": "updateNetworkSegmentRange",
"summary": "Update network segment range",
"description": "Update network segment range",
"input": [
{
"name": "tags",
"type": "string",
"info": "A list of tags to filter the list result by.\nResources that match all tags in this list will be returned.\nTags in query must be separated by comma.: string",
"required": false,
"schema": {
"title": "tags",
"type": "string"
}
},
{
"name": "tagsAny",
"type": "string",
"info": "A list of tags to filter the list result by.\nResources that match any tag in this list will be returned.\nTags in query must be separated by comma.: string",
"required": false,
"schema": {
"title": "tagsAny",
"type": "string"
}
},
{
"name": "notTags",
"type": "string",
"info": "A list of tags to filter the list result by.\nResources that match all tags in this list will be excluded.\nTags in query must be separated by comma.: string",
"required": false,
"schema": {
"title": "notTags",
"type": "string"
}
},
{
"name": "notTagsAny",
"type": "string",
"info": "A list of tags to filter the list result by.\nResources that match any tag in this list will be excluded.\nTags in query must be separated by comma.: string",
"required": false,
"schema": {
"title": "notTagsAny",
"type": "string"
}
},
{
"name": "networkSegmentRangeId",
"type": "string",
"info": "The ID of the network segment range.: string",
"required": true,
"schema": {
"title": "networkSegmentRangeId",
"type": "string"
}
},
{
"name": "body",
"type": "object",
"info": ": {\"network_segment_range\": {\"name\": \"string\", \"minimum\": 123, \"maximum\": 123, \"description\": \"string\"}}",
"required": false,
"schema": {
"type": "object",
"properties": {
"network_segment_range": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"minimum": {
"type": "integer"
},
"maximum": {
"type": "integer"
},
"description": {
"type": "string"
}
}
}
},
"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": "/updateNetworkSegmentRange"
},
"task": true
},
{
"name": "deleteNetworkSegmentRange",
"summary": "Delete network segment range",
"description": "Delete network segment range",
"input": [
{
"name": "networkSegmentRangeId",
"type": "string",
"info": "The ID of the network segment range.: string",
"required": true,
"schema": {
"title": "networkSegmentRangeId",
"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": "/deleteNetworkSegmentRange"
},
"task": true
},
{
"name": "listNetworkSegmentRanges",
"summary": "List network segment ranges",
"description": "List network segment ranges",
"input": [
{
"name": "id",
"type": "string",
"info": "Filter the network segment range list result based on the range ID.: string",
"required": false,
"schema": {
"title": "id",
"type": "string"
}
},
{
"name": "name",
"type": "string",
"info": "Filter the network segment range list result based on the name of the\nrange.: string",
"required": false,
"schema": {
"title": "name",
"type": "string"
}
},
{
"name": "tenantId",
"type": "string",
"info": "Filter the list result by the ID of the project that owns the resource.: string",
"required": false,
"schema": {
"title": "tenantId",
"type": "string"
}
},
{
"name": "projectId",
"type": "string",
"info": "Filter the list result by the ID of the project that owns the resource.: string",
"required": false,
"schema": {
"title": "projectId",
"type": "string"
}
},
{
"name": "networkType",
"type": "string",