{ "id": "@itentialopensource/adapter-vmware_vsphere", "type": "Adapter", "export": "VmwareVsphere", "title": "Vmware_vsphere", "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": "getConsoleCLIAccess", "summary": "get Console CLI Access", "description": "get Console CLI Access", "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": "/getConsoleCLIAccess" }, "task": true }, { "name": "uodateConsoleCLIAccess", "summary": "uodate Console CLI Access", "description": "uodate Console CLI Access", "input": [ { "name": "body", "type": "object", "info": ": {\"enabled\": \"boolean\"}", "required": true, "schema": { "title": "ConsoleCLI-disableRequest", "required": [ "enabled" ], "type": "object", "properties": { "enabled": { "type": "boolean" } }, "example": { "enabled": 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": "/uodateConsoleCLIAccess" }, "task": true }, { "name": "getDCUIAccess", "summary": "get DCUI Access", "description": "get DCUI Access", "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": "/getDCUIAccess" }, "task": true }, { "name": "uodateDCUIAccess", "summary": "uodate DCUI Access", "description": "uodate DCUI Access", "input": [ { "name": "body", "type": "object", "info": ": {\"enabled\": \"boolean\"}", "required": true, "schema": { "title": "DCUI-disableRequest", "required": [ "enabled" ], "type": "object", "properties": { "enabled": { "type": "boolean" } }, "example": { "enabled": 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": "/uodateDCUIAccess" }, "task": true }, { "name": "getShellAccess", "summary": "get Shell Access", "description": "get Shell Access", "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": "/getShellAccess" }, "task": true }, { "name": "uodateShellAccess", "summary": "uodate Shell Access", "description": "uodate Shell Access", "input": [ { "name": "body", "type": "object", "info": ": {\"config\": {\"enabled\": \"boolean\", \"timeout\": 123}}", "required": true, "schema": { "title": "Shell-disableRequest", "required": [ "config" ], "type": "object", "properties": { "config": { "title": "Config", "required": [ "enabled", "timeout" ], "type": "object", "properties": { "enabled": { "type": "boolean" }, "timeout": { "type": "integer", "format": "int32" } }, "example": { "enabled": false, "timeout": 1 } } }, "example": { "config": { "enabled": false, "timeout": 1 } } } } ], "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": "/uodateShellAccess" }, "task": true }, { "name": "getSSHAccess", "summary": "get SSH Access", "description": "get SSH Access", "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": "/getSSHAccess" }, "task": true }, { "name": "updateSSHAccess", "summary": "update SSH Access", "description": "update SSH Access", "input": [ { "name": "body", "type": "object", "info": ": {\"enabled\": \"boolean\"}", "required": true, "schema": { "title": "SSH-disableRequest", "required": [ "enabled" ], "type": "object", "properties": { "enabled": { "type": "boolean" } }, "example": { "enabled": 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": "/updateSSHAccess" }, "task": true }, { "name": "getApplianceServicesHealth", "summary": "get Appliance services health", "description": "get Appliance services health", "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": "/getApplianceServicesHealth" }, "task": true }, { "name": "getDatabaseStorageHealth", "summary": "get Database storage health", "description": "get Database storage health", "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": "/getDatabaseStorageHealth" }, "task": true }, { "name": "getLoadHealth", "summary": "get Load Health", "description": "get Load Health", "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": "/getLoadHealth" }, "task": true }, { "name": "getMemoryHealth", "summary": "get Memory Health", "description": "get Memory Health", "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": "/getMemoryHealth" }, "task": true }, { "name": "getSoftwarePackagesHealth", "summary": "get Software packages health", "description": "get Software packages health", "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": "/getSoftwarePackagesHealth" }, "task": true }, { "name": "getStorageHealth", "summary": "get Storage health", "description": "get Storage health", "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": "/getStorageHealth" }, "task": true }, { "name": "getSwapHealth", "summary": "get Swap health", "description": "get Swap health", "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": "/getSwapHealth" }, "task": true }, { "name": "getSystemHealth", "summary": "get System health", "description": "get System health", "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": "/getSystemHealth" }, "task": true }, { "name": "getSystemLastcheckHealth", "summary": "get System lastcheck health", "description": "get System lastcheck health", "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": "/getSystemLastcheckHealth" }, "task": true }, { "name": "listMonitoring", "summary": "List Monitoring", "description": "List Monitoring", "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": "/listMonitoring" }, "task": true }, { "name": "getMonitoringDetails", "summary": "get Monitoring Details", "description": "get Monitoring Details", "input": [ { "name": "item", "type": "string", "info": "id of item: string", "required": true, "schema": { "title": "item", "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": "/getMonitoringDetails" }, "task": true }, { "name": "queryMonitoringStats", "summary": "Query Monitoring stats", "description": "Query Monitoring stats", "input": [ { "name": "itemInterval", "type": "string", "info": ": string", "required": true, "schema": { "title": "itemInterval", "type": "string" } }, { "name": "itemEndTime", "type": "string", "info": ": string", "required": true, "schema": { "title": "itemEndTime", "type": "string" } }, { "name": "itemNames1", "type": "string", "info": ": string", "required": true, "schema": { "title": "itemNames1", "type": "string" } }, { "name": "itemNames2", "type": "string", "info": ": string", "required": true, "schema": { "title": "itemNames2", "type": "string" } }, { "name": "itemStartTime", "type": "string", "info": ": string", "required": true, "schema": { "title": "itemStartTime", "type": "string" } }, { "name": "itemFunction", "type": "string", "info": ": string", "required": true, "schema": { "title": "itemFunction", "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": "/queryMonitoringStats" }, "task": true }, { "name": "getSNMPConfiguration", "summary": "Return an SNMP agent configuration.", "description": "Return an SNMP agent configuration.", "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": "/getSNMPConfiguration" }, "task": true }, { "name": "setSNMPConfiguration", "summary": "Set SNMP configuration", "description": "Set SNMP configuration.", "input": [ { "name": "body", "type": "object", "info": ": {\"config\": {\"authentication\": \"string\", \"communities\": \"array\", \"engineid\": \"string\", \"loglevel\": \"string\", \"notraps\": \"array\", \"port\": 123, \"privacy\": \"string\", \"remoteusers\": \"array\", \"syscontact\": \"string\", \"syslocation\": \"string\", \"targets\": \"array\", \"users\": \"array\", \"v3targets\": \"array\"}}", "required": true, "schema": { "title": "SetSNMPconfigurationRequest", "required": [ "config" ], "type": "object", "properties": { "config": { "title": "Config7", "required": [ "authentication", "communities", "engineid", "loglevel", "notraps", "port", "privacy", "remoteusers", "syscontact", "syslocation", "targets", "users", "v3targets" ], "type": "object", "properties": { "authentication": { "type": "string" }, "communities": { "type": "array", "items": { "type": "string" }, "description": "" }, "engineid": { "type": "string" }, "loglevel": { "type": "string" }, "notraps": { "type": "array", "items": { "type": "string" }, "description": "" }, "port": { "type": "integer", "format": "int32" }, "privacy": { "type": "string" }, "remoteusers": { "type": "array", "items": { "type": "string" }, "description": "" }, "syscontact": { "type": "string" }, "syslocation": { "type": "string" }, "targets": { "type": "array", "items": { "type": "string" }, "description": "" }, "users": { "type": "array", "items": { "type": "string" }, "description": "" }, "v3targets": { "type": "array", "items": { "type": "string" }, "description": "" } }, "example": { "authentication": "none", "communities": [ "string", "bstring" ], "engineid": "string", "loglevel": "string", "notraps": [ "string", "bstring" ], "port": 1, "privacy": "AES128", "remoteusers": [ "string", "bstring" ], "syscontact": "string", "syslocation": "string", "targets": [ "string", "bstring" ], "users": [ "string", "bstring" ], "v3targets": [ "string", "bstring" ] } } }, "example": { "config": { "authentication": "none", "communities": [ "string", "bstring" ], "engineid": "string", "loglevel": "string", "notraps": [ "string", "bstring" ], "port": 1, "privacy": "AES128", "remoteusers": [ "string", "bstring" ], "syscontact": "string", "syslocation": "string", "targets": [ "string", "bstring" ], "users": [ "string", "bstring" ], "v3targets": [ "string", "bstring" ] } } } } ], "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": "/setSNMPConfiguration" }, "task": true }, { "name": "enableSNMP", "summary": "Start a disabled SNMP agent.", "description": "Start a disabled SNMP agent.", "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": "/enableSNMP" }, "task": true }, { "name": "disableSNMP", "summary": "Stop an enabled SNMP agent.", "description": "Stop an enabled SNMP agent.", "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": "/disableSNMP" }, "task": true }, { "name": "getSNMPStats", "summary": "Generate diagnostics report for snmp agent.", "description": "Generate diagnostics report for snmp agent.", "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": "/getSNMPStats" }, "task": true }, { "name": "testSNMP", "summary": "Send a warmStart notification to all configured traps and inform destinations (see RFC 3418).", "description": "Send a warmStart notification to all configured traps and inform destinations (see RFC 3418).", "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": "/testSNMP" }, "task": true }, { "name": "generateSNMPHash", "summary": "Generate localized keys for secure SNMPv3 communications.", "description": "Generate localized keys for secure SNMPv3 communications.", "input": [ { "name": "body", "type": "object", "info": ": {\"config\": {\"auth_hash\": \"string\", \"priv_hash\": \"string\", \"raw_secret\": \"boolean\"}}", "required": true, "schema": { "title": "GeneratehashRequest", "required": [ "config" ], "type": "object", "properties": { "config": { "title": "Config6", "required": [ "auth_hash", "priv_hash", "raw_secret" ], "type": "object", "properties": { "auth_hash": { "type": "string" }, "priv_hash": { "type": "string" }, "raw_secret": { "type": "boolean" } }, "example": { "auth_hash": "string", "priv_hash": "string", "raw_secret": true } } }, "example": { "config": { "auth_hash": "string", "priv_hash": "string", "raw_secret": true } } } } ], "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": "/generateSNMPHash" }, "task": true }, { "name": "resetSNMPFactorySettings", "summary": "Restore settings to factory defaults.", "description": "Restore settings to factory defaults.", "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": "/resetSNMPFactorySettings" }, "task": true }, { "name": "getSNMPLimits", "summary": "Get SNMP limits", "description": "Get SNMP limits information.", "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": "/getSNMPLimits" }, "task": true }, { "name": "getDNSSearchDomains", "summary": "DNS search domains", "description": "DNS search domains", "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": "/getDNSSearchDomains" }, "task": true }, { "name": "setDNSSEARCHDomain", "summary": "Set DNS Search Domains", "description": "Set DNS Search Domains", "input": [ { "name": "body", "type": "object", "info": ": {\"domains\": \"array\"}", "required": true, "schema": { "title": "DomainssetRequest", "required": [ "domains" ], "type": "object", "properties": { "domains": { "type": "array", "items": { "type": "string" }, "description": "" } }, "example": { "domains": [ "vmware.com" ] } } } ], "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": "/setDNSSEARCHDomain" }, "task": true }, { "name": "addDNSSearchDomain", "summary": "Add DNS Search Domain", "description": "Add DNS Search Domain", "input": [ { "name": "body", "type": "object", "info": ": {\"domain\": \"string\"}", "required": true, "schema": { "title": "DomainsaddRequest", "required": [ "domain" ], "type": "object", "properties": { "domain": { "type": "string" } }, "example": { "domain": "myvmware.com" } } } ], "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": "/addDNSSearchDomain" }, "task": true }, { "name": "getDomainName", "summary": "Get the Fully Qualified Doman Name.", "description": "Get the Fully Qualified Doman Name.", "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": "/getDomainName" }, "task": true }, { "name": "setDomainName", "summary": "Set the Fully Qualified Domain Name.", "description": "Set the Fully Qualified Domain Name.", "input": [ { "name": "body", "type": "object", "info": ": {\"name\": \"string\"}", "required": true, "schema": { "title": "Hostname-setRequest", "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string" } }, "example": { "name": "{{appliance_hostname}}" } } } ], "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": "/setDomainName" }, "task": true }, { "name": "testDomainName", "summary": "Test the Fully Qualified Domain Name.", "description": "Test the Fully Qualified Domain Name.", "input": [ { "name": "body", "type": "object", "info": ": {\"name\": \"string\"}", "required": true, "schema": { "title": "Hostname-testRequest", "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string" } }, "example": { "name": "{{appliance_hostname}}" } } } ], "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": "/testDomainName" }, "task": true }, { "name": "getDNSservers", "summary": "get DNS servers", "description": "get DNS servers", "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": "/getDNSservers" }, "task": true }, { "name": "addDNSserver", "summary": "add DNS servers", "description": "add DNS servers", "input": [ { "name": "body", "type": "object", "info": ": {\"server\": \"string\"}", "required": true, "schema": { "title": "DNSservers-addRequest", "required": [ "server" ], "type": "object", "properties": { "server": { "type": "string" } }, "example": { "server": "serverB" } } } ], "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": "/addDNSserver" }, "task": true }, { "name": "updateDNSserver", "summary": "update DNS servers", "description": "update DNS servers", "input": [ { "name": "body", "type": "object", "info": ": {\"config\": {\"mode\": \"string\", \"servers\": \"array\"}}", "required": true, "schema": { "title": "DNSservers-setRequest", "required": [ "config" ], "type": "object", "properties": { "config": { "title": "Config2", "required": [ "mode", "servers" ], "type": "object", "properties": { "mode": { "type": "string" }, "servers": { "type": "array", "items": { "type": "string" }, "description": "" } }, "example": { "mode": "is_static", "servers": [ "serverA", "serverB" ] } } }, "example": { "config": { "mode": "is_static", "servers": [ "serverA", "serverB" ] } } } } ], "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": "/updateDNSserver" }, "task": true }, { "name": "testDNSservers", "summary": "Test if dns servers are reachable.", "description": "Test if dns servers are reachable.", "input": [ { "name": "body", "type": "object", "info": ": {\"servers\": \"array\"}", "required": true, "schema": { "title": "DNSservers-testRequest", "required": [ "servers" ], "type": "object", "properties": { "servers": { "type": "array", "items": { "type": "string" }, "description": "" } }, "example": { "servers": [ "{{appliance_dns_a}}" ] } } } ], "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": "/testDNSservers" }, "task": true }, { "name": "getInterfaces", "summary": "get Interfaces", "description": "get Interfaces", "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": "/getInterfaces" }, "task": true }, { "name": "getInterfaceDetails", "summary": "Get information about a particular network interface.", "description": "Get information about a particular network interface.", "input": [ { "name": "interfaceParam", "type": "string", "info": "id of interface: string", "required": true, "schema": { "title": "interfaceParam", "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": "/getInterfaceDetails" }, "task": true }, { "name": "getIPv4", "summary": "get IPv4", "description": "get IPv4", "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": "/getIPv4" }, "task": true }, { "name": "setIPv4", "summary": "set IPv4", "description": "set IPv4", "input": [ { "name": "body", "type": "object", "info": ": {\"config\": [{\"address\": \"string\", \"default_gateway\": \"string\", \"interface_name\": \"string\", \"mode\": \"string\", \"prefix\": 123}]}", "required": true, "schema": { "title": "IPv4-setRequest", "required": [ "config" ], "type": "object", "properties": { "config": { "type": "array", "items": { "title": "Config4", "required": [ "address", "default_gateway", "interface_name", "mode", "prefix" ], "type": "object", "properties": { "address": { "type": "string" }, "default_gateway": { "type": "string" }, "interface_name": { "type": "string" }, "mode": { "type": "string" }, "prefix": { "type": "integer", "format": "int32" } }, "example": { "address": "string", "default_gateway": "string", "interface_name": "string", "mode": "dhcp", "prefix": 1 } }, "description": "" } }, "example": { "config": [ { "address": "string", "default_gateway": "string", "interface_name": "string", "mode": "dhcp", "prefix": 1 } ] } } } ], "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": "/setIPv4" }, "task": true }, { "name": "getIPv4Details", "summary": "set IPv4", "description": "set IPv4", "input": [ { "name": "body", "type": "object", "info": ": {\"interfaces\": \"array\"}", "required": true, "schema": { "title": "IPv4-detailsRequest", "required": [ "interfaces" ], "type": "object", "properties": { "interfaces": { "type": "array", "items": { "type": "string" }, "description": "" } }, "example": { "interfaces": [ "nic0" ] } } } ], "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": "/getIPv4Details" }, "task": true }, { "name": "renewIPv4", "summary": "renew IPv4", "description": "renew IPv4", "input": [ { "name": "body", "type": "object", "info": ": {\"interfaces\": \"array\"}", "required": true, "schema": { "title": "IPv4-renewRequest", "required": [ "interfaces" ], "type": "object", "properties": { "interfaces": { "type": "array", "items": { "type": "string" }, "description": "" } }, "example": { "interfaces": [ "nic0" ] } } } ], "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": "/renewIPv4" }, "task": true }, { "name": "getIPv6", "summary": "Get IPv6", "description": "Get IPv6", "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": "/getIPv6" }, "task": true }, { "name": "setIPv6", "summary": "set IPv6", "description": "set IPv6", "input": [ { "name": "body", "type": "object", "info": ": {\"config\": [{\"addresses\": [{\"address\": \"string\", \"prefix\": 123}], \"autoconf\": \"boolean\", \"default_gateway\": \"string\", \"dhcp\": \"boolean\", \"interface_name\": \"string\"}]}", "required": true, "schema": { "title": "IPv6-setRequest", "required": [ "config" ], "type": "object", "properties": { "config": { "type": "array", "items": { "title": "Config5", "required": [ "addresses", "autoconf", "default_gateway", "dhcp", "interface_name" ], "type": "object", "properties": { "addresses": { "type": "array", "items": { "title": "Address", "required": [ "address", "prefix" ], "type": "object", "properties": { "address": { "type": "string" }, "prefix": { "type": "integer", "format": "int32" } }, "example": { "address": "string", "prefix": 1 } }, "description": "" }, "autoconf": { "type": "boolean" }, "default_gateway": { "type": "string" }, "dhcp": { "type": "boolean" }, "interface_name": { "type": "string" } }, "example": { "addresses": [ { "address": "string", "prefix": 1 }, { "address": "string", "prefix": 1 } ], "autoconf": true, "default_gateway": "string", "dhcp": true, "interface_name": "string" } }, "description": "" } }, "example": { "config": [ { "addresses": [ { "address": "string", "prefix": 1 }, { "address": "string", "prefix": 1 } ], "autoconf": true, "default_gateway": "string", "dhcp": true, "interface_name": "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": "/setIPv6" }, "task": true }, { "name": "getIPv6Details", "summary": "get IPv6 Details", "description": "get IPv6 Details", "input": [ { "name": "body", "type": "object", "info": ": {\"interfaces\": \"array\"}", "required": true, "schema": { "title": "IPv6-detailsRequest", "required": [ "interfaces" ], "type": "object", "properties": { "interfaces": { "type": "array", "items": { "type": "string" }, "description": "" } }, "example": { "interfaces": [ "nic0" ] } } } ], "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": "/getIPv6Details" }, "task": true }, { "name": "getNTPConfigurationStatus", "summary": "Get the NTP configuration status", "description": "Get the NTP configuration status", "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": "/getNTPConfigurationStatus" }, "task": true }, { "name": "testNTPConfiguration", "summary": "test NTP configuration", "description": "test NTP configuration", "input": [ { "name": "body", "type": "object", "info": ": {\"servers\": \"array\"}", "required": true, "schema": { "title": "NTP-testRequest", "required": [ "servers" ], "type": "object", "properties": { "servers": { "type": "array", "items": { "type": "string" }, "description": "" } }, "example": { "servers": [ "string", "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": "/testNTPConfiguration" }, "task": true }, { "name": "addNTPServer", "summary": "add NTP server", "description": "add NTP server", "input": [ { "name": "body", "type": "object", "info": ": {\"servers\": \"array\"}", "required": true, "schema": { "title": "NTP-addserverRequest", "required": [ "servers" ], "type": "object", "properties": { "servers": { "type": "array", "items": { "type": "string" }, "description": "" } }, "example": { "servers": [ "string", "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": "/addNTPServer" }, "task": true }, { "name": "setNTPServers", "summary": "set NTP servers", "description": "set NTP servers", "input": [ { "name": "body", "type": "object", "info": ": {\"servers\": \"array\"}", "required": true, "schema": { "title": "NTP-setserversRequest", "required": [ "servers" ], "type": "object", "properties": { "servers": { "type": "array", "items": { "type": "string" }, "description": "" } }, "example": { "servers": [ "string", "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": "/setNTPServers" }, "task": true }, { "name": "deleteNTPServer", "summary": "delete NTP server", "description": "delete NTP server", "input": [ { "name": "body", "type": "object", "info": ": {\"servers\": \"array\"}", "required": true, "schema": { "title": "NTP-deleteserverRequest", "required": [ "servers" ], "type": "object", "properties": { "servers": { "type": "array", "items": { "type": "string" }, "description": "" } }, "example": { "servers": [ "string", "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": "/deleteNTPServer" }, "task": true }, { "name": "getProxyConfigurations", "summary": "Get proxy configurations", "description": "Get proxy configurations", "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": "/getProxyConfigurations" }, "task": true }, { "name": "setProxyConfiguration", "summary": "set Proxy Configuration", "description": "set Proxy Configuration", "input": [ { "name": "body", "type": "object", "info": ": {\"config\": {\"configlist\": [{\"password\": \"string\", \"port\": 123, \"protocol\": \"string\", \"server\": \"string\", \"username\": \"string\"}], \"status\": \"string\"}}", "required": true, "schema": { "title": "Proxy-setRequest", "required": [ "config" ], "type": "object", "properties": { "config": { "title": "Config10", "required": [ "configlist", "status" ], "type": "object", "properties": { "configlist": { "type": "array", "items": { "title": "Configlist", "required": [ "password", "port", "protocol", "server", "username" ], "type": "object", "properties": { "password": { "type": "string" }, "port": { "type": "integer", "format": "int32" }, "protocol": { "type": "string" }, "server": { "type": "string" }, "username": { "type": "string" } }, "example": { "password": "secret string", "port": 1, "protocol": "ftp", "server": "string", "username": "string" } }, "description": "" }, "status": { "type": "string" } }, "example": { "configlist": [ { "password": "secret string", "port": 1, "protocol": "ftp", "server": "string", "username": "string" }, { "password": "secret string", "port": 1, "protocol": "ftp", "server": "string", "username": "string" } ], "status": "disabled" } } }, "example": { "config": { "configlist": [ { "password": "secret string", "port": 1, "protocol": "ftp", "server": "string", "username": "string" }, { "password": "secret string", "port": 1, "protocol": "ftp", "server": "string", "username": "string" } ], "status": "disabled" } } } } ], "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": "/setProxyConfiguration" }, "task": true }, { "name": "testProxyConfiguration", "summary": "test Proxy Configuration", "description": "test Proxy Configuration", "input": [ { "name": "body", "type": "object", "info": ": {\"config\": {\"password\": \"string\", \"port\": 123, \"protocol\": \"string\", \"server\": \"string\", \"testhost\": \"string\", \"username\": \"string\"}}", "required": true, "schema": { "title": "Proxy-testRequest", "required": [ "config" ], "type": "object", "properties": { "config": { "title": "Config11", "required": [ "password", "port", "protocol", "server", "testhost", "username" ], "type": "object", "properties": { "password": { "type": "string" }, "port": { "type": "integer", "format": "int32" }, "protocol": { "type": "string" }, "server": { "type": "string" }, "testhost": { "type": "string" }, "username": { "type": "string" } }, "example": { "password": "secret string", "port": 1, "protocol": "ftp", "server": "string", "testhost": "string", "username": "string" } } }, "example": { "config": { "password": "secret string", "port": 1, "protocol": "ftp", "server": "string", "testhost": "string", "username": "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": "/testProxyConfiguration" }, "task": true }, { "name": "deleteProxyConfiguration", "summary": "Delete Proxy Configuration", "description": "Delete Proxy Configuration", "input": [ { "name": "body", "type": "object", "info": ": {\"protocol\": \"string\"}", "required": true, "schema": { "title": "Proxy-deleteRequest", "required": [ "protocol" ], "type": "object", "properties": { "protocol": { "type": "string" } }, "example": { "protocol": "ftp" } } } ], "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": "/deleteProxyConfiguration" }, "task": true }, { "name": "listNetworkRoutes", "summary": "List Network Routes", "description": "List Network Routes", "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": "/listNetworkRoutes" }, "task": true }, { "name": "setNetworkRoutes", "summary": "Set Network Routes", "description": "Set Network Routes", "input": [ { "name": "body", "type": "object", "info": ": {\"routes\": [{\"destination\": \"string\", \"gateway\": \"string\", \"interface_name\": \"string\", \"prefix\": 123}]}", "required": true, "schema": { "title": "SetRequest", "required": [ "routes" ], "type": "object", "properties": { "routes": { "type": "array", "items": { "title": "Route", "required": [ "destination", "gateway", "interface_name", "prefix" ], "type": "object", "properties": { "destination": { "type": "string" }, "gateway": { "type": "string" }, "interface_name": { "type": "string" }, "prefix": { "type": "integer", "format": "int32" } }, "example": { "destination": "string", "gateway": "string", "interface_name": "string", "prefix": 1 } }, "description": "" } }, "example": { "routes": [ { "destination": "string", "gateway": "string", "interface_name": "string", "prefix": 1 }, { "destination": "string", "gateway": "string", "interface_name": "string", "prefix": 1 } ] } } } ], "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": "/setNetworkRoutes" }, "task": true }, { "name": "testNetworkRoutes", "summary": "test Network Routes", "description": "test Network Routes", "input": [ { "name": "body", "type": "object", "info": ": {\"gateways\": \"array\"}", "required": true, "schema": { "title": "Routes-testRequest", "required": [ "gateways" ], "type": "object", "properties": { "gateways": { "type": "array", "items": { "type": "string" }, "description": "" } }, "example": { "gateways": [ "string", "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": "/testNetworkRoutes" }, "task": true }, { "name": "deleteNetworkRoutes", "summary": "Delete Network Routes", "description": "Delete Network Routes", "input": [ { "name": "body", "type": "object", "info": ": {\"route\": {\"destination\": \"string\", \"gateway\": \"string\", \"interface_name\": \"string\", \"prefix\": 123}}", "required": true, "schema": { "title": "Routes-deleteRequest", "required": [ "route" ], "type": "object", "properties": { "route": { "title": "Route", "required": [ "destination", "gateway", "interface_name", "prefix" ], "type": "object", "properties": { "destination": { "type": "string" }, "gateway": { "type": "string" }, "interface_name": { "type": "string" }, "prefix": { "type": "integer", "format": "int32" } }, "example": { "destination": "string", "gateway": "string", "interface_name": "string", "prefix": 1 } } }, "example": { "route": { "destination": "string", "gateway": "string", "interface_name": "string", "prefix": 1 } } } } ], "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": "/deleteNetworkRoutes" }, "task": true }, { "name": "addNetworkRoute", "summary": "add Network Routes", "description": "add Network Routes", "input": [ { "name": "body", "type": "object", "info": ": {\"route\": {\"destination\": \"string\", \"gateway\": \"string\", \"interface_name\": \"string\", \"prefix\": 123}}", "required": true, "schema": { "title": "Routes-addRequest", "required": [ "route" ], "type": "object", "properties": { "route": { "title": "Route", "required": [ "destination", "gateway", "interface_name", "prefix" ], "type": "object", "properties": { "destination": { "type": "string" }, "gateway": { "type": "string" }, "interface_name": { "type": "string" }, "prefix": { "type": "integer", "format": "int32" } }, "example": { "destination": "string", "gateway": "string", "interface_name": "string", "prefix": 1 } } }, "example": { "route": { "destination": "string", "gateway": "string", "interface_name": "string", "prefix": 1 } } } } ], "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": "/addNetworkRoute" }, "task": true }, { "name": "getBackupJob", "summary": "get Backup job", "description": "get Backup job", "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": "/getBackupJob" }, "task": true }, { "name": "createBackupJob", "summary": "create Backup job", "description": "create Backup job", "input": [ { "name": "body", "type": "object", "info": ": {\"piece\": {\"backup_password\": \"string\", \"comment\": \"string\", \"location\": \"string\", \"location_password\": \"string\", \"location_type\": \"string\", \"location_user\": \"string\", \"parts\": \"array\"}}", "required": true, "schema": { "title": "Backupjob-createRequest", "required": [ "piece" ], "type": "object", "properties": { "piece": { "title": "Piece", "required": [ "backup_password", "comment", "location", "location_password", "location_type", "location_user", "parts" ], "type": "object", "properties": { "backup_password": { "type": "string" }, "comment": { "type": "string" }, "location": { "type": "string" }, "location_password": { "type": "string" }, "location_type": { "type": "string" }, "location_user": { "type": "string" }, "parts": { "type": "array", "items": { "type": "string" }, "description": "" } }, "example": { "backup_password": "string", "comment": "string", "location": "https://webdavserver/location", "location_password": "secret_string", "location_type": "HTTPS", "location_user": "string", "parts": [ "string", "string" ] } } }, "example": { "piece": { "backup_password": "string", "comment": "string", "location": "https://webdavserver/location", "location_password": "secret_string", "location_type": "HTTPS", "location_user": "string", "parts": [ "string", "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": "/createBackupJob" }, "task": true }, { "name": "validateBackupjJob", "summary": "validate Backup job", "description": "validate Backup job", "input": [ { "name": "body", "type": "object", "info": ": {\"piece\": {\"backup_password\": \"string\", \"comment\": \"string\", \"location\": \"string\", \"location_password\": \"string\", \"location_type\": \"string\", \"location_user\": \"string\", \"parts\": \"array\"}}", "required": true, "schema": { "title": "Backupjob-validateRequest", "required": [ "piece" ], "type": "object", "properties": { "piece": { "title": "Piece", "required": [ "backup_password", "comment", "location", "location_password", "location_type", "location_user", "parts" ], "type": "object", "properties": { "backup_password": { "type": "string" }, "comment": { "type": "string" }, "location": { "type": "string" }, "location_password": { "type": "string" }, "location_type": { "type": "string" }, "location_user": { "type": "string" }, "parts": { "type": "array", "items": { "type": "string" }, "description": "" } }, "example": { "backup_password": "string", "comment": "string", "location": "https://webdavserver/location", "location_password": "secret_string", "location_type": "HTTPS", "location_user": "string", "parts": [ "string", "string" ] } } }, "example": { "piece": { "backup_password": "string", "comment": "string", "location": "https://webdavserver/location", "location_password": "secret_string", "location_type": "HTTPS", "location_user": "string", "parts": [ "string", "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": "/validateBackupjJob" }, "task": true }, { "name": "cancelBackupJob", "summary": "cancel Backup job", "description": "cancel Backup job", "input": [ { "name": "jobid", "type": "string", "info": "id of the job: string", "required": true, "schema": { "title": "jobid", "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": "/cancelBackupJob" }, "task": true }, { "name": "getBackupJobStatus", "summary": "get Backup job status", "description": "get Backup job status", "input": [ { "name": "jobid", "type": "string", "info": "id of the job: string", "required": true, "schema": { "title": "jobid", "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": "/getBackupJobStatus" }, "task": true }, { "name": "getBackupJobDetails", "summary": "Get Backup job details", "description": "Get Backup job 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": "/getBackupJobDetails" }, "task": true }, { "name": "getBackupParts", "summary": "Get a list of the backup parts", "description": "Get a list of the backup parts", "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": "/getBackupParts" }, "task": true }, { "name": "getBackupPartSize", "summary": "Get size of the optional part", "description": "Get size of the optional part", "input": [ { "name": "partsid", "type": "string", "info": "id of the part: string", "required": true, "schema": { "title": "partsid", "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": "/getBackupPartSize" }, "task": true }, { "name": "getBackupSchedule", "summary": "get Backup schedule", "description": "get Backup schedule", "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": "/getBackupSchedule" }, "task": true }, { "name": "createBackupSchedule", "summary": "create Backup schedule", "description": "create Backup schedule", "input": [ { "name": "scheduleid", "type": "string", "info": "id of the schedule: string", "required": true, "schema": { "title": "scheduleid", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"spec\": {\"recurrence_info\": {\"hour\": 123, \"days\": \"array\", \"minute\": 123}, \"backup_password\": \"string\", \"location\": \"string\", \"retention_info\": {\"max_count\": 123}, \"parts\": \"array\", \"enable\": \"boolean\", \"location_password\": \"string\", \"location_user\": \"string\"}}", "required": true, "schema": { "title": "Backupschedule-createRequest", "required": [ "spec" ], "type": "object", "properties": { "spec": { "title": "Spec", "required": [ "recurrence_info", "backup_password", "location", "retention_info", "parts", "enable", "location_password", "location_user" ], "type": "object", "properties": { "recurrence_info": { "title": "RecurrenceInfo", "required": [ "hour", "days", "minute" ], "type": "object", "properties": { "hour": { "type": "integer", "format": "int32" }, "days": { "type": "array", "items": { "type": "string" }, "description": "" }, "minute": { "type": "integer", "format": "int32" } }, "example": { "hour": 0, "days": [ "MONDAY" ], "minute": 0 } }, "backup_password": { "type": "string" }, "location": { "type": "string" }, "retention_info": { "title": "RetentionInfo", "required": [ "max_count" ], "type": "object", "properties": { "max_count": { "type": "integer", "format": "int32" } }, "example": { "max_count": 0 } }, "parts": { "type": "array", "items": { "type": "string" }, "description": "" }, "enable": { "type": "boolean" }, "location_password": { "type": "string" }, "location_user": { "type": "string" } }, "example": { "recurrence_info": { "hour": 0, "days": [ "MONDAY" ], "minute": 0 }, "backup_password": "string", "location": "string", "retention_info": { "max_count": 0 }, "parts": [ "string" ], "enable": true, "location_password": "string", "location_user": "string" } } }, "example": { "spec": { "recurrence_info": { "hour": 0, "days": [ "MONDAY" ], "minute": 0 }, "backup_password": "string", "location": "string", "retention_info": { "max_count": 0 }, "parts": [ "string" ], "enable": true, "location_password": "string", "location_user": "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": "/createBackupSchedule" }, "task": true }, { "name": "getBackupScheduleDetails", "summary": "get Backup schedule Details", "description": "get Backup schedule Details", "input": [ { "name": "scheduleid", "type": "string", "info": "id of the schedule: string", "required": true, "schema": { "title": "scheduleid", "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": "/getBackupScheduleDetails" }, "task": true }, { "name": "deleteBackupSchedule", "summary": "delete Backup schedule", "description": "delete Backup schedule", "input": [ { "name": "scheduleid", "type": "string", "info": "id of the schedule: string", "required": true, "schema": { "title": "scheduleid", "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": "/deleteBackupSchedule" }, "task": true }, { "name": "updateBackupSchedule", "summary": "update Backup schedule", "description": "update Backup schedule", "input": [ { "name": "scheduleid", "type": "string", "info": "id of the schedule: string", "required": true, "schema": { "title": "scheduleid", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"spec\": {\"recurrence_info\": {\"hour\": 123, \"days\": \"array\", \"minute\": 123}, \"backup_password\": \"string\", \"location\": \"string\", \"retention_info\": {\"max_count\": 123}, \"parts\": \"array\", \"enable\": \"boolean\", \"location_password\": \"string\", \"location_user\": \"string\"}}", "required": true, "schema": { "title": "Backupschedule-updateRequest", "required": [ "spec" ], "type": "object", "properties": { "spec": { "title": "Spec", "required": [ "recurrence_info", "backup_password", "location", "retention_info", "parts", "enable", "location_password", "location_user" ], "type": "object", "properties": { "recurrence_info": { "title": "RecurrenceInfo", "required": [ "hour", "days", "minute" ], "type": "object", "properties": { "hour": { "type": "integer", "format": "int32" }, "days": { "type": "array", "items": { "type": "string" }, "description": "" }, "minute": { "type": "integer", "format": "int32" } }, "example": { "hour": 0, "days": [ "MONDAY" ], "minute": 0 } }, "backup_password": { "type": "string" }, "location": { "type": "string" }, "retention_info": { "title": "RetentionInfo", "required": [ "max_count" ], "type": "object", "properties": { "max_count": { "type": "integer", "format": "int32" } }, "example": { "max_count": 0 } }, "parts": { "type": "array", "items": { "type": "string" }, "description": "" }, "enable": { "type": "boolean" }, "location_password": { "type": "string" }, "location_user": { "type": "string" } }, "example": { "recurrence_info": { "hour": 0, "days": [ "MONDAY" ], "minute": 0 }, "backup_password": "string", "location": "string", "retention_info": { "max_count": 0 }, "parts": [ "string" ], "enable": true, "location_password": "string", "location_user": "string" } } }, "example": { "spec": { "recurrence_info": { "hour": 0, "days": [ "MONDAY" ], "minute": 0 }, "backup_password": "string", "location": "string", "retention_info": { "max_count": 0 }, "parts": [ "string" ], "enable": true, "location_password": "string", "location_user": "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": "/updateBackupSchedule" }, "task": true }, { "name": "getRestoreJob", "summary": "get Restore job", "description": "get Restore job", "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": "/getRestoreJob" }, "task": true }, { "name": "createRestoreJob", "summary": "create Restore job", "description": "create Restore job", "input": [ { "name": "body", "type": "object", "info": ": {\"piece\": {\"backup_password\": \"string\", \"location\": \"string\", \"location_password\": \"string\", \"location_type\": \"string\", \"location_user\": \"string\"}}", "required": true, "schema": { "title": "Restorejob-createRequest", "required": [ "piece" ], "type": "object", "properties": { "piece": { "title": "Piece2", "required": [ "backup_password", "location", "location_password", "location_type", "location_user" ], "type": "object", "properties": { "backup_password": { "type": "string" }, "location": { "type": "string" }, "location_password": { "type": "string" }, "location_type": { "type": "string" }, "location_user": { "type": "string" } }, "example": { "backup_password": "secret string", "location": "string", "location_password": "secret string", "location_type": "FTPS", "location_user": "string" } } }, "example": { "piece": { "backup_password": "secret string", "location": "string", "location_password": "secret string", "location_type": "FTPS", "location_user": "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": "/createRestoreJob" }, "task": true }, { "name": "cancelRestoreJob", "summary": "cancel Restore job", "description": "cancel Restore job", "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": "/cancelRestoreJob" }, "task": true }, { "name": "getSystemStorage", "summary": "get system Storage", "description": "get system Storage", "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": "/getSystemStorage" }, "task": true }, { "name": "resizeSystemStorage", "summary": "Resize all partitions to 100 percent of disk size", "description": "Resize all partitions to 100 percent of disk size", "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": "/resizeSystemStorage" }, "task": true }, { "name": "getSystemTime", "summary": "get System Time", "description": "get System Time", "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": "/getSystemTime" }, "task": true }, { "name": "getSystemUptime", "summary": "get System Uptime", "description": "get System Uptime", "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": "/getSystemUptime" }, "task": true }, { "name": "getSystemVersion", "summary": "get System Version", "description": "get System Version", "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": "/getSystemVersion" }, "task": true }, { "name": "getSystemShutdownOperations", "summary": "Get System Shutdown operations", "description": "Get System Shutdown operations", "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": "/getSystemShutdownOperations" }, "task": true }, { "name": "startSystemShutdown", "summary": "start System Shutdown", "description": "start System Shutdown", "input": [ { "name": "body", "type": "object", "info": ": {\"config\": {\"delay\": 123, \"reason\": \"string\"}}", "required": true, "schema": { "title": "ShutdownRequest", "required": [ "config" ], "type": "object", "properties": { "config": { "title": "Config8", "required": [ "delay", "reason" ], "type": "object", "properties": { "delay": { "type": "integer", "format": "int32" }, "reason": { "type": "string" } }, "example": { "delay": 1, "reason": "string" } } }, "example": { "config": { "delay": 1, "reason": "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": "/startSystemShutdown" }, "task": true }, { "name": "cancelSystemShutdown", "summary": "Cancel System Shutdown", "description": "Cancel System Shutdown", "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": "/cancelSystemShutdown" }, "task": true }, { "name": "restartSystem", "summary": "Restart System", "description": "Restart System", "input": [ { "name": "body", "type": "object", "info": ": {\"config\": {\"delay\": 123, \"reason\": \"string\"}}", "required": true, "schema": { "title": "RestartRequest", "required": [ "config" ], "type": "object", "properties": { "config": { "title": "Config8", "required": [ "delay", "reason" ], "type": "object", "properties": { "delay": { "type": "integer", "format": "int32" }, "reason": { "type": "string" } }, "example": { "delay": 1, "reason": "string" } } }, "example": { "config": { "delay": 1, "reason": "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": "/restartSystem" }, "task": true }, { "name": "getSystemUpdateRepository", "summary": "Get update repository configuration.", "description": "Get update repository configuration.", "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": "/getSystemUpdateRepository" }, "task": true }, { "name": "setSystemUpdateRepository", "summary": "Set update repository configuration.", "description": "Set update repository configuration.", "input": [ { "name": "body", "type": "object", "info": ": {\"config\": {\"check_updates\": \"string\", \"current_URL\": \"string\", \"day\": \"string\", \"password\": \"string\", \"time\": \"string\", \"username\": \"string\"}}", "required": true, "schema": { "title": "System-updaterepositoryRequest", "required": [ "config" ], "type": "object", "properties": { "config": { "title": "Config12", "required": [ "check_updates", "current_URL", "day", "password", "time", "username" ], "type": "object", "properties": { "check_updates": { "type": "string" }, "current_URL": { "type": "string" }, "day": { "type": "string" }, "password": { "type": "string" }, "time": { "type": "string" }, "username": { "type": "string" } }, "example": { "check_updates": "disabled", "current_URL": "string", "day": "Monday", "password": "secret string", "time": "string", "username": "string" } } }, "example": { "config": { "check_updates": "disabled", "current_URL": "string", "day": "Monday", "password": "secret string", "time": "string", "username": "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": "/setSystemUpdateRepository" }, "task": true }, { "name": "getTimesync", "summary": "Get Timesync", "description": "Get Timesync", "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": "/getTimesync" }, "task": true }, { "name": "setTimesync", "summary": "set Timesync", "description": "set Timesync", "input": [ { "name": "body", "type": "object", "info": ": {\"config\": {\"mode\": \"string\"}}", "required": true, "schema": { "title": "Timesync-setRequest", "required": [ "config" ], "type": "object", "properties": { "config": { "title": "Config13", "required": [ "mode" ], "type": "object", "properties": { "mode": { "type": "string" } }, "example": { "mode": "host" } } }, "example": { "config": { "mode": "host" } } } } ], "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": "/setTimesync" }, "task": true }, { "name": "checkvCenterServerUpdate", "summary": "Check vCenter Server Update - URL & CD-ROM", "description": "Check vCenter Server Update - URL & CD-ROM", "input": [ { "name": "sourceType", "type": "string", "info": ": string", "required": true, "schema": { "title": "sourceType", "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": "/checkvCenterServerUpdate" }, "task": true }, { "name": "getvCenterServerUpdateVersionDetails", "summary": "Get vCenter Server Update - Version Details", "description": "Get vCenter Server Update - Version Details", "input": [ { "name": "version", "type": "string", "info": "version: string", "required": true, "schema": { "title": "version", "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": "/getvCenterServerUpdateVersionDetails" }, "task": true }, { "name": "createvCenterServerUpdate", "summary": "create vCenter Server Update", "description": "create vCenter Server Update", "input": [ { "name": "action", "type": "string", "info": "action (e.g. stage): string", "required": true, "schema": { "title": "action", "type": "string" } }, { "name": "version", "type": "string", "info": "version: string", "required": true, "schema": { "title": "version", "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": "/createvCenterServerUpdate" }, "task": true }, { "name": "getvCenterServerUpdatePolicy", "summary": "get vCenter Server Update Policy", "description": "get vCenter Server Update Policy", "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": "/getvCenterServerUpdatePolicy" }, "task": true }, { "name": "updatevCenterServerUpdatePolicy", "summary": "update vCenter Server Update Policy", "description": "update vCenter Server Update Policy", "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": "/updatevCenterServerUpdatePolicy" }, "task": true }, { "name": "getvCenterServerUpdateStagedUpdate", "summary": "get vCenter Server Staged Update", "description": "get vCenter Server Staged Update", "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": "/getvCenterServerUpdateStagedUpdate" }, "task": true }, { "name": "deletevCenterServerUpdateStagedUpdate", "summary": "delete vCenter Server Staged Update", "description": "delete vCenter Server Staged Update", "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": "/deletevCenterServerUpdateStagedUpdate" }, "task": true }, { "name": "getvCenterServerUpdateStatus", "summary": "get vCenter Server Update Status", "description": "get vCenter Server Update Status", "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": "/getvCenterServerUpdateStatus" }, "task": true }, { "name": "listInboundFirewallRules", "summary": "Get ordered list of inbound IP addresses that are allowed or denied by firewall.", "description": "Get ordered list of inbound IP addresses that are allowed or denied by firewall.", "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": "/listInboundFirewallRules" }, "task": true }, { "name": "createInboundFirewallRule", "summary": "Create inbound firewall rule", "description": "Create inbound firewall rule", "input": [ { "name": "body", "type": "object", "info": ": {\"pos\": 123, \"rule\": {\"address\": \"string\", \"interface_name\": \"string\", \"policy\": \"string\", \"prefix\": 123}}", "required": true, "schema": { "title": "CreateruleRequest", "required": [ "pos", "rule" ], "type": "object", "properties": { "pos": { "type": "integer", "format": "int32" }, "rule": { "title": "Rule", "required": [ "address", "interface_name", "policy", "prefix" ], "type": "object", "properties": { "address": { "type": "string" }, "interface_name": { "type": "string" }, "policy": { "type": "string" }, "prefix": { "type": "integer", "format": "int32" } }, "example": { "address": "string", "interface_name": "*", "policy": "allow", "prefix": 1 } } }, "example": { "pos": 1, "rule": { "address": "string", "interface_name": "*", "policy": "allow", "prefix": 1 } } } } ], "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": "/createInboundFirewallRule" }, "task": true }, { "name": "replaceInboundFirewallRule", "summary": "Replace all inbound firewall rules", "description": "Replace all inbound firewall rules", "input": [ { "name": "body", "type": "object", "info": ": {\"rules\": [{\"address\": \"string\", \"interface_name\": \"string\", \"policy\": \"string\", \"prefix\": 123}]}", "required": true, "schema": { "title": "ReplaceallrulesRequest", "required": [ "rules" ], "type": "object", "properties": { "rules": { "type": "array", "items": { "title": "Rule", "required": [ "address", "interface_name", "policy", "prefix" ], "type": "object", "properties": { "address": { "type": "string" }, "interface_name": { "type": "string" }, "policy": { "type": "string" }, "prefix": { "type": "integer", "format": "int32" } }, "example": { "address": "string", "interface_name": "*", "policy": "allow", "prefix": 1 } }, "description": "" } }, "example": { "rules": [ { "address": "string", "interface_name": "*", "policy": "deny", "prefix": 1 }, { "address": "string", "interface_name": "*", "policy": "allow", "prefix": 1 } ] } } } ], "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": "/replaceInboundFirewallRule" }, "task": true }, { "name": "deleteInboundFirewallRule", "summary": "Delete inbound firewall rules", "description": "Delete inbound firewall rules", "input": [ { "name": "body", "type": "object", "info": ": {\"config\": {\"all\": \"boolean\", \"position\": 123}}", "required": true, "schema": { "title": "DeleteruleRequest", "required": [ "config" ], "type": "object", "properties": { "config": { "title": "Config3", "required": [ "all", "position" ], "type": "object", "properties": { "all": { "type": "boolean" }, "position": { "type": "integer", "format": "int32" } }, "example": { "all": true, "position": 1 } } }, "example": { "config": { "all": true, "position": 1 } } } } ], "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": "/deleteInboundFirewallRule" }, "task": true }, { "name": "getServices", "summary": "Get Services", "description": "Get Services", "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": "/getServices" }, "task": true }, { "name": "getServiceDetails", "summary": "get specific service details", "description": "get specific service details", "input": [ { "name": "body", "type": "object", "info": ": {\"name\": \"string\", \"timeout\": 123}", "required": true, "schema": { "title": "Services-getspecificservicedetailsRequest", "required": [ "name", "timeout" ], "type": "object", "properties": { "name": { "type": "string" }, "timeout": { "type": "integer", "format": "int32" } }, "example": { "name": "string", "timeout": 0 } } } ], "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": "/getServiceDetails" }, "task": true }, { "name": "controlServices", "summary": "Control Services", "description": "Control Services", "input": [ { "name": "body", "type": "object", "info": ": {\"args\": \"array\", \"name\": \"string\", \"timeout\": 123}", "required": true, "schema": { "title": "Services-controlRequest", "required": [ "args", "name", "timeout" ], "type": "object", "properties": { "args": { "type": "array", "items": { "type": "string" }, "description": "" }, "name": { "type": "string" }, "timeout": { "type": "integer", "format": "int32" } }, "example": { "args": [ "string", "string" ], "name": "string", "timeout": 1 } } } ], "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": "/controlServices" }, "task": true }, { "name": "restartServices", "summary": "Restart Services", "description": "Restart Services", "input": [ { "name": "body", "type": "object", "info": ": {\"name\": \"string\", \"timeout\": 123}", "required": true, "schema": { "title": "Services-restartRequest", "required": [ "name", "timeout" ], "type": "object", "properties": { "name": { "type": "string" }, "timeout": { "type": "integer", "format": "int32" } }, "example": { "name": "string", "timeout": 0 } } } ], "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": "/restartServices" }, "task": true }, { "name": "stopServices", "summary": "stop Services", "description": "stop Services", "input": [ { "name": "body", "type": "object", "info": ": {\"name\": \"string\", \"timeout\": 123}", "required": true, "schema": { "title": "Services-stopRequest", "required": [ "name", "timeout" ], "type": "object", "properties": { "name": { "type": "string" }, "timeout": { "type": "integer", "format": "int32" } }, "example": { "name": "string", "timeout": 0 } } } ], "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": "/stopServices" }, "task": true }, { "name": "getLocalAccounts", "summary": "Get Local accounts", "description": "Get Local accounts", "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": "/getLocalAccounts" }, "task": true }, { "name": "createLocalaccounts", "summary": "Create Local accounts", "description": "Create Local accounts", "input": [ { "name": "body", "type": "object", "info": ": {\"config\": {\"email\": \"string\", \"fullname\": \"string\", \"password\": \"string\", \"role\": \"string\", \"username\": \"string\"}}", "required": true, "schema": { "title": "Localaccounts-createRequest", "required": [ "config" ], "type": "object", "properties": { "config": { "title": "Config14", "required": [ "email", "fullname", "password", "role", "username" ], "type": "object", "properties": { "email": { "type": "string" }, "fullname": { "type": "string" }, "password": { "type": "string" }, "role": { "type": "string" }, "username": { "type": "string" } }, "example": { "email": "string@domain.com", "fullname": "string", "password": "secretstring", "role": "admin", "username": "test" } } }, "example": { "config": { "email": "string@domain.com", "fullname": "string", "password": "secretstring", "role": "admin", "username": "test" } } } } ], "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": "/createLocalaccounts" }, "task": true }, { "name": "updateLocalAccounts", "summary": "update Local accounts", "description": "update Local accounts", "input": [ { "name": "body", "type": "object", "info": ": {\"config\": {\"email\": \"string\", \"fullname\": \"string\", \"role\": \"string\", \"status\": \"string\", \"username\": \"string\"}}", "required": true, "schema": { "title": "Localaccounts-updateRequest", "required": [ "config" ], "type": "object", "properties": { "config": { "title": "Config15", "required": [ "email", "fullname", "role", "status", "username" ], "type": "object", "properties": { "email": { "type": "string" }, "fullname": { "type": "string" }, "role": { "type": "string" }, "status": { "type": "string" }, "username": { "type": "string" } }, "example": { "email": "string@domain.com", "fullname": "new string", "role": "admin", "status": "enabled", "username": "test" } } }, "example": { "config": { "email": "string@domain.com", "fullname": "new string", "role": "admin", "status": "enabled", "username": "test" } } } } ], "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": "/updateLocalAccounts" }, "task": true }, { "name": "getLocalAccountsDetails", "summary": "Get Local accounts Details", "description": "Get Local accounts Details", "input": [ { "name": "localUser", "type": "string", "info": "the local user account: string", "required": true, "schema": { "title": "localUser", "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": "/getLocalAccountsDetails" }, "task": true }, { "name": "removeLocalAccounts", "summary": "Remove Local accounts", "description": "Remove Local accounts", "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": "/removeLocalAccounts" }, "task": true }, { "name": "getVmonServices", "summary": "Get Vmon Services", "description": "Get Vmon Services", "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": "/getVmonServices" }, "task": true }, { "name": "getVmonServiceDetails", "summary": "Get details about specific vmon service", "description": "Get details about specific vmon service", "input": [ { "name": "service", "type": "string", "info": "the service: string", "required": true, "schema": { "title": "service", "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": "/getVmonServiceDetails" }, "task": true }, { "name": "updateVmonservice", "summary": "Update specific Vmon service", "description": "Update specific Vmon service", "input": [ { "name": "service", "type": "string", "info": "the service: string", "required": true, "schema": { "title": "service", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"spec\": {\"startup_type\": \"string\"}}", "required": true, "schema": { "title": "UpdatespecificserviceRequest", "required": [ "spec" ], "type": "object", "properties": { "spec": { "title": "Spec2", "required": [ "startup_type" ], "type": "object", "properties": { "startup_type": { "type": "string" } }, "example": { "startup_type": "AUTOMATIC" } } }, "example": { "spec": { "startup_type": "AUTOMATIC" } } } } ], "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": "/updateVmonservice" }, "task": true }, { "name": "restartVmonService", "summary": "Restart specific Vmon service", "description": "Restart specific Vmon service", "input": [ { "name": "service", "type": "string", "info": "the service: string", "required": true, "schema": { "title": "service", "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": "/restartVmonService" }, "task": true }, { "name": "startVmonservice", "summary": "Start Specific Vmon service", "description": "Start Specific Vmon service", "input": [ { "name": "service", "type": "string", "info": "the service: string", "required": true, "schema": { "title": "service", "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": "/startVmonservice" }, "task": true }, { "name": "stopVmonService", "summary": "Stop specific Vmon service", "description": "Stop specific Vmon service", "input": [ { "name": "service", "type": "string", "info": "the service: string", "required": true, "schema": { "title": "service", "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": "/stopVmonService" }, "task": true }, { "name": "listLibraries", "summary": "List Content Libraries", "description": "List Content Libraries", "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": "/listLibraries" }, "task": true }, { "name": "getLibraryDetails", "summary": "Get details of single library", "description": "Get details of single library", "input": [ { "name": "library", "type": "string", "info": "The id of the library (id:###): string", "required": true, "schema": { "title": "library", "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": "/getLibraryDetails" }, "task": true }, { "name": "listLibraryItems", "summary": "List all items in a specific library", "description": "List all items in a specific library", "input": [ { "name": "libraryId", "type": "string", "info": ": string", "required": true, "schema": { "title": "libraryId", "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": "/listLibraryItems" }, "task": true }, { "name": "getLibraryItemDetails", "summary": "List details of a library item", "description": "List details of a library item", "input": [ { "name": "item", "type": "string", "info": "The id of the library item (id:###): string", "required": true, "schema": { "title": "item", "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": "/getLibraryItemDetails" }, "task": true }, { "name": "listFilesInlibraryItem", "summary": "List files in a specific library item", "description": "List files in a specific library item", "input": [ { "name": "libraryItemId", "type": "string", "info": ": string", "required": true, "schema": { "title": "libraryItemId", "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": "/listFilesInlibraryItem" }, "task": true }, { "name": "listStorageInLibraryItem", "summary": "List storage items in a specific library item", "description": "List storage items in a specific library item", "input": [ { "name": "libraryItemId", "type": "string", "info": ": string", "required": true, "schema": { "title": "libraryItemId", "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": "/listStorageInLibraryItem" }, "task": true }, { "name": "takeActionOnLibraryItem", "summary": "Take action on a Library Item", "description": "Take action on a Library Item - query, deploy, etc", "input": [ { "name": "item", "type": "string", "info": "The id of the library item (id:###): string", "required": true, "schema": { "title": "item", "type": "string" } }, { "name": "action", "type": "string", "info": "type of action, (filter, deploy, etc): string", "required": true, "schema": { "title": "action", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"target\": {\"folder_id\": \"string\", \"host_id\": \"string\", \"resource_pool_id\": \"string\"}}", "required": true, "schema": { "title": "QueryanOVFpackagefordeploymentdetailsRequest", "required": [ "target" ], "type": "object", "properties": { "target": { "title": "Target", "required": [ "folder_id", "host_id", "resource_pool_id" ], "type": "object", "properties": { "folder_id": { "type": "string" }, "host_id": { "type": "string" }, "resource_pool_id": { "type": "string" } }, "example": { "folder_id": "group-v9", "host_id": "host-10", "resource_pool_id": "resgroup-8" } } }, "example": { "target": { "folder_id": "group-v9", "host_id": "host-10", "resource_pool_id": "resgroup-8" } } } } ], "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": "/takeActionOnLibraryItem" }, "task": true }, { "name": "createLocalLibrary", "summary": "Create a Local Library", "description": "Create a Local Library", "input": [ { "name": "body", "type": "object", "info": ": {\"create_spec\": {\"name\": \"string\", \"description\": \"string\", \"publish_info\": {\"authentication_method\": \"string\", \"persist_json_enabled\": \"boolean\", \"published\": \"boolean\"}, \"storage_backings\": [{\"datastore_id\": \"string\", \"type\": \"string\"}], \"type\": \"string\"}}", "required": true, "schema": { "title": "ContentLibraryCreateRequest", "required": [ "create_spec" ], "type": "object", "properties": { "create_spec": { "title": "CreateSpec", "required": [ "name", "description", "publish_info", "storage_backings", "type" ], "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "publish_info": { "title": "PublishInfo", "required": [ "authentication_method", "persist_json_enabled", "published" ], "type": "object", "properties": { "authentication_method": { "type": "string" }, "persist_json_enabled": { "type": "boolean" }, "published": { "type": "boolean" } }, "example": { "authentication_method": "NONE", "persist_json_enabled": false, "published": false } }, "storage_backings": { "type": "array", "items": { "title": "StorageBacking", "required": [ "datastore_id", "type" ], "type": "object", "properties": { "datastore_id": { "type": "string" }, "type": { "type": "string" } }, "example": { "datastore_id": "datastore-12", "type": "DATASTORE" } }, "description": "" }, "type": { "type": "string" } }, "example": { "name": "CL1", "description": "CL1 Desc", "publish_info": { "authentication_method": "NONE", "persist_json_enabled": false, "published": false }, "storage_backings": [ { "datastore_id": "datastore-12", "type": "DATASTORE" } ], "type": "LOCAL" } } }, "example": { "create_spec": { "name": "CL1", "description": "CL1 Desc", "publish_info": { "authentication_method": "NONE", "persist_json_enabled": false, "published": false }, "storage_backings": [ { "datastore_id": "datastore-12", "type": "DATASTORE" } ], "type": "LOCAL" } } } } ], "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": "/createLocalLibrary" }, "task": true }, { "name": "listLocalLibraries", "summary": "List all local libraries", "description": "List all local libraries", "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": "/listLocalLibraries" }, "task": true }, { "name": "getLocalLibraryDetails", "summary": "Get details of a local library", "description": "Get details of a local library", "input": [ { "name": "library", "type": "string", "info": "The id of the local library (id:###): string", "required": true, "schema": { "title": "library", "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": "/getLocalLibraryDetails" }, "task": true }, { "name": "deleteLocalLibrary", "summary": "Delete a local library", "description": "Delete a local library", "input": [ { "name": "id", "type": "string", "info": "The id of the local library (id:###): string", "required": true, "schema": { "title": "id", "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": "/deleteLocalLibrary" }, "task": true }, { "name": "createSubscribedLibrary", "summary": "Create Subscribed Library", "description": "Create Subscribed Library", "input": [ { "name": "body", "type": "object", "info": ": {\"create_spec\": {\"subscription_info\": {\"authentication_method\": \"string\", \"ssl_thumbprint\": \"string\", \"automatic_sync_enabled\": \"boolean\", \"subscription_url\": \"string\", \"on_demand\": \"boolean\"}, \"name\": \"string\", \"description\": \"string\", \"publish_info\": {\"authentication_method\": \"string\", \"persist_json_enabled\": \"boolean\", \"published\": \"boolean\"}, \"storage_backings\": [{\"datastore_id\": \"string\", \"type\": \"string\"}], \"type\": \"string\"}}", "required": true, "schema": { "title": "SubscribedLibraryCreateRequest", "required": [ "create_spec" ], "type": "object", "properties": { "create_spec": { "title": "CreateSpec1", "required": [ "subscription_info", "name", "description", "publish_info", "storage_backings", "type" ], "type": "object", "properties": { "subscription_info": { "title": "SubscriptionInfo", "required": [ "authentication_method", "ssl_thumbprint", "automatic_sync_enabled", "subscription_url", "on_demand" ], "type": "object", "properties": { "authentication_method": { "type": "string" }, "ssl_thumbprint": { "type": "string" }, "automatic_sync_enabled": { "type": "boolean" }, "subscription_url": { "type": "string" }, "on_demand": { "type": "boolean" } }, "example": { "authentication_method": "NONE", "ssl_thumbprint": "69:d9:9e:e9:0b:4b:68:24:09:2b:ce:14:d7:4a:f9:8c:bd:c6:5a:e9", "automatic_sync_enabled": true, "subscription_url": "https://s3-us-west-1.amazonaws.com/vghetto-content-library/lib.json", "on_demand": false } }, "name": { "type": "string" }, "description": { "type": "string" }, "publish_info": { "title": "PublishInfo", "required": [ "authentication_method", "persist_json_enabled", "published" ], "type": "object", "properties": { "authentication_method": { "type": "string" }, "persist_json_enabled": { "type": "boolean" }, "published": { "type": "boolean" } }, "example": { "authentication_method": "NONE", "persist_json_enabled": false, "published": false } }, "storage_backings": { "type": "array", "items": { "title": "StorageBacking", "required": [ "datastore_id", "type" ], "type": "object", "properties": { "datastore_id": { "type": "string" }, "type": { "type": "string" } }, "example": { "datastore_id": "datastore-12", "type": "DATASTORE" } }, "description": "" }, "type": { "type": "string" } }, "example": { "subscription_info": { "authentication_method": "NONE", "ssl_thumbprint": "69:d9:9e:e9:0b:4b:68:24:09:2b:ce:14:d7:4a:f9:8c:bd:c6:5a:e9", "automatic_sync_enabled": true, "subscription_url": "https://s3-us-west-1.amazonaws.com/vghetto-content-library/lib.json", "on_demand": false }, "name": "virtuallyGhetto CL", "description": "William Lams CL: http://www.virtuallyghetto.com/2015/04/subscribe-to-vghetto-nested-esxi-template-content-library-in-vsphere-6-0.html", "publish_info": { "authentication_method": "NONE", "persist_json_enabled": false, "published": false }, "storage_backings": [ { "datastore_id": "datastore-28", "type": "DATASTORE" } ], "type": "SUBSCRIBED" } } }, "example": { "create_spec": { "subscription_info": { "authentication_method": "NONE", "ssl_thumbprint": "69:d9:9e:e9:0b:4b:68:24:09:2b:ce:14:d7:4a:f9:8c:bd:c6:5a:e9", "automatic_sync_enabled": true, "subscription_url": "https://s3-us-west-1.amazonaws.com/vghetto-content-library/lib.json", "on_demand": false }, "name": "virtuallyGhetto CL", "description": "William Lams CL: http://www.virtuallyghetto.com/2015/04/subscribe-to-vghetto-nested-esxi-template-content-library-in-vsphere-6-0.html", "publish_info": { "authentication_method": "NONE", "persist_json_enabled": false, "published": false }, "storage_backings": [ { "datastore_id": "datastore-28", "type": "DATASTORE" } ], "type": "SUBSCRIBED" } } } } ], "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": "/createSubscribedLibrary" }, "task": true }, { "name": "listSubscribedlibraryies", "summary": "List all subscribed libraries", "description": "List all subscribed libraries", "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": "/listSubscribedlibraryies" }, "task": true }, { "name": "getSubscribedLibraryDetails", "summary": "Get details of a subscribed library", "description": "Get details of a subscribed library", "input": [ { "name": "library", "type": "string", "info": "The id of the subscribed library (id:###): string", "required": true, "schema": { "title": "library", "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": "/getSubscribedLibraryDetails" }, "task": true }, { "name": "deleteSubscribedLibrary", "summary": "Delete a subscribed library", "description": "Delete a subscribed library", "input": [ { "name": "id", "type": "string", "info": "The id of the subscribed library (id:###): string", "required": true, "schema": { "title": "id", "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": "/deleteSubscribedLibrary" }, "task": true }, { "name": "evictCachedContentSubscribedLibrary", "summary": "Evict cached content of on-demand subscribed library", "description": "Evict cached content of on-demand subscribed library", "input": [ { "name": "id", "type": "string", "info": "The id of the subscribed library (id:###): string", "required": true, "schema": { "title": "id", "type": "string" } }, { "name": "action", "type": "string", "info": "type of action, (evict): string", "required": true, "schema": { "title": "action", "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": "/evictCachedContentSubscribedLibrary" }, "task": true } ], "views": [] }