{ "id": "@itentialopensource/adapter-vmware_virtual_infrastructure", "type": "Adapter", "export": "VmwareVirtualInfrastructure", "title": "Vmware_virtual_infrastructure", "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": "postAlarmMoIdReconfigureAlarm", "summary": "Reconfigures the alarm properties.", "description": "Reconfigures the alarm properties.\n\nThis operation requires access\nprivileges on the entity with which the alarm is associated.\n\nIn addition to the Alarm.Edit privilege, may also require the\nGlobal.ScriptAction if a RunScriptAction action is specified in\nthe AlarmSpec.\n\n***Required privileges:*** Alarm.Edit", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postAlarmMoIdReconfigureAlarm" }, "task": true }, { "name": "postAlarmMoIdRemoveAlarm", "summary": "Removes the alarm.", "description": "Removes the alarm.\n\n***Required privileges:*** Alarm.Delete", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postAlarmMoIdRemoveAlarm" }, "task": true }, { "name": "postAlarmMoIdSetCustomValue", "summary": "Assigns a value to a custom field.", "description": "Assigns a value to a custom field.\n\nThe setCustomValue method requires\nwhichever updatePrivilege is defined as one of the\n*CustomFieldDef.fieldInstancePrivileges*\nfor the CustomFieldDef whose value is being changed.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postAlarmMoIdSetCustomValue" }, "task": true }, { "name": "getAlarmMoIdAvailableField", "summary": "List of custom field definitions that are valid for the object's type.", "description": "List of custom field definitions that are valid for the object's type.\n\nThe fields are sorted by *CustomFieldDef.name*.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getAlarmMoIdAvailableField" }, "task": true }, { "name": "getAlarmMoIdInfo", "summary": "Information about this alarm.", "description": "Information about this alarm.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getAlarmMoIdInfo" }, "task": true }, { "name": "getAlarmMoIdValue", "summary": "List of custom field values.", "description": "List of custom field values.\n\nEach value uses a key to associate\nan instance of a *CustomFieldStringValue* with\na custom field definition.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getAlarmMoIdValue" }, "task": true }, { "name": "postAlarmManagerMoIdAcknowledgeAlarm", "summary": "Acknowledge the alarm on a managed entity.", "description": "Acknowledge the alarm on a managed entity.\n\nThe actions associated\nwith the alarm will not fire until the alarm's next distinct\noccurrence; that is, until after the alarm has entered the green\nor gray states at least once. Calling this method on an acknowledged\nor non-triggered alarm.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postAlarmManagerMoIdAcknowledgeAlarm" }, "task": true }, { "name": "postAlarmManagerMoIdClearTriggeredAlarms", "summary": "Resets all triggered alarms to green.", "description": "Resets all triggered alarms to green.\n\nShould be used when mass alarm reset is needed.\n\n***Required privileges:*** Alarm.SetStatus", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postAlarmManagerMoIdClearTriggeredAlarms" }, "task": true }, { "name": "postAlarmManagerMoIdCreateAlarm", "summary": "Creates an alarm.", "description": "Creates an alarm.\n\nIn addition to the Alarm.Create privilege, may also require the\nGlobal.ScriptAction if a RunScriptAction action is specified in\nthe AlarmSpec.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postAlarmManagerMoIdCreateAlarm" }, "task": true }, { "name": "postAlarmManagerMoIdDisableAlarm", "summary": "Disables alarm for a specific entity.", "description": "Disables alarm for a specific entity.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postAlarmManagerMoIdDisableAlarm" }, "task": true }, { "name": "postAlarmManagerMoIdEnableAlarm", "summary": "Enables alarm for a specific entity.", "description": "Enables alarm for a specific entity.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postAlarmManagerMoIdEnableAlarm" }, "task": true }, { "name": "postAlarmManagerMoIdGetAlarm", "summary": "Available alarms defined on the entity.", "description": "Available alarms defined on the entity.\n\nThese alarms do not include any inherited alarms; that is,\nalarms associated with parent entities.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postAlarmManagerMoIdGetAlarm" }, "task": true }, { "name": "postAlarmManagerMoIdAreAlarmActionsEnabled", "summary": "Returns true if alarm actions are enabled on the specified managed entity.", "description": "Returns true if alarm actions are enabled on the specified managed entity.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postAlarmManagerMoIdAreAlarmActionsEnabled" }, "task": true }, { "name": "postAlarmManagerMoIdGetAlarmState", "summary": "The state of instantiated alarms on the entity.", "description": "The state of instantiated alarms on the entity.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postAlarmManagerMoIdGetAlarmState" }, "task": true }, { "name": "postAlarmManagerMoIdEnableAlarmActions", "summary": "Enables or disables alarms on the specified managed entity.", "description": "Enables or disables alarms on the specified managed entity.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postAlarmManagerMoIdEnableAlarmActions" }, "task": true }, { "name": "getAlarmManagerMoIdDefaultExpression", "summary": "The default setting for each alarm expression, used to populate the\ninitial client wizard screen.", "description": "The default setting for each alarm expression, used to populate the\ninitial client wizard screen.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getAlarmManagerMoIdDefaultExpression" }, "task": true }, { "name": "getAlarmManagerMoIdDescription", "summary": "The static descriptive strings used in alarms.", "description": "The static descriptive strings used in alarms.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getAlarmManagerMoIdDescription" }, "task": true }, { "name": "postAuthorizationManagerMoIdAddAuthorizationRole", "summary": "Adds a new role.", "description": "Adds a new role.\n\nThis method will add a user-defined role with given list of privileges\nand three system-defined privileges, \"System.Anonymous\", \"System.View\",\nand \"System.Read\".\n\n***Required privileges:*** Authorization.ModifyRoles", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postAuthorizationManagerMoIdAddAuthorizationRole" }, "task": true }, { "name": "postAuthorizationManagerMoIdFetchUserPrivilegeOnEntities", "summary": "Get the list of effective privileges for a user,\neither granted explicitly, or through group member", "description": "Get the list of effective privileges for a user,\neither granted explicitly, or through group membership.\n\nThis API is implemented only by vCenter Server.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postAuthorizationManagerMoIdFetchUserPrivilegeOnEntities" }, "task": true }, { "name": "postAuthorizationManagerMoIdHasPrivilegeOnEntities", "summary": "Check whether a session holds a set of privileges on a set of managed entities.", "description": "Check whether a session holds a set of privileges on a set of managed entities.\n\nIf the session does not exist, false is returned for all privileges of\nall the entities.\n\nThis API is implemented only by vCenter Server.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postAuthorizationManagerMoIdHasPrivilegeOnEntities" }, "task": true }, { "name": "postAuthorizationManagerMoIdHasPrivilegeOnEntity", "summary": "Check whether a session holds a set of privileges on a managed entity.", "description": "Check whether a session holds a set of privileges on a managed entity.\n\nIf the session does not exist, false is returned for all privileges.\n\nThis API is implemented only by vCenter Server.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postAuthorizationManagerMoIdHasPrivilegeOnEntity" }, "task": true }, { "name": "postAuthorizationManagerMoIdHasUserPrivilegeOnEntities", "summary": "Checks if a user holds a certain set of privileges on a number of\nmanaged entities.", "description": "Checks if a user holds a certain set of privileges on a number of\nmanaged entities.\n\nPrivileges may be granted to users through their\nrespective group membership. If a privilege is granted to a group it is\nimplicitly granted to its members.\n\nThis API is implemented only by vCenter Server.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postAuthorizationManagerMoIdHasUserPrivilegeOnEntities" }, "task": true }, { "name": "postAuthorizationManagerMoIdMergePermissions", "summary": "Reassigns all permissions of a role to another role.", "description": "Reassigns all permissions of a role to another role.\n\n***Required privileges:*** Authorization.ReassignRolePermissions", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postAuthorizationManagerMoIdMergePermissions" }, "task": true }, { "name": "postAuthorizationManagerMoIdRemoveEntityPermission", "summary": "Removes a permission rule from an entity.", "description": "Removes a permission rule from an entity.\n\nThis will fail with an InvalidArgument fault if called on: the direct child\nfolders of a datacenter managed object, the root resource pool of a\nComputeResource or ClusterComputeResource, or a HostSystem that is part of\na ComputeResource (Stand-alone Host). These objects always have the same\npermissions as their parent.\n\nThis will fail with an InvalidArgument fault if called on a fault-tolerance (FT)\nsecondary VirtualMachine. Such a VirtualMachine always...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postAuthorizationManagerMoIdRemoveEntityPermission" }, "task": true }, { "name": "postAuthorizationManagerMoIdRemoveAuthorizationRole", "summary": "Removes a role.", "description": "Removes a role.\n\n***Required privileges:*** Authorization.ModifyRoles", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postAuthorizationManagerMoIdRemoveAuthorizationRole" }, "task": true }, { "name": "postAuthorizationManagerMoIdResetEntityPermissions", "summary": "Update the entire set of permissions defined on an entity.", "description": "Update the entire set of permissions defined on an entity.\n\nAny\nexisting permissions on the entity are removed and replaced with the\nprovided set.\n\nIf a permission is specified multiple times for the same user or group, the\nlast permission specified takes effect.\n\nThe operation is transactional per permission and could partially fail. The\nupdates are performed in the order of the permission array argument. The first\nfailed update will abort the operation and throw the appropriate exception. When...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postAuthorizationManagerMoIdResetEntityPermissions" }, "task": true }, { "name": "postAuthorizationManagerMoIdRetrieveAllPermissions", "summary": "Finds all permissions defined in the system.", "description": "Finds all permissions defined in the system.\n\nThe result is restricted to the managed entities visible to the\nuser making the call.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postAuthorizationManagerMoIdRetrieveAllPermissions" }, "task": true }, { "name": "postAuthorizationManagerMoIdRetrieveEntityPermissions", "summary": "Gets permissions defined on or effective on a managed entity.", "description": "Gets permissions defined on or effective on a managed entity.\n\nThis returns the actual permission objects defined in the system for all\nusers and groups relative to the managed entity. The inherited\nflag specifies whether or not to include permissions defined by the\nparents of this entity that propagate to this entity.\n\nFor complex entities, the entity reported as defining the permission may\nbe either the parent or a child entity belonging to the complex entity.\n\nThe purpose of this method is to...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postAuthorizationManagerMoIdRetrieveEntityPermissions" }, "task": true }, { "name": "postAuthorizationManagerMoIdRetrieveRolePermissions", "summary": "Finds all the permissions that use a particular role.", "description": "Finds all the permissions that use a particular role.\n\nThe result is restricted to managed entities that are visible to the\nuser making the call.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postAuthorizationManagerMoIdRetrieveRolePermissions" }, "task": true }, { "name": "postAuthorizationManagerMoIdSetEntityPermissions", "summary": "Defines one or more permission rules on an entity or updates rules if already\npresent for the given", "description": "Defines one or more permission rules on an entity or updates rules if already\npresent for the given user or group on the entity.\n\nIf a permission is specified multiple times for the same user or group, then the\nlast permission specified takes effect.\n\nThe operation is applied transactionally per permission and is applied to the\nentity following the order of the elements in the permission array argument. This\nmeans that if a failure occurs, the method terminates at that point in the\npermission ar...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postAuthorizationManagerMoIdSetEntityPermissions" }, "task": true }, { "name": "postAuthorizationManagerMoIdUpdateAuthorizationRole", "summary": "Updates a role's name or privileges.", "description": "Updates a role's name or privileges.\n\nIf the new set of privileges are assigned to the role, the\nsystem-defined privileges, \"System.Anonymous\", \"System.View\",\nand \"System.Read\" will be assigned to the role too.\nThis operation might return before the new privileges are effective.\nA timeout of 100 ms is possible, but it might vary depending on\nthe configuration and the load of the system.\n\n***Required privileges:*** Authorization.ModifyRoles", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postAuthorizationManagerMoIdUpdateAuthorizationRole" }, "task": true }, { "name": "getAuthorizationManagerMoIdDescription", "summary": "Static, descriptive strings for system roles and privileges.", "description": "Static, descriptive strings for system roles and privileges.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getAuthorizationManagerMoIdDescription" }, "task": true }, { "name": "getAuthorizationManagerMoIdPrivilegeList", "summary": "The list of system-defined privileges.", "description": "The list of system-defined privileges.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getAuthorizationManagerMoIdPrivilegeList" }, "task": true }, { "name": "getAuthorizationManagerMoIdRoleList", "summary": "The currently defined roles in the system, including\nstatic system-defined roles.", "description": "The currently defined roles in the system, including\nstatic system-defined roles.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getAuthorizationManagerMoIdRoleList" }, "task": true }, { "name": "postCertificateManagerMoIdCertMgrRefreshCACertificatesAndCRLsTask", "summary": "Re-fetches certificates of trusted CAs and the Certificate Revocation\nLists (CRL) from the appropri", "description": "Re-fetches certificates of trusted CAs and the Certificate Revocation\nLists (CRL) from the appropriate authoritative source and pushes them to\nthe hosts.\n\n***Required privileges:*** Certificate.Manage", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postCertificateManagerMoIdCertMgrRefreshCACertificatesAndCRLsTask" }, "task": true }, { "name": "postCertificateManagerMoIdCertMgrRefreshCertificatesTask", "summary": "Gets CSRs from the hosts and then gets these certificates signed by the\nVMware Certificate Service", "description": "Gets CSRs from the hosts and then gets these certificates signed by the\nVMware Certificate Service and pushes them down to the hosts.\n\n***Required privileges:*** Certificate.Manage", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postCertificateManagerMoIdCertMgrRefreshCertificatesTask" }, "task": true }, { "name": "postCertificateManagerMoIdCertMgrRevokeCertificatesTask", "summary": "Revokes the certificates of some hosts.", "description": "Revokes the certificates of some hosts.\n\n***Required privileges:*** Certificate.Manage", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postCertificateManagerMoIdCertMgrRevokeCertificatesTask" }, "task": true }, { "name": "postClusterComputeResourceMoIdAbandonHciWorkflow", "summary": "Opt out of the HCI workflow.", "description": "Opt out of the HCI workflow.\n\nThis operation is only allowed on a cluster\nthat was created with the HCI workflow.\nWhen the cluster is created, but still unconfigured, the\n*workflowState*\nis \"in\\_progress\". The AbandonHciWorkflow method may be called at any time before\ncluster configuration begins; it is not possible to abandon the workflow\nduring the configuration procedure.\n\n***Required privileges:*** Host.Inventory.EditCluster", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postClusterComputeResourceMoIdAbandonHciWorkflow" }, "task": true }, { "name": "postClusterComputeResourceMoIdAddHostTask", "summary": "Adds a host to the cluster.", "description": "Adds a host to the cluster.\n\nThe hostname must be either an IP address, such as\n192.168.0.1, or a DNS resolvable name. DNS names may be fully qualified names,\nsuch as host1.domain1.com, or a short name such as host1, providing host1 resolves\nto host1.domain1.com. The system uses DNS to resolve short names to fully qualified\nnames. If the cluster supports nested resource pools and the user specifies the\noptional ResourcePool argument, then the host's root resource pool becomes the\nspecified resou...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postClusterComputeResourceMoIdAddHostTask" }, "task": true }, { "name": "postClusterComputeResourceMoIdApplyRecommendation", "summary": "Applies a recommendation from the drsRecommendation or the\nrecommendation list.", "description": "Applies a recommendation from the drsRecommendation or the\nrecommendation list.\n\nEach recommendation can be applied only\nonce.\n\nresource.applyRecommendation privilege is required if the recommendation\nis DRS migration or power management recommendations.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postClusterComputeResourceMoIdApplyRecommendation" }, "task": true }, { "name": "postClusterComputeResourceMoIdCancelRecommendation", "summary": "Cancels a recommendation.", "description": "Cancels a recommendation.\n\n***Required privileges:*** System.Read", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postClusterComputeResourceMoIdCancelRecommendation" }, "task": true }, { "name": "postClusterComputeResourceMoIdConfigureHCITask", "summary": "Configures the cluster.", "description": "Configures the cluster.\n\nThis API requires Host.Inventory.EditCluster privilege on the cluster\nand the hosts; additional privileges might be required depending on the\ninputs.\nThis operation is only allowed on a cluster that was created\nwith the HCI workflow.\nBefore calling this method, it is recommended that\n*ClusterComputeResource.ValidateHCIConfiguration* is\ninvoked with the DvsProfile objects listed in\n*ClusterComputeResourceHCIConfigSpec.dvsProf* along with the hosts listed in\n*ClusterComput...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postClusterComputeResourceMoIdConfigureHCITask" }, "task": true }, { "name": "postClusterComputeResourceMoIdDestroyTask", "summary": "Destroys this object, deleting its contents and removing it from its parent\nfolder (if any).", "description": "Destroys this object, deleting its contents and removing it from its parent\nfolder (if any).\n\nNOTE: The appropriate privilege must be held on the parent of the destroyed\nentity as well as the entity itself.\nThis method can throw one of several exceptions. The exact set of exceptions\ndepends on the kind of entity that is being removed. See comments for\neach entity for more information on destroy behavior.\n\n***Required privileges:*** Host.Inventory.DeleteCluster", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postClusterComputeResourceMoIdDestroyTask" }, "task": true }, { "name": "postClusterComputeResourceMoIdClusterEnterMaintenanceMode", "summary": "The API takes a list of hosts in the cluster as input, and\nreturns a list of hosts in \"ClusterMaint", "description": "The API takes a list of hosts in the cluster as input, and\nreturns a list of hosts in \"ClusterMaintenanceResult\" that the\nserver can successfully evacuate given the existing\nconstraints in the cluster, such as HA, FT, Vmotion\ncompatibility, reservations, affinity rules, etc.\n\nThe client is allowed to pass all hosts in the cluster to the\nAPI, even though all of them cannot enter maintenance mode at\nthe same time. The list returned from the API contains the\nlargest number of hosts that the server ...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postClusterComputeResourceMoIdClusterEnterMaintenanceMode" }, "task": true }, { "name": "postClusterComputeResourceMoIdEvcManager", "summary": "A managed object that controls Enhanced vMotion Compatibility mode for\nthis cluster.", "description": "A managed object that controls Enhanced vMotion Compatibility mode for\nthis cluster.\n\n***Required privileges:*** System.Read", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postClusterComputeResourceMoIdEvcManager" }, "task": true }, { "name": "postClusterComputeResourceMoIdExtendHCITask", "summary": "Extend an existing HCI cluster.", "description": "Extend an existing HCI cluster.\n\nThis API requires Host.Inventory.EditCluster privilege on the cluster\nand the hosts, additional privileges might be required depending on the\ninputs.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postClusterComputeResourceMoIdExtendHCITask" }, "task": true }, { "name": "postClusterComputeResourceMoIdFindRulesForVm", "summary": "Finds all enabled and disabled VM-VM Affinity and Anti-Affinity rules,\ninvolving the given Virtual", "description": "Finds all enabled and disabled VM-VM Affinity and Anti-Affinity rules,\ninvolving the given Virtual Machine.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postClusterComputeResourceMoIdFindRulesForVm" }, "task": true }, { "name": "postClusterComputeResourceMoIdGetResourceUsage", "summary": "This API can be invoked to get the current CPU, memory and storage usage\nin the cluster.", "description": "This API can be invoked to get the current CPU, memory and storage usage\nin the cluster.\n\n***Required privileges:*** System.Read", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postClusterComputeResourceMoIdGetResourceUsage" }, "task": true }, { "name": "postClusterComputeResourceMoIdGetSystemVMsRestrictedDatastores", "summary": "Retrieve all the datastores that are either listed in\n*ClusterSystemVMsConfigInfo.notAllowedDatasto", "description": "Retrieve all the datastores that are either listed in\n*ClusterSystemVMsConfigInfo.notAllowedDatastores* or are\ntagged with a category from\n*ClusterSystemVMsConfigInfo.dsTagCategoriesToExclude*.\n\n***Since:*** vSphere API Release 7.0.3.0\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postClusterComputeResourceMoIdGetSystemVMsRestrictedDatastores" }, "task": true }, { "name": "postClusterComputeResourceMoIdMoveHostIntoTask", "summary": "Moves an existing host into a cluster.", "description": "Moves an existing host into a cluster.\n\nThe host must be part of the same\ndatacenter, and if the host is part of a cluster, the host must be in maintenance\nmode.\n\nIf the host is a stand-alone host, the stand-alone ComputeResource is removed\nas part of this operation.\n\nAll virtual machines associated with the host, regardless of whether or not they\nare running, are moved with the host into the cluster. If there are virtual\nmachines that should not be moved, then migrate those virtual machines off...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postClusterComputeResourceMoIdMoveHostIntoTask" }, "task": true }, { "name": "postClusterComputeResourceMoIdMoveIntoTask", "summary": "Moves an existing host into a cluster.", "description": "Moves an existing host into a cluster.\n\nThe host must be part of the same\ndatacenter, and if the host is part of a cluster, the host must be in maintenance\nmode.\n\nIf the host is part of a stand-alone ComputeResource, then the stand-alone\nComputeResource is removed as part of this operation.\n\nAll virtual machines associated with a host, regardless of whether or not they\nare running, are moved with the host into the cluster. If there are virtual\nmachines that should not be moved, then migrate thos...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postClusterComputeResourceMoIdMoveIntoTask" }, "task": true }, { "name": "postClusterComputeResourceMoIdPlaceVm", "summary": "This method returns a *PlacementResult* object.", "description": "This method returns a *PlacementResult* object.\n\nThis API can be invoked to ask DRS for a set of recommendations\nfor moving a virtual machine and its virtual disks into a cluster.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postClusterComputeResourceMoIdPlaceVm" }, "task": true }, { "name": "postClusterComputeResourceMoIdRecommendHostsForVm", "summary": "Gets a recommendation for where to power on, resume, revert\nfrom powered-off state to powered on st", "description": "Deprecated as of VI API 2.5, use *Datacenter.PowerOnMultiVM_Task*.\n*ClusterComputeResource.RecommendHostsForVm* cannot make any recommendations if DRS cannot\nfind the specified host in the cluster.\nWith *Datacenter.PowerOnMultiVM_Task*, DRS attempts to migrate virtual machines\nand power on hosts in standby mode, given the same conditions.\n\nGets a recommendation for where to power on, resume, revert\nfrom powered-off state to powered on state, or to migrate a\nspecific virtual machine.\n\nIf no host ...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postClusterComputeResourceMoIdRecommendHostsForVm" }, "task": true }, { "name": "postClusterComputeResourceMoIdReconfigureClusterTask", "summary": "Reconfigures a cluster.", "description": "Deprecated as of VI API 2.5, use *ComputeResource.ReconfigureComputeResource_Task*.\n\nReconfigures a cluster.\n\n***Required privileges:*** Host.Inventory.EditCluster", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postClusterComputeResourceMoIdReconfigureClusterTask" }, "task": true }, { "name": "postClusterComputeResourceMoIdReconfigureComputeResourceTask", "summary": "Change the compute resource configuration.", "description": "Change the compute resource configuration.\n\n***Required privileges:*** Host.Inventory.EditCluster", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postClusterComputeResourceMoIdReconfigureComputeResourceTask" }, "task": true }, { "name": "postClusterComputeResourceMoIdRefreshRecommendation", "summary": "Make DRS invoke again and return a new list of recommendations.", "description": "Make DRS invoke again and return a new list of recommendations.\n\nConcurrent \"refresh\" requests may be combined together and trigger only\none DRS invocation.\n\nThe recommendations generated is stored at *ClusterComputeResource.recommendation*.\n\n***Required privileges:*** Host.Inventory.EditCluster", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postClusterComputeResourceMoIdRefreshRecommendation" }, "task": true }, { "name": "postClusterComputeResourceMoIdReload", "summary": "Reload the entity state.", "description": "Reload the entity state.\n\nClients only need to call this method\nif they changed some external state that affects the service\nwithout using the Web service interface to perform the change.\nFor example, hand-editing a virtual machine configuration file\naffects the configuration of the associated virtual machine but\nthe service managing the virtual machine might not monitor the\nfile for changes. In this case, after such an edit, a client\nwould call \"reload\" on the associated virtual machine to ensu...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postClusterComputeResourceMoIdReload" }, "task": true }, { "name": "postClusterComputeResourceMoIdRenameTask", "summary": "Renames this managed entity.", "description": "Renames this managed entity.\n\nAny % (percent) character used in this name parameter\nmust be escaped, unless it is used to start an escape\nsequence. Clients may also escape any other characters in\nthis name parameter.\n\nSee also *ManagedEntity.name*.\n\n***Required privileges:*** Host.Inventory.RenameCluster", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postClusterComputeResourceMoIdRenameTask" }, "task": true }, { "name": "postClusterComputeResourceMoIdRetrieveDasAdvancedRuntimeInfo", "summary": "Retrieve DAS advanced runtime info for this cluster.", "description": "Retrieve DAS advanced runtime info for this cluster.\n\n***Required privileges:*** System.Read", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postClusterComputeResourceMoIdRetrieveDasAdvancedRuntimeInfo" }, "task": true }, { "name": "postClusterComputeResourceMoIdSetCryptoMode", "summary": "Set the desired encryption mode and host key for the cluster.", "description": "Set the desired encryption mode and host key for the cluster.\n\nThe cryptoMode parameter can be used to set crypto mode policy for the\ncluster.\n\nThe desired host key of the cluster can also be specified optionally\nusing the policy parameter.\n\n***Required privileges:*** Cryptographer.RegisterHost", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postClusterComputeResourceMoIdSetCryptoMode" }, "task": true }, { "name": "postClusterComputeResourceMoIdSetCustomValue", "summary": "Assigns a value to a custom field.", "description": "Assigns a value to a custom field.\n\nThe setCustomValue method requires\nwhichever updatePrivilege is defined as one of the\n*CustomFieldDef.fieldInstancePrivileges*\nfor the CustomFieldDef whose value is being changed.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postClusterComputeResourceMoIdSetCustomValue" }, "task": true }, { "name": "postClusterComputeResourceMoIdStampAllRulesWithUuidTask", "summary": "Stamp all rules in the cluster with ruleUuid.", "description": "Stamp all rules in the cluster with ruleUuid.\n\nIf a rule has ruleUuid field set, and it has a value, leave it untouched.\nIf rule's ruleUuid field is unset, generate a UUID and stamp the rule.\n\n***Required privileges:*** Host.Inventory.EditCluster", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postClusterComputeResourceMoIdStampAllRulesWithUuidTask" }, "task": true }, { "name": "postClusterComputeResourceMoIdValidateHCIConfiguration", "summary": "Validate HCI configuration in pre-configure and post-configure use-cases.", "description": "Validate HCI configuration in pre-configure and post-configure use-cases.\n1. pre-configure use-case: Validates the HCI configuration to be applied on\n the cluster. A successful validation in this case means the HCIConfigSpec\n can be applied without errors on the cluster using\n *ClusterComputeResource.ConfigureHCI_Task* or\n *ClusterComputeResource.ExtendHCI_Task*\n These are the things the API validates:\n 1. When providing a set of physical adapters in the\n *ClusterComputeResour...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postClusterComputeResourceMoIdValidateHCIConfiguration" }, "task": true }, { "name": "getClusterComputeResourceMoIdActionHistory", "summary": "The set of actions that have been performed recently.", "description": "The set of actions that have been performed recently.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getClusterComputeResourceMoIdActionHistory" }, "task": true }, { "name": "getClusterComputeResourceMoIdAlarmActionsEnabled", "summary": "Whether alarm actions are enabled for this entity.", "description": "Whether alarm actions are enabled for this entity.\n\nTrue if enabled; false otherwise.\n\n***Required privileges:*** System.Read", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getClusterComputeResourceMoIdAlarmActionsEnabled" }, "task": true }, { "name": "getClusterComputeResourceMoIdAvailableField", "summary": "List of custom field definitions that are valid for the object's type.", "description": "List of custom field definitions that are valid for the object's type.\n\nThe fields are sorted by *CustomFieldDef.name*.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getClusterComputeResourceMoIdAvailableField" }, "task": true }, { "name": "getClusterComputeResourceMoIdConfigIssue", "summary": "Current configuration issues that have been detected for this entity.", "description": "Current configuration issues that have been detected for this entity.\n\nTypically,\nthese issues have already been logged as events. The entity stores these\nevents as long as they are still current. The\n*configStatus* property provides an overall status\nbased on these events.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getClusterComputeResourceMoIdConfigIssue" }, "task": true }, { "name": "getClusterComputeResourceMoIdConfigManagerEnabled", "summary": "Flag indicating whether or not desired configuration\nmanagement platform is enabled on the compute", "description": "Flag indicating whether or not desired configuration\nmanagement platform is enabled on the compute resource.\n\nThis property can be set only at the time of creation or through the\n*ComputeResource.EnableConfigurationManagement* method.\n\n***Since:*** vSphere API Release 8.0.0.0\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getClusterComputeResourceMoIdConfigManagerEnabled" }, "task": true }, { "name": "getClusterComputeResourceMoIdConfigStatus", "summary": "The configStatus indicates whether or not the system has detected a configuration\nissue involving t", "description": "The configStatus indicates whether or not the system has detected a configuration\nissue involving this entity.\n\nFor example, it might have detected a\nduplicate IP address or MAC address, or a host in a cluster\nmight be out of compliance. The meanings of the configStatus values are:\n- red: A problem has been detected involving the entity.\n- yellow: A problem is about to occur or a transient condition\n has occurred (For example, reconfigure fail-over policy).\n- green: No configuration issues have...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getClusterComputeResourceMoIdConfigStatus" }, "task": true }, { "name": "getClusterComputeResourceMoIdConfiguration", "summary": "Configuration of the cluster.", "description": "Deprecated as of VI API 2.5, use *ComputeResource.configurationEx*,\nwhich is a *ClusterConfigInfoEx* data object..\n\nConfiguration of the cluster.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getClusterComputeResourceMoIdConfiguration" }, "task": true }, { "name": "getClusterComputeResourceMoIdConfigurationEx", "summary": "Configuration of the compute resource; applies to both standalone hosts\nand clusters.", "description": "Configuration of the compute resource; applies to both standalone hosts\nand clusters.\n\nFor a cluster this property will return a\n*ClusterConfigInfoEx* object.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getClusterComputeResourceMoIdConfigurationEx" }, "task": true }, { "name": "getClusterComputeResourceMoIdCustomValue", "summary": "Custom field values.", "description": "Custom field values.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getClusterComputeResourceMoIdCustomValue" }, "task": true }, { "name": "getClusterComputeResourceMoIdDatastore", "summary": "The datastore property is the subset of datastore objects in the datacenter\navailable in this Compu", "description": "The datastore property is the subset of datastore objects in the datacenter\navailable in this ComputeResource.\n\nThis property is computed as the aggregate set of datastores available from all\nthe hosts that are part of this compute resource.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getClusterComputeResourceMoIdDatastore" }, "task": true }, { "name": "getClusterComputeResourceMoIdDeclaredAlarmState", "summary": "A set of alarm states for alarms that apply to this managed entity.", "description": "A set of alarm states for alarms that apply to this managed entity.\n\nThe set includes alarms defined on this entity\nand alarms inherited from the parent entity,\nor from any ancestors in the inventory hierarchy.\n\nAlarms are inherited if they can be triggered by this entity or its descendants.\nThis set does not include alarms that are defined on descendants of this entity.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getClusterComputeResourceMoIdDeclaredAlarmState" }, "task": true }, { "name": "getClusterComputeResourceMoIdDisabledMethod", "summary": "List of operations that are disabled, given the current runtime\nstate of the entity.", "description": "List of operations that are disabled, given the current runtime\nstate of the entity.\n\nFor example, a power-on operation always fails if a\nvirtual machine is already powered on. This list can be used by clients to\nenable or disable operations in a graphical user interface.\n\nNote: This list is determined by the current runtime state of an entity,\nnot by its permissions.\n\nThis list may include the following operations for a HostSystem:\n- *HostSystem.EnterMaintenanceMode_Task*\n- *HostSystem.ExitMain...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getClusterComputeResourceMoIdDisabledMethod" }, "task": true }, { "name": "getClusterComputeResourceMoIdDrsFault", "summary": "A collection of the DRS faults generated in the last DRS invocation.", "description": "A collection of the DRS faults generated in the last DRS invocation.\n\nEach element of the collection is the set of faults generated in one\nrecommendation.\nDRS faults are generated when DRS tries to make recommendations\nfor rule enforcement, power management, etc., and indexed in a tree\nstructure with reason for recommendations and VM to migrate (optional)\nas the index keys.\nIn releases after vSphere API 5.0, vSphere Servers might not\ngenerate property collector update notifications for this prop...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getClusterComputeResourceMoIdDrsFault" }, "task": true }, { "name": "getClusterComputeResourceMoIdDrsRecommendation", "summary": "If DRS is enabled, this returns the set of recommended\nmigrations from the DRS module.", "description": "Deprecated as of VI API 2.5, use\n*ClusterComputeResource.recommendation*.\nvSphere 6.5 is the last version where this property is populated.\nLater versions of vSphere no longer populate this property.\n\nIf DRS is enabled, this returns the set of recommended\nmigrations from the DRS module.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getClusterComputeResourceMoIdDrsRecommendation" }, "task": true }, { "name": "getClusterComputeResourceMoIdEffectiveRole", "summary": "Access rights the current session has to this entity.", "description": "Access rights the current session has to this entity.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getClusterComputeResourceMoIdEffectiveRole" }, "task": true }, { "name": "getClusterComputeResourceMoIdEnvironmentBrowser", "summary": "The environment browser object that identifies the environments that are supported\non this compute", "description": "The environment browser object that identifies the environments that are supported\non this compute resource.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getClusterComputeResourceMoIdEnvironmentBrowser" }, "task": true }, { "name": "getClusterComputeResourceMoIdHciConfig", "summary": "This is applicable to clusters which are configured using the HCI\nworkflow and contains data relate", "description": "This is applicable to clusters which are configured using the HCI\nworkflow and contains data related to the workflow and specification.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getClusterComputeResourceMoIdHciConfig" }, "task": true }, { "name": "getClusterComputeResourceMoIdHost", "summary": "List of hosts that are part of this compute resource.", "description": "List of hosts that are part of this compute resource.\n\nIf the compute resource is a\nstandalone type, then this list contains just one element.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getClusterComputeResourceMoIdHost" }, "task": true }, { "name": "getClusterComputeResourceMoIdLifecycleManaged", "summary": "Flag indicating whether or not the lifecycle of the compute resource is\nmanaged.", "description": "Flag indicating whether or not the lifecycle of the compute resource is\nmanaged.\n\nOnce it is enabled, it cannot be disabled.\nThis property can be set only at the time of creation or through the\n*ComputeResource.EnableLifecycleManagement* method.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getClusterComputeResourceMoIdLifecycleManaged" }, "task": true }, { "name": "getClusterComputeResourceMoIdMigrationHistory", "summary": "The set of migration decisions that have recently been performed.", "description": "The set of migration decisions that have recently been performed.\n\nThis list is populated only when DRS is in automatic mode.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getClusterComputeResourceMoIdMigrationHistory" }, "task": true }, { "name": "getClusterComputeResourceMoIdName", "summary": "Name of this entity, unique relative to its parent.", "description": "Name of this entity, unique relative to its parent.\n\nAny / (slash), \\\\ (backslash), character used in this\nname element will be escaped. Similarly, any % (percent) character used in\nthis name element will be escaped, unless it is used to start an escape\nsequence. A slash is escaped as %2F or %2f. A backslash is escaped as %5C or\n%5c, and a percent is escaped as %25.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getClusterComputeResourceMoIdName" }, "task": true }, { "name": "getClusterComputeResourceMoIdNetwork", "summary": "The subset of network objects available in the datacenter that is available in\nthis ComputeResource.", "description": "The subset of network objects available in the datacenter that is available in\nthis ComputeResource.\n\nThis property is computed as the aggregate set of networks available from all the\nhosts that are part of this compute resource.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getClusterComputeResourceMoIdNetwork" }, "task": true }, { "name": "getClusterComputeResourceMoIdOverallStatus", "summary": "General health of this managed entity.", "description": "General health of this managed entity.\n\nThe overall status of the managed entity is computed as the worst status\namong its alarms and the configuration issues detected on the entity.\nThe status is reported as one of the following values:\n- red: The entity has alarms or configuration issues with a red status.\n- yellow: The entity does not have alarms or configuration issues with a\n red status, and has at least one with a yellow status.\n- green: The entity does not have alarms or configuration is...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getClusterComputeResourceMoIdOverallStatus" }, "task": true }, { "name": "getClusterComputeResourceMoIdParent", "summary": "Parent of this entity.", "description": "Parent of this entity.\n\nThis value is null for the root object and for\n*VirtualMachine* objects that are part of\na *VirtualApp*.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getClusterComputeResourceMoIdParent" }, "task": true }, { "name": "getClusterComputeResourceMoIdPermission", "summary": "List of permissions defined for this entity.", "description": "List of permissions defined for this entity.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getClusterComputeResourceMoIdPermission" }, "task": true }, { "name": "getClusterComputeResourceMoIdRecentTask", "summary": "The set of recent tasks operating on this managed entity.", "description": "The set of recent tasks operating on this managed entity.\n\nThis is a subset\nof *TaskManager.recentTask* belong to this entity. A task in this\nlist could be in one of the four states: pending, running, success or error.\n\nThis property can be used to deduce intermediate power states for\na virtual machine entity. For example, if the current powerState is \"poweredOn\"\nand there is a running task performing the \"suspend\" operation, then the virtual\nmachine's intermediate state might be described as \"s...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getClusterComputeResourceMoIdRecentTask" }, "task": true }, { "name": "getClusterComputeResourceMoIdRecommendation", "summary": "List of recommended actions for the cluster.", "description": "List of recommended actions for the cluster.\n\nIt is\npossible that the current set of recommendations may be empty,\neither due to not having any running dynamic recommendation\ngeneration module, or since there may be no recommended actions\nat this time.\n\n***Required privileges:*** System.Read", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getClusterComputeResourceMoIdRecommendation" }, "task": true }, { "name": "getClusterComputeResourceMoIdResourcePool", "summary": "Reference to root resource pool.", "description": "Reference to root resource pool.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getClusterComputeResourceMoIdResourcePool" }, "task": true }, { "name": "getClusterComputeResourceMoIdSummary", "summary": "Basic runtime information about a compute resource.", "description": "Basic runtime information about a compute resource.\n\nThis information is used on\nsummary screens and in list views.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getClusterComputeResourceMoIdSummary" }, "task": true }, { "name": "getClusterComputeResourceMoIdSummaryEx", "summary": "The cluster summary.", "description": "Deprecated do not use this property.\nThe same information could be obtained via\n*ComputeResource.summary*.\n\nThe cluster summary.\n\n***Since:*** vSphere API Release 7.0.1.1", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getClusterComputeResourceMoIdSummaryEx" }, "task": true }, { "name": "getClusterComputeResourceMoIdTag", "summary": "The set of tags associated with this managed entity.", "description": "The set of tags associated with this managed entity.\n\nExperimental. Subject to change.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getClusterComputeResourceMoIdTag" }, "task": true }, { "name": "getClusterComputeResourceMoIdTriggeredAlarmState", "summary": "A set of alarm states for alarms triggered by this entity\nor by its descendants.", "description": "A set of alarm states for alarms triggered by this entity\nor by its descendants.\n\nTriggered alarms are propagated up the inventory hierarchy\nso that a user can readily tell when a descendant has triggered an alarm.\nIn releases after vSphere API 5.0, vSphere Servers might not\ngenerate property collector update notifications for this property.\nTo obtain the latest value of the property, you can use\nPropertyCollector methods RetrievePropertiesEx or WaitForUpdatesEx.\nIf you use the PropertyCollector...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getClusterComputeResourceMoIdTriggeredAlarmState" }, "task": true }, { "name": "getClusterComputeResourceMoIdValue", "summary": "List of custom field values.", "description": "List of custom field values.\n\nEach value uses a key to associate\nan instance of a *CustomFieldStringValue* with\na custom field definition.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getClusterComputeResourceMoIdValue" }, "task": true }, { "name": "postClusterEVCManagerMoIdCheckAddHostEvcTask", "summary": "Test the validity of adding a host into the managed cluster.", "description": "Test the validity of adding a host into the managed cluster.\n\nNote that\nthis method only tests EVC admission control; host-add may fail for\nother reasons.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postClusterEVCManagerMoIdCheckAddHostEvcTask" }, "task": true }, { "name": "postClusterEVCManagerMoIdCheckConfigureEvcModeTask", "summary": "Test the validity of configuring an EVC mode on the managed cluster.", "description": "Test the validity of configuring an EVC mode on the managed cluster.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postClusterEVCManagerMoIdCheckConfigureEvcModeTask" }, "task": true }, { "name": "postClusterEVCManagerMoIdConfigureEvcModeTask", "summary": "Set the EVC mode.", "description": "Set the EVC mode.\n\nIf EVC is currently disabled, then this will enable\nEVC. The parameter must specify a key to one of the EVC modes listed in\nthe *ClusterEVCManagerEVCState.supportedEVCMode* array\nproperty. If there are no modes listed there,\nthen EVC may not currently be enabled; reference the other properties\nin *ClusterEVCManagerEVCState* to determine what conditions are blocking EVC.\n\n***Required privileges:*** Host.Inventory.EditCluster", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postClusterEVCManagerMoIdConfigureEvcModeTask" }, "task": true }, { "name": "postClusterEVCManagerMoIdDisableEvcModeTask", "summary": "Disable EVC.", "description": "Disable EVC.\n\nEVC may be disabled at any time.\n\n***Required privileges:*** Host.Inventory.EditCluster", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postClusterEVCManagerMoIdDisableEvcModeTask" }, "task": true }, { "name": "postClusterEVCManagerMoIdSetCustomValue", "summary": "Assigns a value to a custom field.", "description": "Assigns a value to a custom field.\n\nThe setCustomValue method requires\nwhichever updatePrivilege is defined as one of the\n*CustomFieldDef.fieldInstancePrivileges*\nfor the CustomFieldDef whose value is being changed.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postClusterEVCManagerMoIdSetCustomValue" }, "task": true }, { "name": "getClusterEVCManagerMoIdAvailableField", "summary": "List of custom field definitions that are valid for the object's type.", "description": "List of custom field definitions that are valid for the object's type.\n\nThe fields are sorted by *CustomFieldDef.name*.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getClusterEVCManagerMoIdAvailableField" }, "task": true }, { "name": "getClusterEVCManagerMoIdEvcState", "summary": "EVC-related state of the managed cluster.", "description": "EVC-related state of the managed cluster.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getClusterEVCManagerMoIdEvcState" }, "task": true }, { "name": "getClusterEVCManagerMoIdManagedCluster", "summary": "Cluster associated with this manager object.", "description": "Cluster associated with this manager object.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getClusterEVCManagerMoIdManagedCluster" }, "task": true }, { "name": "getClusterEVCManagerMoIdValue", "summary": "List of custom field values.", "description": "List of custom field values.\n\nEach value uses a key to associate\nan instance of a *CustomFieldStringValue* with\na custom field definition.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getClusterEVCManagerMoIdValue" }, "task": true }, { "name": "postClusterProfileMoIdAssociateProfile", "summary": "Associate a profile with a managed entity.", "description": "Associate a profile with a managed entity.\n\nYou can check the compliance of\nentities associated with a profile by calling the\n*Profile.CheckProfileCompliance_Task* method.\n\n***Required privileges:*** Profile.Edit", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postClusterProfileMoIdAssociateProfile" }, "task": true }, { "name": "postClusterProfileMoIdCheckProfileComplianceTask", "summary": "Check compliance of an entity against a Profile.", "description": "Check compliance of an entity against a Profile.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postClusterProfileMoIdCheckProfileComplianceTask" }, "task": true }, { "name": "postClusterProfileMoIdDestroyProfile", "summary": "Destroy the profile.", "description": "Destroy the profile.\n\n***Required privileges:*** Profile.Delete", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postClusterProfileMoIdDestroyProfile" }, "task": true }, { "name": "postClusterProfileMoIdDissociateProfile", "summary": "Remove the association between a profile and a managed entity.", "description": "Remove the association between a profile and a managed entity.\n\n***Required privileges:*** Profile.Edit", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postClusterProfileMoIdDissociateProfile" }, "task": true }, { "name": "postClusterProfileMoIdExportProfile", "summary": "Export the profile in a serialized form.", "description": "Export the profile in a serialized form.\n\nTo use the serialized string to create a profile,\nspecify a *ProfileSerializedCreateSpec* when you call the\n*HostProfileManager*.*ProfileManager.CreateProfile*\nmethod.\n\n***Required privileges:*** Profile.Export", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postClusterProfileMoIdExportProfile" }, "task": true }, { "name": "postClusterProfileMoIdRetrieveDescription", "summary": "Returns the localizable description for the profile.", "description": "Returns the localizable description for the profile.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postClusterProfileMoIdRetrieveDescription" }, "task": true }, { "name": "postClusterProfileMoIdUpdateClusterProfile", "summary": "Update the ClusterProfile with the specified config.", "description": "Update the ClusterProfile with the specified config.\n\n***Required privileges:*** Profile.Edit", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postClusterProfileMoIdUpdateClusterProfile" }, "task": true }, { "name": "getClusterProfileMoIdComplianceStatus", "summary": "Overall compliance of entities associated with this profile.", "description": "Overall compliance of entities associated with this profile.\n\nIf one of the entities is out of compliance, the profile is nonCompliant .\nIf all entities are in compliance, the profile is compliant .\nIf the compliance status of one of the entities is not known, compliance status\nof the profile is unknown .\nSee *ComplianceResultStatus_enum*.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getClusterProfileMoIdComplianceStatus" }, "task": true }, { "name": "getClusterProfileMoIdConfig", "summary": "Configuration data for the profile.", "description": "Configuration data for the profile.\n\n***Required privileges:*** Profile.Edit", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getClusterProfileMoIdConfig" }, "task": true }, { "name": "getClusterProfileMoIdCreatedTime", "summary": "Time at which the profile was created.", "description": "Time at which the profile was created.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getClusterProfileMoIdCreatedTime" }, "task": true }, { "name": "getClusterProfileMoIdDescription", "summary": "Localizable description of the profile", "description": "Deprecated as of vSphere API 5.0. use *Profile.RetrieveDescription* instead.\n\nLocalizable description of the profile", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getClusterProfileMoIdDescription" }, "task": true }, { "name": "getClusterProfileMoIdEntity", "summary": "List of managed entities associated with the profile.", "description": "List of managed entities associated with the profile.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getClusterProfileMoIdEntity" }, "task": true }, { "name": "getClusterProfileMoIdModifiedTime", "summary": "Time at which the profile was last modified.", "description": "Time at which the profile was last modified.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getClusterProfileMoIdModifiedTime" }, "task": true }, { "name": "getClusterProfileMoIdName", "summary": "Name of the profile.", "description": "Name of the profile.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getClusterProfileMoIdName" }, "task": true }, { "name": "postClusterProfileManagerMoIdCreateProfile", "summary": "Create a profile from the specified CreateSpec.", "description": "Create a profile from the specified CreateSpec.\n\n***Required privileges:*** Profile.Create", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postClusterProfileManagerMoIdCreateProfile" }, "task": true }, { "name": "postClusterProfileManagerMoIdFindAssociatedProfile", "summary": "Get the profile(s) to which this entity is associated.", "description": "Get the profile(s) to which this entity is associated.\n\nThe list of profiles will only include profiles known to this\nprofileManager.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postClusterProfileManagerMoIdFindAssociatedProfile" }, "task": true }, { "name": "postClusterProfileManagerMoIdQueryPolicyMetadata", "summary": "Get the Metadata information for the policyNames.", "description": "Get the Metadata information for the policyNames.\n\nPolicyNames are available with the defaultProfile obtained by invoking the\nmethod createDefaultProfile.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postClusterProfileManagerMoIdQueryPolicyMetadata" }, "task": true }, { "name": "getClusterProfileManagerMoIdProfile", "summary": "A list of profiles known to this ProfileManager.", "description": "A list of profiles known to this ProfileManager.\n\n***Required privileges:*** Profile.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getClusterProfileManagerMoIdProfile" }, "task": true }, { "name": "postComputeResourceMoIdDestroyTask", "summary": "Destroys this object, deleting its contents and removing it from its parent\nfolder (if any).", "description": "Destroys this object, deleting its contents and removing it from its parent\nfolder (if any).\n\nNOTE: The appropriate privilege must be held on the parent of the destroyed\nentity as well as the entity itself.\nThis method can throw one of several exceptions. The exact set of exceptions\ndepends on the kind of entity that is being removed. See comments for\neach entity for more information on destroy behavior.\n\n***Required privileges:*** Host.Inventory.RemoveHostFromCluster", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postComputeResourceMoIdDestroyTask" }, "task": true }, { "name": "postComputeResourceMoIdReconfigureComputeResourceTask", "summary": "Change the compute resource configuration.", "description": "Change the compute resource configuration.\n\n***Required privileges:*** Host.Inventory.EditCluster", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postComputeResourceMoIdReconfigureComputeResourceTask" }, "task": true }, { "name": "postComputeResourceMoIdReload", "summary": "Reload the entity state.", "description": "Reload the entity state.\n\nClients only need to call this method\nif they changed some external state that affects the service\nwithout using the Web service interface to perform the change.\nFor example, hand-editing a virtual machine configuration file\naffects the configuration of the associated virtual machine but\nthe service managing the virtual machine might not monitor the\nfile for changes. In this case, after such an edit, a client\nwould call \"reload\" on the associated virtual machine to ensu...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postComputeResourceMoIdReload" }, "task": true }, { "name": "postComputeResourceMoIdRenameTask", "summary": "Renames this managed entity.", "description": "Renames this managed entity.\n\nAny % (percent) character used in this name parameter\nmust be escaped, unless it is used to start an escape\nsequence. Clients may also escape any other characters in\nthis name parameter.\n\nSee also *ManagedEntity.name*.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postComputeResourceMoIdRenameTask" }, "task": true }, { "name": "postComputeResourceMoIdSetCustomValue", "summary": "Assigns a value to a custom field.", "description": "Assigns a value to a custom field.\n\nThe setCustomValue method requires\nwhichever updatePrivilege is defined as one of the\n*CustomFieldDef.fieldInstancePrivileges*\nfor the CustomFieldDef whose value is being changed.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postComputeResourceMoIdSetCustomValue" }, "task": true }, { "name": "getComputeResourceMoIdAlarmActionsEnabled", "summary": "Whether alarm actions are enabled for this entity.", "description": "Whether alarm actions are enabled for this entity.\n\nTrue if enabled; false otherwise.\n\n***Required privileges:*** System.Read", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getComputeResourceMoIdAlarmActionsEnabled" }, "task": true }, { "name": "getComputeResourceMoIdAvailableField", "summary": "List of custom field definitions that are valid for the object's type.", "description": "List of custom field definitions that are valid for the object's type.\n\nThe fields are sorted by *CustomFieldDef.name*.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getComputeResourceMoIdAvailableField" }, "task": true }, { "name": "getComputeResourceMoIdConfigIssue", "summary": "Current configuration issues that have been detected for this entity.", "description": "Current configuration issues that have been detected for this entity.\n\nTypically,\nthese issues have already been logged as events. The entity stores these\nevents as long as they are still current. The\n*configStatus* property provides an overall status\nbased on these events.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getComputeResourceMoIdConfigIssue" }, "task": true }, { "name": "getComputeResourceMoIdConfigManagerEnabled", "summary": "Flag indicating whether or not desired configuration\nmanagement platform is enabled on the compute", "description": "Flag indicating whether or not desired configuration\nmanagement platform is enabled on the compute resource.\n\nThis property can be set only at the time of creation or through the\n*ComputeResource.EnableConfigurationManagement* method.\n\n***Since:*** vSphere API Release 8.0.0.0\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getComputeResourceMoIdConfigManagerEnabled" }, "task": true }, { "name": "getComputeResourceMoIdConfigStatus", "summary": "The configStatus indicates whether or not the system has detected a configuration\nissue involving t", "description": "The configStatus indicates whether or not the system has detected a configuration\nissue involving this entity.\n\nFor example, it might have detected a\nduplicate IP address or MAC address, or a host in a cluster\nmight be out of compliance. The meanings of the configStatus values are:\n- red: A problem has been detected involving the entity.\n- yellow: A problem is about to occur or a transient condition\n has occurred (For example, reconfigure fail-over policy).\n- green: No configuration issues have...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getComputeResourceMoIdConfigStatus" }, "task": true }, { "name": "getComputeResourceMoIdConfigurationEx", "summary": "Configuration of the compute resource; applies to both standalone hosts\nand clusters.", "description": "Configuration of the compute resource; applies to both standalone hosts\nand clusters.\n\nFor a cluster this property will return a\n*ClusterConfigInfoEx* object.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getComputeResourceMoIdConfigurationEx" }, "task": true }, { "name": "getComputeResourceMoIdCustomValue", "summary": "Custom field values.", "description": "Custom field values.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getComputeResourceMoIdCustomValue" }, "task": true }, { "name": "getComputeResourceMoIdDatastore", "summary": "The datastore property is the subset of datastore objects in the datacenter\navailable in this Compu", "description": "The datastore property is the subset of datastore objects in the datacenter\navailable in this ComputeResource.\n\nThis property is computed as the aggregate set of datastores available from all\nthe hosts that are part of this compute resource.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getComputeResourceMoIdDatastore" }, "task": true }, { "name": "getComputeResourceMoIdDeclaredAlarmState", "summary": "A set of alarm states for alarms that apply to this managed entity.", "description": "A set of alarm states for alarms that apply to this managed entity.\n\nThe set includes alarms defined on this entity\nand alarms inherited from the parent entity,\nor from any ancestors in the inventory hierarchy.\n\nAlarms are inherited if they can be triggered by this entity or its descendants.\nThis set does not include alarms that are defined on descendants of this entity.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getComputeResourceMoIdDeclaredAlarmState" }, "task": true }, { "name": "getComputeResourceMoIdDisabledMethod", "summary": "List of operations that are disabled, given the current runtime\nstate of the entity.", "description": "List of operations that are disabled, given the current runtime\nstate of the entity.\n\nFor example, a power-on operation always fails if a\nvirtual machine is already powered on. This list can be used by clients to\nenable or disable operations in a graphical user interface.\n\nNote: This list is determined by the current runtime state of an entity,\nnot by its permissions.\n\nThis list may include the following operations for a HostSystem:\n- *HostSystem.EnterMaintenanceMode_Task*\n- *HostSystem.ExitMain...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getComputeResourceMoIdDisabledMethod" }, "task": true }, { "name": "getComputeResourceMoIdEffectiveRole", "summary": "Access rights the current session has to this entity.", "description": "Access rights the current session has to this entity.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getComputeResourceMoIdEffectiveRole" }, "task": true }, { "name": "getComputeResourceMoIdEnvironmentBrowser", "summary": "The environment browser object that identifies the environments that are supported\non this compute", "description": "The environment browser object that identifies the environments that are supported\non this compute resource.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getComputeResourceMoIdEnvironmentBrowser" }, "task": true }, { "name": "getComputeResourceMoIdHost", "summary": "List of hosts that are part of this compute resource.", "description": "List of hosts that are part of this compute resource.\n\nIf the compute resource is a\nstandalone type, then this list contains just one element.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getComputeResourceMoIdHost" }, "task": true }, { "name": "getComputeResourceMoIdLifecycleManaged", "summary": "Flag indicating whether or not the lifecycle of the compute resource is\nmanaged.", "description": "Flag indicating whether or not the lifecycle of the compute resource is\nmanaged.\n\nOnce it is enabled, it cannot be disabled.\nThis property can be set only at the time of creation or through the\n*ComputeResource.EnableLifecycleManagement* method.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getComputeResourceMoIdLifecycleManaged" }, "task": true }, { "name": "getComputeResourceMoIdName", "summary": "Name of this entity, unique relative to its parent.", "description": "Name of this entity, unique relative to its parent.\n\nAny / (slash), \\\\ (backslash), character used in this\nname element will be escaped. Similarly, any % (percent) character used in\nthis name element will be escaped, unless it is used to start an escape\nsequence. A slash is escaped as %2F or %2f. A backslash is escaped as %5C or\n%5c, and a percent is escaped as %25.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getComputeResourceMoIdName" }, "task": true }, { "name": "getComputeResourceMoIdNetwork", "summary": "The subset of network objects available in the datacenter that is available in\nthis ComputeResource.", "description": "The subset of network objects available in the datacenter that is available in\nthis ComputeResource.\n\nThis property is computed as the aggregate set of networks available from all the\nhosts that are part of this compute resource.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getComputeResourceMoIdNetwork" }, "task": true }, { "name": "getComputeResourceMoIdOverallStatus", "summary": "General health of this managed entity.", "description": "General health of this managed entity.\n\nThe overall status of the managed entity is computed as the worst status\namong its alarms and the configuration issues detected on the entity.\nThe status is reported as one of the following values:\n- red: The entity has alarms or configuration issues with a red status.\n- yellow: The entity does not have alarms or configuration issues with a\n red status, and has at least one with a yellow status.\n- green: The entity does not have alarms or configuration is...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getComputeResourceMoIdOverallStatus" }, "task": true }, { "name": "getComputeResourceMoIdParent", "summary": "Parent of this entity.", "description": "Parent of this entity.\n\nThis value is null for the root object and for\n*VirtualMachine* objects that are part of\na *VirtualApp*.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getComputeResourceMoIdParent" }, "task": true }, { "name": "getComputeResourceMoIdPermission", "summary": "List of permissions defined for this entity.", "description": "List of permissions defined for this entity.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getComputeResourceMoIdPermission" }, "task": true }, { "name": "getComputeResourceMoIdRecentTask", "summary": "The set of recent tasks operating on this managed entity.", "description": "The set of recent tasks operating on this managed entity.\n\nThis is a subset\nof *TaskManager.recentTask* belong to this entity. A task in this\nlist could be in one of the four states: pending, running, success or error.\n\nThis property can be used to deduce intermediate power states for\na virtual machine entity. For example, if the current powerState is \"poweredOn\"\nand there is a running task performing the \"suspend\" operation, then the virtual\nmachine's intermediate state might be described as \"s...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getComputeResourceMoIdRecentTask" }, "task": true }, { "name": "getComputeResourceMoIdResourcePool", "summary": "Reference to root resource pool.", "description": "Reference to root resource pool.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getComputeResourceMoIdResourcePool" }, "task": true }, { "name": "getComputeResourceMoIdSummary", "summary": "Basic runtime information about a compute resource.", "description": "Basic runtime information about a compute resource.\n\nThis information is used on\nsummary screens and in list views.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getComputeResourceMoIdSummary" }, "task": true }, { "name": "getComputeResourceMoIdTag", "summary": "The set of tags associated with this managed entity.", "description": "The set of tags associated with this managed entity.\n\nExperimental. Subject to change.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getComputeResourceMoIdTag" }, "task": true }, { "name": "getComputeResourceMoIdTriggeredAlarmState", "summary": "A set of alarm states for alarms triggered by this entity\nor by its descendants.", "description": "A set of alarm states for alarms triggered by this entity\nor by its descendants.\n\nTriggered alarms are propagated up the inventory hierarchy\nso that a user can readily tell when a descendant has triggered an alarm.\nIn releases after vSphere API 5.0, vSphere Servers might not\ngenerate property collector update notifications for this property.\nTo obtain the latest value of the property, you can use\nPropertyCollector methods RetrievePropertiesEx or WaitForUpdatesEx.\nIf you use the PropertyCollector...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getComputeResourceMoIdTriggeredAlarmState" }, "task": true }, { "name": "getComputeResourceMoIdValue", "summary": "List of custom field values.", "description": "List of custom field values.\n\nEach value uses a key to associate\nan instance of a *CustomFieldStringValue* with\na custom field definition.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getComputeResourceMoIdValue" }, "task": true }, { "name": "postContainerViewMoIdDestroyView", "summary": "Destroy this view.", "description": "Destroy this view.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postContainerViewMoIdDestroyView" }, "task": true }, { "name": "getContainerViewMoIdContainer", "summary": "The Folder, Datacenter, ComputeResource, ResourcePool, or HostSystem instance\nthat provides the obj", "description": "The Folder, Datacenter, ComputeResource, ResourcePool, or HostSystem instance\nthat provides the objects that the view presents.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getContainerViewMoIdContainer" }, "task": true }, { "name": "getContainerViewMoIdRecursive", "summary": "Whether to include only the immediate children of the container instance,\nor to include additional", "description": "Whether to include only the immediate children of the container instance,\nor to include additional objects by following the paths beyond the\nimmediate children.\n\nFor information about recursive behavior, see the description of\n*ViewManager.CreateContainerView*.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getContainerViewMoIdRecursive" }, "task": true }, { "name": "getContainerViewMoIdType", "summary": "An optional list of types to be applied to the set of objects in the view.", "description": "An optional list of types to be applied to the set of objects in the view.\n\nThe list of types indicates objects that are included in the view.\nIf empty, all types are included.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getContainerViewMoIdType" }, "task": true }, { "name": "getContainerViewMoIdView", "summary": "The list of references to objects mapped by this view.", "description": "The list of references to objects mapped by this view.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getContainerViewMoIdView" }, "task": true }, { "name": "postCryptoManagerMoIdAddKey", "summary": "Add an existing key.", "description": "Add an existing key.\n\n***Required privileges:*** Cryptographer.ManageKeys", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postCryptoManagerMoIdAddKey" }, "task": true }, { "name": "postCryptoManagerMoIdAddKeys", "summary": "Add multiple existing keys.", "description": "Add multiple existing keys.\n\n***Required privileges:*** Cryptographer.ManageKeys", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postCryptoManagerMoIdAddKeys" }, "task": true }, { "name": "postCryptoManagerMoIdListKeys", "summary": "List keys.", "description": "List keys.\n\n\\* When executed against the host, lists all the keys\nadded to the host's key cache by *CryptoManager.AddKey*\\/*CryptoManager.AddKeys*.\n\\* When executed against the VC, lists all the keys used by\nthe correctly registered VMs, and the host key.\n\n***Required privileges:*** Cryptographer.ManageKeys", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postCryptoManagerMoIdListKeys" }, "task": true }, { "name": "postCryptoManagerMoIdRemoveKey", "summary": "Remove a key (only the UUID is needed to remove).", "description": "Remove a key (only the UUID is needed to remove).\n\nIf \"force\" is set, removal will happen even if the key is in use.\n\n***Required privileges:*** Cryptographer.ManageKeys", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postCryptoManagerMoIdRemoveKey" }, "task": true }, { "name": "postCryptoManagerMoIdRemoveKeys", "summary": "Remove multiple keys (only the UUID is needed to remove).", "description": "Remove multiple keys (only the UUID is needed to remove).\n\nIf \"force\" is set, removal will happen even if they are in use.\n\n***Required privileges:*** Cryptographer.ManageKeys", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postCryptoManagerMoIdRemoveKeys" }, "task": true }, { "name": "getCryptoManagerMoIdEnabled", "summary": "Indicate if the encryption feature is enabled.", "description": "Indicate if the encryption feature is enabled.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getCryptoManagerMoIdEnabled" }, "task": true }, { "name": "postCryptoManagerHostMoIdAddKey", "summary": "Add an existing key.", "description": "Add an existing key.\n\n***Required privileges:*** Cryptographer.ManageKeys", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postCryptoManagerHostMoIdAddKey" }, "task": true }, { "name": "postCryptoManagerHostMoIdAddKeys", "summary": "Add multiple existing keys.", "description": "Add multiple existing keys.\n\n***Required privileges:*** Cryptographer.ManageKeys", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postCryptoManagerHostMoIdAddKeys" }, "task": true }, { "name": "postCryptoManagerHostMoIdChangeKeyTask", "summary": "Change the key used for core dump encryption\nNote: *CryptoManagerHost.CryptoManagerHostEnable* must", "description": "Change the key used for core dump encryption\nNote: *CryptoManagerHost.CryptoManagerHostEnable* must be called first\nIf successful, a \"best effort\" will be made to \"in place\" shallow recrypt\nany core dumps found in /var/core to use the new key.\n\n***Required privileges:*** Cryptographer.RegisterHost", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postCryptoManagerHostMoIdChangeKeyTask" }, "task": true }, { "name": "postCryptoManagerHostMoIdCryptoManagerHostDisable", "summary": "Disable encryption on host, if host was in crypto safe mode, put it in\npendingIncapable state and h", "description": "Disable encryption on host, if host was in crypto safe mode, put it in\npendingIncapable state and host will be crypto incapable after a reboot\nNote: A reboot is expected from user after successfully invoking this API\nNote: Do not call this API if the host is in vSAN encrypted cluster\n\n***Required privileges:*** Cryptographer.RegisterHost", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postCryptoManagerHostMoIdCryptoManagerHostDisable" }, "task": true }, { "name": "postCryptoManagerHostMoIdCryptoManagerHostEnable", "summary": "Begin core dump encryption by specifying the encryption key and put\nthe host in *safe* state\nNote:", "description": "Begin core dump encryption by specifying the encryption key and put\nthe host in *safe* state\nNote: *CryptoManagerHost.CryptoManagerHostPrepare* must be called first\n\n***Required privileges:*** Cryptographer.RegisterHost", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postCryptoManagerHostMoIdCryptoManagerHostEnable" }, "task": true }, { "name": "postCryptoManagerHostMoIdGetCryptoKeyStatus", "summary": "Get the key status on the host.", "description": "Get the key status on the host.\n\n***Since:*** vSphere API Release 8.0.1.0\n\n***Required privileges:*** Cryptographer.ManageKeys", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postCryptoManagerHostMoIdGetCryptoKeyStatus" }, "task": true }, { "name": "postCryptoManagerHostMoIdListKeys", "summary": "List keys.", "description": "List keys.\n\n\\* When executed against the host, lists all the keys\nadded to the host's key cache by *CryptoManager.AddKey*\\/*CryptoManager.AddKeys*.\n\\* When executed against the VC, lists all the keys used by\nthe correctly registered VMs, and the host key.\n\n***Required privileges:*** Cryptographer.ManageKeys", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postCryptoManagerHostMoIdListKeys" }, "task": true }, { "name": "postCryptoManagerHostMoIdCryptoManagerHostPrepare", "summary": "Prime the host to receive sensitive information and put the host\nin *prepared* state", "description": "Prime the host to receive sensitive information and put the host\nin *prepared* state\n\n***Required privileges:*** Cryptographer.RegisterHost", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postCryptoManagerHostMoIdCryptoManagerHostPrepare" }, "task": true }, { "name": "postCryptoManagerHostMoIdRemoveKey", "summary": "Remove a key (only the UUID is needed to remove).", "description": "Remove a key (only the UUID is needed to remove).\n\nIf \"force\" is set, removal will happen even if the key is in use.\n\n***Required privileges:*** Cryptographer.ManageKeys", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postCryptoManagerHostMoIdRemoveKey" }, "task": true }, { "name": "postCryptoManagerHostMoIdRemoveKeys", "summary": "Remove multiple keys (only the UUID is needed to remove).", "description": "Remove multiple keys (only the UUID is needed to remove).\n\nIf \"force\" is set, removal will happen even if they are in use.\n\n***Required privileges:*** Cryptographer.ManageKeys", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postCryptoManagerHostMoIdRemoveKeys" }, "task": true }, { "name": "getCryptoManagerHostMoIdEnabled", "summary": "Indicate if the encryption feature is enabled.", "description": "Indicate if the encryption feature is enabled.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getCryptoManagerHostMoIdEnabled" }, "task": true }, { "name": "postCryptoManagerHostKMSMoIdAddKey", "summary": "Add an existing key.", "description": "Add an existing key.\n\n***Required privileges:*** Cryptographer.ManageKeys", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postCryptoManagerHostKMSMoIdAddKey" }, "task": true }, { "name": "postCryptoManagerHostKMSMoIdAddKeys", "summary": "Add multiple existing keys.", "description": "Add multiple existing keys.\n\n***Required privileges:*** Cryptographer.ManageKeys", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postCryptoManagerHostKMSMoIdAddKeys" }, "task": true }, { "name": "postCryptoManagerHostKMSMoIdChangeKeyTask", "summary": "Change the key used for core dump encryption\nNote: *CryptoManagerHost.CryptoManagerHostEnable* must", "description": "Change the key used for core dump encryption\nNote: *CryptoManagerHost.CryptoManagerHostEnable* must be called first\nIf successful, a \"best effort\" will be made to \"in place\" shallow recrypt\nany core dumps found in /var/core to use the new key.\n\n***Required privileges:*** Cryptographer.RegisterHost", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postCryptoManagerHostKMSMoIdChangeKeyTask" }, "task": true }, { "name": "postCryptoManagerHostKMSMoIdCryptoManagerHostDisable", "summary": "Disable encryption on host, if host was in crypto safe mode, put it in\npendingIncapable state and h", "description": "Disable encryption on host, if host was in crypto safe mode, put it in\npendingIncapable state and host will be crypto incapable after a reboot\nNote: A reboot is expected from user after successfully invoking this API\nNote: Do not call this API if the host is in vSAN encrypted cluster\n\n***Required privileges:*** Cryptographer.RegisterHost", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postCryptoManagerHostKMSMoIdCryptoManagerHostDisable" }, "task": true }, { "name": "postCryptoManagerHostKMSMoIdCryptoManagerHostEnable", "summary": "Begin core dump encryption by specifying the encryption key and put\nthe host in *safe* state\nNote:", "description": "Begin core dump encryption by specifying the encryption key and put\nthe host in *safe* state\nNote: *CryptoManagerHost.CryptoManagerHostPrepare* must be called first\n\n***Required privileges:*** Cryptographer.RegisterHost", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postCryptoManagerHostKMSMoIdCryptoManagerHostEnable" }, "task": true }, { "name": "postCryptoManagerHostKMSMoIdGetCryptoKeyStatus", "summary": "Get the key status on the host.", "description": "Get the key status on the host.\n\n***Since:*** vSphere API Release 8.0.1.0\n\n***Required privileges:*** Cryptographer.ManageKeys", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postCryptoManagerHostKMSMoIdGetCryptoKeyStatus" }, "task": true }, { "name": "postCryptoManagerHostKMSMoIdListKeys", "summary": "List keys.", "description": "List keys.\n\n\\* When executed against the host, lists all the keys\nadded to the host's key cache by *CryptoManager.AddKey*\\/*CryptoManager.AddKeys*.\n\\* When executed against the VC, lists all the keys used by\nthe correctly registered VMs, and the host key.\n\n***Required privileges:*** Cryptographer.ManageKeys", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postCryptoManagerHostKMSMoIdListKeys" }, "task": true }, { "name": "postCryptoManagerHostKMSMoIdCryptoManagerHostPrepare", "summary": "Prime the host to receive sensitive information and put the host\nin *prepared* state", "description": "Prime the host to receive sensitive information and put the host\nin *prepared* state\n\n***Required privileges:*** Cryptographer.RegisterHost", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postCryptoManagerHostKMSMoIdCryptoManagerHostPrepare" }, "task": true }, { "name": "postCryptoManagerHostKMSMoIdRemoveKey", "summary": "Remove a key (only the UUID is needed to remove).", "description": "Remove a key (only the UUID is needed to remove).\n\nIf \"force\" is set, removal will happen even if the key is in use.\n\n***Required privileges:*** Cryptographer.ManageKeys", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postCryptoManagerHostKMSMoIdRemoveKey" }, "task": true }, { "name": "postCryptoManagerHostKMSMoIdRemoveKeys", "summary": "Remove multiple keys (only the UUID is needed to remove).", "description": "Remove multiple keys (only the UUID is needed to remove).\n\nIf \"force\" is set, removal will happen even if they are in use.\n\n***Required privileges:*** Cryptographer.ManageKeys", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postCryptoManagerHostKMSMoIdRemoveKeys" }, "task": true }, { "name": "getCryptoManagerHostKMSMoIdEnabled", "summary": "Indicate if the encryption feature is enabled.", "description": "Indicate if the encryption feature is enabled.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getCryptoManagerHostKMSMoIdEnabled" }, "task": true }, { "name": "postCryptoManagerKmipMoIdIsKmsClusterActive", "summary": "Check whether an active KMS exists in cluster.", "description": "Check whether an active KMS exists in cluster.\n\n***Required privileges:*** Cryptographer.ManageKeyServers", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postCryptoManagerKmipMoIdIsKmsClusterActive" }, "task": true }, { "name": "postCryptoManagerKmipMoIdAddKey", "summary": "Add an existing key.", "description": "Add an existing key.\n\n***Required privileges:*** Cryptographer.ManageKeys", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postCryptoManagerKmipMoIdAddKey" }, "task": true }, { "name": "postCryptoManagerKmipMoIdAddKeys", "summary": "Add multiple existing keys.", "description": "Add multiple existing keys.\n\n***Required privileges:*** Cryptographer.ManageKeys", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postCryptoManagerKmipMoIdAddKeys" }, "task": true }, { "name": "postCryptoManagerKmipMoIdGenerateClientCsr", "summary": "Generate a certificate signing request with its private key.", "description": "Generate a certificate signing request with its private key.\n\nThis generates a CSR request as well as its private key. The private key\nwill not be returned to caller for security protection. If this method\nis called again, the CSR and private key generated in the new invocation\nwill overwrite the old ones.\nAfter the CSR is signed by KMS into a certificate, it should be updated\nby calling *CryptoManagerKmip.UpdateKmsSignedCsrClientCert*. The generated CSR\ncan be later retrieved by calling *Crypto...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postCryptoManagerKmipMoIdGenerateClientCsr" }, "task": true }, { "name": "postCryptoManagerKmipMoIdGenerateKey", "summary": "Generate new encryption key.", "description": "Generate new encryption key.\n\n***Required privileges:*** Cryptographer.ManageKeys", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postCryptoManagerKmipMoIdGenerateKey" }, "task": true }, { "name": "postCryptoManagerKmipMoIdGenerateSelfSignedClientCert", "summary": "Generate a self-signed client certificate with its private key.", "description": "Generate a self-signed client certificate with its private key.\n\nThis generates a self signed certificate as well as its private key.\nThe private key will not be returned to caller for security protection.\nIf this method is called again, the certificate and private key\ngenerated in the new invocation will overwrite the old ones.\nThe generated certificate will not replace current working certificate\nuntil *CryptoManagerKmip.UpdateSelfSignedClientCert* is called. The generated self\nsigned certific...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postCryptoManagerKmipMoIdGenerateSelfSignedClientCert" }, "task": true }, { "name": "postCryptoManagerKmipMoIdGetDefaultKmsCluster", "summary": "Get the default KMS cluster of the specified managed entity.", "description": "Get the default KMS cluster of the specified managed entity.\n\n***Required privileges:*** Cryptographer.ManageKeyServers", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postCryptoManagerKmipMoIdGetDefaultKmsCluster" }, "task": true }, { "name": "postCryptoManagerKmipMoIdListKeys", "summary": "List keys.", "description": "List keys.\n\n\\* When executed against the host, lists all the keys\nadded to the host's key cache by *CryptoManager.AddKey*\\/*CryptoManager.AddKeys*.\n\\* When executed against the VC, lists all the keys used by\nthe correctly registered VMs, and the host key.\n\n***Required privileges:*** Cryptographer.ManageKeys", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postCryptoManagerKmipMoIdListKeys" }, "task": true }, { "name": "postCryptoManagerKmipMoIdListKmipServers", "summary": "List the registered KMIP servers.", "description": "List the registered KMIP servers.\n\n***Required privileges:*** Cryptographer.ManageKeyServers", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postCryptoManagerKmipMoIdListKmipServers" }, "task": true }, { "name": "postCryptoManagerKmipMoIdListKmsClusters", "summary": "List the KMS clusters information.", "description": "List the KMS clusters information.\n\n***Required privileges:*** Cryptographer.ManageKeyServers", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postCryptoManagerKmipMoIdListKmsClusters" }, "task": true }, { "name": "postCryptoManagerKmipMoIdMarkDefault", "summary": "Set the default KMIP cluster.", "description": "Set the default KMIP cluster.\n\n***Required privileges:*** Cryptographer.ManageKeyServers", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postCryptoManagerKmipMoIdMarkDefault" }, "task": true }, { "name": "postCryptoManagerKmipMoIdQueryCryptoKeyStatus", "summary": "Check CryptoKey status, such as if VC can access the key, if the key is\nused by some VMs or as host", "description": "Check CryptoKey status, such as if VC can access the key, if the key is\nused by some VMs or as host key.\n\n***Required privileges:*** Cryptographer.ManageKeys", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postCryptoManagerKmipMoIdQueryCryptoKeyStatus" }, "task": true }, { "name": "postCryptoManagerKmipMoIdRegisterKmipServer", "summary": "Register a KMIP server.", "description": "Register a KMIP server.\n\n***Required privileges:*** Cryptographer.ManageKeyServers", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postCryptoManagerKmipMoIdRegisterKmipServer" }, "task": true }, { "name": "postCryptoManagerKmipMoIdRegisterKmsCluster", "summary": "Register the specified KMS cluster to the CryptoManager.", "description": "Register the specified KMS cluster to the CryptoManager.\n\n***Required privileges:*** Cryptographer.ManageKeyServers", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postCryptoManagerKmipMoIdRegisterKmsCluster" }, "task": true }, { "name": "postCryptoManagerKmipMoIdRemoveKey", "summary": "Remove a key (only the UUID is needed to remove).", "description": "Remove a key (only the UUID is needed to remove).\n\nIf \"force\" is set, removal will happen even if the key is in use.\n\n***Required privileges:*** Cryptographer.ManageKeys", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postCryptoManagerKmipMoIdRemoveKey" }, "task": true }, { "name": "postCryptoManagerKmipMoIdRemoveKeys", "summary": "Remove multiple keys (only the UUID is needed to remove).", "description": "Remove multiple keys (only the UUID is needed to remove).\n\nIf \"force\" is set, removal will happen even if they are in use.\n\n***Required privileges:*** Cryptographer.ManageKeys", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postCryptoManagerKmipMoIdRemoveKeys" }, "task": true }, { "name": "postCryptoManagerKmipMoIdRemoveKmipServer", "summary": "Remove a KMIP server, even if in use.", "description": "Remove a KMIP server, even if in use.\n\n***Required privileges:*** Cryptographer.ManageKeyServers", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postCryptoManagerKmipMoIdRemoveKmipServer" }, "task": true }, { "name": "postCryptoManagerKmipMoIdRetrieveClientCert", "summary": "Get the client certificate of the KMIP cluster.", "description": "Get the client certificate of the KMIP cluster.\n\n***Required privileges:*** Cryptographer.ManageKeyServers", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postCryptoManagerKmipMoIdRetrieveClientCert" }, "task": true }, { "name": "postCryptoManagerKmipMoIdRetrieveClientCsr", "summary": "Get the generated client certificate signing request.", "description": "Get the generated client certificate signing request.\n\nIf *CryptoManagerKmip.GenerateClientCsr* is called previously, this will return\nthe generated certificate signing request; otherwise return empty string.\n\n***Required privileges:*** Cryptographer.ManageKeyServers", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postCryptoManagerKmipMoIdRetrieveClientCsr" }, "task": true }, { "name": "postCryptoManagerKmipMoIdRetrieveKmipServerCert", "summary": "Get the server certficate.", "description": "Get the server certficate.\n\nIn the case of error, an empty\ncertificate string is returned.\n\n***Required privileges:*** Cryptographer.ManageKeyServers", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postCryptoManagerKmipMoIdRetrieveKmipServerCert" }, "task": true }, { "name": "postCryptoManagerKmipMoIdRetrieveKmipServersStatusTask", "summary": "Get the status of the KMIP servers.", "description": "Get the status of the KMIP servers.\n\n***Required privileges:*** Cryptographer.ManageKeyServers", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postCryptoManagerKmipMoIdRetrieveKmipServersStatusTask" }, "task": true }, { "name": "postCryptoManagerKmipMoIdRetrieveSelfSignedClientCert", "summary": "Get the generated self signed client certificate.", "description": "Get the generated self signed client certificate.\n\nIf *CryptoManagerKmip.GenerateSelfSignedClientCert* is called previously, this\nwill return the generated certificate; otherwise return empty string.\n\n***Required privileges:*** Cryptographer.ManageKeyServers", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postCryptoManagerKmipMoIdRetrieveSelfSignedClientCert" }, "task": true }, { "name": "postCryptoManagerKmipMoIdSetDefaultKmsCluster", "summary": "Set the default KMS cluster for the specified managed entity.", "description": "Set the default KMS cluster for the specified managed entity.\n\n***Required privileges:*** Cryptographer.ManageKeyServers", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postCryptoManagerKmipMoIdSetDefaultKmsCluster" }, "task": true }, { "name": "postCryptoManagerKmipMoIdSetKeyCustomAttributes", "summary": "Set crypto key's custom attributes.", "description": "Set crypto key's custom attributes.\n\n***Since:*** vSphere API Release 8.0.1.0\n\n***Required privileges:*** Cryptographer.ManageKeys", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postCryptoManagerKmipMoIdSetKeyCustomAttributes" }, "task": true }, { "name": "postCryptoManagerKmipMoIdUnregisterKmsCluster", "summary": "Unregister the specified KMS cluster from the CryptoManager.", "description": "Unregister the specified KMS cluster from the CryptoManager.\n\n***Required privileges:*** Cryptographer.ManageKeyServers", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postCryptoManagerKmipMoIdUnregisterKmsCluster" }, "task": true }, { "name": "postCryptoManagerKmipMoIdUpdateKmipServer", "summary": "Update a KMIP server.", "description": "Update a KMIP server.\n\n***Required privileges:*** Cryptographer.ManageKeyServers", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postCryptoManagerKmipMoIdUpdateKmipServer" }, "task": true }, { "name": "postCryptoManagerKmipMoIdUpdateKmsSignedCsrClientCert", "summary": "Set KMS server signed certificate as KMIP client certificate for the KMS\ncluster.", "description": "Set KMS server signed certificate as KMIP client certificate for the KMS\ncluster.\n\nThis method should be called to update the certificate signed by KMS\nserver from a CSR that is generated by calling *CryptoManagerKmip.GenerateClientCsr*.\nIf *CryptoManagerKmip.GenerateClientCsr* is called more than once, the CSR that is\ngenerated last time should be used; otherwise the certificate will be\nrejected because the private key from last time won't match the public\nkey in the certificate.\n\n***Required p...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postCryptoManagerKmipMoIdUpdateKmsSignedCsrClientCert" }, "task": true }, { "name": "postCryptoManagerKmipMoIdUpdateSelfSignedClientCert", "summary": "Set a self-signed certificate as KMIP client certificate for the KMS\ncluster.", "description": "Set a self-signed certificate as KMIP client certificate for the KMS\ncluster.\n\nThis method should be called to update the certificate which is generated\nby calling *CryptoManagerKmip.GenerateSelfSignedClientCert*. If\n*CryptoManagerKmip.GenerateSelfSignedClientCert* is called more than once, the self\nsigned certificate that is generated last time should be used; otherwise\nthe certificate will be rejected because the private key from last time\nwon't match the public key in the certificate.\n\n***Req...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postCryptoManagerKmipMoIdUpdateSelfSignedClientCert" }, "task": true }, { "name": "postCryptoManagerKmipMoIdUploadClientCert", "summary": "Set a client certificate with private key for the KMIP cluster.", "description": "Set a client certificate with private key for the KMIP cluster.\n\nThe certificate and private key can be assigned by a KMS server and the\ncertificate might be already trusted by the KMS server.\n\n***Required privileges:*** Cryptographer.ManageKeyServers", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postCryptoManagerKmipMoIdUploadClientCert" }, "task": true }, { "name": "postCryptoManagerKmipMoIdUploadKmipServerCert", "summary": "Upload a server certficate.", "description": "Upload a server certficate.\n\n***Required privileges:*** Cryptographer.ManageKeyServers", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postCryptoManagerKmipMoIdUploadKmipServerCert" }, "task": true }, { "name": "getCryptoManagerKmipMoIdEnabled", "summary": "Indicate if the encryption feature is enabled.", "description": "Indicate if the encryption feature is enabled.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getCryptoManagerKmipMoIdEnabled" }, "task": true }, { "name": "getCryptoManagerKmipMoIdKmipServers", "summary": "A list of registered KMIP servers, grouped by clusters.", "description": "A list of registered KMIP servers, grouped by clusters.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getCryptoManagerKmipMoIdKmipServers" }, "task": true }, { "name": "postCustomFieldsManagerMoIdAddCustomFieldDef", "summary": "Creates a new custom field.", "description": "Creates a new custom field.\n\nIf the moType is specified, the\nfield will only be available for that type of managed object.\n\n***Required privileges:*** Global.ManageCustomFields", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postCustomFieldsManagerMoIdAddCustomFieldDef" }, "task": true }, { "name": "postCustomFieldsManagerMoIdRemoveCustomFieldDef", "summary": "Removes a custom field.", "description": "Removes a custom field.\n\nThis also removes all values assigned\nto this custom field.\n\n***Required privileges:*** Global.ManageCustomFields", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postCustomFieldsManagerMoIdRemoveCustomFieldDef" }, "task": true }, { "name": "postCustomFieldsManagerMoIdRenameCustomFieldDef", "summary": "Renames a custom field.", "description": "Renames a custom field.\n\n***Required privileges:*** Global.ManageCustomFields", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postCustomFieldsManagerMoIdRenameCustomFieldDef" }, "task": true }, { "name": "postCustomFieldsManagerMoIdSetField", "summary": "Assigns a value to a custom field on an entity.", "description": "Assigns a value to a custom field on an entity.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postCustomFieldsManagerMoIdSetField" }, "task": true }, { "name": "getCustomFieldsManagerMoIdField", "summary": "List of custom fields defined on this server.", "description": "List of custom fields defined on this server.\n\nThe fields are\nsorted by name.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getCustomFieldsManagerMoIdField" }, "task": true }, { "name": "postCustomizationSpecManagerMoIdCheckCustomizationResources", "summary": "Validate that required resources are available on the server to customize a\nparticular guest operat", "description": "Validate that required resources are available on the server to customize a\nparticular guest operating system.\n\nThese would include sysprep for Windows\nand the debugfs and changefs volume editors for Linux guests.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postCustomizationSpecManagerMoIdCheckCustomizationResources" }, "task": true }, { "name": "postCustomizationSpecManagerMoIdCreateCustomizationSpec", "summary": "Creates a new specification.", "description": "Creates a new specification.\n\n***Required privileges:*** VirtualMachine.Provisioning.ModifyCustSpecs", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postCustomizationSpecManagerMoIdCreateCustomizationSpec" }, "task": true }, { "name": "postCustomizationSpecManagerMoIdDeleteCustomizationSpec", "summary": "Deletes a specification.", "description": "Deletes a specification.\n\n***Required privileges:*** VirtualMachine.Provisioning.ModifyCustSpecs", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postCustomizationSpecManagerMoIdDeleteCustomizationSpec" }, "task": true }, { "name": "postCustomizationSpecManagerMoIdDuplicateCustomizationSpec", "summary": "Duplicates a specification.", "description": "Duplicates a specification.\n\n***Required privileges:*** VirtualMachine.Provisioning.ModifyCustSpecs", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postCustomizationSpecManagerMoIdDuplicateCustomizationSpec" }, "task": true }, { "name": "postCustomizationSpecManagerMoIdDoesCustomizationSpecExist", "summary": "Whether or not a specification exists.", "description": "Whether or not a specification exists.\n\n***Required privileges:*** VirtualMachine.Provisioning.ReadCustSpecs", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postCustomizationSpecManagerMoIdDoesCustomizationSpecExist" }, "task": true }, { "name": "postCustomizationSpecManagerMoIdGetCustomizationSpec", "summary": "Obtains a specification for the given name.", "description": "Obtains a specification for the given name.\n\n***Required privileges:*** VirtualMachine.Provisioning.ReadCustSpecs", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postCustomizationSpecManagerMoIdGetCustomizationSpec" }, "task": true }, { "name": "postCustomizationSpecManagerMoIdOverwriteCustomizationSpec", "summary": "Overwrites an existing specification, possibly after retrieving\n(by using 'get') and editing it.", "description": "Overwrites an existing specification, possibly after retrieving\n(by using 'get') and editing it.\n\nIf, based on the item's changeVersion\nvalue, the overwrite process detects that the specification has changed\nsince its retrieval, then the API uses the SpecModified exception to\nwarn clients that they might overwrite another client's change.\n\n***Required privileges:*** VirtualMachine.Provisioning.ModifyCustSpecs", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postCustomizationSpecManagerMoIdOverwriteCustomizationSpec" }, "task": true }, { "name": "postCustomizationSpecManagerMoIdRenameCustomizationSpec", "summary": "Renames a specification.", "description": "Renames a specification.\n\n***Required privileges:*** VirtualMachine.Provisioning.ModifyCustSpecs", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postCustomizationSpecManagerMoIdRenameCustomizationSpec" }, "task": true }, { "name": "postCustomizationSpecManagerMoIdCustomizationSpecItemToXml", "summary": "Converts a specification item to XML text", "description": "Converts a specification item to XML text\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postCustomizationSpecManagerMoIdCustomizationSpecItemToXml" }, "task": true }, { "name": "postCustomizationSpecManagerMoIdXmlToCustomizationSpecItem", "summary": "Converts an XML string to a specification item", "description": "Converts an XML string to a specification item\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postCustomizationSpecManagerMoIdXmlToCustomizationSpecItem" }, "task": true }, { "name": "getCustomizationSpecManagerMoIdEncryptionKey", "summary": "Gets a binary public encryption key that can be used to encrypt\npasswords in stored specifications.", "description": "Gets a binary public encryption key that can be used to encrypt\npasswords in stored specifications.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getCustomizationSpecManagerMoIdEncryptionKey" }, "task": true }, { "name": "getCustomizationSpecManagerMoIdInfo", "summary": "Gets a list of information on available specifications.", "description": "Gets a list of information on available specifications.\n\n***Required privileges:*** VirtualMachine.Provisioning.ReadCustSpecs", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getCustomizationSpecManagerMoIdInfo" }, "task": true }, { "name": "postDatacenterMoIdBatchQueryConnectInfo", "summary": "This interface returns a list of information about the specified hosts\nwithout adding them to the v", "description": "This interface returns a list of information about the specified hosts\nwithout adding them to the vCenter inventory.\n\nIt does so by calling\n*Datacenter.QueryConnectionInfoViaSpec*.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postDatacenterMoIdBatchQueryConnectInfo" }, "task": true }, { "name": "postDatacenterMoIdDestroyTask", "summary": "Destroys this object, deleting its contents and removing it from its parent\nfolder (if any).", "description": "Destroys this object, deleting its contents and removing it from its parent\nfolder (if any).\n\nNOTE: The appropriate privilege must be held on the parent of the destroyed\nentity as well as the entity itself.\nThis method can throw one of several exceptions. The exact set of exceptions\ndepends on the kind of entity that is being removed. See comments for\neach entity for more information on destroy behavior.\n\n***Required privileges:*** Datacenter.Delete", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postDatacenterMoIdDestroyTask" }, "task": true }, { "name": "postDatacenterMoIdPowerOnMultiVMTask", "summary": "Powers on multiple virtual machines in a data center.", "description": "Powers on multiple virtual machines in a data center.\n\nIf the virtual\nmachines are suspended, this method resumes execution from the suspend\npoint.\nThe virtual machines can belong to different clusters in the data center.\n\nIf any virtual machine in the list is manually managed by DRS, or DRS\nhas to migrate any manually managed virtual machine or power on any manually\nmanaged host in order to power on these virtual machines, a DRS recommendation\nwill be generated, and the users need to manually a...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postDatacenterMoIdPowerOnMultiVMTask" }, "task": true }, { "name": "postDatacenterMoIdQueryDatacenterConfigOptionDescriptor", "summary": "The list of possible choices for\n*DatacenterConfigSpec.defaultHardwareVersionKey*.", "description": "The list of possible choices for\n*DatacenterConfigSpec.defaultHardwareVersionKey*.\n\nDescriptors returned by the vCenter implementation do not have\n*VirtualMachineConfigOptionDescriptor.host* field populated.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postDatacenterMoIdQueryDatacenterConfigOptionDescriptor" }, "task": true }, { "name": "postDatacenterMoIdQueryConnectionInfo", "summary": "This method provides a way of getting basic information about a host without\nadding it to a datacen", "description": "This method provides a way of getting basic information about a host without\nadding it to a datacenter.\n\nConnection wizards typically use this method to show\ninformation about a host so a user can confirm a set of changes before applying\nthem.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postDatacenterMoIdQueryConnectionInfo" }, "task": true }, { "name": "postDatacenterMoIdQueryConnectionInfoViaSpec", "summary": "This method provides a way of getting basic information about a host\nwithout adding it to a datacen", "description": "This method provides a way of getting basic information about a host\nwithout adding it to a datacenter.\n\nThis method is similar to\n*Datacenter.QueryConnectionInfo*, but it takes a *HostConnectSpec*\nas argument, instead of list of parameters.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postDatacenterMoIdQueryConnectionInfoViaSpec" }, "task": true }, { "name": "postDatacenterMoIdReconfigureDatacenterTask", "summary": "Change the datacenter configuration.", "description": "Change the datacenter configuration.\n\n***Required privileges:*** Datacenter.Reconfigure", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postDatacenterMoIdReconfigureDatacenterTask" }, "task": true }, { "name": "postDatacenterMoIdReload", "summary": "Reload the entity state.", "description": "Reload the entity state.\n\nClients only need to call this method\nif they changed some external state that affects the service\nwithout using the Web service interface to perform the change.\nFor example, hand-editing a virtual machine configuration file\naffects the configuration of the associated virtual machine but\nthe service managing the virtual machine might not monitor the\nfile for changes. In this case, after such an edit, a client\nwould call \"reload\" on the associated virtual machine to ensu...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postDatacenterMoIdReload" }, "task": true }, { "name": "postDatacenterMoIdRenameTask", "summary": "Renames this managed entity.", "description": "Renames this managed entity.\n\nAny % (percent) character used in this name parameter\nmust be escaped, unless it is used to start an escape\nsequence. Clients may also escape any other characters in\nthis name parameter.\n\nSee also *ManagedEntity.name*.\n\n***Required privileges:*** Datacenter.Rename", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postDatacenterMoIdRenameTask" }, "task": true }, { "name": "postDatacenterMoIdSetCustomValue", "summary": "Assigns a value to a custom field.", "description": "Assigns a value to a custom field.\n\nThe setCustomValue method requires\nwhichever updatePrivilege is defined as one of the\n*CustomFieldDef.fieldInstancePrivileges*\nfor the CustomFieldDef whose value is being changed.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postDatacenterMoIdSetCustomValue" }, "task": true }, { "name": "getDatacenterMoIdAlarmActionsEnabled", "summary": "Whether alarm actions are enabled for this entity.", "description": "Whether alarm actions are enabled for this entity.\n\nTrue if enabled; false otherwise.\n\n***Required privileges:*** System.Read", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getDatacenterMoIdAlarmActionsEnabled" }, "task": true }, { "name": "getDatacenterMoIdAvailableField", "summary": "List of custom field definitions that are valid for the object's type.", "description": "List of custom field definitions that are valid for the object's type.\n\nThe fields are sorted by *CustomFieldDef.name*.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getDatacenterMoIdAvailableField" }, "task": true }, { "name": "getDatacenterMoIdConfigIssue", "summary": "Current configuration issues that have been detected for this entity.", "description": "Current configuration issues that have been detected for this entity.\n\nTypically,\nthese issues have already been logged as events. The entity stores these\nevents as long as they are still current. The\n*configStatus* property provides an overall status\nbased on these events.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getDatacenterMoIdConfigIssue" }, "task": true }, { "name": "getDatacenterMoIdConfigStatus", "summary": "The configStatus indicates whether or not the system has detected a configuration\nissue involving t", "description": "The configStatus indicates whether or not the system has detected a configuration\nissue involving this entity.\n\nFor example, it might have detected a\nduplicate IP address or MAC address, or a host in a cluster\nmight be out of compliance. The meanings of the configStatus values are:\n- red: A problem has been detected involving the entity.\n- yellow: A problem is about to occur or a transient condition\n has occurred (For example, reconfigure fail-over policy).\n- green: No configuration issues have...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getDatacenterMoIdConfigStatus" }, "task": true }, { "name": "getDatacenterMoIdConfiguration", "summary": "Configuration of the datacenter.", "description": "Configuration of the datacenter.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getDatacenterMoIdConfiguration" }, "task": true }, { "name": "getDatacenterMoIdCustomValue", "summary": "Custom field values.", "description": "Custom field values.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getDatacenterMoIdCustomValue" }, "task": true }, { "name": "getDatacenterMoIdDatastore", "summary": "A collection of references to the datastore objects\navailable in this datacenter.", "description": "A collection of references to the datastore objects\navailable in this datacenter.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getDatacenterMoIdDatastore" }, "task": true }, { "name": "getDatacenterMoIdDatastoreFolder", "summary": "A reference to the folder hierarchy that contains\nthe datastores for this datacenter.", "description": "A reference to the folder hierarchy that contains\nthe datastores for this datacenter.\n\nThis folder is guaranteed to exist.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getDatacenterMoIdDatastoreFolder" }, "task": true }, { "name": "getDatacenterMoIdDeclaredAlarmState", "summary": "A set of alarm states for alarms that apply to this managed entity.", "description": "A set of alarm states for alarms that apply to this managed entity.\n\nThe set includes alarms defined on this entity\nand alarms inherited from the parent entity,\nor from any ancestors in the inventory hierarchy.\n\nAlarms are inherited if they can be triggered by this entity or its descendants.\nThis set does not include alarms that are defined on descendants of this entity.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getDatacenterMoIdDeclaredAlarmState" }, "task": true }, { "name": "getDatacenterMoIdDisabledMethod", "summary": "List of operations that are disabled, given the current runtime\nstate of the entity.", "description": "List of operations that are disabled, given the current runtime\nstate of the entity.\n\nFor example, a power-on operation always fails if a\nvirtual machine is already powered on. This list can be used by clients to\nenable or disable operations in a graphical user interface.\n\nNote: This list is determined by the current runtime state of an entity,\nnot by its permissions.\n\nThis list may include the following operations for a HostSystem:\n- *HostSystem.EnterMaintenanceMode_Task*\n- *HostSystem.ExitMain...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getDatacenterMoIdDisabledMethod" }, "task": true }, { "name": "getDatacenterMoIdEffectiveRole", "summary": "Access rights the current session has to this entity.", "description": "Access rights the current session has to this entity.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getDatacenterMoIdEffectiveRole" }, "task": true }, { "name": "getDatacenterMoIdHostFolder", "summary": "A reference to the folder hierarchy that contains\nthe compute resources, including hosts and cluste", "description": "A reference to the folder hierarchy that contains\nthe compute resources, including hosts and clusters, for this datacenter.\n\nThis folder is guaranteed to exist.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getDatacenterMoIdHostFolder" }, "task": true }, { "name": "getDatacenterMoIdName", "summary": "Name of this entity, unique relative to its parent.", "description": "Name of this entity, unique relative to its parent.\n\nAny / (slash), \\\\ (backslash), character used in this\nname element will be escaped. Similarly, any % (percent) character used in\nthis name element will be escaped, unless it is used to start an escape\nsequence. A slash is escaped as %2F or %2f. A backslash is escaped as %5C or\n%5c, and a percent is escaped as %25.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getDatacenterMoIdName" }, "task": true }, { "name": "getDatacenterMoIdNetwork", "summary": "A collection of references to the network objects\navailable in this datacenter.", "description": "A collection of references to the network objects\navailable in this datacenter.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getDatacenterMoIdNetwork" }, "task": true }, { "name": "getDatacenterMoIdNetworkFolder", "summary": "A reference to the folder hierarchy that contains the network entities\nfor this datacenter.", "description": "A reference to the folder hierarchy that contains the network entities\nfor this datacenter.\n\nThe folder can include *Network*,\n*DistributedVirtualSwitch*, and\n*DistributedVirtualPortgroup* objects.\n\nThis folder is guaranteed to exist.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getDatacenterMoIdNetworkFolder" }, "task": true }, { "name": "getDatacenterMoIdOverallStatus", "summary": "General health of this managed entity.", "description": "General health of this managed entity.\n\nThe overall status of the managed entity is computed as the worst status\namong its alarms and the configuration issues detected on the entity.\nThe status is reported as one of the following values:\n- red: The entity has alarms or configuration issues with a red status.\n- yellow: The entity does not have alarms or configuration issues with a\n red status, and has at least one with a yellow status.\n- green: The entity does not have alarms or configuration is...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getDatacenterMoIdOverallStatus" }, "task": true }, { "name": "getDatacenterMoIdParent", "summary": "Parent of this entity.", "description": "Parent of this entity.\n\nThis value is null for the root object and for\n*VirtualMachine* objects that are part of\na *VirtualApp*.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getDatacenterMoIdParent" }, "task": true }, { "name": "getDatacenterMoIdPermission", "summary": "List of permissions defined for this entity.", "description": "List of permissions defined for this entity.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getDatacenterMoIdPermission" }, "task": true }, { "name": "getDatacenterMoIdRecentTask", "summary": "The set of recent tasks operating on this managed entity.", "description": "The set of recent tasks operating on this managed entity.\n\nThis is a subset\nof *TaskManager.recentTask* belong to this entity. A task in this\nlist could be in one of the four states: pending, running, success or error.\n\nThis property can be used to deduce intermediate power states for\na virtual machine entity. For example, if the current powerState is \"poweredOn\"\nand there is a running task performing the \"suspend\" operation, then the virtual\nmachine's intermediate state might be described as \"s...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getDatacenterMoIdRecentTask" }, "task": true }, { "name": "getDatacenterMoIdTag", "summary": "The set of tags associated with this managed entity.", "description": "The set of tags associated with this managed entity.\n\nExperimental. Subject to change.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getDatacenterMoIdTag" }, "task": true }, { "name": "getDatacenterMoIdTriggeredAlarmState", "summary": "A set of alarm states for alarms triggered by this entity\nor by its descendants.", "description": "A set of alarm states for alarms triggered by this entity\nor by its descendants.\n\nTriggered alarms are propagated up the inventory hierarchy\nso that a user can readily tell when a descendant has triggered an alarm.\nIn releases after vSphere API 5.0, vSphere Servers might not\ngenerate property collector update notifications for this property.\nTo obtain the latest value of the property, you can use\nPropertyCollector methods RetrievePropertiesEx or WaitForUpdatesEx.\nIf you use the PropertyCollector...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getDatacenterMoIdTriggeredAlarmState" }, "task": true }, { "name": "getDatacenterMoIdValue", "summary": "List of custom field values.", "description": "List of custom field values.\n\nEach value uses a key to associate\nan instance of a *CustomFieldStringValue* with\na custom field definition.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getDatacenterMoIdValue" }, "task": true }, { "name": "getDatacenterMoIdVmFolder", "summary": "A reference to the folder hierarchy that contains *VirtualMachine*\nvirtual machine templates (ident", "description": "A reference to the folder hierarchy that contains *VirtualMachine*\nvirtual machine templates (identified by the *VirtualMachineConfigInfo.template*\nproperty, and *VirtualApp* objects for this datacenter.\n\nNote that a VirtualApp that is a child of a *ResourcePool*\nmay also be visible in this folder. VirtualApp objects can be nested,\nbut only the parent VirtualApp can be visible in the folder.\n\nThis folder is guaranteed to exist.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getDatacenterMoIdVmFolder" }, "task": true }, { "name": "postDatastoreMoIdDestroyTask", "summary": "Destroys this object, deleting its contents and removing it from its parent\nfolder (if any).", "description": "Destroys this object, deleting its contents and removing it from its parent\nfolder (if any).\n\nNOTE: The appropriate privilege must be held on the parent of the destroyed\nentity as well as the entity itself.\nThis method can throw one of several exceptions. The exact set of exceptions\ndepends on the kind of entity that is being removed. See comments for\neach entity for more information on destroy behavior.\n\n***Required privileges:*** System.Read", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postDatastoreMoIdDestroyTask" }, "task": true }, { "name": "postDatastoreMoIdDestroyDatastore", "summary": "Removes a datastore.", "description": "Deprecated as of VI API 2.5 do not use this method. This method throws\n*ResourceInUse*. Datastores are automatically\nremoved when no longer in use, so this method is unnecessary.\n\nRemoves a datastore.\n\nA datastore can be removed only if it is not currently used\nby any host or virtual machine.\n\n***Required privileges:*** Datastore.Delete", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postDatastoreMoIdDestroyDatastore" }, "task": true }, { "name": "postDatastoreMoIdDatastoreEnterMaintenanceMode", "summary": "Puts the datastore in maintenance mode.", "description": "Puts the datastore in maintenance mode.\n\nWhile this task is running and when the\ndatastore is in maintenance mode, no virtual machines can be powered on and no\nprovisioning operations can be performed on the datastore. Once the call\ncompletes, it is safe to remove datastore without disrupting any virtual machines.\n\nThe task completes once there are no virtual machines on the datastore\nand no provisioning operations in progress on the datastore. The operation does not\ndirectly initiate any operat...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postDatastoreMoIdDatastoreEnterMaintenanceMode" }, "task": true }, { "name": "postDatastoreMoIdDatastoreExitMaintenanceModeTask", "summary": "Takes the datastore out of maintenance mode.", "description": "Takes the datastore out of maintenance mode.\n\nThe task is cancellable.\n\n***Required privileges:*** Datastore.Config", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postDatastoreMoIdDatastoreExitMaintenanceModeTask" }, "task": true }, { "name": "postDatastoreMoIdIsClusteredVmdkEnabled", "summary": "Check whether clustered VMDK feature is enabled on this datastore.", "description": "Check whether clustered VMDK feature is enabled on this datastore.\n\n***Required privileges:*** System.Read", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postDatastoreMoIdIsClusteredVmdkEnabled" }, "task": true }, { "name": "postDatastoreMoIdRefreshDatastore", "summary": "Explicitly refreshes free-space and capacity values in *Datastore.summary*\nand *Datastore.info*.", "description": "Explicitly refreshes free-space and capacity values in *Datastore.summary*\nand *Datastore.info*.\n\n***Required privileges:*** System.Read", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postDatastoreMoIdRefreshDatastore" }, "task": true }, { "name": "postDatastoreMoIdRefreshDatastoreStorageInfo", "summary": "Refreshes all storage related information including free-space, capacity,\nand detailed usage of vir", "description": "Refreshes all storage related information including free-space, capacity,\nand detailed usage of virtual machines.\n\nUpdated values are available\nin *Datastore.summary* and *Datastore.info*.\n\n***Required privileges:*** System.Read", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postDatastoreMoIdRefreshDatastoreStorageInfo" }, "task": true }, { "name": "postDatastoreMoIdReload", "summary": "Reload the entity state.", "description": "Reload the entity state.\n\nClients only need to call this method\nif they changed some external state that affects the service\nwithout using the Web service interface to perform the change.\nFor example, hand-editing a virtual machine configuration file\naffects the configuration of the associated virtual machine but\nthe service managing the virtual machine might not monitor the\nfile for changes. In this case, after such an edit, a client\nwould call \"reload\" on the associated virtual machine to ensu...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postDatastoreMoIdReload" }, "task": true }, { "name": "postDatastoreMoIdRenameTask", "summary": "Renames this managed entity.", "description": "Renames this managed entity.\n\nAny % (percent) character used in this name parameter\nmust be escaped, unless it is used to start an escape\nsequence. Clients may also escape any other characters in\nthis name parameter.\n\nSee also *ManagedEntity.name*.\n\n***Required privileges:*** Datastore.Rename", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postDatastoreMoIdRenameTask" }, "task": true }, { "name": "postDatastoreMoIdRenameDatastore", "summary": "Renames a datastore.", "description": "Deprecated as of vSphere API 4.0, use *ManagedEntity.Rename_Task*.\n\nRenames a datastore.\n\n***Required privileges:*** Datastore.Rename", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postDatastoreMoIdRenameDatastore" }, "task": true }, { "name": "postDatastoreMoIdSetCustomValue", "summary": "Assigns a value to a custom field.", "description": "Assigns a value to a custom field.\n\nThe setCustomValue method requires\nwhichever updatePrivilege is defined as one of the\n*CustomFieldDef.fieldInstancePrivileges*\nfor the CustomFieldDef whose value is being changed.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postDatastoreMoIdSetCustomValue" }, "task": true }, { "name": "postDatastoreMoIdUpdateVVolVirtualMachineFilesTask", "summary": "Scan a VVol storage container to update file paths and objectID pointers\nembedded in virtual machin", "description": "Scan a VVol storage container to update file paths and objectID pointers\nembedded in virtual machine files on a given storage container.\n\n***Required privileges:*** Datastore.UpdateVirtualMachineFiles", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postDatastoreMoIdUpdateVVolVirtualMachineFilesTask" }, "task": true }, { "name": "postDatastoreMoIdUpdateVirtualMachineFilesTask", "summary": "Update file paths embedded in virtual machine files on the datastore.", "description": "Update file paths embedded in virtual machine files on the datastore.\n\nThis can be called after the file system corresponding to the datastore\nhas been resignatured or remounted. Any MountPathDatastorePairs\nwhere the new path is the same as the original file path will be ignored.\n\nThis method is only supported by vCenter server. Also, this method requires\nthat the datastore is *accessible* from\nat least one host (ESX version 4.1 or above) in vCenter server.\n\nWhile this operation is in progress, ...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postDatastoreMoIdUpdateVirtualMachineFilesTask" }, "task": true }, { "name": "getDatastoreMoIdAlarmActionsEnabled", "summary": "Whether alarm actions are enabled for this entity.", "description": "Whether alarm actions are enabled for this entity.\n\nTrue if enabled; false otherwise.\n\n***Required privileges:*** System.Read", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getDatastoreMoIdAlarmActionsEnabled" }, "task": true }, { "name": "getDatastoreMoIdAvailableField", "summary": "List of custom field definitions that are valid for the object's type.", "description": "List of custom field definitions that are valid for the object's type.\n\nThe fields are sorted by *CustomFieldDef.name*.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getDatastoreMoIdAvailableField" }, "task": true }, { "name": "getDatastoreMoIdBrowser", "summary": "DatastoreBrowser used to browse this datastore.", "description": "DatastoreBrowser used to browse this datastore.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getDatastoreMoIdBrowser" }, "task": true }, { "name": "getDatastoreMoIdCapability", "summary": "Capabilities of this datastore.", "description": "Capabilities of this datastore.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getDatastoreMoIdCapability" }, "task": true }, { "name": "getDatastoreMoIdConfigIssue", "summary": "Current configuration issues that have been detected for this entity.", "description": "Current configuration issues that have been detected for this entity.\n\nTypically,\nthese issues have already been logged as events. The entity stores these\nevents as long as they are still current. The\n*configStatus* property provides an overall status\nbased on these events.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getDatastoreMoIdConfigIssue" }, "task": true }, { "name": "getDatastoreMoIdConfigStatus", "summary": "The configStatus indicates whether or not the system has detected a configuration\nissue involving t", "description": "The configStatus indicates whether or not the system has detected a configuration\nissue involving this entity.\n\nFor example, it might have detected a\nduplicate IP address or MAC address, or a host in a cluster\nmight be out of compliance. The meanings of the configStatus values are:\n- red: A problem has been detected involving the entity.\n- yellow: A problem is about to occur or a transient condition\n has occurred (For example, reconfigure fail-over policy).\n- green: No configuration issues have...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getDatastoreMoIdConfigStatus" }, "task": true }, { "name": "getDatastoreMoIdCustomValue", "summary": "Custom field values.", "description": "Custom field values.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getDatastoreMoIdCustomValue" }, "task": true }, { "name": "getDatastoreMoIdDeclaredAlarmState", "summary": "A set of alarm states for alarms that apply to this managed entity.", "description": "A set of alarm states for alarms that apply to this managed entity.\n\nThe set includes alarms defined on this entity\nand alarms inherited from the parent entity,\nor from any ancestors in the inventory hierarchy.\n\nAlarms are inherited if they can be triggered by this entity or its descendants.\nThis set does not include alarms that are defined on descendants of this entity.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getDatastoreMoIdDeclaredAlarmState" }, "task": true }, { "name": "getDatastoreMoIdDisabledMethod", "summary": "List of operations that are disabled, given the current runtime\nstate of the entity.", "description": "List of operations that are disabled, given the current runtime\nstate of the entity.\n\nFor example, a power-on operation always fails if a\nvirtual machine is already powered on. This list can be used by clients to\nenable or disable operations in a graphical user interface.\n\nNote: This list is determined by the current runtime state of an entity,\nnot by its permissions.\n\nThis list may include the following operations for a HostSystem:\n- *HostSystem.EnterMaintenanceMode_Task*\n- *HostSystem.ExitMain...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getDatastoreMoIdDisabledMethod" }, "task": true }, { "name": "getDatastoreMoIdEffectiveRole", "summary": "Access rights the current session has to this entity.", "description": "Access rights the current session has to this entity.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getDatastoreMoIdEffectiveRole" }, "task": true }, { "name": "getDatastoreMoIdHost", "summary": "Hosts attached to this datastore.", "description": "Hosts attached to this datastore.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getDatastoreMoIdHost" }, "task": true }, { "name": "getDatastoreMoIdInfo", "summary": "Specific information about the datastore.", "description": "Specific information about the datastore.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getDatastoreMoIdInfo" }, "task": true }, { "name": "getDatastoreMoIdIormConfiguration", "summary": "Configuration of storage I/O resource management for the datastore.", "description": "Deprecated as of vSphere8.0 U3, and there is no replacement for it.\n\nConfiguration of storage I/O resource management for the datastore.\n\nCurrently we only support storage I/O resource management on VMFS volumes\nof a datastore.\n\nThis configuration may not be available if the datastore is not accessible\nfrom any host, or if the datastore does not have VMFS volume.\nThe configuration can be modified using the method\n*StorageResourceManager.ConfigureDatastoreIORM_Task*", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getDatastoreMoIdIormConfiguration" }, "task": true }, { "name": "getDatastoreMoIdName", "summary": "Name of this entity, unique relative to its parent.", "description": "Name of this entity, unique relative to its parent.\n\nAny / (slash), \\\\ (backslash), character used in this\nname element will be escaped. Similarly, any % (percent) character used in\nthis name element will be escaped, unless it is used to start an escape\nsequence. A slash is escaped as %2F or %2f. A backslash is escaped as %5C or\n%5c, and a percent is escaped as %25.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getDatastoreMoIdName" }, "task": true }, { "name": "getDatastoreMoIdOverallStatus", "summary": "General health of this managed entity.", "description": "General health of this managed entity.\n\nThe overall status of the managed entity is computed as the worst status\namong its alarms and the configuration issues detected on the entity.\nThe status is reported as one of the following values:\n- red: The entity has alarms or configuration issues with a red status.\n- yellow: The entity does not have alarms or configuration issues with a\n red status, and has at least one with a yellow status.\n- green: The entity does not have alarms or configuration is...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getDatastoreMoIdOverallStatus" }, "task": true }, { "name": "getDatastoreMoIdParent", "summary": "Parent of this entity.", "description": "Parent of this entity.\n\nThis value is null for the root object and for\n*VirtualMachine* objects that are part of\na *VirtualApp*.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getDatastoreMoIdParent" }, "task": true }, { "name": "getDatastoreMoIdPermission", "summary": "List of permissions defined for this entity.", "description": "List of permissions defined for this entity.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getDatastoreMoIdPermission" }, "task": true }, { "name": "getDatastoreMoIdRecentTask", "summary": "The set of recent tasks operating on this managed entity.", "description": "The set of recent tasks operating on this managed entity.\n\nThis is a subset\nof *TaskManager.recentTask* belong to this entity. A task in this\nlist could be in one of the four states: pending, running, success or error.\n\nThis property can be used to deduce intermediate power states for\na virtual machine entity. For example, if the current powerState is \"poweredOn\"\nand there is a running task performing the \"suspend\" operation, then the virtual\nmachine's intermediate state might be described as \"s...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getDatastoreMoIdRecentTask" }, "task": true }, { "name": "getDatastoreMoIdSummary", "summary": "Global properties of the datastore.", "description": "Global properties of the datastore.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getDatastoreMoIdSummary" }, "task": true }, { "name": "getDatastoreMoIdTag", "summary": "The set of tags associated with this managed entity.", "description": "The set of tags associated with this managed entity.\n\nExperimental. Subject to change.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getDatastoreMoIdTag" }, "task": true }, { "name": "getDatastoreMoIdTriggeredAlarmState", "summary": "A set of alarm states for alarms triggered by this entity\nor by its descendants.", "description": "A set of alarm states for alarms triggered by this entity\nor by its descendants.\n\nTriggered alarms are propagated up the inventory hierarchy\nso that a user can readily tell when a descendant has triggered an alarm.\nIn releases after vSphere API 5.0, vSphere Servers might not\ngenerate property collector update notifications for this property.\nTo obtain the latest value of the property, you can use\nPropertyCollector methods RetrievePropertiesEx or WaitForUpdatesEx.\nIf you use the PropertyCollector...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getDatastoreMoIdTriggeredAlarmState" }, "task": true }, { "name": "getDatastoreMoIdValue", "summary": "List of custom field values.", "description": "List of custom field values.\n\nEach value uses a key to associate\nan instance of a *CustomFieldStringValue* with\na custom field definition.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getDatastoreMoIdValue" }, "task": true }, { "name": "getDatastoreMoIdVm", "summary": "Virtual machines stored on this datastore.", "description": "Virtual machines stored on this datastore.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getDatastoreMoIdVm" }, "task": true }, { "name": "postDatastoreNamespaceManagerMoIdConvertNamespacePathToUuidPath", "summary": "Convert the namespace path to the namespace UUID path.", "description": "Convert the namespace path to the namespace UUID path.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postDatastoreNamespaceManagerMoIdConvertNamespacePathToUuidPath" }, "task": true }, { "name": "postDatastoreNamespaceManagerMoIdCreateDirectory", "summary": "Creates a top-level directory on the given datastore, using the given\nuser display name hint and op", "description": "Creates a top-level directory on the given datastore, using the given\nuser display name hint and opaque storage policy.\n\nThe optional given display name hint may be used by the underlying\nstorage system for user display purposes, but it may not be relied\nupon for future directory references.\n\nClients must use the returned stable path for future directory\nreferences.\n\nSee also *DatastoreNamespaceManager.DeleteDirectory*.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postDatastoreNamespaceManagerMoIdCreateDirectory" }, "task": true }, { "name": "postDatastoreNamespaceManagerMoIdDeleteDirectory", "summary": "Deletes the given top-level directory from a datastore.", "description": "Deletes the given top-level directory from a datastore.\n\nThe top-level directory must be a full path of the form\n> /vmfs/volumes/\\[_datastore-uuid_\\]/\\[_directory-uuid_\\]\n>\n\nas returned by\n*DatastoreNamespaceManager.CreateDirectory*.\n\nRequires Datastore.Config privilege on the datastore.\n\nSee also *DatastoreNamespaceManager.CreateDirectory*.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postDatastoreNamespaceManagerMoIdDeleteDirectory" }, "task": true }, { "name": "postDatastoreNamespaceManagerMoIdIncreaseDirectorySize", "summary": "Increase size of the given top-level directory to the given size on\nvSAN backed object storage.", "description": "Increase size of the given top-level directory to the given size on\nvSAN backed object storage.\n\nThe top-level directory must be a full path in the form\n> /vmfs/volumes/\\[_datastore-uuid_\\]/\\[_directory-uuid_\\]\n>\n\nas returned by\n*DatastoreNamespaceManager.CreateDirectory*.\n\nRequires Datastore.Config privilege on the datastore.\n\nSee also *DatastoreNamespaceManager.CreateDirectory*.\n\n***Since:*** vSphere API Release 8.0.1.0", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postDatastoreNamespaceManagerMoIdIncreaseDirectorySize" }, "task": true }, { "name": "postDatastoreNamespaceManagerMoIdQueryDirectoryInfo", "summary": "Query directory information of the given top-level directory on vSAN\nbacked object storage.", "description": "Query directory information of the given top-level directory on vSAN\nbacked object storage.\n\nThe top-level directory must be a full path in the form\n> /vmfs/volumes/\\[_datastore-uuid_\\]/\\[_directory-uuid_\\]\n>\n\nas returned by\n*DatastoreNamespaceManager.CreateDirectory*.\n\nSee also *DatastoreNamespaceManager.CreateDirectory*.\n\n***Since:*** vSphere API Release 8.0.1.0\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postDatastoreNamespaceManagerMoIdQueryDirectoryInfo" }, "task": true }, { "name": "postDiagnosticManagerMoIdEmitSyslogMark", "summary": "Issue a \"mark\" to syslog and the audit trail.", "description": "Issue a \"mark\" to syslog and the audit trail.\n\nThe specified message string will be written to syslog and the audit\ntrail. The \"mark\" audit record will contain the message string in\nits comment parameter.\n\n***Since:*** vSphere API Release 8.0.0.2\n\n***Required privileges:*** Global.Diagnostics", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postDiagnosticManagerMoIdEmitSyslogMark" }, "task": true }, { "name": "postDiagnosticManagerMoIdFetchAuditRecords", "summary": "Retrieve audit records from their storage on the specified host.", "description": "Retrieve audit records from their storage on the specified host.\n\nAudit records are stored on the host in a (large) FIFO. The FIFO is\ncontinuously being written to due to system activities. It is the\nresponsibility of the caller to issue reads fast enough to keep ahead\nof the write traffic.\n\n***Since:*** vSphere API Release 7.0.3.0\n\n***Required privileges:*** Global.Diagnostics", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postDiagnosticManagerMoIdFetchAuditRecords" }, "task": true }, { "name": "postDiagnosticManagerMoIdBrowseDiagnosticLog", "summary": "Returns part of a log file.", "description": "Returns part of a log file.\n\nLog entries are always returned chronologically, typically with the\nnewest event last.\n\n***Required privileges:*** Global.Diagnostics", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postDiagnosticManagerMoIdBrowseDiagnosticLog" }, "task": true }, { "name": "postDiagnosticManagerMoIdGenerateLogBundlesTask", "summary": "Instructs the server to generate diagnostic bundles.", "description": "Deprecated since version 5.0 M/N it is recommended to use the CGI\ninterface for the host bundles, use the address instead:\n`https:// >/cgi-bin/vm-support.cgi`\nfor the VC bundles, use\n`https:// >/appliance/support-bundle`\n\nThe caller can download the bundles using an HTTP GET operation\nfor each returned URL. Bundles are usually available for at least 24\nhours, but the caller should not assume that the returned URLs are\nvalid indefinitely. Servers often automatically delete generated\ndiagnostic bu...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postDiagnosticManagerMoIdGenerateLogBundlesTask" }, "task": true }, { "name": "postDiagnosticManagerMoIdQueryDescriptions", "summary": "Returns a list of diagnostic files for a given system.", "description": "Returns a list of diagnostic files for a given system.\n\n***Required privileges:*** Global.Diagnostics", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postDiagnosticManagerMoIdQueryDescriptions" }, "task": true }, { "name": "postDistributedVirtualPortgroupMoIdDestroyTask", "summary": "Destroys this object, deleting its contents and removing it from its parent\nfolder (if any).", "description": "Destroys this object, deleting its contents and removing it from its parent\nfolder (if any).\n\nNOTE: The appropriate privilege must be held on the parent of the destroyed\nentity as well as the entity itself.\nThis method can throw one of several exceptions. The exact set of exceptions\ndepends on the kind of entity that is being removed. See comments for\neach entity for more information on destroy behavior.\n\n***Required privileges:*** DVPortgroup.Delete", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postDistributedVirtualPortgroupMoIdDestroyTask" }, "task": true }, { "name": "postDistributedVirtualPortgroupMoIdDestroyNetwork", "summary": "Removes a network.", "description": "Deprecated as of VI API 2.5 do not use this method. This method throws\n*ResourceInUse*. Networks are automatically\nremoved when no longer in use, so this method is unnecessary.\n\nRemoves a network.\n\nA network can be removed only if it is not used by any host or\nvirtual machine.\n\n***Required privileges:*** Network.Delete", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postDistributedVirtualPortgroupMoIdDestroyNetwork" }, "task": true }, { "name": "postDistributedVirtualPortgroupMoIdReconfigureDVPortgroupTask", "summary": "Reconfigures one or more distributed virtual portgroups.", "description": "Reconfigures one or more distributed virtual portgroups.\n\nYou can use this method to set portgroup properties or\nto reset the portgroup to a previous state.\n\n**Reconfiguring a Standard Distributed Virtual Portgroup**\n\nTo reconfigure a *DistributedVirtualPortgroup*,\nuse a *DVPortgroupConfigSpec*\nto set the portgroup properties.\n\n**Reconfiguring a Portgroup Associated With a VMware Distributed Virtual Switch**\n\nIf you use a *VmwareDistributedVirtualSwitch*,\nyou can perform the following portgroup ...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postDistributedVirtualPortgroupMoIdReconfigureDVPortgroupTask" }, "task": true }, { "name": "postDistributedVirtualPortgroupMoIdReload", "summary": "Reload the entity state.", "description": "Reload the entity state.\n\nClients only need to call this method\nif they changed some external state that affects the service\nwithout using the Web service interface to perform the change.\nFor example, hand-editing a virtual machine configuration file\naffects the configuration of the associated virtual machine but\nthe service managing the virtual machine might not monitor the\nfile for changes. In this case, after such an edit, a client\nwould call \"reload\" on the associated virtual machine to ensu...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postDistributedVirtualPortgroupMoIdReload" }, "task": true }, { "name": "postDistributedVirtualPortgroupMoIdRenameTask", "summary": "Renames this managed entity.", "description": "Renames this managed entity.\n\nAny % (percent) character used in this name parameter\nmust be escaped, unless it is used to start an escape\nsequence. Clients may also escape any other characters in\nthis name parameter.\n\nSee also *ManagedEntity.name*.\n\n***Required privileges:*** DVPortgroup.Modify", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postDistributedVirtualPortgroupMoIdRenameTask" }, "task": true }, { "name": "postDistributedVirtualPortgroupMoIdDVPortgroupRollbackTask", "summary": "This method determines if the portgroup configuration has changed.", "description": "This method determines if the portgroup configuration has changed.\n\nIf it has changed, the method returns a\n*DVPortgroupConfigSpec*.\nUse the *DistributedVirtualPortgroup.ReconfigureDVPortgroup_Task* method\nto apply the rollback configuration to the portgroup. You can use the\nrollback method only on a portgroup that is associated with a\n*VmwareDistributedVirtualSwitch*.\n- If you specify the entityBackup parameter, the returned\n configuration specification represents the exported portgroup conf...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postDistributedVirtualPortgroupMoIdDVPortgroupRollbackTask" }, "task": true }, { "name": "postDistributedVirtualPortgroupMoIdSetCustomValue", "summary": "Assigns a value to a custom field.", "description": "Assigns a value to a custom field.\n\nThe setCustomValue method requires\nwhichever updatePrivilege is defined as one of the\n*CustomFieldDef.fieldInstancePrivileges*\nfor the CustomFieldDef whose value is being changed.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postDistributedVirtualPortgroupMoIdSetCustomValue" }, "task": true }, { "name": "getDistributedVirtualPortgroupMoIdAlarmActionsEnabled", "summary": "Whether alarm actions are enabled for this entity.", "description": "Whether alarm actions are enabled for this entity.\n\nTrue if enabled; false otherwise.\n\n***Required privileges:*** System.Read", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getDistributedVirtualPortgroupMoIdAlarmActionsEnabled" }, "task": true }, { "name": "getDistributedVirtualPortgroupMoIdAvailableField", "summary": "List of custom field definitions that are valid for the object's type.", "description": "List of custom field definitions that are valid for the object's type.\n\nThe fields are sorted by *CustomFieldDef.name*.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getDistributedVirtualPortgroupMoIdAvailableField" }, "task": true }, { "name": "getDistributedVirtualPortgroupMoIdConfig", "summary": "Configuration of the portgroup.", "description": "Configuration of the portgroup.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getDistributedVirtualPortgroupMoIdConfig" }, "task": true }, { "name": "getDistributedVirtualPortgroupMoIdConfigIssue", "summary": "Current configuration issues that have been detected for this entity.", "description": "Current configuration issues that have been detected for this entity.\n\nTypically,\nthese issues have already been logged as events. The entity stores these\nevents as long as they are still current. The\n*configStatus* property provides an overall status\nbased on these events.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getDistributedVirtualPortgroupMoIdConfigIssue" }, "task": true }, { "name": "getDistributedVirtualPortgroupMoIdConfigStatus", "summary": "The configStatus indicates whether or not the system has detected a configuration\nissue involving t", "description": "The configStatus indicates whether or not the system has detected a configuration\nissue involving this entity.\n\nFor example, it might have detected a\nduplicate IP address or MAC address, or a host in a cluster\nmight be out of compliance. The meanings of the configStatus values are:\n- red: A problem has been detected involving the entity.\n- yellow: A problem is about to occur or a transient condition\n has occurred (For example, reconfigure fail-over policy).\n- green: No configuration issues have...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getDistributedVirtualPortgroupMoIdConfigStatus" }, "task": true }, { "name": "getDistributedVirtualPortgroupMoIdCustomValue", "summary": "Custom field values.", "description": "Custom field values.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getDistributedVirtualPortgroupMoIdCustomValue" }, "task": true }, { "name": "getDistributedVirtualPortgroupMoIdDeclaredAlarmState", "summary": "A set of alarm states for alarms that apply to this managed entity.", "description": "A set of alarm states for alarms that apply to this managed entity.\n\nThe set includes alarms defined on this entity\nand alarms inherited from the parent entity,\nor from any ancestors in the inventory hierarchy.\n\nAlarms are inherited if they can be triggered by this entity or its descendants.\nThis set does not include alarms that are defined on descendants of this entity.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getDistributedVirtualPortgroupMoIdDeclaredAlarmState" }, "task": true }, { "name": "getDistributedVirtualPortgroupMoIdDisabledMethod", "summary": "List of operations that are disabled, given the current runtime\nstate of the entity.", "description": "List of operations that are disabled, given the current runtime\nstate of the entity.\n\nFor example, a power-on operation always fails if a\nvirtual machine is already powered on. This list can be used by clients to\nenable or disable operations in a graphical user interface.\n\nNote: This list is determined by the current runtime state of an entity,\nnot by its permissions.\n\nThis list may include the following operations for a HostSystem:\n- *HostSystem.EnterMaintenanceMode_Task*\n- *HostSystem.ExitMain...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getDistributedVirtualPortgroupMoIdDisabledMethod" }, "task": true }, { "name": "getDistributedVirtualPortgroupMoIdEffectiveRole", "summary": "Access rights the current session has to this entity.", "description": "Access rights the current session has to this entity.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getDistributedVirtualPortgroupMoIdEffectiveRole" }, "task": true }, { "name": "getDistributedVirtualPortgroupMoIdHost", "summary": "Hosts attached to this network.", "description": "Hosts attached to this network.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getDistributedVirtualPortgroupMoIdHost" }, "task": true }, { "name": "getDistributedVirtualPortgroupMoIdKey", "summary": "Generated UUID of the portgroup.", "description": "Generated UUID of the portgroup.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getDistributedVirtualPortgroupMoIdKey" }, "task": true }, { "name": "getDistributedVirtualPortgroupMoIdName", "summary": "Name of this entity, unique relative to its parent.", "description": "Name of this entity, unique relative to its parent.\n\nAny / (slash), \\\\ (backslash), character used in this\nname element will be escaped. Similarly, any % (percent) character used in\nthis name element will be escaped, unless it is used to start an escape\nsequence. A slash is escaped as %2F or %2f. A backslash is escaped as %5C or\n%5c, and a percent is escaped as %25.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getDistributedVirtualPortgroupMoIdName" }, "task": true }, { "name": "getDistributedVirtualPortgroupMoIdOverallStatus", "summary": "General health of this managed entity.", "description": "General health of this managed entity.\n\nThe overall status of the managed entity is computed as the worst status\namong its alarms and the configuration issues detected on the entity.\nThe status is reported as one of the following values:\n- red: The entity has alarms or configuration issues with a red status.\n- yellow: The entity does not have alarms or configuration issues with a\n red status, and has at least one with a yellow status.\n- green: The entity does not have alarms or configuration is...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getDistributedVirtualPortgroupMoIdOverallStatus" }, "task": true }, { "name": "getDistributedVirtualPortgroupMoIdParent", "summary": "Parent of this entity.", "description": "Parent of this entity.\n\nThis value is null for the root object and for\n*VirtualMachine* objects that are part of\na *VirtualApp*.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getDistributedVirtualPortgroupMoIdParent" }, "task": true }, { "name": "getDistributedVirtualPortgroupMoIdPermission", "summary": "List of permissions defined for this entity.", "description": "List of permissions defined for this entity.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getDistributedVirtualPortgroupMoIdPermission" }, "task": true }, { "name": "getDistributedVirtualPortgroupMoIdPortKeys", "summary": "Port keys for the set of ports in the portgroup.", "description": "Port keys for the set of ports in the portgroup.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getDistributedVirtualPortgroupMoIdPortKeys" }, "task": true }, { "name": "getDistributedVirtualPortgroupMoIdRecentTask", "summary": "The set of recent tasks operating on this managed entity.", "description": "The set of recent tasks operating on this managed entity.\n\nThis is a subset\nof *TaskManager.recentTask* belong to this entity. A task in this\nlist could be in one of the four states: pending, running, success or error.\n\nThis property can be used to deduce intermediate power states for\na virtual machine entity. For example, if the current powerState is \"poweredOn\"\nand there is a running task performing the \"suspend\" operation, then the virtual\nmachine's intermediate state might be described as \"s...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getDistributedVirtualPortgroupMoIdRecentTask" }, "task": true }, { "name": "getDistributedVirtualPortgroupMoIdSummary", "summary": "Properties of a network.", "description": "Properties of a network.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getDistributedVirtualPortgroupMoIdSummary" }, "task": true }, { "name": "getDistributedVirtualPortgroupMoIdTag", "summary": "The set of tags associated with this managed entity.", "description": "The set of tags associated with this managed entity.\n\nExperimental. Subject to change.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getDistributedVirtualPortgroupMoIdTag" }, "task": true }, { "name": "getDistributedVirtualPortgroupMoIdTriggeredAlarmState", "summary": "A set of alarm states for alarms triggered by this entity\nor by its descendants.", "description": "A set of alarm states for alarms triggered by this entity\nor by its descendants.\n\nTriggered alarms are propagated up the inventory hierarchy\nso that a user can readily tell when a descendant has triggered an alarm.\nIn releases after vSphere API 5.0, vSphere Servers might not\ngenerate property collector update notifications for this property.\nTo obtain the latest value of the property, you can use\nPropertyCollector methods RetrievePropertiesEx or WaitForUpdatesEx.\nIf you use the PropertyCollector...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getDistributedVirtualPortgroupMoIdTriggeredAlarmState" }, "task": true }, { "name": "getDistributedVirtualPortgroupMoIdValue", "summary": "List of custom field values.", "description": "List of custom field values.\n\nEach value uses a key to associate\nan instance of a *CustomFieldStringValue* with\na custom field definition.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getDistributedVirtualPortgroupMoIdValue" }, "task": true }, { "name": "getDistributedVirtualPortgroupMoIdVm", "summary": "Virtual machines using this network.", "description": "Virtual machines using this network.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getDistributedVirtualPortgroupMoIdVm" }, "task": true }, { "name": "postDistributedVirtualSwitchMoIdAddNetworkResourcePool", "summary": "Add a network resource pool.", "description": "Deprecated as of vSphere API 6.0\nUse *DistributedVirtualSwitch.DvsReconfigureVmVnicNetworkResourcePool_Task* instead\nto add a Virtual NIC network resource pool.\n\nAdd a network resource pool.\n\n***Required privileges:*** DVSwitch.ResourceManagement", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postDistributedVirtualSwitchMoIdAddNetworkResourcePool" }, "task": true }, { "name": "postDistributedVirtualSwitchMoIdCreateDVPortgroupTask", "summary": "Creates a single *DistributedVirtualPortgroup* and adds it\nto the distributed virtual switch.", "description": "Creates a single *DistributedVirtualPortgroup* and adds it\nto the distributed virtual switch.\n\n***Required privileges:*** DVPortgroup.Create", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postDistributedVirtualSwitchMoIdCreateDVPortgroupTask" }, "task": true }, { "name": "postDistributedVirtualSwitchMoIdAddDVPortgroupTask", "summary": "Creates one or more *DistributedVirtualPortgroup*s and adds them to\nthe distributed virtual switch.", "description": "Creates one or more *DistributedVirtualPortgroup*s and adds them to\nthe distributed virtual switch.\n\n***Required privileges:*** DVPortgroup.Create", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postDistributedVirtualSwitchMoIdAddDVPortgroupTask" }, "task": true }, { "name": "postDistributedVirtualSwitchMoIdDestroyTask", "summary": "Destroys this object, deleting its contents and removing it from its parent\nfolder (if any).", "description": "Destroys this object, deleting its contents and removing it from its parent\nfolder (if any).\n\nNOTE: The appropriate privilege must be held on the parent of the destroyed\nentity as well as the entity itself.\nThis method can throw one of several exceptions. The exact set of exceptions\ndepends on the kind of entity that is being removed. See comments for\neach entity for more information on destroy behavior.\n\n***Required privileges:*** DVSwitch.Delete", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postDistributedVirtualSwitchMoIdDestroyTask" }, "task": true }, { "name": "postDistributedVirtualSwitchMoIdEnableNetworkResourceManagement", "summary": "Enable/Disable network I/O control on the vSphere Distributed Switch.", "description": "Enable/Disable network I/O control on the vSphere Distributed Switch.\n\n***Required privileges:*** DVSwitch.ResourceManagement", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postDistributedVirtualSwitchMoIdEnableNetworkResourceManagement" }, "task": true }, { "name": "postDistributedVirtualSwitchMoIdFetchDVPortKeys", "summary": "Return the keys of ports that meet the criteria.", "description": "Return the keys of ports that meet the criteria.\n\nOn an ESXi host,\nthe property shows only the connected ports currently on the host.\n\n***Required privileges:*** System.Read", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postDistributedVirtualSwitchMoIdFetchDVPortKeys" }, "task": true }, { "name": "postDistributedVirtualSwitchMoIdFetchDVPorts", "summary": "Return the ports that meet the criteria.", "description": "Return the ports that meet the criteria.\n\n***Required privileges:*** System.Read", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postDistributedVirtualSwitchMoIdFetchDVPorts" }, "task": true }, { "name": "postDistributedVirtualSwitchMoIdLookupDvPortGroup", "summary": "Returns the portgroup identified by the key within this VDS.", "description": "Returns the portgroup identified by the key within this VDS.\n\n***Required privileges:*** System.Read", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postDistributedVirtualSwitchMoIdLookupDvPortGroup" }, "task": true }, { "name": "postDistributedVirtualSwitchMoIdMergeDvsTask", "summary": "Merge an existing DistributedVirtualSwitch (source) to this switch\n(destination).", "description": "Deprecated as of vSphere API 5.5.\n\nMerge an existing DistributedVirtualSwitch (source) to this switch\n(destination).\n\nThe host members and the connected entity of the source\nswitch will be transferred to the destination switch. This operation\ndisconnects the entities from the source switch, tears down its host\nproxy switches, creates new proxies for the destination switch,\nand reconnects the entities to the destination switch.\n\nIn summary, this operation does the following:\n- Adds the\n config ...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postDistributedVirtualSwitchMoIdMergeDvsTask" }, "task": true }, { "name": "postDistributedVirtualSwitchMoIdMoveDVPortTask", "summary": "Move the ports out of their current portgroup into the specified portgroup.", "description": "Deprecated as of vSphere API 6.0.\n\nMove the ports out of their current portgroup into the specified portgroup.\n\nIf the moving of any of the ports results in a violation of the portgroup\npolicy, or type of the source or destination portgroup, the operation\nraises a fault. A conflict port cannot be moved.\n\n***Required privileges:*** DVSwitch.Modify", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postDistributedVirtualSwitchMoIdMoveDVPortTask" }, "task": true }, { "name": "postDistributedVirtualSwitchMoIdPerformDvsProductSpecOperationTask", "summary": "This method updates the *DistributedVirtualSwitch* product specifications.", "description": "This method updates the *DistributedVirtualSwitch* product specifications.\n\n***Required privileges:*** DVSwitch.Modify", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postDistributedVirtualSwitchMoIdPerformDvsProductSpecOperationTask" }, "task": true }, { "name": "postDistributedVirtualSwitchMoIdQueryUsedVlanIdInDvs", "summary": "Return the used VLAN ID (PVLAN excluded) in the switch.", "description": "Return the used VLAN ID (PVLAN excluded) in the switch.\n\n***Required privileges:*** System.Read", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postDistributedVirtualSwitchMoIdQueryUsedVlanIdInDvs" }, "task": true }, { "name": "postDistributedVirtualSwitchMoIdReconfigureDvsTask", "summary": "Reconfigures a distributed virtual switch.", "description": "Reconfigures a distributed virtual switch.\n\nYou can use this method\nto set switch properties or to reset the switch to a previous state.\n\n**Reconfiguring a Standard Distributed Virtual Switch**\n\nTo reconfigure a *DistributedVirtualSwitch*,\nuse a *DVSConfigSpec*\nto set the switch properties.\n\n**Reconfiguring a VMware Distributed Virtual Switch**\n\nIf you use a *VmwareDistributedVirtualSwitch*,\nyou can perform the following switch reconfiguration:\n- Use a *VMwareDVSConfigSpec*\n to set the switch p...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postDistributedVirtualSwitchMoIdReconfigureDvsTask" }, "task": true }, { "name": "postDistributedVirtualSwitchMoIdReconfigureDVPortTask", "summary": "Reconfigure individual ports.", "description": "Reconfigure individual ports.\n\n***Required privileges:*** DVSwitch.PortConfig", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postDistributedVirtualSwitchMoIdReconfigureDVPortTask" }, "task": true }, { "name": "postDistributedVirtualSwitchMoIdDvsReconfigureVmVnicNetworkResourcePoolTask", "summary": "reconfigure the Virtual NIC network resource pool configuration.", "description": "reconfigure the Virtual NIC network resource pool configuration.\n\n***Required privileges:*** DVSwitch.ResourceManagement", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postDistributedVirtualSwitchMoIdDvsReconfigureVmVnicNetworkResourcePoolTask" }, "task": true }, { "name": "postDistributedVirtualSwitchMoIdRectifyDvsHostTask", "summary": "Update the switch configuration on the host to bring them in sync with the\ncurrent configuration in", "description": "Deprecated as of vSphere API 5.0.\nUse\n*DistributedVirtualSwitchManager*.*DistributedVirtualSwitchManager.RectifyDvsOnHost_Task* instead.\n\nUpdate the switch configuration on the host to bring them in sync with the\ncurrent configuration in vCenter Server.\n\n***Required privileges:*** System.Read", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postDistributedVirtualSwitchMoIdRectifyDvsHostTask" }, "task": true }, { "name": "postDistributedVirtualSwitchMoIdRefreshDVPortState", "summary": "Refresh port states.", "description": "Refresh port states.\n\n***Required privileges:*** System.Read", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postDistributedVirtualSwitchMoIdRefreshDVPortState" }, "task": true }, { "name": "postDistributedVirtualSwitchMoIdReload", "summary": "Reload the entity state.", "description": "Reload the entity state.\n\nClients only need to call this method\nif they changed some external state that affects the service\nwithout using the Web service interface to perform the change.\nFor example, hand-editing a virtual machine configuration file\naffects the configuration of the associated virtual machine but\nthe service managing the virtual machine might not monitor the\nfile for changes. In this case, after such an edit, a client\nwould call \"reload\" on the associated virtual machine to ensu...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postDistributedVirtualSwitchMoIdReload" }, "task": true }, { "name": "postDistributedVirtualSwitchMoIdRemoveNetworkResourcePool", "summary": "Remove a network resource pool.", "description": "Deprecated as of vSphere API 6.0\nUse *DistributedVirtualSwitch.DvsReconfigureVmVnicNetworkResourcePool_Task* instead\nto remove a Virtual NIC network resource pool.\n\nRemove a network resource pool.\n\n***Required privileges:*** DVSwitch.ResourceManagement", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postDistributedVirtualSwitchMoIdRemoveNetworkResourcePool" }, "task": true }, { "name": "postDistributedVirtualSwitchMoIdRenameTask", "summary": "Renames this managed entity.", "description": "Renames this managed entity.\n\nAny % (percent) character used in this name parameter\nmust be escaped, unless it is used to start an escape\nsequence. Clients may also escape any other characters in\nthis name parameter.\n\nSee also *ManagedEntity.name*.\n\n***Required privileges:*** DVSwitch.Modify", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postDistributedVirtualSwitchMoIdRenameTask" }, "task": true }, { "name": "postDistributedVirtualSwitchMoIdDVSRollbackTask", "summary": "This method determines if the distributed virtual switch configuration\nhas changed.", "description": "This method determines if the distributed virtual switch configuration\nhas changed.\n\nIf it has changed, the method returns a\n*VMwareDVSConfigSpec*.\nUse the *DistributedVirtualSwitch.ReconfigureDvs_Task* method to apply\nthe rollback configuration to the switch.\nYou can use the rollback method only on a *VmwareDistributedVirtualSwitch*.\n- If you specify the entityBackup parameter, the returned\n configuration specification represents the exported switch configuration.\n If the entityBackup mat...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postDistributedVirtualSwitchMoIdDVSRollbackTask" }, "task": true }, { "name": "postDistributedVirtualSwitchMoIdSetCustomValue", "summary": "Assigns a value to a custom field.", "description": "Assigns a value to a custom field.\n\nThe setCustomValue method requires\nwhichever updatePrivilege is defined as one of the\n*CustomFieldDef.fieldInstancePrivileges*\nfor the CustomFieldDef whose value is being changed.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postDistributedVirtualSwitchMoIdSetCustomValue" }, "task": true }, { "name": "postDistributedVirtualSwitchMoIdUpdateDvsCapability", "summary": "Set the capability of the switch.", "description": "Set the capability of the switch.\n\n***Required privileges:*** DVSwitch.Modify", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postDistributedVirtualSwitchMoIdUpdateDvsCapability" }, "task": true }, { "name": "postDistributedVirtualSwitchMoIdUpdateDVSHealthCheckConfigTask", "summary": "Update health check configuration.", "description": "Update health check configuration.\n\n***Required privileges:*** DVSwitch.Modify", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postDistributedVirtualSwitchMoIdUpdateDVSHealthCheckConfigTask" }, "task": true }, { "name": "postDistributedVirtualSwitchMoIdUpdateNetworkResourcePool", "summary": "Update the network resource pool configuration.", "description": "Deprecated as of vSphere API 6.0\nUse *DistributedVirtualSwitch.DvsReconfigureVmVnicNetworkResourcePool_Task* instead\nto update the Virtual NIC network resource pool.\n\nUpdate the network resource pool configuration.\n\n***Required privileges:*** DVSwitch.ResourceManagement", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postDistributedVirtualSwitchMoIdUpdateNetworkResourcePool" }, "task": true }, { "name": "getDistributedVirtualSwitchMoIdAlarmActionsEnabled", "summary": "Whether alarm actions are enabled for this entity.", "description": "Whether alarm actions are enabled for this entity.\n\nTrue if enabled; false otherwise.\n\n***Required privileges:*** System.Read", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getDistributedVirtualSwitchMoIdAlarmActionsEnabled" }, "task": true }, { "name": "getDistributedVirtualSwitchMoIdAvailableField", "summary": "List of custom field definitions that are valid for the object's type.", "description": "List of custom field definitions that are valid for the object's type.\n\nThe fields are sorted by *CustomFieldDef.name*.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getDistributedVirtualSwitchMoIdAvailableField" }, "task": true }, { "name": "getDistributedVirtualSwitchMoIdCapability", "summary": "Capability of the switch.", "description": "Capability of the switch.\n\nCapabilities are indicated at the port,\nportgroup and switch levels, and for version-specific features.\nWhen you retrieve this property from an ESXi host,\n*DistributedVirtualSwitch.capability*.*DVSCapability.dvsOperationSupported*\nshould always be set to false.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getDistributedVirtualSwitchMoIdCapability" }, "task": true }, { "name": "getDistributedVirtualSwitchMoIdConfig", "summary": "Switch configuration data.", "description": "Switch configuration data.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getDistributedVirtualSwitchMoIdConfig" }, "task": true }, { "name": "getDistributedVirtualSwitchMoIdConfigIssue", "summary": "Current configuration issues that have been detected for this entity.", "description": "Current configuration issues that have been detected for this entity.\n\nTypically,\nthese issues have already been logged as events. The entity stores these\nevents as long as they are still current. The\n*configStatus* property provides an overall status\nbased on these events.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getDistributedVirtualSwitchMoIdConfigIssue" }, "task": true }, { "name": "getDistributedVirtualSwitchMoIdConfigStatus", "summary": "The configStatus indicates whether or not the system has detected a configuration\nissue involving t", "description": "The configStatus indicates whether or not the system has detected a configuration\nissue involving this entity.\n\nFor example, it might have detected a\nduplicate IP address or MAC address, or a host in a cluster\nmight be out of compliance. The meanings of the configStatus values are:\n- red: A problem has been detected involving the entity.\n- yellow: A problem is about to occur or a transient condition\n has occurred (For example, reconfigure fail-over policy).\n- green: No configuration issues have...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getDistributedVirtualSwitchMoIdConfigStatus" }, "task": true }, { "name": "getDistributedVirtualSwitchMoIdCustomValue", "summary": "Custom field values.", "description": "Custom field values.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getDistributedVirtualSwitchMoIdCustomValue" }, "task": true }, { "name": "getDistributedVirtualSwitchMoIdDeclaredAlarmState", "summary": "A set of alarm states for alarms that apply to this managed entity.", "description": "A set of alarm states for alarms that apply to this managed entity.\n\nThe set includes alarms defined on this entity\nand alarms inherited from the parent entity,\nor from any ancestors in the inventory hierarchy.\n\nAlarms are inherited if they can be triggered by this entity or its descendants.\nThis set does not include alarms that are defined on descendants of this entity.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getDistributedVirtualSwitchMoIdDeclaredAlarmState" }, "task": true }, { "name": "getDistributedVirtualSwitchMoIdDisabledMethod", "summary": "List of operations that are disabled, given the current runtime\nstate of the entity.", "description": "List of operations that are disabled, given the current runtime\nstate of the entity.\n\nFor example, a power-on operation always fails if a\nvirtual machine is already powered on. This list can be used by clients to\nenable or disable operations in a graphical user interface.\n\nNote: This list is determined by the current runtime state of an entity,\nnot by its permissions.\n\nThis list may include the following operations for a HostSystem:\n- *HostSystem.EnterMaintenanceMode_Task*\n- *HostSystem.ExitMain...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getDistributedVirtualSwitchMoIdDisabledMethod" }, "task": true }, { "name": "getDistributedVirtualSwitchMoIdEffectiveRole", "summary": "Access rights the current session has to this entity.", "description": "Access rights the current session has to this entity.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getDistributedVirtualSwitchMoIdEffectiveRole" }, "task": true }, { "name": "getDistributedVirtualSwitchMoIdName", "summary": "Name of this entity, unique relative to its parent.", "description": "Name of this entity, unique relative to its parent.\n\nAny / (slash), \\\\ (backslash), character used in this\nname element will be escaped. Similarly, any % (percent) character used in\nthis name element will be escaped, unless it is used to start an escape\nsequence. A slash is escaped as %2F or %2f. A backslash is escaped as %5C or\n%5c, and a percent is escaped as %25.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getDistributedVirtualSwitchMoIdName" }, "task": true }, { "name": "getDistributedVirtualSwitchMoIdNetworkResourcePool", "summary": "Network resource pool information for the switch.", "description": "Deprecated as of vSphere API 6.0\nUse *DVSConfigInfo.vmVnicNetworkResourcePool*\nto get the Virtual NIC resource pool information.\nUse *DVSConfigInfo.infrastructureTrafficResourceConfig*\nto get the host infrastructure resource information.\n\nNetwork resource pool information for the switch.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getDistributedVirtualSwitchMoIdNetworkResourcePool" }, "task": true }, { "name": "getDistributedVirtualSwitchMoIdOverallStatus", "summary": "General health of this managed entity.", "description": "General health of this managed entity.\n\nThe overall status of the managed entity is computed as the worst status\namong its alarms and the configuration issues detected on the entity.\nThe status is reported as one of the following values:\n- red: The entity has alarms or configuration issues with a red status.\n- yellow: The entity does not have alarms or configuration issues with a\n red status, and has at least one with a yellow status.\n- green: The entity does not have alarms or configuration is...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getDistributedVirtualSwitchMoIdOverallStatus" }, "task": true }, { "name": "getDistributedVirtualSwitchMoIdParent", "summary": "Parent of this entity.", "description": "Parent of this entity.\n\nThis value is null for the root object and for\n*VirtualMachine* objects that are part of\na *VirtualApp*.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getDistributedVirtualSwitchMoIdParent" }, "task": true }, { "name": "getDistributedVirtualSwitchMoIdPermission", "summary": "List of permissions defined for this entity.", "description": "List of permissions defined for this entity.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getDistributedVirtualSwitchMoIdPermission" }, "task": true }, { "name": "getDistributedVirtualSwitchMoIdPortgroup", "summary": "Portgroups that are defined on the switch.", "description": "Portgroups that are defined on the switch.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getDistributedVirtualSwitchMoIdPortgroup" }, "task": true }, { "name": "getDistributedVirtualSwitchMoIdRecentTask", "summary": "The set of recent tasks operating on this managed entity.", "description": "The set of recent tasks operating on this managed entity.\n\nThis is a subset\nof *TaskManager.recentTask* belong to this entity. A task in this\nlist could be in one of the four states: pending, running, success or error.\n\nThis property can be used to deduce intermediate power states for\na virtual machine entity. For example, if the current powerState is \"poweredOn\"\nand there is a running task performing the \"suspend\" operation, then the virtual\nmachine's intermediate state might be described as \"s...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getDistributedVirtualSwitchMoIdRecentTask" }, "task": true }, { "name": "getDistributedVirtualSwitchMoIdRuntime", "summary": "Runtime information of the distributed virtual switch.", "description": "Runtime information of the distributed virtual switch.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getDistributedVirtualSwitchMoIdRuntime" }, "task": true }, { "name": "getDistributedVirtualSwitchMoIdSummary", "summary": "Summary of the switch.", "description": "Summary of the switch.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getDistributedVirtualSwitchMoIdSummary" }, "task": true }, { "name": "getDistributedVirtualSwitchMoIdTag", "summary": "The set of tags associated with this managed entity.", "description": "The set of tags associated with this managed entity.\n\nExperimental. Subject to change.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getDistributedVirtualSwitchMoIdTag" }, "task": true }, { "name": "getDistributedVirtualSwitchMoIdTriggeredAlarmState", "summary": "A set of alarm states for alarms triggered by this entity\nor by its descendants.", "description": "A set of alarm states for alarms triggered by this entity\nor by its descendants.\n\nTriggered alarms are propagated up the inventory hierarchy\nso that a user can readily tell when a descendant has triggered an alarm.\nIn releases after vSphere API 5.0, vSphere Servers might not\ngenerate property collector update notifications for this property.\nTo obtain the latest value of the property, you can use\nPropertyCollector methods RetrievePropertiesEx or WaitForUpdatesEx.\nIf you use the PropertyCollector...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getDistributedVirtualSwitchMoIdTriggeredAlarmState" }, "task": true }, { "name": "getDistributedVirtualSwitchMoIdUuid", "summary": "Generated UUID of the switch.", "description": "Generated UUID of the switch.\n\nUnique across vCenter Server\ninventory and instances.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getDistributedVirtualSwitchMoIdUuid" }, "task": true }, { "name": "getDistributedVirtualSwitchMoIdValue", "summary": "List of custom field values.", "description": "List of custom field values.\n\nEach value uses a key to associate\nan instance of a *CustomFieldStringValue* with\na custom field definition.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getDistributedVirtualSwitchMoIdValue" }, "task": true }, { "name": "postDistributedVirtualSwitchManagerMoIdQueryDvsCheckCompatibility", "summary": "This operation returns a list of compatibility results.", "description": "This operation returns a list of compatibility results.\n\nEach compatibility result\nis an object that has a host property and optionally a fault which would\nbe populated only if that host is not compatible with a given dvsProductSpec.\nAll filters in hostFilerSpecs are ANDed to derive the intersection of hosts against\nwhich compatibility is checked. If caller did not have view privileges on the\nhost entity in an element of the CompatibilityResult array, then that entire\nelement would be removed fr...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postDistributedVirtualSwitchManagerMoIdQueryDvsCheckCompatibility" }, "task": true }, { "name": "postDistributedVirtualSwitchManagerMoIdDVSManagerExportEntityTask", "summary": "Export the configuration for entities specified in the\n selectionSet parameter.", "description": "Export the configuration for entities specified in the\n selectionSet parameter.\n\nYou can use this method only\nfor a *VmwareDistributedVirtualSwitch* and its\nassociated *DistributedVirtualPortgroup* objects.\n\nUse the *DistributedVirtualSwitchManager.DVSManagerImportEntity_Task* method to restore the entity\nto the state represented by the exported configuration.\nYou can also use the exported configuration to create\na new switch or portgroup.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postDistributedVirtualSwitchManagerMoIdDVSManagerExportEntityTask" }, "task": true }, { "name": "postDistributedVirtualSwitchManagerMoIdDVSManagerImportEntityTask", "summary": "Import the configuration of entities specified in\n*EntityBackupConfig*.", "description": "Import the configuration of entities specified in\n*EntityBackupConfig*.\n\nYou can restore the\nexisting configuration to the state represented by the\nbackup configuration. You can also use the backup\nconfiguration to create a new switch or portgroup.\nSee *EntityImportType_enum*.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postDistributedVirtualSwitchManagerMoIdDVSManagerImportEntityTask" }, "task": true }, { "name": "postDistributedVirtualSwitchManagerMoIdDVSManagerLookupDvPortGroup", "summary": "Returns the portgroup identified by the key within the specified VDS\nidentified by its UUID.", "description": "Returns the portgroup identified by the key within the specified VDS\nidentified by its UUID.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postDistributedVirtualSwitchManagerMoIdDVSManagerLookupDvPortGroup" }, "task": true }, { "name": "postDistributedVirtualSwitchManagerMoIdQueryCompatibleHostForExistingDvs", "summary": "This operation returns a list of hosts that are compatible with\nthe given DistributedVirtualSwitch", "description": "This operation returns a list of hosts that are compatible with\nthe given DistributedVirtualSwitch product specification.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postDistributedVirtualSwitchManagerMoIdQueryCompatibleHostForExistingDvs" }, "task": true }, { "name": "postDistributedVirtualSwitchManagerMoIdQueryCompatibleHostForNewDvs", "summary": "This operation returns a list of hosts that are compatible with\nthe given DistributedVirtualSwitch", "description": "This operation returns a list of hosts that are compatible with\nthe given DistributedVirtualSwitch product specification.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postDistributedVirtualSwitchManagerMoIdQueryCompatibleHostForNewDvs" }, "task": true }, { "name": "postDistributedVirtualSwitchManagerMoIdQueryDvsCompatibleHostSpec", "summary": "This operation returns a list of host product specifications that\nare compatible with the given Dis", "description": "This operation returns a list of host product specifications that\nare compatible with the given DistributedVirtualSwitch product\nspecification.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postDistributedVirtualSwitchManagerMoIdQueryDvsCompatibleHostSpec" }, "task": true }, { "name": "postDistributedVirtualSwitchManagerMoIdQueryCompatibleVmnicsFromHosts", "summary": "This operation returns a list of vmnics which are compatible\nwith the given DistributedVirtualSwitc", "description": "This operation returns a list of vmnics which are compatible\nwith the given DistributedVirtualSwitch product specification.\n\n***Since:*** vSphere API Release 8.0.0.1\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postDistributedVirtualSwitchManagerMoIdQueryCompatibleVmnicsFromHosts" }, "task": true }, { "name": "postDistributedVirtualSwitchManagerMoIdQueryDvsConfigTarget", "summary": "This operation returns the DistributedVirtualSwitch or\nDistributedVirtualPortgroup configuration ta", "description": "This operation returns the DistributedVirtualSwitch or\nDistributedVirtualPortgroup configuration target on a host.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postDistributedVirtualSwitchManagerMoIdQueryDvsConfigTarget" }, "task": true }, { "name": "postDistributedVirtualSwitchManagerMoIdQueryDvsFeatureCapability", "summary": "This operation indicates which version-specific DVS features are\navailable for the given Distribute", "description": "This operation indicates which version-specific DVS features are\navailable for the given DistributedVirtualSwitch product specification.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postDistributedVirtualSwitchManagerMoIdQueryDvsFeatureCapability" }, "task": true }, { "name": "postDistributedVirtualSwitchManagerMoIdQuerySupportedNetworkOffloadSpec", "summary": "This operation returns a list of network offload specifications that are\ncompatible with the given", "description": "This operation returns a list of network offload specifications that are\ncompatible with the given DistributedVirtualSwitch product specification.\n\n***Since:*** vSphere API Release 8.0.0.1\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postDistributedVirtualSwitchManagerMoIdQuerySupportedNetworkOffloadSpec" }, "task": true }, { "name": "postDistributedVirtualSwitchManagerMoIdQueryAvailableDvsSpec", "summary": "This operation returns a list of switch product specifications that\nare supported by the vCenter Se", "description": "This operation returns a list of switch product specifications that\nare supported by the vCenter Server.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postDistributedVirtualSwitchManagerMoIdQueryAvailableDvsSpec" }, "task": true }, { "name": "postDistributedVirtualSwitchManagerMoIdQueryDvsByUuid", "summary": "This operation returns a DistributedVirtualSwitch given a UUID.", "description": "This operation returns a DistributedVirtualSwitch given a UUID.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postDistributedVirtualSwitchManagerMoIdQueryDvsByUuid" }, "task": true }, { "name": "postDistributedVirtualSwitchManagerMoIdRectifyDvsOnHostTask", "summary": "Update the Distributed Switch configuration on the hosts to bring them in sync with the\ncurrent con", "description": "Update the Distributed Switch configuration on the hosts to bring them in sync with the\ncurrent configuration in vCenter Server.\n\n***Required privileges:*** System.Read", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postDistributedVirtualSwitchManagerMoIdRectifyDvsOnHostTask" }, "task": true }, { "name": "postEnvironmentBrowserMoIdQueryConfigOption", "summary": "Query for a specific virtual machine configuration option (the ConfigOption).", "description": "Query for a specific virtual machine configuration option (the ConfigOption).\n\nIf the EnvironmentBrowser is from a ComputeResource or ClusterComputeResource,\nthe key or host, or both arguments can be used to return the required config\noptions. If a key is specified, then the ConfigOption corresponding to that key\nvalue is returned. If a host is specified, then the default ConfigOption for\nthat host is returned. If key and host both are specified, the ConfigOption\ncorresponding to the given key f...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postEnvironmentBrowserMoIdQueryConfigOption" }, "task": true }, { "name": "postEnvironmentBrowserMoIdQueryConfigOptionDescriptor", "summary": "The list of ConfigOption keys available on this entity.", "description": "The list of ConfigOption keys available on this entity.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postEnvironmentBrowserMoIdQueryConfigOptionDescriptor" }, "task": true }, { "name": "postEnvironmentBrowserMoIdQueryConfigOptionEx", "summary": "Query for a virtual machine configuration *option*\nmatching the key or host or both given in the\n*E", "description": "Query for a virtual machine configuration *option*\nmatching the key or host or both given in the\n*EnvironmentBrowserConfigOptionQuerySpec*.\n\nFor more details see\n*EnvironmentBrowser.QueryConfigOption*\n\nIf the Environment Browser belongs to a virtual machine and the spec argument\nis omitted, the method returns the ConfigOption object corresponding to the\nvmx version of the virutal machine and the\n*guestOSDescriptor* list contains\nonly the guestId of the virutal machine.\n\n***Required privileges:**...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postEnvironmentBrowserMoIdQueryConfigOptionEx" }, "task": true }, { "name": "postEnvironmentBrowserMoIdQueryConfigTarget", "summary": "Queries for information about a specific target, a \"physical\" device that\ncan be used to back virtu", "description": "Queries for information about a specific target, a \"physical\" device that\ncan be used to back virtual devices.\n\nThe ConfigTarget that is returned specifies\nthe set of values that can be used in the device backings to connect the virtual\nmachine to physical (or logical) host devices.\n\nIf the EnvironmentBrowser is from a ComputeResource or ClusterComputeResource,\nthe host argument can be used to return the ConfigTarget provided by a particular\nhost in the compute resource or cluster. If host is no...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postEnvironmentBrowserMoIdQueryConfigTarget" }, "task": true }, { "name": "postEnvironmentBrowserMoIdQueryTargetCapabilities", "summary": "Queries for information on the capabilities supported by the ComputeResource\nassociated with the En", "description": "Queries for information on the capabilities supported by the ComputeResource\nassociated with the EnvironmentBrowser.\n\nIf the EnvironmentBrowser is from a ComputeResource or ClusterComputeResource,\nthe host argument can be used to return the capabilities associated with a\nspecific host in the compute resource or cluster. If the host argument is not\nspecified and the EnvironmentBrowser is from a ComputeResource or\nClusterComputeResource, then the intersection of the capabilities supported by\nall t...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postEnvironmentBrowserMoIdQueryTargetCapabilities" }, "task": true }, { "name": "getEnvironmentBrowserMoIdDatastoreBrowser", "summary": "DatastoreBrowser to browse datastores that are available on this entity.", "description": "DatastoreBrowser to browse datastores that are available on this entity.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getEnvironmentBrowserMoIdDatastoreBrowser" }, "task": true }, { "name": "postEventHistoryCollectorMoIdReadNextEvents", "summary": "Reads the 'scrollable view' from the current position.", "description": "Reads the 'scrollable view' from the current position.\n\nThe scrollable\nposition is moved to the next newer page after the read. No item is\nreturned when the end of the collector is reached.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postEventHistoryCollectorMoIdReadNextEvents" }, "task": true }, { "name": "postEventHistoryCollectorMoIdReadPreviousEvents", "summary": "Reads the 'scrollable view' from the current position.", "description": "Reads the 'scrollable view' from the current position.\n\nThe scrollable\nposition is moved to the next older page after the read. No item is\nreturned when the head of the collector is reached.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postEventHistoryCollectorMoIdReadPreviousEvents" }, "task": true }, { "name": "postEventHistoryCollectorMoIdDestroyCollector", "summary": "Destroys this collector.", "description": "Destroys this collector.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postEventHistoryCollectorMoIdDestroyCollector" }, "task": true }, { "name": "postEventHistoryCollectorMoIdResetCollector", "summary": "Moves the \"scrollable view\" to the item immediately preceding the\n\"viewable latest page\".", "description": "Moves the \"scrollable view\" to the item immediately preceding the\n\"viewable latest page\".\n\nIf you use \"readPrev\",\n*ReadPreviousTasks* or\n*ReadPreviousEvents*,\nall items\nare retrieved from the newest item to the oldest item.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postEventHistoryCollectorMoIdResetCollector" }, "task": true }, { "name": "postEventHistoryCollectorMoIdRewindCollector", "summary": "Moves the \"scrollable view\" to the oldest item.", "description": "Moves the \"scrollable view\" to the oldest item.\n\nIf you use\n*ReadNextTasks* or\n*ReadNextEvents*,\nall items are retrieved from the oldest item to the newest item. This\nis the default setting when the collector is created.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postEventHistoryCollectorMoIdRewindCollector" }, "task": true }, { "name": "postEventHistoryCollectorMoIdSetCollectorPageSize", "summary": "Sets the \"viewable latest page\" size to contain at most the\nnumber of items specified by the maxCou", "description": "Sets the \"viewable latest page\" size to contain at most the\nnumber of items specified by the maxCount parameter).", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postEventHistoryCollectorMoIdSetCollectorPageSize" }, "task": true }, { "name": "getEventHistoryCollectorMoIdFilter", "summary": "The filter used to create this collector.", "description": "The filter used to create this collector.\n\nThe type of the returned filter is determined by the managed object\nfor which the collector is created.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getEventHistoryCollectorMoIdFilter" }, "task": true }, { "name": "getEventHistoryCollectorMoIdInitialized", "summary": "Indicates whether the *EventHistoryCollector.latestPage* is initialized.", "description": "Indicates whether the *EventHistoryCollector.latestPage* is initialized.\n\nIf the\n*EventFilterSpec.delayedInit* is `false` or unset this property is always true.\n\n***Since:*** vSphere API Release 8.0.3.0", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getEventHistoryCollectorMoIdInitialized" }, "task": true }, { "name": "getEventHistoryCollectorMoIdLatestPage", "summary": "The items in the 'viewable latest page'.", "description": "The items in the 'viewable latest page'.\n\nAs new events that match the\ncollector's *EventFilterSpec* are created, they are added to this\npage, and the oldest events are removed from the collector to keep the\nsize of the page to that allowed by\n*HistoryCollector.SetCollectorPageSize*.\n\nThe \"oldest event\" is the one with the smallest key (event ID). The\nevents in the returned page are unordered.\nWhile `initialized` is `false` this property will remain empty and once the Collector is initialized it...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getEventHistoryCollectorMoIdLatestPage" }, "task": true }, { "name": "postEventManagerMoIdQueryEvents", "summary": "Returns the events in specified filter.", "description": "Returns the events in specified filter.\n\nReturns empty array when there are not any events qualified.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postEventManagerMoIdQueryEvents" }, "task": true }, { "name": "postEventManagerMoIdCreateCollectorForEvents", "summary": "Creates an event history collector, which is a specialized history collector\nthat provides Event ob", "description": "Creates an event history collector, which is a specialized history collector\nthat provides Event objects.\n\nEvent collectors do not persist beyond the current client session.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postEventManagerMoIdCreateCollectorForEvents" }, "task": true }, { "name": "postEventManagerMoIdLogUserEvent", "summary": "Logs a user defined event against a particular managed entity.", "description": "Logs a user defined event against a particular managed entity.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postEventManagerMoIdLogUserEvent" }, "task": true }, { "name": "postEventManagerMoIdPostEvent", "summary": "Posts the specified event, optionally associating it with\na task.", "description": "Posts the specified event, optionally associating it with\na task.\n\nThe event being posted should have the following info in it:\n- The *ManagedEntity* on which the event is being posted should\n be set in the appropriate *EntityEventArgument* field of the base\n *Event* class. It is OK to not set any entity, in which case the\n event is treated as an event about the system.\n- Some Event fields (*Event.key*, *Event.chainId*,\n *Event.createdTime*) are mandatory because of the nature of\n the struc...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postEventManagerMoIdPostEvent" }, "task": true }, { "name": "postEventManagerMoIdRetrieveArgumentDescription", "summary": "Retrieves the argument meta-data for a given Event type", "description": "Retrieves the argument meta-data for a given Event type\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postEventManagerMoIdRetrieveArgumentDescription" }, "task": true }, { "name": "getEventManagerMoIdDescription", "summary": "Static descriptive strings used in events.", "description": "Static descriptive strings used in events.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getEventManagerMoIdDescription" }, "task": true }, { "name": "getEventManagerMoIdLatestEvent", "summary": "The latest event that happened on the VirtualCenter server.", "description": "The latest event that happened on the VirtualCenter server.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getEventManagerMoIdLatestEvent" }, "task": true }, { "name": "getEventManagerMoIdMaxCollector", "summary": "For each client, the maximum number of event collectors that can exist\nsimultaneously.", "description": "For each client, the maximum number of event collectors that can exist\nsimultaneously.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getEventManagerMoIdMaxCollector" }, "task": true }, { "name": "postExtensibleManagedObjectMoIdSetCustomValue", "summary": "Assigns a value to a custom field.", "description": "Assigns a value to a custom field.\n\nThe setCustomValue method requires\nwhichever updatePrivilege is defined as one of the\n*CustomFieldDef.fieldInstancePrivileges*\nfor the CustomFieldDef whose value is being changed.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postExtensibleManagedObjectMoIdSetCustomValue" }, "task": true }, { "name": "getExtensibleManagedObjectMoIdAvailableField", "summary": "List of custom field definitions that are valid for the object's type.", "description": "List of custom field definitions that are valid for the object's type.\n\nThe fields are sorted by *CustomFieldDef.name*.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getExtensibleManagedObjectMoIdAvailableField" }, "task": true }, { "name": "getExtensibleManagedObjectMoIdValue", "summary": "List of custom field values.", "description": "List of custom field values.\n\nEach value uses a key to associate\nan instance of a *CustomFieldStringValue* with\na custom field definition.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getExtensibleManagedObjectMoIdValue" }, "task": true }, { "name": "postExtensionManagerMoIdFindExtension", "summary": "Returns extension with the given key, if any.", "description": "Returns extension with the given key, if any.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postExtensionManagerMoIdFindExtension" }, "task": true }, { "name": "postExtensionManagerMoIdGetPublicKey", "summary": "Returns VirtualCenter Server public key.", "description": "Deprecated as of VI 4.0, use trusted certificates and\n*SessionManager.LoginExtensionBySubjectName* or\n*ExtensionManager.SetExtensionCertificate* and\n*SessionManager.LoginExtensionByCertificate*.\n\nReturns VirtualCenter Server public key.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postExtensionManagerMoIdGetPublicKey" }, "task": true }, { "name": "postExtensionManagerMoIdQueryExtensionIpAllocationUsage", "summary": "Query statistics about IP allocation usage, either system wide or for\nspecified extensions.", "description": "Query statistics about IP allocation usage, either system wide or for\nspecified extensions.\n\nRefer to *IpPoolManager* for details.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postExtensionManagerMoIdQueryExtensionIpAllocationUsage" }, "task": true }, { "name": "postExtensionManagerMoIdQueryManagedBy", "summary": "Find entities managed by an extension.", "description": "Find entities managed by an extension.\n\nThese can be either virtual machines\nor vApps.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postExtensionManagerMoIdQueryManagedBy" }, "task": true }, { "name": "postExtensionManagerMoIdRegisterExtension", "summary": "Registers extension.", "description": "Registers extension.\n\n***Required privileges:*** Extension.Register", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postExtensionManagerMoIdRegisterExtension" }, "task": true }, { "name": "postExtensionManagerMoIdSetExtensionCertificate", "summary": "Update the stored authentication certificate for a specified extension.", "description": "Update the stored authentication certificate for a specified extension.\n\nUpdates the registration of the specified extension with the\nthumbprint of the X.509 client certificate provided over SSL handshake,\nor by the "certificatePem"argument. The thumbprint\nwill be used to authenticate the extension during invocations of\n*SessionManager.LoginExtensionByCertificate*.\n\nNOTE: No verification is performed on the received certificate, such as\nexpiry or revocation.\n\nThis method will unset any...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postExtensionManagerMoIdSetExtensionCertificate" }, "task": true }, { "name": "postExtensionManagerMoIdSetPublicKey", "summary": "Sets extension's public key.", "description": "Deprecated as of VI 4.0, use trusted certificates and\n*SessionManager.LoginExtensionBySubjectName* or\n*ExtensionManager.SetExtensionCertificate* and\n*SessionManager.LoginExtensionByCertificate*.\n\nSets extension's public key.\n\nThis method will unset any subject name or\ncertificate associated with the extension.\n\n***Required privileges:*** Extension.Update", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postExtensionManagerMoIdSetPublicKey" }, "task": true }, { "name": "postExtensionManagerMoIdSetServiceAccount", "summary": "Update the stored authentication service account for the specified extension.", "description": "Update the stored authentication service account for the specified extension.\n\nUpdates the registration of the specified extension with the\nservice account passed in the "serviceAccount"parameter.\nThe service account will be used to authenticate the extension\nby invoking vCenter Server Login APIs and the user session can be\nused to update an Extension's data.\n\nThis method will unset the previous service account name\nassociated with the extension.\n\nThe account name must be passed in wit...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postExtensionManagerMoIdSetServiceAccount" }, "task": true }, { "name": "postExtensionManagerMoIdUnregisterExtension", "summary": "Unregisters the specified extension if it exists.", "description": "Unregisters the specified extension if it exists.\n\n***Required privileges:*** Extension.Unregister", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postExtensionManagerMoIdUnregisterExtension" }, "task": true }, { "name": "postExtensionManagerMoIdUpdateExtension", "summary": "If the key specified in the extension exists,\nthe existing record is updated.", "description": "If the key specified in the extension exists,\nthe existing record is updated.\n\nIf the "subjectName" property of the Extension\nobject has a value, and it is different from the existing\nvalue, this method will unset any public key or\ncertificate associated with the extension.\n\n***Required privileges:*** Extension.Update", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postExtensionManagerMoIdUpdateExtension" }, "task": true }, { "name": "getExtensionManagerMoIdExtensionList", "summary": "The list of currently registered extensions.", "description": "The list of currently registered extensions.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getExtensionManagerMoIdExtensionList" }, "task": true }, { "name": "postFailoverClusterConfiguratorMoIdConfigureVchaTask", "summary": "Configure VCHA on the local vCenter Server.", "description": "Configure VCHA on the local vCenter Server.\n\nThis operation configures the VC appliance with VCHA specific inputs\nand uses already deployed Passive and Witness nodes to set up the\nVCHA cluster. After configuration, the VCHA Cluster is enabled\non a best effort basis, but if this operation does not succeed,\n*FailoverClusterManager.setClusterMode_Task* must be called\nto enable it. State replication or failover is not allowed\nuntil the VCHA Cluster is enabled. The current vCenter Server\ncontinues to...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postFailoverClusterConfiguratorMoIdConfigureVchaTask" }, "task": true }, { "name": "postFailoverClusterConfiguratorMoIdCreatePassiveNodeTask", "summary": "Creates a Passive node in a degraded VCHA Cluster with node location\ninformation and pre-existing V", "description": "Creates a Passive node in a degraded VCHA Cluster with node location\ninformation and pre-existing VCHA Cluster configuration from the\nActive node.\n\n***Required privileges:*** Global.VCServer", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postFailoverClusterConfiguratorMoIdCreatePassiveNodeTask" }, "task": true }, { "name": "postFailoverClusterConfiguratorMoIdCreateWitnessNodeTask", "summary": "Creates a Witness node in a degraded VCHA Cluster with node location\ninformation and pre-existing V", "description": "Creates a Witness node in a degraded VCHA Cluster with node location\ninformation and pre-existing VCHA Cluster configuration from the\nActive node.\n\n***Required privileges:*** Global.VCServer", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postFailoverClusterConfiguratorMoIdCreateWitnessNodeTask" }, "task": true }, { "name": "postFailoverClusterConfiguratorMoIdDeployVchaTask", "summary": "Deploys and Configures VCHA on the local vCenter as a single API.", "description": "Deploys and Configures VCHA on the local vCenter as a single API.\n\nThis deployment operation automatically provisions and creates a\nPassive and a Witness node followed by configuring each node such that\na 3 node VCHA Cluster is formed. After configuration, the VCHA Cluster\nis enabled on a best effort basis, but if this operation does not\nsucceed, *FailoverClusterManager.setClusterMode_Task* must be\ncalled to enable it. State replication or failover is not allowed\nuntil the VCHA Cluster is enable...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postFailoverClusterConfiguratorMoIdDeployVchaTask" }, "task": true }, { "name": "postFailoverClusterConfiguratorMoIdDestroyVchaTask", "summary": "Destroys the VCHA cluster setup and removes all VCHA specific\nconfiguration from the VCVA appliance.", "description": "Destroys the VCHA cluster setup and removes all VCHA specific\nconfiguration from the VCVA appliance.\n\nThe active node in the cluster\ncontinues to run as a standalone VCVA appliance after the destroy\noperation has been performed.\nThis operation is allowed under the following circumstances:\n\\- VCHA cluster is disabled\n\\- The node is in an isolated state\n\\- VCHA Deploy/Configure has failed\n\n***Required privileges:*** Global.VCServer", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postFailoverClusterConfiguratorMoIdDestroyVchaTask" }, "task": true }, { "name": "postFailoverClusterConfiguratorMoIdGetVchaConfig", "summary": "Returns the configuration information for each node that is part of\nthe VCHA Cluster.", "description": "Returns the configuration information for each node that is part of\nthe VCHA Cluster.\n\n***Required privileges:*** System.Read", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postFailoverClusterConfiguratorMoIdGetVchaConfig" }, "task": true }, { "name": "postFailoverClusterConfiguratorMoIdPrepareVchaTask", "summary": "Prepares the vCenter appliance for a VCHA cluster deployment.", "description": "Prepares the vCenter appliance for a VCHA cluster deployment.\n\nThis preparation operation saves the network configuration of the cluster\nand configures the Active node to be cloned for a VCHA configuration.\nPrepares the VCHA Active node for ssh keys, vpostgres replication\nand related configuration file setup needed for a VCHA cluster.\nIf the Active node Cluster network adapter does not exist\nthe prepare operation will fail.\nNo changes will be made if the cluster is already configured.\n\n***Requir...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postFailoverClusterConfiguratorMoIdPrepareVchaTask" }, "task": true }, { "name": "getFailoverClusterConfiguratorMoIdDisabledConfigureMethod", "summary": "A list of method names that must not be called and will throw\na fault due to some other method runn", "description": "A list of method names that must not be called and will throw\na fault due to some other method running that the disabled method\ncan cause side-effects for.\n\nThis list may include the following methods:\n- *FailoverClusterConfigurator.deployVcha_Task*\n- *FailoverClusterConfigurator.configureVcha_Task*\n- *FailoverClusterConfigurator.createPassiveNode_Task*\n- *FailoverClusterConfigurator.createWitnessNode_Task*\n- *FailoverClusterConfigurator.destroyVcha_Task*\n\nAs with other disabled methods there ...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getFailoverClusterConfiguratorMoIdDisabledConfigureMethod" }, "task": true }, { "name": "postFailoverClusterManagerMoIdGetVchaClusterHealth", "summary": "Returns last known health of the VCHA Cluster.", "description": "Returns last known health of the VCHA Cluster.\n\n***Required privileges:*** System.Read", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postFailoverClusterManagerMoIdGetVchaClusterHealth" }, "task": true }, { "name": "postFailoverClusterManagerMoIdGetClusterMode", "summary": "Returns current mode of a VCHA Cluster.", "description": "Returns current mode of a VCHA Cluster.\n\n***Required privileges:*** System.Read", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postFailoverClusterManagerMoIdGetClusterMode" }, "task": true }, { "name": "postFailoverClusterManagerMoIdInitiateFailoverTask", "summary": "Allows a caller to initiate a failover from Active vCenter Server node\nto the Passive node.", "description": "Allows a caller to initiate a failover from Active vCenter Server node\nto the Passive node.\n\nBy default it is a forced failover. The planned\nflag can be used to initiate it as a planned failover.\nFor forced failover, Active node immediately initiates a failover. This\nmay result into a data loss after failover.\nFor planned failover, Active node flushes all the state to the\nPassive node, waits for the flush to complete before causing a failover.\nAfter the failover, Passive node starts without any ...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postFailoverClusterManagerMoIdInitiateFailoverTask" }, "task": true }, { "name": "postFailoverClusterManagerMoIdSetClusterModeTask", "summary": "setClusterMode method allows caller to manipulate the mode of a\nVCHA Cluster\nFollowing mode transit", "description": "setClusterMode method allows caller to manipulate the mode of a\nVCHA Cluster\nFollowing mode transitions are allowed -\nenabled -> disabled - Allowed only in healthy and degraded states.\n\nenabled -> maintenance - Allowed only in healthy state.\ndisabled -> enabled - Allowed only in healthy state.\nmaintenance -> enabled - Allowed only in healthy state with all nodes\nare running the same version.\nmaintenance -> disabled - Allowed only in healthy state with all nodes\nare running the sam...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postFailoverClusterManagerMoIdSetClusterModeTask" }, "task": true }, { "name": "getFailoverClusterManagerMoIdDisabledClusterMethod", "summary": "A list of method names that must not be called and will throw\na fault due to some other method runn", "description": "A list of method names that must not be called and will throw\na fault due to some other method running that the disabled method\ncan cause side-effects for.\n\nThis list may include the following methods:\n- *FailoverClusterManager.setClusterMode_Task*\n- *FailoverClusterManager.getClusterMode*\n- *FailoverClusterManager.initiateFailover_Task*\n- *FailoverClusterManager.GetVchaClusterHealth*\n\nGetClusterHealth will also be disabled if Deploy is in progress.\nAs with other disabled methods there will be...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getFailoverClusterManagerMoIdDisabledClusterMethod" }, "task": true }, { "name": "postFileManagerMoIdChangeOwner", "summary": "Change the owner for a file.", "description": "Change the owner for a file.\n\nThis method is currently not supported.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postFileManagerMoIdChangeOwner" }, "task": true }, { "name": "postFileManagerMoIdCopyDatastoreFileTask", "summary": "Copies the source file or folder to the destination.", "description": "Copies the source file or folder to the destination.\n\nIf the destination file does not exist, it is created.\nIf the destination file exists, the force parameter determines whether\nto overwrite it with the source or not.\nFolders can be copied recursively. In this case, the\ndestination, if it exists, must be a folder, else one will be created. Existing\nfiles on the destination that conflict with source files can be overwritten using\nthe force parameter. Files and disks are always copied in binary ...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postFileManagerMoIdCopyDatastoreFileTask" }, "task": true }, { "name": "postFileManagerMoIdDeleteDatastoreFileTask", "summary": "Deletes the specified file or folder from the datastore.", "description": "Deletes the specified file or folder from the datastore.\n\nIf a file of a virtual machine is deleted, it may corrupt that\nvirtual machine. Folder deletes are always recursive.\nThe datacenter parameter may be omitted if a URL is used to name\nthe file or folder.\n\nIf the source is an extent of a virtual disk, this operation treats the extent\nas a file.\n\nIt is important to note that this operation will provide transactional guarantees\nonly for a file. No guarantees are provided when deleting folders....(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postFileManagerMoIdDeleteDatastoreFileTask" }, "task": true }, { "name": "postFileManagerMoIdMakeDirectory", "summary": "Create a folder using the specified name.", "description": "Create a folder using the specified name.\n\nIf the parent\nor intermediate level folders do not exist, and the parameter\ncreateParentDirectories is false, a *FileNotFound* fault\nis thrown.\nIf the intermediate level folders do not exist, and the parameter\ncreateParentDirectories is true, all the non-existent folders\nare created.\n\nRequires Datastore.FileManagement privilege on the datastore.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postFileManagerMoIdMakeDirectory" }, "task": true }, { "name": "postFileManagerMoIdMoveDatastoreFileTask", "summary": "Moves the source file or folder to the destination.", "description": "Moves the source file or folder to the destination.\n\nIf the destination file does not exist, it is created.\nIf the destination file exists, the force parameter determines whether\nto overwrite it with the source or not.\nIf the source path is a folder, then the destination path must not exist; the\ndestination cannot be overwritten even with a force flag in that case. Folder\nmoves are recursive, treating all files and disks to move as binary.\n\nIf source (or destination) name is specified as a URL, ...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postFileManagerMoIdMoveDatastoreFileTask" }, "task": true }, { "name": "postFileManagerMoIdQueryFileLockInfo", "summary": "Fetches as much information as possible for the file path passed in.", "description": "Fetches as much information as possible for the file path passed in.\n\nThe main purpose of the API is to show caller any lock information\nthat can be queried from the host. The API gathers various information\ndepending on which file-system (VMFS/NFS/VSAN) the file is located on.\n\n***Since:*** vSphere API Release 8.0.2.0\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postFileManagerMoIdQueryFileLockInfo" }, "task": true }, { "name": "postFolderMoIdAddStandaloneHostTask", "summary": "Creates a new single-host compute resource.", "description": "Creates a new single-host compute resource.\n\nThe name provided can be an\nIP address, such as 192.168.0.120, or a string, such as esx120.\nIf a name is specified, a DNS lookup is used to resolve it to a fully-qualified\nname, such as esx120.vmware.com. If the DNS lookup fails, the string is\nstored as specified.\n\nLicenses for the host are allocated when making the first connection to\nthe host. This is because the license needed typically depends on the type\nof host and the number of CPUs.\n\nIn additi...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postFolderMoIdAddStandaloneHostTask" }, "task": true }, { "name": "postFolderMoIdBatchAddHostsToClusterTask", "summary": "Adds a set of new and existing hosts to the cluster.", "description": "Adds a set of new and existing hosts to the cluster.\n\nThis API is a composite API and performs the following tasks before hosts\nbecome part of the specified cluter -\n- Adds all new hosts as standalone hosts.\n- Move each host to the desired state.\n- Move each host to the cluster.\n\nThe dynamic privilege check will ensure that appropriate privileges\nare acquired to allow this API to perform multiple actions on hosts\nand cluster. Required privileges -\n- Host.Inventory.EditCluster on cluster\n- Host...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postFolderMoIdBatchAddHostsToClusterTask" }, "task": true }, { "name": "postFolderMoIdBatchAddStandaloneHostsTask", "summary": "Adds a list of hosts to inventory, as standalone hosts,\nin a single invocation.", "description": "Adds a list of hosts to inventory, as standalone hosts,\nin a single invocation.\n\nThe operation returns a result containing\na list of hosts that are successfully added.\n\nIn addition to the Host.Inventory.AddStandaloneHost privilege, the operation\nrequires System.View privilege on the VM folder that the VMs of the\nhost will be placed on.\n\n***Required privileges:*** Host.Inventory.AddStandaloneHost", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postFolderMoIdBatchAddStandaloneHostsTask" }, "task": true }, { "name": "postFolderMoIdCreateCluster", "summary": "Creates a new cluster compute resource in this folder.", "description": "Deprecated as of VI API 2.5, use *Folder.CreateClusterEx*.\n\nCreates a new cluster compute resource in this folder.\n\nAny % (percent) character used in this name parameter must be escaped, unless it\nis used to start an escape sequence. Clients may also escape any other characters\nin this name parameter.\n\n***Required privileges:*** Host.Inventory.CreateCluster", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postFolderMoIdCreateCluster" }, "task": true }, { "name": "postFolderMoIdCreateClusterEx", "summary": "Creates a new cluster compute resource in this folder.", "description": "Creates a new cluster compute resource in this folder.\n\nAny % (percent) character used in this name parameter must be escaped, unless it\nis used to start an escape sequence. Clients may also escape any other characters\nin this name parameter.\n\n***Required privileges:*** Host.Inventory.CreateCluster", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postFolderMoIdCreateClusterEx" }, "task": true }, { "name": "postFolderMoIdCreateDatacenter", "summary": "Creates a new datacenter with the given name.", "description": "Creates a new datacenter with the given name.\n\nAny % (percent) character used in this name parameter must be escaped, unless it\nis used to start an escape sequence. Clients may also escape any other characters\nin this name parameter.\n\n***Required privileges:*** Datacenter.Create", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postFolderMoIdCreateDatacenter" }, "task": true }, { "name": "postFolderMoIdCreateDVSTask", "summary": "Create a *DistributedVirtualSwitch* in the folder according to the\nspecified *DVSCreateSpec*.", "description": "Create a *DistributedVirtualSwitch* in the folder according to the\nspecified *DVSCreateSpec*.\n\nThe specified Folder\nmust be a Network entity folder.\n\n***Required privileges:*** DVSwitch.Create", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postFolderMoIdCreateDVSTask" }, "task": true }, { "name": "postFolderMoIdCreateFolder", "summary": "Creates a new sub-folder with the specified name.", "description": "Creates a new sub-folder with the specified name.\n\nThe *Folder.childType* property of the new folder is the same as\nthe *Folder.childType* property of the current folder.\n\n***Required privileges:*** Folder.Create", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postFolderMoIdCreateFolder" }, "task": true }, { "name": "postFolderMoIdCreateStoragePod", "summary": "Creates a new storage pod in this folder.", "description": "Creates a new storage pod in this folder.\n\nAny % (percent) character used in this name parameter must be escaped, unless it\nis used to start an escape sequence. Clients may also escape any other characters\nin this name parameter.\n\n***Required privileges:*** Folder.Create", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postFolderMoIdCreateStoragePod" }, "task": true }, { "name": "postFolderMoIdCreateVMTask", "summary": "Creates a new virtual machine in the current folder and attaches it to the\nspecified resource pool.", "description": "Creates a new virtual machine in the current folder and attaches it to the\nspecified resource pool.\n\nThis operation creates a virtual machine,\ninstead of cloning a virtual machine from an existing one.\n\nThe server does not support creating templates using this method.\nInstead, you should create templates by marking existing virtual\nmachines as templates, or by cloning an existing virtual machine or\ntemplate.\n\nThis operation only works if the folder's childType includes VirtualMachine.\nIn additio...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postFolderMoIdCreateVMTask" }, "task": true }, { "name": "postFolderMoIdDestroyTask", "summary": "Destroys this object, deleting its contents and removing it from its parent\nfolder (if any).", "description": "Destroys this object, deleting its contents and removing it from its parent\nfolder (if any).\n\nNOTE: The appropriate privilege must be held on the parent of the destroyed\nentity as well as the entity itself.\nThis method can throw one of several exceptions. The exact set of exceptions\ndepends on the kind of entity that is being removed. See comments for\neach entity for more information on destroy behavior.\n\n***Required privileges:*** Folder.Delete", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postFolderMoIdDestroyTask" }, "task": true }, { "name": "postFolderMoIdMoveIntoFolderTask", "summary": "Moves a set of managed entities into this folder.", "description": "Moves a set of managed entities into this folder.\n\nThis operation is typically used by clients when they implement a drag-and-drop\ninterface to move a set of objects into a folder.\n\nThis operation is transactional only with respect to each individual entity.\nThe set of entities is moved sequentially as specified in the list, and\ncommitted one at a time. If the *Folder.MoveIntoFolder_Task* method fails on an object, the\nmethod terminates at that point with an exception, leaving the rest of the\nma...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postFolderMoIdMoveIntoFolderTask" }, "task": true }, { "name": "postFolderMoIdRegisterVMTask", "summary": "Adds an existing virtual machine to the folder.", "description": "Adds an existing virtual machine to the folder.\n\nAny % (percent) character used in this name parameter must be escaped, unless it\nis used to start an escape sequence. Clients may also escape any other characters\nin this name parameter.\n\nThis operation only works if the folder's type is VirtualMachine.\nIn addition to the VirtualMachine.Inventory.Register and\nResource.AssignVMToPool privileges, it requires System.Read privilege\non the datastore that the existing virtual machine resides on. If the\n...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postFolderMoIdRegisterVMTask" }, "task": true }, { "name": "postFolderMoIdReload", "summary": "Reload the entity state.", "description": "Reload the entity state.\n\nClients only need to call this method\nif they changed some external state that affects the service\nwithout using the Web service interface to perform the change.\nFor example, hand-editing a virtual machine configuration file\naffects the configuration of the associated virtual machine but\nthe service managing the virtual machine might not monitor the\nfile for changes. In this case, after such an edit, a client\nwould call \"reload\" on the associated virtual machine to ensu...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postFolderMoIdReload" }, "task": true }, { "name": "postFolderMoIdRenameTask", "summary": "Renames this managed entity.", "description": "Renames this managed entity.\n\nAny % (percent) character used in this name parameter\nmust be escaped, unless it is used to start an escape\nsequence. Clients may also escape any other characters in\nthis name parameter.\n\nSee also *ManagedEntity.name*.\n\n***Required privileges:*** Folder.Rename", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postFolderMoIdRenameTask" }, "task": true }, { "name": "postFolderMoIdSetCustomValue", "summary": "Assigns a value to a custom field.", "description": "Assigns a value to a custom field.\n\nThe setCustomValue method requires\nwhichever updatePrivilege is defined as one of the\n*CustomFieldDef.fieldInstancePrivileges*\nfor the CustomFieldDef whose value is being changed.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postFolderMoIdSetCustomValue" }, "task": true }, { "name": "postFolderMoIdUnregisterAndDestroyTask", "summary": "Recursively unregisters all virtual machines and vApps, and destroys\nall child virtual machine fold", "description": "Recursively unregisters all virtual machines and vApps, and destroys\nall child virtual machine folders.\n\nThis is similar to the Destroy\\_Task method,\nbut this method calls UnregisterAndDestroy\\_Task on each virtual machine\nobject instead of calling Destroy\\_Task.\nThis operation applies only to VirtualMachine folders.\n\nUnregisterAndDestroy\\_Task is a recursive operation that destroys the specified\nvirtual machine folder, unregisters all child virtual machine objects, and destroys\nall child virtua...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postFolderMoIdUnregisterAndDestroyTask" }, "task": true }, { "name": "getFolderMoIdAlarmActionsEnabled", "summary": "Whether alarm actions are enabled for this entity.", "description": "Whether alarm actions are enabled for this entity.\n\nTrue if enabled; false otherwise.\n\n***Required privileges:*** System.Read", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getFolderMoIdAlarmActionsEnabled" }, "task": true }, { "name": "getFolderMoIdAvailableField", "summary": "List of custom field definitions that are valid for the object's type.", "description": "List of custom field definitions that are valid for the object's type.\n\nThe fields are sorted by *CustomFieldDef.name*.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getFolderMoIdAvailableField" }, "task": true }, { "name": "getFolderMoIdChildEntity", "summary": "An array of managed object references.", "description": "An array of managed object references.\n\nEach entry is a reference to a child entity.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getFolderMoIdChildEntity" }, "task": true }, { "name": "getFolderMoIdChildType", "summary": "Specifies the object types a folder may contain.", "description": "Specifies the object types a folder may contain.\n\nWhen you create a folder, it inherits its childType from the parent folder\nin which it is created. childType is an array of strings. Each array entry\nidentifies a set of object types - Folder and one or more managed object\ntypes. The following list shows childType values for the different folders:\n- { \"vim.Folder\", \"vim.Datacenter\" } - Identifies the root folder\n and its descendant folders. Data center folders can contain\n child data center fol...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getFolderMoIdChildType" }, "task": true }, { "name": "getFolderMoIdConfigIssue", "summary": "Current configuration issues that have been detected for this entity.", "description": "Current configuration issues that have been detected for this entity.\n\nTypically,\nthese issues have already been logged as events. The entity stores these\nevents as long as they are still current. The\n*configStatus* property provides an overall status\nbased on these events.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getFolderMoIdConfigIssue" }, "task": true }, { "name": "getFolderMoIdConfigStatus", "summary": "The configStatus indicates whether or not the system has detected a configuration\nissue involving t", "description": "The configStatus indicates whether or not the system has detected a configuration\nissue involving this entity.\n\nFor example, it might have detected a\nduplicate IP address or MAC address, or a host in a cluster\nmight be out of compliance. The meanings of the configStatus values are:\n- red: A problem has been detected involving the entity.\n- yellow: A problem is about to occur or a transient condition\n has occurred (For example, reconfigure fail-over policy).\n- green: No configuration issues have...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getFolderMoIdConfigStatus" }, "task": true }, { "name": "getFolderMoIdCustomValue", "summary": "Custom field values.", "description": "Custom field values.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getFolderMoIdCustomValue" }, "task": true }, { "name": "getFolderMoIdDeclaredAlarmState", "summary": "A set of alarm states for alarms that apply to this managed entity.", "description": "A set of alarm states for alarms that apply to this managed entity.\n\nThe set includes alarms defined on this entity\nand alarms inherited from the parent entity,\nor from any ancestors in the inventory hierarchy.\n\nAlarms are inherited if they can be triggered by this entity or its descendants.\nThis set does not include alarms that are defined on descendants of this entity.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getFolderMoIdDeclaredAlarmState" }, "task": true }, { "name": "getFolderMoIdDisabledMethod", "summary": "List of operations that are disabled, given the current runtime\nstate of the entity.", "description": "List of operations that are disabled, given the current runtime\nstate of the entity.\n\nFor example, a power-on operation always fails if a\nvirtual machine is already powered on. This list can be used by clients to\nenable or disable operations in a graphical user interface.\n\nNote: This list is determined by the current runtime state of an entity,\nnot by its permissions.\n\nThis list may include the following operations for a HostSystem:\n- *HostSystem.EnterMaintenanceMode_Task*\n- *HostSystem.ExitMain...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getFolderMoIdDisabledMethod" }, "task": true }, { "name": "getFolderMoIdEffectiveRole", "summary": "Access rights the current session has to this entity.", "description": "Access rights the current session has to this entity.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getFolderMoIdEffectiveRole" }, "task": true }, { "name": "getFolderMoIdName", "summary": "Name of this entity, unique relative to its parent.", "description": "Name of this entity, unique relative to its parent.\n\nAny / (slash), \\\\ (backslash), character used in this\nname element will be escaped. Similarly, any % (percent) character used in\nthis name element will be escaped, unless it is used to start an escape\nsequence. A slash is escaped as %2F or %2f. A backslash is escaped as %5C or\n%5c, and a percent is escaped as %25.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getFolderMoIdName" }, "task": true }, { "name": "getFolderMoIdNamespace", "summary": "The namespace with which the Folder is associated.", "description": "The namespace with which the Folder is associated.\n\nNamespace is a vAPI\nresource which divides cluster resources and allows administrators to\ngive Kubernetes environments to their development teams.\nThis property is set only at the time of creation and cannot change.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getFolderMoIdNamespace" }, "task": true }, { "name": "getFolderMoIdOverallStatus", "summary": "General health of this managed entity.", "description": "General health of this managed entity.\n\nThe overall status of the managed entity is computed as the worst status\namong its alarms and the configuration issues detected on the entity.\nThe status is reported as one of the following values:\n- red: The entity has alarms or configuration issues with a red status.\n- yellow: The entity does not have alarms or configuration issues with a\n red status, and has at least one with a yellow status.\n- green: The entity does not have alarms or configuration is...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getFolderMoIdOverallStatus" }, "task": true }, { "name": "getFolderMoIdParent", "summary": "Parent of this entity.", "description": "Parent of this entity.\n\nThis value is null for the root object and for\n*VirtualMachine* objects that are part of\na *VirtualApp*.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getFolderMoIdParent" }, "task": true }, { "name": "getFolderMoIdPermission", "summary": "List of permissions defined for this entity.", "description": "List of permissions defined for this entity.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getFolderMoIdPermission" }, "task": true }, { "name": "getFolderMoIdRecentTask", "summary": "The set of recent tasks operating on this managed entity.", "description": "The set of recent tasks operating on this managed entity.\n\nThis is a subset\nof *TaskManager.recentTask* belong to this entity. A task in this\nlist could be in one of the four states: pending, running, success or error.\n\nThis property can be used to deduce intermediate power states for\na virtual machine entity. For example, if the current powerState is \"poweredOn\"\nand there is a running task performing the \"suspend\" operation, then the virtual\nmachine's intermediate state might be described as \"s...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getFolderMoIdRecentTask" }, "task": true }, { "name": "getFolderMoIdTag", "summary": "The set of tags associated with this managed entity.", "description": "The set of tags associated with this managed entity.\n\nExperimental. Subject to change.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getFolderMoIdTag" }, "task": true }, { "name": "getFolderMoIdTriggeredAlarmState", "summary": "A set of alarm states for alarms triggered by this entity\nor by its descendants.", "description": "A set of alarm states for alarms triggered by this entity\nor by its descendants.\n\nTriggered alarms are propagated up the inventory hierarchy\nso that a user can readily tell when a descendant has triggered an alarm.\nIn releases after vSphere API 5.0, vSphere Servers might not\ngenerate property collector update notifications for this property.\nTo obtain the latest value of the property, you can use\nPropertyCollector methods RetrievePropertiesEx or WaitForUpdatesEx.\nIf you use the PropertyCollector...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getFolderMoIdTriggeredAlarmState" }, "task": true }, { "name": "getFolderMoIdValue", "summary": "List of custom field values.", "description": "List of custom field values.\n\nEach value uses a key to associate\nan instance of a *CustomFieldStringValue* with\na custom field definition.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getFolderMoIdValue" }, "task": true }, { "name": "postGuestAliasManagerMoIdAddGuestAlias", "summary": "Defines an alias for a guest account in a virtual machine.", "description": "Defines an alias for a guest account in a virtual machine.\n\nAfter the alias is defined, the ESXi Server will use the alias\nto authenticate guest operations requests.\n\nThis will add the given VMware SSO Server's certificate and a\nsubject to the alias store of the\nspecified user in the guest.\n\nIn order to add an alias to the guest, you must supply\nan existing valid credential. This can be any instance\nof *GuestAuthentication*, but must be valid for the\nspecified guest username.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postGuestAliasManagerMoIdAddGuestAlias" }, "task": true }, { "name": "postGuestAliasManagerMoIdListGuestAliases", "summary": "Lists the\n*GuestAliases*\nfor a specified user in the guest that can be used\nfor authentication of g", "description": "Lists the\n*GuestAliases*\nfor a specified user in the guest that can be used\nfor authentication of guest operations.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postGuestAliasManagerMoIdListGuestAliases" }, "task": true }, { "name": "postGuestAliasManagerMoIdListGuestMappedAliases", "summary": "Lists the\n*GuestMappedAliases*\nin the guest that can be used for\nauthentication of guest operations.", "description": "Lists the\n*GuestMappedAliases*\nin the guest that can be used for\nauthentication of guest operations.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postGuestAliasManagerMoIdListGuestMappedAliases" }, "task": true }, { "name": "postGuestAliasManagerMoIdRemoveGuestAlias", "summary": "Removes an alias from the guest so it can no longer be\nused for\nauthentication of guest operations.", "description": "Removes an alias from the guest so it can no longer be\nused for\nauthentication of guest operations.\n\nIt will also be removed\nfrom the mapped credentials.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postGuestAliasManagerMoIdRemoveGuestAlias" }, "task": true }, { "name": "postGuestAliasManagerMoIdRemoveGuestAliasByCert", "summary": "Removes a VMware SSO Server's certificate and all\nassociated aliases from the guest so it\ncan no lo", "description": "Removes a VMware SSO Server's certificate and all\nassociated aliases from the guest so it\ncan no longer be used for\nauthentication of guest operations.\n\nIt will also be removed\nfrom the global certificate-to-user mapping file in the guest.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postGuestAliasManagerMoIdRemoveGuestAliasByCert" }, "task": true }, { "name": "postGuestAuthManagerMoIdAcquireCredentialsInGuest", "summary": "Authenticates in the guest and returns a *GuestAuthentication* object\nwith the acquired credentials", "description": "Authenticates in the guest and returns a *GuestAuthentication* object\nwith the acquired credentials for use in subsequent guest operation calls.\n\nThis can be used to authenticate inside the guest and obtain a\n*GuestAuthentication* object for supported authentication types.\nThis operation is not needed for Name and Password Authentication. To use\nName and Password Authentication, see *NamePasswordAuthentication*.\nFor SSPI authentication, requestAuth should be of the type *SSPIAuthentication*.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postGuestAuthManagerMoIdAcquireCredentialsInGuest" }, "task": true }, { "name": "postGuestAuthManagerMoIdReleaseCredentialsInGuest", "summary": "Releases session data and resources associated with\na *GuestAuthentication* object returned by *Gue", "description": "Releases session data and resources associated with\na *GuestAuthentication* object returned by *GuestAuthManager.AcquireCredentialsInGuest*.\n\nThis frees any resources and session data associated with a\n*GuestAuthentication* object returned by *GuestAuthManager.AcquireCredentialsInGuest*.\nThe *GuestAuthentication* object can no longer be used to\nauthenticate in the guest once released. Currently this operation is only\nvalid for *TicketedSessionAuthentication* objects.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postGuestAuthManagerMoIdReleaseCredentialsInGuest" }, "task": true }, { "name": "postGuestAuthManagerMoIdValidateCredentialsInGuest", "summary": "Validates the *GuestAuthentication* credentials.", "description": "Validates the *GuestAuthentication* credentials.\n\nThis can be used to check the authentication data, or\nvalidate any authentication that has a timeout is still valid.\nIf the authentication is not valid, *GuestPermissionDenied*\nwill be thrown.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postGuestAuthManagerMoIdValidateCredentialsInGuest" }, "task": true }, { "name": "postGuestFileManagerMoIdChangeFileAttributesInGuest", "summary": "Changes the file attributes of a specified file inside the guest.", "description": "Changes the file attributes of a specified file inside the guest.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postGuestFileManagerMoIdChangeFileAttributesInGuest" }, "task": true }, { "name": "postGuestFileManagerMoIdCreateTemporaryDirectoryInGuest", "summary": "Creates a temporary directory.", "description": "Creates a temporary directory.\n\nCreates a new unique temporary directory for the user to use as needed.\nThe user is responsible for removing it when it is no longer needed.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postGuestFileManagerMoIdCreateTemporaryDirectoryInGuest" }, "task": true }, { "name": "postGuestFileManagerMoIdCreateTemporaryFileInGuest", "summary": "Creates a temporary file.", "description": "Creates a temporary file.\n\nCreates a new unique temporary file for the user to use as needed.\nThe user is responsible for removing it when it is no longer needed.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postGuestFileManagerMoIdCreateTemporaryFileInGuest" }, "task": true }, { "name": "postGuestFileManagerMoIdDeleteDirectoryInGuest", "summary": "Deletes a directory in the guest OS.", "description": "Deletes a directory in the guest OS.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postGuestFileManagerMoIdDeleteDirectoryInGuest" }, "task": true }, { "name": "postGuestFileManagerMoIdDeleteFileInGuest", "summary": "Deletes a file in the guest OS", "description": "Deletes a file in the guest OS", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postGuestFileManagerMoIdDeleteFileInGuest" }, "task": true }, { "name": "postGuestFileManagerMoIdInitiateFileTransferFromGuest", "summary": "Initiates an operation to transfer a file from the guest.", "description": "Initiates an operation to transfer a file from the guest.\n\nObtains a reference to\n*FileTransferInformation* object\nfor the file transfer operation. The information object contains a URL\nto the file inside the guest to be transferred to the client.\n\nSee *FileTransferInformation* for\ninformation on how to use the information object. If the power state\nof the Virtual Machine is changed when the file transfer is in progress,\nor the Virtual Machine is migrated,\nthen the transfer operation is aborte...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postGuestFileManagerMoIdInitiateFileTransferFromGuest" }, "task": true }, { "name": "postGuestFileManagerMoIdInitiateFileTransferToGuest", "summary": "Initiates an operation to transfer a file to the guest.", "description": "Initiates an operation to transfer a file to the guest.\n\nObtains a URL to the file inside the guest to be transferred from the\nclient. The user should send a HTTP PUT request specifying the file\ncontent in the body of the request. Multiple PUT request cannot be\nsent to the URL simultaneously. URL will be invalidated after a\nsuccessful PUT request is sent. If the power state of the Virtual\nMachine is changed when the file transfer is in progress, or\nthe Virtual Machine is migrated, then the\ntrans...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postGuestFileManagerMoIdInitiateFileTransferToGuest" }, "task": true }, { "name": "postGuestFileManagerMoIdListFilesInGuest", "summary": "Returns information about files or directories in the guest.", "description": "Returns information about files or directories in the guest.\n\nThe results could be extremely large, so to minimize the size\nof the return value for cases where a UI only needs to show\nthe first N results, the answer is batched. Files are returned in\nOS-specific (inode) order. If the directory is modified between\nqueries, missing or duplicate results can occur.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postGuestFileManagerMoIdListFilesInGuest" }, "task": true }, { "name": "postGuestFileManagerMoIdMakeDirectoryInGuest", "summary": "Creates a directory in the guest OS", "description": "Creates a directory in the guest OS", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postGuestFileManagerMoIdMakeDirectoryInGuest" }, "task": true }, { "name": "postGuestFileManagerMoIdMoveDirectoryInGuest", "summary": "Moves or renames a directory in the guest.", "description": "Moves or renames a directory in the guest.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postGuestFileManagerMoIdMoveDirectoryInGuest" }, "task": true }, { "name": "postGuestFileManagerMoIdMoveFileInGuest", "summary": "Renames a file in the guest.", "description": "Renames a file in the guest.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postGuestFileManagerMoIdMoveFileInGuest" }, "task": true }, { "name": "getGuestOperationsManagerMoIdAliasManager", "summary": "A managed object that provides methods to support single sign-on\nin the guest operating system.", "description": "A managed object that provides methods to support single sign-on\nin the guest operating system.\n\n***Required privileges:*** System.Anonymous", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getGuestOperationsManagerMoIdAliasManager" }, "task": true }, { "name": "getGuestOperationsManagerMoIdAuthManager", "summary": "A singleton managed object that provides methods for guest authentication\noperations.", "description": "A singleton managed object that provides methods for guest authentication\noperations.\n\n***Required privileges:*** System.Anonymous", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getGuestOperationsManagerMoIdAuthManager" }, "task": true }, { "name": "getGuestOperationsManagerMoIdFileManager", "summary": "A singleton managed object that provides methods for guest file\noperations.", "description": "A singleton managed object that provides methods for guest file\noperations.\n\n***Required privileges:*** System.Anonymous", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getGuestOperationsManagerMoIdFileManager" }, "task": true }, { "name": "getGuestOperationsManagerMoIdGuestWindowsRegistryManager", "summary": "A singleton managed object that provides methods for guest windows registry\noperations.", "description": "A singleton managed object that provides methods for guest windows registry\noperations.\n\n***Required privileges:*** System.Anonymous", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getGuestOperationsManagerMoIdGuestWindowsRegistryManager" }, "task": true }, { "name": "getGuestOperationsManagerMoIdProcessManager", "summary": "A singleton managed object that provides methods for guest process\noperations.", "description": "A singleton managed object that provides methods for guest process\noperations.\n\n***Required privileges:*** System.Anonymous", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getGuestOperationsManagerMoIdProcessManager" }, "task": true }, { "name": "postGuestProcessManagerMoIdListProcessesInGuest", "summary": "List the processes running in the guest operating system,\nplus those started by *GuestProcessManage", "description": "List the processes running in the guest operating system,\nplus those started by *GuestProcessManager.StartProgramInGuest*\nthat have recently completed.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postGuestProcessManagerMoIdListProcessesInGuest" }, "task": true }, { "name": "postGuestProcessManagerMoIdReadEnvironmentVariableInGuest", "summary": "Reads an environment variable from the guest OS", "description": "Reads an environment variable from the guest OS\n\nIf the authentication uses interactiveSession, then the\nenvironment being read will be that of the user logged into the desktop.\nOtherwise it's the environment of the user specified by the auth.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postGuestProcessManagerMoIdReadEnvironmentVariableInGuest" }, "task": true }, { "name": "postGuestProcessManagerMoIdStartProgramInGuest", "summary": "Starts a program in the guest operating system.", "description": "Starts a program in the guest operating system.\n\nA process started this way can have its status queried with\n*GuestProcessManager.ListProcessesInGuest*.\nWhen the process completes, its exit code and end time will be\navailable for 5 minutes after completion.\n\nIf VMware Tools is restarted, the exit code and end time will not\nbe available.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postGuestProcessManagerMoIdStartProgramInGuest" }, "task": true }, { "name": "postGuestProcessManagerMoIdTerminateProcessInGuest", "summary": "Terminates a process in the guest OS.", "description": "Terminates a process in the guest OS.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postGuestProcessManagerMoIdTerminateProcessInGuest" }, "task": true }, { "name": "postGuestWindowsRegistryManagerMoIdCreateRegistryKeyInGuest", "summary": "Create a registry key.", "description": "Create a registry key.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postGuestWindowsRegistryManagerMoIdCreateRegistryKeyInGuest" }, "task": true }, { "name": "postGuestWindowsRegistryManagerMoIdDeleteRegistryKeyInGuest", "summary": "Delete a registry key.", "description": "Delete a registry key.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postGuestWindowsRegistryManagerMoIdDeleteRegistryKeyInGuest" }, "task": true }, { "name": "postGuestWindowsRegistryManagerMoIdDeleteRegistryValueInGuest", "summary": "Delete a registry value.", "description": "Delete a registry value.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postGuestWindowsRegistryManagerMoIdDeleteRegistryValueInGuest" }, "task": true }, { "name": "postGuestWindowsRegistryManagerMoIdListRegistryKeysInGuest", "summary": "List all registry subkeys for a given registry key.", "description": "List all registry subkeys for a given registry key.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postGuestWindowsRegistryManagerMoIdListRegistryKeysInGuest" }, "task": true }, { "name": "postGuestWindowsRegistryManagerMoIdListRegistryValuesInGuest", "summary": "List all registry values for a given registry key.", "description": "List all registry values for a given registry key.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postGuestWindowsRegistryManagerMoIdListRegistryValuesInGuest" }, "task": true }, { "name": "postGuestWindowsRegistryManagerMoIdSetRegistryValueInGuest", "summary": "Set/Create a registry value.", "description": "Set/Create a registry value.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postGuestWindowsRegistryManagerMoIdSetRegistryValueInGuest" }, "task": true }, { "name": "postHealthUpdateManagerMoIdAddFilter", "summary": "Adds health update filters.", "description": "Adds health update filters.\n\n***Required privileges:*** Host.Inventory.EditCluster", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHealthUpdateManagerMoIdAddFilter" }, "task": true }, { "name": "postHealthUpdateManagerMoIdAddFilterEntities", "summary": "Add entities on which this filter is configured.", "description": "Add entities on which this filter is configured.\n\n***Required privileges:*** Host.Inventory.EditCluster", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHealthUpdateManagerMoIdAddFilterEntities" }, "task": true }, { "name": "postHealthUpdateManagerMoIdAddMonitoredEntities", "summary": "The provider monitors additional managed entities.", "description": "The provider monitors additional managed entities.\n\nA particular\nmanaged entity can be monitored by multiple providers.\n\n***Required privileges:*** HealthUpdateProvider.Update", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHealthUpdateManagerMoIdAddMonitoredEntities" }, "task": true }, { "name": "postHealthUpdateManagerMoIdHasMonitoredEntity", "summary": "Check if the managed entity is monitored by the provider.", "description": "Check if the managed entity is monitored by the provider.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHealthUpdateManagerMoIdHasMonitoredEntity" }, "task": true }, { "name": "postHealthUpdateManagerMoIdHasProvider", "summary": "Verifies if the given provider is registered.", "description": "Verifies if the given provider is registered.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHealthUpdateManagerMoIdHasProvider" }, "task": true }, { "name": "postHealthUpdateManagerMoIdPostHealthUpdates", "summary": "Report a change in health status.", "description": "Report a change in health status.\n\n***Required privileges:*** HealthUpdateProvider.Update", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHealthUpdateManagerMoIdPostHealthUpdates" }, "task": true }, { "name": "postHealthUpdateManagerMoIdQueryFilterEntities", "summary": "Returns the list of entities on which this filter is configured.", "description": "Returns the list of entities on which this filter is configured.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHealthUpdateManagerMoIdQueryFilterEntities" }, "task": true }, { "name": "postHealthUpdateManagerMoIdQueryFilterInfoIds", "summary": "Returns the list of HealthUpdateInfos configured for this filter.", "description": "Returns the list of HealthUpdateInfos configured for this filter.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHealthUpdateManagerMoIdQueryFilterInfoIds" }, "task": true }, { "name": "postHealthUpdateManagerMoIdQueryFilterList", "summary": "Returns the list of filters.", "description": "Returns the list of filters.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHealthUpdateManagerMoIdQueryFilterList" }, "task": true }, { "name": "postHealthUpdateManagerMoIdQueryFilterName", "summary": "Returns the filter name.", "description": "Returns the filter name.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHealthUpdateManagerMoIdQueryFilterName" }, "task": true }, { "name": "postHealthUpdateManagerMoIdQueryHealthUpdateInfos", "summary": "Returns the list of HealthUpdateInfo configured for the given provider.", "description": "Returns the list of HealthUpdateInfo configured for the given provider.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHealthUpdateManagerMoIdQueryHealthUpdateInfos" }, "task": true }, { "name": "postHealthUpdateManagerMoIdQueryHealthUpdates", "summary": "Returns the list of health updates reported by the given provider.", "description": "Returns the list of health updates reported by the given provider.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHealthUpdateManagerMoIdQueryHealthUpdates" }, "task": true }, { "name": "postHealthUpdateManagerMoIdQueryMonitoredEntities", "summary": "Returns the list of managed entities monitored by the given provider.", "description": "Returns the list of managed entities monitored by the given provider.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHealthUpdateManagerMoIdQueryMonitoredEntities" }, "task": true }, { "name": "postHealthUpdateManagerMoIdQueryProviderList", "summary": "The providers.", "description": "The providers.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postHealthUpdateManagerMoIdQueryProviderList" }, "task": true }, { "name": "postHealthUpdateManagerMoIdQueryProviderName", "summary": "Query the name of the provider.", "description": "Query the name of the provider.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHealthUpdateManagerMoIdQueryProviderName" }, "task": true }, { "name": "postHealthUpdateManagerMoIdQueryUnmonitoredHosts", "summary": "The set of hosts that are in the cluster, but not monitored by\nthe provider.", "description": "The set of hosts that are in the cluster, but not monitored by\nthe provider.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHealthUpdateManagerMoIdQueryUnmonitoredHosts" }, "task": true }, { "name": "postHealthUpdateManagerMoIdRegisterHealthUpdateProvider", "summary": "Registers provider.", "description": "Registers provider.\n\n***Required privileges:*** HealthUpdateProvider.Register", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHealthUpdateManagerMoIdRegisterHealthUpdateProvider" }, "task": true }, { "name": "postHealthUpdateManagerMoIdRemoveFilter", "summary": "Removes the specified filter.", "description": "Removes the specified filter.\n\n***Required privileges:*** Host.Inventory.EditCluster", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHealthUpdateManagerMoIdRemoveFilter" }, "task": true }, { "name": "postHealthUpdateManagerMoIdRemoveFilterEntities", "summary": "Remove entities on which this filter is configured.", "description": "Remove entities on which this filter is configured.\n\n***Required privileges:*** Host.Inventory.EditCluster", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHealthUpdateManagerMoIdRemoveFilterEntities" }, "task": true }, { "name": "postHealthUpdateManagerMoIdRemoveMonitoredEntities", "summary": "The provider monitors fewer managed entities.", "description": "The provider monitors fewer managed entities.\n\n***Required privileges:*** HealthUpdateProvider.Update", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHealthUpdateManagerMoIdRemoveMonitoredEntities" }, "task": true }, { "name": "postHealthUpdateManagerMoIdUnregisterHealthUpdateProvider", "summary": "Unregisters the specified provider, if it exists.", "description": "Unregisters the specified provider, if it exists.\n\nA VirtualCenter\nServer restart implicitly unregisters all providers.\n\n***Required privileges:*** HealthUpdateProvider.Unregister", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHealthUpdateManagerMoIdUnregisterHealthUpdateProvider" }, "task": true }, { "name": "postHistoryCollectorMoIdDestroyCollector", "summary": "Destroys this collector.", "description": "Destroys this collector.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postHistoryCollectorMoIdDestroyCollector" }, "task": true }, { "name": "postHistoryCollectorMoIdResetCollector", "summary": "Moves the \"scrollable view\" to the item immediately preceding the\n\"viewable latest page\".", "description": "Moves the \"scrollable view\" to the item immediately preceding the\n\"viewable latest page\".\n\nIf you use \"readPrev\",\n*ReadPreviousTasks* or\n*ReadPreviousEvents*,\nall items\nare retrieved from the newest item to the oldest item.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postHistoryCollectorMoIdResetCollector" }, "task": true }, { "name": "postHistoryCollectorMoIdRewindCollector", "summary": "Moves the \"scrollable view\" to the oldest item.", "description": "Moves the \"scrollable view\" to the oldest item.\n\nIf you use\n*ReadNextTasks* or\n*ReadNextEvents*,\nall items are retrieved from the oldest item to the newest item. This\nis the default setting when the collector is created.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postHistoryCollectorMoIdRewindCollector" }, "task": true }, { "name": "postHistoryCollectorMoIdSetCollectorPageSize", "summary": "Sets the \"viewable latest page\" size to contain at most the\nnumber of items specified by the maxCou", "description": "Sets the \"viewable latest page\" size to contain at most the\nnumber of items specified by the maxCount parameter).", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHistoryCollectorMoIdSetCollectorPageSize" }, "task": true }, { "name": "getHistoryCollectorMoIdFilter", "summary": "The filter used to create this collector.", "description": "The filter used to create this collector.\n\nThe type of the returned filter is determined by the managed object\nfor which the collector is created.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHistoryCollectorMoIdFilter" }, "task": true }, { "name": "postHostAccessManagerMoIdChangeAccessMode", "summary": "Update the access mode for a user or group.", "description": "Update the access mode for a user or group.\n\nIf the host is in lockdown mode, this operation is allowed only on\nusers in the exceptions list - see *HostAccessManager.QueryLockdownExceptions*,\nand trying to change the access mode of other users or groups\nwill fail with SecurityError.\n\n***Required privileges:*** Global.Settings", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostAccessManagerMoIdChangeAccessMode" }, "task": true }, { "name": "postHostAccessManagerMoIdChangeLockdownMode", "summary": "Changes the lockdown state of the ESXi host.", "description": "Changes the lockdown state of the ESXi host.\n\nThis operation will do nothing if the host is already in the desired\nlockdown state.\n\nWhen the host is in lockdown mode it can be managed only through vCenter\nand through DCUI (Direct Console User Interface) if the DCUI service is\nrunning.\nThis is achieved by removing all permissions on the host, except those\nof the exception users defined with *HostAccessManager.UpdateLockdownExceptions*.\n\nIn addition, the permissions for users 'dcui' and 'vpxuser'\n...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostAccessManagerMoIdChangeLockdownMode" }, "task": true }, { "name": "postHostAccessManagerMoIdQueryLockdownExceptions", "summary": "Get the list of users which are exceptions for lockdown mode.", "description": "Get the list of users which are exceptions for lockdown mode.\n\nSee *HostAccessManager.UpdateLockdownExceptions*.\n\n***Required privileges:*** Global.Settings", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postHostAccessManagerMoIdQueryLockdownExceptions" }, "task": true }, { "name": "postHostAccessManagerMoIdQuerySystemUsers", "summary": "Get the list of local system users.", "description": "Get the list of local system users.\n\nThese are special users like 'vpxuser' and 'dcui',\nwhich may be used for authenticating different sub-components of the\nvSphere system and may be essential for its correct functioning.\n\nUsually these users may not be used by human operators to connect\ndirectly to the host and the UI may choose to show them only in some\n\"advanced\" UI view.\n\n***Required privileges:*** Global.Settings", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postHostAccessManagerMoIdQuerySystemUsers" }, "task": true }, { "name": "postHostAccessManagerMoIdRetrieveHostAccessControlEntries", "summary": "Retrieve access entries.", "description": "Retrieve access entries.\n\nReturns a list of AccessEntry objects for each VIM user or group which\nhave explicitly assigned permissions on the host. This means that\n*accessNone* will not be present in the result.\n\n***Required privileges:*** Global.Settings", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postHostAccessManagerMoIdRetrieveHostAccessControlEntries" }, "task": true }, { "name": "postHostAccessManagerMoIdUpdateLockdownExceptions", "summary": "Update the list of users which are exceptions for lockdown mode.", "description": "Update the list of users which are exceptions for lockdown mode.\n\nUsually these are user accounts used by third party solutions and\nexternal applications which need to continue to function in lockdown\nmode. It is not advised to add user accounts used by human operators,\nbecause this will compromise the purpose of lockdown mode.\n\nBoth local and domain users are supported. The format for domain accounts\nis \"DOMAIN\\\\login\".\n\nWhen this API is called when the host is in lockdown mode,\nthe behaviour i...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostAccessManagerMoIdUpdateLockdownExceptions" }, "task": true }, { "name": "postHostAccessManagerMoIdUpdateSystemUsers", "summary": "Update the list of local system users.", "description": "Update the list of local system users.\n\nThe special users 'dcui' and 'vpxuser' need not be specified.\nThey are always reported in the list of system users.\n\n***Required privileges:*** Global.Settings", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostAccessManagerMoIdUpdateSystemUsers" }, "task": true }, { "name": "getHostAccessManagerMoIdLockdownMode", "summary": "Current lockdown state of the host.", "description": "Current lockdown state of the host.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostAccessManagerMoIdLockdownMode" }, "task": true }, { "name": "postHostActiveDirectoryAuthenticationMoIdDisableSmartCardAuthentication", "summary": "Disables console authentication using a local smart card and reader.", "description": "Deprecated as of vSphere API 8.0U3, and there is no replacement for it.\n\nDisables console authentication using a local smart card and reader.\n\n***Required privileges:*** Host.Config.AuthenticationStore", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postHostActiveDirectoryAuthenticationMoIdDisableSmartCardAuthentication" }, "task": true }, { "name": "postHostActiveDirectoryAuthenticationMoIdEnableSmartCardAuthentication", "summary": "Enables console authentication using a local smart card and reader.", "description": "Deprecated as of vSphere API 8.0U3, and there is no replacement for it.\n\nEnables console authentication using a local smart card and reader.\n\nTo take effect this feature requires an active domain membership to a\ndomain with users configured to authenticate using smart cards.\n\n***Required privileges:*** Host.Config.AuthenticationStore", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postHostActiveDirectoryAuthenticationMoIdEnableSmartCardAuthentication" }, "task": true }, { "name": "postHostActiveDirectoryAuthenticationMoIdImportCertificateForCAMTask", "summary": "Import the CAM server's certificate to the local store of vmwauth.", "description": "Import the CAM server's certificate to the local store of vmwauth.\n\nThe certificate should have already been uploaded to ESXi file system.\n\n***Required privileges:*** Host.Config.AuthenticationStore", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostActiveDirectoryAuthenticationMoIdImportCertificateForCAMTask" }, "task": true }, { "name": "postHostActiveDirectoryAuthenticationMoIdInstallSmartCardTrustAnchor", "summary": "Install a trust anchor certificate for smart card authentication.", "description": "Deprecated as of vSphere API 8.0U3, and there is no replacement for it.\n\nInstall a trust anchor certificate for smart card authentication.\n\n***Required privileges:*** Host.Config.AuthenticationStore", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostActiveDirectoryAuthenticationMoIdInstallSmartCardTrustAnchor" }, "task": true }, { "name": "postHostActiveDirectoryAuthenticationMoIdJoinDomainTask", "summary": "Adds the host to an Active Directory domain.", "description": "Adds the host to an Active Directory domain.\n\nIf the *HostAuthenticationStoreInfo*.*HostAuthenticationStoreInfo.enabled*\nproperty is True (accessed through the info property),\nthe host has joined a domain.\nThe vSphere API will throw the InvalidState fault if you try\nto add a host to a domain when the host has already joined a domain.\n\n***Required privileges:*** Host.Config.AuthenticationStore", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostActiveDirectoryAuthenticationMoIdJoinDomainTask" }, "task": true }, { "name": "postHostActiveDirectoryAuthenticationMoIdJoinDomainWithCAMTask", "summary": "Adds the host to an Active Directory domain through CAM service.", "description": "Adds the host to an Active Directory domain through CAM service.\n\nIf the *HostAuthenticationStoreInfo*.*HostAuthenticationStoreInfo.enabled*\nproperty is True (accessed through the info property),\nthe host has joined a domain.\nThe vSphere API will throw the InvalidState fault if you try\nto add a host to a domain when the host has already joined a domain.\n\n***Required privileges:*** Host.Config.AuthenticationStore", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostActiveDirectoryAuthenticationMoIdJoinDomainWithCAMTask" }, "task": true }, { "name": "postHostActiveDirectoryAuthenticationMoIdLeaveCurrentDomainTask", "summary": "Removes the host from the Active Directory domain to which it belongs.", "description": "Removes the host from the Active Directory domain to which it belongs.\n\n***Required privileges:*** Host.Config.AuthenticationStore", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostActiveDirectoryAuthenticationMoIdLeaveCurrentDomainTask" }, "task": true }, { "name": "postHostActiveDirectoryAuthenticationMoIdListSmartCardTrustAnchors", "summary": "Lists installed trust anchor certificates for smart card authentication.", "description": "Deprecated as of vSphere API 8.0U3, and there is no replacement for it.\n\nLists installed trust anchor certificates for smart card authentication.\n\n***Required privileges:*** Host.Config.AuthenticationStore", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postHostActiveDirectoryAuthenticationMoIdListSmartCardTrustAnchors" }, "task": true }, { "name": "postHostActiveDirectoryAuthenticationMoIdRemoveSmartCardTrustAnchor", "summary": "Remove a smart card trust anchor certificate from the system.", "description": "Deprecated please remove by fingerprint/digest instead.\n\nRemove a smart card trust anchor certificate from the system.\n\n***Required privileges:*** Host.Config.AuthenticationStore", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostActiveDirectoryAuthenticationMoIdRemoveSmartCardTrustAnchor" }, "task": true }, { "name": "postHostActiveDirectoryAuthenticationMoIdRemoveSmartCardTrustAnchorByFingerprint", "summary": "Remove a smart card trust anchor certificate from the system by\nfingerprint.", "description": "Deprecated as of vSphere API 8.0U3, and there is no replacement for it.\n\nRemove a smart card trust anchor certificate from the system by\nfingerprint.\n\n***Required privileges:*** Host.Config.AuthenticationStore", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostActiveDirectoryAuthenticationMoIdRemoveSmartCardTrustAnchorByFingerprint" }, "task": true }, { "name": "postHostActiveDirectoryAuthenticationMoIdReplaceSmartCardTrustAnchors", "summary": "Replace the trust anchor certificates for smart card authentication.", "description": "Deprecated as of vSphere API 8.0U3, and there is no replacement for it.\n\nReplace the trust anchor certificates for smart card authentication.\n\n***Required privileges:*** Host.Config.AuthenticationStore", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostActiveDirectoryAuthenticationMoIdReplaceSmartCardTrustAnchors" }, "task": true }, { "name": "getHostActiveDirectoryAuthenticationMoIdInfo", "summary": "Information about the authentication store.", "description": "Information about the authentication store.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostActiveDirectoryAuthenticationMoIdInfo" }, "task": true }, { "name": "postHostAssignableHardwareManagerMoIdDownloadDescriptionTree", "summary": "Download Assignable Hardware description tree.", "description": "Download Assignable Hardware description tree.\n\nThe size of the downloaded description tree is dependent on the\ntype and number of assignable devices found on the host. As a\nrough estimate, each device might require approximate 256 bytes\nto represent.\nThe number of assignable devices on a host may vary from none to\n60 or more. A host with 3 SRIOV type devices consisting\nof a PF and 16 VFs would have a total of 51 devices and the\ndescription tree would be approximately 51 \\* 256 bytes = 13,056 by...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postHostAssignableHardwareManagerMoIdDownloadDescriptionTree" }, "task": true }, { "name": "postHostAssignableHardwareManagerMoIdRetrieveDynamicPassthroughInfo", "summary": "Retrieve PCI Dynamic Passthrough info.", "description": "Retrieve PCI Dynamic Passthrough info.\n\nReturns the list of PCI devices that may be used as a Dynamic\nDirectPath IO device.\n\n***Required privileges:*** System.Read", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postHostAssignableHardwareManagerMoIdRetrieveDynamicPassthroughInfo" }, "task": true }, { "name": "postHostAssignableHardwareManagerMoIdRetrieveVendorDeviceGroupInfo", "summary": "Retrieve VendorDeviceGroup info.", "description": "Retrieve VendorDeviceGroup info.\n\nReturns the list of Vendor Device Group deviceTypes present.\n\n***Since:*** vSphere API Release 8.0.0.1\n\n***Required privileges:*** System.Read", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postHostAssignableHardwareManagerMoIdRetrieveVendorDeviceGroupInfo" }, "task": true }, { "name": "postHostAssignableHardwareManagerMoIdUpdateAssignableHardwareConfig", "summary": "Update Assignable Hardware configuration.", "description": "Update Assignable Hardware configuration.\n\nEntries are updated as described in *HostAssignableHardwareConfig*.\n\n***Required privileges:*** Host.Config.Settings", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostAssignableHardwareManagerMoIdUpdateAssignableHardwareConfig" }, "task": true }, { "name": "getHostAssignableHardwareManagerMoIdBinding", "summary": "Assignable Hardware bindings", "description": "Assignable Hardware bindings\n\n***Required privileges:*** System.Read", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostAssignableHardwareManagerMoIdBinding" }, "task": true }, { "name": "getHostAssignableHardwareManagerMoIdConfig", "summary": "Assignable Hardware configuration", "description": "Assignable Hardware configuration\n\n***Required privileges:*** System.Read", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostAssignableHardwareManagerMoIdConfig" }, "task": true }, { "name": "getHostAuthenticationManagerMoIdInfo", "summary": "Information about Active Directory membership.", "description": "Information about Active Directory membership.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostAuthenticationManagerMoIdInfo" }, "task": true }, { "name": "getHostAuthenticationManagerMoIdSupportedStore", "summary": "An array that can contain managed object references to local and\nActive Directory authentication ma", "description": "An array that can contain managed object references to local and\nActive Directory authentication managed objects.\n\n supportedStore data implies a connection to a system\nthat stores information about accounts.\nThe supportedStore array can include the following objects:\n- *HostLocalAuthentication* - Local authentication refers\n to user accounts on the ESX host. Local authentication is always enabled.\n- *HostActiveDirectoryAuthentication* - Active Directory authentication\n refers to computer a...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostAuthenticationManagerMoIdSupportedStore" }, "task": true }, { "name": "getHostAuthenticationStoreMoIdInfo", "summary": "Information about the authentication store.", "description": "Information about the authentication store.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostAuthenticationStoreMoIdInfo" }, "task": true }, { "name": "postHostAutoStartManagerMoIdAutoStartPowerOff", "summary": "Powers-off virtual machines according to the current AutoStart configuration.", "description": "Powers-off virtual machines according to the current AutoStart configuration.\n\nSee the description of the (@link vim.host.AutoStartManager.AutoPowerInfo)\ndata object type for more information on Auto power-off behavior.\n\n***Required privileges:*** Host.Config.AutoStart", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postHostAutoStartManagerMoIdAutoStartPowerOff" }, "task": true }, { "name": "postHostAutoStartManagerMoIdAutoStartPowerOn", "summary": "Powers-on virtual machines according to the current AutoStart configuration.", "description": "Powers-on virtual machines according to the current AutoStart configuration.\n\nSee the description of the (@link vim.host.AutoStartManager.AutoPowerInfo)\ndata object type for more information on Auto power-on behavior.\n\n***Required privileges:*** Host.Config.AutoStart", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postHostAutoStartManagerMoIdAutoStartPowerOn" }, "task": true }, { "name": "postHostAutoStartManagerMoIdReconfigureAutostart", "summary": "Changes the power-on or power-off sequence and system defaults.", "description": "Changes the power-on or power-off sequence and system defaults.\n\nThe specification\nis an incremental change to the current configuration.\n\nIf systemDefaults are included, only values that are specified in the\nspecification are changed.\n\nFor the spec.powerInfo array, each element is interpreted as an incremental\nchange and the changes are processed sequentially. It is not an error to remove a\nnon-existing virtual machine. If both startAction and stopAction are set to\nnone, then the virtual machin...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostAutoStartManagerMoIdReconfigureAutostart" }, "task": true }, { "name": "getHostAutoStartManagerMoIdConfig", "summary": "HostAutoStartManager_getConfig", "description": "HostAutoStartManager_getConfig", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostAutoStartManagerMoIdConfig" }, "task": true }, { "name": "postHostBootDeviceSystemMoIdQueryBootDevices", "summary": "Retrieves a list of the available boot devices for the host system.", "description": "Retrieves a list of the available boot devices for the host system.\n\n***Required privileges:*** System.Read", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postHostBootDeviceSystemMoIdQueryBootDevices" }, "task": true }, { "name": "postHostBootDeviceSystemMoIdUpdateBootDevice", "summary": "Sets the current boot device for the host system.", "description": "Sets the current boot device for the host system.\n\n***Required privileges:*** Host.Config.Maintenance", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostBootDeviceSystemMoIdUpdateBootDevice" }, "task": true }, { "name": "postHostCacheConfigurationManagerMoIdConfigureHostCacheTask", "summary": "Configure host cache/swap performance enhancement.", "description": "Configure host cache/swap performance enhancement.\n\n***Required privileges:*** Host.Config.AdvancedConfig", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostCacheConfigurationManagerMoIdConfigureHostCacheTask" }, "task": true }, { "name": "getHostCacheConfigurationManagerMoIdCacheConfigurationInfo", "summary": "The swap performance configuration for the ESX host.", "description": "The swap performance configuration for the ESX host.\n\nThis includes\nconfiguration information for each datastore enabled for this purpose.\n\n***Required privileges:*** Host.Config.AdvancedConfig", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostCacheConfigurationManagerMoIdCacheConfigurationInfo" }, "task": true }, { "name": "postHostCertificateManagerMoIdGenerateCertificateSigningRequest", "summary": "Requests the server to generate a certificate-signing\nrequest (CSR) for itself.", "description": "Requests the server to generate a certificate-signing\nrequest (CSR) for itself.\n\nThe CSR is then typically\nprovided to a Certificate Authority to sign and issue\nthe SSL certificate for the server. Use *HostCertificateManager.InstallServerCertificate*\nto install this certificate.\n\n***Required privileges:*** Certificate.Manage", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostCertificateManagerMoIdGenerateCertificateSigningRequest" }, "task": true }, { "name": "postHostCertificateManagerMoIdGenerateCertificateSigningRequestByDn", "summary": "Requests the server to generate a certificate-signing\nrequest (CSR) for itself.", "description": "Requests the server to generate a certificate-signing\nrequest (CSR) for itself.\n\nAlternative version similar to *HostCertificateManager.GenerateCertificateSigningRequest*\nbut takes a Distinguished Name (DN) as a parameter.\n\n***Required privileges:*** Certificate.Manage", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostCertificateManagerMoIdGenerateCertificateSigningRequestByDn" }, "task": true }, { "name": "postHostCertificateManagerMoIdInstallServerCertificate", "summary": "Installs a given SSL certificate on the server.", "description": "Installs a given SSL certificate on the server.\n\nThe private key must have been previously generated by *HostCertificateManager.GenerateCertificateSigningRequest* or provided\nby *HostCertificateManager.ProvisionServerPrivateKey*.\n\n***Required privileges:*** Certificate.Manage", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostCertificateManagerMoIdInstallServerCertificate" }, "task": true }, { "name": "postHostCertificateManagerMoIdListCACertificateRevocationLists", "summary": "Fetches the SSL CRLs of Certificate Authorities that are trusted.", "description": "Fetches the SSL CRLs of Certificate Authorities that are trusted.\n\n***Required privileges:*** Certificate.Manage", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postHostCertificateManagerMoIdListCACertificateRevocationLists" }, "task": true }, { "name": "postHostCertificateManagerMoIdListCACertificates", "summary": "Fetches the SSL certificates of Certificate Authorities\nthat are trusted.", "description": "Fetches the SSL certificates of Certificate Authorities\nthat are trusted.\n\n***Required privileges:*** Certificate.Manage", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postHostCertificateManagerMoIdListCACertificates" }, "task": true }, { "name": "postHostCertificateManagerMoIdNotifyAffectedServices", "summary": "Instructs the host services affected by SSL credential changes\nby *HostCertificateManager.InstallSe", "description": "Instructs the host services affected by SSL credential changes\nby *HostCertificateManager.InstallServerCertificate*\nor *HostCertificateManager.ReplaceCACertificatesAndCRLs*\nto take into account said changes now.\n\nPlease note, that\nold SSL connections typically survive the transition and continue using\nold SSL credentials. New SSL connections will use the new SSL credentials.\n\n***Required privileges:*** Certificate.Manage", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostCertificateManagerMoIdNotifyAffectedServices" }, "task": true }, { "name": "postHostCertificateManagerMoIdProvisionServerPrivateKey", "summary": "Provisions a given SSL private key on the server for use with a subsequent\nSSL certificate installa", "description": "Provisions a given SSL private key on the server for use with a subsequent\nSSL certificate installation.\n\nThe recommended way to update the server private key is via *HostCertificateManager.GenerateCertificateSigningRequest*, which\nensures that the key never leaves the host.\n\nThe current method is intended for use only in environments that\nhave special requirements on how their private keys are generated.\n\n***Since:*** vSphere API Release 8.0.3.0\n\n***Required privileges:*** Certificate.Manage", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostCertificateManagerMoIdProvisionServerPrivateKey" }, "task": true }, { "name": "postHostCertificateManagerMoIdReplaceCACertificatesAndCRLs", "summary": "Replaces the trusted Certificate Authority (CA)\ncertificates and Certification Revocation List (CRL", "description": "Replaces the trusted Certificate Authority (CA)\ncertificates and Certification Revocation List (CRL)\nused by the server with the provided values.\n\nThese determine whether the server can verify\nthe identity of an external entity.\n\n***Required privileges:*** Certificate.Manage", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostCertificateManagerMoIdReplaceCACertificatesAndCRLs" }, "task": true }, { "name": "postHostCertificateManagerMoIdRetrieveCertificateInfoList", "summary": "the CertificateInfos of all known Certificates on\nthe host", "description": "the CertificateInfos of all known Certificates on\nthe host\n\n***Since:*** vSphere API Release 8.0.1.0\n\n***Required privileges:*** Certificate.Manage", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postHostCertificateManagerMoIdRetrieveCertificateInfoList" }, "task": true }, { "name": "getHostCertificateManagerMoIdCertificateInfo", "summary": "the CertificateInfo of the Host Certificate.", "description": "the CertificateInfo of the Host Certificate.\n\n***Required privileges:*** Certificate.Manage", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostCertificateManagerMoIdCertificateInfo" }, "task": true }, { "name": "postHostCpuSchedulerSystemMoIdDisableHyperThreading", "summary": "Don't treat hyperthreads as schedulable resources the next time the CPU\nscheduler starts.", "description": "Don't treat hyperthreads as schedulable resources the next time the CPU\nscheduler starts.\n\nIf successful, this operation will change the\nconfigured setting.\n\n***Required privileges:*** Host.Config.HyperThreading", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postHostCpuSchedulerSystemMoIdDisableHyperThreading" }, "task": true }, { "name": "postHostCpuSchedulerSystemMoIdEnableHyperThreading", "summary": "Treat hyperthreads as schedulable resources the next time the CPU\nscheduler starts.", "description": "Treat hyperthreads as schedulable resources the next time the CPU\nscheduler starts.\n\nIf successful, this operation will set the\n*config*\nproperty to \"true\".\n\n***Required privileges:*** Host.Config.HyperThreading", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postHostCpuSchedulerSystemMoIdEnableHyperThreading" }, "task": true }, { "name": "postHostCpuSchedulerSystemMoIdSetCustomValue", "summary": "Assigns a value to a custom field.", "description": "Assigns a value to a custom field.\n\nThe setCustomValue method requires\nwhichever updatePrivilege is defined as one of the\n*CustomFieldDef.fieldInstancePrivileges*\nfor the CustomFieldDef whose value is being changed.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostCpuSchedulerSystemMoIdSetCustomValue" }, "task": true }, { "name": "getHostCpuSchedulerSystemMoIdAvailableField", "summary": "List of custom field definitions that are valid for the object's type.", "description": "List of custom field definitions that are valid for the object's type.\n\nThe fields are sorted by *CustomFieldDef.name*.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostCpuSchedulerSystemMoIdAvailableField" }, "task": true }, { "name": "getHostCpuSchedulerSystemMoIdCpuSchedulerInfo", "summary": "Information about the current CPU scheduler of the host.", "description": "Information about the current CPU scheduler of the host.\n\nPopulates *HostCpuSchedulerInfo.policy* with the active *CPU Scheduling Policy*.\n\n***Since:*** vSphere API Release 8.0.3.0", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostCpuSchedulerSystemMoIdCpuSchedulerInfo" }, "task": true }, { "name": "getHostCpuSchedulerSystemMoIdHyperthreadInfo", "summary": "The hyperthread configuration for the CpuSchedulerSystem.", "description": "The hyperthread configuration for the CpuSchedulerSystem.\n\nThe\nexistence of this data object type indicates if the CPU scheduler\nis capable of scheduling hyperthreads as resources.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostCpuSchedulerSystemMoIdHyperthreadInfo" }, "task": true }, { "name": "getHostCpuSchedulerSystemMoIdValue", "summary": "List of custom field values.", "description": "List of custom field values.\n\nEach value uses a key to associate\nan instance of a *CustomFieldStringValue* with\na custom field definition.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostCpuSchedulerSystemMoIdValue" }, "task": true }, { "name": "postHostDatastoreBrowserMoIdDeleteFile", "summary": "Deletes the specified files from the datastore.", "description": "Deprecated as of VI API 2.5, use *FileManager.DeleteDatastoreFile_Task*.\n\nDeletes the specified files from the datastore.\n\nIf a valid virtual disk file is\nspecified, then all the components of the virtual disk are deleted.\n\n***Required privileges:*** Datastore.DeleteFile", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostDatastoreBrowserMoIdDeleteFile" }, "task": true }, { "name": "postHostDatastoreBrowserMoIdSearchDatastoreTask", "summary": "Returns the information for the files that match the given search criteria as a\nSearchResults objec", "description": "Returns the information for the files that match the given search criteria as a\nSearchResults object.\n\nSearches only the folder specified by the datastore path.\nThe Datastore.Browse privilege must be held on the datastore identified\nby the datastore path.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostDatastoreBrowserMoIdSearchDatastoreTask" }, "task": true }, { "name": "postHostDatastoreBrowserMoIdSearchDatastoreSubFoldersTask", "summary": "Returns the information for the files that match the given search criteria as a\nSearchResults\\[\\] o", "description": "Returns the information for the files that match the given search criteria as a\nSearchResults\\[\\] object.\n\nSearches the folder specified by the datastore path and\nall subfolders. The Datastore.Browse privilege must be held on the\ndatastore identified by the datastore path.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostDatastoreBrowserMoIdSearchDatastoreSubFoldersTask" }, "task": true }, { "name": "getHostDatastoreBrowserMoIdDatastore", "summary": "Set of datastores that can be searched on this DatastoreBrowser.", "description": "Set of datastores that can be searched on this DatastoreBrowser.\n\nThe list of datastores available to browse on this DatastoreBrowser is contextual\ninformation that depends on the object being browsed. If the host is being\nbrowsed, the host's datastores are used. If the Datacenter is being browsed, the\nDatacenter's list of datastores is used.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostDatastoreBrowserMoIdDatastore" }, "task": true }, { "name": "getHostDatastoreBrowserMoIdSupportedType", "summary": "The list of supported file types.", "description": "The list of supported file types.\n\nThe supported file types are represented as\nitems in this list. For each supported file type, there is an object in the list\nwhose dynamic type is one of the types derived from the\n*FileQuery* data object\ntype. In general, the properties in this query type are not set.\n\nUse the Query of the desired file type in the SearchSpec.query to indicate the\ndesired file types.\n\nThis property is used by clients to determine what kinds of file types are\nsupported. Clients ...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostDatastoreBrowserMoIdSupportedType" }, "task": true }, { "name": "postHostDatastoreSystemMoIdConfigureDatastorePrincipal", "summary": "Configures datastore principal user for the host.", "description": "Configures datastore principal user for the host.\n\nAll virtual machine-related file I/O is performed under\nthis user. Configuring datastore principal user\nwill result in all virtual machine files (configuration, disk,\nand so on) being checked for proper access. If necessary, ownership\nand permissions are modified. Note that in some environments,\nfile ownership and permissions modification may not be possible.\nFor example, virtual machine files stored on NFS cannot be\nmodified for ownership and p...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostDatastoreSystemMoIdConfigureDatastorePrincipal" }, "task": true }, { "name": "postHostDatastoreSystemMoIdCreateLocalDatastore", "summary": "Creates a new local datastore.", "description": "Creates a new local datastore.\n\n***Required privileges:*** Host.Config.Storage", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostDatastoreSystemMoIdCreateLocalDatastore" }, "task": true }, { "name": "postHostDatastoreSystemMoIdCreateNasDatastore", "summary": "Creates a new network-attached storage datastore.", "description": "Creates a new network-attached storage datastore.\n\n***Required privileges:*** Host.Config.Storage", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostDatastoreSystemMoIdCreateNasDatastore" }, "task": true }, { "name": "postHostDatastoreSystemMoIdCreateVmfsDatastore", "summary": "Creates a new VMFS datastore.", "description": "Creates a new VMFS datastore.\n\n***Required privileges:*** Host.Config.Storage", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostDatastoreSystemMoIdCreateVmfsDatastore" }, "task": true }, { "name": "postHostDatastoreSystemMoIdCreateVvolDatastore", "summary": "Create a Virtual-Volume based datastore", "description": "Create a Virtual-Volume based datastore\n\n***Required privileges:*** Host.Config.Storage", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostDatastoreSystemMoIdCreateVvolDatastore" }, "task": true }, { "name": "postHostDatastoreSystemMoIdDisableClusteredVmdkSupport", "summary": "Disable the clustered vmdk support on specified datastore.", "description": "Disable the clustered vmdk support on specified datastore.\n\nThis API will fail if there are running VMs on the datastore\nwhich are configured to use clustered VMDK feature.\n\n***Required privileges:*** Host.Config.Storage", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostDatastoreSystemMoIdDisableClusteredVmdkSupport" }, "task": true }, { "name": "postHostDatastoreSystemMoIdEnableClusteredVmdkSupport", "summary": "Enable the clustered vmdk support on specified datastore.", "description": "Enable the clustered vmdk support on specified datastore.\n\n***Required privileges:*** Host.Config.Storage", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostDatastoreSystemMoIdEnableClusteredVmdkSupport" }, "task": true }, { "name": "postHostDatastoreSystemMoIdExpandVmfsDatastore", "summary": "Increases the capacity of an existing VMFS datastore by expanding\n(increasing the size of) an exist", "description": "Increases the capacity of an existing VMFS datastore by expanding\n(increasing the size of) an existing extent of the datastore.\n\n***Required privileges:*** Host.Config.Storage", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostDatastoreSystemMoIdExpandVmfsDatastore" }, "task": true }, { "name": "postHostDatastoreSystemMoIdExtendVmfsDatastore", "summary": "Increases the capacity of an existing VMFS datastore by adding new\nextents to the datastore.", "description": "Increases the capacity of an existing VMFS datastore by adding new\nextents to the datastore.\n\n***Required privileges:*** Host.Config.Storage", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostDatastoreSystemMoIdExtendVmfsDatastore" }, "task": true }, { "name": "postHostDatastoreSystemMoIdQueryAvailableDisksForVmfs", "summary": "Query to list disks that can be used to contain VMFS datastore extents.", "description": "Query to list disks that can be used to contain VMFS datastore extents.\n\nIf the optional parameter name is supplied, queries for disks that can be\nused to contain extents for a VMFS datastore identified by the supplied\nname. Otherwise, the method retrieves disks that can be used to contain\nnew VMFS datastores.\n\nThis operation will filter out disks that are currently in use by an\nexisting VMFS unless the VMFS using the disk is one being extended.\nIt will also filter out management LUNs and disks ...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostDatastoreSystemMoIdQueryAvailableDisksForVmfs" }, "task": true }, { "name": "postHostDatastoreSystemMoIdQueryMaxQueueDepth", "summary": "Query max queue depth for a specified NFS datastore.", "description": "Query max queue depth for a specified NFS datastore.\n\n***Since:*** vSphere API Release 8.0.0.1\n\n***Required privileges:*** Host.Config.Storage", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostDatastoreSystemMoIdQueryMaxQueueDepth" }, "task": true }, { "name": "postHostDatastoreSystemMoIdQueryUnresolvedVmfsVolumes", "summary": "Get the list of unbound VMFS volumes.", "description": "Get the list of unbound VMFS volumes.\n\nFor sharing a volume across hosts, a VMFS volume is bound to its\nunderlying block device storage. When a low level block copy is\nperformed to copy or move the VMFS volume, the copied volume will\nbe unbound.\n\n***Required privileges:*** System.Read", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postHostDatastoreSystemMoIdQueryUnresolvedVmfsVolumes" }, "task": true }, { "name": "postHostDatastoreSystemMoIdQueryVmfsDatastoreCreateOptions", "summary": "Queries options for creating a new VMFS datastore for a disk.", "description": "Queries options for creating a new VMFS datastore for a disk.\n\nSee also *HostScsiDisk.devicePath*.\n\n***Required privileges:*** Host.Config.Storage", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostDatastoreSystemMoIdQueryVmfsDatastoreCreateOptions" }, "task": true }, { "name": "postHostDatastoreSystemMoIdQueryVmfsDatastoreExpandOptions", "summary": "Queries for options for increasing the capacity of an existing VMFS\ndatastore by expanding (increas", "description": "Queries for options for increasing the capacity of an existing VMFS\ndatastore by expanding (increasing the size of) an existing extent of\nthe datastore.\n\n***Required privileges:*** Host.Config.Storage", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostDatastoreSystemMoIdQueryVmfsDatastoreExpandOptions" }, "task": true }, { "name": "postHostDatastoreSystemMoIdQueryVmfsDatastoreExtendOptions", "summary": "Queries for options for increasing the capacity of an existing VMFS\ndatastore by adding new extents", "description": "Queries for options for increasing the capacity of an existing VMFS\ndatastore by adding new extents using space from the specified disk.\n\nSee also *HostScsiDisk.devicePath*.\n\n***Required privileges:*** Host.Config.Storage", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostDatastoreSystemMoIdQueryVmfsDatastoreExtendOptions" }, "task": true }, { "name": "postHostDatastoreSystemMoIdRemoveDatastore", "summary": "Removes a datastore from a host.", "description": "Removes a datastore from a host.\n\n***Required privileges:*** Host.Config.Storage", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostDatastoreSystemMoIdRemoveDatastore" }, "task": true }, { "name": "postHostDatastoreSystemMoIdRemoveDatastoreExTask", "summary": "Remove one or more datastores.", "description": "Remove one or more datastores.\n\nThis is an asynchronous, batch operation of\nremoveDatastore. Please see *HostDatastoreSystem.RemoveDatastore*\nfor operational details.\nNote: This API currently supports removal of only NFS datastores.\n\n***Required privileges:*** Host.Config.Storage", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostDatastoreSystemMoIdRemoveDatastoreExTask" }, "task": true }, { "name": "postHostDatastoreSystemMoIdResignatureUnresolvedVmfsVolumeTask", "summary": "Resignature an unbound VMFS volume.", "description": "Resignature an unbound VMFS volume.\n\nTo safely enable sharing of the volume across hosts, a VMFS volume\nis bound to its underlying block device storage. When a low level\nblock copy is performed to copy or move the VMFS volume, the copied\nvolume will be unbound. In order for the VMFS volume to be usable,\na resolution operation is needed to determine whether the VMFS volume\nshould be treated as a new volume or not and what extents compose\nthat volume in the event there is more than one unbound vol...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostDatastoreSystemMoIdResignatureUnresolvedVmfsVolumeTask" }, "task": true }, { "name": "postHostDatastoreSystemMoIdSetMaxQueueDepth", "summary": "Set max queue depth for a specified NFS datastore.", "description": "Set max queue depth for a specified NFS datastore.\n\n***Since:*** vSphere API Release 8.0.0.1\n\n***Required privileges:*** Host.Config.Storage", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostDatastoreSystemMoIdSetMaxQueueDepth" }, "task": true }, { "name": "postHostDatastoreSystemMoIdUpdateLocalSwapDatastore", "summary": "Choose the\n*localSwapDatastore*\nfor this host.", "description": "Choose the\n*localSwapDatastore*\nfor this host.\n\nAny change to this setting will affect virtual machines\nthat subsequently power on or resume from a suspended state at this host,\nor that migrate to this host while powered on; virtual machines that are\ncurrently powered on at this host will not yet be affected.\n\n***Required privileges:*** Host.Config.Storage", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostDatastoreSystemMoIdUpdateLocalSwapDatastore" }, "task": true }, { "name": "getHostDatastoreSystemMoIdCapabilities", "summary": "Capability vector indicating the available product features.", "description": "Capability vector indicating the available product features.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostDatastoreSystemMoIdCapabilities" }, "task": true }, { "name": "getHostDatastoreSystemMoIdDatastore", "summary": "List of datastores on this host.", "description": "List of datastores on this host.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostDatastoreSystemMoIdDatastore" }, "task": true }, { "name": "postHostDateTimeSystemMoIdQueryAvailableTimeZones", "summary": "Retrieves the list of available timezones on the host.", "description": "Retrieves the list of available timezones on the host.\n\nThe API works off the public domain 'tz' timezone database.\n\n***Required privileges:*** System.Read", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postHostDateTimeSystemMoIdQueryAvailableTimeZones" }, "task": true }, { "name": "postHostDateTimeSystemMoIdQueryDateTime", "summary": "Get the current DateTime on the host.", "description": "Get the current DateTime on the host.\n\n***Required privileges:*** System.Read", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postHostDateTimeSystemMoIdQueryDateTime" }, "task": true }, { "name": "postHostDateTimeSystemMoIdRefreshDateTimeSystem", "summary": "Refresh the DateTime related settings to pick up any changes that might\nhave occurred.", "description": "Refresh the DateTime related settings to pick up any changes that might\nhave occurred.\n\n***Required privileges:*** Host.Config.DateTime", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postHostDateTimeSystemMoIdRefreshDateTimeSystem" }, "task": true }, { "name": "postHostDateTimeSystemMoIdTestTimeService", "summary": "Run a test to validate current time service configuration is functioning\nnormally.", "description": "Run a test to validate current time service configuration is functioning\nnormally.\n\nThe report will provide a localized diagnostic of any issues.\nOnly one diagnostic test may be running at a time.\n\n***Since:*** vSphere API Release 7.0.3.0\n\n***Required privileges:*** Host.Config.DateTime", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postHostDateTimeSystemMoIdTestTimeService" }, "task": true }, { "name": "postHostDateTimeSystemMoIdUpdateDateTimeConfig", "summary": "Update the DateTime configuration of the host.", "description": "Update the DateTime configuration of the host.\n\n***Required privileges:*** Host.Config.DateTime", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostDateTimeSystemMoIdUpdateDateTimeConfig" }, "task": true }, { "name": "postHostDateTimeSystemMoIdUpdateDateTime", "summary": "Update the date/time on the host.", "description": "Update the date/time on the host.\n\nThis method should be used with caution since network delays, execution\ndelays can result in time skews.\n\n***Required privileges:*** Host.Config.DateTime", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostDateTimeSystemMoIdUpdateDateTime" }, "task": true }, { "name": "getHostDateTimeSystemMoIdDateTimeInfo", "summary": "The DateTime configuration of the host.", "description": "The DateTime configuration of the host.\n\n***Required privileges:*** System.Read", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostDateTimeSystemMoIdDateTimeInfo" }, "task": true }, { "name": "postHostDiagnosticSystemMoIdCreateDiagnosticPartition", "summary": "Creates a diagnostic partition according to the provided create\nspecification.", "description": "Creates a diagnostic partition according to the provided create\nspecification.\n\nOn success, this method will create the partition\nand make the partition the active diagnostic partition if specified.\nOn failure, the diagnostic partition may exist but may not be active\nif the partition was supposed to be made active.\n\n***Required privileges:*** Host.Config.Storage", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostDiagnosticSystemMoIdCreateDiagnosticPartition" }, "task": true }, { "name": "postHostDiagnosticSystemMoIdQueryAvailablePartition", "summary": "Retrieves a list of available diagnostic partitions.", "description": "Retrieves a list of available diagnostic partitions.\n\nThe server will\nprovide the list in order of preference. In general, local diagnostic\npartitions are better than shared diagnostic partitions because of\nthe impossibility of multiple servers sharing the same partition. The\nmost preferred diagnostic partition will be first in the array.\n\n***Required privileges:*** Host.Config.Storage", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postHostDiagnosticSystemMoIdQueryAvailablePartition" }, "task": true }, { "name": "postHostDiagnosticSystemMoIdQueryPartitionCreateDesc", "summary": "For a disk, query for the diagnostic partition creation description.", "description": "For a disk, query for the diagnostic partition creation description.\n\nThe description details how the diagnostic partition will be created\non the disk and provides a creation specification that is needed to\ninvoke the create operation.\n\nSee also *HostScsiDisk*, *ScsiLun.uuid*.\n\n***Required privileges:*** Host.Config.Storage", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostDiagnosticSystemMoIdQueryPartitionCreateDesc" }, "task": true }, { "name": "postHostDiagnosticSystemMoIdQueryPartitionCreateOptions", "summary": "Retrieves a list of disks that can be used to contain a diagnostic\npartition.", "description": "Retrieves a list of disks that can be used to contain a diagnostic\npartition.\n\nThis list will contain disks that have sufficient space\nto contain a diagnostic partition of the specific type.\n\nThe choices will be returned in the order that is most preferable\nas determined by the system.\n\n***Required privileges:*** Host.Config.Storage", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostDiagnosticSystemMoIdQueryPartitionCreateOptions" }, "task": true }, { "name": "postHostDiagnosticSystemMoIdSelectActivePartition", "summary": "Changes the active diagnostic partition to a different partition.", "description": "Changes the active diagnostic partition to a different partition.\n\nSetting a NULL partition will result in unsetting the diagnostic\npartition.\n\n***Required privileges:*** Host.Config.Storage", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostDiagnosticSystemMoIdSelectActivePartition" }, "task": true }, { "name": "getHostDiagnosticSystemMoIdActivePartition", "summary": "The currently active diagnostic partition.", "description": "The currently active diagnostic partition.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostDiagnosticSystemMoIdActivePartition" }, "task": true }, { "name": "getHostDirectoryStoreMoIdInfo", "summary": "Information about the authentication store.", "description": "Information about the authentication store.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostDirectoryStoreMoIdInfo" }, "task": true }, { "name": "postHostEsxAgentHostManagerMoIdEsxAgentHostManagerUpdateConfig", "summary": "Update the host's ESX agent configuration.", "description": "Update the host's ESX agent configuration.\n\nThe entire configuration must be set each time since all values are\noverwritten. E.g. a field set to null clears the value on the host.\n\n***Required privileges:*** Host.Config.Settings", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostEsxAgentHostManagerMoIdEsxAgentHostManagerUpdateConfig" }, "task": true }, { "name": "getHostEsxAgentHostManagerMoIdConfigInfo", "summary": "Configuration of agent virtual machine resources", "description": "Configuration of agent virtual machine resources\n\n***Required privileges:*** Host.Config.Settings", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostEsxAgentHostManagerMoIdConfigInfo" }, "task": true }, { "name": "postHostFirewallSystemMoIdDisableRuleset", "summary": "Blocks the firewall ports belonging to the specified ruleset.", "description": "Blocks the firewall ports belonging to the specified ruleset.\n\nIf the ruleset has a managed service with a policy of 'auto'\nand all other rulesets used by the service are blocked, stops\nthe service.\n\n***Required privileges:*** Host.Config.NetService", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostFirewallSystemMoIdDisableRuleset" }, "task": true }, { "name": "postHostFirewallSystemMoIdEnableRuleset", "summary": "Opens the firewall ports belonging to the specified ruleset.", "description": "Opens the firewall ports belonging to the specified ruleset.\n\nIf the ruleset has a managed service with a policy of 'auto'\nthat is not running, starts the service.\n\n***Required privileges:*** Host.Config.NetService", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostFirewallSystemMoIdEnableRuleset" }, "task": true }, { "name": "postHostFirewallSystemMoIdRefreshFirewall", "summary": "Refresh the firewall information and settings to pick up any changes\nmade directly on the host.", "description": "Refresh the firewall information and settings to pick up any changes\nmade directly on the host.\n\n***Required privileges:*** Host.Config.NetService", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postHostFirewallSystemMoIdRefreshFirewall" }, "task": true }, { "name": "postHostFirewallSystemMoIdSetCustomValue", "summary": "Assigns a value to a custom field.", "description": "Assigns a value to a custom field.\n\nThe setCustomValue method requires\nwhichever updatePrivilege is defined as one of the\n*CustomFieldDef.fieldInstancePrivileges*\nfor the CustomFieldDef whose value is being changed.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostFirewallSystemMoIdSetCustomValue" }, "task": true }, { "name": "postHostFirewallSystemMoIdUpdateDefaultPolicy", "summary": "Updates the default firewall policy; unset fields are left unchanged.", "description": "Updates the default firewall policy; unset fields are left unchanged.\n\n***Required privileges:*** Host.Config.NetService", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostFirewallSystemMoIdUpdateDefaultPolicy" }, "task": true }, { "name": "postHostFirewallSystemMoIdUpdateRuleset", "summary": "Update the firewall ruleset specification.", "description": "Update the firewall ruleset specification.\n\n***Required privileges:*** Host.Config.NetService", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostFirewallSystemMoIdUpdateRuleset" }, "task": true }, { "name": "getHostFirewallSystemMoIdAvailableField", "summary": "List of custom field definitions that are valid for the object's type.", "description": "List of custom field definitions that are valid for the object's type.\n\nThe fields are sorted by *CustomFieldDef.name*.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostFirewallSystemMoIdAvailableField" }, "task": true }, { "name": "getHostFirewallSystemMoIdFirewallInfo", "summary": "Firewall configuration.", "description": "Firewall configuration.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostFirewallSystemMoIdFirewallInfo" }, "task": true }, { "name": "getHostFirewallSystemMoIdValue", "summary": "List of custom field values.", "description": "List of custom field values.\n\nEach value uses a key to associate\nan instance of a *CustomFieldStringValue* with\na custom field definition.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostFirewallSystemMoIdValue" }, "task": true }, { "name": "postHostFirmwareSystemMoIdBackupFirmwareConfiguration", "summary": "Backup the configuration of the host.", "description": "Backup the configuration of the host.\n\nThe method generates a bundle containing the host configuration.\nYou can use an HTTP GET operation to download the bundle from the returned URL.\n\n***Required privileges:*** Host.Config.Firmware", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postHostFirmwareSystemMoIdBackupFirmwareConfiguration" }, "task": true }, { "name": "postHostFirmwareSystemMoIdQueryFirmwareConfigUploadURL", "summary": "Return the URL on the host to which the configuration bundle must be\nuploaded for a restore operati", "description": "Return the URL on the host to which the configuration bundle must be\nuploaded for a restore operation.\n\nSee *HostFirmwareSystem.RestoreFirmwareConfiguration*.\n\n***Required privileges:*** Host.Config.Firmware", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postHostFirmwareSystemMoIdQueryFirmwareConfigUploadURL" }, "task": true }, { "name": "postHostFirmwareSystemMoIdResetFirmwareToFactoryDefaults", "summary": "Reset the configuration to factory defaults.", "description": "Reset the configuration to factory defaults.\n\nThis method will reset all configuration options, including the \"admin\"\npassword, to the factory defaults. The host will be rebooted immediately.\nThe host needs to be in maintenance mode before this operation can be\nperformed.\n\n***Required privileges:*** Host.Config.Firmware", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postHostFirmwareSystemMoIdResetFirmwareToFactoryDefaults" }, "task": true }, { "name": "postHostFirmwareSystemMoIdRestoreFirmwareConfiguration", "summary": "Restore the configuration of the host to that specified in the bundle.", "description": "Restore the configuration of the host to that specified in the bundle.\n\nUpload the bundle to the URL returned by the\n*HostFirmwareSystem.QueryFirmwareConfigUploadURL* method.\nThe *HostFirmwareSystem.RestoreFirmwareConfiguration* method\nwill restore all configuration options,\nincluding the \"admin\" password, to the values in the bundle.\nThe host will be rebooted immediately.\nThe host must be in maintenance mode before this operation can be\nperformed.\n\n***Required privileges:*** Host.Config.Firmwar...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostFirmwareSystemMoIdRestoreFirmwareConfiguration" }, "task": true }, { "name": "postHostGraphicsManagerMoIdIsSharedGraphicsActive", "summary": "Indicate if shared graphics device is active on the host.", "description": "Indicate if shared graphics device is active on the host.\n\n***Required privileges:*** System.Read", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postHostGraphicsManagerMoIdIsSharedGraphicsActive" }, "task": true }, { "name": "postHostGraphicsManagerMoIdRefreshGraphicsManager", "summary": "Refresh the available graphics information.", "description": "Refresh the available graphics information.\n\n***Required privileges:*** Host.Config.Settings", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postHostGraphicsManagerMoIdRefreshGraphicsManager" }, "task": true }, { "name": "postHostGraphicsManagerMoIdRetrieveVgpuDeviceInfo", "summary": "***Since:*** vSphere API Release 7.0.3.0\n\n***Required privileges:*** System.Read", "description": "***Since:*** vSphere API Release 7.0.3.0\n\n***Required privileges:*** System.Read", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postHostGraphicsManagerMoIdRetrieveVgpuDeviceInfo" }, "task": true }, { "name": "postHostGraphicsManagerMoIdRetrieveVgpuProfileInfo", "summary": "***Since:*** vSphere API Release 7.0.3.0\n\n***Required privileges:*** System.Read", "description": "***Since:*** vSphere API Release 7.0.3.0\n\n***Required privileges:*** System.Read", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postHostGraphicsManagerMoIdRetrieveVgpuProfileInfo" }, "task": true }, { "name": "postHostGraphicsManagerMoIdSetCustomValue", "summary": "Assigns a value to a custom field.", "description": "Assigns a value to a custom field.\n\nThe setCustomValue method requires\nwhichever updatePrivilege is defined as one of the\n*CustomFieldDef.fieldInstancePrivileges*\nfor the CustomFieldDef whose value is being changed.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostGraphicsManagerMoIdSetCustomValue" }, "task": true }, { "name": "postHostGraphicsManagerMoIdUpdateGraphicsConfig", "summary": "Update graphics configuration", "description": "Update graphics configuration\n\n***Required privileges:*** Host.Config.Settings", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostGraphicsManagerMoIdUpdateGraphicsConfig" }, "task": true }, { "name": "getHostGraphicsManagerMoIdAvailableField", "summary": "List of custom field definitions that are valid for the object's type.", "description": "List of custom field definitions that are valid for the object's type.\n\nThe fields are sorted by *CustomFieldDef.name*.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostGraphicsManagerMoIdAvailableField" }, "task": true }, { "name": "getHostGraphicsManagerMoIdGraphicsConfig", "summary": "Graphics Configuration", "description": "Graphics Configuration\n\n***Required privileges:*** System.Read", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostGraphicsManagerMoIdGraphicsConfig" }, "task": true }, { "name": "getHostGraphicsManagerMoIdGraphicsInfo", "summary": "Array of graphics information", "description": "Array of graphics information\n\n***Required privileges:*** System.Read", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostGraphicsManagerMoIdGraphicsInfo" }, "task": true }, { "name": "getHostGraphicsManagerMoIdSharedGpuCapabilities", "summary": "Array of shared passthru GPU capablities.", "description": "Array of shared passthru GPU capablities.\n\nSee also *HostSharedGpuCapabilities*.\n\n***Required privileges:*** System.Read", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostGraphicsManagerMoIdSharedGpuCapabilities" }, "task": true }, { "name": "getHostGraphicsManagerMoIdSharedPassthruGpuTypes", "summary": "Array of shared passthru GPU types.", "description": "Array of shared passthru GPU types.\n\nThese GPU types may be enabled\nwhen specific host hardware is present. Example values are \"grid\\_k120q\"\nand \"grid\\_k240q\".\n\n***Required privileges:*** System.Read", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostGraphicsManagerMoIdSharedPassthruGpuTypes" }, "task": true }, { "name": "getHostGraphicsManagerMoIdValue", "summary": "List of custom field values.", "description": "List of custom field values.\n\nEach value uses a key to associate\nan instance of a *CustomFieldStringValue* with\na custom field definition.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostGraphicsManagerMoIdValue" }, "task": true }, { "name": "postHostHealthStatusSystemMoIdFetchSystemEventLog", "summary": "Hardware System Event Log (SEL) information", "description": "Hardware System Event Log (SEL) information\n\n***Required privileges:*** Host.Config.Settings", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postHostHealthStatusSystemMoIdFetchSystemEventLog" }, "task": true }, { "name": "postHostHealthStatusSystemMoIdClearSystemEventLog", "summary": "Clear the the IPMI System Event Log.", "description": "Clear the the IPMI System Event Log.\n\n***Required privileges:*** Host.Config.Settings", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postHostHealthStatusSystemMoIdClearSystemEventLog" }, "task": true }, { "name": "postHostHealthStatusSystemMoIdRefreshHealthStatusSystem", "summary": "Refresh the available runtime hardware health information.", "description": "Refresh the available runtime hardware health information.\n\n***Required privileges:*** System.Read", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postHostHealthStatusSystemMoIdRefreshHealthStatusSystem" }, "task": true }, { "name": "postHostHealthStatusSystemMoIdResetSystemHealthInfo", "summary": "Resets the state of the sensors of the IPMI subsystem.", "description": "Resets the state of the sensors of the IPMI subsystem.\n\nOn certain types\nof hardware IPMI sensor states latch onto unhealthy states and will stay\nin an unhealth state until the sensor state is reset. This method will\nexplicitly reset the sensors state.\n\n***Required privileges:*** Host.Config.Settings", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postHostHealthStatusSystemMoIdResetSystemHealthInfo" }, "task": true }, { "name": "getHostHealthStatusSystemMoIdRuntime", "summary": "HostHealthStatusSystem_getRuntime", "description": "HostHealthStatusSystem_getRuntime", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostHealthStatusSystemMoIdRuntime" }, "task": true }, { "name": "postHostImageConfigManagerMoIdFetchSoftwarePackages", "summary": "Reports the set of software packages installed.", "description": "Reports the set of software packages installed.\n\nThe\nCLI command is: esxcli software vib get\n\n***Required privileges:*** Host.Config.Image", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postHostImageConfigManagerMoIdFetchSoftwarePackages" }, "task": true }, { "name": "postHostImageConfigManagerMoIdInstallDate", "summary": "Reports the UTC time stamp when this system was first installed.", "description": "Reports the UTC time stamp when this system was first installed.\n\nThe\nCLI command is: esxcli system stats installtime get\n\n***Required privileges:*** Host.Config.Image", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postHostImageConfigManagerMoIdInstallDate" }, "task": true }, { "name": "postHostImageConfigManagerMoIdHostImageConfigGetAcceptance", "summary": "Queries the current host acceptance level setting.", "description": "Queries the current host acceptance level setting.\n\nSee also *HostImageAcceptanceLevel_enum*If this has not been configured yet, then a default value will be\nreturned..\n\n***Required privileges:*** System.Read", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postHostImageConfigManagerMoIdHostImageConfigGetAcceptance" }, "task": true }, { "name": "postHostImageConfigManagerMoIdHostImageConfigGetProfile", "summary": "Queries the current host image profile information.", "description": "Queries the current host image profile information.\n\nSee also *HostImageProfileSummary*If there is no host image profile, then the value \"<Unknown>\" will\npopulate both name and vendor..\n\n***Required privileges:*** System.Read", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postHostImageConfigManagerMoIdHostImageConfigGetProfile" }, "task": true }, { "name": "postHostImageConfigManagerMoIdUpdateHostImageAcceptanceLevel", "summary": "Sets the acceptance level of the host image profile.", "description": "Sets the acceptance level of the host image profile.\n\nSee also *HostImageAcceptanceLevel_enum*.\n\n***Required privileges:*** Host.Config.Image", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostImageConfigManagerMoIdUpdateHostImageAcceptanceLevel" }, "task": true }, { "name": "postHostKernelModuleSystemMoIdQueryConfiguredModuleOptionString", "summary": "Query the options configured to be passed to the kernel module when loaded.", "description": "Query the options configured to be passed to the kernel module when loaded.\n\nNote that this is not necessarily the option string currently in use by\nthe kernel module.\n\n***Required privileges:*** Host.Config.Settings", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostKernelModuleSystemMoIdQueryConfiguredModuleOptionString" }, "task": true }, { "name": "postHostKernelModuleSystemMoIdQueryModules", "summary": "Query the set of modules on the host.", "description": "Query the set of modules on the host.\n\n***Required privileges:*** Host.Config.Settings", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postHostKernelModuleSystemMoIdQueryModules" }, "task": true }, { "name": "postHostKernelModuleSystemMoIdUpdateModuleOptionString", "summary": "Specifies the options to be passed to the kernel module when loaded.", "description": "Specifies the options to be passed to the kernel module when loaded.\n\n***Required privileges:*** Host.Config.Settings", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostKernelModuleSystemMoIdUpdateModuleOptionString" }, "task": true }, { "name": "postHostLocalAccountManagerMoIdAssignUserToGroup", "summary": "Assigns a user to a group.", "description": "Deprecated as of vSphere API 5.1, local user groups are not supported\nand group specific methods will throw NotSupported.\n\nAssigns a user to a group.\n\n***Required privileges:*** Host.Local.ManageUserGroups", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostLocalAccountManagerMoIdAssignUserToGroup" }, "task": true }, { "name": "postHostLocalAccountManagerMoIdChangePassword", "summary": "Updates the password of a local user account.", "description": "Updates the password of a local user account.\n\n***Required privileges:*** System.Anonymous", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostLocalAccountManagerMoIdChangePassword" }, "task": true }, { "name": "postHostLocalAccountManagerMoIdCreateGroup", "summary": "Creates a local group account using the parameters defined in the\n*HostLocalAccountManagerAccountSp", "description": "Deprecated as of vSphere API 5.1, local user groups are not supported\nand group specific methods will throw NotSupported.\n\nCreates a local group account using the parameters defined in the\n*HostLocalAccountManagerAccountSpecification*\ndata object type.\n\nFor POSIX hosts, passing the\n*HostLocalAccountManagerPosixAccountSpecification* data object\ntype allows you to control\nthe group ID format of the group account being created.\n\n***Required privileges:*** Host.Local.ManageUserGroups", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostLocalAccountManagerMoIdCreateGroup" }, "task": true }, { "name": "postHostLocalAccountManagerMoIdCreateUser", "summary": "Creates a local user account using the parameters defined in the\n*HostLocalAccountManagerAccountSpe", "description": "Creates a local user account using the parameters defined in the\n*HostLocalAccountManagerAccountSpecification*\ndata object type.\n\nFor POSIX hosts,\npassing *HostLocalAccountManagerPosixAccountSpecification* data object\ntype allows you to control the\nformat of the user ID of the user account being created.\n\n***Required privileges:*** Host.Local.ManageUserGroups", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostLocalAccountManagerMoIdCreateUser" }, "task": true }, { "name": "postHostLocalAccountManagerMoIdRemoveGroup", "summary": "Removes a local group account.", "description": "Deprecated as of vSphere API 5.1, local user groups are not supported\nand group specific methods will throw NotSupported.\n\nRemoves a local group account.\n\n***Required privileges:*** Host.Local.ManageUserGroups", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostLocalAccountManagerMoIdRemoveGroup" }, "task": true }, { "name": "postHostLocalAccountManagerMoIdRemoveUser", "summary": "Removes a local user account.", "description": "Removes a local user account.\n\nAs of vSphere API 5.1, this operation will first try to remove all\npermissions associated with the specified account. The permissions of\nthe user are removed one by one, not atomically, and the operation\nis not rolled back if the removal of some permission fails.\n\n***Required privileges:*** Host.Local.ManageUserGroups", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostLocalAccountManagerMoIdRemoveUser" }, "task": true }, { "name": "postHostLocalAccountManagerMoIdUnassignUserFromGroup", "summary": "Unassigns a user from a group.", "description": "Deprecated as of vSphere API 5.1, local user groups are not supported\nand group specific methods will throw NotSupported.\n\nUnassigns a user from a group.\n\n***Required privileges:*** Host.Local.ManageUserGroups", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostLocalAccountManagerMoIdUnassignUserFromGroup" }, "task": true }, { "name": "postHostLocalAccountManagerMoIdUpdateUser", "summary": "Updates a local user account using the parameters defined in the\n*HostLocalAccountManagerAccountSpe", "description": "Updates a local user account using the parameters defined in the\n*HostLocalAccountManagerAccountSpecification*\ndata object type.\n\n***Required privileges:*** Host.Local.ManageUserGroups", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostLocalAccountManagerMoIdUpdateUser" }, "task": true }, { "name": "getHostLocalAuthenticationMoIdInfo", "summary": "Information about the authentication store.", "description": "Information about the authentication store.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostLocalAuthenticationMoIdInfo" }, "task": true }, { "name": "postHostMemorySystemMoIdReconfigureServiceConsoleReservation", "summary": "Sets the configured service console memory reservation.", "description": "Sets the configured service console memory reservation.\n\nThis change\naffects only the serviceConsoleReservedCfg property. The\nconfiguration change\npropagates to the other properties after the next boot.\n\n***Required privileges:*** Host.Config.Memory", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostMemorySystemMoIdReconfigureServiceConsoleReservation" }, "task": true }, { "name": "postHostMemorySystemMoIdReconfigureVirtualMachineReservation", "summary": "Updates the virtual machine reservation information.", "description": "Updates the virtual machine reservation information.\n\n***Required privileges:*** Host.Config.Memory", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostMemorySystemMoIdReconfigureVirtualMachineReservation" }, "task": true }, { "name": "postHostMemorySystemMoIdSetCustomValue", "summary": "Assigns a value to a custom field.", "description": "Assigns a value to a custom field.\n\nThe setCustomValue method requires\nwhichever updatePrivilege is defined as one of the\n*CustomFieldDef.fieldInstancePrivileges*\nfor the CustomFieldDef whose value is being changed.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostMemorySystemMoIdSetCustomValue" }, "task": true }, { "name": "getHostMemorySystemMoIdAvailableField", "summary": "List of custom field definitions that are valid for the object's type.", "description": "List of custom field definitions that are valid for the object's type.\n\nThe fields are sorted by *CustomFieldDef.name*.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostMemorySystemMoIdAvailableField" }, "task": true }, { "name": "getHostMemorySystemMoIdConsoleReservationInfo", "summary": "Service console reservation information for the memory manager.", "description": "Service console reservation information for the memory manager.\n\nThe\nexistence of this data object indicates if the service console memory\nreservation must be configured for this host.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostMemorySystemMoIdConsoleReservationInfo" }, "task": true }, { "name": "getHostMemorySystemMoIdValue", "summary": "List of custom field values.", "description": "List of custom field values.\n\nEach value uses a key to associate\nan instance of a *CustomFieldStringValue* with\na custom field definition.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostMemorySystemMoIdValue" }, "task": true }, { "name": "getHostMemorySystemMoIdVirtualMachineReservationInfo", "summary": "Virtual machine reservation information for the memory manager.", "description": "Virtual machine reservation information for the memory manager.\n\nThe\nexistence of this data object indicates if the virtual machine memory\nreservation must be configured for this host.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostMemorySystemMoIdVirtualMachineReservationInfo" }, "task": true }, { "name": "postHostNetworkSystemMoIdAddPortGroup", "summary": "Adds a port group to the virtual switch.", "description": "Adds a port group to the virtual switch.\n\n***Required privileges:*** Host.Config.Network", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostNetworkSystemMoIdAddPortGroup" }, "task": true }, { "name": "postHostNetworkSystemMoIdAddServiceConsoleVirtualNic", "summary": "Adds a virtual service console network adapter.", "description": "Adds a virtual service console network adapter.\n\nReturns the device of the\nVirtualNic.\n\nIP configuration is required although it does not have to be enabled\nif the host is an ESX Server system.\nThe dynamic privilege check will ensure that users have Host.Config.Network\nprivilege on the host, and Network.Assign privilege on the connecting\nDVPortGroup, or DVS if connecting to a standalone DVPort.\nNetwork.Assign privilege is not required for operations on standard network\nor for operations performe...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostNetworkSystemMoIdAddServiceConsoleVirtualNic" }, "task": true }, { "name": "postHostNetworkSystemMoIdAddVirtualNic", "summary": "Adds a virtual host/VMkernel network adapter.", "description": "Adds a virtual host/VMkernel network adapter.\n\nReturns the device of the virtual\nnetwork adapter.\n\nIP configuration is required although it does not have to be enabled\nif the host is an ESX Server system.\nThe dynamic privilege check will ensure that users have Host.Config.Network\nprivilege on the host, and Network.Assign privilege on the connecting\nDVPortGroup, or DVS if connecting to a standalone DVPort.\nNetwork.Assign privilege is not required for operations on standard network\nor for operatio...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostNetworkSystemMoIdAddVirtualNic" }, "task": true }, { "name": "postHostNetworkSystemMoIdAddVirtualSwitch", "summary": "Adds a new virtual switch to the system with the given name.", "description": "Adds a new virtual switch to the system with the given name.\n\nThe\nname must be unique with respect to other virtual switches on the\nhost and is limited to 32 characters.\n\nSee also *HostNetworkSystem.UpdateVirtualSwitch*.\n\n***Required privileges:*** Host.Config.Network", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostNetworkSystemMoIdAddVirtualSwitch" }, "task": true }, { "name": "postHostNetworkSystemMoIdQueryNetworkHint", "summary": "Requests network hint information for a physical network adapter.", "description": "Requests network hint information for a physical network adapter.\n\nA network hint is\nsome information about the network to which the physical network\nadapter is attached. The method receives in a list of physical\nnetwork adapter devices and returns an equal number of hints\nif some devices are provided. If the list of devices is empty,\nthen the method accesses hints for all physical\nnetwork adapters.\n\nSee also *HostNetCapabilities.supportsNetworkHints*, *PhysicalNic.device*.\n\n***Required privileg...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostNetworkSystemMoIdQueryNetworkHint" }, "task": true }, { "name": "postHostNetworkSystemMoIdRefreshNetworkSystem", "summary": "Refresh the network information and settings to pick up any changes\nthat might have occurred.", "description": "Refresh the network information and settings to pick up any changes\nthat might have occurred.\n\n***Required privileges:*** Host.Config.Network", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postHostNetworkSystemMoIdRefreshNetworkSystem" }, "task": true }, { "name": "postHostNetworkSystemMoIdRemovePortGroup", "summary": "Removes port group from the virtual switch.", "description": "Removes port group from the virtual switch.\n\n***Required privileges:*** Host.Config.Network", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostNetworkSystemMoIdRemovePortGroup" }, "task": true }, { "name": "postHostNetworkSystemMoIdRemoveServiceConsoleVirtualNic", "summary": "Removes a virtual service console network adapter.", "description": "Removes a virtual service console network adapter.\n\nSee also *HostNetCapabilities.usesServiceConsoleNic*.\n\n***Required privileges:*** Host.Config.Network", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostNetworkSystemMoIdRemoveServiceConsoleVirtualNic" }, "task": true }, { "name": "postHostNetworkSystemMoIdRemoveVirtualNic", "summary": "Removes a virtual host/VMkernel network adapter.", "description": "Removes a virtual host/VMkernel network adapter.\n\n***Required privileges:*** Host.Config.Network", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostNetworkSystemMoIdRemoveVirtualNic" }, "task": true }, { "name": "postHostNetworkSystemMoIdRemoveVirtualSwitch", "summary": "Removes an existing virtual switch from the system.", "description": "Removes an existing virtual switch from the system.\n\n***Required privileges:*** Host.Config.Network", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostNetworkSystemMoIdRemoveVirtualSwitch" }, "task": true }, { "name": "postHostNetworkSystemMoIdRestartServiceConsoleVirtualNic", "summary": "Restart the service console virtual network adapter interface.", "description": "Restart the service console virtual network adapter interface.\n\nIf the service console virtual network adapter uses DHCP, restarting\nthe interface may result it with a different IP configuration, or\neven fail to be brought up depending on the host system network\nconfiguration.\n\nSee also *HostNetCapabilities.usesServiceConsoleNic*.\n\n***Required privileges:*** Host.Config.Network", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostNetworkSystemMoIdRestartServiceConsoleVirtualNic" }, "task": true }, { "name": "postHostNetworkSystemMoIdSetCustomValue", "summary": "Assigns a value to a custom field.", "description": "Assigns a value to a custom field.\n\nThe setCustomValue method requires\nwhichever updatePrivilege is defined as one of the\n*CustomFieldDef.fieldInstancePrivileges*\nfor the CustomFieldDef whose value is being changed.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostNetworkSystemMoIdSetCustomValue" }, "task": true }, { "name": "postHostNetworkSystemMoIdStartDpuFailover", "summary": "Launch DPU(Data Processing Unit) failover for a given distributed virtual switch.", "description": "Launch DPU(Data Processing Unit) failover for a given distributed virtual switch.\n\n***Since:*** vSphere API Release 8.0.3.0\n\n***Required privileges:*** Host.Config.Network", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostNetworkSystemMoIdStartDpuFailover" }, "task": true }, { "name": "postHostNetworkSystemMoIdUpdateConsoleIpRouteConfig", "summary": "Applies the IP route configuration for the service console.", "description": "Applies the IP route configuration for the service console.\n\n***Required privileges:*** Host.Config.Network", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostNetworkSystemMoIdUpdateConsoleIpRouteConfig" }, "task": true }, { "name": "postHostNetworkSystemMoIdUpdateDnsConfig", "summary": "Applies the client-side DNS configuration.", "description": "Deprecated as of vSphere API 5.5, which is moved to\neach NetStackInstance. This API only works on the default NetStackInstance.\n\nApplies the client-side DNS configuration.\n\n***Required privileges:*** Host.Config.Network", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostNetworkSystemMoIdUpdateDnsConfig" }, "task": true }, { "name": "postHostNetworkSystemMoIdUpdateIpRouteConfig", "summary": "Applies the IP route configuration.", "description": "Deprecated as of vSphere API 5.5, which is moved to\neach NetStackInstance. This API only works on the default NetStackInstance.\n\nApplies the IP route configuration.\n\n***Required privileges:*** Host.Config.Network", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostNetworkSystemMoIdUpdateIpRouteConfig" }, "task": true }, { "name": "postHostNetworkSystemMoIdUpdateIpRouteTableConfig", "summary": "Applies the IP route table configuration.", "description": "Deprecated as of vSphere API 5.5, which is moved to\neach NetStackInstance. This API only works on the default NetStackInstance.\n\nApplies the IP route table configuration.\n\n***Required privileges:*** Host.Config.Network", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostNetworkSystemMoIdUpdateIpRouteTableConfig" }, "task": true }, { "name": "postHostNetworkSystemMoIdUpdateNetworkConfig", "summary": "Applies the network configuration.", "description": "Applies the network configuration.\n\nThis method operates primarily\nin two modes: **replace** or **modify** mode.\n\n**replace**\nWhen called in **replace** mode, this method applies the fully\nspecified networking configuration to the networking system.\n\nUpon successful completion of the call, the state of networking will\nmatch the configuration specified in **config**. In general, objects\nare created or destroyed to match the elements in the array of\nconfigurations. The identifier field in each e...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostNetworkSystemMoIdUpdateNetworkConfig" }, "task": true }, { "name": "postHostNetworkSystemMoIdUpdatePhysicalNicLinkSpeed", "summary": "Configures link speed and duplexity.", "description": "Configures link speed and duplexity.\n\nIf linkSpeed is not specified,\nphysical network adapter will be set to autonegotiate.\n\nSee also *HostNetCapabilities.canSetPhysicalNicLinkSpeed*.\n\n***Required privileges:*** Host.Config.Network", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostNetworkSystemMoIdUpdatePhysicalNicLinkSpeed" }, "task": true }, { "name": "postHostNetworkSystemMoIdUpdatePortGroup", "summary": "Reconfigures a port group on the virtual switch.", "description": "Reconfigures a port group on the virtual switch.\n\n***Required privileges:*** Host.Config.Network", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostNetworkSystemMoIdUpdatePortGroup" }, "task": true }, { "name": "postHostNetworkSystemMoIdUpdateServiceConsoleVirtualNic", "summary": "Configures the IP configuration for a virtual service console network\nadapter.", "description": "Configures the IP configuration for a virtual service console network\nadapter.\n\nIP configuration is required although it does not have to be enabled\nif the host is an ESX Server system.\nThe dynamic privilege check will check that the users\nhave Network.Assign privilege on the DVPortGroup\nor the DVS if the port resides on a DVPortGroup or is a stand-alone DVS port.\n\nSee also *HostNetCapabilities.usesServiceConsoleNic*.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostNetworkSystemMoIdUpdateServiceConsoleVirtualNic" }, "task": true }, { "name": "postHostNetworkSystemMoIdUpdateVirtualNic", "summary": "Configures virtual host/VMkernel network adapter.", "description": "Configures virtual host/VMkernel network adapter.\n\nIP configuration is required although it does not have to be enabled\nif the host is an ESX Server system.\nThe dynamic privilege check will ensure that users have Host.Config.Network\nprivilege on the host, and Network.Assign privilege on the connecting\nDVPortGroup, or DVS if connecting to a standalone DVPort.\nNetwork.Assign privilege is not required for operations on standard network\nor for operations performed directly on the host.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostNetworkSystemMoIdUpdateVirtualNic" }, "task": true }, { "name": "postHostNetworkSystemMoIdUpdateVirtualSwitch", "summary": "Updates the properties of the virtual switch.", "description": "Updates the properties of the virtual switch.\n\nIf the bridge is NULL, the configuration will be unset.\n\nIf a network adapter is listed in the active or standby list, then\nchanging the set of network adapters to which the physical network\nadapter is associated may have a side effect of changing the network\nadapter order policy. If a network adapter is removed from\nthe bridge configuration, then the network adapter is removed\nfrom the network\nadapter teaming order.\n\nThe BondBridge configuration is...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostNetworkSystemMoIdUpdateVirtualSwitch" }, "task": true }, { "name": "getHostNetworkSystemMoIdAvailableField", "summary": "List of custom field definitions that are valid for the object's type.", "description": "List of custom field definitions that are valid for the object's type.\n\nThe fields are sorted by *CustomFieldDef.name*.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostNetworkSystemMoIdAvailableField" }, "task": true }, { "name": "getHostNetworkSystemMoIdCapabilities", "summary": "Capability vector indicating the available product features.", "description": "Capability vector indicating the available product features.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostNetworkSystemMoIdCapabilities" }, "task": true }, { "name": "getHostNetworkSystemMoIdConsoleIpRouteConfig", "summary": "IP route configuration for the service console.", "description": "IP route configuration for the service console.\n\nThe IP route\nconfiguration is global to the entire host. This property is\nset only if\nIP routing can be configured for the service console.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostNetworkSystemMoIdConsoleIpRouteConfig" }, "task": true }, { "name": "getHostNetworkSystemMoIdDnsConfig", "summary": "Client-side DNS configuration.", "description": "Deprecated as of vSphere API 5.5, which is moved to\neach NetStackInstance. This only works on the default NetStackInstance.\n\nClient-side DNS configuration.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostNetworkSystemMoIdDnsConfig" }, "task": true }, { "name": "getHostNetworkSystemMoIdIpRouteConfig", "summary": "The IP route configuration.", "description": "Deprecated as of vSphere API 5.5, which is moved to\neach NetStackInstance. This only works on the default NetStackInstance.\n\nThe IP route configuration.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostNetworkSystemMoIdIpRouteConfig" }, "task": true }, { "name": "getHostNetworkSystemMoIdNetworkConfig", "summary": "Network configuration information.", "description": "Network configuration information.\n\nThis information can be applied\nusing the *updateNetworkConfig()* method. The\ninformation is a strict subset of the information available in NetworkInfo.\n\nSee also *HostNetworkInfo*.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostNetworkSystemMoIdNetworkConfig" }, "task": true }, { "name": "getHostNetworkSystemMoIdNetworkInfo", "summary": "The network configuration and runtime information.", "description": "The network configuration and runtime information.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostNetworkSystemMoIdNetworkInfo" }, "task": true }, { "name": "getHostNetworkSystemMoIdOffloadCapabilities", "summary": "The offload capabilities available on this server.", "description": "Deprecated as of VI API 4.0, the system defaults will be used.\n\nThe offload capabilities available on this server.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostNetworkSystemMoIdOffloadCapabilities" }, "task": true }, { "name": "getHostNetworkSystemMoIdValue", "summary": "List of custom field values.", "description": "List of custom field values.\n\nEach value uses a key to associate\nan instance of a *CustomFieldStringValue* with\na custom field definition.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostNetworkSystemMoIdValue" }, "task": true }, { "name": "postHostNvdimmSystemMoIdCreateNvdimmNamespaceTask", "summary": "A new block or persistent namespace can be created on the NVDIMM(s)\nwhen the system is in maintenan", "description": "Deprecated as of vSphere 6.7u1, use createPMemNamespace\nCreate nvd namespace from information passed in NamespaceCreationSpec.\n\nA new block or persistent namespace can be created on the NVDIMM(s)\nwhen the system is in maintenance mode.\n\nIf all the parameters passed\nare valid and system is in maintenance mode, then a DSM (Device\nSpecific Method) call is made to create the namespace. DSM calls are\nblockable and slow operations and hence the use of task.\n\nIf a new namespace is created, its UUID is ...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostNvdimmSystemMoIdCreateNvdimmNamespaceTask" }, "task": true }, { "name": "postHostNvdimmSystemMoIdCreateNvdimmPMemNamespaceTask", "summary": "Create persistent memory mode nvd namespace from information passed\nin PMemNamespaceCreationSpec.", "description": "Create persistent memory mode nvd namespace from information passed\nin PMemNamespaceCreationSpec.\n\nA new persistent namespace can be created on the NVDIMM(s)\nwhen the system is in maintenance mode. If all the parameters passed\nare valid and system is in maintenance mode, then a DSM (Device\nSpecific Method) call is made to create the namespace. DSM calls are\nblockable and slow operations and hence the use of task.\n\nIf a new namespace is created, its UUID is returned.\n\n***Required privileges:*** H...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostNvdimmSystemMoIdCreateNvdimmPMemNamespaceTask" }, "task": true }, { "name": "postHostNvdimmSystemMoIdDeleteNvdimmBlockNamespacesTask", "summary": "Delete all block mode namespaces in the system.", "description": "Delete all block mode namespaces in the system.\n\nExisting block namespace(s) can be deleted from all NVDIMMs, if the\nsystem is in maintenance mode. If paramters passed are valid and\nthe system is in maintenance mode, then DSM calls are made to\ndelete these namespaces. DSM calls are blockable, slow operations\nand hence the use of task.\n\nIf a particular block namespace is to be deleted, use\n*HostNvdimmSystem.DeleteNvdimmNamespace_Task* by passing it the UUID\nof the block namespace.\n\n***Required pr...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postHostNvdimmSystemMoIdDeleteNvdimmBlockNamespacesTask" }, "task": true }, { "name": "postHostNvdimmSystemMoIdDeleteNvdimmNamespaceTask", "summary": "Delete nvd namespace whose uuid matches passed parameter.", "description": "Delete nvd namespace whose uuid matches passed parameter.\n\nAn existing namespace of type block or persistent mode can be deleted\nfrom NVDIMM(s), if the system is in maintenance mode. If paramters\npassed are valid and the system is in maintenance mode, then a DSM call\nis made to delete this namespace. DSM calls are blockable, slow\noperations and hence the use of task.\n\n***Required privileges:*** Host.Config.Nvdimm", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostNvdimmSystemMoIdDeleteNvdimmNamespaceTask" }, "task": true }, { "name": "getHostNvdimmSystemMoIdNvdimmSystemInfo", "summary": "Host NVDIMM information.", "description": "Host NVDIMM information.\n\n\\- Summary of all dimms on the host.\n\\- Array of all DIMMs on the host.\n\\- Array of DIMM information and health for all dimms on the host.\n\\- Array of interleave set for all sets on the host.\n\\- Array of interleave set information for all sets on the host.\n\\- Array of namespace IDs for all dimms on the host.\n\\- Array of namespace details of all dimms on the host.\n\n***Required privileges:*** Host.Config.Nvdimm", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostNvdimmSystemMoIdNvdimmSystemInfo" }, "task": true }, { "name": "postHostPatchManagerMoIdCheckHostPatchTask", "summary": "Check the list of metadata and returns the dependency, obsolete and conflict information\nThe operat", "description": "Deprecated as of vSphere 8.0u3, and there is no replacement available.\n\nCheck the list of metadata and returns the dependency, obsolete and conflict information\nThe operation is cancelable through the returned *Task* object.\n\nNo integrity checks\nare performed on the metadata.\n\n***Required privileges:*** System.Read", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostPatchManagerMoIdCheckHostPatchTask" }, "task": true }, { "name": "postHostPatchManagerMoIdInstallHostPatchTask", "summary": "Patch the host.", "description": "Deprecated method is deprecated, use *HostPatchManager.InstallHostPatchV2_Task* instead.\n\nPatch the host.\n\nThe operation is not cancelable. If the\npatch installation failed, an atomic rollback of the installation will\nbe attempted. Manual rollback is required if the atomic rollback\nfailed, see *PatchInstallFailed* for details.\n\n***Required privileges:*** Host.Config.Patch", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostPatchManagerMoIdInstallHostPatchTask" }, "task": true }, { "name": "postHostPatchManagerMoIdInstallHostPatchV2Task", "summary": "Patch the host.", "description": "Deprecated as of vSphere 8.0u3, and there is no replacement available.\n\nPatch the host.\n\nThe operation is not cancelable. If the\npatch installation failed, an atomic rollback of the installation will\nbe attempted. Manual rollback is required if the atomic rollback\nfailed, see *PatchInstallFailed* for details.\n\n***Required privileges:*** Host.Config.Patch", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostPatchManagerMoIdInstallHostPatchV2Task" }, "task": true }, { "name": "postHostPatchManagerMoIdQueryHostPatchTask", "summary": "Query the host for installed bulletins.", "description": "Deprecated as of vSphere 8.0u3, and there is no replacement available.\n\nQuery the host for installed bulletins.\n\n***Required privileges:*** System.Read", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostPatchManagerMoIdQueryHostPatchTask" }, "task": true }, { "name": "postHostPatchManagerMoIdScanHostPatchTask", "summary": "Scan the host for the patch status.", "description": "Deprecated as of VI API 4.0, use *HostPatchManager.ScanHostPatchV2_Task*.\n\nScan the host for the patch status.\n\nThe operation is cancelable\nthrough the returned *Task* object. Integrity checks are\nperformed on the metadata only during the scan operation.\n\n***Required privileges:*** System.Read", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostPatchManagerMoIdScanHostPatchTask" }, "task": true }, { "name": "postHostPatchManagerMoIdScanHostPatchV2Task", "summary": "Scan the host for the patch status.", "description": "Deprecated as of vSphere 8.0u3, and there is no replacement available.\n\nScan the host for the patch status.\n\nThe operation is cancelable\nthrough the returned *Task* object. Integrity checks are\nperformed on the metadata only during the scan operation.\n\n***Required privileges:*** System.Read", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostPatchManagerMoIdScanHostPatchV2Task" }, "task": true }, { "name": "postHostPatchManagerMoIdStageHostPatchTask", "summary": "Stage the vib files to esx local location and possibly do some run time check.", "description": "Deprecated as of vSphere 8.0u3, and there is no replacement available.\n\nStage the vib files to esx local location and possibly do some run time check.\n\n***Required privileges:*** Host.Config.Patch", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostPatchManagerMoIdStageHostPatchTask" }, "task": true }, { "name": "postHostPatchManagerMoIdUninstallHostPatchTask", "summary": "Uninstall patch from the host.", "description": "Deprecated as of vSphere 8.0u3, and there is no replacement available.\n\nUninstall patch from the host.\n\nThe operation is not cancelable.\n\n***Required privileges:*** Host.Config.Patch", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostPatchManagerMoIdUninstallHostPatchTask" }, "task": true }, { "name": "postHostPciPassthruSystemMoIdRefresh", "summary": "Refresh the available PciPassthru information.", "description": "Refresh the available PciPassthru information.\n\n***Required privileges:*** Host.Config.Settings", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postHostPciPassthruSystemMoIdRefresh" }, "task": true }, { "name": "postHostPciPassthruSystemMoIdSetCustomValue", "summary": "Assigns a value to a custom field.", "description": "Assigns a value to a custom field.\n\nThe setCustomValue method requires\nwhichever updatePrivilege is defined as one of the\n*CustomFieldDef.fieldInstancePrivileges*\nfor the CustomFieldDef whose value is being changed.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostPciPassthruSystemMoIdSetCustomValue" }, "task": true }, { "name": "postHostPciPassthruSystemMoIdUpdatePassthruConfig", "summary": "Updates the PciPassthru configuration, this will\nget called for the dependent device with the enabl", "description": "Updates the PciPassthru configuration, this will\nget called for the dependent device with the enabled\nbool set\n\n***Required privileges:*** Host.Config.PciPassthru", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostPciPassthruSystemMoIdUpdatePassthruConfig" }, "task": true }, { "name": "getHostPciPassthruSystemMoIdAvailableField", "summary": "List of custom field definitions that are valid for the object's type.", "description": "List of custom field definitions that are valid for the object's type.\n\nThe fields are sorted by *CustomFieldDef.name*.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostPciPassthruSystemMoIdAvailableField" }, "task": true }, { "name": "getHostPciPassthruSystemMoIdPciPassthruInfo", "summary": "Array of PciPassthru information", "description": "Array of PciPassthru information\n\n***Required privileges:*** System.Read", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostPciPassthruSystemMoIdPciPassthruInfo" }, "task": true }, { "name": "getHostPciPassthruSystemMoIdSriovDevicePoolInfo", "summary": "Array of Sriov Device Pool information", "description": "Array of Sriov Device Pool information\n\n***Required privileges:*** System.Read", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostPciPassthruSystemMoIdSriovDevicePoolInfo" }, "task": true }, { "name": "getHostPciPassthruSystemMoIdValue", "summary": "List of custom field values.", "description": "List of custom field values.\n\nEach value uses a key to associate\nan instance of a *CustomFieldStringValue* with\na custom field definition.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostPciPassthruSystemMoIdValue" }, "task": true }, { "name": "postHostPowerSystemMoIdConfigurePowerPolicy", "summary": "Configure host power policy.", "description": "Configure host power policy.\n\n***Required privileges:*** Host.Config.Power", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostPowerSystemMoIdConfigurePowerPolicy" }, "task": true }, { "name": "getHostPowerSystemMoIdCapability", "summary": "Power system capabilities object.", "description": "Power system capabilities object.\n\n***Required privileges:*** System.Read", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostPowerSystemMoIdCapability" }, "task": true }, { "name": "getHostPowerSystemMoIdInfo", "summary": "Power system state info object.", "description": "Power system state info object.\n\n***Required privileges:*** System.Read", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostPowerSystemMoIdInfo" }, "task": true }, { "name": "postHostProfileMoIdHostProfileResetValidationState", "summary": "This API will update the validationState to Ready\nfrom Failed, invalidate the validationFailureInfo", "description": "This API will update the validationState to Ready\nfrom Failed, invalidate the validationFailureInfo\nand reset the validationStateUpdateTime.\n\nThis API will return error if the validationState\nis Running.\n\n***Required privileges:*** Profile.Edit", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postHostProfileMoIdHostProfileResetValidationState" }, "task": true }, { "name": "postHostProfileMoIdAssociateProfile", "summary": "Associate a profile with a managed entity.", "description": "Associate a profile with a managed entity.\n\nYou can check the compliance of\nentities associated with a profile by calling the\n*Profile.CheckProfileCompliance_Task* method.\n\n***Required privileges:*** Profile.Edit", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostProfileMoIdAssociateProfile" }, "task": true }, { "name": "postHostProfileMoIdCheckProfileComplianceTask", "summary": "Check compliance of an entity against a Profile.", "description": "Check compliance of an entity against a Profile.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostProfileMoIdCheckProfileComplianceTask" }, "task": true }, { "name": "postHostProfileMoIdDestroyProfile", "summary": "Destroy the profile.", "description": "Destroy the profile.\n\n***Required privileges:*** Profile.Delete", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postHostProfileMoIdDestroyProfile" }, "task": true }, { "name": "postHostProfileMoIdDissociateProfile", "summary": "Remove the association between a profile and a managed entity.", "description": "Remove the association between a profile and a managed entity.\n\n***Required privileges:*** Profile.Edit", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostProfileMoIdDissociateProfile" }, "task": true }, { "name": "postHostProfileMoIdExecuteHostProfile", "summary": "Run the Profile Engine to determine the list of configuration changes\nneeded for the specified host.", "description": "Run the Profile Engine to determine the list of configuration changes\nneeded for the specified host.\n\nThe method generates configuration changes\nbased on the host profile.\n\nYou can also specify deferred parameters to verify additional host-specific data.\nThe Profile Engine uses the policy options\n(*HostProfile*.*Profile.config*.*HostProfileConfigInfo.applyProfile*.*ApplyProfile.policy*\\[\\])\nto determine the required parameters\n(*PolicyOption*.*PolicyOption.parameter*\\[\\])\nfor host configuration....(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostProfileMoIdExecuteHostProfile" }, "task": true }, { "name": "postHostProfileMoIdExportProfile", "summary": "Export the profile in a serialized form.", "description": "Export the profile in a serialized form.\n\nTo use the serialized string to create a profile,\nspecify a *ProfileSerializedCreateSpec* when you call the\n*HostProfileManager*.*ProfileManager.CreateProfile*\nmethod.\n\n***Required privileges:*** Profile.Export", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postHostProfileMoIdExportProfile" }, "task": true }, { "name": "postHostProfileMoIdRetrieveDescription", "summary": "Returns the localizable description for the profile.", "description": "Returns the localizable description for the profile.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postHostProfileMoIdRetrieveDescription" }, "task": true }, { "name": "postHostProfileMoIdUpdateHostProfile", "summary": "Update the HostProfile with the specified configuration data.", "description": "Update the HostProfile with the specified configuration data.\n\n***Required privileges:*** Profile.Edit", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostProfileMoIdUpdateHostProfile" }, "task": true }, { "name": "postHostProfileMoIdUpdateReferenceHost", "summary": "Sets the *HostProfile*.*HostProfile.referenceHost* property.", "description": "Sets the *HostProfile*.*HostProfile.referenceHost* property.\n\n***Required privileges:*** Profile.Edit", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostProfileMoIdUpdateReferenceHost" }, "task": true }, { "name": "getHostProfileMoIdComplianceCheckTime", "summary": "The latest compliance check time.", "description": "The latest compliance check time.\n\n***Since:*** vSphere API Release 8.0.1.0", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostProfileMoIdComplianceCheckTime" }, "task": true }, { "name": "getHostProfileMoIdComplianceStatus", "summary": "Overall compliance of entities associated with this profile.", "description": "Overall compliance of entities associated with this profile.\n\nIf one of the entities is out of compliance, the profile is nonCompliant .\nIf all entities are in compliance, the profile is compliant .\nIf the compliance status of one of the entities is not known, compliance status\nof the profile is unknown .\nSee *ComplianceResultStatus_enum*.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostProfileMoIdComplianceStatus" }, "task": true }, { "name": "getHostProfileMoIdConfig", "summary": "Configuration data for the profile.", "description": "Configuration data for the profile.\n\n***Required privileges:*** Profile.Edit", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostProfileMoIdConfig" }, "task": true }, { "name": "getHostProfileMoIdCreatedTime", "summary": "Time at which the profile was created.", "description": "Time at which the profile was created.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostProfileMoIdCreatedTime" }, "task": true }, { "name": "getHostProfileMoIdDescription", "summary": "Localizable description of the profile", "description": "Deprecated as of vSphere API 5.0. use *Profile.RetrieveDescription* instead.\n\nLocalizable description of the profile", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostProfileMoIdDescription" }, "task": true }, { "name": "getHostProfileMoIdEntity", "summary": "List of managed entities associated with the profile.", "description": "List of managed entities associated with the profile.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostProfileMoIdEntity" }, "task": true }, { "name": "getHostProfileMoIdModifiedTime", "summary": "Time at which the profile was last modified.", "description": "Time at which the profile was last modified.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostProfileMoIdModifiedTime" }, "task": true }, { "name": "getHostProfileMoIdName", "summary": "Name of the profile.", "description": "Name of the profile.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostProfileMoIdName" }, "task": true }, { "name": "getHostProfileMoIdReferenceHost", "summary": "Reference host in use for this host profile.", "description": "Reference host in use for this host profile.\n\nTo set this property,\nuse the *HostProfile.UpdateReferenceHost*\nmethod. If you do not specify a host for validation\n(*HostProfileCompleteConfigSpec*.*HostProfileCompleteConfigSpec.validatorHost*),\nthe Profile Engine uses the reference host to validate the profile.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostProfileMoIdReferenceHost" }, "task": true }, { "name": "getHostProfileMoIdValidationFailureInfo", "summary": "This object is created or updated if the *HostProfileValidationState_enum*\nis Failed.", "description": "This object is created or updated if the *HostProfileValidationState_enum*\nis Failed.\n\nThis object captures the most recent validation\nresult for the host profile object in case of failure.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostProfileMoIdValidationFailureInfo" }, "task": true }, { "name": "getHostProfileMoIdValidationState", "summary": "State of the host profile validation operation.", "description": "State of the host profile validation operation.\n\nThe values\nof the state will be one of *HostProfileValidationState_enum* enumerations.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostProfileMoIdValidationState" }, "task": true }, { "name": "getHostProfileMoIdValidationStateUpdateTime", "summary": "Update time of the validation operation.", "description": "Update time of the validation operation.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostProfileMoIdValidationStateUpdateTime" }, "task": true }, { "name": "postHostProfileManagerMoIdApplyEntitiesConfigTask", "summary": "The task for applying host configuration on a list of hosts.", "description": "The task for applying host configuration on a list of hosts.\n\nThis is the\nbatch version of applyHostConfiguration . The implementation\nof this method will:\nWhen a host is in a DRS cluster but doesn't satisfy the state requirement\nsuch as that the host is not in the required maintenance mode, this\nmethod uses DRS feature to put the host into maintenance mode.\nThis method will apply a host profile to a stateful host or stateless\nhost; or apply a host profile to a stateless host by reboot.\nAfter a...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostProfileManagerMoIdApplyEntitiesConfigTask" }, "task": true }, { "name": "postHostProfileManagerMoIdApplyHostConfigTask", "summary": "Apply the configuration to the host.", "description": "Apply the configuration to the host.\n\nIf you specify any user input,\nthe configuration will be saved in the *AnswerFile*\nassociated with the host. If there is no answer file, the Profile Engine\nwill create one.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostProfileManagerMoIdApplyHostConfigTask" }, "task": true }, { "name": "postHostProfileManagerMoIdCheckAnswerFileStatusTask", "summary": "Check the validity of the answer files for the specified hosts.", "description": "Check the validity of the answer files for the specified hosts.\n\nThe Profile Engine uses the profile associated with a host to check\nthe answer file.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostProfileManagerMoIdCheckAnswerFileStatusTask" }, "task": true }, { "name": "postHostProfileManagerMoIdCompositeHostProfileTask", "summary": "Composes (merge, replace, delete, disable)\nthe selected configurations into the target host profile", "description": "Composes (merge, replace, delete, disable)\nthe selected configurations into the target host profiles.\n\n***Required privileges:*** Profile.Edit", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostProfileManagerMoIdCompositeHostProfileTask" }, "task": true }, { "name": "postHostProfileManagerMoIdCreateDefaultProfile", "summary": "Create a default subprofile of a given type (for example, a\n*VirtualSwitchProfile*).", "description": "Create a default subprofile of a given type (for example, a\n*VirtualSwitchProfile*).\n\nAfter you create\nthe subprofile, you can add it to a configuration specification\nand update the host profile:\n- Call the CreateDefaultProfile method.\n- Create a *HostProfileCompleteConfigSpec* object.\n- Copy the existing profile from the host configuration information\n (*HostProfile*.*Profile.config*.*HostProfileConfigInfo.applyProfile*) to the configuration specification.\n- Add the new subprofile to the con...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostProfileManagerMoIdCreateDefaultProfile" }, "task": true }, { "name": "postHostProfileManagerMoIdCreateProfile", "summary": "Create a profile from the specified CreateSpec.", "description": "Create a profile from the specified CreateSpec.\n\n***Required privileges:*** Profile.Create", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostProfileManagerMoIdCreateProfile" }, "task": true }, { "name": "postHostProfileManagerMoIdExportAnswerFileTask", "summary": "Export a host's answer file into a serialized form.", "description": "Export a host's answer file into a serialized form.\n\nThe method returns a string\nthat contains only the list of user input options.\nSee *AnswerFile*.*AnswerFile.userInput*.\n\n***Required privileges:*** Profile.Export", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostProfileManagerMoIdExportAnswerFileTask" }, "task": true }, { "name": "postHostProfileManagerMoIdFindAssociatedProfile", "summary": "Get the profile(s) to which this entity is associated.", "description": "Get the profile(s) to which this entity is associated.\n\nThe list of profiles will only include profiles known to this\nprofileManager.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostProfileManagerMoIdFindAssociatedProfile" }, "task": true }, { "name": "postHostProfileManagerMoIdGenerateConfigTaskList", "summary": "Generate a list of configuration tasks that will be performed on the\nhost during HostProfile applic", "description": "Deprecated as of vSphere API 6.0 use\n*HostProfileManager.GenerateHostProfileTaskList_Task*.\n\nGenerate a list of configuration tasks that will be performed on the\nhost during HostProfile application.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostProfileManagerMoIdGenerateConfigTaskList" }, "task": true }, { "name": "postHostProfileManagerMoIdGenerateHostConfigTaskSpecTask", "summary": "This method generates *ApplyHostProfileConfigurationSpec* data object\nfor each host which can be pa", "description": "This method generates *ApplyHostProfileConfigurationSpec* data object\nfor each host which can be passed as input to\n*HostProfileManager.ApplyEntitiesConfig_Task*\nto configure that host.\n\nFor each host, this method goes through two stages,\n*HostProfile.ExecuteHostProfile* stage\n*HostProfileManager.GenerateHostProfileTaskList_Task* stage. If the\n*HostProfile.ExecuteHostProfile* stage completes\nsuccessfully then the method invokes the\n*HostProfileManager.GenerateHostProfileTaskList_Task*\nstage to g...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostProfileManagerMoIdGenerateHostConfigTaskSpecTask" }, "task": true }, { "name": "postHostProfileManagerMoIdGenerateHostProfileTaskListTask", "summary": "Generate a list of configuration tasks that will be performed on the\nhost during HostProfile applic", "description": "Generate a list of configuration tasks that will be performed on the\nhost during HostProfile application.\n\nThis differs from the\n*HostProfileManager.GenerateConfigTaskList* method in\nthat it returns a task to monitor the progress of the operation.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostProfileManagerMoIdGenerateHostProfileTaskListTask" }, "task": true }, { "name": "postHostProfileManagerMoIdQueryAnswerFileStatus", "summary": "Returns the status of the answer files associated with specified hosts.", "description": "Returns the status of the answer files associated with specified hosts.\n\nThis method returns the most recent status determined by\n*HostProfileManager.CheckAnswerFileStatus_Task*.\nSee *HostProfileManagerAnswerFileStatus_enum* for valid values.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostProfileManagerMoIdQueryAnswerFileStatus" }, "task": true }, { "name": "postHostProfileManagerMoIdQueryPolicyMetadata", "summary": "Get the Metadata information for the policyNames.", "description": "Get the Metadata information for the policyNames.\n\nPolicyNames are available with the defaultProfile obtained by invoking the\nmethod createDefaultProfile.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostProfileManagerMoIdQueryPolicyMetadata" }, "task": true }, { "name": "postHostProfileManagerMoIdQueryHostProfileMetadata", "summary": "Retrieve the metadata for a set of profiles.", "description": "Retrieve the metadata for a set of profiles.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostProfileManagerMoIdQueryHostProfileMetadata" }, "task": true }, { "name": "postHostProfileManagerMoIdQueryProfileStructure", "summary": "Get information about the structure of the profile.", "description": "Get information about the structure of the profile.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostProfileManagerMoIdQueryProfileStructure" }, "task": true }, { "name": "postHostProfileManagerMoIdRetrieveAnswerFile", "summary": "Returns the answer file associated with a particular host.", "description": "Returns the answer file associated with a particular host.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostProfileManagerMoIdRetrieveAnswerFile" }, "task": true }, { "name": "postHostProfileManagerMoIdRetrieveAnswerFileForProfile", "summary": "Returns the answer file associated with a particular host, augmented\nwith whatever answer file valu", "description": "Returns the answer file associated with a particular host, augmented\nwith whatever answer file values are required for the supplied host\nprofile.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostProfileManagerMoIdRetrieveAnswerFileForProfile" }, "task": true }, { "name": "postHostProfileManagerMoIdRetrieveHostCustomizations", "summary": "This is the batch version of\nvim.profile.host.ProfileManager@retrieveAnswerFile.", "description": "This is the batch version of\nvim.profile.host.ProfileManager@retrieveAnswerFile.\n\nReturns a map that contains the hosts and their answer file data\nobjects.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostProfileManagerMoIdRetrieveHostCustomizations" }, "task": true }, { "name": "postHostProfileManagerMoIdRetrieveHostCustomizationsForProfile", "summary": "This is the batch version of\nvim.profile.host.ProfileManager@retrieveAnswerFileForProfile.", "description": "This is the batch version of\nvim.profile.host.ProfileManager@retrieveAnswerFileForProfile.\n\nReturns a map that contains the hosts and their answer files associated\nwith these hosts, augmented with whatever answer file values are\nrequired for the supplied host profile.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostProfileManagerMoIdRetrieveHostCustomizationsForProfile" }, "task": true }, { "name": "postHostProfileManagerMoIdUpdateAnswerFileTask", "summary": "Update the *AnswerFile* for the specified host.", "description": "Update the *AnswerFile* for the specified host.\n\nIf there is no answer file associated with the host, the Profile Engine\nuses the answer file configuration specification to create a new one.\n\n***Required privileges:*** Profile.Edit", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostProfileManagerMoIdUpdateAnswerFileTask" }, "task": true }, { "name": "postHostProfileManagerMoIdValidateHostProfileCompositionTask", "summary": "Validates the proposed host profile composition.", "description": "Validates the proposed host profile composition.\n\n***Required privileges:*** Profile.Edit", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostProfileManagerMoIdValidateHostProfileCompositionTask" }, "task": true }, { "name": "getHostProfileManagerMoIdProfile", "summary": "A list of profiles known to this ProfileManager.", "description": "A list of profiles known to this ProfileManager.\n\n***Required privileges:*** Profile.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostProfileManagerMoIdProfile" }, "task": true }, { "name": "postHostServiceSystemMoIdRefreshServices", "summary": "Refresh the service information and settings to pick up any changes\nmade directly on the host.", "description": "Refresh the service information and settings to pick up any changes\nmade directly on the host.\n\n***Required privileges:*** Host.Config.NetService", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postHostServiceSystemMoIdRefreshServices" }, "task": true }, { "name": "postHostServiceSystemMoIdRestartService", "summary": "Restarts the service.", "description": "Restarts the service.\n\n***Required privileges:*** Host.Config.NetService", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostServiceSystemMoIdRestartService" }, "task": true }, { "name": "postHostServiceSystemMoIdSetCustomValue", "summary": "Assigns a value to a custom field.", "description": "Assigns a value to a custom field.\n\nThe setCustomValue method requires\nwhichever updatePrivilege is defined as one of the\n*CustomFieldDef.fieldInstancePrivileges*\nfor the CustomFieldDef whose value is being changed.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostServiceSystemMoIdSetCustomValue" }, "task": true }, { "name": "postHostServiceSystemMoIdStartService", "summary": "Starts the service.", "description": "Starts the service.\n\n***Required privileges:*** Host.Config.NetService", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostServiceSystemMoIdStartService" }, "task": true }, { "name": "postHostServiceSystemMoIdStopService", "summary": "Stops the service.", "description": "Stops the service.\n\n***Required privileges:*** Host.Config.NetService", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostServiceSystemMoIdStopService" }, "task": true }, { "name": "postHostServiceSystemMoIdUninstallService", "summary": "Uninstalls the service.", "description": "Uninstalls the service.\n\nIf the service is running, it is\nstopped before being uninstalled.\n\n***Required privileges:*** Host.Config.NetService", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostServiceSystemMoIdUninstallService" }, "task": true }, { "name": "postHostServiceSystemMoIdUpdateServicePolicy", "summary": "Updates the activation policy of the service.", "description": "Updates the activation policy of the service.\n\n***Required privileges:*** Host.Config.NetService", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostServiceSystemMoIdUpdateServicePolicy" }, "task": true }, { "name": "getHostServiceSystemMoIdAvailableField", "summary": "List of custom field definitions that are valid for the object's type.", "description": "List of custom field definitions that are valid for the object's type.\n\nThe fields are sorted by *CustomFieldDef.name*.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostServiceSystemMoIdAvailableField" }, "task": true }, { "name": "getHostServiceSystemMoIdServiceInfo", "summary": "Service configuration.", "description": "Service configuration.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostServiceSystemMoIdServiceInfo" }, "task": true }, { "name": "getHostServiceSystemMoIdValue", "summary": "List of custom field values.", "description": "List of custom field values.\n\nEach value uses a key to associate\nan instance of a *CustomFieldStringValue* with\na custom field definition.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostServiceSystemMoIdValue" }, "task": true }, { "name": "postHostSnmpSystemMoIdReconfigureSnmpAgent", "summary": "***Required privileges:*** Global.Settings", "description": "***Required privileges:*** Global.Settings", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostSnmpSystemMoIdReconfigureSnmpAgent" }, "task": true }, { "name": "postHostSnmpSystemMoIdSendTestNotification", "summary": "***Required privileges:*** Global.Settings", "description": "***Required privileges:*** Global.Settings", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postHostSnmpSystemMoIdSendTestNotification" }, "task": true }, { "name": "getHostSnmpSystemMoIdConfiguration", "summary": "***Required privileges:*** Global.Settings", "description": "***Required privileges:*** Global.Settings", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostSnmpSystemMoIdConfiguration" }, "task": true }, { "name": "getHostSnmpSystemMoIdLimits", "summary": "***Required privileges:*** Global.Settings", "description": "***Required privileges:*** Global.Settings", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostSnmpSystemMoIdLimits" }, "task": true }, { "name": "postHostSpecificationManagerMoIdDeleteHostSpecification", "summary": "Delete the host specification of the specified host.", "description": "Delete the host specification of the specified host.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostSpecificationManagerMoIdDeleteHostSpecification" }, "task": true }, { "name": "postHostSpecificationManagerMoIdDeleteHostSubSpecification", "summary": "Delete the host sub specification specified by the provided\nsubSpecname of the specified host.", "description": "Delete the host sub specification specified by the provided\nsubSpecname of the specified host.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostSpecificationManagerMoIdDeleteHostSubSpecification" }, "task": true }, { "name": "postHostSpecificationManagerMoIdHostSpecGetUpdatedHosts", "summary": "Query the hosts whose specification was updated in the specified\ntime period.", "description": "Query the hosts whose specification was updated in the specified\ntime period.\n\nWhen the startChangeID isn't provided, it will\nreturn all the host updated before the endChangeID . When the\n endChangeID isn't provided, it will return all the hosts\nupdated after startChangeID . If both aren't provided, all\nhosts having host spec will be returned.\nThe format of the change ID is defined at\n*HostSpecification.changeID*.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostSpecificationManagerMoIdHostSpecGetUpdatedHosts" }, "task": true }, { "name": "postHostSpecificationManagerMoIdRetrieveHostSpecification", "summary": "Retrieve the host specification.", "description": "Retrieve the host specification.\n\nWhen the parameter fromHost\nis true , the host specification is retrieved from the host;\notherwise, it is from the host specification \"database\" for this manager.\nWhen retrieved from host, the copy in host specification \"database\" will\nbe updated. On success, it will fire a\n HostSpecificationChangedEvent .\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostSpecificationManagerMoIdRetrieveHostSpecification" }, "task": true }, { "name": "postHostSpecificationManagerMoIdUpdateHostSpecification", "summary": "Update the host specification with the provided copy.", "description": "Update the host specification with the provided copy.\n\nIf there is no host specification for the host, create the host\nspecification for this host in the host specification \"database\";\notherwise, update the host specification with the provided.\n*HostSpecification* object.\nOn success, it will fire a HostSpecificationChangedEvent .\n\n***Required privileges:*** Profile.Edit", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostSpecificationManagerMoIdUpdateHostSpecification" }, "task": true }, { "name": "postHostSpecificationManagerMoIdUpdateHostSubSpecification", "summary": "Update the host specification with the provided host sub specification.", "description": "Update the host specification with the provided host sub specification.\n\nIf there is no host specification for the host, create the host\nspecification, which contains only the provided host sub specification,\nfor this host; otherwise, add or update the host specification with the\nprovided *HostSubSpecification* object.\nThis method provides a way to incrementally build the host specification.\nOn success, it will fire a HostSpecificationChangedEvent .\n\n***Required privileges:*** Profile.Edit", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostSpecificationManagerMoIdUpdateHostSubSpecification" }, "task": true }, { "name": "postHostStorageSystemMoIdAddInternetScsiSendTargets", "summary": "Adds Send Target entries to the host bus adapter discovery list.", "description": "Adds Send Target entries to the host bus adapter discovery list.\n\nThe DiscoveryProperties.sendTargetsDiscoveryEnabled flag\nmust be set to true.\n\n***Required privileges:*** Host.Config.Storage", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostStorageSystemMoIdAddInternetScsiSendTargets" }, "task": true }, { "name": "postHostStorageSystemMoIdAddInternetScsiStaticTargets", "summary": "Adds Static Target entries to the host bus adapter discovery list.", "description": "Adds Static Target entries to the host bus adapter discovery list.\n\nThe DiscoveryProperty.staticTargetDiscoveryEnabled must be set to true.\n\n***Required privileges:*** Host.Config.Storage", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostStorageSystemMoIdAddInternetScsiStaticTargets" }, "task": true }, { "name": "postHostStorageSystemMoIdAttachScsiLun", "summary": "Allow I/O issue to the specified detached ScsiLun.", "description": "Allow I/O issue to the specified detached ScsiLun.\n\nThe ScsiLun is\nadministratively configured on, if the attach operation is successful.\nSee *HostStorageSystem.DetachScsiLun*.\n\nattachScsiLun is part of the Unmount, Detach workflow used\nwhen a device will be permanently removed.\nSee also *HostStorageSystem.UnmountVmfsVolume*.\n\n***Required privileges:*** Host.Config.Storage", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostStorageSystemMoIdAttachScsiLun" }, "task": true }, { "name": "postHostStorageSystemMoIdAttachScsiLunExTask", "summary": "Attach one or more SCSI LUNs.", "description": "Attach one or more SCSI LUNs.\n\nThis is an asynchronous, batch operation of\nattachScisLun. Please see *HostStorageSystem.AttachScsiLun*\nfor operational details.\n\n***Required privileges:*** Host.Config.Storage", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostStorageSystemMoIdAttachScsiLunExTask" }, "task": true }, { "name": "postHostStorageSystemMoIdAttachVmfsExtent", "summary": "Extends a VMFS by attaching a disk partition as an extent.", "description": "Extends a VMFS by attaching a disk partition as an extent.\n\n***Required privileges:*** Host.Config.Storage", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostStorageSystemMoIdAttachVmfsExtent" }, "task": true }, { "name": "postHostStorageSystemMoIdChangeNFSUserPassword", "summary": "Change password for existing NFS user.", "description": "Change password for existing NFS user.\n\nThis method shall be called after\nthe NFS user has been created on the host.\n\n***Required privileges:*** Host.Config.Storage", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostStorageSystemMoIdChangeNFSUserPassword" }, "task": true }, { "name": "postHostStorageSystemMoIdClearNFSUser", "summary": "Clear the NFS user configured on the esx host", "description": "Clear the NFS user configured on the esx host\n\n***Required privileges:*** Host.Config.Storage", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postHostStorageSystemMoIdClearNFSUser" }, "task": true }, { "name": "postHostStorageSystemMoIdComputeDiskPartitionInfo", "summary": "Computes the disk partition information given the desired disk layout.", "description": "Computes the disk partition information given the desired disk layout.\n\nThe server computes a new partition information object for a specific\ndisk representing the desired layout.\n\nSee also *HostDiskPartitionInfoPartitionFormat_enum*.\n\n***Required privileges:*** Host.Config.Storage", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostStorageSystemMoIdComputeDiskPartitionInfo" }, "task": true }, { "name": "postHostStorageSystemMoIdComputeDiskPartitionInfoForResize", "summary": "Computes the disk partition information for the purpose of resizing\na given partition.", "description": "Computes the disk partition information for the purpose of resizing\na given partition.\n\nSee also *HostDiskPartitionInfoPartitionFormat_enum*.\n\n***Required privileges:*** Host.Config.Storage", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostStorageSystemMoIdComputeDiskPartitionInfoForResize" }, "task": true }, { "name": "postHostStorageSystemMoIdConnectNvmeController", "summary": "Establish a connection to an NVME controller.", "description": "Establish a connection to an NVME controller.\n\nAs a result, all the namespaces attached to the controller\nwill be accessible through the adapter.\nFor more details, see:\n- \"NVM Express over Fabrics 1.0\", Section 3.3,\n \"Connect command and response\"\n\n***Required privileges:*** Host.Config.Storage", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostStorageSystemMoIdConnectNvmeController" }, "task": true }, { "name": "postHostStorageSystemMoIdConnectNvmeControllerExTask", "summary": "Establish a connection to one or more NVMe controllers.", "description": "Establish a connection to one or more NVMe controllers.\n\nThis is an asynchronous, batch version of the connectNvmeController API.\nSee *HostStorageSystem.ConnectNvmeController* for details. If supported\non the host in question, *HostCapability.nvmeBatchOperationsSupported*\nwill be set to true.\nAn attempt will be made to establish a connection using each of the provided\nspecifications. There are no transactional guarantees - some of the connections\nmay succeed and some may fail. In case of any fai...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostStorageSystemMoIdConnectNvmeControllerExTask" }, "task": true }, { "name": "postHostStorageSystemMoIdCreateNvmeOverRdmaAdapter", "summary": "Creates a software NVME over RDMA adapter.", "description": "Creates a software NVME over RDMA adapter.\n\n***Required privileges:*** Host.Config.Storage", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostStorageSystemMoIdCreateNvmeOverRdmaAdapter" }, "task": true }, { "name": "postHostStorageSystemMoIdCreateSoftwareAdapter", "summary": "Creates a software host bus adapter based on the provided spec.", "description": "Creates a software host bus adapter based on the provided spec.\n\n***Since:*** vSphere API Release 7.0.3.0\n\n***Required privileges:*** Host.Config.Storage", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostStorageSystemMoIdCreateSoftwareAdapter" }, "task": true }, { "name": "postHostStorageSystemMoIdDeleteScsiLunState", "summary": "For previously detached SCSI Lun, remove the state information from\nhost.", "description": "For previously detached SCSI Lun, remove the state information from\nhost.\n\nDetach SCSI Lun marks the device where I/Os are not allowed.\nHost still maintains the entry of this device and its state.\nIf a LUN is detached using detachScsiLun, ESX will not automatically\nattach this LUN durng a rescan or after a reboot.\nSee *HostStorageSystem.DetachScsiLun*.\nPlease note: The API takes 'canonicalName' of the ScsiLun object\ninstead of the ScsiLun.uuid.\n\nSee also *ScsiLun.canonicalName*.\n\n***Required pri...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostStorageSystemMoIdDeleteScsiLunState" }, "task": true }, { "name": "postHostStorageSystemMoIdDeleteVffsVolumeState", "summary": "For previously unmounted VFFS volume, remove the state information from\nhost.", "description": "For previously unmounted VFFS volume, remove the state information from\nhost.\n\nVFFS volumes mount state is maintained by host.\n\ndeleteVffsVolumeState is part of the Unmount/Detach workflow used\nwhen the device will be permanently removed.\nSee also *HostStorageSystem.UnmountVffsVolume*.\nIf the VFFS volume is unmounted using unmountVffsVolume, ESX maintains\nthe state of VFFS volume. This API will remove the state from the host.\nIf the underlying storage device is going to be un-provisioned on the\n...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostStorageSystemMoIdDeleteVffsVolumeState" }, "task": true }, { "name": "postHostStorageSystemMoIdDeleteVmfsVolumeState", "summary": "For previously unmounted VMFS volume, remove the state information from\nhost.", "description": "For previously unmounted VMFS volume, remove the state information from\nhost.\n\nVMFS volumes mount state is maintained by host.\n\ndeleteVmfsVolumeState is part of the Unmount/Detach workflow used\nwhen the device will be permanently removed.\nSee also *HostStorageSystem.UnmountVmfsVolume*.\nIf the VMFS volume is unmounted using unmountVmfsVolume, ESX maintains\nthe state of VMFS volume. This API will remove the state from the host.\nIf the underlying storage device is going to be un-provisioned on the\n...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostStorageSystemMoIdDeleteVmfsVolumeState" }, "task": true }, { "name": "postHostStorageSystemMoIdDestroyVffs", "summary": "Destroy a VFFS volume.", "description": "Destroy a VFFS volume.\n\n***Required privileges:*** Host.Config.Storage", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostStorageSystemMoIdDestroyVffs" }, "task": true }, { "name": "postHostStorageSystemMoIdDetachScsiLun", "summary": "Disallow I/O issue to the specified ScsiLun.", "description": "Disallow I/O issue to the specified ScsiLun.\n\nThe ScsiLun is\ndetached, i.e. administratively configured off until a subsequent\nattachScsiLun is performed, if the operation is successful.\nSee *HostStorageSystem.AttachScsiLun*.\n\ndetachScsiLun is part of the Unmount / Detach workflow used\nwhen a device will be permanently removed.\nSee also *HostStorageSystem.UnmountVmfsVolume*.\n\n***Required privileges:*** Host.Config.Storage", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostStorageSystemMoIdDetachScsiLun" }, "task": true }, { "name": "postHostStorageSystemMoIdDetachScsiLunExTask", "summary": "Detach one or more SCSI LUNs.", "description": "Detach one or more SCSI LUNs.\n\nThis is an asynchronous, batch operation of\ndetachScisLun. Please see *HostStorageSystem.DetachScsiLun*\nfor operational details.\n\n***Required privileges:*** Host.Config.Storage", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostStorageSystemMoIdDetachScsiLunExTask" }, "task": true }, { "name": "postHostStorageSystemMoIdDisableMultipathPath", "summary": "Disables an enabled path for a Logical Unit.", "description": "Disables an enabled path for a Logical Unit.\n\nUse the path name from *HostMultipathStateInfoPath*\nor *HostMultipathInfoPath*.\n\n***Required privileges:*** Host.Config.Storage", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostStorageSystemMoIdDisableMultipathPath" }, "task": true }, { "name": "postHostStorageSystemMoIdDisconnectNvmeController", "summary": "Disconnect from an NVME controller.", "description": "Disconnect from an NVME controller.\n\nAs a result, all the namespaces attached to the controller\nwill no longer be accessible through the adapter.\n\n***Required privileges:*** Host.Config.Storage", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostStorageSystemMoIdDisconnectNvmeController" }, "task": true }, { "name": "postHostStorageSystemMoIdDisconnectNvmeControllerExTask", "summary": "Disconnect from one or more NVMe controllers.", "description": "Disconnect from one or more NVMe controllers.\n\nThis is an asynchronous, batch version of the disconnectNvmeController API.\nSee *HostStorageSystem.DisconnectNvmeController* for details. If supported\non the host in question, *HostCapability.nvmeBatchOperationsSupported*\nwill be set to true.\nAn attempt will be made to disconnect a controller using each of the provided\nspecifications. There are no transactional guarantees - some of the disconnections\nmay succeed and some may fail. In case of any fai...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostStorageSystemMoIdDisconnectNvmeControllerExTask" }, "task": true }, { "name": "postHostStorageSystemMoIdDiscoverFcoeHbas", "summary": "Initiates FCoE discovery using the given FcoeSpecification.", "description": "Deprecated as of vSphere API 8.0. Software FCoE not supported.\n\nInitiates FCoE discovery using the given FcoeSpecification.\n\nUpon success, discovered VNPorts will have registered with the\nsystem as FCoE HBAs.\n\n***Required privileges:*** Host.Config.Storage", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostStorageSystemMoIdDiscoverFcoeHbas" }, "task": true }, { "name": "postHostStorageSystemMoIdDiscoverNvmeControllers", "summary": "Connects to a Discovery Controller and retrieves the Discovery Log\nusing the provided NvmeDiscoverS", "description": "Connects to a Discovery Controller and retrieves the Discovery Log\nusing the provided NvmeDiscoverSpec.\n\nFor more details, see:\n- \"NVM Express over Fabrics 1.0\", Section 5, \"Discovery service\"\n\n***Required privileges:*** Host.Config.Storage", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostStorageSystemMoIdDiscoverNvmeControllers" }, "task": true }, { "name": "postHostStorageSystemMoIdEnableMultipathPath", "summary": "Enables a disabled path for a Logical Unit.", "description": "Enables a disabled path for a Logical Unit.\n\nUse the path name from *HostMultipathStateInfoPath*\nor *HostMultipathInfoPath*.\n\n***Required privileges:*** Host.Config.Storage", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostStorageSystemMoIdEnableMultipathPath" }, "task": true }, { "name": "postHostStorageSystemMoIdExpandVmfsExtent", "summary": "Expands a VMFS extent as specified by the Disk partition specification.", "description": "Expands a VMFS extent as specified by the Disk partition specification.\n\n***Required privileges:*** Host.Config.Storage", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostStorageSystemMoIdExpandVmfsExtent" }, "task": true }, { "name": "postHostStorageSystemMoIdExtendVffs", "summary": "Extends a VFFS by attaching a SSD.", "description": "Extends a VFFS by attaching a SSD.\n\nSee also *HostScsiDisk.devicePath*.\n\n***Required privileges:*** Host.Config.Storage", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostStorageSystemMoIdExtendVffs" }, "task": true }, { "name": "postHostStorageSystemMoIdFormatVffs", "summary": "Format a new VFFS on a SSD disk", "description": "Format a new VFFS on a SSD disk\n\n***Required privileges:*** Host.Config.Storage", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostStorageSystemMoIdFormatVffs" }, "task": true }, { "name": "postHostStorageSystemMoIdFormatVmfs", "summary": "Formats a new VMFS on a disk partition.", "description": "Formats a new VMFS on a disk partition.\n\n***Required privileges:*** Host.Config.Storage", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostStorageSystemMoIdFormatVmfs" }, "task": true }, { "name": "postHostStorageSystemMoIdMarkAsLocalTask", "summary": "Mark a disk to local disk, due to the reason that local disks\nbehind some controllers might not be", "description": "Mark a disk to local disk, due to the reason that local disks\nbehind some controllers might not be recongized as local correctly.\n\nTask failure might lose existing claim rules on the disk.\n\n***Required privileges:*** Host.Config.Storage", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostStorageSystemMoIdMarkAsLocalTask" }, "task": true }, { "name": "postHostStorageSystemMoIdMarkAsNonLocalTask", "summary": "Mark a disk to remote disk, which is the opposite operation of\n*HostStorageSystem.MarkAsLocal_Task*", "description": "Mark a disk to remote disk, which is the opposite operation of\n*HostStorageSystem.MarkAsLocal_Task*\nTask failure might lose existing claim rules on the disk.\n\n***Required privileges:*** Host.Config.Storage", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostStorageSystemMoIdMarkAsNonLocalTask" }, "task": true }, { "name": "postHostStorageSystemMoIdMarkAsNonSsdTask", "summary": "Mark a disk to Non-SSD, which is the opposite operation of\n*HostStorageSystem.MarkAsSsd_Task*\nTask", "description": "Mark a disk to Non-SSD, which is the opposite operation of\n*HostStorageSystem.MarkAsSsd_Task*\nTask failure might lose existing claim rules on the disk.\n\n***Required privileges:*** Host.Config.Storage", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostStorageSystemMoIdMarkAsNonSsdTask" }, "task": true }, { "name": "postHostStorageSystemMoIdMarkAsSsdTask", "summary": "Mark a disk to SSD, due to the reason that SSDs behind some controllers\nmight not be recongized as", "description": "Mark a disk to SSD, due to the reason that SSDs behind some controllers\nmight not be recongized as SSD correctly.\n\nTask failure might lose existing claim rules on the disk.\n\n***Required privileges:*** Host.Config.Storage", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostStorageSystemMoIdMarkAsSsdTask" }, "task": true }, { "name": "postHostStorageSystemMoIdHostStorageSystemMarkForRemoval", "summary": "Mark or unmark the given FCoE HBA for removal from the host system.", "description": "Deprecated as of vSphere API 8.0. Software FCoE not supported.\n\nMark or unmark the given FCoE HBA for removal from the host system.\n\nMarking an FCoE HBA for removal will result in the HBA\nnot being discovered upon host reboot. Until reboot,\nthe HBA remains visible in the storage topology.\n\n***Required privileges:*** Host.Config.Storage", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostStorageSystemMoIdHostStorageSystemMarkForRemoval" }, "task": true }, { "name": "postHostStorageSystemMoIdMarkPerenniallyReserved", "summary": "Marks the specified LUN as perennially reserved.", "description": "Marks the specified LUN as perennially reserved.\n\n***Required privileges:*** Host.Config.Storage", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostStorageSystemMoIdMarkPerenniallyReserved" }, "task": true }, { "name": "postHostStorageSystemMoIdMarkPerenniallyReservedExTask", "summary": "Marks the specified one or more SCSI LUN's perennially reserved based\non the sate.", "description": "Marks the specified one or more SCSI LUN's perennially reserved based\non the sate.\n\n***Required privileges:*** Host.Config.Storage", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostStorageSystemMoIdMarkPerenniallyReservedExTask" }, "task": true }, { "name": "postHostStorageSystemMoIdMountVffsVolume", "summary": "Mount the unmounted VFFS volume.", "description": "Mount the unmounted VFFS volume.\n\nSee *HostStorageSystem.UnmountVffsVolume*.\n\nmountVffsVolume is part of the Unmount / Detach workflow used\nwhen a device will be permanently removed.\nSee also *HostStorageSystem.DetachScsiLun*.\n\n***Required privileges:*** Host.Config.Storage", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostStorageSystemMoIdMountVffsVolume" }, "task": true }, { "name": "postHostStorageSystemMoIdMountVmfsVolume", "summary": "Mount the unmounted Vmfs volume.", "description": "Mount the unmounted Vmfs volume.\n\nA newly discovered vmfs volume will be\nmounted unless, it has been explicitly unmounted. The default mount\nbehavior of Vmfs volumes is auto-mount. See *HostStorageSystem.UnmountVmfsVolume*.\n\nmountVmfsVolume is part of the Unmount / Detach workflow used\nwhen a device will be permanently removed.\nSee also *HostStorageSystem.DetachScsiLun*.\n\n***Required privileges:*** Host.Config.Storage", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostStorageSystemMoIdMountVmfsVolume" }, "task": true }, { "name": "postHostStorageSystemMoIdMountVmfsVolumeExTask", "summary": "Mount one or more VMFS volumes.", "description": "Mount one or more VMFS volumes.\n\nThis is an asynchronous, batch operation of\nmountVmfsVolume. Please see *HostStorageSystem.MountVmfsVolume*\nfor operational details.\n\n***Required privileges:*** Host.Config.Storage", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostStorageSystemMoIdMountVmfsVolumeExTask" }, "task": true }, { "name": "postHostStorageSystemMoIdQueryAvailableSsds", "summary": "Query the list SSD disks that can be used to contain a VFFS volume.", "description": "Query the list SSD disks that can be used to contain a VFFS volume.\n\nIf the optional parameter name is supplied, queries for the SSD\ndisks that can be used to contain extents of the specified VFFS volume. Otherwise,\nthe method retrieves the SSD disks that can be used to contain the new VFFS volume.\n\nThis operation will filter out SSD disks that are currently in use by an existing VFFS volume.\n\n***Required privileges:*** Host.Config.Storage", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostStorageSystemMoIdQueryAvailableSsds" }, "task": true }, { "name": "postHostStorageSystemMoIdQueryNFSUser", "summary": "Query the NFS user configured on the esx host", "description": "Query the NFS user configured on the esx host\n\n***Required privileges:*** Host.Config.Storage", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postHostStorageSystemMoIdQueryNFSUser" }, "task": true }, { "name": "postHostStorageSystemMoIdQueryPathSelectionPolicyOptions", "summary": "Queries the set of path selection policy options.", "description": "Queries the set of path selection policy options.\n\nThe set of policy\noptions indicates what path selection policies can be used by a\ndevice managed by native multipathing. Devices managed through native\nmultipathing are described in the *HostMultipathInfo* data\nobject.\n\nFiltering capabilities are not currently present but may be added in\nthe future.\n\n***Required privileges:*** System.Read", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postHostStorageSystemMoIdQueryPathSelectionPolicyOptions" }, "task": true }, { "name": "postHostStorageSystemMoIdQueryStorageArrayTypePolicyOptions", "summary": "Queries the set of storage array type policy options.", "description": "Queries the set of storage array type policy options.\n\nThe set of policy\noptions indicates what storage array type policies can be used by a\ndevice managed by native multipathing. Devices managed through native\nmultipathing are described in the *HostMultipathInfo* data\nobject.\n\nFiltering capabilities are not currently present but may be added in\nthe future.\n\n***Required privileges:*** System.Read", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postHostStorageSystemMoIdQueryStorageArrayTypePolicyOptions" }, "task": true }, { "name": "postHostStorageSystemMoIdQueryUnresolvedVmfsVolume", "summary": "Get the list of unbound VMFS volumes.", "description": "Get the list of unbound VMFS volumes.\n\nFor sharing a volume across hosts, a VMFS volume is bound to its\nunderlying block device storage. When a low level block copy is\nperformed to copy or move the VMFS volume, the copied volume will\nbe unbound.\n\n***Required privileges:*** System.Read", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postHostStorageSystemMoIdQueryUnresolvedVmfsVolume" }, "task": true }, { "name": "postHostStorageSystemMoIdQueryVmfsConfigOption", "summary": "Get the VMFS configuration options, including block size,\nunmap granularity.", "description": "Get the VMFS configuration options, including block size,\nunmap granularity.\n\n***Required privileges:*** Host.Config.Storage", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postHostStorageSystemMoIdQueryVmfsConfigOption" }, "task": true }, { "name": "postHostStorageSystemMoIdRefreshStorageSystem", "summary": "Obtains the latest host storage information related to storage devices, topology,\nand file systems.", "description": "Obtains the latest host storage information related to storage devices, topology,\nand file systems.\n\nThe ESX host updates its storage information asynchronously.\n\nThis method may update the following inventory elements:\n- Devices and storage topology\n (*HostSystem*.*HostSystem.config*.*HostConfigInfo.storageDevice*).\n- VMFS and NFS datastores (*HostSystem*.*HostSystem.datastore*).\n- File system volumes\n (*HostSystem*.*HostSystem.config*.*HostConfigInfo.fileSystemVolume*).\n\nThe Server perform...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postHostStorageSystemMoIdRefreshStorageSystem" }, "task": true }, { "name": "postHostStorageSystemMoIdRemoveInternetScsiSendTargets", "summary": "Removes Send Target entries from the host bus adapter discovery list.", "description": "Removes Send Target entries from the host bus adapter discovery list.\n\nThe DiscoveryProperty.sendTargetsDiscoveryEnabled must be set to true.\nIf any of the targets provided as parameters are not found in\nthe existing list, the other targets are removed and an exception\nis thrown.\n\n***Required privileges:*** Host.Config.Storage", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostStorageSystemMoIdRemoveInternetScsiSendTargets" }, "task": true }, { "name": "postHostStorageSystemMoIdRemoveInternetScsiStaticTargets", "summary": "Removes static target entries from the host bus adapter discovery list.", "description": "Removes static target entries from the host bus adapter discovery list.\n\nThe DiscoveryProperty.staticTargetDiscoveryEnabled must be set to true.\nIf any of the targets provided as parameters are not found in\nthe existing list, the other targets are removed and an exception\nis thrown.\n\n***Required privileges:*** Host.Config.Storage", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostStorageSystemMoIdRemoveInternetScsiStaticTargets" }, "task": true }, { "name": "postHostStorageSystemMoIdRemoveNvmeOverRdmaAdapter", "summary": "Removes a software NVME over RDMA adapter.", "description": "Removes a software NVME over RDMA adapter.\n\n***Required privileges:*** Host.Config.Storage", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostStorageSystemMoIdRemoveNvmeOverRdmaAdapter" }, "task": true }, { "name": "postHostStorageSystemMoIdRemoveSoftwareAdapter", "summary": "Removes a software host bus adapter, if the adapter type allows it.", "description": "Removes a software host bus adapter, if the adapter type allows it.\n\n***Since:*** vSphere API Release 7.0.3.0\n\n***Required privileges:*** Host.Config.Storage", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostStorageSystemMoIdRemoveSoftwareAdapter" }, "task": true }, { "name": "postHostStorageSystemMoIdRescanAllHba", "summary": "Scans all host bus adapters to obtain the current list of devices and device topology.", "description": "Scans all host bus adapters to obtain the current list of devices and device topology.\n\nThe *HostStorageSystem.RescanAllHba* method looks for new devices,\nremoved devices, and path changes.\n\nThis method may update the following inventory elements:\n- Devices and storage topology\n (*HostSystem*.*HostSystem.config*.*HostConfigInfo.storageDevice*).\n- VMFS and NFS datastores (*HostSystem*.*HostSystem.datastore*).\n- File system volumes (*HostSystem*.*HostSystem.config*.*HostConfigInfo.fileSystemVolum...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postHostStorageSystemMoIdRescanAllHba" }, "task": true }, { "name": "postHostStorageSystemMoIdRescanHba", "summary": "Issues a request to rescan a specific host bus adapter\nfor new storage devices.", "description": "Issues a request to rescan a specific host bus adapter\nfor new storage devices.\n\n***Required privileges:*** Host.Config.Storage", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostStorageSystemMoIdRescanHba" }, "task": true }, { "name": "postHostStorageSystemMoIdRescanVffs", "summary": "Rescans for new VFFS.", "description": "Rescans for new VFFS.\n\nThe *HostStorageSystem.RefreshStorageSystem* method also performs a VFFS rescan.\n\n*HostStorageSystem.RescanVffs* may update the\n*HostSystem*.*HostSystem.config*.*HostConfigInfo.fileSystemVolume* property.\nThe Server performs asynchronous updates to the inventory. Use the\n*PropertyCollector*.*PropertyCollector.WaitForUpdatesEx*\nmethod to obtain the property changes.\n\n***Required privileges:*** Host.Config.Storage", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postHostStorageSystemMoIdRescanVffs" }, "task": true }, { "name": "postHostStorageSystemMoIdRescanVmfs", "summary": "Rescans for new Virtual Machine File Systems (VMFS).", "description": "Rescans for new Virtual Machine File Systems (VMFS).\n\nThe *HostStorageSystem.RefreshStorageSystem* method also performs a VMFS rescan.\n\n*HostStorageSystem.RescanVmfs* may update the\n*HostSystem*.*HostSystem.config*.*HostConfigInfo.fileSystemVolume* property.\nThe Server performs asynchronous updates to the inventory. Use the\n*PropertyCollector*.*PropertyCollector.WaitForUpdatesEx*\nmethod to obtain the property changes.\n\n***Required privileges:*** Host.Config.Storage", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postHostStorageSystemMoIdRescanVmfs" }, "task": true }, { "name": "postHostStorageSystemMoIdResolveMultipleUnresolvedVmfsVolumes", "summary": "Resignature or 'Force Mount' list of unbound VMFS volumes.", "description": "Resignature or 'Force Mount' list of unbound VMFS volumes.\n\nTo safely enable sharing of the volume across hosts, a VMFS volume\nis bound to its underlying block device storage. When a low level\nblock copy is performed to copy or move the VMFS volume, the copied\nvolume will be unbound. In order for the VMFS volume to be usable,\na resolution operation is needed to determine whether the VMFS volume\nshould be treated as a new volume or not and what extents compose\nthat volume in the event there is mo...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostStorageSystemMoIdResolveMultipleUnresolvedVmfsVolumes" }, "task": true }, { "name": "postHostStorageSystemMoIdResolveMultipleUnresolvedVmfsVolumesExTask", "summary": "Resignature or 'Force Mount' list of unbound VMFS volumes.", "description": "Resignature or 'Force Mount' list of unbound VMFS volumes.\n\nTo safely enable sharing of the volume across hosts, a VMFS volume\nis bound to its underlying block device storage. When a low level\nblock copy is performed to copy or move the VMFS volume, the copied\nvolume will be unbound. In order for the VMFS volume to be usable,\na resolution operation is needed to determine whether the VMFS volume\nshould be treated as a new volume or not and what extents compose\nthat volume in the event there is mo...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostStorageSystemMoIdResolveMultipleUnresolvedVmfsVolumesExTask" }, "task": true }, { "name": "postHostStorageSystemMoIdRetrieveDiskPartitionInfo", "summary": "Gets the partition information for the disks named by the device names.", "description": "Gets the partition information for the disks named by the device names.\n\n***Required privileges:*** System.Read", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostStorageSystemMoIdRetrieveDiskPartitionInfo" }, "task": true }, { "name": "postHostStorageSystemMoIdSetCustomValue", "summary": "Assigns a value to a custom field.", "description": "Assigns a value to a custom field.\n\nThe setCustomValue method requires\nwhichever updatePrivilege is defined as one of the\n*CustomFieldDef.fieldInstancePrivileges*\nfor the CustomFieldDef whose value is being changed.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostStorageSystemMoIdSetCustomValue" }, "task": true }, { "name": "postHostStorageSystemMoIdSetMultipathLunPolicy", "summary": "Updates the path selection policy for a Logical Unit.", "description": "Updates the path selection policy for a Logical Unit.\n\nUse the LUN uuid from *HostMultipathInfoLogicalUnit*.\n\n***Required privileges:*** Host.Config.Storage", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostStorageSystemMoIdSetMultipathLunPolicy" }, "task": true }, { "name": "postHostStorageSystemMoIdSetNFSUser", "summary": "Set NFS username and password on the host.", "description": "Set NFS username and password on the host.\n\nThe specified password is\nstored encrypted at the host and overwrites any previous password\nconfiguration. This information is only needed when the host has\nmounted NFS volumes with security types that require user\ncredentials for accessing data. The password is used to acquire\ncredentials that the NFS client needs to use in order to secure NFS\ntraffic using RPCSECGSS. The client will access files on all volumes\nmounted on this host (that are mounted w...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostStorageSystemMoIdSetNFSUser" }, "task": true }, { "name": "postHostStorageSystemMoIdTurnDiskLocatorLedOffTask", "summary": "Turn off one or more disk locator LEDs.", "description": "Turn off one or more disk locator LEDs.\n\nThis is a batch operation to turn off one or more disk locator LEDs,\nwhich is the opposite operation of *HostStorageSystem.TurnDiskLocatorLedOn_Task*\n\n***Required privileges:*** Host.Config.Storage", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostStorageSystemMoIdTurnDiskLocatorLedOffTask" }, "task": true }, { "name": "postHostStorageSystemMoIdTurnDiskLocatorLedOnTask", "summary": "Turn on one or more disk locator LEDs, duration is the maximum that\nhardware can support.", "description": "Turn on one or more disk locator LEDs, duration is the maximum that\nhardware can support.\n\nThis is a batch operation to turn on one or more disk locator LEDs,\nso that user can easily locate the ScsiDisk on physical infrastructure.\n\n***Required privileges:*** Host.Config.Storage", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostStorageSystemMoIdTurnDiskLocatorLedOnTask" }, "task": true }, { "name": "postHostStorageSystemMoIdUnmapVmfsVolumeExTask", "summary": "Unmap one or more VMFS volumes.", "description": "Unmap one or more VMFS volumes.\n\nThis is an asynchronous, batch operation.\nThe operation unmaps free blocks in each VMFS volume.\n\n***Required privileges:*** Host.Config.Storage", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostStorageSystemMoIdUnmapVmfsVolumeExTask" }, "task": true }, { "name": "postHostStorageSystemMoIdUnmountForceMountedVmfsVolume", "summary": "Unmount the 'forceMounted' Vmfs volume.", "description": "Unmount the 'forceMounted' Vmfs volume.\n\nWhen a low level block copy is performed to copy or move the\nVMFS volume, the copied volume is unresolved. For the VMFS\nvolume to be usable, a resolution operation is applied. As\npart of resolution operation, user may decide to keep the\noriginal VMFS Uuid. Once the resolution is applied, the VMFS\nvolume is mounted on the host for its use. User can unmount\nthe VMFS volume if it is not being used by any registered\nVMs.\n\n***Required privileges:*** Host.Confi...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostStorageSystemMoIdUnmountForceMountedVmfsVolume" }, "task": true }, { "name": "postHostStorageSystemMoIdUnmountVffsVolume", "summary": "Unmount the VFFS volume.", "description": "Unmount the VFFS volume.\n\nAn unmounted volume cannot be used for any\nfilesystem operation requiring I/O. In contrast to removal, this\noperation does not destroy or alter partitions on which VFFS volumes\nreside. The mountState will be persisted across filesystem rescans and\nhost reboots. See *HostStorageSystem.MountVffsVolume*.\n\nunmountVffsVolume is part of the Unmount / Detach workflow used\nwhen a device will be permanently removed.\nSee also *HostStorageSystem.DetachScsiLun*.\n\n***Required privil...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostStorageSystemMoIdUnmountVffsVolume" }, "task": true }, { "name": "postHostStorageSystemMoIdUnmountVmfsVolume", "summary": "Unmount the Vmfs volume.", "description": "Unmount the Vmfs volume.\n\nAn unmounted volume cannot be used for any\nfilesystem operation requiring I/O. In contrast to removal, this\noperation does not destroy or alter partitions on which vmfs volumes\nreside. The mountState will be persisted across filesystem rescans and\nhost reboots. See *HostStorageSystem.MountVmfsVolume*.\n\nunmountVmfsVolume is part of the Unmount / Detach workflow used\nwhen a device will be permanently removed.\n\n Mounted Vmfs Volume\n unmountVm...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostStorageSystemMoIdUnmountVmfsVolume" }, "task": true }, { "name": "postHostStorageSystemMoIdUnmountVmfsVolumeExTask", "summary": "Unmount one or more VMFS volumes.", "description": "Unmount one or more VMFS volumes.\n\nThis is an asynchronous, batch operation of\nunmountVmfsVolume. Please see *HostStorageSystem.UnmountVmfsVolume*\nfor operational details.\n\n***Required privileges:*** Host.Config.Storage", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostStorageSystemMoIdUnmountVmfsVolumeExTask" }, "task": true }, { "name": "postHostStorageSystemMoIdUpdateDiskPartitions", "summary": "Changes the partitions on the disk by supplying a partition specification\nand the device name.", "description": "Changes the partitions on the disk by supplying a partition specification\nand the device name.\n\n***Required privileges:*** Host.Config.Storage", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostStorageSystemMoIdUpdateDiskPartitions" }, "task": true }, { "name": "postHostStorageSystemMoIdUpdateHppMultipathLunPolicy", "summary": "Updates the path selection policy for a HPP claimed Logical Unit.", "description": "Updates the path selection policy for a HPP claimed Logical Unit.\n\nUse the LUN uuid from *HostMultipathInfoLogicalUnit*.\n\n***Required privileges:*** Host.Config.Storage", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostStorageSystemMoIdUpdateHppMultipathLunPolicy" }, "task": true }, { "name": "postHostStorageSystemMoIdUpdateInternetScsiAdvancedOptions", "summary": "Updates the advanced options the iSCSI host bus adapter or the\ndiscovery addresses and targets asso", "description": "Updates the advanced options the iSCSI host bus adapter or the\ndiscovery addresses and targets associated with it.\n\n***Required privileges:*** Host.Config.Storage", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostStorageSystemMoIdUpdateInternetScsiAdvancedOptions" }, "task": true }, { "name": "postHostStorageSystemMoIdUpdateInternetScsiAlias", "summary": "Updates the alias of an iSCSI host bus adapter.", "description": "Updates the alias of an iSCSI host bus adapter.\n\n***Required privileges:*** Host.Config.Storage", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostStorageSystemMoIdUpdateInternetScsiAlias" }, "task": true }, { "name": "postHostStorageSystemMoIdUpdateInternetScsiAuthenticationProperties", "summary": "Updates the authentication properties for one or more targets or\ndiscovery addresses associated wit", "description": "Updates the authentication properties for one or more targets or\ndiscovery addresses associated with an iSCSI host bus adapter.\n\n***Required privileges:*** Host.Config.Storage", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostStorageSystemMoIdUpdateInternetScsiAuthenticationProperties" }, "task": true }, { "name": "postHostStorageSystemMoIdUpdateInternetScsiDigestProperties", "summary": "Updates the digest properties for the iSCSI host bus adapter or the\ndiscovery addresses and targets", "description": "Updates the digest properties for the iSCSI host bus adapter or the\ndiscovery addresses and targets associated with it.\n\n***Required privileges:*** Host.Config.Storage", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostStorageSystemMoIdUpdateInternetScsiDigestProperties" }, "task": true }, { "name": "postHostStorageSystemMoIdUpdateInternetScsiDiscoveryProperties", "summary": "Updates the Discovery properties for an iSCSI host bus adapter.", "description": "Updates the Discovery properties for an iSCSI host bus adapter.\n\n***Required privileges:*** Host.Config.Storage", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostStorageSystemMoIdUpdateInternetScsiDiscoveryProperties" }, "task": true }, { "name": "postHostStorageSystemMoIdUpdateInternetScsiIPProperties", "summary": "Updates the IP properties for an iSCSI host bus adapter.", "description": "Updates the IP properties for an iSCSI host bus adapter.\n\n***Required privileges:*** Host.Config.Storage", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostStorageSystemMoIdUpdateInternetScsiIPProperties" }, "task": true }, { "name": "postHostStorageSystemMoIdUpdateInternetScsiName", "summary": "Updates the name of an iSCSI host bus adapter.", "description": "Updates the name of an iSCSI host bus adapter.\n\n***Required privileges:*** Host.Config.Storage", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostStorageSystemMoIdUpdateInternetScsiName" }, "task": true }, { "name": "postHostStorageSystemMoIdUpdateScsiLunDisplayName", "summary": "Update the mutable display name associated with a ScsiLun.", "description": "Update the mutable display name associated with a ScsiLun.\n\nThe ScsiLun\nto be updated is identified using the specified uuid.\n\n***Required privileges:*** Host.Config.Storage", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostStorageSystemMoIdUpdateScsiLunDisplayName" }, "task": true }, { "name": "postHostStorageSystemMoIdUpdateSoftwareInternetScsiEnabled", "summary": "Enables or disables Software iSCSI.", "description": "Enables or disables Software iSCSI.\n\n***Required privileges:*** Host.Config.Storage", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostStorageSystemMoIdUpdateSoftwareInternetScsiEnabled" }, "task": true }, { "name": "postHostStorageSystemMoIdUpdateVmfsUnmapBandwidth", "summary": "Update VMFS unmap bandwidth.", "description": "Update VMFS unmap bandwidth.\n\nThis API updates the value of\n*VmfsUnmapBandwidthSpec.policy*,\n*VmfsUnmapBandwidthSpec.fixedValue*,\n*VmfsUnmapBandwidthSpec.dynamicMin*,\n*VmfsUnmapBandwidthSpec.dynamicMax*.\n\n***Required privileges:*** Host.Config.Storage", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostStorageSystemMoIdUpdateVmfsUnmapBandwidth" }, "task": true }, { "name": "postHostStorageSystemMoIdUpdateVmfsUnmapPriority", "summary": "Update VMFS unmap priority.", "description": "Update VMFS unmap priority.\n\nThis API updates the value of *HostVmfsVolume.unmapPriority*.\n\n***Required privileges:*** Host.Config.Storage", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostStorageSystemMoIdUpdateVmfsUnmapPriority" }, "task": true }, { "name": "postHostStorageSystemMoIdUpgradeVmLayout", "summary": "Iterates over all registered virtual machines.", "description": "Iterates over all registered virtual machines.\n\nFor each VM which .vmx file\nis located on the service console and all disks are available on VMFS3 or NAS,\nit will relocate the disks into directories if stored in the ROOT, and\nrelocate the VMX file into the directory too. Events are logged for each\nvirtual machine that is relocated.\n\nOn ESXi systems, this operation has no effect.\n\n***Required privileges:*** Host.Config.Storage", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postHostStorageSystemMoIdUpgradeVmLayout" }, "task": true }, { "name": "postHostStorageSystemMoIdUpgradeVmfs", "summary": "Upgrades the VMFS to the *latest\nsupported VMFS version*.", "description": "Upgrades the VMFS to the *latest\nsupported VMFS version*.\n\nPrerequisite:\nAll hosts that have mounted the volume must support the VMFS\nversion to which the volume will be upgraded.\n\n***Required privileges:*** Host.Config.Storage", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostStorageSystemMoIdUpgradeVmfs" }, "task": true }, { "name": "getHostStorageSystemMoIdAvailableField", "summary": "List of custom field definitions that are valid for the object's type.", "description": "List of custom field definitions that are valid for the object's type.\n\nThe fields are sorted by *CustomFieldDef.name*.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostStorageSystemMoIdAvailableField" }, "task": true }, { "name": "getHostStorageSystemMoIdFileSystemVolumeInfo", "summary": "File system volume information for the host.", "description": "File system volume information for the host.\n\nSee the\n*FileSystemVolumeInfo* data\nobject type for more information.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostStorageSystemMoIdFileSystemVolumeInfo" }, "task": true }, { "name": "getHostStorageSystemMoIdMultipathStateInfo", "summary": "Runtime information about the state of a multipath path.", "description": "Runtime information about the state of a multipath path.\n\nA null value will be returned if path state information is not available\nfor this system.\n\nIn systems prior to the plug-store architecture, the state of a path\nmay be accessible on the *HostMultipathInfo* data object\nof the *HostStorageSystem.storageDeviceInfo* property.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostStorageSystemMoIdMultipathStateInfo" }, "task": true }, { "name": "getHostStorageSystemMoIdStorageDeviceInfo", "summary": "Host storage information up to the device level.", "description": "Host storage information up to the device level.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostStorageSystemMoIdStorageDeviceInfo" }, "task": true }, { "name": "getHostStorageSystemMoIdSystemFile", "summary": "Datastore paths of files used by the host system on\nmounted volumes, for instance, the COS vmdk fil", "description": "Datastore paths of files used by the host system on\nmounted volumes, for instance, the COS vmdk file of the\nhost.\n\nFor information on datastore paths, see *Datastore*.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostStorageSystemMoIdSystemFile" }, "task": true }, { "name": "getHostStorageSystemMoIdValue", "summary": "List of custom field values.", "description": "List of custom field values.\n\nEach value uses a key to associate\nan instance of a *CustomFieldStringValue* with\na custom field definition.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostStorageSystemMoIdValue" }, "task": true }, { "name": "postHostSystemMoIdAcquireCimServicesTicket", "summary": "Creates and returns a credential used to establish a remote\nconnection to a Web Based Management (C", "description": "Creates and returns a credential used to establish a remote\nconnection to a Web Based Management (CIM) interface.\n\nValid only\nwhen ESXi wbem authentication mode is set to password.\nThe ticket provides the port for the service and sslThumbprint should\nbe used by client to validate ssl connection. This ticket is valid for 2\nminutes then will expire and is non-renewable.\n\n***Required privileges:*** Host.Cim.CimInteraction", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postHostSystemMoIdAcquireCimServicesTicket" }, "task": true }, { "name": "postHostSystemMoIdConfigureCryptoKey", "summary": "Sets/changes the key to be used for coredump encryption\nand puts the host in *safe* state.", "description": "Sets/changes the key to be used for coredump encryption\nand puts the host in *safe* state.\n\nThis function will make the host crypto safe and unlock all encrypted\nVMs on the host. When the encryption on the host is enabled for the\nfirst time after adding it to vCenter Server, this method will start\nsending asynchronously all the encryption keys for VMs on the host and\ncluster to unlock encrypted VMs.\nThis API behaves differently on the ESXi host vs. the vCenter server.\nBefore vSphere 7.0, it is n...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostSystemMoIdConfigureCryptoKey" }, "task": true }, { "name": "postHostSystemMoIdDestroyTask", "summary": "Destroys this object, deleting its contents and removing it from its parent\nfolder (if any).", "description": "Destroys this object, deleting its contents and removing it from its parent\nfolder (if any).\n\nNOTE: The appropriate privilege must be held on the parent of the destroyed\nentity as well as the entity itself.\nThis method can throw one of several exceptions. The exact set of exceptions\ndepends on the kind of entity that is being removed. See comments for\neach entity for more information on destroy behavior.\n\n***Required privileges:*** Host.Inventory.RemoveHostFromCluster", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postHostSystemMoIdDestroyTask" }, "task": true }, { "name": "postHostSystemMoIdDisconnectHostTask", "summary": "Disconnects from a host and instructs the server to stop sending heartbeats.", "description": "Disconnects from a host and instructs the server to stop sending heartbeats.\n\n***Required privileges:*** Host.Config.Connection", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postHostSystemMoIdDisconnectHostTask" }, "task": true }, { "name": "postHostSystemMoIdEnableCrypto", "summary": "Sets/changes the key to be used for coredump encryption\nand puts the host in *safe* state\nNote: *Ho", "description": "Sets/changes the key to be used for coredump encryption\nand puts the host in *safe* state\nNote: *HostSystem.PrepareCrypto* must be called first\n\n***Required privileges:*** Cryptographer.RegisterHost", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostSystemMoIdEnableCrypto" }, "task": true }, { "name": "postHostSystemMoIdEnterLockdownMode", "summary": "Modifies the permissions on the host, so that it will only be accessible\nthrough local console or a", "description": "Deprecated as of vSphere API 6.0, use\n*HostAccessManager.ChangeLockdownMode*.\n\nModifies the permissions on the host, so that it will only be accessible\nthrough local console or an authorized centralized management application.\n\nAny user defined permissions found on the host are lost.\n\nAccess via a VI client connected to the host is blocked.\nAccess though other services running on the host is also blocked.\n\nIf the operation is successful, *HostConfigInfo.adminDisabled*\nwill be set to true. This A...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postHostSystemMoIdEnterLockdownMode" }, "task": true }, { "name": "postHostSystemMoIdEnterMaintenanceModeTask", "summary": "Puts the host in maintenance mode.", "description": "Puts the host in maintenance mode.\n\nWhile this task is running and when the host is\nin maintenance mode, no virtual machines can be powered on and no provisioning\noperations can be performed on the host. Once the call completes, it is safe to\nturn off a host without disrupting any virtual machines.\n\nThe task completes once there are no powered-on virtual machines on the host and\nno provisioning operations in progress on the host. The operation does not\ndirectly initiate any operations to evacuat...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostSystemMoIdEnterMaintenanceModeTask" }, "task": true }, { "name": "postHostSystemMoIdPowerDownHostToStandByTask", "summary": "Puts the host in standby mode, a mode in which the host is in a\nstandby state from which it can be", "description": "Puts the host in standby mode, a mode in which the host is in a\nstandby state from which it can be powered up remotely.\n\nWhile\nthis task is running, no virtual machines can be powered on and\nno provisioning operations can be performed on the host.\n\nThe task completes only if there are no powered-on virtual\nmachines on the host, no provisioning operations in progress on\nthe host, and the host stopped responding. The operation does\nnot directly initiate any operations to evacuate or power-down\npow...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostSystemMoIdPowerDownHostToStandByTask" }, "task": true }, { "name": "postHostSystemMoIdExitLockdownMode", "summary": "Restores Administrator permission for the local administrative account\nfor the host that was remove", "description": "Deprecated as of vSphere API 6.0, use\n*HostAccessManager.ChangeLockdownMode*.\n\nRestores Administrator permission for the local administrative account\nfor the host that was removed by prior call to *HostSystem.EnterLockdownMode*.\n\nIf the operation is successful,\n*HostConfigInfo.adminDisabled* will be set to false. This API\nis not supported on the host. If invoked directly on a host, a\nNotSupported fault will be thrown.\n\nSee also *AuthorizationManager*for more information on permissions..\n\n***Requ...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postHostSystemMoIdExitLockdownMode" }, "task": true }, { "name": "postHostSystemMoIdExitMaintenanceModeTask", "summary": "Takes the host out of maintenance mode.", "description": "Takes the host out of maintenance mode.\n\nThis blocks if any concurrent\nrunning maintenance-only host configurations operations are being performed.\nFor example, if VMFS volumes are being upgraded.\n\nThe task is cancellable.\n\n***Required privileges:*** Host.Config.Maintenance", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostSystemMoIdExitMaintenanceModeTask" }, "task": true }, { "name": "postHostSystemMoIdPowerUpHostFromStandByTask", "summary": "Takes the host out of standby mode.", "description": "Takes the host out of standby mode.\n\nIf the command is\nsuccessful, the host wakes up and starts sending\nheartbeats. This method may be called automatically by a\ndynamic recommendation generation module to add capacity to a\ncluster, if the host is not in maintenance mode.\n\nNote that, depending on the implementation of the wakeup\nmethod, the client may never receive an indicator of success in\nthe returned task. In some cases, it is not even possible to\nensure that the wakeup request has made it to...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostSystemMoIdPowerUpHostFromStandByTask" }, "task": true }, { "name": "postHostSystemMoIdPrepareCrypto", "summary": "Prepare the host for receiving sensitive information\nand puts the host in *prepared* mode\nNote: Mus", "description": "Prepare the host for receiving sensitive information\nand puts the host in *prepared* mode\nNote: Must be invoked before *HostSystem.EnableCrypto*\n\n***Required privileges:*** Cryptographer.RegisterHost", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postHostSystemMoIdPrepareCrypto" }, "task": true }, { "name": "postHostSystemMoIdQueryHostConnectionInfo", "summary": "Connection-oriented information about a host.", "description": "Connection-oriented information about a host.\n\n***Required privileges:*** System.Read", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postHostSystemMoIdQueryHostConnectionInfo" }, "task": true }, { "name": "postHostSystemMoIdQueryMemoryOverhead", "summary": "Determines the amount of memory overhead necessary to power on a virtual\nmachine with the specified", "description": "Deprecated as of VI API 2.5, use *HostSystem.QueryMemoryOverheadEx*.\n\nDetermines the amount of memory overhead necessary to power on a virtual\nmachine with the specified characteristics.\n\n***Required privileges:*** System.Read", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostSystemMoIdQueryMemoryOverhead" }, "task": true }, { "name": "postHostSystemMoIdQueryMemoryOverheadEx", "summary": "Determines the amount of memory overhead necessary to power on a virtual\nmachine with the specified", "description": "Deprecated as of VI API 6.0, use\n*VirtualMachineConfigInfo.initialOverhead*.\n\nDetermines the amount of memory overhead necessary to power on a virtual\nmachine with the specified characteristics.\n\n***Required privileges:*** System.Read", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostSystemMoIdQueryMemoryOverheadEx" }, "task": true }, { "name": "postHostSystemMoIdQueryProductLockerLocation", "summary": "Query the path to VMware Tools repository configured on the host.", "description": "Query the path to VMware Tools repository configured on the host.\n\nThe host should be powered on.\n\n***Required privileges:*** System.Read", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postHostSystemMoIdQueryProductLockerLocation" }, "task": true }, { "name": "postHostSystemMoIdQueryTpmAttestationReport", "summary": "Basic information about TPM attestation state of the host.", "description": "Basic information about TPM attestation state of the host.\n\n***Required privileges:*** System.Read", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postHostSystemMoIdQueryTpmAttestationReport" }, "task": true }, { "name": "postHostSystemMoIdRebootHostTask", "summary": "Reboots a host.", "description": "Reboots a host.\n\nIf the command is successful, then the host has been rebooted. If\nconnected directly to the host, the client never receives an indicator of success\nin the returned task but simply loses connection to the host, upon success.\n\nThis command is not supported on all hosts. Check the host capability\n*vim.host.Capability.rebootSupported*.\nIf QuickBoot is enabled on the host, additional setup steps are performed.\n\n***Required privileges:*** Host.Config.Maintenance", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostSystemMoIdRebootHostTask" }, "task": true }, { "name": "postHostSystemMoIdReconfigureHostForDASTask", "summary": "Reconfigures the host for vSphere HA.", "description": "Reconfigures the host for vSphere HA.\n\nIf the host is part of a HA cluster, this operation reconfigures the host for HA.\nFor example, this operation may be used if a host is added to a HA enabled cluster\nand the automatic HA configuration system task fails. Automatic HA configuration\nmay fail for a variety of reasons. For example, the host is configured\nincorrectly.\n\n***Required privileges:*** Host.Config.Connection", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postHostSystemMoIdReconfigureHostForDASTask" }, "task": true }, { "name": "postHostSystemMoIdReconnectHostTask", "summary": "Reconnects to a host.", "description": "Reconnects to a host.\n\nThis process reinstalls agents and reconfigures the host, if\nit has gotten out of date with VirtualCenter. The reconnection process goes\nthrough many of the same steps as addHost: ensuring the correct set of licenses\nfor the number of CPUs on the host, ensuring the correct set of agents is\ninstalled, and ensuring that networks and datastores are discovered and registered\nwith VirtualCenter.\n\nThe client can change the IP address and port of the host when doing a reconnect\no...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostSystemMoIdReconnectHostTask" }, "task": true }, { "name": "postHostSystemMoIdReload", "summary": "Reload the entity state.", "description": "Reload the entity state.\n\nClients only need to call this method\nif they changed some external state that affects the service\nwithout using the Web service interface to perform the change.\nFor example, hand-editing a virtual machine configuration file\naffects the configuration of the associated virtual machine but\nthe service managing the virtual machine might not monitor the\nfile for changes. In this case, after such an edit, a client\nwould call \"reload\" on the associated virtual machine to ensu...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postHostSystemMoIdReload" }, "task": true }, { "name": "postHostSystemMoIdRenameTask", "summary": "Renames this managed entity.", "description": "Renames this managed entity.\n\nAny % (percent) character used in this name parameter\nmust be escaped, unless it is used to start an escape\nsequence. Clients may also escape any other characters in\nthis name parameter.\n\nSee also *ManagedEntity.name*.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostSystemMoIdRenameTask" }, "task": true }, { "name": "postHostSystemMoIdRetrieveFreeEpcMemory", "summary": "Return the amount of free EPC memory on the host in bytes.", "description": "Return the amount of free EPC memory on the host in bytes.\n\n***Required privileges:*** System.Read", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postHostSystemMoIdRetrieveFreeEpcMemory" }, "task": true }, { "name": "postHostSystemMoIdRetrieveHardwareUptime", "summary": "Return the hardware uptime of the host in seconds.", "description": "Return the hardware uptime of the host in seconds.\n\nThe harware uptime of a host is not affected by NTP and changes to its\nwall clock time and can be used by clients to provide a common time\nreference for all hosts.\n\n***Required privileges:*** System.Read", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postHostSystemMoIdRetrieveHardwareUptime" }, "task": true }, { "name": "postHostSystemMoIdSetCustomValue", "summary": "Assigns a value to a custom field.", "description": "Assigns a value to a custom field.\n\nThe setCustomValue method requires\nwhichever updatePrivilege is defined as one of the\n*CustomFieldDef.fieldInstancePrivileges*\nfor the CustomFieldDef whose value is being changed.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostSystemMoIdSetCustomValue" }, "task": true }, { "name": "postHostSystemMoIdShutdownHostTask", "summary": "Shuts down a host.", "description": "Shuts down a host.\n\nIf the command is successful, then the host has been shut down.\nThus, the client never receives an indicator of success in the returned task if\nconnected directly to the host.\n\nThis command is not supported on all hosts. Check the host capability\n*HostCapability.shutdownSupported*.\n\n***Required privileges:*** Host.Config.Maintenance", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostSystemMoIdShutdownHostTask" }, "task": true }, { "name": "postHostSystemMoIdUpdateFlags", "summary": "Update flags that are part of the *HostFlagInfo* object.", "description": "Update flags that are part of the *HostFlagInfo* object.\n\n***Required privileges:*** Host.Config.Settings", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostSystemMoIdUpdateFlags" }, "task": true }, { "name": "postHostSystemMoIdUpdateIpmi", "summary": "Update fields that are part of the *HostIpmiInfo* object.", "description": "Update fields that are part of the *HostIpmiInfo* object.\n\n***Required privileges:*** Host.Config.Settings", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostSystemMoIdUpdateIpmi" }, "task": true }, { "name": "postHostSystemMoIdUpdateProductLockerLocationTask", "summary": "Change and reconfigure the VMware Tools repository on the host.", "description": "Change and reconfigure the VMware Tools repository on the host.\n\nIf the new path is the same as the path already configured on\nthe host, no changes will be made to the host.\nThe host should be powered on.\n\nThis task is not cancellable and cannot be reverted once started.\n\n***Required privileges:*** Host.Config.ProductLocker", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostSystemMoIdUpdateProductLockerLocationTask" }, "task": true }, { "name": "postHostSystemMoIdUpdateSystemResources", "summary": "Update the configuration of the system resource hierarchy.", "description": "Deprecated as of Vsphere API 6.0. Please, contact VMware Support to get\ninstructions on how to configure system ESX resource pools.\n\nUpdate the configuration of the system resource hierarchy.\n\n***Required privileges:*** Host.Config.Resources", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostSystemMoIdUpdateSystemResources" }, "task": true }, { "name": "postHostSystemMoIdUpdateSystemSwapConfiguration", "summary": "Update the System Swap Configuration.", "description": "Update the System Swap Configuration.\n\nSee also *HostSystemSwapConfiguration*.\n\n***Required privileges:*** Host.Config.Settings", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostSystemMoIdUpdateSystemSwapConfiguration" }, "task": true }, { "name": "getHostSystemMoIdAlarmActionsEnabled", "summary": "Whether alarm actions are enabled for this entity.", "description": "Whether alarm actions are enabled for this entity.\n\nTrue if enabled; false otherwise.\n\n***Required privileges:*** System.Read", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostSystemMoIdAlarmActionsEnabled" }, "task": true }, { "name": "getHostSystemMoIdAnswerFileValidationResult", "summary": "Host answer file validation result.", "description": "Host answer file validation result.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostSystemMoIdAnswerFileValidationResult" }, "task": true }, { "name": "getHostSystemMoIdAnswerFileValidationState", "summary": "Host answer file validation state.", "description": "Host answer file validation state.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostSystemMoIdAnswerFileValidationState" }, "task": true }, { "name": "getHostSystemMoIdAvailableField", "summary": "List of custom field definitions that are valid for the object's type.", "description": "List of custom field definitions that are valid for the object's type.\n\nThe fields are sorted by *CustomFieldDef.name*.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostSystemMoIdAvailableField" }, "task": true }, { "name": "getHostSystemMoIdCapability", "summary": "Host capabilities.", "description": "Host capabilities.\n\nThis might not be available for a\ndisconnected host.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostSystemMoIdCapability" }, "task": true }, { "name": "getHostSystemMoIdComplianceCheckResult", "summary": "The host profile compliance check result.", "description": "The host profile compliance check result.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostSystemMoIdComplianceCheckResult" }, "task": true }, { "name": "getHostSystemMoIdComplianceCheckState", "summary": "The host profile compliance check state.", "description": "The host profile compliance check state.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostSystemMoIdComplianceCheckState" }, "task": true }, { "name": "getHostSystemMoIdConfig", "summary": "Host configuration information.", "description": "Host configuration information.\n\nThis might not be available for a disconnected\nhost.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostSystemMoIdConfig" }, "task": true }, { "name": "getHostSystemMoIdConfigIssue", "summary": "Current configuration issues that have been detected for this entity.", "description": "Current configuration issues that have been detected for this entity.\n\nTypically,\nthese issues have already been logged as events. The entity stores these\nevents as long as they are still current. The\n*configStatus* property provides an overall status\nbased on these events.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostSystemMoIdConfigIssue" }, "task": true }, { "name": "getHostSystemMoIdConfigManager", "summary": "Host configuration systems.", "description": "Host configuration systems.\n\nIn releases after vSphere API 5.0, vSphere Servers might not\ngenerate property collector update notifications for this property.\nTo obtain the latest value of the property, you can use\nPropertyCollector methods RetrievePropertiesEx or WaitForUpdatesEx.\nIf you use the PropertyCollector.WaitForUpdatesEx method, specify\nan empty string for the version parameter. Any other version value will not\nproduce any property values as no updates are generated.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostSystemMoIdConfigManager" }, "task": true }, { "name": "getHostSystemMoIdConfigStatus", "summary": "The configStatus indicates whether or not the system has detected a configuration\nissue involving t", "description": "The configStatus indicates whether or not the system has detected a configuration\nissue involving this entity.\n\nFor example, it might have detected a\nduplicate IP address or MAC address, or a host in a cluster\nmight be out of compliance. The meanings of the configStatus values are:\n- red: A problem has been detected involving the entity.\n- yellow: A problem is about to occur or a transient condition\n has occurred (For example, reconfigure fail-over policy).\n- green: No configuration issues have...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostSystemMoIdConfigStatus" }, "task": true }, { "name": "getHostSystemMoIdCustomValue", "summary": "Custom field values.", "description": "Custom field values.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostSystemMoIdCustomValue" }, "task": true }, { "name": "getHostSystemMoIdDatastore", "summary": "A collection of references to the subset of datastore objects in the datacenter\nthat are available", "description": "A collection of references to the subset of datastore objects in the datacenter\nthat are available in this HostSystem.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostSystemMoIdDatastore" }, "task": true }, { "name": "getHostSystemMoIdDatastoreBrowser", "summary": "DatastoreBrowser to browse datastores for this host.", "description": "DatastoreBrowser to browse datastores for this host.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostSystemMoIdDatastoreBrowser" }, "task": true }, { "name": "getHostSystemMoIdDeclaredAlarmState", "summary": "A set of alarm states for alarms that apply to this managed entity.", "description": "A set of alarm states for alarms that apply to this managed entity.\n\nThe set includes alarms defined on this entity\nand alarms inherited from the parent entity,\nor from any ancestors in the inventory hierarchy.\n\nAlarms are inherited if they can be triggered by this entity or its descendants.\nThis set does not include alarms that are defined on descendants of this entity.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostSystemMoIdDeclaredAlarmState" }, "task": true }, { "name": "getHostSystemMoIdDisabledMethod", "summary": "List of operations that are disabled, given the current runtime\nstate of the entity.", "description": "List of operations that are disabled, given the current runtime\nstate of the entity.\n\nFor example, a power-on operation always fails if a\nvirtual machine is already powered on. This list can be used by clients to\nenable or disable operations in a graphical user interface.\n\nNote: This list is determined by the current runtime state of an entity,\nnot by its permissions.\n\nThis list may include the following operations for a HostSystem:\n- *HostSystem.EnterMaintenanceMode_Task*\n- *HostSystem.ExitMain...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostSystemMoIdDisabledMethod" }, "task": true }, { "name": "getHostSystemMoIdEffectiveRole", "summary": "Access rights the current session has to this entity.", "description": "Access rights the current session has to this entity.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostSystemMoIdEffectiveRole" }, "task": true }, { "name": "getHostSystemMoIdHardware", "summary": "Hardware configuration of the host.", "description": "Hardware configuration of the host.\n\nThis might not be available for a\ndisconnected host.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostSystemMoIdHardware" }, "task": true }, { "name": "getHostSystemMoIdLicensableResource", "summary": "Information about all licensable resources, currently present on this host.", "description": "Information about all licensable resources, currently present on this host.\n\nThis information is used mostly by the modules, manipulating information\nin the *LicenseManager*. Developers of such modules\nshould use this property instead of *hardware*.\n\nNOTE:\nThe values in this property may not be accurate for pre-5.0 hosts when returned by vCenter 5.0", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostSystemMoIdLicensableResource" }, "task": true }, { "name": "getHostSystemMoIdName", "summary": "Name of this entity, unique relative to its parent.", "description": "Name of this entity, unique relative to its parent.\n\nAny / (slash), \\\\ (backslash), character used in this\nname element will be escaped. Similarly, any % (percent) character used in\nthis name element will be escaped, unless it is used to start an escape\nsequence. A slash is escaped as %2F or %2f. A backslash is escaped as %5C or\n%5c, and a percent is escaped as %25.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostSystemMoIdName" }, "task": true }, { "name": "getHostSystemMoIdNetwork", "summary": "A collection of references to the subset of network objects in the datacenter that\nare available in", "description": "A collection of references to the subset of network objects in the datacenter that\nare available in this HostSystem.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostSystemMoIdNetwork" }, "task": true }, { "name": "getHostSystemMoIdOverallStatus", "summary": "General health of this managed entity.", "description": "General health of this managed entity.\n\nThe overall status of the managed entity is computed as the worst status\namong its alarms and the configuration issues detected on the entity.\nThe status is reported as one of the following values:\n- red: The entity has alarms or configuration issues with a red status.\n- yellow: The entity does not have alarms or configuration issues with a\n red status, and has at least one with a yellow status.\n- green: The entity does not have alarms or configuration is...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostSystemMoIdOverallStatus" }, "task": true }, { "name": "getHostSystemMoIdParent", "summary": "Parent of this entity.", "description": "Parent of this entity.\n\nThis value is null for the root object and for\n*VirtualMachine* objects that are part of\na *VirtualApp*.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostSystemMoIdParent" }, "task": true }, { "name": "getHostSystemMoIdPermission", "summary": "List of permissions defined for this entity.", "description": "List of permissions defined for this entity.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostSystemMoIdPermission" }, "task": true }, { "name": "getHostSystemMoIdPrecheckRemediationResult", "summary": "The host profile precheck-remediation result.", "description": "The host profile precheck-remediation result.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostSystemMoIdPrecheckRemediationResult" }, "task": true }, { "name": "getHostSystemMoIdRecentTask", "summary": "The set of recent tasks operating on this managed entity.", "description": "The set of recent tasks operating on this managed entity.\n\nThis is a subset\nof *TaskManager.recentTask* belong to this entity. A task in this\nlist could be in one of the four states: pending, running, success or error.\n\nThis property can be used to deduce intermediate power states for\na virtual machine entity. For example, if the current powerState is \"poweredOn\"\nand there is a running task performing the \"suspend\" operation, then the virtual\nmachine's intermediate state might be described as \"s...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostSystemMoIdRecentTask" }, "task": true }, { "name": "getHostSystemMoIdRemediationResult", "summary": "The host profile remediation result.", "description": "The host profile remediation result.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostSystemMoIdRemediationResult" }, "task": true }, { "name": "getHostSystemMoIdRemediationState", "summary": "The host profile remediation state.", "description": "The host profile remediation state.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostSystemMoIdRemediationState" }, "task": true }, { "name": "getHostSystemMoIdRuntime", "summary": "Runtime state information about the host such as connection state.", "description": "Runtime state information about the host such as connection state.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostSystemMoIdRuntime" }, "task": true }, { "name": "getHostSystemMoIdSummary", "summary": "Basic information about the host, including connection state.", "description": "Basic information about the host, including connection state.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostSystemMoIdSummary" }, "task": true }, { "name": "getHostSystemMoIdSystemResources", "summary": "Reference for the system resource hierarchy, used for configuring the set of\nresources reserved to", "description": "Reference for the system resource hierarchy, used for configuring the set of\nresources reserved to the system and unavailable to virtual machines.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostSystemMoIdSystemResources" }, "task": true }, { "name": "getHostSystemMoIdTag", "summary": "The set of tags associated with this managed entity.", "description": "The set of tags associated with this managed entity.\n\nExperimental. Subject to change.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostSystemMoIdTag" }, "task": true }, { "name": "getHostSystemMoIdTriggeredAlarmState", "summary": "A set of alarm states for alarms triggered by this entity\nor by its descendants.", "description": "A set of alarm states for alarms triggered by this entity\nor by its descendants.\n\nTriggered alarms are propagated up the inventory hierarchy\nso that a user can readily tell when a descendant has triggered an alarm.\nIn releases after vSphere API 5.0, vSphere Servers might not\ngenerate property collector update notifications for this property.\nTo obtain the latest value of the property, you can use\nPropertyCollector methods RetrievePropertiesEx or WaitForUpdatesEx.\nIf you use the PropertyCollector...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostSystemMoIdTriggeredAlarmState" }, "task": true }, { "name": "getHostSystemMoIdValue", "summary": "List of custom field values.", "description": "List of custom field values.\n\nEach value uses a key to associate\nan instance of a *CustomFieldStringValue* with\na custom field definition.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostSystemMoIdValue" }, "task": true }, { "name": "getHostSystemMoIdVm", "summary": "List of virtual machines associated with this host.", "description": "List of virtual machines associated with this host.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostSystemMoIdVm" }, "task": true }, { "name": "postHostVFlashManagerMoIdHostConfigVFlashCache", "summary": "Configure vFlash cache on the host.", "description": "Configure vFlash cache on the host.\n\n***Required privileges:*** Host.Config.AdvancedConfig", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostVFlashManagerMoIdHostConfigVFlashCache" }, "task": true }, { "name": "postHostVFlashManagerMoIdHostConfigureVFlashResource", "summary": "Configure vFlash resource on the host by attaching to a backend VFFS volume.", "description": "Configure vFlash resource on the host by attaching to a backend VFFS volume.\n\n***Required privileges:*** Host.Config.Storage", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostVFlashManagerMoIdHostConfigureVFlashResource" }, "task": true }, { "name": "postHostVFlashManagerMoIdConfigureVFlashResourceExTask", "summary": "Configure vFlash resource on a list of SSD disks.", "description": "Configure vFlash resource on a list of SSD disks.\n\nIf the host does not have\na VFFS volume, host will format the volume first and then extend the volume\non the rest of the SSDs; otherwise host will extend the existing VFFS volume\non the passed SSDs. Finally host will configure the vFlash resource on the\nVFFS volume.\n\nIt will return *HostVFlashResourceConfigurationResult*\ndescribing success or failure associated with each device.\n\n***Required privileges:*** Host.Config.Storage", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostVFlashManagerMoIdConfigureVFlashResourceExTask" }, "task": true }, { "name": "postHostVFlashManagerMoIdHostGetVFlashModuleDefaultConfig", "summary": "Retrieve the default supported configuration for a given vFlash module", "description": "Retrieve the default supported configuration for a given vFlash module\n\n***Required privileges:*** Host.Config.AdvancedConfig", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostVFlashManagerMoIdHostGetVFlashModuleDefaultConfig" }, "task": true }, { "name": "postHostVFlashManagerMoIdHostRemoveVFlashResource", "summary": "Remove vFlash resource on the host by destroying the contained VFFS volume.", "description": "Remove vFlash resource on the host by destroying the contained VFFS volume.\n\n***Required privileges:*** Host.Config.Storage", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postHostVFlashManagerMoIdHostRemoveVFlashResource" }, "task": true }, { "name": "getHostVFlashManagerMoIdVFlashConfigInfo", "summary": "Host vFlash configuration information.", "description": "Host vFlash configuration information.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostVFlashManagerMoIdVFlashConfigInfo" }, "task": true }, { "name": "postHostVMotionSystemMoIdDeselectVnic", "summary": "Indicate that no VirtualNic should be used for VMotion.", "description": "Indicate that no VirtualNic should be used for VMotion.\n\n***Required privileges:*** Host.Config.Network", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postHostVMotionSystemMoIdDeselectVnic" }, "task": true }, { "name": "postHostVMotionSystemMoIdSelectVnic", "summary": "Select the VirtualNic to be used for VMotion.", "description": "Select the VirtualNic to be used for VMotion.\n\n***Required privileges:*** Host.Config.Network", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostVMotionSystemMoIdSelectVnic" }, "task": true }, { "name": "postHostVMotionSystemMoIdSetCustomValue", "summary": "Assigns a value to a custom field.", "description": "Assigns a value to a custom field.\n\nThe setCustomValue method requires\nwhichever updatePrivilege is defined as one of the\n*CustomFieldDef.fieldInstancePrivileges*\nfor the CustomFieldDef whose value is being changed.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostVMotionSystemMoIdSetCustomValue" }, "task": true }, { "name": "postHostVMotionSystemMoIdUpdateIpConfig", "summary": "Update the IP configuration of VMotion VirtualNic.", "description": "Update the IP configuration of VMotion VirtualNic.\n\n***Required privileges:*** Host.Config.Network", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostVMotionSystemMoIdUpdateIpConfig" }, "task": true }, { "name": "getHostVMotionSystemMoIdAvailableField", "summary": "List of custom field definitions that are valid for the object's type.", "description": "List of custom field definitions that are valid for the object's type.\n\nThe fields are sorted by *CustomFieldDef.name*.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostVMotionSystemMoIdAvailableField" }, "task": true }, { "name": "getHostVMotionSystemMoIdIpConfig", "summary": "IP configuration of the VMotion VirtualNic.", "description": "IP configuration of the VMotion VirtualNic.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostVMotionSystemMoIdIpConfig" }, "task": true }, { "name": "getHostVMotionSystemMoIdNetConfig", "summary": "VMotion network configuration.", "description": "VMotion network configuration.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostVMotionSystemMoIdNetConfig" }, "task": true }, { "name": "getHostVMotionSystemMoIdValue", "summary": "List of custom field values.", "description": "List of custom field values.\n\nEach value uses a key to associate\nan instance of a *CustomFieldStringValue* with\na custom field definition.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostVMotionSystemMoIdValue" }, "task": true }, { "name": "postHostVStorageObjectManagerMoIdHostVStorageObjectRevertTask", "summary": "Reverts to a given snapshot of a VStorageObject.", "description": "Reverts to a given snapshot of a VStorageObject.\n\nThis operation is supported on detached VirtualDisks\nDuring revert all the snapshots which were taken after the specified\nsnapshot would get deleted.\n\nE.g. Consider Disk with 4 snapshots\n\nBaseDisk -> Snap-2 -> Snap-3 -> Snap-4 -> Running-Point\n\nIf user chooses to revert to snap-2 then snap-4 and snap-3 would also\nbe deleted. After revert operation disk would have below configuration:\n\nBaseDisk -> Snap-2 -> Running-Point\n\n***Requ...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostVStorageObjectManagerMoIdHostVStorageObjectRevertTask" }, "task": true }, { "name": "postHostVStorageObjectManagerMoIdHostClearVStorageObjectControlFlags", "summary": "Clear control flags on VStorageObject.", "description": "Clear control flags on VStorageObject.\n\nThe control flags are defined in\n*vslmVStorageObjectControlFlag_enum*.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostVStorageObjectManagerMoIdHostClearVStorageObjectControlFlags" }, "task": true }, { "name": "postHostVStorageObjectManagerMoIdHostCloneVStorageObjectTask", "summary": "Clone a virtual storage object.", "description": "Clone a virtual storage object.\n\nRequires Datastore.FileManagement privilege on both source and\ndestination datastore.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostVStorageObjectManagerMoIdHostCloneVStorageObjectTask" }, "task": true }, { "name": "postHostVStorageObjectManagerMoIdHostCreateDiskTask", "summary": "Create a virtual disk, which is a storage object with\n*disk*\nas consumption type.", "description": "Create a virtual disk, which is a storage object with\n*disk*\nas consumption type.\n\nRequires Datastore.FileManagement privilege on the datastore where the\nvirtual disk object is created.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostVStorageObjectManagerMoIdHostCreateDiskTask" }, "task": true }, { "name": "postHostVStorageObjectManagerMoIdHostVStorageObjectCreateDiskFromSnapshotTask", "summary": "Creates a new Disk from given snapshot of a VStorageObject.", "description": "Creates a new Disk from given snapshot of a VStorageObject.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostVStorageObjectManagerMoIdHostVStorageObjectCreateDiskFromSnapshotTask" }, "task": true }, { "name": "postHostVStorageObjectManagerMoIdHostVStorageObjectCreateSnapshotTask", "summary": "Creates a snapshot of a given VStorageObject.", "description": "Creates a snapshot of a given VStorageObject.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostVStorageObjectManagerMoIdHostVStorageObjectCreateSnapshotTask" }, "task": true }, { "name": "postHostVStorageObjectManagerMoIdVStorageObjectCreateSnapshotExTask", "summary": "Creates a snapshot of a given VStorageObject.", "description": "Creates a snapshot of a given VStorageObject.\n\nRequires Datastore.FileManagement privilege.\n\n***Since:*** vSphere API Release 8.0.2.0\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostVStorageObjectManagerMoIdVStorageObjectCreateSnapshotExTask" }, "task": true }, { "name": "postHostVStorageObjectManagerMoIdHostVStorageObjectDeleteSnapshotTask", "summary": "Deletes a given snapshot of a VStorageObject.", "description": "Deletes a given snapshot of a VStorageObject.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostVStorageObjectManagerMoIdHostVStorageObjectDeleteSnapshotTask" }, "task": true }, { "name": "postHostVStorageObjectManagerMoIdVStorageObjectDeleteSnapshotExTask", "summary": "Deletes a given snapshot of a VStorageObject.", "description": "Deletes a given snapshot of a VStorageObject.\n\nRequires Datastore.FileManagement privilege.\n\n***Since:*** vSphere API Release 8.0.2.0\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostVStorageObjectManagerMoIdVStorageObjectDeleteSnapshotExTask" }, "task": true }, { "name": "postHostVStorageObjectManagerMoIdHostDeleteVStorageObjectTask", "summary": "Delete a virtual storage object and its assoicated backings.", "description": "Delete a virtual storage object and its assoicated backings.\n\nRequires Datastore.FileManagement privilege on the datastore where the\nvirtual storage object is located.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostVStorageObjectManagerMoIdHostDeleteVStorageObjectTask" }, "task": true }, { "name": "postHostVStorageObjectManagerMoIdHostDeleteVStorageObjectExTask", "summary": "Delete a virtual storage object and its assoicated backings.", "description": "Delete a virtual storage object and its assoicated backings.\n\nRequires Datastore.FileManagement privilege on the datastore where the\nvirtual storage object is located.\n\n***Since:*** vSphere API Release 7.0.2.0\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostVStorageObjectManagerMoIdHostDeleteVStorageObjectExTask" }, "task": true }, { "name": "postHostVStorageObjectManagerMoIdHostExtendDiskTask", "summary": "Expand the capacity of a virtual disk, which is a storage object with\n*disk*, to the new\ncapacity.", "description": "Expand the capacity of a virtual disk, which is a storage object with\n*disk*, to the new\ncapacity.\n\nIf new capacity is smaller than current disk capacity, then\noperation fails due to invalid capacity. If new capacity is greater\nthan current disk capacity, then operation proceeds. If new capacity\nis equal to current disk ccapcity, then operation succeeds without\nany actual extension.\nThe extended disk region will be the same as the original disk:\n\\- For a zerothick disk, the extended disk region ...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostVStorageObjectManagerMoIdHostExtendDiskTask" }, "task": true }, { "name": "postHostVStorageObjectManagerMoIdVStorageObjectExtendDiskExTask", "summary": "Expand the capacity of a virtual disk, which is a storage object with\n*disk*, to the new\ncapacity.", "description": "Expand the capacity of a virtual disk, which is a storage object with\n*disk*, to the new\ncapacity.\n\nIf new capacity is smaller than current disk capacity, then\noperation fails due to invalid capacity. If new capacity is greater\nthan current disk capacity, then operation proceeds. If new capacity\nis equal to current disk ccapcity, then operation succeeds without\nany actual extension.\nThe extended disk region will be the same as the original disk:\n\\- For a zerothick disk, the extended disk region ...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostVStorageObjectManagerMoIdVStorageObjectExtendDiskExTask" }, "task": true }, { "name": "postHostVStorageObjectManagerMoIdHostInflateDiskTask", "summary": "Inflate a sparse or thin-provisioned virtual disk up to the full size.", "description": "Inflate a sparse or thin-provisioned virtual disk up to the full size.\n\nAdditional space allocated to the disk as a result of this operation\nwill be filled with zeroes.\n\nCurrently inflateDisk API only supports the following combinations:\nValid provisioning type: THIN;\nValid Datastore: VMFS, NFS.\nInflating a disk is not applicable for VVol/VSAN datastore.\n\nRequires Datastore.FileManagement privilege on the datastore where the\nvirtual storage object is located.\n\n***Required privileges:*** System.V...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostVStorageObjectManagerMoIdHostInflateDiskTask" }, "task": true }, { "name": "postHostVStorageObjectManagerMoIdHostListVStorageObject", "summary": "List all virtual storage objects located on a datastore.", "description": "List all virtual storage objects located on a datastore.\n\nRequires Datastore.FileManagement privilege on the datastore where the\nvirtual storage object is located.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostVStorageObjectManagerMoIdHostListVStorageObject" }, "task": true }, { "name": "postHostVStorageObjectManagerMoIdHostQueryVirtualDiskUuid", "summary": "Get the virtual disk UUID.", "description": "Get the virtual disk UUID.\n\n***Since:*** vSphere API Release 8.0.3.0\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostVStorageObjectManagerMoIdHostQueryVirtualDiskUuid" }, "task": true }, { "name": "postHostVStorageObjectManagerMoIdHostReconcileDatastoreInventoryTask", "summary": "Reconcile the datastore inventory info of virtual storage objects.", "description": "Reconcile the datastore inventory info of virtual storage objects.\n\nRequires Datastore.FileManagement privilege.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostVStorageObjectManagerMoIdHostReconcileDatastoreInventoryTask" }, "task": true }, { "name": "postHostVStorageObjectManagerMoIdHostRegisterDisk", "summary": "Promote a virtual disk to a First Class Disk.", "description": "Promote a virtual disk to a First Class Disk.\n\nRequires Datastore.FileManagement privilege on the datastore where the\nvirtual disk resides.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostVStorageObjectManagerMoIdHostRegisterDisk" }, "task": true }, { "name": "postHostVStorageObjectManagerMoIdHostRelocateVStorageObjectTask", "summary": "Relocate a virtual storage object.", "description": "Relocate a virtual storage object.\n\nRequires Datastore.FileManagement privilege on both source and\ndestination datastore.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostVStorageObjectManagerMoIdHostRelocateVStorageObjectTask" }, "task": true }, { "name": "postHostVStorageObjectManagerMoIdHostRenameVStorageObject", "summary": "Rename a virtual storage object.", "description": "Rename a virtual storage object.\n\nRequires Datastore.FileManagement privilege on the datastore where the\nvirtual storage object is located.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostVStorageObjectManagerMoIdHostRenameVStorageObject" }, "task": true }, { "name": "postHostVStorageObjectManagerMoIdRenameVStorageObjectEx", "summary": "Rename a virtual storage object.", "description": "Rename a virtual storage object.\n\n***Since:*** vSphere API Release 8.0.2.0\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostVStorageObjectManagerMoIdRenameVStorageObjectEx" }, "task": true }, { "name": "postHostVStorageObjectManagerMoIdHostVStorageObjectRetrieveSnapshotInfo", "summary": "Retrieves snapshot information of a given VStorageObject.", "description": "Retrieves snapshot information of a given VStorageObject.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostVStorageObjectManagerMoIdHostVStorageObjectRetrieveSnapshotInfo" }, "task": true }, { "name": "postHostVStorageObjectManagerMoIdHostRetrieveVStorageInfrastructureObjectPolicy", "summary": "Retrieve virtual storage infrastructure object SBPM policy on given\ndatastore.", "description": "Retrieve virtual storage infrastructure object SBPM policy on given\ndatastore.\n\nOnly support VSAN datastore.\n\nRequires Datastore.FileManagement privilege on the datastore specified.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostVStorageObjectManagerMoIdHostRetrieveVStorageInfrastructureObjectPolicy" }, "task": true }, { "name": "postHostVStorageObjectManagerMoIdHostRetrieveVStorageObject", "summary": "Retrieve a virtual storage object.", "description": "Retrieve a virtual storage object.\n\nRequires Datastore.FileManagement privilege on the datastore where the\nvirtual storage object is located.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostVStorageObjectManagerMoIdHostRetrieveVStorageObject" }, "task": true }, { "name": "postHostVStorageObjectManagerMoIdHostRetrieveVStorageObjectMetadata", "summary": "Retrieve metadata KV pairs from a virtual storage object.", "description": "Retrieve metadata KV pairs from a virtual storage object.\n\nRequires Datastore.FileManagement privilege on the datastore where the\nvirtual storage object is located.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostVStorageObjectManagerMoIdHostRetrieveVStorageObjectMetadata" }, "task": true }, { "name": "postHostVStorageObjectManagerMoIdHostRetrieveVStorageObjectMetadataValue", "summary": "Retrieve the metadata value by key from a virtual storage object.", "description": "Retrieve the metadata value by key from a virtual storage object.\n\nRequires Datastore.FileManagement privilege on the datastore where the\nvirtual storage object is located.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostVStorageObjectManagerMoIdHostRetrieveVStorageObjectMetadataValue" }, "task": true }, { "name": "postHostVStorageObjectManagerMoIdHostRetrieveVStorageObjectState", "summary": "Retrieve a virtual storage object state.", "description": "Retrieve a virtual storage object state.\n\nRequires Datastore.FileManagement privilege on the datastore where the\nvirtual storage object is located.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostVStorageObjectManagerMoIdHostRetrieveVStorageObjectState" }, "task": true }, { "name": "postHostVStorageObjectManagerMoIdRevertVStorageObjectExTask", "summary": "Reverts to a given snapshot of a VStorageObject.", "description": "Reverts to a given snapshot of a VStorageObject.\n\nThis operation is supported on detached VirtualDisks\nDuring revert all the snapshots which were taken after the specified\nsnapshot would get deleted.\n\nE.g. Consider Disk with 4 snapshots\n\nBaseDisk -> Snap-2 -> Snap-3 -> Snap-4 -> Running-Point\n\nIf user chooses to revert to snap-2 then snap-4 and snap-3 would also\nbe deleted. After revert operation disk would have below configuration:\n\nBaseDisk -> Snap-2 -> Running-Point\n\nRequire...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostVStorageObjectManagerMoIdRevertVStorageObjectExTask" }, "task": true }, { "name": "postHostVStorageObjectManagerMoIdHostScheduleReconcileDatastoreInventory", "summary": "Schedules reconcile of the datastore inventory info of virtual storage\nobjects.", "description": "Schedules reconcile of the datastore inventory info of virtual storage\nobjects.\n\nThis method just schedules the reconcile operation for the\nnearby future and returns. Note that since the reconcile operation will\nbe executed after this method already returns the success of this method\nshould not be considered as success of the actual reconcile operation.\n\nRequires Datastore.FileManagement privilege.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostVStorageObjectManagerMoIdHostScheduleReconcileDatastoreInventory" }, "task": true }, { "name": "postHostVStorageObjectManagerMoIdHostSetVStorageObjectControlFlags", "summary": "Set control flags on VStorageObject.", "description": "Set control flags on VStorageObject.\n\nThe control flags are defined in\n*vslmVStorageObjectControlFlag_enum*.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostVStorageObjectManagerMoIdHostSetVStorageObjectControlFlags" }, "task": true }, { "name": "postHostVStorageObjectManagerMoIdHostSetVirtualDiskUuidTask", "summary": "Set the virtual disk Uuid.", "description": "Set the virtual disk Uuid.\n\n***Since:*** vSphere API Release 8.0.3.0\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostVStorageObjectManagerMoIdHostSetVirtualDiskUuidTask" }, "task": true }, { "name": "postHostVStorageObjectManagerMoIdHostUpdateVStorageObjectMetadataTask", "summary": "Update metadata KV pairs to a virtual storage object.", "description": "Update metadata KV pairs to a virtual storage object.\n\nAnd this API is by\ndesign supposed to be used for all of the addition, modification and\ndeletion operations of metadata KV pairs.\n\nRequires Datastore.FileManagement privilege on the datastore where the\nvirtual storage object is located.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostVStorageObjectManagerMoIdHostUpdateVStorageObjectMetadataTask" }, "task": true }, { "name": "postHostVStorageObjectManagerMoIdHostUpdateVStorageObjectMetadataExTask", "summary": "Update metadata KV pairs to a virtual storage object.", "description": "Update metadata KV pairs to a virtual storage object.\n\nAnd this API is by\ndesign supposed to be used for all of the addition, modification and\ndeletion operations of metadata KV pairs.\n\nRequires Datastore.FileManagement privilege on the datastore where the\nvirtual storage object is located.\n\n***Since:*** vSphere API Release 7.0.2.0\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostVStorageObjectManagerMoIdHostUpdateVStorageObjectMetadataExTask" }, "task": true }, { "name": "postHostVirtualNicManagerMoIdDeselectVnicForNicType", "summary": "Deselect the VirtualNic to be a special type.", "description": "Deselect the VirtualNic to be a special type.\n\n***Required privileges:*** Host.Config.Network", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostVirtualNicManagerMoIdDeselectVnicForNicType" }, "task": true }, { "name": "postHostVirtualNicManagerMoIdQueryNetConfig", "summary": "Get the NetConfig for the specified nicType", "description": "Get the NetConfig for the specified nicType\n\n***Required privileges:*** System.Read", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostVirtualNicManagerMoIdQueryNetConfig" }, "task": true }, { "name": "postHostVirtualNicManagerMoIdSelectVnicForNicType", "summary": "Select the NicType of the VirtualNic.", "description": "Select the NicType of the VirtualNic.\n\nSelecting a device automatically\ndeselects the previous selection if *VirtualNicManagerNetConfig.multiSelectAllowed*\nis false for the specified nicType.\nElse, the device is added to the list of selected nics.\n\n***Required privileges:*** Host.Config.Network", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostVirtualNicManagerMoIdSelectVnicForNicType" }, "task": true }, { "name": "postHostVirtualNicManagerMoIdSetCustomValue", "summary": "Assigns a value to a custom field.", "description": "Assigns a value to a custom field.\n\nThe setCustomValue method requires\nwhichever updatePrivilege is defined as one of the\n*CustomFieldDef.fieldInstancePrivileges*\nfor the CustomFieldDef whose value is being changed.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostVirtualNicManagerMoIdSetCustomValue" }, "task": true }, { "name": "getHostVirtualNicManagerMoIdAvailableField", "summary": "List of custom field definitions that are valid for the object's type.", "description": "List of custom field definitions that are valid for the object's type.\n\nThe fields are sorted by *CustomFieldDef.name*.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostVirtualNicManagerMoIdAvailableField" }, "task": true }, { "name": "getHostVirtualNicManagerMoIdInfo", "summary": "Network configuration.", "description": "Network configuration.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostVirtualNicManagerMoIdInfo" }, "task": true }, { "name": "getHostVirtualNicManagerMoIdValue", "summary": "List of custom field values.", "description": "List of custom field values.\n\nEach value uses a key to associate\nan instance of a *CustomFieldStringValue* with\na custom field definition.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostVirtualNicManagerMoIdValue" }, "task": true }, { "name": "postHostVsanInternalSystemMoIdAbdicateDomOwnership", "summary": "Abdicate ownership of DOM objects.", "description": "Abdicate ownership of DOM objects.\n\nThe objects must be currently owned\nby this host. Which host has ownership of an object at a given point in\ntime can be queried from QueryVsanObjects() or QueryCmmds() APIs.\nAbidcating ownership tears down DOM owner in-memory state. Hosts in the\ncluster will then compete to become the new owner of the object, similar\nto a host failure event. There is a short interuption of IO flow while\nthe owner re-election is going on, but it is transparent to any consumers\n...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostVsanInternalSystemMoIdAbdicateDomOwnership" }, "task": true }, { "name": "postHostVsanInternalSystemMoIdCanProvisionObjects", "summary": "Determine if given objects can be provisioned.", "description": "Determine if given objects can be provisioned.\n\nDetermines if the objects\nof the given size can be provisioned with the given policies.\nThe API is intended to answer the question: can these objects be\nprovisioned with the given policy using the current cluster topology\n(#hosts and #disks) and does NOT take into account free space on the\ndisk, size of disks, etc. If the objects cannot be provisioned,\nthe API returns the reason for not being able to satisfy the policy.\nIf the objects can be provis...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostVsanInternalSystemMoIdCanProvisionObjects" }, "task": true }, { "name": "postHostVsanInternalSystemMoIdDeleteVsanObjects", "summary": "Delete VSAN objects.", "description": "Delete VSAN objects.\n\nThis API is internal and intended for troubleshooting/debugging only.\nWARNING: This API can be slow because we do IOs to all the objects.\nThis API can be used to delete VSAN objects. DOM won't allow access to\nobjects which have lost quorum. Such objects can be deleted with the\noptional \"force\" flag. These objects may however re-appear with quorum\nif the absent components come back (network partition gets resolved,\netc.)\n\n***Required privileges:*** Host.Config.Storage", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostVsanInternalSystemMoIdDeleteVsanObjects" }, "task": true }, { "name": "postHostVsanInternalSystemMoIdGetVsanObjExtAttrs", "summary": "Get VSAN object extended attributes.", "description": "Get VSAN object extended attributes.\n\nThis API is internal and intended for troubleshooting/debugging\nsituations in the field. WARNING: This API can be slow because we\ndo IOs (reads) to all the objects. This API can be used to get\nextended attributes of any object in the VSAN cluster from any host\nprovided the object is accessible from that host. In case of an error,\nwe return a dict with key \"Error\" for that object.\n\n***Required privileges:*** System.Read", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostVsanInternalSystemMoIdGetVsanObjExtAttrs" }, "task": true }, { "name": "postHostVsanInternalSystemMoIdQueryCmmds", "summary": "Query CMMDS directly.", "description": "Query CMMDS directly.\n\nThe list of given queries is executed and all\nresults are returned in a flat list. No attempt is made to de-dupe\nresults in the case of overlapping query results.\n\n***Required privileges:*** System.Read", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostVsanInternalSystemMoIdQueryCmmds" }, "task": true }, { "name": "postHostVsanInternalSystemMoIdQueryObjectsOnPhysicalVsanDisk", "summary": "Query DOM objects on a given set of physical disks.", "description": "Query DOM objects on a given set of physical disks.\n\nFinds all DOM objects\nthat have at least one component on the given physical disks. In order to\nmake this API efficient, the output of this API contains the found\nDOM\\_OBJECT, and referenced LSOM\\_OBJECT and DISK entries.\n\n***Required privileges:*** System.Read", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostVsanInternalSystemMoIdQueryObjectsOnPhysicalVsanDisk" }, "task": true }, { "name": "postHostVsanInternalSystemMoIdQueryPhysicalVsanDisks", "summary": "Query statistics about physical VSAN disks.", "description": "Query statistics about physical VSAN disks.\n\nUsing the props parameter the\ncaller can control which properties are returned. Requesting only the\nrequired properties is encouraged to reduce server load, response time\nand client load.\n\n***Required privileges:*** System.Read", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostVsanInternalSystemMoIdQueryPhysicalVsanDisks" }, "task": true }, { "name": "postHostVsanInternalSystemMoIdQuerySyncingVsanObjects", "summary": "Query information about VSAN DOM objects that are currently syncing data.", "description": "Query information about VSAN DOM objects that are currently syncing data.\n\nInstead of returning all objects, only such objects are returned that\nare currently resyncing any stale components or syncing fresh replicas.\nThe API returns the same output format as queryVsanObjects(). It\nretrieves information about syncing all objects, or retricts the\nsearch for syncing objects to the UUID list provided. In order to make\nthis API efficient, the output of this API contains the found\nDOM\\_OBJECT, and ref...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostVsanInternalSystemMoIdQuerySyncingVsanObjects" }, "task": true }, { "name": "postHostVsanInternalSystemMoIdQueryVsanObjectUuidsByFilter", "summary": "Query VSAN object UUIDs by filtering conditions.", "description": "Query VSAN object UUIDs by filtering conditions.\n\nThe API queries CMMDS by given filtering conditions (initially only for\nobject version) and return object UUID in an array with limited elements\ncount.\nIf caller specified the inputs objects UUID, then only these objects will\nbe checked for the filtering conditions, and return ones which satisfy\nthe filtering condition. In this case, the 'limit' parameter will be\nignored.\n\n***Required privileges:*** System.Read", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostVsanInternalSystemMoIdQueryVsanObjectUuidsByFilter" }, "task": true }, { "name": "postHostVsanInternalSystemMoIdQueryVsanObjects", "summary": "Query information about VSAN DOM objects.", "description": "Query information about VSAN DOM objects.\n\nRetrieves information about the\ngiven set of DOM object UUIDs. In order to make this API efficient, the\noutput of this API contains the found DOM\\_OBJECT, and referenced\nLSOM\\_OBJECT and DISK entries.\n\n***Required privileges:*** System.Read", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostVsanInternalSystemMoIdQueryVsanObjects" }, "task": true }, { "name": "postHostVsanInternalSystemMoIdQueryVsanStatistics", "summary": "Query VSAN system statistics.", "description": "Query VSAN system statistics.\n\nThis is a low level API that gathers low\nlevel statistic counters from the system. The details of the counters\nremain undocumented and unsupported at this point, and this API remains\ninternal.\nThe data for this API call mostly comes from VSI, but also other tools\nlike memstats.\nThe caller can control which counters are being retrieved by providing\na list of labels. The following labels are current supported:\n\\- TBD\n\n***Required privileges:*** System.Read", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostVsanInternalSystemMoIdQueryVsanStatistics" }, "task": true }, { "name": "postHostVsanInternalSystemMoIdReconfigurationSatisfiable", "summary": "Determine if the given objects can be reconfigured with the given\npolicies.", "description": "Determine if the given objects can be reconfigured with the given\npolicies.\n\nThe what-if determination only takes into account\nthe total number of hosts and total number\nof disks per host. The API is intended to answer the question: is\nthis reconfiguration possible using the current cluster topology\n(#hosts and #disks) and does NOT take into account free space on the\ndisk, size of disks, etc. If policy is not satisfiable, the API returns\nthe reason for not being able to satisfy the policy. If th...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostVsanInternalSystemMoIdReconfigurationSatisfiable" }, "task": true }, { "name": "postHostVsanInternalSystemMoIdReconfigureDomObject", "summary": "Reconfigure DOM object.", "description": "Reconfigure DOM object.\n\nTypically we expect VM centric APIs to be used\nfor setting storage policies, i.e. to use ReconfigVM() to change the\npolicy/profile of a namespace directory or virtual disk. This is a low\nlevel API to reconfigure any object known by UUID.\nThis API is internal and intended for troubleshooting/debugging\nsituations in the field.\n\n***Required privileges:*** Host.Config.Storage", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostVsanInternalSystemMoIdReconfigureDomObject" }, "task": true }, { "name": "postHostVsanInternalSystemMoIdRunVsanPhysicalDiskDiagnostics", "summary": "Runs diagnostics on VSAN physical disks.", "description": "Runs diagnostics on VSAN physical disks.\n\nThis method takes an active\napproach and creates a minimal and temporary object on each physical\nMD disk consumed by VSAN across the entire VSAN cluster. The temporary\nobjects are deleted right away upon completion of creation. The result\nreturns a list of all checked MDs, indicating wheather or not there was\na problem creating an object on that MD at the given point in time.\n\n***Required privileges:*** System.Read", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostVsanInternalSystemMoIdRunVsanPhysicalDiskDiagnostics" }, "task": true }, { "name": "postHostVsanInternalSystemMoIdUpgradeVsanObjects", "summary": "Upgrade VSAN objects version.", "description": "Upgrade VSAN objects version.\n\nUpgrade a set of objects' version to new one in batch mode.\nAPI caller should limit the size of the inputs array, and suggested\narray size is 500 ~ 1000 initially. (The API will give more realistic\nsuggestion after more experiments, then will apply hard limits in future)\n\n***Required privileges:*** Host.Config.Storage", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostVsanInternalSystemMoIdUpgradeVsanObjects" }, "task": true }, { "name": "postHostVsanSystemMoIdAddDisksTask", "summary": "Add the set of given disks for use by the VSAN service on this host.", "description": "Add the set of given disks for use by the VSAN service on this host.\n\nUsers may use this API to manually add disks for use by VSAN, without\nspecifying an explicit *VsanHostDiskMapping*, when the VSAN service\nnot configured to automatically claim storage. Any ineligible disk in\nthe set of given disks and disks which would have exceeded\nthe capacity will be ignored and will not be published in\nreturned *TaskInfo.result*.\n\nMount a *VsanHostDiskMapping* if the specified disk belongs to the\nunmounted...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostVsanSystemMoIdAddDisksTask" }, "task": true }, { "name": "postHostVsanSystemMoIdEvacuateVsanNodeTask", "summary": "Evacuate this host from VSAN cluster.", "description": "Evacuate this host from VSAN cluster.\n\nThe task is cancellable.\n\n***Required privileges:*** Host.Config.Storage", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostVsanSystemMoIdEvacuateVsanNodeTask" }, "task": true }, { "name": "postHostVsanSystemMoIdInitializeDisksTask", "summary": "Initialize and use the sets of disks in the given *VsanHostDiskMapping*\nlist for the VSAN service o", "description": "Initialize and use the sets of disks in the given *VsanHostDiskMapping*\nlist for the VSAN service on this host.\n\nUsers may use this API to specify or\nchange disk mappings when the VSAN service is not configured to\nautomatically claim storage. For appending new non-SSDs to an existing\n*VsanHostDiskMapping*, users need to specify only the new non-SSDs\nwith its *VsanHostDiskMapping.ssd*.\n\nMount a *VsanHostDiskMapping* if the specified\n*VsanHostDiskMapping* is not mounted in this host.\n\nUpon success...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostVsanSystemMoIdInitializeDisksTask" }, "task": true }, { "name": "postHostVsanSystemMoIdQueryDisksForVsan", "summary": "Queries disks on this host for suitability to use with the VSAN service,\nand returns the result.", "description": "Queries disks on this host for suitability to use with the VSAN service,\nand returns the result.\n\nSee also *ScsiLun.canonicalName*.\n\n***Required privileges:*** System.Read", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostVsanSystemMoIdQueryDisksForVsan" }, "task": true }, { "name": "postHostVsanSystemMoIdQueryHostStatus", "summary": "Queries this host's current runtime status for the VSAN service.", "description": "Queries this host's current runtime status for the VSAN service.\n\n***Required privileges:*** System.Read", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postHostVsanSystemMoIdQueryHostStatus" }, "task": true }, { "name": "postHostVsanSystemMoIdRecommissionVsanNodeTask", "summary": "Recommission this host to VSAN cluster.", "description": "Recommission this host to VSAN cluster.\n\nUsers may use this API to recommission a node that has been\nevacuated in *VsanHostDecommissionMode*.\n\nSee also *HostVsanSystem.EvacuateVsanNode_Task*, *VsanHostDecommissionMode*.\n\n***Required privileges:*** Host.Config.Storage", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postHostVsanSystemMoIdRecommissionVsanNodeTask" }, "task": true }, { "name": "postHostVsanSystemMoIdRemoveDiskTask", "summary": "Remove the set of given disks from use by the VSAN service on this host.", "description": "Remove the set of given disks from use by the VSAN service on this host.\n\nUsers\nmay use this API to manually remove a *VsanHostDiskMapping.nonSsd*\nfrom a *VsanHostDiskMapping*. This operation is only permitted if the\nVSAN service on this host is not configured to automatically claim storage.\n\nThe task is cancellable.\n\nThis method may not be used to remove the last\n*VsanHostDiskMapping.nonSsd* from any given\n*VsanHostDiskMapping*. Removal of the last\n*VsanHostDiskMapping.nonSsd* can be accomplish...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostVsanSystemMoIdRemoveDiskTask" }, "task": true }, { "name": "postHostVsanSystemMoIdRemoveDiskMappingTask", "summary": "Delete given set of disk mappings from use by the VSAN service on this host.", "description": "Delete given set of disk mappings from use by the VSAN service on this host.\n\nThis API may be used to remove all disks in a given mapping, including its\n*VsanHostDiskMapping.ssd*. This operation is only permitted\nif the VSAN service on this host is not configured to automatically\nclaim storage.\n\nThe task is cancellable.\n\nUpon successful completion of the returned *Task*, its\n*TaskInfo.result* field will be populated with an empty\n*VsanHostDiskMapResult*\\[\\]. If any errors are encountered,\nthe re...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostVsanSystemMoIdRemoveDiskMappingTask" }, "task": true }, { "name": "postHostVsanSystemMoIdUnmountDiskMappingTask", "summary": "Unmount the mounted *VsanHostDiskMapping*.", "description": "Unmount the mounted *VsanHostDiskMapping*.\n\nAn unmounted volume cannot\nbe used for any VSAN operations. In contrast to *HostVsanSystem.RemoveDiskMapping_Task*,\nthis operation does not destroy or alter VSAN data on the disks.\n*HostVsanSystem.AddDisks_Task* and *HostVsanSystem.InitializeDisks_Task* can be used to\nre-mount the diskMapping.\n\nIn case of shared-SAS, where diskMappings are visible to more than one VSAN hosts,\nUsers may use this API to manually unmount and re-mount diskMappings.\n\nUpon s...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostVsanSystemMoIdUnmountDiskMappingTask" }, "task": true }, { "name": "postHostVsanSystemMoIdUpdateVsanTask", "summary": "Update the VSAN service on this host according to the given host\nconfiguration specification.", "description": "Update the VSAN service on this host according to the given host\nconfiguration specification.\n\nEnabling and disabling the VSAN service can be achieved by using\nthe *VsanHostConfigInfo.enabled* flag.\nHost storage settings can be specified through use of\n*VsanHostConfigInfo.storageInfo*. If this value is omitted,\nchanges will not be made to the existing storage configuration.\nHost cluster settings can be specified through use of\n*VsanHostConfigInfo.clusterInfo*. If this value is omitted,\nchanges w...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHostVsanSystemMoIdUpdateVsanTask" }, "task": true }, { "name": "getHostVsanSystemMoIdConfig", "summary": "The current VSAN service configuration information for this host.", "description": "The current VSAN service configuration information for this host.\n\n***Required privileges:*** System.Read", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHostVsanSystemMoIdConfig" }, "task": true }, { "name": "postHttpNfcLeaseMoIdHttpNfcLeaseAbort", "summary": "Aborts the import/export and releases this lease.", "description": "Aborts the import/export and releases this lease.\n\nOperations on the\nobjects contained in this lease will no longer be blocked. After\ncalling this method, this lease will no longer be valid.\n\nClients should call this method if an error occurs while accessing\nthe disks, or if the operation is cancelled. The client can report\nthe cause of the abort to other clients listening on the task with\nthe fault parameter.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHttpNfcLeaseMoIdHttpNfcLeaseAbort" }, "task": true }, { "name": "postHttpNfcLeaseMoIdHttpNfcLeaseComplete", "summary": "Completes the import/export and releases this lease.", "description": "Completes the import/export and releases this lease.\n\nOperations on\nthe objects contained in this lease will no longer be blocked. After\ncalling this method, this lease will no longer be valid.\n\nClients should call this method when they are done accessing the\ndisks for the *VirtualMachine*s in this lease. The status\nof the corresponding task will be set to success.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postHttpNfcLeaseMoIdHttpNfcLeaseComplete" }, "task": true }, { "name": "postHttpNfcLeaseMoIdHttpNfcLeaseGetManifest", "summary": "Gets the download manifest for this lease.", "description": "Gets the download manifest for this lease.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postHttpNfcLeaseMoIdHttpNfcLeaseGetManifest" }, "task": true }, { "name": "postHttpNfcLeaseMoIdHttpNfcLeaseProbeUrls", "summary": "Perform a series of validations on the target host to see if\nit can succesfully perform PullFromUrl", "description": "Perform a series of validations on the target host to see if\nit can succesfully perform PullFromUrls.\n\n***Since:*** vSphere API Release 7.0.2.0", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHttpNfcLeaseMoIdHttpNfcLeaseProbeUrls" }, "task": true }, { "name": "postHttpNfcLeaseMoIdHttpNfcLeaseProgress", "summary": "Sets the disk up/download progress, and renews this lease.", "description": "Sets the disk up/download progress, and renews this lease.\n\nA lease\nwill time out automatically after a while. If the client wishes to\ncontinue using it, for example if it is not done accessing the\ndisks, this method must be called periodically.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHttpNfcLeaseMoIdHttpNfcLeaseProgress" }, "task": true }, { "name": "postHttpNfcLeaseMoIdHttpNfcLeasePullFromUrlsTask", "summary": "Upgrades current lease from push to pull mode.", "description": "Upgrades current lease from push to pull mode.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHttpNfcLeaseMoIdHttpNfcLeasePullFromUrlsTask" }, "task": true }, { "name": "postHttpNfcLeaseMoIdHttpNfcLeaseSetManifestChecksumType", "summary": "Sets desired checksum algorithm per each file that will be returned in\nManifestEntry.", "description": "Sets desired checksum algorithm per each file that will be returned in\nManifestEntry.\n\nShould be set before any transfer starts.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postHttpNfcLeaseMoIdHttpNfcLeaseSetManifestChecksumType" }, "task": true }, { "name": "getHttpNfcLeaseMoIdCapabilities", "summary": "Current supported capabilities by this lease\nSee *HttpNfcLeaseCapabilities*", "description": "Current supported capabilities by this lease\nSee *HttpNfcLeaseCapabilities*", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHttpNfcLeaseMoIdCapabilities" }, "task": true }, { "name": "getHttpNfcLeaseMoIdError", "summary": "If the lease is in the error state, this property contains the\nerror that caused the lease to be ab", "description": "If the lease is in the error state, this property contains the\nerror that caused the lease to be aborted.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHttpNfcLeaseMoIdError" }, "task": true }, { "name": "getHttpNfcLeaseMoIdInfo", "summary": "Provides information on the objects contained in this lease.", "description": "Provides information on the objects contained in this lease.\n\nThe\ninfo property is only valid when the lease is in the ready state.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHttpNfcLeaseMoIdInfo" }, "task": true }, { "name": "getHttpNfcLeaseMoIdInitializeProgress", "summary": "Provides progress information (0-100 percent) for the initializing state\nof the lease.", "description": "Provides progress information (0-100 percent) for the initializing state\nof the lease.\n\nClients can use this to track overall progress.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHttpNfcLeaseMoIdInitializeProgress" }, "task": true }, { "name": "getHttpNfcLeaseMoIdMode", "summary": "Current mode of the lease.", "description": "Current mode of the lease.\n\nSee *HttpNfcLeaseMode_enum* for possible values.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHttpNfcLeaseMoIdMode" }, "task": true }, { "name": "getHttpNfcLeaseMoIdState", "summary": "The current state of the lease.", "description": "The current state of the lease.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHttpNfcLeaseMoIdState" }, "task": true }, { "name": "getHttpNfcLeaseMoIdTransferProgress", "summary": "Provides progress information (0-100 percent) for current transfer.", "description": "Provides progress information (0-100 percent) for current transfer.\n\nTransfer covers download, upload and pull scenario.\nCan be externally updated by progress method.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getHttpNfcLeaseMoIdTransferProgress" }, "task": true }, { "name": "postInventoryViewMoIdCloseInventoryViewFolder", "summary": "Notify the server that folder(s) have been closed, and changes for all\nits contained objects should", "description": "Notify the server that folder(s) have been closed, and changes for all\nits contained objects should no longer be sent.\n\nThe associated child\nobjects are removed from the view. The containers themselves\nwill still be retained as open objects until their parent is closed.\n\nMay partially succeed if some entities could not be resolved. The operation\nwill still succeed for all entities that could be resolved, and the\nlist of those that failed is returned as the result.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postInventoryViewMoIdCloseInventoryViewFolder" }, "task": true }, { "name": "postInventoryViewMoIdDestroyView", "summary": "Destroy this view.", "description": "Destroy this view.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postInventoryViewMoIdDestroyView" }, "task": true }, { "name": "postInventoryViewMoIdOpenInventoryViewFolder", "summary": "Adds the child objects of a given managed entity to the view.", "description": "Adds the child objects of a given managed entity to the view.\n\nIf a *Datacenter* is returned as a child, the implicit virtual machine folder and\nhost folder objects are also returned. If a *ComputeResource* is returned,\nthe implicit root *ResourcePool* and *HostSystem* objects are also returned.\n\nMay partially succeed if some entities could not be resolved. The operation\nwill still succeed for all entities which could be resolved, and the\nlist of those which failed is returned as the result.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postInventoryViewMoIdOpenInventoryViewFolder" }, "task": true }, { "name": "getInventoryViewMoIdView", "summary": "The list of references to objects mapped by this view.", "description": "The list of references to objects mapped by this view.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getInventoryViewMoIdView" }, "task": true }, { "name": "postIoFilterManagerMoIdInstallIoFilterTask", "summary": "Install an IO Filter on a compute resource.", "description": "Install an IO Filter on a compute resource.\n\nIO Filters can only be installed on a cluster.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postIoFilterManagerMoIdInstallIoFilterTask" }, "task": true }, { "name": "postIoFilterManagerMoIdQueryDisksUsingFilter", "summary": "Return the list of virtual disks that use an IO Filter installed on\na compute resource.", "description": "Return the list of virtual disks that use an IO Filter installed on\na compute resource.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postIoFilterManagerMoIdQueryDisksUsingFilter" }, "task": true }, { "name": "postIoFilterManagerMoIdQueryIoFilterInfo", "summary": "Return the information for the IO Filters that are installed on the cluster.", "description": "Return the information for the IO Filters that are installed on the cluster.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postIoFilterManagerMoIdQueryIoFilterInfo" }, "task": true }, { "name": "postIoFilterManagerMoIdQueryIoFilterIssues", "summary": "Return the issues that occurred during the last installation/uninstallation/upgrade\noperation of an", "description": "Return the issues that occurred during the last installation/uninstallation/upgrade\noperation of an IO Filter on a compute resource.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postIoFilterManagerMoIdQueryIoFilterIssues" }, "task": true }, { "name": "postIoFilterManagerMoIdResolveInstallationErrorsOnClusterTask", "summary": "Resolve the errors occurred during an installation/uninstallation/upgrade\noperation of an IO Filter", "description": "Resolve the errors occurred during an installation/uninstallation/upgrade\noperation of an IO Filter on a cluster.\n\nDepending on the nature of the installation failure, vCenter will take the\nappropriate actions to resolve it. For example, retry or resume\ninstallation.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postIoFilterManagerMoIdResolveInstallationErrorsOnClusterTask" }, "task": true }, { "name": "postIoFilterManagerMoIdResolveInstallationErrorsOnHostTask", "summary": "Resolve the errors occurred during an installation/uninstallation/upgrade\noperation of an IO Filter", "description": "Resolve the errors occurred during an installation/uninstallation/upgrade\noperation of an IO Filter on a host.\n\nDepending on the nature of the installation failure, vCenter will take the\nappropriate actions to resolve it. For example, retry or resume\ninstallation.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postIoFilterManagerMoIdResolveInstallationErrorsOnHostTask" }, "task": true }, { "name": "postIoFilterManagerMoIdUninstallIoFilterTask", "summary": "Uninstall an IO Filter from a compute resource.", "description": "Uninstall an IO Filter from a compute resource.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postIoFilterManagerMoIdUninstallIoFilterTask" }, "task": true }, { "name": "postIoFilterManagerMoIdUpgradeIoFilterTask", "summary": "Upgrade an IO Filter on a compute resource.", "description": "Upgrade an IO Filter on a compute resource.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postIoFilterManagerMoIdUpgradeIoFilterTask" }, "task": true }, { "name": "postIpPoolManagerMoIdAllocateIpv4Address", "summary": "Allocates an IPv4 address from an IP pool.", "description": "Allocates an IPv4 address from an IP pool.\n\nAllocated IP addresses are reserved in the IP pool until released by\ncalling *IpPoolManager.ReleaseIpAllocation*, or until the IP pool is configured to\nhave an IP range that does not contain the IP address, or until the IP\npool is destroyed.\n\nThe caller must be a vCenter extension. Refer to *ExtensionManager*\nfor details on vCenter extensions.\n\nThe caller specifies a per extension unique allocation ID. Calling this\nfunction twice with the same allocati...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postIpPoolManagerMoIdAllocateIpv4Address" }, "task": true }, { "name": "postIpPoolManagerMoIdAllocateIpv6Address", "summary": "Allocates an IPv6 address from an IP pool.", "description": "Allocates an IPv6 address from an IP pool.\n\nAllocated IP addresses are reserved in the IP pool until released by\ncalling *IpPoolManager.ReleaseIpAllocation*, or until the IP pool is configured to\nhave an IP range that does not contain the IP address, or until the IP\npool is destroyed.\n\nThe caller must be a vCenter extension. Refer to *ExtensionManager*\nfor details on vCenter extensions.\n\nThe caller specifies a per extension unique allocation ID. Calling this\nfunction twice with the same allocati...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postIpPoolManagerMoIdAllocateIpv6Address" }, "task": true }, { "name": "postIpPoolManagerMoIdCreateIpPool", "summary": "Create a new IP pool.", "description": "Create a new IP pool.\n\nThe name field must be defined, all other fields are optional. If unset,\nthey will be given default values.\n\nThe ID for the pool is generated by the server and should not be defined on the\npool object passed to this method.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postIpPoolManagerMoIdCreateIpPool" }, "task": true }, { "name": "postIpPoolManagerMoIdDestroyIpPool", "summary": "Destroys an IP pool on the given datacenter.", "description": "Destroys an IP pool on the given datacenter.\n\nLooks up the pool on the datacenter by ID and deletes it. If the pool is in use,\nthe method throws InvalidState unless the force flag is true.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postIpPoolManagerMoIdDestroyIpPool" }, "task": true }, { "name": "postIpPoolManagerMoIdQueryIPAllocations", "summary": "Query IP allocations by IP pool and extension key.", "description": "Query IP allocations by IP pool and extension key.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postIpPoolManagerMoIdQueryIPAllocations" }, "task": true }, { "name": "postIpPoolManagerMoIdQueryIpPools", "summary": "Return the list of IP pools for a datacenter.", "description": "Return the list of IP pools for a datacenter.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postIpPoolManagerMoIdQueryIpPools" }, "task": true }, { "name": "postIpPoolManagerMoIdReleaseIpAllocation", "summary": "Releases an IP allocation back to it's IP pool.", "description": "Releases an IP allocation back to it's IP pool.\n\nAttempting to release an IP allocation that is not allocated from the\nspecified IP pool with the specified allocation ID silently fails. This\nmakes it possible to release IP allocations idempotently.\n\nAll IP addresses allocated by an extension are automatically released\nif the extension is unregistered from vCenter.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postIpPoolManagerMoIdReleaseIpAllocation" }, "task": true }, { "name": "postIpPoolManagerMoIdUpdateIpPool", "summary": "Update an IP pool on a datacenter.", "description": "Update an IP pool on a datacenter.\n\nThe pool to update is looked up from the value of the id field.\n\nAll fields in the pool except the id are optional. Only defined values are stored\non the server.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postIpPoolManagerMoIdUpdateIpPool" }, "task": true }, { "name": "postIscsiManagerMoIdBindVnic", "summary": "Bind a Virtual NIC to be used for an iSCSI adapter", "description": "Bind a Virtual NIC to be used for an iSCSI adapter\n\n***Required privileges:*** Host.Config.Storage", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postIscsiManagerMoIdBindVnic" }, "task": true }, { "name": "postIscsiManagerMoIdQueryBoundVnics", "summary": "Query the list of Virtual NICs that are bound to a given iSCSI HBA.", "description": "Query the list of Virtual NICs that are bound to a given iSCSI HBA.\n\n***Required privileges:*** Host.Config.Storage", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postIscsiManagerMoIdQueryBoundVnics" }, "task": true }, { "name": "postIscsiManagerMoIdQueryCandidateNics", "summary": "Query the candidate Virtual NICs and Physical NICs that can be used\nfor Port-Binding.", "description": "Query the candidate Virtual NICs and Physical NICs that can be used\nfor Port-Binding.\n\nFor dependent offload adapters, the Virtual NIC should be attached\nto the physical NIC associated with the hardware function.\n\n***Required privileges:*** Host.Config.Storage", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postIscsiManagerMoIdQueryCandidateNics" }, "task": true }, { "name": "postIscsiManagerMoIdQueryMigrationDependencies", "summary": "Query the dependency table for a migration operation of a given Physical\nNIC.", "description": "Query the dependency table for a migration operation of a given Physical\nNIC.\n\n***Required privileges:*** Host.Config.Storage", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postIscsiManagerMoIdQueryMigrationDependencies" }, "task": true }, { "name": "postIscsiManagerMoIdQueryPnicStatus", "summary": "Query if Physical NIC device is used for iSCSI.", "description": "Query if Physical NIC device is used for iSCSI.\n\n***Required privileges:*** Host.Config.Storage", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postIscsiManagerMoIdQueryPnicStatus" }, "task": true }, { "name": "postIscsiManagerMoIdQueryVnicStatus", "summary": "Query the status of Virtual NIC association with the iSCSI.", "description": "Query the status of Virtual NIC association with the iSCSI.\n\n***Required privileges:*** Host.Config.Storage", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postIscsiManagerMoIdQueryVnicStatus" }, "task": true }, { "name": "postIscsiManagerMoIdUnbindVnic", "summary": "Unbind Virtual NIC binding from an iSCSI adapter.", "description": "Unbind Virtual NIC binding from an iSCSI adapter.\n\n***Required privileges:*** Host.Config.Storage", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postIscsiManagerMoIdUnbindVnic" }, "task": true }, { "name": "postLicenseAssignmentManagerMoIdQueryAssignedLicenses", "summary": "Get information about all the licenses associated with an entity", "description": "Get information about all the licenses associated with an entity\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postLicenseAssignmentManagerMoIdQueryAssignedLicenses" }, "task": true }, { "name": "postLicenseAssignmentManagerMoIdRemoveAssignedLicense", "summary": "Remove licenses associated with an entity", "description": "Remove licenses associated with an entity\n\n***Required privileges:*** Global.Licenses", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postLicenseAssignmentManagerMoIdRemoveAssignedLicense" }, "task": true }, { "name": "postLicenseAssignmentManagerMoIdUpdateAssignedLicense", "summary": "Update the license associated with an entity", "description": "Update the license associated with an entity\n\n***Required privileges:*** Global.Licenses", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postLicenseAssignmentManagerMoIdUpdateAssignedLicense" }, "task": true }, { "name": "postLicenseManagerMoIdAddLicense", "summary": "Adds a license to the inventory of available licenses.", "description": "Adds a license to the inventory of available licenses.\n\n***Required privileges:*** Global.Licenses", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postLicenseManagerMoIdAddLicense" }, "task": true }, { "name": "postLicenseManagerMoIdCheckLicenseFeature", "summary": "Returns whether or not a given feature is enabled.", "description": "Deprecated as of vSphere API 4.0, use\n*LicenseAssignmentManager.QueryAssignedLicenses* instead.\n\nReturns whether or not a given feature is enabled.\n\n***Required privileges:*** System.Read", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postLicenseManagerMoIdCheckLicenseFeature" }, "task": true }, { "name": "postLicenseManagerMoIdConfigureLicenseSource", "summary": "Allows for reconfiguration of the License Manager license source.", "description": "Deprecated as of vSphere API 4.0, use *LicenseManager.UpdateLicense*\ninstead.\n\nAllows for reconfiguration of the License Manager license source.\n\nThis changes the licensing source to be either served or local. Before changing\nthe license source location, the API checks the number of licenses available at\nthe new potential source to ensure there are at least as many licenses there as\nhave been issued by the current source. If there are an equal or greater number of\nlicenses at the new source, all...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postLicenseManagerMoIdConfigureLicenseSource" }, "task": true }, { "name": "postLicenseManagerMoIdDecodeLicense", "summary": "Decodes licensing information on the license specified.", "description": "Decodes licensing information on the license specified.\n\n***Required privileges:*** Global.Licenses", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postLicenseManagerMoIdDecodeLicense" }, "task": true }, { "name": "postLicenseManagerMoIdDisableFeature", "summary": "Release licenses for an optional feature.", "description": "Deprecated as of vSphere API 4.0, use\n*LicenseAssignmentManager.RemoveAssignedLicense* instead.\n\nRelease licenses for an optional feature.\n\n***Required privileges:*** Global.Licenses", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postLicenseManagerMoIdDisableFeature" }, "task": true }, { "name": "postLicenseManagerMoIdEnableFeature", "summary": "Enable a feature that has an optional state.", "description": "Deprecated as of vSphere API 4.0, use\n*LicenseAssignmentManager.UpdateAssignedLicense* instead.\n\nEnable a feature that has an optional state.\n\n***Required privileges:*** Global.Licenses", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postLicenseManagerMoIdEnableFeature" }, "task": true }, { "name": "postLicenseManagerMoIdQueryLicenseSourceAvailability", "summary": "Queries the current license source for total and available licenses available for\neach feature know", "description": "Deprecated as of vSphere API 4.0, use\n*LicenseAssignmentManager.QueryAssignedLicenses* instead.\n\nQueries the current license source for total and available licenses available for\neach feature known to this system.\n\n***Required privileges:*** Global.Licenses", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postLicenseManagerMoIdQueryLicenseSourceAvailability" }, "task": true }, { "name": "postLicenseManagerMoIdQuerySupportedFeatures", "summary": "Queries the current license source for a list of available licenses that can be\nlicensed from this", "description": "Deprecated as of vSphere API 4.0, use\n*LicenseAssignmentManager.QueryAssignedLicenses* instead.\n\nQueries the current license source for a list of available licenses that can be\nlicensed from this system.\n\n***Required privileges:*** Global.Licenses", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postLicenseManagerMoIdQuerySupportedFeatures" }, "task": true }, { "name": "postLicenseManagerMoIdQueryLicenseUsage", "summary": "Returns the license usage.", "description": "Deprecated as of vSphere API 4.0, use\n*LicenseAssignmentManager.QueryAssignedLicenses* instead.\n\nReturns the license usage.\n\nThe license usage is a list of supported features and\nthe number of licenses that have been reserved.\n\n**PLATFORM Specific Notes:**\nVirtualCenter - Empty string returns the usage of non-host specific features.\nMust specify managed host to query.\nESX Server - Host argument ignored.\n\n***Required privileges:*** System.Read", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postLicenseManagerMoIdQueryLicenseUsage" }, "task": true }, { "name": "postLicenseManagerMoIdRemoveLicenseLabel", "summary": "Removed a license's label.", "description": "Removed a license's label.\n\n***Required privileges:*** Global.Licenses", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postLicenseManagerMoIdRemoveLicenseLabel" }, "task": true }, { "name": "postLicenseManagerMoIdRemoveLicense", "summary": "Remove license from the available set.", "description": "Remove license from the available set.\n\n***Required privileges:*** Global.Licenses", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postLicenseManagerMoIdRemoveLicense" }, "task": true }, { "name": "postLicenseManagerMoIdSetLicenseEdition", "summary": "Defines the product's license edition.", "description": "Deprecated as of vSphere API 4.0, use\n*LicenseAssignmentManager.QueryAssignedLicenses* instead.\n\nDefines the product's license edition.\n\nThe edition defines which product license\nthe server requires. This, in turn, determines the core set of functionality\nprovided by the product and the additional features that can be licensed.\n\nTo determine what featureKey the current platform will accept, use\nquerySourceAvailablity() at runtime, or consult the documentation for the\ncurrent platform.\n\n***Requir...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postLicenseManagerMoIdSetLicenseEdition" }, "task": true }, { "name": "postLicenseManagerMoIdUpdateLicenseLabel", "summary": "Update a license's label.", "description": "Update a license's label.\n\nIt creates a label entry if the labelKey doesn't already exist\n\n***Required privileges:*** Global.Licenses", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postLicenseManagerMoIdUpdateLicenseLabel" }, "task": true }, { "name": "postLicenseManagerMoIdUpdateLicense", "summary": "Updates the available licenses to the one provided in licenseKey.", "description": "Updates the available licenses to the one provided in licenseKey.\n\nThis is the same as removing all the licenses using\n*LicenseManager.RemoveLicense* and adding licenseKey using\n*LicenseManager.AddLicense*\nIf the optional parameter labels is specify this is the same as calling\nupdateLicense without the optioal parameter and calling updateLabel for each pair\nin the labels array.\n\n***Required privileges:*** Global.Licenses", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postLicenseManagerMoIdUpdateLicense" }, "task": true }, { "name": "getLicenseManagerMoIdDiagnostics", "summary": "Return current diagnostic information.", "description": "Deprecated as of vSphere API 4.0, this property is not used by the system.\n\nReturn current diagnostic information.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getLicenseManagerMoIdDiagnostics" }, "task": true }, { "name": "getLicenseManagerMoIdEvaluation", "summary": "***Required privileges:*** System.Read", "description": "***Required privileges:*** System.Read", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getLicenseManagerMoIdEvaluation" }, "task": true }, { "name": "getLicenseManagerMoIdFeatureInfo", "summary": "The list of features that can be licensed.", "description": "Deprecated as of VI API 2.5, use *LicenseManager.QuerySupportedFeatures*\ninstead.\n\nThe list of features that can be licensed.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getLicenseManagerMoIdFeatureInfo" }, "task": true }, { "name": "getLicenseManagerMoIdLicenseAssignmentManager", "summary": "License Assignment Manager", "description": "License Assignment Manager\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getLicenseManagerMoIdLicenseAssignmentManager" }, "task": true }, { "name": "getLicenseManagerMoIdLicensedEdition", "summary": "The product's license edition.", "description": "Deprecated as of vSphere API 4.0, use\n*LicenseAssignmentManager.QueryAssignedLicenses* instead.\n\nThe product's license edition.\n\nThe edition defines which product license\nthe server requires. This, in turn, determines the core set of functionalities\nprovided by the product and the additional features that can be licensed. If\nno edition is set the property is set to the empty string (\"\").\nTo set the edition use *LicenseManager.SetLicenseEdition*.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getLicenseManagerMoIdLicensedEdition" }, "task": true }, { "name": "getLicenseManagerMoIdLicenses", "summary": "Get information about all the licenses available.", "description": "Get information about all the licenses available.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getLicenseManagerMoIdLicenses" }, "task": true }, { "name": "getLicenseManagerMoIdSource", "summary": "Set or return a data object type of LocalLicense or LicenseServer.", "description": "Deprecated as of vSphere API 4.0, use\n*LicenseAssignmentManager.QueryAssignedLicenses* to get evaluation information.\n\nSet or return a data object type of LocalLicense or LicenseServer.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getLicenseManagerMoIdSource" }, "task": true }, { "name": "getLicenseManagerMoIdSourceAvailable", "summary": "Current state of the license source.", "description": "Deprecated as of vSphere API 4.0, this property is not used.\n\nCurrent state of the license source.\n\nLicense sources that are LocalSource\nare always available.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getLicenseManagerMoIdSourceAvailable" }, "task": true }, { "name": "postListViewMoIdDestroyView", "summary": "Destroy this view.", "description": "Destroy this view.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postListViewMoIdDestroyView" }, "task": true }, { "name": "postListViewMoIdModifyListView", "summary": "Modify the list by giving a delta of entities to add and\nentities to remove.", "description": "Modify the list by giving a delta of entities to add and\nentities to remove.\n\nMay partially succeed if some objects could not be resolved. The operation\nwill still succeed for all objects which could be resolved, and the\nlist of those which failed is returned as the result.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postListViewMoIdModifyListView" }, "task": true }, { "name": "postListViewMoIdResetListView", "summary": "Replaces the list with an entirely new set of objects.", "description": "Replaces the list with an entirely new set of objects.\n\nIf\nthe entire set is changing, this is less data to send than a delta.\n\nMay partially succeed if some objects could not be resolved. The operation\nwill still succeed for all objects which could be resolved, and the\nlist of those which failed is as the result.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postListViewMoIdResetListView" }, "task": true }, { "name": "postListViewMoIdResetListViewFromView", "summary": "Replaces the list with the set of objects in a given view.", "description": "Replaces the list with the set of objects in a given view.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postListViewMoIdResetListViewFromView" }, "task": true }, { "name": "getListViewMoIdView", "summary": "The list of references to objects mapped by this view.", "description": "The list of references to objects mapped by this view.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getListViewMoIdView" }, "task": true }, { "name": "getLocalizationManagerMoIdCatalog", "summary": "Fetches the descriptions of all the client-side localization message\ncatalogs available for the cur", "description": "Fetches the descriptions of all the client-side localization message\ncatalogs available for the current session locale.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getLocalizationManagerMoIdCatalog" }, "task": true }, { "name": "postManagedEntityMoIdDestroyTask", "summary": "Destroys this object, deleting its contents and removing it from its parent\nfolder (if any).", "description": "Destroys this object, deleting its contents and removing it from its parent\nfolder (if any).\n\nNOTE: The appropriate privilege must be held on the parent of the destroyed\nentity as well as the entity itself.\nThis method can throw one of several exceptions. The exact set of exceptions\ndepends on the kind of entity that is being removed. See comments for\neach entity for more information on destroy behavior.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postManagedEntityMoIdDestroyTask" }, "task": true }, { "name": "postManagedEntityMoIdReload", "summary": "Reload the entity state.", "description": "Reload the entity state.\n\nClients only need to call this method\nif they changed some external state that affects the service\nwithout using the Web service interface to perform the change.\nFor example, hand-editing a virtual machine configuration file\naffects the configuration of the associated virtual machine but\nthe service managing the virtual machine might not monitor the\nfile for changes. In this case, after such an edit, a client\nwould call \"reload\" on the associated virtual machine to ensu...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postManagedEntityMoIdReload" }, "task": true }, { "name": "postManagedEntityMoIdRenameTask", "summary": "Renames this managed entity.", "description": "Renames this managed entity.\n\nAny % (percent) character used in this name parameter\nmust be escaped, unless it is used to start an escape\nsequence. Clients may also escape any other characters in\nthis name parameter.\n\nSee also *ManagedEntity.name*.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postManagedEntityMoIdRenameTask" }, "task": true }, { "name": "postManagedEntityMoIdSetCustomValue", "summary": "Assigns a value to a custom field.", "description": "Assigns a value to a custom field.\n\nThe setCustomValue method requires\nwhichever updatePrivilege is defined as one of the\n*CustomFieldDef.fieldInstancePrivileges*\nfor the CustomFieldDef whose value is being changed.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postManagedEntityMoIdSetCustomValue" }, "task": true }, { "name": "getManagedEntityMoIdAlarmActionsEnabled", "summary": "Whether alarm actions are enabled for this entity.", "description": "Whether alarm actions are enabled for this entity.\n\nTrue if enabled; false otherwise.\n\n***Required privileges:*** System.Read", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getManagedEntityMoIdAlarmActionsEnabled" }, "task": true }, { "name": "getManagedEntityMoIdAvailableField", "summary": "List of custom field definitions that are valid for the object's type.", "description": "List of custom field definitions that are valid for the object's type.\n\nThe fields are sorted by *CustomFieldDef.name*.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getManagedEntityMoIdAvailableField" }, "task": true }, { "name": "getManagedEntityMoIdConfigIssue", "summary": "Current configuration issues that have been detected for this entity.", "description": "Current configuration issues that have been detected for this entity.\n\nTypically,\nthese issues have already been logged as events. The entity stores these\nevents as long as they are still current. The\n*configStatus* property provides an overall status\nbased on these events.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getManagedEntityMoIdConfigIssue" }, "task": true }, { "name": "getManagedEntityMoIdConfigStatus", "summary": "The configStatus indicates whether or not the system has detected a configuration\nissue involving t", "description": "The configStatus indicates whether or not the system has detected a configuration\nissue involving this entity.\n\nFor example, it might have detected a\nduplicate IP address or MAC address, or a host in a cluster\nmight be out of compliance. The meanings of the configStatus values are:\n- red: A problem has been detected involving the entity.\n- yellow: A problem is about to occur or a transient condition\n has occurred (For example, reconfigure fail-over policy).\n- green: No configuration issues have...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getManagedEntityMoIdConfigStatus" }, "task": true }, { "name": "getManagedEntityMoIdCustomValue", "summary": "Custom field values.", "description": "Custom field values.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getManagedEntityMoIdCustomValue" }, "task": true }, { "name": "getManagedEntityMoIdDeclaredAlarmState", "summary": "A set of alarm states for alarms that apply to this managed entity.", "description": "A set of alarm states for alarms that apply to this managed entity.\n\nThe set includes alarms defined on this entity\nand alarms inherited from the parent entity,\nor from any ancestors in the inventory hierarchy.\n\nAlarms are inherited if they can be triggered by this entity or its descendants.\nThis set does not include alarms that are defined on descendants of this entity.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getManagedEntityMoIdDeclaredAlarmState" }, "task": true }, { "name": "getManagedEntityMoIdDisabledMethod", "summary": "List of operations that are disabled, given the current runtime\nstate of the entity.", "description": "List of operations that are disabled, given the current runtime\nstate of the entity.\n\nFor example, a power-on operation always fails if a\nvirtual machine is already powered on. This list can be used by clients to\nenable or disable operations in a graphical user interface.\n\nNote: This list is determined by the current runtime state of an entity,\nnot by its permissions.\n\nThis list may include the following operations for a HostSystem:\n- *HostSystem.EnterMaintenanceMode_Task*\n- *HostSystem.ExitMain...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getManagedEntityMoIdDisabledMethod" }, "task": true }, { "name": "getManagedEntityMoIdEffectiveRole", "summary": "Access rights the current session has to this entity.", "description": "Access rights the current session has to this entity.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getManagedEntityMoIdEffectiveRole" }, "task": true }, { "name": "getManagedEntityMoIdName", "summary": "Name of this entity, unique relative to its parent.", "description": "Name of this entity, unique relative to its parent.\n\nAny / (slash), \\\\ (backslash), character used in this\nname element will be escaped. Similarly, any % (percent) character used in\nthis name element will be escaped, unless it is used to start an escape\nsequence. A slash is escaped as %2F or %2f. A backslash is escaped as %5C or\n%5c, and a percent is escaped as %25.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getManagedEntityMoIdName" }, "task": true }, { "name": "getManagedEntityMoIdOverallStatus", "summary": "General health of this managed entity.", "description": "General health of this managed entity.\n\nThe overall status of the managed entity is computed as the worst status\namong its alarms and the configuration issues detected on the entity.\nThe status is reported as one of the following values:\n- red: The entity has alarms or configuration issues with a red status.\n- yellow: The entity does not have alarms or configuration issues with a\n red status, and has at least one with a yellow status.\n- green: The entity does not have alarms or configuration is...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getManagedEntityMoIdOverallStatus" }, "task": true }, { "name": "getManagedEntityMoIdParent", "summary": "Parent of this entity.", "description": "Parent of this entity.\n\nThis value is null for the root object and for\n*VirtualMachine* objects that are part of\na *VirtualApp*.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getManagedEntityMoIdParent" }, "task": true }, { "name": "getManagedEntityMoIdPermission", "summary": "List of permissions defined for this entity.", "description": "List of permissions defined for this entity.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getManagedEntityMoIdPermission" }, "task": true }, { "name": "getManagedEntityMoIdRecentTask", "summary": "The set of recent tasks operating on this managed entity.", "description": "The set of recent tasks operating on this managed entity.\n\nThis is a subset\nof *TaskManager.recentTask* belong to this entity. A task in this\nlist could be in one of the four states: pending, running, success or error.\n\nThis property can be used to deduce intermediate power states for\na virtual machine entity. For example, if the current powerState is \"poweredOn\"\nand there is a running task performing the \"suspend\" operation, then the virtual\nmachine's intermediate state might be described as \"s...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getManagedEntityMoIdRecentTask" }, "task": true }, { "name": "getManagedEntityMoIdTag", "summary": "The set of tags associated with this managed entity.", "description": "The set of tags associated with this managed entity.\n\nExperimental. Subject to change.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getManagedEntityMoIdTag" }, "task": true }, { "name": "getManagedEntityMoIdTriggeredAlarmState", "summary": "A set of alarm states for alarms triggered by this entity\nor by its descendants.", "description": "A set of alarm states for alarms triggered by this entity\nor by its descendants.\n\nTriggered alarms are propagated up the inventory hierarchy\nso that a user can readily tell when a descendant has triggered an alarm.\nIn releases after vSphere API 5.0, vSphere Servers might not\ngenerate property collector update notifications for this property.\nTo obtain the latest value of the property, you can use\nPropertyCollector methods RetrievePropertiesEx or WaitForUpdatesEx.\nIf you use the PropertyCollector...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getManagedEntityMoIdTriggeredAlarmState" }, "task": true }, { "name": "getManagedEntityMoIdValue", "summary": "List of custom field values.", "description": "List of custom field values.\n\nEach value uses a key to associate\nan instance of a *CustomFieldStringValue* with\na custom field definition.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getManagedEntityMoIdValue" }, "task": true }, { "name": "postManagedObjectViewMoIdDestroyView", "summary": "Destroy this view.", "description": "Destroy this view.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postManagedObjectViewMoIdDestroyView" }, "task": true }, { "name": "getManagedObjectViewMoIdView", "summary": "The list of references to objects mapped by this view.", "description": "The list of references to objects mapped by this view.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getManagedObjectViewMoIdView" }, "task": true }, { "name": "postNetworkMoIdDestroyTask", "summary": "Destroys this object, deleting its contents and removing it from its parent\nfolder (if any).", "description": "Destroys this object, deleting its contents and removing it from its parent\nfolder (if any).\n\nNOTE: The appropriate privilege must be held on the parent of the destroyed\nentity as well as the entity itself.\nThis method can throw one of several exceptions. The exact set of exceptions\ndepends on the kind of entity that is being removed. See comments for\neach entity for more information on destroy behavior.\n\n***Required privileges:*** System.Read", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postNetworkMoIdDestroyTask" }, "task": true }, { "name": "postNetworkMoIdDestroyNetwork", "summary": "Removes a network.", "description": "Deprecated as of VI API 2.5 do not use this method. This method throws\n*ResourceInUse*. Networks are automatically\nremoved when no longer in use, so this method is unnecessary.\n\nRemoves a network.\n\nA network can be removed only if it is not used by any host or\nvirtual machine.\n\n***Required privileges:*** Network.Delete", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postNetworkMoIdDestroyNetwork" }, "task": true }, { "name": "postNetworkMoIdReload", "summary": "Reload the entity state.", "description": "Reload the entity state.\n\nClients only need to call this method\nif they changed some external state that affects the service\nwithout using the Web service interface to perform the change.\nFor example, hand-editing a virtual machine configuration file\naffects the configuration of the associated virtual machine but\nthe service managing the virtual machine might not monitor the\nfile for changes. In this case, after such an edit, a client\nwould call \"reload\" on the associated virtual machine to ensu...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postNetworkMoIdReload" }, "task": true }, { "name": "postNetworkMoIdRenameTask", "summary": "Renames this managed entity.", "description": "Renames this managed entity.\n\nAny % (percent) character used in this name parameter\nmust be escaped, unless it is used to start an escape\nsequence. Clients may also escape any other characters in\nthis name parameter.\n\nSee also *ManagedEntity.name*.\n\n***Required privileges:*** System.Read", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postNetworkMoIdRenameTask" }, "task": true }, { "name": "postNetworkMoIdSetCustomValue", "summary": "Assigns a value to a custom field.", "description": "Assigns a value to a custom field.\n\nThe setCustomValue method requires\nwhichever updatePrivilege is defined as one of the\n*CustomFieldDef.fieldInstancePrivileges*\nfor the CustomFieldDef whose value is being changed.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postNetworkMoIdSetCustomValue" }, "task": true }, { "name": "getNetworkMoIdAlarmActionsEnabled", "summary": "Whether alarm actions are enabled for this entity.", "description": "Whether alarm actions are enabled for this entity.\n\nTrue if enabled; false otherwise.\n\n***Required privileges:*** System.Read", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getNetworkMoIdAlarmActionsEnabled" }, "task": true }, { "name": "getNetworkMoIdAvailableField", "summary": "List of custom field definitions that are valid for the object's type.", "description": "List of custom field definitions that are valid for the object's type.\n\nThe fields are sorted by *CustomFieldDef.name*.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getNetworkMoIdAvailableField" }, "task": true }, { "name": "getNetworkMoIdConfigIssue", "summary": "Current configuration issues that have been detected for this entity.", "description": "Current configuration issues that have been detected for this entity.\n\nTypically,\nthese issues have already been logged as events. The entity stores these\nevents as long as they are still current. The\n*configStatus* property provides an overall status\nbased on these events.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getNetworkMoIdConfigIssue" }, "task": true }, { "name": "getNetworkMoIdConfigStatus", "summary": "The configStatus indicates whether or not the system has detected a configuration\nissue involving t", "description": "The configStatus indicates whether or not the system has detected a configuration\nissue involving this entity.\n\nFor example, it might have detected a\nduplicate IP address or MAC address, or a host in a cluster\nmight be out of compliance. The meanings of the configStatus values are:\n- red: A problem has been detected involving the entity.\n- yellow: A problem is about to occur or a transient condition\n has occurred (For example, reconfigure fail-over policy).\n- green: No configuration issues have...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getNetworkMoIdConfigStatus" }, "task": true }, { "name": "getNetworkMoIdCustomValue", "summary": "Custom field values.", "description": "Custom field values.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getNetworkMoIdCustomValue" }, "task": true }, { "name": "getNetworkMoIdDeclaredAlarmState", "summary": "A set of alarm states for alarms that apply to this managed entity.", "description": "A set of alarm states for alarms that apply to this managed entity.\n\nThe set includes alarms defined on this entity\nand alarms inherited from the parent entity,\nor from any ancestors in the inventory hierarchy.\n\nAlarms are inherited if they can be triggered by this entity or its descendants.\nThis set does not include alarms that are defined on descendants of this entity.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getNetworkMoIdDeclaredAlarmState" }, "task": true }, { "name": "getNetworkMoIdDisabledMethod", "summary": "List of operations that are disabled, given the current runtime\nstate of the entity.", "description": "List of operations that are disabled, given the current runtime\nstate of the entity.\n\nFor example, a power-on operation always fails if a\nvirtual machine is already powered on. This list can be used by clients to\nenable or disable operations in a graphical user interface.\n\nNote: This list is determined by the current runtime state of an entity,\nnot by its permissions.\n\nThis list may include the following operations for a HostSystem:\n- *HostSystem.EnterMaintenanceMode_Task*\n- *HostSystem.ExitMain...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getNetworkMoIdDisabledMethod" }, "task": true }, { "name": "getNetworkMoIdEffectiveRole", "summary": "Access rights the current session has to this entity.", "description": "Access rights the current session has to this entity.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getNetworkMoIdEffectiveRole" }, "task": true }, { "name": "getNetworkMoIdHost", "summary": "Hosts attached to this network.", "description": "Hosts attached to this network.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getNetworkMoIdHost" }, "task": true }, { "name": "getNetworkMoIdName", "summary": "Name of this entity, unique relative to its parent.", "description": "Name of this entity, unique relative to its parent.\n\nAny / (slash), \\\\ (backslash), character used in this\nname element will be escaped. Similarly, any % (percent) character used in\nthis name element will be escaped, unless it is used to start an escape\nsequence. A slash is escaped as %2F or %2f. A backslash is escaped as %5C or\n%5c, and a percent is escaped as %25.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getNetworkMoIdName" }, "task": true }, { "name": "getNetworkMoIdOverallStatus", "summary": "General health of this managed entity.", "description": "General health of this managed entity.\n\nThe overall status of the managed entity is computed as the worst status\namong its alarms and the configuration issues detected on the entity.\nThe status is reported as one of the following values:\n- red: The entity has alarms or configuration issues with a red status.\n- yellow: The entity does not have alarms or configuration issues with a\n red status, and has at least one with a yellow status.\n- green: The entity does not have alarms or configuration is...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getNetworkMoIdOverallStatus" }, "task": true }, { "name": "getNetworkMoIdParent", "summary": "Parent of this entity.", "description": "Parent of this entity.\n\nThis value is null for the root object and for\n*VirtualMachine* objects that are part of\na *VirtualApp*.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getNetworkMoIdParent" }, "task": true }, { "name": "getNetworkMoIdPermission", "summary": "List of permissions defined for this entity.", "description": "List of permissions defined for this entity.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getNetworkMoIdPermission" }, "task": true }, { "name": "getNetworkMoIdRecentTask", "summary": "The set of recent tasks operating on this managed entity.", "description": "The set of recent tasks operating on this managed entity.\n\nThis is a subset\nof *TaskManager.recentTask* belong to this entity. A task in this\nlist could be in one of the four states: pending, running, success or error.\n\nThis property can be used to deduce intermediate power states for\na virtual machine entity. For example, if the current powerState is \"poweredOn\"\nand there is a running task performing the \"suspend\" operation, then the virtual\nmachine's intermediate state might be described as \"s...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getNetworkMoIdRecentTask" }, "task": true }, { "name": "getNetworkMoIdSummary", "summary": "Properties of a network.", "description": "Properties of a network.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getNetworkMoIdSummary" }, "task": true }, { "name": "getNetworkMoIdTag", "summary": "The set of tags associated with this managed entity.", "description": "The set of tags associated with this managed entity.\n\nExperimental. Subject to change.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getNetworkMoIdTag" }, "task": true }, { "name": "getNetworkMoIdTriggeredAlarmState", "summary": "A set of alarm states for alarms triggered by this entity\nor by its descendants.", "description": "A set of alarm states for alarms triggered by this entity\nor by its descendants.\n\nTriggered alarms are propagated up the inventory hierarchy\nso that a user can readily tell when a descendant has triggered an alarm.\nIn releases after vSphere API 5.0, vSphere Servers might not\ngenerate property collector update notifications for this property.\nTo obtain the latest value of the property, you can use\nPropertyCollector methods RetrievePropertiesEx or WaitForUpdatesEx.\nIf you use the PropertyCollector...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getNetworkMoIdTriggeredAlarmState" }, "task": true }, { "name": "getNetworkMoIdValue", "summary": "List of custom field values.", "description": "List of custom field values.\n\nEach value uses a key to associate\nan instance of a *CustomFieldStringValue* with\na custom field definition.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getNetworkMoIdValue" }, "task": true }, { "name": "getNetworkMoIdVm", "summary": "Virtual machines using this network.", "description": "Virtual machines using this network.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getNetworkMoIdVm" }, "task": true }, { "name": "postOpaqueNetworkMoIdDestroyTask", "summary": "Destroys this object, deleting its contents and removing it from its parent\nfolder (if any).", "description": "Destroys this object, deleting its contents and removing it from its parent\nfolder (if any).\n\nNOTE: The appropriate privilege must be held on the parent of the destroyed\nentity as well as the entity itself.\nThis method can throw one of several exceptions. The exact set of exceptions\ndepends on the kind of entity that is being removed. See comments for\neach entity for more information on destroy behavior.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postOpaqueNetworkMoIdDestroyTask" }, "task": true }, { "name": "postOpaqueNetworkMoIdDestroyNetwork", "summary": "Removes a network.", "description": "Deprecated as of VI API 2.5 do not use this method. This method throws\n*ResourceInUse*. Networks are automatically\nremoved when no longer in use, so this method is unnecessary.\n\nRemoves a network.\n\nA network can be removed only if it is not used by any host or\nvirtual machine.\n\n***Required privileges:*** Network.Delete", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postOpaqueNetworkMoIdDestroyNetwork" }, "task": true }, { "name": "postOpaqueNetworkMoIdReload", "summary": "Reload the entity state.", "description": "Reload the entity state.\n\nClients only need to call this method\nif they changed some external state that affects the service\nwithout using the Web service interface to perform the change.\nFor example, hand-editing a virtual machine configuration file\naffects the configuration of the associated virtual machine but\nthe service managing the virtual machine might not monitor the\nfile for changes. In this case, after such an edit, a client\nwould call \"reload\" on the associated virtual machine to ensu...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postOpaqueNetworkMoIdReload" }, "task": true }, { "name": "postOpaqueNetworkMoIdRenameTask", "summary": "Renames this managed entity.", "description": "Renames this managed entity.\n\nAny % (percent) character used in this name parameter\nmust be escaped, unless it is used to start an escape\nsequence. Clients may also escape any other characters in\nthis name parameter.\n\nSee also *ManagedEntity.name*.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postOpaqueNetworkMoIdRenameTask" }, "task": true }, { "name": "postOpaqueNetworkMoIdSetCustomValue", "summary": "Assigns a value to a custom field.", "description": "Assigns a value to a custom field.\n\nThe setCustomValue method requires\nwhichever updatePrivilege is defined as one of the\n*CustomFieldDef.fieldInstancePrivileges*\nfor the CustomFieldDef whose value is being changed.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postOpaqueNetworkMoIdSetCustomValue" }, "task": true }, { "name": "getOpaqueNetworkMoIdAlarmActionsEnabled", "summary": "Whether alarm actions are enabled for this entity.", "description": "Whether alarm actions are enabled for this entity.\n\nTrue if enabled; false otherwise.\n\n***Required privileges:*** System.Read", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getOpaqueNetworkMoIdAlarmActionsEnabled" }, "task": true }, { "name": "getOpaqueNetworkMoIdAvailableField", "summary": "List of custom field definitions that are valid for the object's type.", "description": "List of custom field definitions that are valid for the object's type.\n\nThe fields are sorted by *CustomFieldDef.name*.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getOpaqueNetworkMoIdAvailableField" }, "task": true }, { "name": "getOpaqueNetworkMoIdCapability", "summary": "The capability of the Opaque Network.", "description": "The capability of the Opaque Network.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getOpaqueNetworkMoIdCapability" }, "task": true }, { "name": "getOpaqueNetworkMoIdConfigIssue", "summary": "Current configuration issues that have been detected for this entity.", "description": "Current configuration issues that have been detected for this entity.\n\nTypically,\nthese issues have already been logged as events. The entity stores these\nevents as long as they are still current. The\n*configStatus* property provides an overall status\nbased on these events.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getOpaqueNetworkMoIdConfigIssue" }, "task": true }, { "name": "getOpaqueNetworkMoIdConfigStatus", "summary": "The configStatus indicates whether or not the system has detected a configuration\nissue involving t", "description": "The configStatus indicates whether or not the system has detected a configuration\nissue involving this entity.\n\nFor example, it might have detected a\nduplicate IP address or MAC address, or a host in a cluster\nmight be out of compliance. The meanings of the configStatus values are:\n- red: A problem has been detected involving the entity.\n- yellow: A problem is about to occur or a transient condition\n has occurred (For example, reconfigure fail-over policy).\n- green: No configuration issues have...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getOpaqueNetworkMoIdConfigStatus" }, "task": true }, { "name": "getOpaqueNetworkMoIdCustomValue", "summary": "Custom field values.", "description": "Custom field values.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getOpaqueNetworkMoIdCustomValue" }, "task": true }, { "name": "getOpaqueNetworkMoIdDeclaredAlarmState", "summary": "A set of alarm states for alarms that apply to this managed entity.", "description": "A set of alarm states for alarms that apply to this managed entity.\n\nThe set includes alarms defined on this entity\nand alarms inherited from the parent entity,\nor from any ancestors in the inventory hierarchy.\n\nAlarms are inherited if they can be triggered by this entity or its descendants.\nThis set does not include alarms that are defined on descendants of this entity.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getOpaqueNetworkMoIdDeclaredAlarmState" }, "task": true }, { "name": "getOpaqueNetworkMoIdDisabledMethod", "summary": "List of operations that are disabled, given the current runtime\nstate of the entity.", "description": "List of operations that are disabled, given the current runtime\nstate of the entity.\n\nFor example, a power-on operation always fails if a\nvirtual machine is already powered on. This list can be used by clients to\nenable or disable operations in a graphical user interface.\n\nNote: This list is determined by the current runtime state of an entity,\nnot by its permissions.\n\nThis list may include the following operations for a HostSystem:\n- *HostSystem.EnterMaintenanceMode_Task*\n- *HostSystem.ExitMain...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getOpaqueNetworkMoIdDisabledMethod" }, "task": true }, { "name": "getOpaqueNetworkMoIdEffectiveRole", "summary": "Access rights the current session has to this entity.", "description": "Access rights the current session has to this entity.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getOpaqueNetworkMoIdEffectiveRole" }, "task": true }, { "name": "getOpaqueNetworkMoIdExtraConfig", "summary": "Extra NSX specific properties for opaque network.", "description": "Extra NSX specific properties for opaque network.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getOpaqueNetworkMoIdExtraConfig" }, "task": true }, { "name": "getOpaqueNetworkMoIdHost", "summary": "Hosts attached to this network.", "description": "Hosts attached to this network.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getOpaqueNetworkMoIdHost" }, "task": true }, { "name": "getOpaqueNetworkMoIdName", "summary": "Name of this entity, unique relative to its parent.", "description": "Name of this entity, unique relative to its parent.\n\nAny / (slash), \\\\ (backslash), character used in this\nname element will be escaped. Similarly, any % (percent) character used in\nthis name element will be escaped, unless it is used to start an escape\nsequence. A slash is escaped as %2F or %2f. A backslash is escaped as %5C or\n%5c, and a percent is escaped as %25.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getOpaqueNetworkMoIdName" }, "task": true }, { "name": "getOpaqueNetworkMoIdOverallStatus", "summary": "General health of this managed entity.", "description": "General health of this managed entity.\n\nThe overall status of the managed entity is computed as the worst status\namong its alarms and the configuration issues detected on the entity.\nThe status is reported as one of the following values:\n- red: The entity has alarms or configuration issues with a red status.\n- yellow: The entity does not have alarms or configuration issues with a\n red status, and has at least one with a yellow status.\n- green: The entity does not have alarms or configuration is...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getOpaqueNetworkMoIdOverallStatus" }, "task": true }, { "name": "getOpaqueNetworkMoIdParent", "summary": "Parent of this entity.", "description": "Parent of this entity.\n\nThis value is null for the root object and for\n*VirtualMachine* objects that are part of\na *VirtualApp*.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getOpaqueNetworkMoIdParent" }, "task": true }, { "name": "getOpaqueNetworkMoIdPermission", "summary": "List of permissions defined for this entity.", "description": "List of permissions defined for this entity.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getOpaqueNetworkMoIdPermission" }, "task": true }, { "name": "getOpaqueNetworkMoIdRecentTask", "summary": "The set of recent tasks operating on this managed entity.", "description": "The set of recent tasks operating on this managed entity.\n\nThis is a subset\nof *TaskManager.recentTask* belong to this entity. A task in this\nlist could be in one of the four states: pending, running, success or error.\n\nThis property can be used to deduce intermediate power states for\na virtual machine entity. For example, if the current powerState is \"poweredOn\"\nand there is a running task performing the \"suspend\" operation, then the virtual\nmachine's intermediate state might be described as \"s...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getOpaqueNetworkMoIdRecentTask" }, "task": true }, { "name": "getOpaqueNetworkMoIdSummary", "summary": "Properties of a network.", "description": "Properties of a network.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getOpaqueNetworkMoIdSummary" }, "task": true }, { "name": "getOpaqueNetworkMoIdTag", "summary": "The set of tags associated with this managed entity.", "description": "The set of tags associated with this managed entity.\n\nExperimental. Subject to change.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getOpaqueNetworkMoIdTag" }, "task": true }, { "name": "getOpaqueNetworkMoIdTriggeredAlarmState", "summary": "A set of alarm states for alarms triggered by this entity\nor by its descendants.", "description": "A set of alarm states for alarms triggered by this entity\nor by its descendants.\n\nTriggered alarms are propagated up the inventory hierarchy\nso that a user can readily tell when a descendant has triggered an alarm.\nIn releases after vSphere API 5.0, vSphere Servers might not\ngenerate property collector update notifications for this property.\nTo obtain the latest value of the property, you can use\nPropertyCollector methods RetrievePropertiesEx or WaitForUpdatesEx.\nIf you use the PropertyCollector...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getOpaqueNetworkMoIdTriggeredAlarmState" }, "task": true }, { "name": "getOpaqueNetworkMoIdValue", "summary": "List of custom field values.", "description": "List of custom field values.\n\nEach value uses a key to associate\nan instance of a *CustomFieldStringValue* with\na custom field definition.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getOpaqueNetworkMoIdValue" }, "task": true }, { "name": "getOpaqueNetworkMoIdVm", "summary": "Virtual machines using this network.", "description": "Virtual machines using this network.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getOpaqueNetworkMoIdVm" }, "task": true }, { "name": "postOptionManagerMoIdQueryOptions", "summary": "Returns a specific node or nodes in the option hierarchy.", "description": "Returns a specific node or nodes in the option hierarchy.\n\nThis method might require any of the following privileges depending\non where the property fits in the inventory tree.\n- System.View on the root folder, if this is used to read settings\n in the "client" subtree.\n- System.Read on the root folder, if this is used to read all settings\n or any settings beside those in the "client" subtree.\n- System.Read on the host, if this is used to read the advanced\n options for a ho...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postOptionManagerMoIdQueryOptions" }, "task": true }, { "name": "postOptionManagerMoIdUpdateOptions", "summary": "Updates one or more options.", "description": "Updates one or more options.\n\nThe options are changed one by one, and the operation is not atomic.\nThis means that on failure some of the options may not be changed.\n\nA nested option setting can be named using a dot notation; for example,\nsystem.cacheSize.\n\nThis method might require any of the following privileges depending\non where the property fits in the inventory tree.\n- Global.Settings on the root folder, if this is used to modify the\n settings in the service node.\n- Host.Config.AdvancedCo...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postOptionManagerMoIdUpdateOptions" }, "task": true }, { "name": "getOptionManagerMoIdSetting", "summary": "A list of the current settings for the key/value pair options.", "description": "A list of the current settings for the key/value pair options.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getOptionManagerMoIdSetting" }, "task": true }, { "name": "getOptionManagerMoIdSupportedOption", "summary": "A list of supported key/value pair options including their\ntype information.", "description": "A list of supported key/value pair options including their\ntype information.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getOptionManagerMoIdSupportedOption" }, "task": true }, { "name": "postOverheadMemoryManagerMoIdLookupVmOverheadMemory", "summary": "Return static VM overhead memory value in bytes for a (vm, host) pair from\nthe overhead memory modu", "description": "Return static VM overhead memory value in bytes for a (vm, host) pair from\nthe overhead memory module (OMM) in Virtual Center.\n\n***Required privileges:*** Global.VCServer", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postOverheadMemoryManagerMoIdLookupVmOverheadMemory" }, "task": true }, { "name": "postOvfManagerMoIdCreateDescriptor", "summary": "Create an OVF descriptor for the specified ManagedEntity, which may be a\n*VirtualMachine* or a *Vir", "description": "Create an OVF descriptor for the specified ManagedEntity, which may be a\n*VirtualMachine* or a *VirtualApp*.\n\nTo create the complete OVF descriptor, the client must already have downloaded the\nfiles that are part of the entity, because information about these files\n(compression, chunking, filename etc.) is part of the descriptor.\n\nHowever, these downloads can be quite time-consuming, so if the descriptor for some\nreason cannot be generated, the client will want to know this before downloading\nth...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postOvfManagerMoIdCreateDescriptor" }, "task": true }, { "name": "postOvfManagerMoIdCreateImportSpec", "summary": "Validate the OVF descriptor against the hardware supported by the\nhost system.", "description": "Validate the OVF descriptor against the hardware supported by the\nhost system.\n\nIf the validation succeeds, return a result containing:\n- An *ImportSpec* to use when importing the entity.\n- A list of items to upload (for example disk backing files, ISO images etc.)\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postOvfManagerMoIdCreateImportSpec" }, "task": true }, { "name": "postOvfManagerMoIdParseDescriptor", "summary": "Parse the OVF descriptor and return as much information about it as possible\nwithout knowing the ho", "description": "Parse the OVF descriptor and return as much information about it as possible\nwithout knowing the host on which it will be imported.\n\nTypically, this method is called once without a deploymentOption parameter to\nobtain the values for the default deployment option. Part of the result is the list\nof possible deployment options. To obtain the values for a particular deployment\noption, call this method again, specifying that option.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postOvfManagerMoIdParseDescriptor" }, "task": true }, { "name": "postOvfManagerMoIdValidateHost", "summary": "Validate that the given OVF can be imported on the host.", "description": "Validate that the given OVF can be imported on the host.\n\nMore specifically, this means whether or not the host supports the virtual hardware\nrequired by the OVF descriptor.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postOvfManagerMoIdValidateHost" }, "task": true }, { "name": "getOvfManagerMoIdOvfExportOption", "summary": "Returns an array of *OvfOptionInfo* object that specifies what options the server\nsupport for expor", "description": "Returns an array of *OvfOptionInfo* object that specifies what options the server\nsupport for exporting an OVF descriptor.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getOvfManagerMoIdOvfExportOption" }, "task": true }, { "name": "getOvfManagerMoIdOvfImportOption", "summary": "Returns an array of *OvfOptionInfo* object that specifies what options the server\nsupport for modif", "description": "Returns an array of *OvfOptionInfo* object that specifies what options the server\nsupport for modifing/relaxing the OVF import process.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getOvfManagerMoIdOvfImportOption" }, "task": true }, { "name": "postPerformanceManagerMoIdCreatePerfInterval", "summary": "Adds a new historical interval.", "description": "Deprecated as of API 2.5, use *PerformanceManager.UpdatePerfInterval*. The\ndefault historical intervals can be modified, but they cannot be created.\n\nAdds a new historical interval.\n\nSampling period for new interval must be\na multiple of an existing interval; must comprise a longer period of\ntime; and must be uniquely named.\n\n***Required privileges:*** Performance.ModifyIntervals", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postPerformanceManagerMoIdCreatePerfInterval" }, "task": true }, { "name": "postPerformanceManagerMoIdQueryAvailablePerfMetric", "summary": "Retrieves all performance counters for the specified *managed object* generated during a specified\n", "description": "Retrieves all performance counters for the specified *managed object* generated during a specified\nperiod of time.\n\nThe time period can be specified using beginTime,\nendTime, or by interval ID.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postPerformanceManagerMoIdQueryAvailablePerfMetric" }, "task": true }, { "name": "postPerformanceManagerMoIdQueryPerfComposite", "summary": "Retrieves a *PerfCompositeMetric* data object\nthat comprises statistics for the specified entity an", "description": "Retrieves a *PerfCompositeMetric* data object\nthat comprises statistics for the specified entity and its children\nentities.\n\nOnly metrics for the first level of descendents are included in\nthe *PerfCompositeMetric* object.\n\nUse this operation to obtain statistics for a *host* and its associated *virtual machines*, for\nexample.\n\nRequires **system.read** privilege for every virtual machine on\nthe target host, or the query fails with the “NoPermission”\nfault. Suported for *HostSystem* man...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postPerformanceManagerMoIdQueryPerfComposite" }, "task": true }, { "name": "postPerformanceManagerMoIdQueryPerfCounter", "summary": "Retrieves counter information for the specified list of counter IDs.", "description": "Retrieves counter information for the specified list of counter IDs.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postPerformanceManagerMoIdQueryPerfCounter" }, "task": true }, { "name": "postPerformanceManagerMoIdQueryPerfCounterByLevel", "summary": "Retrieves the set of counters that are available at a specified\ncollection *PerfInterval.level*.", "description": "Retrieves the set of counters that are available at a specified\ncollection *PerfInterval.level*.\n\nThe collection level\ndetermines the statistics that get stored in VirtualCenter. See *PerfInterval* for more information about VirtualCenter Server\nhistorical statistics collection.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postPerformanceManagerMoIdQueryPerfCounterByLevel" }, "task": true }, { "name": "postPerformanceManagerMoIdQueryPerfProviderSummary", "summary": "Retrieves the *PerfProviderSummary* data object that\ndefines the capabilities of the specified mana", "description": "Retrieves the *PerfProviderSummary* data object that\ndefines the capabilities of the specified managed object with respect to\nstatistics, such as whether it supports current or summary\nstatistics.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postPerformanceManagerMoIdQueryPerfProviderSummary" }, "task": true }, { "name": "postPerformanceManagerMoIdQueryPerf", "summary": "Retrieves the performance metrics for the specified entity (or entities)\nbased on the properties sp", "description": "Retrieves the performance metrics for the specified entity (or entities)\nbased on the properties specified in the *PerfQuerySpec* data object.\n\n**Query Performance for VirtualCenter Server**\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postPerformanceManagerMoIdQueryPerf" }, "task": true }, { "name": "postPerformanceManagerMoIdRemovePerfInterval", "summary": "Removes an interval from the list.", "description": "Deprecated as of API 2.5, use *PerformanceManager.UpdatePerfInterval*.\nHistorical intervals cannot be removed.\n\nRemoves an interval from the list.\n\n***Required privileges:*** Performance.ModifyIntervals", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postPerformanceManagerMoIdRemovePerfInterval" }, "task": true }, { "name": "postPerformanceManagerMoIdResetCounterLevelMapping", "summary": "Restores a set of performance counters to the default level of data\ncollection.", "description": "Restores a set of performance counters to the default level of data\ncollection.\n\nSee the performance counter\ntables for the default collection level for individual counters.\n\n***Required privileges:*** Performance.ModifyIntervals", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postPerformanceManagerMoIdResetCounterLevelMapping" }, "task": true }, { "name": "postPerformanceManagerMoIdUpdateCounterLevelMapping", "summary": "Changes the level of data collection for a set of performance counters.", "description": "Changes the level of data collection for a set of performance counters.\n\nSee the performance counter tables\nfor the default collection level for individual counters.\n\n**Important:**\n\nConsider the performance and storage consequences of using this\nmethod. You may cause a significant increase in data collection and\nstorage, along with a corresponding decrease in performance. vCenter\nServer performance and database storage requirements depend on the\ncollection levels defined for the performance i...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postPerformanceManagerMoIdUpdateCounterLevelMapping" }, "task": true }, { "name": "postPerformanceManagerMoIdUpdatePerfInterval", "summary": "Modifies VirtualCenter Server's built-in *historical intervals*, within certain limits.", "description": "Modifies VirtualCenter Server's built-in *historical intervals*, within certain limits.\n\n**Supported Modifications**\n\n\n key\n samplingPeriod\n length\n name\n level \\[1\\]\n enabled \\[2\\]\n\n\n 1\n 300 \\[3\\]\n 86400 \\[4\\]\n Past day\n 1\n true\n\n\n 2\n 1800\n 604800\n Past week\n 1\n true\n\n\n 3\n 7200\n 2592000\n Past month\n 1\n true\n\n\n 4\n 86400\n 31536000 \\[5\\]\n Past year\n 1\n true\n\n\n\n**\\[1\\]**  The collection level for the *historical intervals* can be ch...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postPerformanceManagerMoIdUpdatePerfInterval" }, "task": true }, { "name": "getPerformanceManagerMoIdDescription", "summary": "The static description strings.", "description": "The static description strings.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getPerformanceManagerMoIdDescription" }, "task": true }, { "name": "getPerformanceManagerMoIdHistoricalInterval", "summary": "A list of *intervals* configured on the\nsystem.", "description": "A list of *intervals* configured on the\nsystem.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getPerformanceManagerMoIdHistoricalInterval" }, "task": true }, { "name": "getPerformanceManagerMoIdPerfCounter", "summary": "A list of all supported performance counters in the system.", "description": "A list of all supported performance counters in the system.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getPerformanceManagerMoIdPerfCounter" }, "task": true }, { "name": "postProfileMoIdAssociateProfile", "summary": "Associate a profile with a managed entity.", "description": "Associate a profile with a managed entity.\n\nYou can check the compliance of\nentities associated with a profile by calling the\n*Profile.CheckProfileCompliance_Task* method.\n\n***Required privileges:*** Profile.Edit", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postProfileMoIdAssociateProfile" }, "task": true }, { "name": "postProfileMoIdCheckProfileComplianceTask", "summary": "Check compliance of an entity against a Profile.", "description": "Check compliance of an entity against a Profile.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postProfileMoIdCheckProfileComplianceTask" }, "task": true }, { "name": "postProfileMoIdDestroyProfile", "summary": "Destroy the profile.", "description": "Destroy the profile.\n\n***Required privileges:*** Profile.Delete", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postProfileMoIdDestroyProfile" }, "task": true }, { "name": "postProfileMoIdDissociateProfile", "summary": "Remove the association between a profile and a managed entity.", "description": "Remove the association between a profile and a managed entity.\n\n***Required privileges:*** Profile.Edit", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postProfileMoIdDissociateProfile" }, "task": true }, { "name": "postProfileMoIdExportProfile", "summary": "Export the profile in a serialized form.", "description": "Export the profile in a serialized form.\n\nTo use the serialized string to create a profile,\nspecify a *ProfileSerializedCreateSpec* when you call the\n*HostProfileManager*.*ProfileManager.CreateProfile*\nmethod.\n\n***Required privileges:*** Profile.Export", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postProfileMoIdExportProfile" }, "task": true }, { "name": "postProfileMoIdRetrieveDescription", "summary": "Returns the localizable description for the profile.", "description": "Returns the localizable description for the profile.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postProfileMoIdRetrieveDescription" }, "task": true }, { "name": "getProfileMoIdComplianceStatus", "summary": "Overall compliance of entities associated with this profile.", "description": "Overall compliance of entities associated with this profile.\n\nIf one of the entities is out of compliance, the profile is nonCompliant .\nIf all entities are in compliance, the profile is compliant .\nIf the compliance status of one of the entities is not known, compliance status\nof the profile is unknown .\nSee *ComplianceResultStatus_enum*.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getProfileMoIdComplianceStatus" }, "task": true }, { "name": "getProfileMoIdConfig", "summary": "Configuration data for the profile.", "description": "Configuration data for the profile.\n\n***Required privileges:*** Profile.Edit", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getProfileMoIdConfig" }, "task": true }, { "name": "getProfileMoIdCreatedTime", "summary": "Time at which the profile was created.", "description": "Time at which the profile was created.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getProfileMoIdCreatedTime" }, "task": true }, { "name": "getProfileMoIdDescription", "summary": "Localizable description of the profile", "description": "Deprecated as of vSphere API 5.0. use *Profile.RetrieveDescription* instead.\n\nLocalizable description of the profile", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getProfileMoIdDescription" }, "task": true }, { "name": "getProfileMoIdEntity", "summary": "List of managed entities associated with the profile.", "description": "List of managed entities associated with the profile.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getProfileMoIdEntity" }, "task": true }, { "name": "getProfileMoIdModifiedTime", "summary": "Time at which the profile was last modified.", "description": "Time at which the profile was last modified.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getProfileMoIdModifiedTime" }, "task": true }, { "name": "getProfileMoIdName", "summary": "Name of the profile.", "description": "Name of the profile.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getProfileMoIdName" }, "task": true }, { "name": "postProfileComplianceManagerMoIdCheckComplianceTask", "summary": "Check compliance of an entity against a Profile.", "description": "Check compliance of an entity against a Profile.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postProfileComplianceManagerMoIdCheckComplianceTask" }, "task": true }, { "name": "postProfileComplianceManagerMoIdClearComplianceStatus", "summary": "Clear the saved ComplianceResult based on profile and entity filtering criteria.", "description": "Clear the saved ComplianceResult based on profile and entity filtering criteria.\n\n***Required privileges:*** Profile.Clear", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postProfileComplianceManagerMoIdClearComplianceStatus" }, "task": true }, { "name": "postProfileComplianceManagerMoIdQueryComplianceStatus", "summary": "Query the compliance status based on Profile and Entity filter.", "description": "Query the compliance status based on Profile and Entity filter.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postProfileComplianceManagerMoIdQueryComplianceStatus" }, "task": true }, { "name": "postProfileComplianceManagerMoIdQueryExpressionMetadata", "summary": "Query the metadata for the expressions.", "description": "Query the metadata for the expressions.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postProfileComplianceManagerMoIdQueryExpressionMetadata" }, "task": true }, { "name": "postProfileManagerMoIdCreateProfile", "summary": "Create a profile from the specified CreateSpec.", "description": "Create a profile from the specified CreateSpec.\n\n***Required privileges:*** Profile.Create", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postProfileManagerMoIdCreateProfile" }, "task": true }, { "name": "postProfileManagerMoIdFindAssociatedProfile", "summary": "Get the profile(s) to which this entity is associated.", "description": "Get the profile(s) to which this entity is associated.\n\nThe list of profiles will only include profiles known to this\nprofileManager.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postProfileManagerMoIdFindAssociatedProfile" }, "task": true }, { "name": "postProfileManagerMoIdQueryPolicyMetadata", "summary": "Get the Metadata information for the policyNames.", "description": "Get the Metadata information for the policyNames.\n\nPolicyNames are available with the defaultProfile obtained by invoking the\nmethod createDefaultProfile.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postProfileManagerMoIdQueryPolicyMetadata" }, "task": true }, { "name": "getProfileManagerMoIdProfile", "summary": "A list of profiles known to this ProfileManager.", "description": "A list of profiles known to this ProfileManager.\n\n***Required privileges:*** Profile.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getProfileManagerMoIdProfile" }, "task": true }, { "name": "postPropertyCollectorMoIdCancelRetrievePropertiesEx", "summary": "Discards remaining results from a retrieval started by *PropertyCollector.RetrievePropertiesEx* on", "description": "Discards remaining results from a retrieval started by *PropertyCollector.RetrievePropertiesEx* on the same session on the same *PropertyCollector*.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postPropertyCollectorMoIdCancelRetrievePropertiesEx" }, "task": true }, { "name": "postPropertyCollectorMoIdCancelWaitForUpdates", "summary": "Attempts to cancel outstanding calls to *PropertyCollector.WaitForUpdates* or *PropertyCollector.Wa", "description": "Attempts to cancel outstanding calls to *PropertyCollector.WaitForUpdates* or *PropertyCollector.WaitForUpdatesEx* in the current session.\n\nIf an update calculation is\nin process this method has no effect. If an update calculation is not in\nprocess any waiting calls complete quickly and report a *RequestCanceled* fault.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postPropertyCollectorMoIdCancelWaitForUpdates" }, "task": true }, { "name": "postPropertyCollectorMoIdCheckForUpdates", "summary": "Checks for updates on properties specified by the union of all current\nfilters.", "description": "Deprecated as of vSphere API 4.1, use\n*PropertyCollector.WaitForUpdatesEx* with a\n*WaitOptions.maxWaitSeconds* of 0.\n\nChecks for updates on properties specified by the union of all current\nfilters.\n\nIf no updates are pending, this method returns null.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postPropertyCollectorMoIdCheckForUpdates" }, "task": true }, { "name": "postPropertyCollectorMoIdContinueRetrievePropertiesEx", "summary": "Retrieves additional results from a retrieval started by *PropertyCollector.RetrievePropertiesEx* o", "description": "Retrieves additional results from a retrieval started by *PropertyCollector.RetrievePropertiesEx* on the same session on the same *PropertyCollector*.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postPropertyCollectorMoIdContinueRetrievePropertiesEx" }, "task": true }, { "name": "postPropertyCollectorMoIdCreateFilter", "summary": "Creates a new filter for the given set of managed objects.", "description": "Creates a new filter for the given set of managed objects.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postPropertyCollectorMoIdCreateFilter" }, "task": true }, { "name": "postPropertyCollectorMoIdCreatePropertyCollector", "summary": "Creates a new session-specific *PropertyCollector* that can\nbe used to retrieve property updates in", "description": "Creates a new session-specific *PropertyCollector* that can\nbe used to retrieve property updates independent of any other\n*PropertyCollector*.\n\nThe newly created *PropertyCollector*\nis not tied to the creating *PropertyCollector* in any way and\nexists until it is destroyed\nby a call to *PropertyCollector.DestroyPropertyCollector* or until the session\non which the PropertyCollector was created is closed. This is in contrast\nto the default *PropertyCollector*, which always exists, but still has\nse...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postPropertyCollectorMoIdCreatePropertyCollector" }, "task": true }, { "name": "postPropertyCollectorMoIdDestroyPropertyCollector", "summary": "Destroys this *PropertyCollector*.", "description": "Destroys this *PropertyCollector*.\n\nA *PropertyCollector* that was created by\n*PropertyCollector.CreatePropertyCollector* is automatically destroyed when the\nsession on which it was created is closed. This method can be used to\ndestroy them explicitly.\n\nAn automatically created *PropertyCollector* provided by a service\nis not session specific and may not be destroyed.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postPropertyCollectorMoIdDestroyPropertyCollector" }, "task": true }, { "name": "postPropertyCollectorMoIdRetrieveProperties", "summary": "Retrieves the specified properties of the specified managed objects.", "description": "Deprecated as of vSphere API 4.1, use *PropertyCollector.RetrievePropertiesEx*.\n\nRetrieves the specified properties of the specified managed objects.\n\nThis method is similar to creating the filters, receiving the\nproperty values, and destroying the filters. The main difference is that\nthe output blends the results from all the filters and reports a given\nmanaged object at most once no matter how many filters apply.\n\nThe method isn't requiring any privilege, because it's used to\naccess properties...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postPropertyCollectorMoIdRetrieveProperties" }, "task": true }, { "name": "postPropertyCollectorMoIdRetrievePropertiesEx", "summary": "Retrieves the specified properties of the specified managed objects.", "description": "Retrieves the specified properties of the specified managed objects.\n\nThis method is similar to creating the filters, receiving the\nproperty values, and destroying the filters. The main difference is that\nthe output blends the results from all the filters and reports a given\nmanaged object at most once no matter how many filters apply.\n\nThe method isn't requiring any privilege, because it's used to\naccess properties that are publicly available, without authenticated\nsession. That isn't sequrity ...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postPropertyCollectorMoIdRetrievePropertiesEx" }, "task": true }, { "name": "postPropertyCollectorMoIdWaitForUpdates", "summary": "Calculate the set of updates for each existing filter in the session,\nreturning when at least one f", "description": "Deprecated as of vSphere API 4.1, use *PropertyCollector.WaitForUpdatesEx*.\n\nCalculate the set of updates for each existing filter in the session,\nreturning when at least one filter has updates.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postPropertyCollectorMoIdWaitForUpdates" }, "task": true }, { "name": "postPropertyCollectorMoIdWaitForUpdatesEx", "summary": "Calculate the set of updates for each existing filter in the session.", "description": "Calculate the set of updates for each existing filter in the session.\n\n*PropertyCollector.WaitForUpdatesEx* may return only partial update\ncalculations. See *UpdateSet.truncated* for a\nmore detailed explanation. *PropertyCollector.WaitForUpdatesEx* may also return null\nafter a timeout, either as requested by *WaitOptions.maxWaitSeconds* or due to *PropertyCollector*\npolicy.\n\nIf an application uses waitForUpdatesEx it is strongly recommended\nthat it not make concurrent calls to *PropertyCollector...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postPropertyCollectorMoIdWaitForUpdatesEx" }, "task": true }, { "name": "getPropertyCollectorMoIdFilter", "summary": "The filters that this *PropertyCollector* uses to determine the list of\nproperties for which it det", "description": "The filters that this *PropertyCollector* uses to determine the list of\nproperties for which it detects incremental changes.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getPropertyCollectorMoIdFilter" }, "task": true }, { "name": "postPropertyFilterMoIdDestroyPropertyFilter", "summary": "Destroys this filter.", "description": "Destroys this filter.\n\nThis operation can be called explicitly, or it can take place\nimplicitly when the session that created the filter is closed.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postPropertyFilterMoIdDestroyPropertyFilter" }, "task": true }, { "name": "getPropertyFilterMoIdPartialUpdates", "summary": "Flag to indicate if a change to a nested property reports only the\nnested change or the entire spec", "description": "Flag to indicate if a change to a nested property reports only the\nnested change or the entire specified property value.\n\nIf the value is\ntrue, a change reports only the nested property. If the value is\nfalse, a change reports the enclosing property named in the filter.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getPropertyFilterMoIdPartialUpdates" }, "task": true }, { "name": "getPropertyFilterMoIdSpec", "summary": "Specifications for this filter.", "description": "Specifications for this filter.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getPropertyFilterMoIdSpec" }, "task": true }, { "name": "postResourcePlanningManagerMoIdEstimateDatabaseSize", "summary": "Estimates the database size required to store VirtualCenter data.", "description": "Estimates the database size required to store VirtualCenter data.\n\n***Required privileges:*** System.Read", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postResourcePlanningManagerMoIdEstimateDatabaseSize" }, "task": true }, { "name": "postResourcePoolMoIdCreateResourcePool", "summary": "Creates a new resource pool.", "description": "Creates a new resource pool.\n\n***Required privileges:*** Resource.CreatePool", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postResourcePoolMoIdCreateResourcePool" }, "task": true }, { "name": "postResourcePoolMoIdCreateVApp", "summary": "Creates a new vApp container.", "description": "Creates a new vApp container.\n\nAny % (percent) character used in this name parameter must be escaped, unless it\nis used to start an escape sequence. Clients may also escape any other characters\nin this name parameter.\n\n***Required privileges:*** VApp.Create", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postResourcePoolMoIdCreateVApp" }, "task": true }, { "name": "postResourcePoolMoIdCreateChildVMTask", "summary": "Creates a new virtual machine in a vApp container.", "description": "Creates a new virtual machine in a vApp container.\n\nThis method supports creating a virtual machine directly in a vApp. A\nvirtual machine in a vApp is not associated with a VM folder and therefore\ncannot be created using the method on a *Folder*.\n\nThis method can only be called directly on a *vApp*\nor on a resource pool that is a child of a vApp.\n\nThe privilege VirtualMachine.Inventory.Create is required on this entity. Further,\nif this is a resource pool, the privilege Resource.AssignVMToPool i...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postResourcePoolMoIdCreateChildVMTask" }, "task": true }, { "name": "postResourcePoolMoIdDestroyTask", "summary": "Destroys this object, deleting its contents and removing it from its parent\nfolder (if any).", "description": "Destroys this object, deleting its contents and removing it from its parent\nfolder (if any).\n\nNOTE: The appropriate privilege must be held on the parent of the destroyed\nentity as well as the entity itself.\nThis method can throw one of several exceptions. The exact set of exceptions\ndepends on the kind of entity that is being removed. See comments for\neach entity for more information on destroy behavior.\n\n***Required privileges:*** Resource.DeletePool", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postResourcePoolMoIdDestroyTask" }, "task": true }, { "name": "postResourcePoolMoIdDestroyChildren", "summary": "Removes all child resource pools recursively.", "description": "Removes all child resource pools recursively.\n\nAll virtual machines and vApps\nassociated with the child resource pools get associated with this resource pool.\n\nNote that resource pools contained in child vApps are not affected.\n\nThe privilege checks performed are the following.\n- Resource.DeletePool privilege must be held on this object and each of it's\n immediate children to be destroyed.\n- If VMs are being moved, the privilege Resource.AssignVMToPool must be held\n on this resource pool as we...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postResourcePoolMoIdDestroyChildren" }, "task": true }, { "name": "postResourcePoolMoIdImportVApp", "summary": "Creates a new entity in this resource pool.", "description": "Creates a new entity in this resource pool.\n\nThe import process consists of two\nsteps:\n1. Create the VMs and/or vApps that make up the entity.\n2. Upload virtual disk contents.\n\nIn step 1, the client must wait for the server to create all inventory\nobjects. It does that by monitoring the *HttpNfcLease.state*\nproperty on the *HttpNfcLease* object returned from this call.\nWhen the server is done creating objects, the lease will change to the\nready state, and step 2 begins. If an error occurs whi...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postResourcePoolMoIdImportVApp" }, "task": true }, { "name": "postResourcePoolMoIdMoveIntoResourcePool", "summary": "Moves a set of resource pools, vApps or virtual machines into this pool.", "description": "Moves a set of resource pools, vApps or virtual machines into this pool.\n\nThe\npools, vApps and virtual machines must be part of the cluster or standalone\nhost that contains this pool.\n\nFor each entity being moved, the move is subject to the following privilege\nchecks:\n- If the object being moved is a ResourcePool, then Resource.MovePool must be\n held on the pool being moved and it's former parent pool or vApp. If the\n target is a vApp, the privilege VApp.AssignResourcePool must be held on\n it...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postResourcePoolMoIdMoveIntoResourcePool" }, "task": true }, { "name": "postResourcePoolMoIdQueryResourceConfigOption", "summary": "Get a value range and default values for *ResourceConfigSpec*.", "description": "Deprecated as of vSphere API 6.5.\n\nGet a value range and default values for *ResourceConfigSpec*.\n\nThis API was never implemented, and there is no replacement for it.\n\n***Required privileges:*** Resource.EditPool", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postResourcePoolMoIdQueryResourceConfigOption" }, "task": true }, { "name": "postResourcePoolMoIdRefreshRuntime", "summary": "Refreshes the resource usage data that is available in\n*ResourcePoolRuntimeInfo*.", "description": "Refreshes the resource usage data that is available in\n*ResourcePoolRuntimeInfo*.\n\nThe latest runtime resource usage of this resource pool may not be\navailable immediately after operations that alter resource usage,\nsuch as powering on a virtual machine. Invoke this method when resource\nusage may have recently changed, and the most up-to-date value in the\n*ResourcePoolRuntimeInfo* is needed.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postResourcePoolMoIdRefreshRuntime" }, "task": true }, { "name": "postResourcePoolMoIdRegisterChildVMTask", "summary": "Adds an existing virtual machine to this resource pool or vApp.", "description": "Adds an existing virtual machine to this resource pool or vApp.\n\nThis operation only works for vApps or resource pools that are children of\nvApps. To register a VM in a folder, see *Folder.RegisterVM_Task*.\n\nAny % (percent) character used in this name parameter must be escaped, unless it\nis used to start an escape sequence. Clients may also escape any other characters\nin this name parameter.\nIn addition to the VirtualMachine.Inventory.Register privilege, it\nrequires System.Read privilege on the ...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postResourcePoolMoIdRegisterChildVMTask" }, "task": true }, { "name": "postResourcePoolMoIdReload", "summary": "Reload the entity state.", "description": "Reload the entity state.\n\nClients only need to call this method\nif they changed some external state that affects the service\nwithout using the Web service interface to perform the change.\nFor example, hand-editing a virtual machine configuration file\naffects the configuration of the associated virtual machine but\nthe service managing the virtual machine might not monitor the\nfile for changes. In this case, after such an edit, a client\nwould call \"reload\" on the associated virtual machine to ensu...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postResourcePoolMoIdReload" }, "task": true }, { "name": "postResourcePoolMoIdRenameTask", "summary": "Renames this managed entity.", "description": "Renames this managed entity.\n\nAny % (percent) character used in this name parameter\nmust be escaped, unless it is used to start an escape\nsequence. Clients may also escape any other characters in\nthis name parameter.\n\nSee also *ManagedEntity.name*.\n\n***Required privileges:*** Resource.RenamePool", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postResourcePoolMoIdRenameTask" }, "task": true }, { "name": "postResourcePoolMoIdSetCustomValue", "summary": "Assigns a value to a custom field.", "description": "Assigns a value to a custom field.\n\nThe setCustomValue method requires\nwhichever updatePrivilege is defined as one of the\n*CustomFieldDef.fieldInstancePrivileges*\nfor the CustomFieldDef whose value is being changed.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postResourcePoolMoIdSetCustomValue" }, "task": true }, { "name": "postResourcePoolMoIdUpdateChildResourceConfiguration", "summary": "Changes resource configuration of a set of children of this resource pool.", "description": "Changes resource configuration of a set of children of this resource pool.\n\nThe\nmethod allows bulk modifications of the set of the direct children\n(virtual machines and resource pools).\n\nBulk modifications are not transactional. Each modification is made individually.\nIf a failure is encountered while applying the changes, then the processing stops,\nmeaning at least one and as many as all of the changes are not applied.\n\nA set can include a subset of the resources. Children that are not\nmentione...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postResourcePoolMoIdUpdateChildResourceConfiguration" }, "task": true }, { "name": "postResourcePoolMoIdUpdateConfig", "summary": "Updates the configuration of the resource pool.", "description": "Updates the configuration of the resource pool.\n\nAny % (percent) character used in this name parameter must be escaped, unless it\nis used to start an escape sequence. Clients may also escape any other characters\nin this name parameter.\n\nThe privilege checks for this operation are as follows:\n- If this is a resource pool, the privilege Resource.EditPool is required on\n this and on the parent pool or vApp.\n- If this is a vApp, the privilege VApp.ResourceConfig is required on\n this and on the par...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postResourcePoolMoIdUpdateConfig" }, "task": true }, { "name": "getResourcePoolMoIdAlarmActionsEnabled", "summary": "Whether alarm actions are enabled for this entity.", "description": "Whether alarm actions are enabled for this entity.\n\nTrue if enabled; false otherwise.\n\n***Required privileges:*** System.Read", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getResourcePoolMoIdAlarmActionsEnabled" }, "task": true }, { "name": "getResourcePoolMoIdAvailableField", "summary": "List of custom field definitions that are valid for the object's type.", "description": "List of custom field definitions that are valid for the object's type.\n\nThe fields are sorted by *CustomFieldDef.name*.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getResourcePoolMoIdAvailableField" }, "task": true }, { "name": "getResourcePoolMoIdChildConfiguration", "summary": "The resource configuration of all direct children (VirtualMachine and\nResourcePool) of this resourc", "description": "The resource configuration of all direct children (VirtualMachine and\nResourcePool) of this resource group.\n\nProperty collector update notifications might not be generated for this\nproperty. To listen for the child configuration change, please create\nPropertyCollector filter on the child entities directly.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getResourcePoolMoIdChildConfiguration" }, "task": true }, { "name": "getResourcePoolMoIdConfig", "summary": "Configuration of this resource pool.", "description": "Configuration of this resource pool.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getResourcePoolMoIdConfig" }, "task": true }, { "name": "getResourcePoolMoIdConfigIssue", "summary": "Current configuration issues that have been detected for this entity.", "description": "Current configuration issues that have been detected for this entity.\n\nTypically,\nthese issues have already been logged as events. The entity stores these\nevents as long as they are still current. The\n*configStatus* property provides an overall status\nbased on these events.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getResourcePoolMoIdConfigIssue" }, "task": true }, { "name": "getResourcePoolMoIdConfigStatus", "summary": "The configStatus indicates whether or not the system has detected a configuration\nissue involving t", "description": "The configStatus indicates whether or not the system has detected a configuration\nissue involving this entity.\n\nFor example, it might have detected a\nduplicate IP address or MAC address, or a host in a cluster\nmight be out of compliance. The meanings of the configStatus values are:\n- red: A problem has been detected involving the entity.\n- yellow: A problem is about to occur or a transient condition\n has occurred (For example, reconfigure fail-over policy).\n- green: No configuration issues have...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getResourcePoolMoIdConfigStatus" }, "task": true }, { "name": "getResourcePoolMoIdCustomValue", "summary": "Custom field values.", "description": "Custom field values.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getResourcePoolMoIdCustomValue" }, "task": true }, { "name": "getResourcePoolMoIdDeclaredAlarmState", "summary": "A set of alarm states for alarms that apply to this managed entity.", "description": "A set of alarm states for alarms that apply to this managed entity.\n\nThe set includes alarms defined on this entity\nand alarms inherited from the parent entity,\nor from any ancestors in the inventory hierarchy.\n\nAlarms are inherited if they can be triggered by this entity or its descendants.\nThis set does not include alarms that are defined on descendants of this entity.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getResourcePoolMoIdDeclaredAlarmState" }, "task": true }, { "name": "getResourcePoolMoIdDisabledMethod", "summary": "List of operations that are disabled, given the current runtime\nstate of the entity.", "description": "List of operations that are disabled, given the current runtime\nstate of the entity.\n\nFor example, a power-on operation always fails if a\nvirtual machine is already powered on. This list can be used by clients to\nenable or disable operations in a graphical user interface.\n\nNote: This list is determined by the current runtime state of an entity,\nnot by its permissions.\n\nThis list may include the following operations for a HostSystem:\n- *HostSystem.EnterMaintenanceMode_Task*\n- *HostSystem.ExitMain...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getResourcePoolMoIdDisabledMethod" }, "task": true }, { "name": "getResourcePoolMoIdEffectiveRole", "summary": "Access rights the current session has to this entity.", "description": "Access rights the current session has to this entity.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getResourcePoolMoIdEffectiveRole" }, "task": true }, { "name": "getResourcePoolMoIdName", "summary": "Name of this entity, unique relative to its parent.", "description": "Name of this entity, unique relative to its parent.\n\nAny / (slash), \\\\ (backslash), character used in this\nname element will be escaped. Similarly, any % (percent) character used in\nthis name element will be escaped, unless it is used to start an escape\nsequence. A slash is escaped as %2F or %2f. A backslash is escaped as %5C or\n%5c, and a percent is escaped as %25.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getResourcePoolMoIdName" }, "task": true }, { "name": "getResourcePoolMoIdNamespace", "summary": "The namespace with which the ResourcePool is associated.", "description": "The namespace with which the ResourcePool is associated.\n\nNamespace is a\nvAPI resource which divides cluster resources and allows administrators\nto give Kubernetes environments to their development teams.\nThis property is set only at the time of creation and cannot change.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getResourcePoolMoIdNamespace" }, "task": true }, { "name": "getResourcePoolMoIdOverallStatus", "summary": "General health of this managed entity.", "description": "General health of this managed entity.\n\nThe overall status of the managed entity is computed as the worst status\namong its alarms and the configuration issues detected on the entity.\nThe status is reported as one of the following values:\n- red: The entity has alarms or configuration issues with a red status.\n- yellow: The entity does not have alarms or configuration issues with a\n red status, and has at least one with a yellow status.\n- green: The entity does not have alarms or configuration is...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getResourcePoolMoIdOverallStatus" }, "task": true }, { "name": "getResourcePoolMoIdOwner", "summary": "The ComputeResource to which this set of one or more nested resource pools\nbelong.", "description": "The ComputeResource to which this set of one or more nested resource pools\nbelong.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getResourcePoolMoIdOwner" }, "task": true }, { "name": "getResourcePoolMoIdParent", "summary": "Parent of this entity.", "description": "Parent of this entity.\n\nThis value is null for the root object and for\n*VirtualMachine* objects that are part of\na *VirtualApp*.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getResourcePoolMoIdParent" }, "task": true }, { "name": "getResourcePoolMoIdPermission", "summary": "List of permissions defined for this entity.", "description": "List of permissions defined for this entity.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getResourcePoolMoIdPermission" }, "task": true }, { "name": "getResourcePoolMoIdRecentTask", "summary": "The set of recent tasks operating on this managed entity.", "description": "The set of recent tasks operating on this managed entity.\n\nThis is a subset\nof *TaskManager.recentTask* belong to this entity. A task in this\nlist could be in one of the four states: pending, running, success or error.\n\nThis property can be used to deduce intermediate power states for\na virtual machine entity. For example, if the current powerState is \"poweredOn\"\nand there is a running task performing the \"suspend\" operation, then the virtual\nmachine's intermediate state might be described as \"s...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getResourcePoolMoIdRecentTask" }, "task": true }, { "name": "getResourcePoolMoIdResourcePool", "summary": "The set of child resource pools.", "description": "The set of child resource pools.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getResourcePoolMoIdResourcePool" }, "task": true }, { "name": "getResourcePoolMoIdRuntime", "summary": "Runtime information about a resource pool.", "description": "Runtime information about a resource pool.\n\nThe *ResourcePoolResourceUsage* information within\n*ResourcePoolRuntimeInfo* can be transiently stale.\nUse *ResourcePool.RefreshRuntime* method to\nupdate the information.\nIn releases after vSphere API 5.0, vSphere Servers might not\ngenerate property collector update notifications for this property.\nTo obtain the latest value of the property, you can use\nPropertyCollector methods RetrievePropertiesEx or WaitForUpdatesEx.\nIf you use the PropertyCollector...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getResourcePoolMoIdRuntime" }, "task": true }, { "name": "getResourcePoolMoIdSummary", "summary": "Basic information about a resource pool.", "description": "Basic information about a resource pool.\n\nIn releases after vSphere API 5.0, vSphere Servers might not\ngenerate property collector update notifications for this property.\nTo obtain the latest value of the property, you can use\nPropertyCollector methods RetrievePropertiesEx or WaitForUpdatesEx.\nIf you use the PropertyCollector.WaitForUpdatesEx method, specify\nan empty string for the version parameter. Any other version value will not\nproduce any property values as no updates are generated.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getResourcePoolMoIdSummary" }, "task": true }, { "name": "getResourcePoolMoIdTag", "summary": "The set of tags associated with this managed entity.", "description": "The set of tags associated with this managed entity.\n\nExperimental. Subject to change.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getResourcePoolMoIdTag" }, "task": true }, { "name": "getResourcePoolMoIdTriggeredAlarmState", "summary": "A set of alarm states for alarms triggered by this entity\nor by its descendants.", "description": "A set of alarm states for alarms triggered by this entity\nor by its descendants.\n\nTriggered alarms are propagated up the inventory hierarchy\nso that a user can readily tell when a descendant has triggered an alarm.\nIn releases after vSphere API 5.0, vSphere Servers might not\ngenerate property collector update notifications for this property.\nTo obtain the latest value of the property, you can use\nPropertyCollector methods RetrievePropertiesEx or WaitForUpdatesEx.\nIf you use the PropertyCollector...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getResourcePoolMoIdTriggeredAlarmState" }, "task": true }, { "name": "getResourcePoolMoIdValue", "summary": "List of custom field values.", "description": "List of custom field values.\n\nEach value uses a key to associate\nan instance of a *CustomFieldStringValue* with\na custom field definition.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getResourcePoolMoIdValue" }, "task": true }, { "name": "getResourcePoolMoIdVm", "summary": "The set of virtual machines associated with this resource pool.", "description": "The set of virtual machines associated with this resource pool.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getResourcePoolMoIdVm" }, "task": true }, { "name": "postScheduledTaskMoIdReconfigureScheduledTask", "summary": "Reconfigures the scheduled task properties.", "description": "Reconfigures the scheduled task properties.\n\n***Required privileges:*** ScheduledTask.Edit", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postScheduledTaskMoIdReconfigureScheduledTask" }, "task": true }, { "name": "postScheduledTaskMoIdRemoveScheduledTask", "summary": "Removes the scheduled task.", "description": "Removes the scheduled task.\n\n***Required privileges:*** ScheduledTask.Delete", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postScheduledTaskMoIdRemoveScheduledTask" }, "task": true }, { "name": "postScheduledTaskMoIdRunScheduledTask", "summary": "Runs the scheduled task immediately.", "description": "Runs the scheduled task immediately.\n\nThe schedule for future runs remains in effect.\n\n***Required privileges:*** ScheduledTask.Run", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postScheduledTaskMoIdRunScheduledTask" }, "task": true }, { "name": "postScheduledTaskMoIdSetCustomValue", "summary": "Assigns a value to a custom field.", "description": "Assigns a value to a custom field.\n\nThe setCustomValue method requires\nwhichever updatePrivilege is defined as one of the\n*CustomFieldDef.fieldInstancePrivileges*\nfor the CustomFieldDef whose value is being changed.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postScheduledTaskMoIdSetCustomValue" }, "task": true }, { "name": "getScheduledTaskMoIdAvailableField", "summary": "List of custom field definitions that are valid for the object's type.", "description": "List of custom field definitions that are valid for the object's type.\n\nThe fields are sorted by *CustomFieldDef.name*.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getScheduledTaskMoIdAvailableField" }, "task": true }, { "name": "getScheduledTaskMoIdInfo", "summary": "Information about the current scheduled task.", "description": "Information about the current scheduled task.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getScheduledTaskMoIdInfo" }, "task": true }, { "name": "getScheduledTaskMoIdValue", "summary": "List of custom field values.", "description": "List of custom field values.\n\nEach value uses a key to associate\nan instance of a *CustomFieldStringValue* with\na custom field definition.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getScheduledTaskMoIdValue" }, "task": true }, { "name": "postScheduledTaskManagerMoIdCreateScheduledTask", "summary": "Creates a scheduled task.", "description": "Creates a scheduled task.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postScheduledTaskManagerMoIdCreateScheduledTask" }, "task": true }, { "name": "postScheduledTaskManagerMoIdCreateObjectScheduledTask", "summary": "Creates a scheduled task.", "description": "Creates a scheduled task.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postScheduledTaskManagerMoIdCreateObjectScheduledTask" }, "task": true }, { "name": "postScheduledTaskManagerMoIdRetrieveEntityScheduledTask", "summary": "Available scheduled tasks defined on the entity.", "description": "Available scheduled tasks defined on the entity.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postScheduledTaskManagerMoIdRetrieveEntityScheduledTask" }, "task": true }, { "name": "postScheduledTaskManagerMoIdRetrieveObjectScheduledTask", "summary": "Available scheduled tasks defined on the object.", "description": "Available scheduled tasks defined on the object.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postScheduledTaskManagerMoIdRetrieveObjectScheduledTask" }, "task": true }, { "name": "getScheduledTaskManagerMoIdDescription", "summary": "Static descriptive strings used in scheduled tasks.", "description": "Static descriptive strings used in scheduled tasks.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getScheduledTaskManagerMoIdDescription" }, "task": true }, { "name": "getScheduledTaskManagerMoIdScheduledTask", "summary": "All available scheduled tasks.", "description": "All available scheduled tasks.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getScheduledTaskManagerMoIdScheduledTask" }, "task": true }, { "name": "postSearchIndexMoIdFindAllByDnsName", "summary": "Finds all virtual machines or hosts by DNS name.", "description": "Finds all virtual machines or hosts by DNS name.\n\nThe DNS name for a virtual\nmachine is the one returned from VMware tools, *GuestInfo.hostName*.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postSearchIndexMoIdFindAllByDnsName" }, "task": true }, { "name": "postSearchIndexMoIdFindAllByIp", "summary": "Finds all virtual machines or hosts by IP address, where the IP address is\nin dot-decimal notation.", "description": "Finds all virtual machines or hosts by IP address, where the IP address is\nin dot-decimal notation.\n\nFor example, 10.17.12.12. The IP address for a virtual\nmachine is the one returned from VMware tools, *GuestInfo.ipAddress*.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postSearchIndexMoIdFindAllByIp" }, "task": true }, { "name": "postSearchIndexMoIdFindAllByUuid", "summary": "Finds all virtual machines or hosts by UUID.", "description": "Finds all virtual machines or hosts by UUID.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postSearchIndexMoIdFindAllByUuid" }, "task": true }, { "name": "postSearchIndexMoIdFindByDatastorePath", "summary": "Finds a virtual machine by its location on a datastore.", "description": "Finds a virtual machine by its location on a datastore.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postSearchIndexMoIdFindByDatastorePath" }, "task": true }, { "name": "postSearchIndexMoIdFindByDnsName", "summary": "Finds a virtual machine or host by DNS name.", "description": "Finds a virtual machine or host by DNS name.\n\nThe DNS name for a virtual\nmachine is the one returned from VMware tools, *GuestInfo.hostName*.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postSearchIndexMoIdFindByDnsName" }, "task": true }, { "name": "postSearchIndexMoIdFindByInventoryPath", "summary": "Finds a managed entity based on its location in the inventory.", "description": "Finds a managed entity based on its location in the inventory.\n\nThe path is\nseparated by slashes ('/'). For example, a path should be of the form\n\"My Folder/My Datacenter/vm/Discovered VM/VM1\". A leading slash or trailing\nslash is ignored. Thus, the following paths all represents the same object:\n\"a/b\", \"/a/b\", \"a/b/\", and '/a/b/'. Slashes in names must be represented using\n%2f, following the standard URL syntax. Any object in the inventory can be\nretrieved using this method, including resource ...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postSearchIndexMoIdFindByInventoryPath" }, "task": true }, { "name": "postSearchIndexMoIdFindByIp", "summary": "Finds a virtual machine or host by IP address, where the IP address is in\ndot-decimal notation.", "description": "Finds a virtual machine or host by IP address, where the IP address is in\ndot-decimal notation.\n\nFor example, 10.17.12.12. The IP address for a virtual\nmachine is the one returned from VMware tools, *GuestInfo.ipAddress*.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postSearchIndexMoIdFindByIp" }, "task": true }, { "name": "postSearchIndexMoIdFindByUuid", "summary": "Finds a virtual machine or host by BIOS or instance UUID.", "description": "Finds a virtual machine or host by BIOS or instance UUID.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postSearchIndexMoIdFindByUuid" }, "task": true }, { "name": "postSearchIndexMoIdFindChild", "summary": "Finds a particular child based on a managed entity\nname.", "description": "Finds a particular child based on a managed entity\nname.\n\nThis only searches the immediate children of a managed entity.\nFor a *Datacenter*, the host and vm folders are\nconsidered children. For a *ComputeResource*,\nthe hosts and root *ResourcePool* are considered\nchildren.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postSearchIndexMoIdFindChild" }, "task": true }, { "name": "postServiceInstanceMoIdCurrentTime", "summary": "Returns the current time on the server.", "description": "Returns the current time on the server.\n\nTo monitor non-linear time changes,\nuse the *serverClock* property.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postServiceInstanceMoIdCurrentTime" }, "task": true }, { "name": "postServiceInstanceMoIdQueryVMotionCompatibility", "summary": "Investigates the general VMotion compatibility of a virtual machine with\na set of hosts.", "description": "Deprecated as of vSphere API 4.0, use\n*VirtualMachineProvisioningChecker.QueryVMotionCompatibilityEx_Task* instead.\n\nInvestigates the general VMotion compatibility of a virtual machine with\na set of hosts.\n\nThe virtual machine may be in any power state. Hosts\nmay be in any connection state and also may be in maintenance mode.\n\n***Required privileges:*** Resource.QueryVMotion", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postServiceInstanceMoIdQueryVMotionCompatibility" }, "task": true }, { "name": "postServiceInstanceMoIdRetrieveServiceContent", "summary": "Retrieves the properties of the service instance.", "description": "Retrieves the properties of the service instance.\n\n***Required privileges:*** System.Anonymous", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postServiceInstanceMoIdRetrieveServiceContent" }, "task": true }, { "name": "postServiceInstanceMoIdRetrieveProductComponents", "summary": "Component information for bundled products", "description": "Component information for bundled products\n\n***Required privileges:*** System.Anonymous", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postServiceInstanceMoIdRetrieveProductComponents" }, "task": true }, { "name": "postServiceInstanceMoIdValidateMigration", "summary": "Checks the validity of a set of proposed migrations.", "description": "Deprecated as of vSphere API 4.0, use *VirtualMachineProvisioningChecker*\ninstead.\n\nChecks the validity of a set of proposed migrations.\n\nA migration\nis the act of changing the assigned execution host of a virtual\nmachine, which can result from invoking\n*VirtualMachine.MigrateVM_Task* or\n*VirtualMachine.RelocateVM_Task*.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postServiceInstanceMoIdValidateMigration" }, "task": true }, { "name": "getServiceInstanceMoIdCapability", "summary": "API-wide capabilities.", "description": "API-wide capabilities.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getServiceInstanceMoIdCapability" }, "task": true }, { "name": "getServiceInstanceMoIdContent", "summary": "The properties of the ServiceInstance managed object.", "description": "The properties of the ServiceInstance managed object.\n\nThe content property\nis identical to the return value from the\n*ServiceInstance.RetrieveServiceContent* method.\n\nUse the content property with the *PropertyCollector*\nto perform inventory traversal that includes the ServiceInstance.\n(In the absence of a content property, a traversal that encounters\nthe *ServiceInstance* would require calling\nthe *ServiceInstance.RetrieveServiceContent* method,\nand then invoking a second traversal to continue...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getServiceInstanceMoIdContent" }, "task": true }, { "name": "getServiceInstanceMoIdServerClock", "summary": "Contains the time most recently obtained from the server.", "description": "Contains the time most recently obtained from the server.\n\nThe time is not necessarily current. This property is intended for use\nwith the PropertyCollector *PropertyCollector.WaitForUpdates*\nmethod. The PropertyCollector will provide notification if some event occurs\nthat changes the server clock time in a non-linear fashion.\n\nYou should not rely on the serverClock property to get the current time\non the server; instead, use the *ServiceInstance.CurrentTime* method.\n\n***Required privileges:*** ...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getServiceInstanceMoIdServerClock" }, "task": true }, { "name": "postServiceManagerMoIdQueryServiceList", "summary": "A query interface that returns a list of services that match certain criteria.", "description": "A query interface that returns a list of services that match certain criteria.\n\nBesides a basic service name entry, an arbitrary list of matching locations\ncan also be specified. The location array is assumed to be a list of AND expressions,\nie, all locations must match for an entry to be considered a match.\nRegular expressions are not allowed in the query service.\n\n***Required privileges:*** Global.ServiceManagers", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postServiceManagerMoIdQueryServiceList" }, "task": true }, { "name": "getServiceManagerMoIdService", "summary": "The full list of services available in this directory.", "description": "The full list of services available in this directory.\n\n***Required privileges:*** Global.ServiceManagers", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getServiceManagerMoIdService" }, "task": true }, { "name": "postSessionManagerMoIdAcquireCloneTicket", "summary": "Acquire a session-specific ticket string which can be used to clone\nthe current session.", "description": "Acquire a session-specific ticket string which can be used to clone\nthe current session.\n\nThe caller of this operation can pass the ticket\nvalue to another entity on the client. The recipient can then call\n*SessionManager.CloneSession* with the ticket string on an unauthenticated\nsession and avoid having to re-enter credentials.\n\nThe ticket may only be used once and becomes invalid after use. The\nticket is also invalidated when the corresponding session is closed or\nexpires. The ticket is only v...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postSessionManagerMoIdAcquireCloneTicket" }, "task": true }, { "name": "postSessionManagerMoIdAcquireGenericServiceTicket", "summary": "Creates and returns a one-time credential that may be used to make the\nspecified request.", "description": "Creates and returns a one-time credential that may be used to make the\nspecified request.\n\n***Required privileges:*** System.Anonymous", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postSessionManagerMoIdAcquireGenericServiceTicket" }, "task": true }, { "name": "postSessionManagerMoIdAcquireLocalTicket", "summary": "Acquires a one-time ticket for mutual authentication between a server and client.", "description": "Acquires a one-time ticket for mutual authentication between a server and client.\n\nThe caller of this operation can use the user name and file content of\nthe returned object as the userName and password arguments for login\noperation. The local ticket that is returned becomes invalid either\nafter it is used or after a server-determined ticket expiration time\npasses. This operation can be used by servers and clients to avoid\nre-entering user credentials after authentication by the operating\nsystem...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postSessionManagerMoIdAcquireLocalTicket" }, "task": true }, { "name": "postSessionManagerMoIdCloneSession", "summary": "Clone the session specified by the clone ticket and associate it with\nthe current connection.", "description": "Clone the session specified by the clone ticket and associate it with\nthe current connection.\n\nThe current session will take on the identity\nand authorization level of the UserSession associated with the\nspecified cloning ticket.\n\nSee also *SessionManager.AcquireCloneTicket*, *SessionManager.AcquireGenericServiceTicket*.\n\n***Required privileges:*** System.Anonymous", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postSessionManagerMoIdCloneSession" }, "task": true }, { "name": "postSessionManagerMoIdImpersonateUser", "summary": "Converts current session to impersonate the specified user.", "description": "Converts current session to impersonate the specified user.\n\nThe current session will take on the identity and authorization level of\nthe user. That user must have a currently-active session.\nIf the given userName is an extension key and this key does\nnot overlap with a user name of any currently-active session, it will\ntake on the identity and authorization level of that extension provided\nthe current session has the same authorization level of that extension.\n\n***Required privileges:*** Sessio...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postSessionManagerMoIdImpersonateUser" }, "task": true }, { "name": "postSessionManagerMoIdLogin", "summary": "Log on to the server.", "description": "Log on to the server.\n\nThis method fails if the user name and password are\nincorrect, or if the user is valid but has no permissions granted.\n\n***Required privileges:*** System.Anonymous", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postSessionManagerMoIdLogin" }, "task": true }, { "name": "postSessionManagerMoIdLoginBySSPI", "summary": "Log on to the server using SSPI pass-through authentication.", "description": "Deprecated as of vSphere API 5.1 for VirtualCenter login use SSO style\n*SessionManager.LoginByToken*.\n\nLog on to the server using SSPI pass-through authentication.\n\nThis method provides support for passing credentials of the calling\nprocess to the server without using a password, by leveraging the\nWindows Security Support Provider Interface (SSPI) library.\n\nIf the function is not supported, this throws a NotSupported fault.\n\nThe client first calls AcquireCredentialsHandle(). If Kerberos is\nused,...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postSessionManagerMoIdLoginBySSPI" }, "task": true }, { "name": "postSessionManagerMoIdLoginByToken", "summary": "Log on to the server through token representing principal identity.", "description": "Log on to the server through token representing principal identity.\n\nThe token is obtained from SSO (single sign-on) service. This method\nfails if the token is not valid, or the principal has no permissions\ngranted. Two type of sso tokens are supported by this method: Bearer\nand Holder-of-Key (HoK). If the token type obliges the method caller\nto prove his rights to present this token (HoK), then a signature is\nsupplied as well. The token and the security signature if available\nare provided in a ...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postSessionManagerMoIdLoginByToken" }, "task": true }, { "name": "postSessionManagerMoIdLoginExtension", "summary": "Creates a special privileged session that includes\nthe Sessions.ImpersonateUser privilege.", "description": "Deprecated as of vSphere API 4.0, use SSO style of login instead\n*SessionManager.LoginByToken*.\n\nCreates a special privileged session that includes\nthe Sessions.ImpersonateUser privilege.\n\nRequires exchange of\na message signed with the extension's registered public key\nand base-64 encoded.\n\nAs of vSphere API 4.0, the NotFound fault is no longer thrown. Instead, InvalidLogin\nis thrown if the specified extension is not registered.\n\nAs of vSphere API 5.0, this method always throws a NotSupported ex...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postSessionManagerMoIdLoginExtension" }, "task": true }, { "name": "postSessionManagerMoIdLoginExtensionByCertificate", "summary": "Creates a special privileged session that includes\nthe Sessions.ImpersonateUser privilege.", "description": "Deprecated as of vSphere API 6.0, use SSO style of login instead\n*SessionManager.LoginByToken*.\n\nCreates a special privileged session that includes\nthe Sessions.ImpersonateUser privilege.\n\nRequires that the client connect\nover SSL and provide an X.509 certificate for which they hold the private key.\nThe certificate must match the certificate used in an earlier call to\n*ExtensionManager.SetExtensionCertificate*.\n\nNOTE: Verification of the received certificate (such as expiry, revocation,\nand trus...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postSessionManagerMoIdLoginExtensionByCertificate" }, "task": true }, { "name": "postSessionManagerMoIdLoginExtensionBySubjectName", "summary": "Creates a special privileged session that includes\nthe Sessions.ImpersonateUser privilege.", "description": "Deprecated as of vSphere API 6.0, use SSO style of login instead\n*SessionManager.LoginByToken*.\n\nCreates a special privileged session that includes\nthe Sessions.ImpersonateUser privilege.\n\nRequires that the extension connected\nusing SSL, with a certificate that has a subject name that matches the subject\nname registered for the extension.\n\nAs of vSphere API 4.0, the NotFound fault is no longer thrown. Instead, InvalidLogin\nis thrown if the specified extension is not registered.\n\n***Required priv...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postSessionManagerMoIdLoginExtensionBySubjectName" }, "task": true }, { "name": "postSessionManagerMoIdLogout", "summary": "Log out and terminate the current session.", "description": "Log out and terminate the current session.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postSessionManagerMoIdLogout" }, "task": true }, { "name": "postSessionManagerMoIdSessionIsActive", "summary": "Validates that a currently-active session exists with the specified\nsessionID and userName associat", "description": "Validates that a currently-active session exists with the specified\nsessionID and userName associated with it.\n\nReturns true\nif session exists.\n\n***Required privileges:*** Sessions.ValidateSession", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postSessionManagerMoIdSessionIsActive" }, "task": true }, { "name": "postSessionManagerMoIdSetLocale", "summary": "Sets the session locale.", "description": "Sets the session locale.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postSessionManagerMoIdSetLocale" }, "task": true }, { "name": "postSessionManagerMoIdTerminateSession", "summary": "Log off and terminate the provided list of sessions.", "description": "Log off and terminate the provided list of sessions.\n\nThis method is only transactional for each session ID. The set of sessions\nare terminated sequentially, as specified in the list. If a failure\noccurs, for example, because of an unknown sessionID, the method aborts with\nan exception. When the method aborts, any sessions that have not yet been\nterminated are left in their unterminated state.\n\n***Required privileges:*** Sessions.TerminateSession", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postSessionManagerMoIdTerminateSession" }, "task": true }, { "name": "postSessionManagerMoIdUpdateServiceMessage", "summary": "Updates the system global message.", "description": "Updates the system global message.\n\nIf not blank, the message is immediately\ndisplayed to currently logged-on users. When set, the message is shown by new\nclients upon logging in.\n\n***Required privileges:*** Sessions.GlobalMessage", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postSessionManagerMoIdUpdateServiceMessage" }, "task": true }, { "name": "getSessionManagerMoIdCurrentSession", "summary": "This property contains information about the client's current session.", "description": "This property contains information about the client's current session.\n\nIf the client is not logged on, the value is null.\n\n***Required privileges:*** System.Anonymous", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getSessionManagerMoIdCurrentSession" }, "task": true }, { "name": "getSessionManagerMoIdDefaultLocale", "summary": "This is the default server locale.", "description": "This is the default server locale.\n\n***Required privileges:*** System.Anonymous", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getSessionManagerMoIdDefaultLocale" }, "task": true }, { "name": "getSessionManagerMoIdMessage", "summary": "The system global message from the server.", "description": "The system global message from the server.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getSessionManagerMoIdMessage" }, "task": true }, { "name": "getSessionManagerMoIdMessageLocaleList", "summary": "Provides the list of locales for which the server has localized messages.", "description": "Provides the list of locales for which the server has localized messages.\n\n***Required privileges:*** System.Anonymous", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getSessionManagerMoIdMessageLocaleList" }, "task": true }, { "name": "getSessionManagerMoIdSessionList", "summary": "The list of currently active sessions.", "description": "The list of currently active sessions.\n\n***Required privileges:*** Sessions.TerminateSession", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getSessionManagerMoIdSessionList" }, "task": true }, { "name": "getSessionManagerMoIdSupportedLocaleList", "summary": "Provides the list of locales that the server supports.", "description": "Provides the list of locales that the server supports.\n\nListing a locale ensures that some standardized information such as dates appear\nin the appropriate format. Other localized information, such as error messages,\nare displayed, if available. If localized information is not available, the\nmessage is returned using the system locale.\n\n***Required privileges:*** System.Anonymous", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getSessionManagerMoIdSupportedLocaleList" }, "task": true }, { "name": "postSimpleCommandMoIdExecuteSimpleCommand", "summary": "The single function execution point for this simple command.", "description": "The single function execution point for this simple command.\n\nThe actual effects of\nthis command depend upon the service handler registered for this instance.\n\n***Required privileges:*** Global.ServiceManagers", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postSimpleCommandMoIdExecuteSimpleCommand" }, "task": true }, { "name": "getSimpleCommandMoIdEncodingType", "summary": "The encoding type used in the result.", "description": "The encoding type used in the result.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getSimpleCommandMoIdEncodingType" }, "task": true }, { "name": "getSimpleCommandMoIdEntity", "summary": "A description of the service.", "description": "A description of the service.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getSimpleCommandMoIdEntity" }, "task": true }, { "name": "postSiteInfoManagerMoIdGetSiteInfo", "summary": "Returns the *SiteInfo* object associated with this vCenter.", "description": "Returns the *SiteInfo* object associated with this vCenter.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postSiteInfoManagerMoIdGetSiteInfo" }, "task": true }, { "name": "postStoragePodMoIdAddStandaloneHostTask", "summary": "Creates a new single-host compute resource.", "description": "Creates a new single-host compute resource.\n\nThe name provided can be an\nIP address, such as 192.168.0.120, or a string, such as esx120.\nIf a name is specified, a DNS lookup is used to resolve it to a fully-qualified\nname, such as esx120.vmware.com. If the DNS lookup fails, the string is\nstored as specified.\n\nLicenses for the host are allocated when making the first connection to\nthe host. This is because the license needed typically depends on the type\nof host and the number of CPUs.\n\nIn additi...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postStoragePodMoIdAddStandaloneHostTask" }, "task": true }, { "name": "postStoragePodMoIdBatchAddHostsToClusterTask", "summary": "Adds a set of new and existing hosts to the cluster.", "description": "Adds a set of new and existing hosts to the cluster.\n\nThis API is a composite API and performs the following tasks before hosts\nbecome part of the specified cluter -\n- Adds all new hosts as standalone hosts.\n- Move each host to the desired state.\n- Move each host to the cluster.\n\nThe dynamic privilege check will ensure that appropriate privileges\nare acquired to allow this API to perform multiple actions on hosts\nand cluster. Required privileges -\n- Host.Inventory.EditCluster on cluster\n- Host...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postStoragePodMoIdBatchAddHostsToClusterTask" }, "task": true }, { "name": "postStoragePodMoIdBatchAddStandaloneHostsTask", "summary": "Adds a list of hosts to inventory, as standalone hosts,\nin a single invocation.", "description": "Adds a list of hosts to inventory, as standalone hosts,\nin a single invocation.\n\nThe operation returns a result containing\na list of hosts that are successfully added.\n\nIn addition to the Host.Inventory.AddStandaloneHost privilege, the operation\nrequires System.View privilege on the VM folder that the VMs of the\nhost will be placed on.\n\n***Required privileges:*** Host.Inventory.AddStandaloneHost", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postStoragePodMoIdBatchAddStandaloneHostsTask" }, "task": true }, { "name": "postStoragePodMoIdCreateCluster", "summary": "Creates a new cluster compute resource in this folder.", "description": "Deprecated as of VI API 2.5, use *Folder.CreateClusterEx*.\n\nCreates a new cluster compute resource in this folder.\n\nAny % (percent) character used in this name parameter must be escaped, unless it\nis used to start an escape sequence. Clients may also escape any other characters\nin this name parameter.\n\n***Required privileges:*** Host.Inventory.CreateCluster", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postStoragePodMoIdCreateCluster" }, "task": true }, { "name": "postStoragePodMoIdCreateClusterEx", "summary": "Creates a new cluster compute resource in this folder.", "description": "Creates a new cluster compute resource in this folder.\n\nAny % (percent) character used in this name parameter must be escaped, unless it\nis used to start an escape sequence. Clients may also escape any other characters\nin this name parameter.\n\n***Required privileges:*** Host.Inventory.CreateCluster", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postStoragePodMoIdCreateClusterEx" }, "task": true }, { "name": "postStoragePodMoIdCreateDatacenter", "summary": "Creates a new datacenter with the given name.", "description": "Creates a new datacenter with the given name.\n\nAny % (percent) character used in this name parameter must be escaped, unless it\nis used to start an escape sequence. Clients may also escape any other characters\nin this name parameter.\n\n***Required privileges:*** Datacenter.Create", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postStoragePodMoIdCreateDatacenter" }, "task": true }, { "name": "postStoragePodMoIdCreateDVSTask", "summary": "Create a *DistributedVirtualSwitch* in the folder according to the\nspecified *DVSCreateSpec*.", "description": "Create a *DistributedVirtualSwitch* in the folder according to the\nspecified *DVSCreateSpec*.\n\nThe specified Folder\nmust be a Network entity folder.\n\n***Required privileges:*** DVSwitch.Create", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postStoragePodMoIdCreateDVSTask" }, "task": true }, { "name": "postStoragePodMoIdCreateFolder", "summary": "Creates a new sub-folder with the specified name.", "description": "Creates a new sub-folder with the specified name.\n\nThe *Folder.childType* property of the new folder is the same as\nthe *Folder.childType* property of the current folder.\n\n***Required privileges:*** Folder.Create", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postStoragePodMoIdCreateFolder" }, "task": true }, { "name": "postStoragePodMoIdCreateStoragePod", "summary": "Creates a new storage pod in this folder.", "description": "Creates a new storage pod in this folder.\n\nAny % (percent) character used in this name parameter must be escaped, unless it\nis used to start an escape sequence. Clients may also escape any other characters\nin this name parameter.\n\n***Required privileges:*** Folder.Create", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postStoragePodMoIdCreateStoragePod" }, "task": true }, { "name": "postStoragePodMoIdCreateVMTask", "summary": "Creates a new virtual machine in the current folder and attaches it to the\nspecified resource pool.", "description": "Creates a new virtual machine in the current folder and attaches it to the\nspecified resource pool.\n\nThis operation creates a virtual machine,\ninstead of cloning a virtual machine from an existing one.\n\nThe server does not support creating templates using this method.\nInstead, you should create templates by marking existing virtual\nmachines as templates, or by cloning an existing virtual machine or\ntemplate.\n\nThis operation only works if the folder's childType includes VirtualMachine.\nIn additio...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postStoragePodMoIdCreateVMTask" }, "task": true }, { "name": "postStoragePodMoIdDestroyTask", "summary": "Destroys this object, deleting its contents and removing it from its parent\nfolder (if any).", "description": "Destroys this object, deleting its contents and removing it from its parent\nfolder (if any).\n\nNOTE: The appropriate privilege must be held on the parent of the destroyed\nentity as well as the entity itself.\nThis method can throw one of several exceptions. The exact set of exceptions\ndepends on the kind of entity that is being removed. See comments for\neach entity for more information on destroy behavior.\n\n***Required privileges:*** Folder.Delete", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postStoragePodMoIdDestroyTask" }, "task": true }, { "name": "postStoragePodMoIdMoveIntoFolderTask", "summary": "Moves a set of managed entities into this folder.", "description": "Moves a set of managed entities into this folder.\n\nThis operation is typically used by clients when they implement a drag-and-drop\ninterface to move a set of objects into a folder.\n\nThis operation is transactional only with respect to each individual entity.\nThe set of entities is moved sequentially as specified in the list, and\ncommitted one at a time. If the *Folder.MoveIntoFolder_Task* method fails on an object, the\nmethod terminates at that point with an exception, leaving the rest of the\nma...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postStoragePodMoIdMoveIntoFolderTask" }, "task": true }, { "name": "postStoragePodMoIdRegisterVMTask", "summary": "Adds an existing virtual machine to the folder.", "description": "Adds an existing virtual machine to the folder.\n\nAny % (percent) character used in this name parameter must be escaped, unless it\nis used to start an escape sequence. Clients may also escape any other characters\nin this name parameter.\n\nThis operation only works if the folder's type is VirtualMachine.\nIn addition to the VirtualMachine.Inventory.Register and\nResource.AssignVMToPool privileges, it requires System.Read privilege\non the datastore that the existing virtual machine resides on. If the\n...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postStoragePodMoIdRegisterVMTask" }, "task": true }, { "name": "postStoragePodMoIdReload", "summary": "Reload the entity state.", "description": "Reload the entity state.\n\nClients only need to call this method\nif they changed some external state that affects the service\nwithout using the Web service interface to perform the change.\nFor example, hand-editing a virtual machine configuration file\naffects the configuration of the associated virtual machine but\nthe service managing the virtual machine might not monitor the\nfile for changes. In this case, after such an edit, a client\nwould call \"reload\" on the associated virtual machine to ensu...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postStoragePodMoIdReload" }, "task": true }, { "name": "postStoragePodMoIdRenameTask", "summary": "Renames this managed entity.", "description": "Renames this managed entity.\n\nAny % (percent) character used in this name parameter\nmust be escaped, unless it is used to start an escape\nsequence. Clients may also escape any other characters in\nthis name parameter.\n\nSee also *ManagedEntity.name*.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postStoragePodMoIdRenameTask" }, "task": true }, { "name": "postStoragePodMoIdSetCustomValue", "summary": "Assigns a value to a custom field.", "description": "Assigns a value to a custom field.\n\nThe setCustomValue method requires\nwhichever updatePrivilege is defined as one of the\n*CustomFieldDef.fieldInstancePrivileges*\nfor the CustomFieldDef whose value is being changed.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postStoragePodMoIdSetCustomValue" }, "task": true }, { "name": "postStoragePodMoIdUnregisterAndDestroyTask", "summary": "Recursively unregisters all virtual machines and vApps, and destroys\nall child virtual machine fold", "description": "Recursively unregisters all virtual machines and vApps, and destroys\nall child virtual machine folders.\n\nThis is similar to the Destroy\\_Task method,\nbut this method calls UnregisterAndDestroy\\_Task on each virtual machine\nobject instead of calling Destroy\\_Task.\nThis operation applies only to VirtualMachine folders.\n\nUnregisterAndDestroy\\_Task is a recursive operation that destroys the specified\nvirtual machine folder, unregisters all child virtual machine objects, and destroys\nall child virtua...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postStoragePodMoIdUnregisterAndDestroyTask" }, "task": true }, { "name": "getStoragePodMoIdAlarmActionsEnabled", "summary": "Whether alarm actions are enabled for this entity.", "description": "Whether alarm actions are enabled for this entity.\n\nTrue if enabled; false otherwise.\n\n***Required privileges:*** System.Read", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getStoragePodMoIdAlarmActionsEnabled" }, "task": true }, { "name": "getStoragePodMoIdAvailableField", "summary": "List of custom field definitions that are valid for the object's type.", "description": "List of custom field definitions that are valid for the object's type.\n\nThe fields are sorted by *CustomFieldDef.name*.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getStoragePodMoIdAvailableField" }, "task": true }, { "name": "getStoragePodMoIdChildEntity", "summary": "An array of managed object references.", "description": "An array of managed object references.\n\nEach entry is a reference to a child entity.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getStoragePodMoIdChildEntity" }, "task": true }, { "name": "getStoragePodMoIdChildType", "summary": "Specifies the object types a folder may contain.", "description": "Specifies the object types a folder may contain.\n\nWhen you create a folder, it inherits its childType from the parent folder\nin which it is created. childType is an array of strings. Each array entry\nidentifies a set of object types - Folder and one or more managed object\ntypes. The following list shows childType values for the different folders:\n- { \"vim.Folder\", \"vim.Datacenter\" } - Identifies the root folder\n and its descendant folders. Data center folders can contain\n child data center fol...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getStoragePodMoIdChildType" }, "task": true }, { "name": "getStoragePodMoIdConfigIssue", "summary": "Current configuration issues that have been detected for this entity.", "description": "Current configuration issues that have been detected for this entity.\n\nTypically,\nthese issues have already been logged as events. The entity stores these\nevents as long as they are still current. The\n*configStatus* property provides an overall status\nbased on these events.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getStoragePodMoIdConfigIssue" }, "task": true }, { "name": "getStoragePodMoIdConfigStatus", "summary": "The configStatus indicates whether or not the system has detected a configuration\nissue involving t", "description": "The configStatus indicates whether or not the system has detected a configuration\nissue involving this entity.\n\nFor example, it might have detected a\nduplicate IP address or MAC address, or a host in a cluster\nmight be out of compliance. The meanings of the configStatus values are:\n- red: A problem has been detected involving the entity.\n- yellow: A problem is about to occur or a transient condition\n has occurred (For example, reconfigure fail-over policy).\n- green: No configuration issues have...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getStoragePodMoIdConfigStatus" }, "task": true }, { "name": "getStoragePodMoIdCustomValue", "summary": "Custom field values.", "description": "Custom field values.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getStoragePodMoIdCustomValue" }, "task": true }, { "name": "getStoragePodMoIdDeclaredAlarmState", "summary": "A set of alarm states for alarms that apply to this managed entity.", "description": "A set of alarm states for alarms that apply to this managed entity.\n\nThe set includes alarms defined on this entity\nand alarms inherited from the parent entity,\nor from any ancestors in the inventory hierarchy.\n\nAlarms are inherited if they can be triggered by this entity or its descendants.\nThis set does not include alarms that are defined on descendants of this entity.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getStoragePodMoIdDeclaredAlarmState" }, "task": true }, { "name": "getStoragePodMoIdDisabledMethod", "summary": "List of operations that are disabled, given the current runtime\nstate of the entity.", "description": "List of operations that are disabled, given the current runtime\nstate of the entity.\n\nFor example, a power-on operation always fails if a\nvirtual machine is already powered on. This list can be used by clients to\nenable or disable operations in a graphical user interface.\n\nNote: This list is determined by the current runtime state of an entity,\nnot by its permissions.\n\nThis list may include the following operations for a HostSystem:\n- *HostSystem.EnterMaintenanceMode_Task*\n- *HostSystem.ExitMain...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getStoragePodMoIdDisabledMethod" }, "task": true }, { "name": "getStoragePodMoIdEffectiveRole", "summary": "Access rights the current session has to this entity.", "description": "Access rights the current session has to this entity.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getStoragePodMoIdEffectiveRole" }, "task": true }, { "name": "getStoragePodMoIdName", "summary": "Name of this entity, unique relative to its parent.", "description": "Name of this entity, unique relative to its parent.\n\nAny / (slash), \\\\ (backslash), character used in this\nname element will be escaped. Similarly, any % (percent) character used in\nthis name element will be escaped, unless it is used to start an escape\nsequence. A slash is escaped as %2F or %2f. A backslash is escaped as %5C or\n%5c, and a percent is escaped as %25.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getStoragePodMoIdName" }, "task": true }, { "name": "getStoragePodMoIdNamespace", "summary": "The namespace with which the Folder is associated.", "description": "The namespace with which the Folder is associated.\n\nNamespace is a vAPI\nresource which divides cluster resources and allows administrators to\ngive Kubernetes environments to their development teams.\nThis property is set only at the time of creation and cannot change.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getStoragePodMoIdNamespace" }, "task": true }, { "name": "getStoragePodMoIdOverallStatus", "summary": "General health of this managed entity.", "description": "General health of this managed entity.\n\nThe overall status of the managed entity is computed as the worst status\namong its alarms and the configuration issues detected on the entity.\nThe status is reported as one of the following values:\n- red: The entity has alarms or configuration issues with a red status.\n- yellow: The entity does not have alarms or configuration issues with a\n red status, and has at least one with a yellow status.\n- green: The entity does not have alarms or configuration is...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getStoragePodMoIdOverallStatus" }, "task": true }, { "name": "getStoragePodMoIdParent", "summary": "Parent of this entity.", "description": "Parent of this entity.\n\nThis value is null for the root object and for\n*VirtualMachine* objects that are part of\na *VirtualApp*.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getStoragePodMoIdParent" }, "task": true }, { "name": "getStoragePodMoIdPermission", "summary": "List of permissions defined for this entity.", "description": "List of permissions defined for this entity.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getStoragePodMoIdPermission" }, "task": true }, { "name": "getStoragePodMoIdPodStorageDrsEntry", "summary": "Storage DRS related attributes of the Storage Pod.", "description": "Storage DRS related attributes of the Storage Pod.\n\n***Required privileges:*** System.Read", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getStoragePodMoIdPodStorageDrsEntry" }, "task": true }, { "name": "getStoragePodMoIdRecentTask", "summary": "The set of recent tasks operating on this managed entity.", "description": "The set of recent tasks operating on this managed entity.\n\nThis is a subset\nof *TaskManager.recentTask* belong to this entity. A task in this\nlist could be in one of the four states: pending, running, success or error.\n\nThis property can be used to deduce intermediate power states for\na virtual machine entity. For example, if the current powerState is \"poweredOn\"\nand there is a running task performing the \"suspend\" operation, then the virtual\nmachine's intermediate state might be described as \"s...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getStoragePodMoIdRecentTask" }, "task": true }, { "name": "getStoragePodMoIdSummary", "summary": "Storage pod summary.", "description": "Storage pod summary.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getStoragePodMoIdSummary" }, "task": true }, { "name": "getStoragePodMoIdTag", "summary": "The set of tags associated with this managed entity.", "description": "The set of tags associated with this managed entity.\n\nExperimental. Subject to change.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getStoragePodMoIdTag" }, "task": true }, { "name": "getStoragePodMoIdTriggeredAlarmState", "summary": "A set of alarm states for alarms triggered by this entity\nor by its descendants.", "description": "A set of alarm states for alarms triggered by this entity\nor by its descendants.\n\nTriggered alarms are propagated up the inventory hierarchy\nso that a user can readily tell when a descendant has triggered an alarm.\nIn releases after vSphere API 5.0, vSphere Servers might not\ngenerate property collector update notifications for this property.\nTo obtain the latest value of the property, you can use\nPropertyCollector methods RetrievePropertiesEx or WaitForUpdatesEx.\nIf you use the PropertyCollector...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getStoragePodMoIdTriggeredAlarmState" }, "task": true }, { "name": "getStoragePodMoIdValue", "summary": "List of custom field values.", "description": "List of custom field values.\n\nEach value uses a key to associate\nan instance of a *CustomFieldStringValue* with\na custom field definition.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getStoragePodMoIdValue" }, "task": true }, { "name": "postStorageQueryManagerMoIdQueryHostsWithAttachedLun", "summary": "Query the set of all hosts which have the specified lun attached.", "description": "Query the set of all hosts which have the specified lun attached.\n\nRequires Host.Config.Storage privilege on the hosts which have\nthe lun in attached state.\n\n***Required privileges:*** System.Read", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postStorageQueryManagerMoIdQueryHostsWithAttachedLun" }, "task": true }, { "name": "postStorageResourceManagerMoIdConfigureDatastoreIORMTask", "summary": "Changes configuration of storage I/O resource management for a given datastore.", "description": "Deprecated as of vSphere8.0 U3, and there is no replacement for it.\n\nChanges configuration of storage I/O resource management for a given datastore.\n\nThe changes are applied to all the backing storage devices for the datastore.\nCurrently we only support storage I/O resource management on VMFS volumes.\nIn order to enable storage I/O resource management on a datstore, we require\nthat all the hosts that are attached to the datastore support this feature.\nThe privilege Datastore.ConfigIOManagement i...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postStorageResourceManagerMoIdConfigureDatastoreIORMTask" }, "task": true }, { "name": "postStorageResourceManagerMoIdQueryIORMConfigOption", "summary": "Query configuration options for storage I/O resource management.", "description": "Deprecated as of vSphere8.0 U3, and there is no replacement for it.\n\nQuery configuration options for storage I/O resource management.\n\n***Required privileges:*** Datastore.Config", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postStorageResourceManagerMoIdQueryIORMConfigOption" }, "task": true }, { "name": "postStorageResourceManagerMoIdApplyStorageDrsRecommendationTask", "summary": "Applies a recommendation from the recommendation list that is generated\nby SDRS initial placement i", "description": "Applies a recommendation from the recommendation list that is generated\nby SDRS initial placement invoked by RecommendDatastore method.\n\nIn the case of CreateVm and CloneVm a VirtualMachine is returned. Other\nworkflows don't have a return value.\n\nRequires Resource. ApplyRecommendation privilege on the storage pod.\nAdditionally, depending on the workflow where this API is called from,\nit may require the privileges of invoking one of following APIs:\n- CreateVm *Folder.CreateVM_Task*\n- AddDisk *Vir...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postStorageResourceManagerMoIdApplyStorageDrsRecommendationTask" }, "task": true }, { "name": "postStorageResourceManagerMoIdApplyStorageDrsRecommendationToPodTask", "summary": "Applies a recommendation from the recommendation list that is generated\nby SDRS load balancing acti", "description": "Applies a recommendation from the recommendation list that is generated\nby SDRS load balancing activity.\n\nEach recommendation can be applied\nonly once.\n\nRequires Resource.ApplyRecommendation privilege on the storage pod. And\nrequires Resource.ColdMigrate privilege on the virtual machine(s) that\nare relocated. Additionally requires Resource.HotMigrate privilege if\nthe virtual machine is powered on (for Storage VMotion). Also requires\nDatastore.AllocateSpace on any datastore the virtual machine or...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postStorageResourceManagerMoIdApplyStorageDrsRecommendationToPodTask" }, "task": true }, { "name": "postStorageResourceManagerMoIdCancelStorageDrsRecommendation", "summary": "Cancels a recommendation.", "description": "Cancels a recommendation.\n\nCurrently only initial placement\nrecommendations can be cancelled. Migration recommendations cannot.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postStorageResourceManagerMoIdCancelStorageDrsRecommendation" }, "task": true }, { "name": "postStorageResourceManagerMoIdConfigureStorageDrsForPodTask", "summary": "Change the storage DRS configuration for a pod *StoragePod*.", "description": "Change the storage DRS configuration for a pod *StoragePod*.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postStorageResourceManagerMoIdConfigureStorageDrsForPodTask" }, "task": true }, { "name": "postStorageResourceManagerMoIdQueryDatastorePerformanceSummary", "summary": "Returns datastore summary performance statistics.", "description": "Deprecated as of vSphere8.0 U3, and there is no replacement for it.\n\nReturns datastore summary performance statistics.\n\nThis is an experimental interface that is not intended for\nuse in production code.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postStorageResourceManagerMoIdQueryDatastorePerformanceSummary" }, "task": true }, { "name": "postStorageResourceManagerMoIdRecommendDatastores", "summary": "This method returns a *StoragePlacementResult* object.\nThis API is intended to replace the followin", "description": "This method returns a *StoragePlacementResult* object.\nThis API is intended to replace the following existing APIs for\nSDRS-enabled pods:\nCreateVm: StoragePlacementSpec::type == create =\n*Folder.CreateVM_Task*\nAddDisk: StoragePlacementSpec::type == reconfigure =\n*VirtualMachine.ReconfigVM_Task*\nRelocateVm: StoragePlacementSpec::type == relocate =\n*VirtualMachine.RelocateVM_Task*\nCloneVm: StoragePlacementSpec::type == clone =\n*VirtualMachine.CloneVM_Task*\nThe PodSelectionSpec parameter in Storage...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postStorageResourceManagerMoIdRecommendDatastores" }, "task": true }, { "name": "postStorageResourceManagerMoIdRefreshStorageDrsRecommendation", "summary": "Make Storage DRS invoke again on the specified pod *StoragePod*\nand return a new list of recommenda", "description": "Make Storage DRS invoke again on the specified pod *StoragePod*\nand return a new list of recommendations.\n\nConcurrent \"refresh\" requests\nmay be combined together and trigger only one Storage DRS invocation.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postStorageResourceManagerMoIdRefreshStorageDrsRecommendation" }, "task": true }, { "name": "postStorageResourceManagerMoIdRefreshStorageDrsRecommendationsForPodTask", "summary": "Invoke Storage DRS on a specific pod *StoragePod*\nand return a new list of recommendations.", "description": "Invoke Storage DRS on a specific pod *StoragePod*\nand return a new list of recommendations.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postStorageResourceManagerMoIdRefreshStorageDrsRecommendationsForPodTask" }, "task": true }, { "name": "postStorageResourceManagerMoIdValidateStoragePodConfig", "summary": "Validate the new storage DRS configuration for a pod\n*StoragePod*.", "description": "Validate the new storage DRS configuration for a pod\n*StoragePod*.\n\nIf validation fails, it will return with InvalidArgument fault.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postStorageResourceManagerMoIdValidateStoragePodConfig" }, "task": true }, { "name": "postTaskMoIdSetTaskDescription", "summary": "Updates task description to describe the current phase of the task.", "description": "Updates task description to describe the current phase of the task.\n\n***Required privileges:*** Task.Update", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postTaskMoIdSetTaskDescription" }, "task": true }, { "name": "postTaskMoIdUpdateProgress", "summary": "Sets percentage done for this task and recalculates overall\npercentage done.", "description": "Sets percentage done for this task and recalculates overall\npercentage done.\n\nIf a percentDone value of less than zero or\ngreater than 100 is specified, a value of zero or 100\nrespectively is used.\n\n***Required privileges:*** Task.Update", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postTaskMoIdUpdateProgress" }, "task": true }, { "name": "postTaskMoIdCancelTask", "summary": "Cancels a running or queued task.", "description": "Cancels a running or queued task.\n\nA task may only be canceled if it is\ncancelable. Multiple cancel requests will be treated as a single\ncancelation request. Canceling a completed or already canceled task\nwill throw an InvalidState exception.\n\nIf a task is canceled, its runtime state will be set to error and its\nerror state will be set to *RequestCanceled*.\n\nA cancel operation is asynchronous. The operation may return before\nthe task is canceled.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postTaskMoIdCancelTask" }, "task": true }, { "name": "postTaskMoIdSetCustomValue", "summary": "Assigns a value to a custom field.", "description": "Assigns a value to a custom field.\n\nThe setCustomValue method requires\nwhichever updatePrivilege is defined as one of the\n*CustomFieldDef.fieldInstancePrivileges*\nfor the CustomFieldDef whose value is being changed.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postTaskMoIdSetCustomValue" }, "task": true }, { "name": "postTaskMoIdSetTaskState", "summary": "Sets task state and optionally sets results or fault,\nas appropriate for state", "description": "Sets task state and optionally sets results or fault,\nas appropriate for state\n\n***Required privileges:*** Task.Update", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postTaskMoIdSetTaskState" }, "task": true }, { "name": "getTaskMoIdAvailableField", "summary": "List of custom field definitions that are valid for the object's type.", "description": "List of custom field definitions that are valid for the object's type.\n\nThe fields are sorted by *CustomFieldDef.name*.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getTaskMoIdAvailableField" }, "task": true }, { "name": "getTaskMoIdInfo", "summary": "Detailed information about this task.", "description": "Detailed information about this task.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getTaskMoIdInfo" }, "task": true }, { "name": "getTaskMoIdValue", "summary": "List of custom field values.", "description": "List of custom field values.\n\nEach value uses a key to associate\nan instance of a *CustomFieldStringValue* with\na custom field definition.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getTaskMoIdValue" }, "task": true }, { "name": "postTaskHistoryCollectorMoIdReadNextTasks", "summary": "Reads the 'scrollable view' from the current position.", "description": "Reads the 'scrollable view' from the current position.\n\nThe scrollable\nposition is moved to the next newer page after the read. No item is\nreturned when the end of the collector is reached.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postTaskHistoryCollectorMoIdReadNextTasks" }, "task": true }, { "name": "postTaskHistoryCollectorMoIdReadPreviousTasks", "summary": "Reads the 'scrollable view' from the current position.", "description": "Reads the 'scrollable view' from the current position.\n\nThe scrollable\nposition is then moved to the next older page after the read. No item is\nreturned when the head of the collector is reached.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postTaskHistoryCollectorMoIdReadPreviousTasks" }, "task": true }, { "name": "postTaskHistoryCollectorMoIdDestroyCollector", "summary": "Destroys this collector.", "description": "Destroys this collector.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postTaskHistoryCollectorMoIdDestroyCollector" }, "task": true }, { "name": "postTaskHistoryCollectorMoIdResetCollector", "summary": "Moves the \"scrollable view\" to the item immediately preceding the\n\"viewable latest page\".", "description": "Moves the \"scrollable view\" to the item immediately preceding the\n\"viewable latest page\".\n\nIf you use \"readPrev\",\n*ReadPreviousTasks* or\n*ReadPreviousEvents*,\nall items\nare retrieved from the newest item to the oldest item.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postTaskHistoryCollectorMoIdResetCollector" }, "task": true }, { "name": "postTaskHistoryCollectorMoIdRewindCollector", "summary": "Moves the \"scrollable view\" to the oldest item.", "description": "Moves the \"scrollable view\" to the oldest item.\n\nIf you use\n*ReadNextTasks* or\n*ReadNextEvents*,\nall items are retrieved from the oldest item to the newest item. This\nis the default setting when the collector is created.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postTaskHistoryCollectorMoIdRewindCollector" }, "task": true }, { "name": "postTaskHistoryCollectorMoIdSetCollectorPageSize", "summary": "Sets the \"viewable latest page\" size to contain at most the\nnumber of items specified by the maxCou", "description": "Sets the \"viewable latest page\" size to contain at most the\nnumber of items specified by the maxCount parameter).", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postTaskHistoryCollectorMoIdSetCollectorPageSize" }, "task": true }, { "name": "getTaskHistoryCollectorMoIdFilter", "summary": "The filter used to create this collector.", "description": "The filter used to create this collector.\n\nThe type of the returned filter is determined by the managed object\nfor which the collector is created.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getTaskHistoryCollectorMoIdFilter" }, "task": true }, { "name": "getTaskHistoryCollectorMoIdLatestPage", "summary": "The items in the 'viewable latest page'.", "description": "The items in the 'viewable latest page'.\n\nAs new tasks that match the\ncollector's *TaskFilterSpec* are created, they are added to this\npage, and the oldest tasks are removed from the collector to keep the\nsize of the page to that allowed by\n*HistoryCollector.SetCollectorPageSize*.\n\nThe \"oldest task\" is the one with the oldest creation time. The\ntasks in the returned page are unordered.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getTaskHistoryCollectorMoIdLatestPage" }, "task": true }, { "name": "postTaskManagerMoIdCreateCollectorForTasks", "summary": "Creates a *TaskHistoryCollector*, a\nspecialized *HistoryCollector* that gathers\n*TaskInfo* data obj", "description": "Creates a *TaskHistoryCollector*, a\nspecialized *HistoryCollector* that gathers\n*TaskInfo* data objects.\n\nA *TaskHistoryCollector* does not persist\nbeyond the current client session.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postTaskManagerMoIdCreateCollectorForTasks" }, "task": true }, { "name": "postTaskManagerMoIdCreateCollectorWithInfoFilterForTasks", "summary": "Creates a *TaskHistoryCollector*, a\nspecialized *HistoryCollector* that gathers\n*TaskInfo* data obj", "description": "Creates a *TaskHistoryCollector*, a\nspecialized *HistoryCollector* that gathers\n*TaskInfo* data objects.\n\nA *TaskHistoryCollector* does not persist\nbeyond the current client session.\n\n***Since:*** vSphere API Release 8.0.3.0\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postTaskManagerMoIdCreateCollectorWithInfoFilterForTasks" }, "task": true }, { "name": "postTaskManagerMoIdCreateTask", "summary": "Creates a new *Task*, specifying the object with which\nthe *Task* is associated, the type of task,\n", "description": "Creates a new *Task*, specifying the object with which\nthe *Task* is associated, the type of task,\nand whether the task is cancelable.\n\nUse this operation in conjunction\nwith the *ExtensionManager*.\n\n***Required privileges:*** Task.Create", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postTaskManagerMoIdCreateTask" }, "task": true }, { "name": "getTaskManagerMoIdDescription", "summary": "Locale-specific, static strings that describe *Task*\ninformation to users.", "description": "Locale-specific, static strings that describe *Task*\ninformation to users.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getTaskManagerMoIdDescription" }, "task": true }, { "name": "getTaskManagerMoIdMaxCollector", "summary": "Maximum number of *TaskHistoryCollector*\ndata objects that can exist concurrently, per client.", "description": "Maximum number of *TaskHistoryCollector*\ndata objects that can exist concurrently, per client.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getTaskManagerMoIdMaxCollector" }, "task": true }, { "name": "getTaskManagerMoIdRecentTask", "summary": "A list of *Task* managed objects that completed recently,\nthat are currently running, or that are q", "description": "A list of *Task* managed objects that completed recently,\nthat are currently running, or that are queued to run.\n\nThe list contains only *Task* objects that the client\nhas permission to access, which is determined by having permission to\naccess the *Task* object's managed *entity*.\n\nThe completed *Task* objects by default include only\n*Task* objects that completed within the past 10 minutes.\nWhen connected to vCenter Server, there is an additional default limitation\nthat each of the completed *T...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getTaskManagerMoIdRecentTask" }, "task": true }, { "name": "postTenantTenantManagerMoIdMarkServiceProviderEntities", "summary": "Define a set of ManagedEntity objects as used for tenant management.", "description": "Define a set of ManagedEntity objects as used for tenant management.\n\nThose entities are a starting point of an inventory hierarchy\n(sub-tree) that functionally exists in the tenant's inventory but are\nowned by the system user of the vCenter Server.\nThe operations which the tenant may perform on these objects depend\non the permissions granted to the tenant by the SaaS provisioning\nlayer.\nPermissions that the tenant may create on the parent objects of the\nmanagement entities do not propagate to t...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postTenantTenantManagerMoIdMarkServiceProviderEntities" }, "task": true }, { "name": "postTenantTenantManagerMoIdRetrieveServiceProviderEntities", "summary": "Retrieves the list of tenant management entities.", "description": "Retrieves the list of tenant management entities.\n\n***Required privileges:*** TenantManager.Query", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postTenantTenantManagerMoIdRetrieveServiceProviderEntities" }, "task": true }, { "name": "postTenantTenantManagerMoIdUnmarkServiceProviderEntities", "summary": "Resets the management type of an array of ManagedEntity objects.", "description": "Resets the management type of an array of ManagedEntity objects.\n\nThis operation will fail if any of the entities does not exist.\nThe method behaviour is transactional - either all entities are\nunmarked or none if an error occurs while processing them.\nThe user calling this method should hold TenantManager.Update on the\nroot folder and TenantManager.Update on each entity currently\nbeing unmarked as a service provider one. These are strict privilege\nrequirements allowing only administrators to ca...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postTenantTenantManagerMoIdUnmarkServiceProviderEntities" }, "task": true }, { "name": "postUserDirectoryMoIdRetrieveUserGroups", "summary": "Returns a list of *UserSearchResult* objects describing the\nusers and groups defined for the server.", "description": "Returns a list of *UserSearchResult* objects describing the\nusers and groups defined for the server.\n- On Windows, the search for users and groups is restricted to\n the given domain. If you omit the domain argument, then\n the search is performed on local users and groups.\n- On ESX Server (or Linux systems), the method returns the list\n of users and groups that are specified in the /etc/passwd file.\n If the password file contains Sun NIS or NIS+ users and groups,\n the returned list includes ...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postUserDirectoryMoIdRetrieveUserGroups" }, "task": true }, { "name": "getUserDirectoryMoIdDomainList", "summary": "List of Windows domains available for user searches, if the underlying\nsystem supports windows doma", "description": "List of Windows domains available for user searches, if the underlying\nsystem supports windows domain membership.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getUserDirectoryMoIdDomainList" }, "task": true }, { "name": "postVStorageObjectManagerBaseMoIdVStorageObjectCreateSnapshotExTask", "summary": "Creates a snapshot of a given VStorageObject.", "description": "Creates a snapshot of a given VStorageObject.\n\nRequires Datastore.FileManagement privilege.\n\n***Since:*** vSphere API Release 8.0.2.0\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVStorageObjectManagerBaseMoIdVStorageObjectCreateSnapshotExTask" }, "task": true }, { "name": "postVStorageObjectManagerBaseMoIdVStorageObjectDeleteSnapshotExTask", "summary": "Deletes a given snapshot of a VStorageObject.", "description": "Deletes a given snapshot of a VStorageObject.\n\nRequires Datastore.FileManagement privilege.\n\n***Since:*** vSphere API Release 8.0.2.0\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVStorageObjectManagerBaseMoIdVStorageObjectDeleteSnapshotExTask" }, "task": true }, { "name": "postVStorageObjectManagerBaseMoIdVStorageObjectExtendDiskExTask", "summary": "Expand the capacity of a virtual disk, which is a storage object with\n*disk*, to the new\ncapacity.", "description": "Expand the capacity of a virtual disk, which is a storage object with\n*disk*, to the new\ncapacity.\n\nIf new capacity is smaller than current disk capacity, then\noperation fails due to invalid capacity. If new capacity is greater\nthan current disk capacity, then operation proceeds. If new capacity\nis equal to current disk ccapcity, then operation succeeds without\nany actual extension.\nThe extended disk region will be the same as the original disk:\n\\- For a zerothick disk, the extended disk region ...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVStorageObjectManagerBaseMoIdVStorageObjectExtendDiskExTask" }, "task": true }, { "name": "postVStorageObjectManagerBaseMoIdRenameVStorageObjectEx", "summary": "Rename a virtual storage object.", "description": "Rename a virtual storage object.\n\n***Since:*** vSphere API Release 8.0.2.0\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVStorageObjectManagerBaseMoIdRenameVStorageObjectEx" }, "task": true }, { "name": "postVStorageObjectManagerBaseMoIdRevertVStorageObjectExTask", "summary": "Reverts to a given snapshot of a VStorageObject.", "description": "Reverts to a given snapshot of a VStorageObject.\n\nThis operation is supported on detached VirtualDisks\nDuring revert all the snapshots which were taken after the specified\nsnapshot would get deleted.\n\nE.g. Consider Disk with 4 snapshots\n\nBaseDisk -> Snap-2 -> Snap-3 -> Snap-4 -> Running-Point\n\nIf user chooses to revert to snap-2 then snap-4 and snap-3 would also\nbe deleted. After revert operation disk would have below configuration:\n\nBaseDisk -> Snap-2 -> Running-Point\n\nRequire...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVStorageObjectManagerBaseMoIdRevertVStorageObjectExTask" }, "task": true }, { "name": "postVcenterVStorageObjectManagerMoIdRevertVStorageObjectTask", "summary": "Reverts to a given snapshot of a VStorageObject.", "description": "Reverts to a given snapshot of a VStorageObject.\n\nThis operation is supported on detached VirtualDisks\nDuring revert all the snapshots which were taken after the specified\nsnapshot would get deleted.\n\nE.g. Consider Disk with 4 snapshots\n\nBaseDisk -> Snap-2 -> Snap-3 -> Snap-4 -> Running-Point\n\nIf user chooses to revert to snap-2 then snap-4 and snap-3 would also\nbe deleted. After revert operation disk would have below configuration:\n\nBaseDisk -> Snap-2 -> Running-Point\n\nRequire...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVcenterVStorageObjectManagerMoIdRevertVStorageObjectTask" }, "task": true }, { "name": "postVcenterVStorageObjectManagerMoIdAttachTagToVStorageObject", "summary": "Attach a tag to a virtual storage object.", "description": "Attach a tag to a virtual storage object.\n\nRequires privilege InventoryService.Tagging.AttachTag on root folder\n\n***Required privileges:*** System.Read", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVcenterVStorageObjectManagerMoIdAttachTagToVStorageObject" }, "task": true }, { "name": "postVcenterVStorageObjectManagerMoIdClearVStorageObjectControlFlags", "summary": "Clear control flags on VStorageObject.", "description": "Clear control flags on VStorageObject.\n\nThe control flags are defined in\n*vslmVStorageObjectControlFlag_enum*.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVcenterVStorageObjectManagerMoIdClearVStorageObjectControlFlags" }, "task": true }, { "name": "postVcenterVStorageObjectManagerMoIdCloneVStorageObjectTask", "summary": "Clone a virtual storage object.", "description": "Clone a virtual storage object.\n\nRequires Datastore.FileManagement privilege on both source and\ndestination datastore.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVcenterVStorageObjectManagerMoIdCloneVStorageObjectTask" }, "task": true }, { "name": "postVcenterVStorageObjectManagerMoIdCreateDiskTask", "summary": "Create a virtual disk, which is a storage object with\n*disk*\nas consumption type.", "description": "Create a virtual disk, which is a storage object with\n*disk*\nas consumption type.\n\nRequires Datastore.FileManagement privilege on the datastore where the\nvirtual disk object is created.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVcenterVStorageObjectManagerMoIdCreateDiskTask" }, "task": true }, { "name": "postVcenterVStorageObjectManagerMoIdCreateDiskFromSnapshotTask", "summary": "Creates a new Disk from given snapshot of a VStorageObject.", "description": "Creates a new Disk from given snapshot of a VStorageObject.\n\nRequires Datastore.FileManagement privilege.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVcenterVStorageObjectManagerMoIdCreateDiskFromSnapshotTask" }, "task": true }, { "name": "postVcenterVStorageObjectManagerMoIdVStorageObjectCreateSnapshotTask", "summary": "Creates a snapshot of a given VStorageObject.", "description": "Creates a snapshot of a given VStorageObject.\n\nRequires Datastore.FileManagement privilege.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVcenterVStorageObjectManagerMoIdVStorageObjectCreateSnapshotTask" }, "task": true }, { "name": "postVcenterVStorageObjectManagerMoIdVStorageObjectCreateSnapshotExTask", "summary": "Creates a snapshot of a given VStorageObject.", "description": "Creates a snapshot of a given VStorageObject.\n\nRequires Datastore.FileManagement privilege.\n\n***Since:*** vSphere API Release 8.0.2.0\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVcenterVStorageObjectManagerMoIdVStorageObjectCreateSnapshotExTask" }, "task": true }, { "name": "postVcenterVStorageObjectManagerMoIdDeleteSnapshotTask", "summary": "Deletes a given snapshot of a VStorageObject.", "description": "Deletes a given snapshot of a VStorageObject.\n\nRequires Datastore.FileManagement privilege.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVcenterVStorageObjectManagerMoIdDeleteSnapshotTask" }, "task": true }, { "name": "postVcenterVStorageObjectManagerMoIdVStorageObjectDeleteSnapshotExTask", "summary": "Deletes a given snapshot of a VStorageObject.", "description": "Deletes a given snapshot of a VStorageObject.\n\nRequires Datastore.FileManagement privilege.\n\n***Since:*** vSphere API Release 8.0.2.0\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVcenterVStorageObjectManagerMoIdVStorageObjectDeleteSnapshotExTask" }, "task": true }, { "name": "postVcenterVStorageObjectManagerMoIdDeleteVStorageObjectTask", "summary": "Delete a virtual storage object and its associated backings.", "description": "Delete a virtual storage object and its associated backings.\n\nRequires Datastore.FileManagement privilege on the datastore where the\nvirtual storage object is located.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVcenterVStorageObjectManagerMoIdDeleteVStorageObjectTask" }, "task": true }, { "name": "postVcenterVStorageObjectManagerMoIdDeleteVStorageObjectExTask", "summary": "Delete a virtual storage object and its associated backings.", "description": "Delete a virtual storage object and its associated backings.\n\nReturns\nthe corresponding vclock upon succeess.\n\nRequires Datastore.FileManagement privilege on the datastore where the\nvirtual storage object is located.\n\n***Since:*** vSphere API Release 7.0.2.0\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVcenterVStorageObjectManagerMoIdDeleteVStorageObjectExTask" }, "task": true }, { "name": "postVcenterVStorageObjectManagerMoIdDetachTagFromVStorageObject", "summary": "Detach a tag from a virtual storage object.", "description": "Detach a tag from a virtual storage object.\n\nRequires privilege InventoryService.Tagging.AttachTag on root folder\n\n***Required privileges:*** System.Read", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVcenterVStorageObjectManagerMoIdDetachTagFromVStorageObject" }, "task": true }, { "name": "postVcenterVStorageObjectManagerMoIdExtendDiskTask", "summary": "Expand the capacity of a virtual disk, which is a storage object with\n*disk*, to the new\ncapacity.", "description": "Expand the capacity of a virtual disk, which is a storage object with\n*disk*, to the new\ncapacity.\n\nIf new capacity is smaller than current disk capacity, then\noperation fails due to invalid capacity. If new capacity is greater\nthan current disk capacity, then operation proceeds. If new capacity\nis equal to current disk ccapcity, then operation succeeds without\nany actual extension.\nThe extended disk region will be the same as the original disk:\n\\- For a zerothick disk, the extended disk region ...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVcenterVStorageObjectManagerMoIdExtendDiskTask" }, "task": true }, { "name": "postVcenterVStorageObjectManagerMoIdVStorageObjectExtendDiskExTask", "summary": "Expand the capacity of a virtual disk, which is a storage object with\n*disk*, to the new\ncapacity.", "description": "Expand the capacity of a virtual disk, which is a storage object with\n*disk*, to the new\ncapacity.\n\nIf new capacity is smaller than current disk capacity, then\noperation fails due to invalid capacity. If new capacity is greater\nthan current disk capacity, then operation proceeds. If new capacity\nis equal to current disk ccapcity, then operation succeeds without\nany actual extension.\nThe extended disk region will be the same as the original disk:\n\\- For a zerothick disk, the extended disk region ...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVcenterVStorageObjectManagerMoIdVStorageObjectExtendDiskExTask" }, "task": true }, { "name": "postVcenterVStorageObjectManagerMoIdInflateDiskTask", "summary": "Inflate a sparse or thin-provisioned virtual disk up to the full size.", "description": "Inflate a sparse or thin-provisioned virtual disk up to the full size.\n\nAdditional space allocated to the disk as a result of this operation\nwill be filled with zeros.\n\nCurrently inflateDisk API only supports the following combinations:\nValid provisioning type: THIN;\nValid Datastore: VMFS, NFS.\nInflating a disk is not applicable for VVol/VSAN datastore.\n\nRequires Datastore.FileManagement privilege on the datastore where the\nvirtual storage object is located.\n\n***Required privileges:*** System.Vi...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVcenterVStorageObjectManagerMoIdInflateDiskTask" }, "task": true }, { "name": "postVcenterVStorageObjectManagerMoIdListTagsAttachedToVStorageObject", "summary": "Lists all tags attached to virtual storage object.", "description": "Lists all tags attached to virtual storage object.\n\n***Required privileges:*** System.Read", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVcenterVStorageObjectManagerMoIdListTagsAttachedToVStorageObject" }, "task": true }, { "name": "postVcenterVStorageObjectManagerMoIdListVStorageObject", "summary": "List all virtual storage objects located on a datastore.", "description": "List all virtual storage objects located on a datastore.\n\nRequires Datastore.FileManagement privilege on the datastore where the\nvirtual storage object is located.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVcenterVStorageObjectManagerMoIdListVStorageObject" }, "task": true }, { "name": "postVcenterVStorageObjectManagerMoIdListVStorageObjectsAttachedToTag", "summary": "Lists all virtual storage objects attached to the tag.", "description": "Lists all virtual storage objects attached to the tag.\n\n***Required privileges:*** System.Read", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVcenterVStorageObjectManagerMoIdListVStorageObjectsAttachedToTag" }, "task": true }, { "name": "postVcenterVStorageObjectManagerMoIdVstorageObjectVCenterQueryChangedDiskAreas", "summary": "Get a list of areas of a virtual disk that have been modified since a\nwell-defined point in the pas", "description": "Get a list of areas of a virtual disk that have been modified since a\nwell-defined point in the past.\n\nThe beginning of the change interval is\nidentified by \"changeId\", while the end of the change interval is implied\nby the snapshot ID passed in.\n\nNote that the result of this function may contain \"false positives\"\n(i.e: flag areas of the disk as modified that are not). However, it is\nguaranteed that no changes will be missed.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVcenterVStorageObjectManagerMoIdVstorageObjectVCenterQueryChangedDiskAreas" }, "task": true }, { "name": "postVcenterVStorageObjectManagerMoIdQueryVirtualDiskUuidEx", "summary": "Get the virtual disk UUID.", "description": "Get the virtual disk UUID.\n\nThe datacenter parameter may be omitted if a URL is used to name the disk.\nA URL has the form\n> _scheme_://_authority_/folder/_path_?dcPath=_dcPath_&dsName=_dsName_\n\nwhere\n- _scheme_ is http or https .\n- _authority_ specifies the hostname or IP address of the VirtualCenter or\n ESX server and optionally the port.\n- _dcPath_ is the inventory path to the Datacenter containing the\n Datastore.\n- _dsName_ is the name of the Datastore.\n- _path_ is a slash-delimited ...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVcenterVStorageObjectManagerMoIdQueryVirtualDiskUuidEx" }, "task": true }, { "name": "postVcenterVStorageObjectManagerMoIdReconcileDatastoreInventoryTask", "summary": "Reconcile the datastore inventory info of virtual storage objects.", "description": "Reconcile the datastore inventory info of virtual storage objects.\n\nRequires Datastore.FileManagement privilege.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVcenterVStorageObjectManagerMoIdReconcileDatastoreInventoryTask" }, "task": true }, { "name": "postVcenterVStorageObjectManagerMoIdRegisterDisk", "summary": "Promote a virtual disk to a First Class Disk.", "description": "Promote a virtual disk to a First Class Disk.\n\nRequires Datastore.FileManagement privilege on the datastore where the\nvirtual disk resides.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVcenterVStorageObjectManagerMoIdRegisterDisk" }, "task": true }, { "name": "postVcenterVStorageObjectManagerMoIdRelocateVStorageObjectTask", "summary": "Relocate a virtual storage object.", "description": "Relocate a virtual storage object.\n\nRequires Datastore.FileManagement privilege on both source and\ndestination datastore.\n\nIf there is no host that has access to both source and destination datastore,\nthen limited number of concurrent relocations are supported. This number is\nset to 10.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVcenterVStorageObjectManagerMoIdRelocateVStorageObjectTask" }, "task": true }, { "name": "postVcenterVStorageObjectManagerMoIdRenameVStorageObject", "summary": "Rename a virtual storage object.", "description": "Rename a virtual storage object.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVcenterVStorageObjectManagerMoIdRenameVStorageObject" }, "task": true }, { "name": "postVcenterVStorageObjectManagerMoIdRenameVStorageObjectEx", "summary": "Rename a virtual storage object.", "description": "Rename a virtual storage object.\n\n***Since:*** vSphere API Release 8.0.2.0\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVcenterVStorageObjectManagerMoIdRenameVStorageObjectEx" }, "task": true }, { "name": "postVcenterVStorageObjectManagerMoIdRetrieveSnapshotDetails", "summary": "Retrieves snapshot disk details of a given snapshot.", "description": "Retrieves snapshot disk details of a given snapshot.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVcenterVStorageObjectManagerMoIdRetrieveSnapshotDetails" }, "task": true }, { "name": "postVcenterVStorageObjectManagerMoIdRetrieveSnapshotInfo", "summary": "Retrieves snapshot information of a given VStorageObject.", "description": "Retrieves snapshot information of a given VStorageObject.\n\nRequires Datastore.FileManagement privilege.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVcenterVStorageObjectManagerMoIdRetrieveSnapshotInfo" }, "task": true }, { "name": "postVcenterVStorageObjectManagerMoIdRetrieveVStorageInfrastructureObjectPolicy", "summary": "Retrieve virtual storage infrastructure object SBPM policy on given\ndatastore.", "description": "Retrieve virtual storage infrastructure object SBPM policy on given\ndatastore.\n\nOnly support VSAN datastore.\n\nRequires Datastore.FileManagement privilege on the datastore where the\nvirtual storage infrastructure object is located.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVcenterVStorageObjectManagerMoIdRetrieveVStorageInfrastructureObjectPolicy" }, "task": true }, { "name": "postVcenterVStorageObjectManagerMoIdRetrieveVStorageObject", "summary": "Retrieve a virtual storage object.", "description": "Retrieve a virtual storage object.\n\nRequires Datastore.FileManagement privilege on the datastore where the\nvirtual storage object is located.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVcenterVStorageObjectManagerMoIdRetrieveVStorageObject" }, "task": true }, { "name": "postVcenterVStorageObjectManagerMoIdRetrieveVStorageObjectAssociations", "summary": "Retrieve vm associations for each virtual storage object in the query.", "description": "Retrieve vm associations for each virtual storage object in the query.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVcenterVStorageObjectManagerMoIdRetrieveVStorageObjectAssociations" }, "task": true }, { "name": "postVcenterVStorageObjectManagerMoIdRetrieveVStorageObjectState", "summary": "Retrieve a virtual storage object state.", "description": "Retrieve a virtual storage object state.\n\nRequires Datastore.FileManagement privilege on the datastore where the\nvirtual storage object is located.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVcenterVStorageObjectManagerMoIdRetrieveVStorageObjectState" }, "task": true }, { "name": "postVcenterVStorageObjectManagerMoIdRevertVStorageObjectExTask", "summary": "Reverts to a given snapshot of a VStorageObject.", "description": "Reverts to a given snapshot of a VStorageObject.\n\nThis operation is supported on detached VirtualDisks\nDuring revert all the snapshots which were taken after the specified\nsnapshot would get deleted.\n\nE.g. Consider Disk with 4 snapshots\n\nBaseDisk -> Snap-2 -> Snap-3 -> Snap-4 -> Running-Point\n\nIf user chooses to revert to snap-2 then snap-4 and snap-3 would also\nbe deleted. After revert operation disk would have below configuration:\n\nBaseDisk -> Snap-2 -> Running-Point\n\nRequire...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVcenterVStorageObjectManagerMoIdRevertVStorageObjectExTask" }, "task": true }, { "name": "postVcenterVStorageObjectManagerMoIdScheduleReconcileDatastoreInventory", "summary": "Schedules reconcile of the inventory info of virtual storage objects on\none of the hosts that is co", "description": "Schedules reconcile of the inventory info of virtual storage objects on\none of the hosts that is connected with the datastore.\n\nThis method just\nschedules the reconcile operation for the nearby future and returns. Note\nthat since the reconcile operation will be executed after this method\nalready returns the success of this method should not be considered as\nsuccess of the actual reconcile operation.\n\nRequires Datastore.FileManagement privilege.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVcenterVStorageObjectManagerMoIdScheduleReconcileDatastoreInventory" }, "task": true }, { "name": "postVcenterVStorageObjectManagerMoIdSetVStorageObjectControlFlags", "summary": "Set control flags on VStorageObject.", "description": "Set control flags on VStorageObject.\n\nThe control flags are defined in\n*vslmVStorageObjectControlFlag_enum*.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVcenterVStorageObjectManagerMoIdSetVStorageObjectControlFlags" }, "task": true }, { "name": "postVcenterVStorageObjectManagerMoIdSetVirtualDiskUuidExTask", "summary": "Set the virtual disk Uuid.", "description": "Set the virtual disk Uuid.\n\nThe datacenter parameter may be omitted if a URL is used to name the disk.\nA URL has the form\n> _scheme_://_authority_/folder/_path_?dcPath=_dcPath_&dsName=_dsName_\n\nwhere\n- _scheme_ is http or https .\n- _authority_ specifies the hostname or IP address of the VirtualCenter or\n ESX server and optionally the port.\n- _dcPath_ is the inventory path to the Datacenter containing the\n Datastore.\n- _dsName_ is the name of the Datastore.\n- _path_ is a slash-delimited ...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVcenterVStorageObjectManagerMoIdSetVirtualDiskUuidExTask" }, "task": true }, { "name": "postVcenterVStorageObjectManagerMoIdUpdateVStorageInfrastructureObjectPolicyTask", "summary": "Assigns specified SBPM policy to the given virtual storage\ninfrastructure object.", "description": "Assigns specified SBPM policy to the given virtual storage\ninfrastructure object.\n\nOnly support VSAN datastore.\n\nRequires Datastore.FileManagement privilege on the datastore where the\nvirtual storage infrastructure object is located.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVcenterVStorageObjectManagerMoIdUpdateVStorageInfrastructureObjectPolicyTask" }, "task": true }, { "name": "postVcenterVStorageObjectManagerMoIdUpdateVStorageObjectCryptoTask", "summary": "Update the crypto on a virtual storage object.", "description": "Update the crypto on a virtual storage object.\n\nThis is also intended for disk encryption, decryption and re-encryption.\nTo encrypt the disk, profile must contain an encryption component.\ndisksCrypto can be left as blank, which means caller doesn't care\nwhich key is used to encrypt the disk. If it's not blank, it has to\nbe of type CryptoSpecEncrypt.\nTo decrypt the disk, profile must not contain an encryption component.\ndisksCrypto can be left as blank, if not, it has be of type\nCryptoSpecDecrypt...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVcenterVStorageObjectManagerMoIdUpdateVStorageObjectCryptoTask" }, "task": true }, { "name": "postVcenterVStorageObjectManagerMoIdVCenterUpdateVStorageObjectMetadataExTask", "summary": "Update metadata KV pairs to a virtual storage object and\nreturns the corresponding vclock upon succ", "description": "Update metadata KV pairs to a virtual storage object and\nreturns the corresponding vclock upon success.\n\n***Since:*** vSphere API Release 7.0.2.0\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVcenterVStorageObjectManagerMoIdVCenterUpdateVStorageObjectMetadataExTask" }, "task": true }, { "name": "postVcenterVStorageObjectManagerMoIdUpdateVStorageObjectPolicyTask", "summary": "Update the storage policy on a virtual storage object.", "description": "Update the storage policy on a virtual storage object.\n\nRequires Datastore.FileManagement privilege on the datastore where the\nvirtual storage object is located.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVcenterVStorageObjectManagerMoIdUpdateVStorageObjectPolicyTask" }, "task": true }, { "name": "postViewMoIdDestroyView", "summary": "Destroy this view.", "description": "Destroy this view.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postViewMoIdDestroyView" }, "task": true }, { "name": "postViewManagerMoIdCreateContainerView", "summary": "Create a *ContainerView* managed object for this session.", "description": "Create a *ContainerView* managed object for this session.\n\nThe method returns\na reference to a *ContainerView* object that has a list of managed object references.\nThe list references objects in the container and may include references to objects from\nadditional containers. You can configure the resulting list of objects by specifying\na type list and recursion. Once you have created the view, the object list always\nrepresents the current configuration of the virtual environment and reflects any\n...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postViewManagerMoIdCreateContainerView" }, "task": true }, { "name": "postViewManagerMoIdCreateInventoryView", "summary": "Create a new *InventoryView* managed object for this session.", "description": "Create a new *InventoryView* managed object for this session.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postViewManagerMoIdCreateInventoryView" }, "task": true }, { "name": "postViewManagerMoIdCreateListView", "summary": "Create a *ListView* object for this session.", "description": "Create a *ListView* object for this session.\n\nThe method returns\na session object that has a list of managed object references. The list\nof references corresponds to the input object list.\nYou can modify the resulting list after you have created the object.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postViewManagerMoIdCreateListView" }, "task": true }, { "name": "postViewManagerMoIdCreateListViewFromView", "summary": "Create a *ListView* object for this session.", "description": "Create a *ListView* object for this session.\n\nThis method uses an existing\nview to construct the object list for the new view.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postViewManagerMoIdCreateListViewFromView" }, "task": true }, { "name": "getViewManagerMoIdViewList", "summary": "An array of view references.", "description": "An array of view references.\n\nEach array entry is a managed object reference\nto a view created by this ViewManager.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getViewManagerMoIdViewList" }, "task": true }, { "name": "postVirtualAppMoIdCloneVAppTask", "summary": "Creates a clone of this vApp.", "description": "Creates a clone of this vApp.\n\nAny % (percent) character used in this name parameter must be escaped, unless it\nis used to start an escape sequence. Clients may also escape any other characters\nin this name parameter.\n\nWhen invoking this method, the following privilege checks occur:\n- The privilege VApp.Clone is required on this vApp.\n- If the target is a resource pool, the privilege\n Resource.AssignVAppToPool is required on it.\n- If the target is a vApp, the privileges VApp.Clone and\n VApp.As...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVirtualAppMoIdCloneVAppTask" }, "task": true }, { "name": "postVirtualAppMoIdCreateResourcePool", "summary": "Creates a new resource pool.", "description": "Creates a new resource pool.\n\n***Required privileges:*** Resource.CreatePool", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVirtualAppMoIdCreateResourcePool" }, "task": true }, { "name": "postVirtualAppMoIdCreateVApp", "summary": "Creates a new vApp container.", "description": "Creates a new vApp container.\n\nAny % (percent) character used in this name parameter must be escaped, unless it\nis used to start an escape sequence. Clients may also escape any other characters\nin this name parameter.\n\n***Required privileges:*** VApp.Create", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVirtualAppMoIdCreateVApp" }, "task": true }, { "name": "postVirtualAppMoIdCreateChildVMTask", "summary": "Creates a new virtual machine in a vApp container.", "description": "Creates a new virtual machine in a vApp container.\n\nThis method supports creating a virtual machine directly in a vApp. A\nvirtual machine in a vApp is not associated with a VM folder and therefore\ncannot be created using the method on a *Folder*.\n\nThis method can only be called directly on a *vApp*\nor on a resource pool that is a child of a vApp.\n\nThe privilege VirtualMachine.Inventory.Create is required on this entity. Further,\nif this is a resource pool, the privilege Resource.AssignVMToPool i...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVirtualAppMoIdCreateChildVMTask" }, "task": true }, { "name": "postVirtualAppMoIdDestroyTask", "summary": "Destroys this object, deleting its contents and removing it from its parent\nfolder (if any).", "description": "Destroys this object, deleting its contents and removing it from its parent\nfolder (if any).\n\nNOTE: The appropriate privilege must be held on the parent of the destroyed\nentity as well as the entity itself.\nThis method can throw one of several exceptions. The exact set of exceptions\ndepends on the kind of entity that is being removed. See comments for\neach entity for more information on destroy behavior.\n\n***Required privileges:*** VApp.Delete", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postVirtualAppMoIdDestroyTask" }, "task": true }, { "name": "postVirtualAppMoIdDestroyChildren", "summary": "Removes all child resource pools recursively.", "description": "Removes all child resource pools recursively.\n\nAll virtual machines and vApps\nassociated with the child resource pools get associated with this resource pool.\n\nNote that resource pools contained in child vApps are not affected.\n\nThe privilege checks performed are the following.\n- Resource.DeletePool privilege must be held on this object and each of it's\n immediate children to be destroyed.\n- If VMs are being moved, the privilege Resource.AssignVMToPool must be held\n on this resource pool as we...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postVirtualAppMoIdDestroyChildren" }, "task": true }, { "name": "postVirtualAppMoIdExportVApp", "summary": "Obtains an export lease on this vApp.", "description": "Obtains an export lease on this vApp.\n\nThe export lease contains a list\nof URLs for the disks of the virtual machines in this vApp, as well as\na ticket that gives access to these URLs.\n\nSee *HttpNfcLease* for information on how to use the lease.\n\n***Required privileges:*** VApp.Export", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postVirtualAppMoIdExportVApp" }, "task": true }, { "name": "postVirtualAppMoIdImportVApp", "summary": "Creates a new entity in this resource pool.", "description": "Creates a new entity in this resource pool.\n\nThe import process consists of two\nsteps:\n1. Create the VMs and/or vApps that make up the entity.\n2. Upload virtual disk contents.\n\nIn step 1, the client must wait for the server to create all inventory\nobjects. It does that by monitoring the *HttpNfcLease.state*\nproperty on the *HttpNfcLease* object returned from this call.\nWhen the server is done creating objects, the lease will change to the\nready state, and step 2 begins. If an error occurs whi...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVirtualAppMoIdImportVApp" }, "task": true }, { "name": "postVirtualAppMoIdMoveIntoResourcePool", "summary": "Moves a set of resource pools, vApps or virtual machines into this pool.", "description": "Moves a set of resource pools, vApps or virtual machines into this pool.\n\nThe\npools, vApps and virtual machines must be part of the cluster or standalone\nhost that contains this pool.\n\nFor each entity being moved, the move is subject to the following privilege\nchecks:\n- If the object being moved is a ResourcePool, then Resource.MovePool must be\n held on the pool being moved and it's former parent pool or vApp. If the\n target is a vApp, the privilege VApp.AssignResourcePool must be held on\n it...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVirtualAppMoIdMoveIntoResourcePool" }, "task": true }, { "name": "postVirtualAppMoIdPowerOffVAppTask", "summary": "Stops this vApp.", "description": "Stops this vApp.\n\nThe virtual machines (or child vApps) will be stopped in the order\nspecified in the vApp configuration, if force is false. If force is set\nto true, all virtual machines are powered-off (in no specific order and\npossibly in parallel) regardless of the vApp auto-start configuration.\n\nWhile a vApp is stopping, all power operations performed on sub entities are\ndisabled through the VIM API. They will throw TaskInProgress.\n\n***Required privileges:*** VApp.PowerOff", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVirtualAppMoIdPowerOffVAppTask" }, "task": true }, { "name": "postVirtualAppMoIdPowerOnVAppTask", "summary": "Starts this vApp.", "description": "Starts this vApp.\n\nThe virtual machines (or sub vApps) will be started in the order\nspecified in the vApp configuration. If the vApp is suspended\n(@see vim.VirtualApp.Summary#suspended), all suspended virtual machines\nwill be powered-on based on the defined start-up order.\n\nWhile a vApp is starting, all power operations performed on sub entities are\ndisabled through the VIM API. They will throw TaskInProgress.\n\nIn case of a failure to power-on a virtual machine, the exception from the virtual\nma...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postVirtualAppMoIdPowerOnVAppTask" }, "task": true }, { "name": "postVirtualAppMoIdQueryResourceConfigOption", "summary": "Get a value range and default values for *ResourceConfigSpec*.", "description": "Deprecated as of vSphere API 6.5.\n\nGet a value range and default values for *ResourceConfigSpec*.\n\nThis API was never implemented, and there is no replacement for it.\n\n***Required privileges:*** Resource.EditPool", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postVirtualAppMoIdQueryResourceConfigOption" }, "task": true }, { "name": "postVirtualAppMoIdRefreshRuntime", "summary": "Refreshes the resource usage data that is available in\n*ResourcePoolRuntimeInfo*.", "description": "Refreshes the resource usage data that is available in\n*ResourcePoolRuntimeInfo*.\n\nThe latest runtime resource usage of this resource pool may not be\navailable immediately after operations that alter resource usage,\nsuch as powering on a virtual machine. Invoke this method when resource\nusage may have recently changed, and the most up-to-date value in the\n*ResourcePoolRuntimeInfo* is needed.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postVirtualAppMoIdRefreshRuntime" }, "task": true }, { "name": "postVirtualAppMoIdRegisterChildVMTask", "summary": "Adds an existing virtual machine to this resource pool or vApp.", "description": "Adds an existing virtual machine to this resource pool or vApp.\n\nThis operation only works for vApps or resource pools that are children of\nvApps. To register a VM in a folder, see *Folder.RegisterVM_Task*.\n\nAny % (percent) character used in this name parameter must be escaped, unless it\nis used to start an escape sequence. Clients may also escape any other characters\nin this name parameter.\nIn addition to the VirtualMachine.Inventory.Register privilege, it\nrequires System.Read privilege on the ...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVirtualAppMoIdRegisterChildVMTask" }, "task": true }, { "name": "postVirtualAppMoIdReload", "summary": "Reload the entity state.", "description": "Reload the entity state.\n\nClients only need to call this method\nif they changed some external state that affects the service\nwithout using the Web service interface to perform the change.\nFor example, hand-editing a virtual machine configuration file\naffects the configuration of the associated virtual machine but\nthe service managing the virtual machine might not monitor the\nfile for changes. In this case, after such an edit, a client\nwould call \"reload\" on the associated virtual machine to ensu...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postVirtualAppMoIdReload" }, "task": true }, { "name": "postVirtualAppMoIdRenameTask", "summary": "Renames this managed entity.", "description": "Renames this managed entity.\n\nAny % (percent) character used in this name parameter\nmust be escaped, unless it is used to start an escape\nsequence. Clients may also escape any other characters in\nthis name parameter.\n\nSee also *ManagedEntity.name*.\n\n***Required privileges:*** VApp.Rename", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVirtualAppMoIdRenameTask" }, "task": true }, { "name": "postVirtualAppMoIdSetCustomValue", "summary": "Assigns a value to a custom field.", "description": "Assigns a value to a custom field.\n\nThe setCustomValue method requires\nwhichever updatePrivilege is defined as one of the\n*CustomFieldDef.fieldInstancePrivileges*\nfor the CustomFieldDef whose value is being changed.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVirtualAppMoIdSetCustomValue" }, "task": true }, { "name": "postVirtualAppMoIdSuspendVAppTask", "summary": "Suspends this vApp.", "description": "Suspends this vApp.\n\nSuspends all powered-on virtual machines in a vApp, including virtual machines\nin child vApps. The virtual machines are suspended in the same order as\nused for a power-off operation (reverse power-on sequence).\n\nWhile a vApp is being suspended, all power operations performed on sub entities\nare disabled through the VIM API. They will throw TaskInProgress.\n\n***Required privileges:*** VApp.Suspend", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postVirtualAppMoIdSuspendVAppTask" }, "task": true }, { "name": "postVirtualAppMoIdUnregisterVAppTask", "summary": "Removes this vApp from the inventory without removing\nany of the virtual machine's files on disk.", "description": "Removes this vApp from the inventory without removing\nany of the virtual machine's files on disk.\n\nAll high-level information\nstored with the management server (ESX Server or VirtualCenter) is\nremoved, including information such as vApp configuration, statistics,\npermissions, and alarms.\n\n***Required privileges:*** VApp.Unregister", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postVirtualAppMoIdUnregisterVAppTask" }, "task": true }, { "name": "postVirtualAppMoIdUpdateChildResourceConfiguration", "summary": "Changes resource configuration of a set of children of this resource pool.", "description": "Changes resource configuration of a set of children of this resource pool.\n\nThe\nmethod allows bulk modifications of the set of the direct children\n(virtual machines and resource pools).\n\nBulk modifications are not transactional. Each modification is made individually.\nIf a failure is encountered while applying the changes, then the processing stops,\nmeaning at least one and as many as all of the changes are not applied.\n\nA set can include a subset of the resources. Children that are not\nmentione...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVirtualAppMoIdUpdateChildResourceConfiguration" }, "task": true }, { "name": "postVirtualAppMoIdUpdateConfig", "summary": "Updates the configuration of the resource pool.", "description": "Updates the configuration of the resource pool.\n\nAny % (percent) character used in this name parameter must be escaped, unless it\nis used to start an escape sequence. Clients may also escape any other characters\nin this name parameter.\n\nThe privilege checks for this operation are as follows:\n- If this is a resource pool, the privilege Resource.EditPool is required on\n this and on the parent pool or vApp.\n- If this is a vApp, the privilege VApp.ResourceConfig is required on\n this and on the par...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVirtualAppMoIdUpdateConfig" }, "task": true }, { "name": "postVirtualAppMoIdUpdateLinkedChildren", "summary": "Reconfigure the set of linked children.", "description": "Deprecated as of vSphere API 5.1.\n\nReconfigure the set of linked children.\n\nA VirtualMachine and vApp can be added as a linked child as long as it\nis not a direct child of another vApp. In case it is a linked child, the\nexisting link is removed and replaced with the new link specified in this\ncall.\n\nAn InvalidArgument fault is thrown if a link target is a direct child\nof another vApp, or if the addition of the link will result in a vApp\nwith a cycle. For example, a vApp cannot be linked to itsel...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVirtualAppMoIdUpdateLinkedChildren" }, "task": true }, { "name": "postVirtualAppMoIdUpdateVAppConfig", "summary": "Updates the vApp configuration.", "description": "Updates the vApp configuration.\n\nUpdates in different areas require different privileges. See\n*VAppConfigSpec* for a full description.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVirtualAppMoIdUpdateVAppConfig" }, "task": true }, { "name": "getVirtualAppMoIdAlarmActionsEnabled", "summary": "Whether alarm actions are enabled for this entity.", "description": "Whether alarm actions are enabled for this entity.\n\nTrue if enabled; false otherwise.\n\n***Required privileges:*** System.Read", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getVirtualAppMoIdAlarmActionsEnabled" }, "task": true }, { "name": "getVirtualAppMoIdAvailableField", "summary": "List of custom field definitions that are valid for the object's type.", "description": "List of custom field definitions that are valid for the object's type.\n\nThe fields are sorted by *CustomFieldDef.name*.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getVirtualAppMoIdAvailableField" }, "task": true }, { "name": "getVirtualAppMoIdChildConfiguration", "summary": "The resource configuration of all direct children (VirtualMachine and\nResourcePool) of this resourc", "description": "The resource configuration of all direct children (VirtualMachine and\nResourcePool) of this resource group.\n\nProperty collector update notifications might not be generated for this\nproperty. To listen for the child configuration change, please create\nPropertyCollector filter on the child entities directly.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getVirtualAppMoIdChildConfiguration" }, "task": true }, { "name": "getVirtualAppMoIdChildLink", "summary": "List of linked children.", "description": "Deprecated as of vSphere API 5.1.\n\nList of linked children.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getVirtualAppMoIdChildLink" }, "task": true }, { "name": "getVirtualAppMoIdConfig", "summary": "Configuration of this resource pool.", "description": "Configuration of this resource pool.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getVirtualAppMoIdConfig" }, "task": true }, { "name": "getVirtualAppMoIdConfigIssue", "summary": "Current configuration issues that have been detected for this entity.", "description": "Current configuration issues that have been detected for this entity.\n\nTypically,\nthese issues have already been logged as events. The entity stores these\nevents as long as they are still current. The\n*configStatus* property provides an overall status\nbased on these events.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getVirtualAppMoIdConfigIssue" }, "task": true }, { "name": "getVirtualAppMoIdConfigStatus", "summary": "The configStatus indicates whether or not the system has detected a configuration\nissue involving t", "description": "The configStatus indicates whether or not the system has detected a configuration\nissue involving this entity.\n\nFor example, it might have detected a\nduplicate IP address or MAC address, or a host in a cluster\nmight be out of compliance. The meanings of the configStatus values are:\n- red: A problem has been detected involving the entity.\n- yellow: A problem is about to occur or a transient condition\n has occurred (For example, reconfigure fail-over policy).\n- green: No configuration issues have...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getVirtualAppMoIdConfigStatus" }, "task": true }, { "name": "getVirtualAppMoIdCustomValue", "summary": "Custom field values.", "description": "Custom field values.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getVirtualAppMoIdCustomValue" }, "task": true }, { "name": "getVirtualAppMoIdDatastore", "summary": "A collection of references to the subset of datastore objects used by this\nvApp.", "description": "A collection of references to the subset of datastore objects used by this\nvApp.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getVirtualAppMoIdDatastore" }, "task": true }, { "name": "getVirtualAppMoIdDeclaredAlarmState", "summary": "A set of alarm states for alarms that apply to this managed entity.", "description": "A set of alarm states for alarms that apply to this managed entity.\n\nThe set includes alarms defined on this entity\nand alarms inherited from the parent entity,\nor from any ancestors in the inventory hierarchy.\n\nAlarms are inherited if they can be triggered by this entity or its descendants.\nThis set does not include alarms that are defined on descendants of this entity.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getVirtualAppMoIdDeclaredAlarmState" }, "task": true }, { "name": "getVirtualAppMoIdDisabledMethod", "summary": "List of operations that are disabled, given the current runtime\nstate of the entity.", "description": "List of operations that are disabled, given the current runtime\nstate of the entity.\n\nFor example, a power-on operation always fails if a\nvirtual machine is already powered on. This list can be used by clients to\nenable or disable operations in a graphical user interface.\n\nNote: This list is determined by the current runtime state of an entity,\nnot by its permissions.\n\nThis list may include the following operations for a HostSystem:\n- *HostSystem.EnterMaintenanceMode_Task*\n- *HostSystem.ExitMain...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getVirtualAppMoIdDisabledMethod" }, "task": true }, { "name": "getVirtualAppMoIdEffectiveRole", "summary": "Access rights the current session has to this entity.", "description": "Access rights the current session has to this entity.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getVirtualAppMoIdEffectiveRole" }, "task": true }, { "name": "getVirtualAppMoIdName", "summary": "Name of this entity, unique relative to its parent.", "description": "Name of this entity, unique relative to its parent.\n\nAny / (slash), \\\\ (backslash), character used in this\nname element will be escaped. Similarly, any % (percent) character used in\nthis name element will be escaped, unless it is used to start an escape\nsequence. A slash is escaped as %2F or %2f. A backslash is escaped as %5C or\n%5c, and a percent is escaped as %25.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getVirtualAppMoIdName" }, "task": true }, { "name": "getVirtualAppMoIdNamespace", "summary": "The namespace with which the ResourcePool is associated.", "description": "The namespace with which the ResourcePool is associated.\n\nNamespace is a\nvAPI resource which divides cluster resources and allows administrators\nto give Kubernetes environments to their development teams.\nThis property is set only at the time of creation and cannot change.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getVirtualAppMoIdNamespace" }, "task": true }, { "name": "getVirtualAppMoIdNetwork", "summary": "A collection of references to the subset of network objects that\nis used by this virtual machine.", "description": "A collection of references to the subset of network objects that\nis used by this virtual machine.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getVirtualAppMoIdNetwork" }, "task": true }, { "name": "getVirtualAppMoIdOverallStatus", "summary": "General health of this managed entity.", "description": "General health of this managed entity.\n\nThe overall status of the managed entity is computed as the worst status\namong its alarms and the configuration issues detected on the entity.\nThe status is reported as one of the following values:\n- red: The entity has alarms or configuration issues with a red status.\n- yellow: The entity does not have alarms or configuration issues with a\n red status, and has at least one with a yellow status.\n- green: The entity does not have alarms or configuration is...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getVirtualAppMoIdOverallStatus" }, "task": true }, { "name": "getVirtualAppMoIdOwner", "summary": "The ComputeResource to which this set of one or more nested resource pools\nbelong.", "description": "The ComputeResource to which this set of one or more nested resource pools\nbelong.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getVirtualAppMoIdOwner" }, "task": true }, { "name": "getVirtualAppMoIdParent", "summary": "Parent of this entity.", "description": "Parent of this entity.\n\nThis value is null for the root object and for\n*VirtualMachine* objects that are part of\na *VirtualApp*.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getVirtualAppMoIdParent" }, "task": true }, { "name": "getVirtualAppMoIdParentFolder", "summary": "A reference to the parent folder in the VM and Template folder hierarchy.", "description": "A reference to the parent folder in the VM and Template folder hierarchy.\n\nThis\nis only set for a root vApp. A root vApp is a vApp that is not a child of\nanother vApp.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getVirtualAppMoIdParentFolder" }, "task": true }, { "name": "getVirtualAppMoIdParentVApp", "summary": "Reference to the parent vApp.", "description": "Reference to the parent vApp.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getVirtualAppMoIdParentVApp" }, "task": true }, { "name": "getVirtualAppMoIdPermission", "summary": "List of permissions defined for this entity.", "description": "List of permissions defined for this entity.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getVirtualAppMoIdPermission" }, "task": true }, { "name": "getVirtualAppMoIdRecentTask", "summary": "The set of recent tasks operating on this managed entity.", "description": "The set of recent tasks operating on this managed entity.\n\nThis is a subset\nof *TaskManager.recentTask* belong to this entity. A task in this\nlist could be in one of the four states: pending, running, success or error.\n\nThis property can be used to deduce intermediate power states for\na virtual machine entity. For example, if the current powerState is \"poweredOn\"\nand there is a running task performing the \"suspend\" operation, then the virtual\nmachine's intermediate state might be described as \"s...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getVirtualAppMoIdRecentTask" }, "task": true }, { "name": "getVirtualAppMoIdResourcePool", "summary": "The set of child resource pools.", "description": "The set of child resource pools.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getVirtualAppMoIdResourcePool" }, "task": true }, { "name": "getVirtualAppMoIdRuntime", "summary": "Runtime information about a resource pool.", "description": "Runtime information about a resource pool.\n\nThe *ResourcePoolResourceUsage* information within\n*ResourcePoolRuntimeInfo* can be transiently stale.\nUse *ResourcePool.RefreshRuntime* method to\nupdate the information.\nIn releases after vSphere API 5.0, vSphere Servers might not\ngenerate property collector update notifications for this property.\nTo obtain the latest value of the property, you can use\nPropertyCollector methods RetrievePropertiesEx or WaitForUpdatesEx.\nIf you use the PropertyCollector...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getVirtualAppMoIdRuntime" }, "task": true }, { "name": "getVirtualAppMoIdSummary", "summary": "Basic information about a resource pool.", "description": "Basic information about a resource pool.\n\nIn releases after vSphere API 5.0, vSphere Servers might not\ngenerate property collector update notifications for this property.\nTo obtain the latest value of the property, you can use\nPropertyCollector methods RetrievePropertiesEx or WaitForUpdatesEx.\nIf you use the PropertyCollector.WaitForUpdatesEx method, specify\nan empty string for the version parameter. Any other version value will not\nproduce any property values as no updates are generated.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getVirtualAppMoIdSummary" }, "task": true }, { "name": "getVirtualAppMoIdTag", "summary": "The set of tags associated with this managed entity.", "description": "The set of tags associated with this managed entity.\n\nExperimental. Subject to change.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getVirtualAppMoIdTag" }, "task": true }, { "name": "getVirtualAppMoIdTriggeredAlarmState", "summary": "A set of alarm states for alarms triggered by this entity\nor by its descendants.", "description": "A set of alarm states for alarms triggered by this entity\nor by its descendants.\n\nTriggered alarms are propagated up the inventory hierarchy\nso that a user can readily tell when a descendant has triggered an alarm.\nIn releases after vSphere API 5.0, vSphere Servers might not\ngenerate property collector update notifications for this property.\nTo obtain the latest value of the property, you can use\nPropertyCollector methods RetrievePropertiesEx or WaitForUpdatesEx.\nIf you use the PropertyCollector...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getVirtualAppMoIdTriggeredAlarmState" }, "task": true }, { "name": "getVirtualAppMoIdVAppConfig", "summary": "Configuration of this package.", "description": "Configuration of this package.\n\n***Required privileges:*** System.Read", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getVirtualAppMoIdVAppConfig" }, "task": true }, { "name": "getVirtualAppMoIdValue", "summary": "List of custom field values.", "description": "List of custom field values.\n\nEach value uses a key to associate\nan instance of a *CustomFieldStringValue* with\na custom field definition.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getVirtualAppMoIdValue" }, "task": true }, { "name": "getVirtualAppMoIdVm", "summary": "The set of virtual machines associated with this resource pool.", "description": "The set of virtual machines associated with this resource pool.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getVirtualAppMoIdVm" }, "task": true }, { "name": "postVirtualDiskManagerMoIdCopyVirtualDiskTask", "summary": "Copy a virtual disk, performing conversions as specified in the spec.", "description": "Copy a virtual disk, performing conversions as specified in the spec.\n\nIf source (or destination) name is specified as a URL, then the\ncorresponding datacenter parameter may be omitted.\n\nIf source and destination resolve to the same file system location,\nthe call has no effect, regardless of destSpec content.\n\nRequires Datastore.FileManagement privilege on both source and destination\ndatastores.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVirtualDiskManagerMoIdCopyVirtualDiskTask" }, "task": true }, { "name": "postVirtualDiskManagerMoIdCreateVirtualDiskTask", "summary": "Create a virtual disk.", "description": "Deprecated as of vSphere 6.5, use\n*HostVStorageObjectManager.HostCreateDisk_Task* instead.\n\nCreate a virtual disk.\n\nThe datacenter parameter may be omitted if a URL is used to name the disk.\n\nRequires Datastore.FileManagement privilege on the datastore where the\nvirtual disk is created.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVirtualDiskManagerMoIdCreateVirtualDiskTask" }, "task": true }, { "name": "postVirtualDiskManagerMoIdDefragmentVirtualDiskTask", "summary": "Defragment a sparse virtual disk.", "description": "Deprecated as of vSphere 6.5, use\n*VirtualMachine.DefragmentAllDisks* instead.\n\nDefragment a sparse virtual disk.\n\nThis is defragmentation of the virtual disk file(s) in the host operating\nsystem, not defragmentation of the guest operating system filesystem inside\nthe virtual disk.\n\nThe datacenter parameter may be omitted if a URL is used to name the disk.\n\nRequires Datastore.FileManagement privilege on the datastore where the\nvirtual disk resides.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVirtualDiskManagerMoIdDefragmentVirtualDiskTask" }, "task": true }, { "name": "postVirtualDiskManagerMoIdDeleteVirtualDiskTask", "summary": "Delete a virtual disk.", "description": "Deprecated as of vSphere 6.5, use\n*HostVStorageObjectManager.HostDeleteVStorageObject_Task* instead.\n\nDelete a virtual disk.\n\nAll files relating to the disk\nwill be deleted.\n\nDeletion of virtual disk is prohibited if it is attached to VMs.\n\nThe datacenter parameter may be omitted if a URL is used to name the disk.\n\nRequires Datastore.FileManagement privilege on the datastore where the\nvirtual disk is removed.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVirtualDiskManagerMoIdDeleteVirtualDiskTask" }, "task": true }, { "name": "postVirtualDiskManagerMoIdEagerZeroVirtualDiskTask", "summary": "Explicitly zero out unaccessed parts zeroedthick disk.", "description": "Explicitly zero out unaccessed parts zeroedthick disk.\n\nEffectively a no-op if the disk is already eagerZeroedThick.\nUnlike zeroFillVirtualDisk, which wipes the entire disk, this\noperation only affects previously unaccessed parts of the disk.\n\nThe datacenter parameter may be omitted if a URL is used to name the disk.\n\nRequires Datastore.FileManagement privilege on the datastore where the\nvirtual disk resides.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVirtualDiskManagerMoIdEagerZeroVirtualDiskTask" }, "task": true }, { "name": "postVirtualDiskManagerMoIdExtendVirtualDiskTask", "summary": "Expand the capacity of a virtual disk to the new capacity.", "description": "Deprecated as of vSphere 6.5, use\n*HostVStorageObjectManager.HostExtendDisk_Task* instead.\n\nExpand the capacity of a virtual disk to the new capacity.\n\nIf the eagerZero flag is not specified,\n\\- the extended disk region of a zerothick disk will be zeroedthick\n\\- the extended disk region of a eagerzerothick disk will be eagerzeroedthick\n\\- a thin-provisioned disk will always be extended as a thin-provisioned disk.\nIf the eagerZero flag TRUE, the extended region of the disk will\nalways be eagerly ...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVirtualDiskManagerMoIdExtendVirtualDiskTask" }, "task": true }, { "name": "postVirtualDiskManagerMoIdImportUnmanagedSnapshot", "summary": "Import an unmanaged-snapshot from Virtual-Volume(VVol) enabled\nStorage Array.", "description": "Import an unmanaged-snapshot from Virtual-Volume(VVol) enabled\nStorage Array.\n\nStorage Array may support users to take snapshots indepedent of\nVMware stack. Such copies or snapshots are known as\n'Unmanaged-Snapshots'.\nWe are providing an ability to end-users to import such\nunmanaged-snapshots as Virtual Disks.\n\nEnd-user needs to know the VVol-Identifier to import unmanaged\nsnapshot as VirtualDisk.\n\nOnce VirtualDisk is created, user can use 'Datastore Browser' to use\nwith rest of Virtual Machine ...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVirtualDiskManagerMoIdImportUnmanagedSnapshot" }, "task": true }, { "name": "postVirtualDiskManagerMoIdInflateVirtualDiskTask", "summary": "Inflate a sparse or thin-provisioned virtual disk up to the full size.", "description": "Deprecated as of vSphere 6.5, use\n*HostVStorageObjectManager.HostInflateDisk_Task* instead.\n\nInflate a sparse or thin-provisioned virtual disk up to the full size.\n\nAdditional space allocated to the disk as a result of this operation\nwill be filled with zeroes.\n\nThe datacenter parameter may be omitted if a URL is used to name the disk.\n\nRequires Datastore.FileManagement privilege on the datastore where the\nvirtual disk resides.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVirtualDiskManagerMoIdInflateVirtualDiskTask" }, "task": true }, { "name": "postVirtualDiskManagerMoIdMoveVirtualDiskTask", "summary": "Move a virtual disk and all related files from the source location specified\nby sourceName and s", "description": "Move a virtual disk and all related files from the source location specified\nby sourceName and sourceDatacenter to the destination\nlocation specified by destName and destDatacenter .\n\nIf source (or destination) name is specified as a URL, then the\ncorresponding datacenter parameter may be omitted.\n\nIf source and destination resolve to the same file system location,\nthe call has no effect.\n\nRequires Datastore.FileManagement privilege on both source and destination\ndatastores.\n\n***Required ...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVirtualDiskManagerMoIdMoveVirtualDiskTask" }, "task": true }, { "name": "postVirtualDiskManagerMoIdQueryVirtualDiskFragmentation", "summary": "Return the percentage of fragmentation of the sparse virtual disk.", "description": "Return the percentage of fragmentation of the sparse virtual disk.\n\nThis is the fragmentation of virtual disk file(s) in the host operating\nsystem, not the fragmentation of the guest operating systemS filesystem\ninside the virtual disk.\n\nThe datacenter parameter may be omitted if a URL is used to name the disk.\n\nRequires Datastore.FileManagement privilege on the datastore where the\nvirtual disk resides.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVirtualDiskManagerMoIdQueryVirtualDiskFragmentation" }, "task": true }, { "name": "postVirtualDiskManagerMoIdQueryVirtualDiskGeometry", "summary": "Get the disk geometry information for the virtual disk.", "description": "Get the disk geometry information for the virtual disk.\n\nThe datacenter parameter may be omitted if a URL is used to name the disk.\n\nRequires Datastore.FileManagement privilege on the datastore where the\nvirtual disk resides.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVirtualDiskManagerMoIdQueryVirtualDiskGeometry" }, "task": true }, { "name": "postVirtualDiskManagerMoIdQueryVirtualDiskUuid", "summary": "Get the virtual disk SCSI inquiry page 0x83 data.", "description": "Deprecated as of vSphere 6.5, use\n*HostVStorageObjectManager.HostRetrieveVStorageObject*\ninstead.\n\nGet the virtual disk SCSI inquiry page 0x83 data.\n\nThe datacenter parameter may be omitted if a URL is used to name the disk.\n\nRequires Datastore.FileManagement privilege on the datastore where the\nvirtual disk resides.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVirtualDiskManagerMoIdQueryVirtualDiskUuid" }, "task": true }, { "name": "postVirtualDiskManagerMoIdReleaseManagedSnapshot", "summary": "Release a snapshot previously imported with importUnmanagedSnapshot", "description": "Release a snapshot previously imported with importUnmanagedSnapshot\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVirtualDiskManagerMoIdReleaseManagedSnapshot" }, "task": true }, { "name": "postVirtualDiskManagerMoIdSetVirtualDiskUuid", "summary": "Set the virtual disk SCSI inquiry page 0x83 data.", "description": "Deprecated as of vSphere 6.5, use\n*HostVStorageObjectManager.HostRegisterDisk* to register\na disk as vStorageObject with new unique UUID.\n\nSet the virtual disk SCSI inquiry page 0x83 data.\n\nThe datacenter parameter may be omitted if a URL is used to name the disk.\n\nRequires Datastore.FileManagement privilege on the datastore where the\nvirtual disk resides.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVirtualDiskManagerMoIdSetVirtualDiskUuid" }, "task": true }, { "name": "postVirtualDiskManagerMoIdShrinkVirtualDiskTask", "summary": "Shrink a sparse virtual disk.", "description": "Deprecated as of vSphere 6.5, use\n*VirtualMachine.ShrinkDisk_Task* instead.\n\nShrink a sparse virtual disk.\n\nThe datacenter parameter may be omitted if a URL is used to name the disk.\n\nThe optional parameter copy specifies whether to shrink the\ndisk in copy-shrink mode or in-place mode. In copy-shrink mode,\nadditional space is required, but will result in a shrunk disk that is\nalso defragmented. In-place shrink does not require additional space,\nbut will increase fragmentation. The default beha...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVirtualDiskManagerMoIdShrinkVirtualDiskTask" }, "task": true }, { "name": "postVirtualDiskManagerMoIdZeroFillVirtualDiskTask", "summary": "Overwrite all blocks of the virtual disk with zeros.", "description": "Overwrite all blocks of the virtual disk with zeros.\n\nAll data will be lost.\n\nThe datacenter parameter may be omitted if a URL is used to name the disk.\n\nRequires Datastore.FileManagement privilege on the datastore where the\nvirtual disk resides.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVirtualDiskManagerMoIdZeroFillVirtualDiskTask" }, "task": true }, { "name": "postVirtualMachineMoIdAcquireMksTicket", "summary": "Creates and returns a one-time credential used in establishing a\nremote mouse-keyboard-screen conne", "description": "Deprecated as of vSphere API 4.1, use *VirtualMachine.AcquireTicket* instead.\n\nCreates and returns a one-time credential used in establishing a\nremote mouse-keyboard-screen connection to this virtual\nmachine.\n\nThe correct function of this method depends on being able to\nretrieve TCP binding information about the server end of the\nclient connection that is requesting the ticket. If such\ninformation is not available, the NotSupported fault is thrown.\nThis method is appropriate for SOAP and authent...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postVirtualMachineMoIdAcquireMksTicket" }, "task": true }, { "name": "postVirtualMachineMoIdAcquireTicket", "summary": "Creates and returns a one-time credential used in establishing a\nspecific connection to this virtua", "description": "Creates and returns a one-time credential used in establishing a\nspecific connection to this virtual machine, for example, a ticket\ntype of mks can be used to establish a remote mouse-keyboard-screen\nconnection.\n\nA client using this ticketing mechanism must have network\nconnectivity to the ESX server where the virtual machine is running,\nand the ESX server must be reachable to the management client from\nthe address made available to the client via the ticket.\n\nAcquiring a virtual machine ticket ...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVirtualMachineMoIdAcquireTicket" }, "task": true }, { "name": "postVirtualMachineMoIdAnswerVM", "summary": "Responds to a question that is blocking this virtual machine.", "description": "Responds to a question that is blocking this virtual machine.\n\n***Required privileges:*** VirtualMachine.Interact.AnswerQuestion", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVirtualMachineMoIdAnswerVM" }, "task": true }, { "name": "postVirtualMachineMoIdApplyEvcModeVMTask", "summary": "Applies the EVC mode masks to the virtual machine.", "description": "Applies the EVC mode masks to the virtual machine.\n\nExisting masks will be replaced by the input masks.\nIf the mask parameter is not set, then the masks on the virtual machine\nare removed.\nSee *EVCMode.featureMask* for the list of masks to provide.\nThese can be retrieved from *Capability.supportedEVCMode*,\nwhich is accessible in *ServiceInstance.capability*.\n\nThis operation is only supported if\n*VirtualMachineCapability.perVmEvcSupported* is true.\n\n***Required privileges:*** VirtualMachine.Confi...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVirtualMachineMoIdApplyEvcModeVMTask" }, "task": true }, { "name": "postVirtualMachineMoIdAttachDiskTask", "summary": "Attach an existing disk to this virtual machine.", "description": "Attach an existing disk to this virtual machine.\n\nA minimum virtual machine version of 'vmx-13' is required for this\noperation to succeed. If a compatible VM version is not satisfied,\na *DeviceUnsupportedForVmVersion* fault will be thrown.\n\n***Required privileges:*** VirtualMachine.Config.AddExistingDisk", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVirtualMachineMoIdAttachDiskTask" }, "task": true }, { "name": "postVirtualMachineMoIdCheckCustomizationSpec", "summary": "Checks the customization specification against the virtual machine configuration.", "description": "Checks the customization specification against the virtual machine configuration.\n\nFor example, this is used on a source virtual machine before a clone operation to\ncatch customization failure before the disk copy. This checks the specification's\ninternal consistency as well as for compatibility with this virtual machine's\nconfiguration.\n\n***Required privileges:*** VirtualMachine.Provisioning.Customize", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVirtualMachineMoIdCheckCustomizationSpec" }, "task": true }, { "name": "postVirtualMachineMoIdCloneVMTask", "summary": "Creates a clone of this virtual machine.", "description": "Creates a clone of this virtual machine.\n\nIf the virtual machine\nis used as a template, this method corresponds to the deploy command.\n\nAny % (percent) character used in this name parameter must be escaped, unless it\nis used to start an escape sequence. Clients may also escape any other characters\nin this name parameter.\n\nThe privilege required on the source virtual machine depends on the source\nand destination types:\n- source is virtual machine, destination is virtual machine -\n VirtualMachine...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVirtualMachineMoIdCloneVMTask" }, "task": true }, { "name": "postVirtualMachineMoIdConsolidateVMDisksTask", "summary": "Consolidate the virtual disk files of the virtual machine by finding hierarchies\nof redo logs that", "description": "Consolidate the virtual disk files of the virtual machine by finding hierarchies\nof redo logs that can be combined without violating data dependency.\n\nThe\nredundant redo logs after merging are then deleted.\nConsolidation improves I/O performance since less number of virtual disk\nfiles need to be traversed; it also reduces the storage usage. However\nadditional space is temporarily required to perform the operation. Use *VirtualMachine.EstimateStorageForConsolidateSnapshots_Task* to estimate the\nt...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postVirtualMachineMoIdConsolidateVMDisksTask" }, "task": true }, { "name": "postVirtualMachineMoIdCreateScreenshotTask", "summary": "Create a screen shot of a virtual machine.", "description": "Create a screen shot of a virtual machine.\n\n***Required privileges:*** VirtualMachine.Interact.CreateScreenshot", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postVirtualMachineMoIdCreateScreenshotTask" }, "task": true }, { "name": "postVirtualMachineMoIdCreateSecondaryVMTask", "summary": "Creates a secondary virtual machine to be part of this fault tolerant group.", "description": "Deprecated as of vSphere API 6.0, use *VirtualMachine.CreateSecondaryVMEx_Task* instead.\n\nCreates a secondary virtual machine to be part of this fault tolerant group.\n\nIf a host is specified, the secondary virtual machine will be created on it.\nOtherwise, a host will be selected by the system.\n\nIf the primary virtual machine (i.e., this virtual machine) is powered on when\nthe secondary is created, an attempt will be made to power on the secondary on\na system selected host. If the cluster is a DR...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVirtualMachineMoIdCreateSecondaryVMTask" }, "task": true }, { "name": "postVirtualMachineMoIdCreateSecondaryVMExTask", "summary": "Creates a secondary virtual machine to be part of this fault tolerant group.", "description": "Creates a secondary virtual machine to be part of this fault tolerant group.\n\nIf a host is specified, the secondary virtual machine will be created on it.\nOtherwise, a host will be selected by the system.\n\nIf a FaultToleranceConfigSpec is specified, the virtual machine's\nconfiguration files and disks will be created in the specified datastores.\n\nIf the primary virtual machine (i.e., this virtual machine) is powered on when\nthe secondary is created, an attempt will be made to power on the seconda...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVirtualMachineMoIdCreateSecondaryVMExTask" }, "task": true }, { "name": "postVirtualMachineMoIdCreateSnapshotTask", "summary": "Creates a new snapshot of this virtual machine.", "description": "Deprecated as of vSphere 8.0GA, this method is deprecated. Please\nuse *VirtualMachine.CreateSnapshotEx_Task* instead.\n\nCreates a new snapshot of this virtual machine.\n\nAs a side effect,\nthis updates the current snapshot.\n\nSnapshots are not supported for Fault Tolerance primary and secondary\nvirtual machines.\n\nAny % (percent) character used in this name parameter must be escaped, unless it\nis used to start an escape sequence. Clients may also escape any other characters\nin this name parameter.\n\n*...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVirtualMachineMoIdCreateSnapshotTask" }, "task": true }, { "name": "postVirtualMachineMoIdCreateSnapshotExTask", "summary": "Creates a new snapshot of this virtual machine.", "description": "Creates a new snapshot of this virtual machine.\n\nAs a side effect,\nthis updates the current snapshot.\n\nSnapshots are not supported for Fault Tolerance primary and secondary\nvirtual machines.\n\nAny % (percent) character used in this name parameter must be escaped,\nunless it is used to start an escape sequence. Clients may also escape\nany other characters in this name parameter.\n\n***Required privileges:*** VirtualMachine.State.CreateSnapshot", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVirtualMachineMoIdCreateSnapshotExTask" }, "task": true }, { "name": "postVirtualMachineMoIdCryptoUnlockTask", "summary": "Unlocks an encrypted virtual machine by sending the encryption keys for\nthe Virtual Machine Home an", "description": "Unlocks an encrypted virtual machine by sending the encryption keys for\nthe Virtual Machine Home and all the Virtual Disks to the ESX Server.\n\n***Required privileges:*** Cryptographer.RegisterVM", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postVirtualMachineMoIdCryptoUnlockTask" }, "task": true }, { "name": "postVirtualMachineMoIdCustomizeVMTask", "summary": "Customizes a virtual machine's guest operating system.", "description": "Customizes a virtual machine's guest operating system.\n\n***Required privileges:*** VirtualMachine.Provisioning.Customize", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVirtualMachineMoIdCustomizeVMTask" }, "task": true }, { "name": "postVirtualMachineMoIdDefragmentAllDisks", "summary": "Defragment all virtual disks attached to this virtual machine.", "description": "Defragment all virtual disks attached to this virtual machine.\n\n***Required privileges:*** VirtualMachine.Interact.DefragmentAllDisks", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postVirtualMachineMoIdDefragmentAllDisks" }, "task": true }, { "name": "postVirtualMachineMoIdDestroyTask", "summary": "Destroys this object, deleting its contents and removing it from its parent\nfolder (if any).", "description": "Destroys this object, deleting its contents and removing it from its parent\nfolder (if any).\n\nNOTE: The appropriate privilege must be held on the parent of the destroyed\nentity as well as the entity itself.\nThis method can throw one of several exceptions. The exact set of exceptions\ndepends on the kind of entity that is being removed. See comments for\neach entity for more information on destroy behavior.\n\n***Required privileges:*** VirtualMachine.Inventory.Delete", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postVirtualMachineMoIdDestroyTask" }, "task": true }, { "name": "postVirtualMachineMoIdDetachDiskTask", "summary": "Detach a disk from this virtual machine.", "description": "Detach a disk from this virtual machine.\n\n***Required privileges:*** VirtualMachine.Config.RemoveDisk", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVirtualMachineMoIdDetachDiskTask" }, "task": true }, { "name": "postVirtualMachineMoIdDisableSecondaryVMTask", "summary": "Disables the specified secondary virtual machine in this fault tolerant group.", "description": "Disables the specified secondary virtual machine in this fault tolerant group.\n\nThe specified secondary will not be automatically started on a subsequent\npower-on of the primary virtual machine.\nThis operation could leave the primary virtual machine in a non-fault\ntolerant state.\n\n***Required privileges:*** VirtualMachine.Interact.DisableSecondary", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVirtualMachineMoIdDisableSecondaryVMTask" }, "task": true }, { "name": "postVirtualMachineMoIdDropConnections", "summary": "Force the virtual machine to drop the specified connections.", "description": "Force the virtual machine to drop the specified connections.\n\nAttempt to drop the specified virtual machine connections. An attempt\nwill be made to drop all of the specified connections before returning.\n\n***Since:*** vSphere API Release 7.0.1.0\n\n***Required privileges:*** VirtualMachine.Interact.ConsoleInteract", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVirtualMachineMoIdDropConnections" }, "task": true }, { "name": "postVirtualMachineMoIdEnableSecondaryVMTask", "summary": "Enables the specified secondary virtual machine in this fault tolerant group.", "description": "Enables the specified secondary virtual machine in this fault tolerant group.\n\nThis operation is used to enable a secondary virtual machine that was\npreviously disabled by the *VirtualMachine.DisableSecondaryVM_Task*\ncall. The specified secondary will be automatically started whenever the\nprimary is powered on.\n\nIf the primary virtual machine (i.e., this virtual machine) is powered on when\nthe secondary is enabled, an attempt will be made to power on the secondary. If\na host was specified in the...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVirtualMachineMoIdEnableSecondaryVMTask" }, "task": true }, { "name": "postVirtualMachineMoIdEstimateStorageForConsolidateSnapshotsTask", "summary": "Estimate the temporary space required to consolidation disk\nfiles.", "description": "Estimate the temporary space required to consolidation disk\nfiles.\n\nThe estimation is a lower bound if the childmost writable disk\nfile will be consolidated for an online virtual machine, it is\naccurate for all other situations. This is because the space\nrequirement depending on the size of the childmost disk file and how\nwrite intensive the guest is.\n\nThis method can be used prior to invoke consolidation via\n*VirtualMachine.ConsolidateVMDisks_Task*.\n\n***Required privileges:*** VirtualMachine.St...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postVirtualMachineMoIdEstimateStorageForConsolidateSnapshotsTask" }, "task": true }, { "name": "postVirtualMachineMoIdExportVm", "summary": "Obtains an export lease on this virtual machine.", "description": "Obtains an export lease on this virtual machine.\n\nThe export lease contains\na list of URLs for the virtual disks for this virtual machine, as well as\na ticket giving access to the URLs.\n\nSee *HttpNfcLease* for information on how to use the lease.\n\n***Required privileges:*** VApp.Export", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postVirtualMachineMoIdExportVm" }, "task": true }, { "name": "postVirtualMachineMoIdExtractOvfEnvironment", "summary": "Returns the OVF environment for a virtual machine.", "description": "Returns the OVF environment for a virtual machine.\n\nIf the virtual machine has no\nvApp configuration, an empty string is returned. Also, sensitive information\nis omitted, so this method is not guaranteed to return the complete OVF\nenvironment.\n\n***Required privileges:*** VApp.ExtractOvfEnvironment", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postVirtualMachineMoIdExtractOvfEnvironment" }, "task": true }, { "name": "postVirtualMachineMoIdInstantCloneTask", "summary": "Creates a powered-on Instant Clone of a virtual machine.", "description": "Creates a powered-on Instant Clone of a virtual machine.\n\nThe new\nvirtual machine will be created on the same host and start with the\nidentical running point as the original virtual machine, sharing memory\nstate when possible and sharing disk state.\nThe original virtual machine must be in a powered-on state.\nThe privilege required for Instant Clone operation are:\n- VirtualMachine.Provisioning.Clone\n- VirtualMachine.Interact.PowerOn\n- VirtualMachine.Inventory.CreateFromExisting\n- Datastore.Alloca...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVirtualMachineMoIdInstantCloneTask" }, "task": true }, { "name": "postVirtualMachineMoIdMakePrimaryVMTask", "summary": "Makes the specified secondary virtual machine from this fault tolerant group as\nthe primary virtual", "description": "Makes the specified secondary virtual machine from this fault tolerant group as\nthe primary virtual machine.\n\n***Required privileges:*** VirtualMachine.Interact.MakePrimary", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVirtualMachineMoIdMakePrimaryVMTask" }, "task": true }, { "name": "postVirtualMachineMoIdMarkAsTemplate", "summary": "Marks a VirtualMachine object as being used as a template.", "description": "Marks a VirtualMachine object as being used as a template.\n\nNote: A VirtualMachine marked as a template cannot be powered on.\n\n***Required privileges:*** VirtualMachine.Provisioning.MarkAsTemplate", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postVirtualMachineMoIdMarkAsTemplate" }, "task": true }, { "name": "postVirtualMachineMoIdMarkAsVirtualMachine", "summary": "Clears the 'isTemplate' flag and reassociates the virtual machine with\na resource pool and host.", "description": "Clears the 'isTemplate' flag and reassociates the virtual machine with\na resource pool and host.\n\n***Required privileges:*** VirtualMachine.Provisioning.MarkAsVM", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVirtualMachineMoIdMarkAsVirtualMachine" }, "task": true }, { "name": "postVirtualMachineMoIdMigrateVMTask", "summary": "Migrates a virtual machine's execution to a specific resource pool or host.", "description": "Deprecated as of vSphere 6.5, use *VirtualMachine.RelocateVM_Task*\ninstead.\n\nMigrates a virtual machine's execution to a specific resource pool or host.\n\nRequires Resource.HotMigrate privilege if the virtual machine is powered on or\nResource.ColdMigrate privilege if the virtual machine is powered off or\nsuspended.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVirtualMachineMoIdMigrateVMTask" }, "task": true }, { "name": "postVirtualMachineMoIdMountToolsInstaller", "summary": "Mounts the VMware Tools CD installer as a CD-ROM for the guest operating system.", "description": "Mounts the VMware Tools CD installer as a CD-ROM for the guest operating system.\n\nTo monitor the status of the tools install, clients should check the tools status,\n*GuestInfo.toolsVersionStatus* and\n*GuestInfo.toolsRunningStatus*\n\n***Required privileges:*** VirtualMachine.Interact.ToolsInstall", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postVirtualMachineMoIdMountToolsInstaller" }, "task": true }, { "name": "postVirtualMachineMoIdPowerOffVMTask", "summary": "Powers off this virtual machine.", "description": "Powers off this virtual machine.\n\nIf this virtual machine is a fault tolerant primary virtual machine, this\nwill result in the secondary virtual machine(s) getting powered off as well.\n\n***Required privileges:*** VirtualMachine.Interact.PowerOff", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postVirtualMachineMoIdPowerOffVMTask" }, "task": true }, { "name": "postVirtualMachineMoIdPowerOnVMTask", "summary": "Powers on this virtual machine.", "description": "Powers on this virtual machine.\n\nIf the virtual machine is suspended,\nthis method resumes execution from the suspend point.\n\nWhen powering on a virtual machine in a cluster, the system might implicitly\nor due to the host argument, do an implicit relocation of the virtual machine\nto another host. Hence, errors related to this relocation can be thrown. If the\ncluster is a DRS cluster, DRS will be invoked if the virtual machine can be\nautomatically placed by DRS (see *DrsBehavior_enum*).\nBecause th...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVirtualMachineMoIdPowerOnVMTask" }, "task": true }, { "name": "postVirtualMachineMoIdPromoteDisksTask", "summary": "Promotes disks on this virtual machine that have delta disk backings.", "description": "Promotes disks on this virtual machine that have delta disk backings.\n\nA delta disk backing is a way to preserve a virtual disk backing\nat some point in time. A delta disk backing is a file backing which in\nturn points to the original virtual disk backing (the parent). After a delta\ndisk backing is added, all writes go to the delta disk backing. All reads\nfirst try the delta disk backing and then try the parent backing if needed.\n\nPromoting does two things\n1. If the unlink parameter is true, any...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVirtualMachineMoIdPromoteDisksTask" }, "task": true }, { "name": "postVirtualMachineMoIdPutUsbScanCodes", "summary": "Inject a sequence of USB HID scan codes into the keyboard.", "description": "Inject a sequence of USB HID scan codes into the keyboard.\n\n***Required privileges:*** VirtualMachine.Interact.PutUsbScanCodes", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVirtualMachineMoIdPutUsbScanCodes" }, "task": true }, { "name": "postVirtualMachineMoIdQueryChangedDiskAreas", "summary": "Get a list of areas of a virtual disk belonging to this VM that have\nbeen modified since a well-def", "description": "Get a list of areas of a virtual disk belonging to this VM that have\nbeen modified since a well-defined point in the past.\n\nThe beginning of\nthe change interval is identified by \"changeId\", while the end of the\nchange interval is implied by the snapshot ID passed in.\n\nNote that the result of this function may contain \"false positives\"\n(i.e: flag areas of the disk as modified that are not). However, it is\nguaranteed that no changes will be missed.\n\n***Required privileges:*** VirtualMachine.Provis...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVirtualMachineMoIdQueryChangedDiskAreas" }, "task": true }, { "name": "postVirtualMachineMoIdQueryConnections", "summary": "Ask the virtual machine for a list of connections.", "description": "Ask the virtual machine for a list of connections.\n\nThe virtual machine returns a list of connections.\nIt is possible for the array returned to be empty - a virtual machine\nmay have no connections.\n\n***Since:*** vSphere API Release 7.0.1.0\n\n***Required privileges:*** VirtualMachine.Interact.ConsoleInteract", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postVirtualMachineMoIdQueryConnections" }, "task": true }, { "name": "postVirtualMachineMoIdQueryFaultToleranceCompatibility", "summary": "This API can be invoked to determine whether a virtual machine is\ncompatible for legacy Fault Toler", "description": "Deprecated as of vSphere API 6.0.\n\nThis API can be invoked to determine whether a virtual machine is\ncompatible for legacy Fault Tolerance.\n\nThe API only checks for\nVM-specific factors that impact compatibility for RecordReplay based\nFault Tolerance. Other requirements for Fault Tolerance such as host\nprocessor compatibility, logging nic configuration and licensing are\nnot covered by this API.\nThe query returns a list of faults, each fault corresponding to a\nspecific incompatibility. If a given ...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postVirtualMachineMoIdQueryFaultToleranceCompatibility" }, "task": true }, { "name": "postVirtualMachineMoIdQueryFaultToleranceCompatibilityEx", "summary": "This API can be invoked to determine whether a virtual machine is\ncompatible for Fault Tolerance.", "description": "This API can be invoked to determine whether a virtual machine is\ncompatible for Fault Tolerance.\n\nThe API only checks for VM-specific\nfactors that impact compatibility for Fault Tolerance. Other\nrequirements for Fault Tolerance such as host processor compatibility,\nlogging nic configuration and licensing are not covered by this API.\nThe query returns a list of faults, each fault corresponding to a\nspecific incompatibility. If a given virtual machine is\ncompatible for Fault Tolerance, then the f...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVirtualMachineMoIdQueryFaultToleranceCompatibilityEx" }, "task": true }, { "name": "postVirtualMachineMoIdQueryUnownedFiles", "summary": "For all files that belong to the vm, check that the file owner\nis set to the current datastore prin", "description": "For all files that belong to the vm, check that the file owner\nis set to the current datastore principal user, as set by\n*HostDatastoreSystem.ConfigureDatastorePrincipal*\n\n***Required privileges:*** VirtualMachine.Config.QueryUnownedFiles", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postVirtualMachineMoIdQueryUnownedFiles" }, "task": true }, { "name": "postVirtualMachineMoIdRebootGuest", "summary": "Issues a command to the guest operating system asking it to perform\na reboot.", "description": "Issues a command to the guest operating system asking it to perform\na reboot.\n\nReturns immediately and does not wait for the guest operating system\nto complete the operation.\n\n***Required privileges:*** VirtualMachine.Interact.Reset", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postVirtualMachineMoIdRebootGuest" }, "task": true }, { "name": "postVirtualMachineMoIdReconfigVMTask", "summary": "Reconfigures this virtual machine.", "description": "Reconfigures this virtual machine.\n\nAll the changes in the given configuration\nare applied to the virtual machine as an atomic operation.\n\nReconfiguring the virtual machine may require any of the following privileges\ndepending on what is being changed:\n- VirtualMachine.Interact.DeviceConnection if changing the runtime connection\n state of a device as embodied by the Connectable property.\n- VirtualMachine.Interact.SetCDMedia if changing the backing of a CD-ROM\n device\n- VirtualMachine.Interact....(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVirtualMachineMoIdReconfigVMTask" }, "task": true }, { "name": "postVirtualMachineMoIdRefreshStorageInfo", "summary": "Explicitly refreshes the storage information of this virtual machine,\nupdating properties *VirtualM", "description": "Explicitly refreshes the storage information of this virtual machine,\nupdating properties *VirtualMachine.storage*, *VirtualMachine.layoutEx*\nand *VirtualMachineSummary.storage*.\n\nThis is an asynchronous operation which will return immediately; changes\nmay not be reflected in vCenter for some time.\n\n***Required privileges:*** System.Read", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postVirtualMachineMoIdRefreshStorageInfo" }, "task": true }, { "name": "postVirtualMachineMoIdReload", "summary": "Reload the entity state.", "description": "Reload the entity state.\n\nClients only need to call this method\nif they changed some external state that affects the service\nwithout using the Web service interface to perform the change.\nFor example, hand-editing a virtual machine configuration file\naffects the configuration of the associated virtual machine but\nthe service managing the virtual machine might not monitor the\nfile for changes. In this case, after such an edit, a client\nwould call \"reload\" on the associated virtual machine to ensu...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postVirtualMachineMoIdReload" }, "task": true }, { "name": "postVirtualMachineMoIdReloadVirtualMachineFromPathTask", "summary": "Reloads the configuration for this virtual machine from a given\ndatastore path.", "description": "Reloads the configuration for this virtual machine from a given\ndatastore path.\n\nThis is equivalent to unregistering and registering the\nvirtual machine from a different path. The virtual machine's hardware\nconfiguration, snapshots, guestinfo variables etc. will be\nreplaced based on the new configuration file. Other information\nassociated with the virtual machine object, such as events and\npermissions, will be preserved.\n\nThis method is only supported on vCenter Server. It can be invoked on\ninac...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVirtualMachineMoIdReloadVirtualMachineFromPathTask" }, "task": true }, { "name": "postVirtualMachineMoIdRelocateVMTask", "summary": "Relocates a virtual machine to the location specified by\n*VirtualMachineRelocateSpec*.", "description": "Relocates a virtual machine to the location specified by\n*VirtualMachineRelocateSpec*.\n\nStarting from VCenter 5.1, this API also supports relocating a template\nto a new host should the current host become inactive.\nStarting from vCenter 6.0 this API also supports relocating a VM to a new\nvCenter service.\n\nRequires the following additional permissions:\n- Resource.HotMigrate if the virtual machine is powered on.\n- Datastore.AllocateSpec if the virtual machine or its disks are\n being relocated to ...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVirtualMachineMoIdRelocateVMTask" }, "task": true }, { "name": "postVirtualMachineMoIdRemoveAllSnapshotsTask", "summary": "Remove all the snapshots associated with this virtual machine.", "description": "Remove all the snapshots associated with this virtual machine.\n\nIf the virtual\nmachine\ndoes not have any snapshots, then this operation simply returns successfully.\n\n***Required privileges:*** VirtualMachine.State.RemoveSnapshot", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVirtualMachineMoIdRemoveAllSnapshotsTask" }, "task": true }, { "name": "postVirtualMachineMoIdRenameTask", "summary": "Renames this managed entity.", "description": "Renames this managed entity.\n\nAny % (percent) character used in this name parameter\nmust be escaped, unless it is used to start an escape\nsequence. Clients may also escape any other characters in\nthis name parameter.\n\nSee also *ManagedEntity.name*.\n\n***Required privileges:*** VirtualMachine.Config.Rename", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVirtualMachineMoIdRenameTask" }, "task": true }, { "name": "postVirtualMachineMoIdResetVMTask", "summary": "Resets power on this virtual machine.", "description": "Resets power on this virtual machine.\n\nIf the current state is poweredOn,\nthen this method first performs powerOff(hard). Once the power state\nis poweredOff, then this method performs powerOn(option).\n\nAlthough this method functions as a powerOff followed by a powerOn, the\ntwo operations are atomic with respect to other clients, meaning that\nother power operations cannot be performed until the reset method completes.\n\n***Required privileges:*** VirtualMachine.Interact.Reset", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postVirtualMachineMoIdResetVMTask" }, "task": true }, { "name": "postVirtualMachineMoIdResetGuestInformation", "summary": "Clears cached guest information.", "description": "Clears cached guest information.\n\nGuest information can be cleared\nonly if the virtual machine is powered off.\n\nThis method can be useful if stale information is cached,\npreventing an IP address or MAC address from being reused.\n\n***Required privileges:*** VirtualMachine.Config.ResetGuestInfo", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postVirtualMachineMoIdResetGuestInformation" }, "task": true }, { "name": "postVirtualMachineMoIdRevertToCurrentSnapshotTask", "summary": "Reverts the virtual machine to the current snapshot.", "description": "Reverts the virtual machine to the current snapshot.\n\nThis is equivalent to\ndoing snapshot.currentSnapshot.revert.\n\nIf no snapshot exists, then the operation does nothing,\nand the virtual machine state remains unchanged.\n\n***Required privileges:*** VirtualMachine.State.RevertToSnapshot", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVirtualMachineMoIdRevertToCurrentSnapshotTask" }, "task": true }, { "name": "postVirtualMachineMoIdSendNMI", "summary": "Send a non-maskable interrupt (NMI).", "description": "Send a non-maskable interrupt (NMI).\n\nCurrently, there is no way to verify if the NMI was actually\nreceived by the guest OS.\n\n***Required privileges:*** VirtualMachine.Interact.GuestControl", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postVirtualMachineMoIdSendNMI" }, "task": true }, { "name": "postVirtualMachineMoIdSetCustomValue", "summary": "Assigns a value to a custom field.", "description": "Assigns a value to a custom field.\n\nThe setCustomValue method requires\nwhichever updatePrivilege is defined as one of the\n*CustomFieldDef.fieldInstancePrivileges*\nfor the CustomFieldDef whose value is being changed.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVirtualMachineMoIdSetCustomValue" }, "task": true }, { "name": "postVirtualMachineMoIdSetDisplayTopology", "summary": "Sets the console window's display topology as specified.", "description": "Sets the console window's display topology as specified.\n\n***Required privileges:*** VirtualMachine.Interact.ConsoleInteract", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVirtualMachineMoIdSetDisplayTopology" }, "task": true }, { "name": "postVirtualMachineMoIdSetScreenResolution", "summary": "Sets the console window's resolution as specified.", "description": "Sets the console window's resolution as specified.\n\n***Required privileges:*** VirtualMachine.Interact.ConsoleInteract", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVirtualMachineMoIdSetScreenResolution" }, "task": true }, { "name": "postVirtualMachineMoIdShutdownGuest", "summary": "Issues a command to the guest operating system asking it to perform\na clean shutdown of all service", "description": "Issues a command to the guest operating system asking it to perform\na clean shutdown of all services.\n\nReturns immediately and does not wait for the guest operating system\nto complete the operation.\n\n***Required privileges:*** VirtualMachine.Interact.PowerOff", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postVirtualMachineMoIdShutdownGuest" }, "task": true }, { "name": "postVirtualMachineMoIdStandbyGuest", "summary": "Issues a command to the guest operating system asking it to prepare for\na suspend operation.", "description": "Issues a command to the guest operating system asking it to prepare for\na suspend operation.\n\nReturns immediately and does not wait for the guest operating system\nto complete the operation.\n\n***Required privileges:*** VirtualMachine.Interact.Suspend", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postVirtualMachineMoIdStandbyGuest" }, "task": true }, { "name": "postVirtualMachineMoIdStartRecordingTask", "summary": "Initiates a recording session on this virtual machine.", "description": "Deprecated as of vsphere API 5.1.\n\nInitiates a recording session on this virtual machine.\n\nAs a side effect,\nthis operation creates a snapshot on the virtual machine, which in turn\nbecomes the current snapshot.\n\nThis is an experimental interface that is not intended for use in production code.\n\n***Required privileges:*** VirtualMachine.Interact.Record", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVirtualMachineMoIdStartRecordingTask" }, "task": true }, { "name": "postVirtualMachineMoIdStartReplayingTask", "summary": "Starts a replay session on this virtual machine.", "description": "Deprecated as of vsphere API 5.1.\n\nStarts a replay session on this virtual machine.\n\nAs a side effect,\nthis operation updates the current snapshot of the virtual machine.\n\nThis is an experimental interface that is not intended for use in production code.\n\n***Required privileges:*** VirtualMachine.Interact.Replay", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVirtualMachineMoIdStartReplayingTask" }, "task": true }, { "name": "postVirtualMachineMoIdStopRecordingTask", "summary": "Stops a currently active recording session on this virtual machine.", "description": "Deprecated as of vsphere API 5.1.\n\nStops a currently active recording session on this virtual machine.\n\nThis is an experimental interface that is not intended for use in production code.\n\n***Required privileges:*** VirtualMachine.Interact.Record", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postVirtualMachineMoIdStopRecordingTask" }, "task": true }, { "name": "postVirtualMachineMoIdStopReplayingTask", "summary": "Stops a replay session on this virtual machine.", "description": "Deprecated as of vsphere API 5.1.\n\nStops a replay session on this virtual machine.\n\nThis is an experimental interface that is not intended for use in production code.\n\n***Required privileges:*** VirtualMachine.Interact.Replay", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postVirtualMachineMoIdStopReplayingTask" }, "task": true }, { "name": "postVirtualMachineMoIdSuspendVMTask", "summary": "Suspends execution in this virtual machine.", "description": "Suspends execution in this virtual machine.\n\n***Required privileges:*** VirtualMachine.Interact.Suspend", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postVirtualMachineMoIdSuspendVMTask" }, "task": true }, { "name": "postVirtualMachineMoIdTerminateVM", "summary": "Do an immediate power off of a VM.", "description": "Do an immediate power off of a VM.\n\nThis API issues a SIGKILL to the vmx process of the VM.\nPending synchronous I/Os may not be written out before the vmx\nprocess dies depending on accessibility of the datastore.\n\n***Required privileges:*** VirtualMachine.Interact.PowerOff", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postVirtualMachineMoIdTerminateVM" }, "task": true }, { "name": "postVirtualMachineMoIdTerminateFaultTolerantVMTask", "summary": "Terminates the specified secondary virtual machine in a fault tolerant group.", "description": "Terminates the specified secondary virtual machine in a fault tolerant group.\n\nThis\ncan be used to test fault tolerance on a given virtual machine, and should\nbe used with care.\n\n***Required privileges:*** VirtualMachine.Interact.TerminateFaultTolerantVM", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVirtualMachineMoIdTerminateFaultTolerantVMTask" }, "task": true }, { "name": "postVirtualMachineMoIdTurnOffFaultToleranceForVMTask", "summary": "Removes all secondary virtual machines associated with the fault tolerant\ngroup and turns off prote", "description": "Removes all secondary virtual machines associated with the fault tolerant\ngroup and turns off protection for this virtual machine.\n\nThis operation can only be invoked from the primary virtual machine in\nthe group.\n\n***Required privileges:*** VirtualMachine.Interact.TurnOffFaultTolerance", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postVirtualMachineMoIdTurnOffFaultToleranceForVMTask" }, "task": true }, { "name": "postVirtualMachineMoIdUnmountToolsInstaller", "summary": "Unmounts VMware Tools installer CD.", "description": "Unmounts VMware Tools installer CD.\n\n***Required privileges:*** VirtualMachine.Interact.ToolsInstall", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postVirtualMachineMoIdUnmountToolsInstaller" }, "task": true }, { "name": "postVirtualMachineMoIdUnregisterVM", "summary": "Removes this virtual machine from the inventory without removing\nany of the virtual machine's files", "description": "Removes this virtual machine from the inventory without removing\nany of the virtual machine's files on disk.\n\nAll high-level information\nstored with the management server (ESX Server or VirtualCenter) is\nremoved, including information such as statistics, resource pool association,\npermissions, and alarms.\n\nUse the Folder.RegisterVM method to recreate a\nVirtualMachine object from the set of virtual machine files by passing in\nthe path to the configuration file. However, the VirtualMachine managed...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postVirtualMachineMoIdUnregisterVM" }, "task": true }, { "name": "postVirtualMachineMoIdUpgradeToolsTask", "summary": "Begins the tools upgrade process.", "description": "Begins the tools upgrade process.\n\nTo monitor the status of the tools install, clients should check the tools status,\n*GuestInfo.toolsVersionStatus* and\n*GuestInfo.toolsRunningStatus*.\n\n***Required privileges:*** VirtualMachine.Interact.ToolsInstall", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVirtualMachineMoIdUpgradeToolsTask" }, "task": true }, { "name": "postVirtualMachineMoIdUpgradeVMTask", "summary": "Upgrades this virtual machine's virtual hardware to the latest revision\nthat is supported by the vi", "description": "Upgrades this virtual machine's virtual hardware to the latest revision\nthat is supported by the virtual machine's current host.\n\n***Required privileges:*** VirtualMachine.Config.UpgradeVirtualHardware", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVirtualMachineMoIdUpgradeVMTask" }, "task": true }, { "name": "getVirtualMachineMoIdAlarmActionsEnabled", "summary": "Whether alarm actions are enabled for this entity.", "description": "Whether alarm actions are enabled for this entity.\n\nTrue if enabled; false otherwise.\n\n***Required privileges:*** System.Read", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getVirtualMachineMoIdAlarmActionsEnabled" }, "task": true }, { "name": "getVirtualMachineMoIdAvailableField", "summary": "List of custom field definitions that are valid for the object's type.", "description": "List of custom field definitions that are valid for the object's type.\n\nThe fields are sorted by *CustomFieldDef.name*.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getVirtualMachineMoIdAvailableField" }, "task": true }, { "name": "getVirtualMachineMoIdCapability", "summary": "Information about the runtime capabilities of this virtual machine.", "description": "Information about the runtime capabilities of this virtual machine.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getVirtualMachineMoIdCapability" }, "task": true }, { "name": "getVirtualMachineMoIdConfig", "summary": "Configuration of this virtual machine, including the name and UUID.", "description": "Configuration of this virtual machine, including the name and UUID.\n\nThis property is set when a virtual machine is created or when\nthe *reconfigVM* method is called.\n\nThe virtual machine configuration is not guaranteed to be available.\nFor example, the configuration information would be unavailable\nif the server is unable to access the virtual machine files on disk,\nand is often also unavailable during the initial phases of\nvirtual machine creation.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getVirtualMachineMoIdConfig" }, "task": true }, { "name": "getVirtualMachineMoIdConfigIssue", "summary": "Current configuration issues that have been detected for this entity.", "description": "Current configuration issues that have been detected for this entity.\n\nTypically,\nthese issues have already been logged as events. The entity stores these\nevents as long as they are still current. The\n*configStatus* property provides an overall status\nbased on these events.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getVirtualMachineMoIdConfigIssue" }, "task": true }, { "name": "getVirtualMachineMoIdConfigStatus", "summary": "The configStatus indicates whether or not the system has detected a configuration\nissue involving t", "description": "The configStatus indicates whether or not the system has detected a configuration\nissue involving this entity.\n\nFor example, it might have detected a\nduplicate IP address or MAC address, or a host in a cluster\nmight be out of compliance. The meanings of the configStatus values are:\n- red: A problem has been detected involving the entity.\n- yellow: A problem is about to occur or a transient condition\n has occurred (For example, reconfigure fail-over policy).\n- green: No configuration issues have...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getVirtualMachineMoIdConfigStatus" }, "task": true }, { "name": "getVirtualMachineMoIdCustomValue", "summary": "Custom field values.", "description": "Custom field values.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getVirtualMachineMoIdCustomValue" }, "task": true }, { "name": "getVirtualMachineMoIdDatastore", "summary": "A collection of references to the subset of datastore objects in the datacenter\nthat is used by thi", "description": "A collection of references to the subset of datastore objects in the datacenter\nthat is used by this virtual machine.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getVirtualMachineMoIdDatastore" }, "task": true }, { "name": "getVirtualMachineMoIdDeclaredAlarmState", "summary": "A set of alarm states for alarms that apply to this managed entity.", "description": "A set of alarm states for alarms that apply to this managed entity.\n\nThe set includes alarms defined on this entity\nand alarms inherited from the parent entity,\nor from any ancestors in the inventory hierarchy.\n\nAlarms are inherited if they can be triggered by this entity or its descendants.\nThis set does not include alarms that are defined on descendants of this entity.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getVirtualMachineMoIdDeclaredAlarmState" }, "task": true }, { "name": "getVirtualMachineMoIdDisabledMethod", "summary": "List of operations that are disabled, given the current runtime\nstate of the entity.", "description": "List of operations that are disabled, given the current runtime\nstate of the entity.\n\nFor example, a power-on operation always fails if a\nvirtual machine is already powered on. This list can be used by clients to\nenable or disable operations in a graphical user interface.\n\nNote: This list is determined by the current runtime state of an entity,\nnot by its permissions.\n\nThis list may include the following operations for a HostSystem:\n- *HostSystem.EnterMaintenanceMode_Task*\n- *HostSystem.ExitMain...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getVirtualMachineMoIdDisabledMethod" }, "task": true }, { "name": "getVirtualMachineMoIdEffectiveRole", "summary": "Access rights the current session has to this entity.", "description": "Access rights the current session has to this entity.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getVirtualMachineMoIdEffectiveRole" }, "task": true }, { "name": "getVirtualMachineMoIdEnvironmentBrowser", "summary": "The current virtual machine's environment browser object.", "description": "The current virtual machine's environment browser object.\n\nThis contains\ninformation on all the configurations that can be used on the\nvirtual machine. This is identical to the environment browser on\nthe *ComputeResource* to which this virtual machine belongs.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getVirtualMachineMoIdEnvironmentBrowser" }, "task": true }, { "name": "getVirtualMachineMoIdGuest", "summary": "Information about VMware Tools and about the virtual machine\nfrom the perspective of VMware Tools.", "description": "Information about VMware Tools and about the virtual machine\nfrom the perspective of VMware Tools.\n\nInformation about the guest operating system is available in VirtualCenter. Guest\noperating system information reflects the last known state of the virtual machine.\nFor powered on machines, this is current information. For powered off machines,\nthis is the last recorded state before the virtual machine was powered off.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getVirtualMachineMoIdGuest" }, "task": true }, { "name": "getVirtualMachineMoIdGuestHeartbeatStatus", "summary": "The guest heartbeat.", "description": "The guest heartbeat.\n\nThe heartbeat status is classified as:\n- gray - VMware Tools are not installed or not running.\n- red - No heartbeat. Guest operating system may have stopped responding.\n- yellow - Intermittent heartbeat. May be due to guest load.\n- green - Guest operating system is responding normally.\n\nThe guest heartbeat is a statistics metric. Alarms can be configured on\nthis metric to trigger emails or other actions.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getVirtualMachineMoIdGuestHeartbeatStatus" }, "task": true }, { "name": "getVirtualMachineMoIdLayout", "summary": "Detailed information about the files that comprise this virtual machine.", "description": "Deprecated as of vSphere API 4.0, use *VirtualMachine.layoutEx* instead.\nIn releases after vSphere API 5.0, vSphere Servers might not\ngenerate property collector update notifications for this property.\nTo obtain the latest value of the property, you can use\nPropertyCollector methods RetrievePropertiesEx or WaitForUpdatesEx.\nIf you use the PropertyCollector.WaitForUpdatesEx method, specify\nan empty string for the version parameter. Any other version value will not\nproduce any property values as n...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getVirtualMachineMoIdLayout" }, "task": true }, { "name": "getVirtualMachineMoIdLayoutEx", "summary": "Detailed information about the files that comprise this virtual machine.", "description": "Detailed information about the files that comprise this virtual machine.\n\nCan be explicitly refreshed by the *VirtualMachine.RefreshStorageInfo* operation.\nIn releases after vSphere API 5.0, vSphere Servers might not\ngenerate property collector update notifications for this property.\nTo obtain the latest value of the property, you can use\nPropertyCollector methods RetrievePropertiesEx or WaitForUpdatesEx.\nIf you use the PropertyCollector.WaitForUpdatesEx method, specify\nan empty string for the v...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getVirtualMachineMoIdLayoutEx" }, "task": true }, { "name": "getVirtualMachineMoIdName", "summary": "Name of this entity, unique relative to its parent.", "description": "Name of this entity, unique relative to its parent.\n\nAny / (slash), \\\\ (backslash), character used in this\nname element will be escaped. Similarly, any % (percent) character used in\nthis name element will be escaped, unless it is used to start an escape\nsequence. A slash is escaped as %2F or %2f. A backslash is escaped as %5C or\n%5c, and a percent is escaped as %25.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getVirtualMachineMoIdName" }, "task": true }, { "name": "getVirtualMachineMoIdNetwork", "summary": "A collection of references to the subset of network objects in the datacenter that\nis used by this", "description": "A collection of references to the subset of network objects in the datacenter that\nis used by this virtual machine.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getVirtualMachineMoIdNetwork" }, "task": true }, { "name": "getVirtualMachineMoIdOverallStatus", "summary": "General health of this managed entity.", "description": "General health of this managed entity.\n\nThe overall status of the managed entity is computed as the worst status\namong its alarms and the configuration issues detected on the entity.\nThe status is reported as one of the following values:\n- red: The entity has alarms or configuration issues with a red status.\n- yellow: The entity does not have alarms or configuration issues with a\n red status, and has at least one with a yellow status.\n- green: The entity does not have alarms or configuration is...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getVirtualMachineMoIdOverallStatus" }, "task": true }, { "name": "getVirtualMachineMoIdParent", "summary": "Parent of this entity.", "description": "Parent of this entity.\n\nThis value is null for the root object and for\n*VirtualMachine* objects that are part of\na *VirtualApp*.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getVirtualMachineMoIdParent" }, "task": true }, { "name": "getVirtualMachineMoIdParentVApp", "summary": "Reference to the parent vApp.", "description": "Reference to the parent vApp.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getVirtualMachineMoIdParentVApp" }, "task": true }, { "name": "getVirtualMachineMoIdPermission", "summary": "List of permissions defined for this entity.", "description": "List of permissions defined for this entity.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getVirtualMachineMoIdPermission" }, "task": true }, { "name": "getVirtualMachineMoIdRecentTask", "summary": "The set of recent tasks operating on this managed entity.", "description": "The set of recent tasks operating on this managed entity.\n\nThis is a subset\nof *TaskManager.recentTask* belong to this entity. A task in this\nlist could be in one of the four states: pending, running, success or error.\n\nThis property can be used to deduce intermediate power states for\na virtual machine entity. For example, if the current powerState is \"poweredOn\"\nand there is a running task performing the \"suspend\" operation, then the virtual\nmachine's intermediate state might be described as \"s...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getVirtualMachineMoIdRecentTask" }, "task": true }, { "name": "getVirtualMachineMoIdResourceConfig", "summary": "The resource configuration for a virtual machine.", "description": "The resource configuration for a virtual machine.\n\nThe shares\nin this specification are evaluated relative to the resource pool\nto which it is assigned. This will return null if the product\nthe virtual machine is registered on does not support resource\nconfiguration.\n\nTo retrieve the configuration, you typically use\n*childConfiguration*.\n\nTo change the configuration, use\n*ResourcePool.UpdateChildResourceConfiguration*.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getVirtualMachineMoIdResourceConfig" }, "task": true }, { "name": "getVirtualMachineMoIdResourcePool", "summary": "The current resource pool that specifies resource allocation\nfor this virtual machine.", "description": "The current resource pool that specifies resource allocation\nfor this virtual machine.\n\nThis property is set when a virtual machine is created or associated with\na different resource pool.\n\nReturns null if the virtual machine is a template or the session has no access\nto the resource pool.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getVirtualMachineMoIdResourcePool" }, "task": true }, { "name": "getVirtualMachineMoIdRootSnapshot", "summary": "The roots of all snapshot trees for the virtual machine.", "description": "The roots of all snapshot trees for the virtual machine.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getVirtualMachineMoIdRootSnapshot" }, "task": true }, { "name": "getVirtualMachineMoIdRuntime", "summary": "Execution state and history for this virtual machine.", "description": "Execution state and history for this virtual machine.\n\nThe contents of this property change when:\n- the virtual machine's power state changes.\n- an execution message is pending.\n- an event occurs.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getVirtualMachineMoIdRuntime" }, "task": true }, { "name": "getVirtualMachineMoIdSnapshot", "summary": "Current snapshot and tree.", "description": "Current snapshot and tree.\n\nThe property is valid if snapshots have been created\nfor this virtual machine.\n\nThe contents of this property change in response to the methods:\n- *createSnapshot*\n- *revertToCurrentSnapshot*\n- *remove*\n- *revert*\n- *removeAllSnapshots*", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getVirtualMachineMoIdSnapshot" }, "task": true }, { "name": "getVirtualMachineMoIdStorage", "summary": "Storage space used by the virtual machine, split by datastore.", "description": "Storage space used by the virtual machine, split by datastore.\n\nCan be explicitly refreshed by the *VirtualMachine.RefreshStorageInfo* operation.\nIn releases after vSphere API 5.0, vSphere Servers might not\ngenerate property collector update notifications for this property.\nTo obtain the latest value of the property, you can use\nPropertyCollector methods RetrievePropertiesEx or WaitForUpdatesEx.\nIf you use the PropertyCollector.WaitForUpdatesEx method, specify\nan empty string for the version par...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getVirtualMachineMoIdStorage" }, "task": true }, { "name": "getVirtualMachineMoIdSummary", "summary": "Basic information about this virtual machine.", "description": "Basic information about this virtual machine.\n\nThis includes:\n- runtimeInfo\n- guest\n- basic configuration\n- alarms\n- performance information", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getVirtualMachineMoIdSummary" }, "task": true }, { "name": "getVirtualMachineMoIdTag", "summary": "The set of tags associated with this managed entity.", "description": "The set of tags associated with this managed entity.\n\nExperimental. Subject to change.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getVirtualMachineMoIdTag" }, "task": true }, { "name": "getVirtualMachineMoIdTriggeredAlarmState", "summary": "A set of alarm states for alarms triggered by this entity\nor by its descendants.", "description": "A set of alarm states for alarms triggered by this entity\nor by its descendants.\n\nTriggered alarms are propagated up the inventory hierarchy\nso that a user can readily tell when a descendant has triggered an alarm.\nIn releases after vSphere API 5.0, vSphere Servers might not\ngenerate property collector update notifications for this property.\nTo obtain the latest value of the property, you can use\nPropertyCollector methods RetrievePropertiesEx or WaitForUpdatesEx.\nIf you use the PropertyCollector...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getVirtualMachineMoIdTriggeredAlarmState" }, "task": true }, { "name": "getVirtualMachineMoIdValue", "summary": "List of custom field values.", "description": "List of custom field values.\n\nEach value uses a key to associate\nan instance of a *CustomFieldStringValue* with\na custom field definition.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getVirtualMachineMoIdValue" }, "task": true }, { "name": "postVirtualMachineCompatibilityCheckerMoIdCheckCompatibilityTask", "summary": "Tests whether or not a virtual machine could be placed on\nthe given host in the given resource pool.", "description": "Tests whether or not a virtual machine could be placed on\nthe given host in the given resource pool.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVirtualMachineCompatibilityCheckerMoIdCheckCompatibilityTask" }, "task": true }, { "name": "postVirtualMachineCompatibilityCheckerMoIdCheckPowerOnTask", "summary": "Tests whether the provided virtual machine can be powered on\non the given host and/or resource pool.", "description": "Tests whether the provided virtual machine can be powered on\non the given host and/or resource pool.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVirtualMachineCompatibilityCheckerMoIdCheckPowerOnTask" }, "task": true }, { "name": "postVirtualMachineCompatibilityCheckerMoIdCheckVmConfigTask", "summary": "Tests whether the provided virtual machine specification can be applied\non the given host and resou", "description": "Tests whether the provided virtual machine specification can be applied\non the given host and resource pool.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVirtualMachineCompatibilityCheckerMoIdCheckVmConfigTask" }, "task": true }, { "name": "postVirtualMachineGuestCustomizationManagerMoIdAbortCustomizationTask", "summary": "Abort any running guest customization process in the guest and remove\nthe guest customization lock", "description": "Abort any running guest customization process in the guest and remove\nthe guest customization lock in the guest as well.\n\nAs a result of the\noperation, the guest configuration may be left in an undefined state,\nwhich is however fine because guest customization is idempotent.\nA later successful guest customization can set the guest configuration\nto a valid state.\nThe virtual machine must be in the powered-on state and the VMware Tools\nmust be running.\nThe VM is typically a cloned VM after the Ins...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVirtualMachineGuestCustomizationManagerMoIdAbortCustomizationTask" }, "task": true }, { "name": "postVirtualMachineGuestCustomizationManagerMoIdCustomizeGuestTask", "summary": "Customize a running virtual machine.", "description": "Customize a running virtual machine.\n\nThe virtual machine must be in the powered-on state and the VMware Tools\nmust be running.\nThe VM is typically a cloned VM after the InstantClone operation. See\n*VirtualMachine.InstantClone_Task*.\n\n***Required privileges:*** VirtualMachine.Provisioning.Customize", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVirtualMachineGuestCustomizationManagerMoIdCustomizeGuestTask" }, "task": true }, { "name": "postVirtualMachineGuestCustomizationManagerMoIdStartGuestNetworkTask", "summary": "Start the network service in the guest, e.g.", "description": "Start the network service in the guest, e.g.\n\nacquire IPs from DHCP.\nThe virtual machine must be in the powered-on state and the VMware Tools\nmust be running.\nThe VM is typically a cloned VM after the InstantClone operation. See\n*VirtualMachine.InstantClone_Task*.\n\n***Required privileges:*** VirtualMachine.Provisioning.Customize", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVirtualMachineGuestCustomizationManagerMoIdStartGuestNetworkTask" }, "task": true }, { "name": "postVirtualMachineProvisioningCheckerMoIdCheckCloneTask", "summary": "Tests the feasibility of a proposed\n*VirtualMachine.CloneVM_Task* operation.", "description": "Tests the feasibility of a proposed\n*VirtualMachine.CloneVM_Task* operation.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVirtualMachineProvisioningCheckerMoIdCheckCloneTask" }, "task": true }, { "name": "postVirtualMachineProvisioningCheckerMoIdCheckInstantCloneTask", "summary": "Tests the feasibility of a proposed\n*VirtualMachine.InstantClone_Task* operation.", "description": "Tests the feasibility of a proposed\n*VirtualMachine.InstantClone_Task* operation.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVirtualMachineProvisioningCheckerMoIdCheckInstantCloneTask" }, "task": true }, { "name": "postVirtualMachineProvisioningCheckerMoIdCheckMigrateTask", "summary": "Tests the feasibility of a proposed\n*VirtualMachine.MigrateVM_Task* operation.", "description": "Tests the feasibility of a proposed\n*VirtualMachine.MigrateVM_Task* operation.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVirtualMachineProvisioningCheckerMoIdCheckMigrateTask" }, "task": true }, { "name": "postVirtualMachineProvisioningCheckerMoIdCheckRelocateTask", "summary": "Tests the feasibility of a proposed\n*VirtualMachine.RelocateVM_Task* operation.", "description": "Tests the feasibility of a proposed\n*VirtualMachine.RelocateVM_Task* operation.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVirtualMachineProvisioningCheckerMoIdCheckRelocateTask" }, "task": true }, { "name": "postVirtualMachineProvisioningCheckerMoIdQueryVMotionCompatibilityExTask", "summary": "Investigates the general VMotion compatibility of a set of virtual machines\nwith a set of hosts.", "description": "Investigates the general VMotion compatibility of a set of virtual machines\nwith a set of hosts.\n\nThe virtual machine may be in any power state. Hosts\nmay be in any connection state and also may be in maintenance mode.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVirtualMachineProvisioningCheckerMoIdQueryVMotionCompatibilityExTask" }, "task": true }, { "name": "postVirtualMachineSnapshotMoIdExportSnapshot", "summary": "Obtains an export lease on this snapshot.", "description": "Obtains an export lease on this snapshot.\n\nThe export lease contains\na list of URLs for the virtual disks for this snapshot, as well as\na ticket giving access to the URLs.\n\nSee *HttpNfcLease* for information on how to use the lease.\n\n***Required privileges:*** VApp.Export", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postVirtualMachineSnapshotMoIdExportSnapshot" }, "task": true }, { "name": "postVirtualMachineSnapshotMoIdRemoveSnapshotTask", "summary": "Removes this snapshot and deletes any associated storage.", "description": "Removes this snapshot and deletes any associated storage.\n\n***Required privileges:*** VirtualMachine.State.RemoveSnapshot", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVirtualMachineSnapshotMoIdRemoveSnapshotTask" }, "task": true }, { "name": "postVirtualMachineSnapshotMoIdRenameSnapshot", "summary": "Rename this snapshot with either a new name or a new description or both.", "description": "Rename this snapshot with either a new name or a new description or both.\n\nAt least one of these must be specified when calling the rename method.\n\n***Required privileges:*** VirtualMachine.State.RenameSnapshot", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVirtualMachineSnapshotMoIdRenameSnapshot" }, "task": true }, { "name": "postVirtualMachineSnapshotMoIdRevertToSnapshotTask", "summary": "Change the execution state of the virtual machine to the state of this snapshot.", "description": "Change the execution state of the virtual machine to the state of this snapshot.\n\n***Required privileges:*** VirtualMachine.State.RevertToSnapshot", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVirtualMachineSnapshotMoIdRevertToSnapshotTask" }, "task": true }, { "name": "postVirtualMachineSnapshotMoIdSetCustomValue", "summary": "Assigns a value to a custom field.", "description": "Assigns a value to a custom field.\n\nThe setCustomValue method requires\nwhichever updatePrivilege is defined as one of the\n*CustomFieldDef.fieldInstancePrivileges*\nfor the CustomFieldDef whose value is being changed.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVirtualMachineSnapshotMoIdSetCustomValue" }, "task": true }, { "name": "getVirtualMachineSnapshotMoIdAvailableField", "summary": "List of custom field definitions that are valid for the object's type.", "description": "List of custom field definitions that are valid for the object's type.\n\nThe fields are sorted by *CustomFieldDef.name*.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getVirtualMachineSnapshotMoIdAvailableField" }, "task": true }, { "name": "getVirtualMachineSnapshotMoIdChildSnapshot", "summary": "All snapshots for which this snapshot is the parent.", "description": "All snapshots for which this snapshot is the parent.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getVirtualMachineSnapshotMoIdChildSnapshot" }, "task": true }, { "name": "getVirtualMachineSnapshotMoIdConfig", "summary": "Information about the configuration of this virtual machine when this snapshot was\ntaken.", "description": "Information about the configuration of this virtual machine when this snapshot was\ntaken.\n\nThe datastore paths for the virtual machine disks point to the head of the disk\nchain that represents the disk at this given snapshot. The fileInfo.fileLayout\nfield is not set.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getVirtualMachineSnapshotMoIdConfig" }, "task": true }, { "name": "getVirtualMachineSnapshotMoIdValue", "summary": "List of custom field values.", "description": "List of custom field values.\n\nEach value uses a key to associate\nan instance of a *CustomFieldStringValue* with\na custom field definition.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getVirtualMachineSnapshotMoIdValue" }, "task": true }, { "name": "getVirtualMachineSnapshotMoIdVm", "summary": "The virtual machine for which the snapshot was taken.", "description": "The virtual machine for which the snapshot was taken.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getVirtualMachineSnapshotMoIdVm" }, "task": true }, { "name": "postVmwareDistributedVirtualSwitchMoIdAddNetworkResourcePool", "summary": "Add a network resource pool.", "description": "Deprecated as of vSphere API 6.0\nUse *DistributedVirtualSwitch.DvsReconfigureVmVnicNetworkResourcePool_Task* instead\nto add a Virtual NIC network resource pool.\n\nAdd a network resource pool.\n\n***Required privileges:*** DVSwitch.ResourceManagement", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVmwareDistributedVirtualSwitchMoIdAddNetworkResourcePool" }, "task": true }, { "name": "postVmwareDistributedVirtualSwitchMoIdCreateDVPortgroupTask", "summary": "Creates a single *DistributedVirtualPortgroup* and adds it\nto the distributed virtual switch.", "description": "Creates a single *DistributedVirtualPortgroup* and adds it\nto the distributed virtual switch.\n\n***Required privileges:*** DVPortgroup.Create", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVmwareDistributedVirtualSwitchMoIdCreateDVPortgroupTask" }, "task": true }, { "name": "postVmwareDistributedVirtualSwitchMoIdAddDVPortgroupTask", "summary": "Creates one or more *DistributedVirtualPortgroup*s and adds them to\nthe distributed virtual switch.", "description": "Creates one or more *DistributedVirtualPortgroup*s and adds them to\nthe distributed virtual switch.\n\n***Required privileges:*** DVPortgroup.Create", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVmwareDistributedVirtualSwitchMoIdAddDVPortgroupTask" }, "task": true }, { "name": "postVmwareDistributedVirtualSwitchMoIdDestroyTask", "summary": "Destroys this object, deleting its contents and removing it from its parent\nfolder (if any).", "description": "Destroys this object, deleting its contents and removing it from its parent\nfolder (if any).\n\nNOTE: The appropriate privilege must be held on the parent of the destroyed\nentity as well as the entity itself.\nThis method can throw one of several exceptions. The exact set of exceptions\ndepends on the kind of entity that is being removed. See comments for\neach entity for more information on destroy behavior.\n\n***Required privileges:*** DVSwitch.Delete", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postVmwareDistributedVirtualSwitchMoIdDestroyTask" }, "task": true }, { "name": "postVmwareDistributedVirtualSwitchMoIdEnableNetworkResourceManagement", "summary": "Enable/Disable network I/O control on the vSphere Distributed Switch.", "description": "Enable/Disable network I/O control on the vSphere Distributed Switch.\n\n***Required privileges:*** DVSwitch.ResourceManagement", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVmwareDistributedVirtualSwitchMoIdEnableNetworkResourceManagement" }, "task": true }, { "name": "postVmwareDistributedVirtualSwitchMoIdFetchDVPortKeys", "summary": "Return the keys of ports that meet the criteria.", "description": "Return the keys of ports that meet the criteria.\n\nOn an ESXi host,\nthe property shows only the connected ports currently on the host.\n\n***Required privileges:*** System.Read", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVmwareDistributedVirtualSwitchMoIdFetchDVPortKeys" }, "task": true }, { "name": "postVmwareDistributedVirtualSwitchMoIdFetchDVPorts", "summary": "Return the ports that meet the criteria.", "description": "Return the ports that meet the criteria.\n\n***Required privileges:*** System.Read", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVmwareDistributedVirtualSwitchMoIdFetchDVPorts" }, "task": true }, { "name": "postVmwareDistributedVirtualSwitchMoIdLookupDvPortGroup", "summary": "Returns the portgroup identified by the key within this VDS.", "description": "Returns the portgroup identified by the key within this VDS.\n\n***Required privileges:*** System.Read", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVmwareDistributedVirtualSwitchMoIdLookupDvPortGroup" }, "task": true }, { "name": "postVmwareDistributedVirtualSwitchMoIdMergeDvsTask", "summary": "Merge an existing DistributedVirtualSwitch (source) to this switch\n(destination).", "description": "Deprecated as of vSphere API 5.5.\n\nMerge an existing DistributedVirtualSwitch (source) to this switch\n(destination).\n\nThe host members and the connected entity of the source\nswitch will be transferred to the destination switch. This operation\ndisconnects the entities from the source switch, tears down its host\nproxy switches, creates new proxies for the destination switch,\nand reconnects the entities to the destination switch.\n\nIn summary, this operation does the following:\n- Adds the\n config ...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVmwareDistributedVirtualSwitchMoIdMergeDvsTask" }, "task": true }, { "name": "postVmwareDistributedVirtualSwitchMoIdMoveDVPortTask", "summary": "Move the ports out of their current portgroup into the specified portgroup.", "description": "Deprecated as of vSphere API 6.0.\n\nMove the ports out of their current portgroup into the specified portgroup.\n\nIf the moving of any of the ports results in a violation of the portgroup\npolicy, or type of the source or destination portgroup, the operation\nraises a fault. A conflict port cannot be moved.\n\n***Required privileges:*** DVSwitch.Modify", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVmwareDistributedVirtualSwitchMoIdMoveDVPortTask" }, "task": true }, { "name": "postVmwareDistributedVirtualSwitchMoIdPerformDvsProductSpecOperationTask", "summary": "This method updates the *DistributedVirtualSwitch* product specifications.", "description": "This method updates the *DistributedVirtualSwitch* product specifications.\n\n***Required privileges:*** DVSwitch.Modify", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVmwareDistributedVirtualSwitchMoIdPerformDvsProductSpecOperationTask" }, "task": true }, { "name": "postVmwareDistributedVirtualSwitchMoIdQueryUsedVlanIdInDvs", "summary": "Return the used VLAN ID (PVLAN excluded) in the switch.", "description": "Return the used VLAN ID (PVLAN excluded) in the switch.\n\n***Required privileges:*** System.Read", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postVmwareDistributedVirtualSwitchMoIdQueryUsedVlanIdInDvs" }, "task": true }, { "name": "postVmwareDistributedVirtualSwitchMoIdReconfigureDvsTask", "summary": "Reconfigures a distributed virtual switch.", "description": "Reconfigures a distributed virtual switch.\n\nYou can use this method\nto set switch properties or to reset the switch to a previous state.\n\n**Reconfiguring a Standard Distributed Virtual Switch**\n\nTo reconfigure a *DistributedVirtualSwitch*,\nuse a *DVSConfigSpec*\nto set the switch properties.\n\n**Reconfiguring a VMware Distributed Virtual Switch**\n\nIf you use a *VmwareDistributedVirtualSwitch*,\nyou can perform the following switch reconfiguration:\n- Use a *VMwareDVSConfigSpec*\n to set the switch p...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVmwareDistributedVirtualSwitchMoIdReconfigureDvsTask" }, "task": true }, { "name": "postVmwareDistributedVirtualSwitchMoIdReconfigureDVPortTask", "summary": "Reconfigure individual ports.", "description": "Reconfigure individual ports.\n\n***Required privileges:*** DVSwitch.PortConfig", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVmwareDistributedVirtualSwitchMoIdReconfigureDVPortTask" }, "task": true }, { "name": "postVmwareDistributedVirtualSwitchMoIdDvsReconfigureVmVnicNetworkResourcePoolTask", "summary": "reconfigure the Virtual NIC network resource pool configuration.", "description": "reconfigure the Virtual NIC network resource pool configuration.\n\n***Required privileges:*** DVSwitch.ResourceManagement", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVmwareDistributedVirtualSwitchMoIdDvsReconfigureVmVnicNetworkResourcePoolTask" }, "task": true }, { "name": "postVmwareDistributedVirtualSwitchMoIdRectifyDvsHostTask", "summary": "Update the switch configuration on the host to bring them in sync with the\ncurrent configuration in", "description": "Deprecated as of vSphere API 5.0.\nUse\n*DistributedVirtualSwitchManager*.*DistributedVirtualSwitchManager.RectifyDvsOnHost_Task* instead.\n\nUpdate the switch configuration on the host to bring them in sync with the\ncurrent configuration in vCenter Server.\n\n***Required privileges:*** System.Read", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVmwareDistributedVirtualSwitchMoIdRectifyDvsHostTask" }, "task": true }, { "name": "postVmwareDistributedVirtualSwitchMoIdRefreshDVPortState", "summary": "Refresh port states.", "description": "Refresh port states.\n\n***Required privileges:*** System.Read", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVmwareDistributedVirtualSwitchMoIdRefreshDVPortState" }, "task": true }, { "name": "postVmwareDistributedVirtualSwitchMoIdReload", "summary": "Reload the entity state.", "description": "Reload the entity state.\n\nClients only need to call this method\nif they changed some external state that affects the service\nwithout using the Web service interface to perform the change.\nFor example, hand-editing a virtual machine configuration file\naffects the configuration of the associated virtual machine but\nthe service managing the virtual machine might not monitor the\nfile for changes. In this case, after such an edit, a client\nwould call \"reload\" on the associated virtual machine to ensu...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/postVmwareDistributedVirtualSwitchMoIdReload" }, "task": true }, { "name": "postVmwareDistributedVirtualSwitchMoIdRemoveNetworkResourcePool", "summary": "Remove a network resource pool.", "description": "Deprecated as of vSphere API 6.0\nUse *DistributedVirtualSwitch.DvsReconfigureVmVnicNetworkResourcePool_Task* instead\nto remove a Virtual NIC network resource pool.\n\nRemove a network resource pool.\n\n***Required privileges:*** DVSwitch.ResourceManagement", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVmwareDistributedVirtualSwitchMoIdRemoveNetworkResourcePool" }, "task": true }, { "name": "postVmwareDistributedVirtualSwitchMoIdRenameTask", "summary": "Renames this managed entity.", "description": "Renames this managed entity.\n\nAny % (percent) character used in this name parameter\nmust be escaped, unless it is used to start an escape\nsequence. Clients may also escape any other characters in\nthis name parameter.\n\nSee also *ManagedEntity.name*.\n\n***Required privileges:*** DVSwitch.Modify", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVmwareDistributedVirtualSwitchMoIdRenameTask" }, "task": true }, { "name": "postVmwareDistributedVirtualSwitchMoIdDVSRollbackTask", "summary": "This method determines if the distributed virtual switch configuration\nhas changed.", "description": "This method determines if the distributed virtual switch configuration\nhas changed.\n\nIf it has changed, the method returns a\n*VMwareDVSConfigSpec*.\nUse the *DistributedVirtualSwitch.ReconfigureDvs_Task* method to apply\nthe rollback configuration to the switch.\nYou can use the rollback method only on a *VmwareDistributedVirtualSwitch*.\n- If you specify the entityBackup parameter, the returned\n configuration specification represents the exported switch configuration.\n If the entityBackup mat...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVmwareDistributedVirtualSwitchMoIdDVSRollbackTask" }, "task": true }, { "name": "postVmwareDistributedVirtualSwitchMoIdSetCustomValue", "summary": "Assigns a value to a custom field.", "description": "Assigns a value to a custom field.\n\nThe setCustomValue method requires\nwhichever updatePrivilege is defined as one of the\n*CustomFieldDef.fieldInstancePrivileges*\nfor the CustomFieldDef whose value is being changed.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVmwareDistributedVirtualSwitchMoIdSetCustomValue" }, "task": true }, { "name": "postVmwareDistributedVirtualSwitchMoIdUpdateDvsCapability", "summary": "Set the capability of the switch.", "description": "Set the capability of the switch.\n\n***Required privileges:*** DVSwitch.Modify", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVmwareDistributedVirtualSwitchMoIdUpdateDvsCapability" }, "task": true }, { "name": "postVmwareDistributedVirtualSwitchMoIdUpdateDVSHealthCheckConfigTask", "summary": "Update health check configuration.", "description": "Update health check configuration.\n\n***Required privileges:*** DVSwitch.Modify", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVmwareDistributedVirtualSwitchMoIdUpdateDVSHealthCheckConfigTask" }, "task": true }, { "name": "postVmwareDistributedVirtualSwitchMoIdUpdateDVSLacpGroupConfigTask", "summary": "Update Link Aggregation Control Protocol groups.", "description": "Update Link Aggregation Control Protocol groups.\n\nIt can be called if the value of\n*VMwareDVSConfigInfo.lacpApiVersion* is\n*multipleLag*\nelse an exception ConflictingConfiguration will be thrown.\n\n***Required privileges:*** DVSwitch.Modify", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVmwareDistributedVirtualSwitchMoIdUpdateDVSLacpGroupConfigTask" }, "task": true }, { "name": "postVmwareDistributedVirtualSwitchMoIdUpdateNetworkResourcePool", "summary": "Update the network resource pool configuration.", "description": "Deprecated as of vSphere API 6.0\nUse *DistributedVirtualSwitch.DvsReconfigureVmVnicNetworkResourcePool_Task* instead\nto update the Virtual NIC network resource pool.\n\nUpdate the network resource pool configuration.\n\n***Required privileges:*** DVSwitch.ResourceManagement", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVmwareDistributedVirtualSwitchMoIdUpdateNetworkResourcePool" }, "task": true }, { "name": "getVmwareDistributedVirtualSwitchMoIdAlarmActionsEnabled", "summary": "Whether alarm actions are enabled for this entity.", "description": "Whether alarm actions are enabled for this entity.\n\nTrue if enabled; false otherwise.\n\n***Required privileges:*** System.Read", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getVmwareDistributedVirtualSwitchMoIdAlarmActionsEnabled" }, "task": true }, { "name": "getVmwareDistributedVirtualSwitchMoIdAvailableField", "summary": "List of custom field definitions that are valid for the object's type.", "description": "List of custom field definitions that are valid for the object's type.\n\nThe fields are sorted by *CustomFieldDef.name*.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getVmwareDistributedVirtualSwitchMoIdAvailableField" }, "task": true }, { "name": "getVmwareDistributedVirtualSwitchMoIdCapability", "summary": "Capability of the switch.", "description": "Capability of the switch.\n\nCapabilities are indicated at the port,\nportgroup and switch levels, and for version-specific features.\nWhen you retrieve this property from an ESXi host,\n*DistributedVirtualSwitch.capability*.*DVSCapability.dvsOperationSupported*\nshould always be set to false.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getVmwareDistributedVirtualSwitchMoIdCapability" }, "task": true }, { "name": "getVmwareDistributedVirtualSwitchMoIdConfig", "summary": "Switch configuration data.", "description": "Switch configuration data.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getVmwareDistributedVirtualSwitchMoIdConfig" }, "task": true }, { "name": "getVmwareDistributedVirtualSwitchMoIdConfigIssue", "summary": "Current configuration issues that have been detected for this entity.", "description": "Current configuration issues that have been detected for this entity.\n\nTypically,\nthese issues have already been logged as events. The entity stores these\nevents as long as they are still current. The\n*configStatus* property provides an overall status\nbased on these events.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getVmwareDistributedVirtualSwitchMoIdConfigIssue" }, "task": true }, { "name": "getVmwareDistributedVirtualSwitchMoIdConfigStatus", "summary": "The configStatus indicates whether or not the system has detected a configuration\nissue involving t", "description": "The configStatus indicates whether or not the system has detected a configuration\nissue involving this entity.\n\nFor example, it might have detected a\nduplicate IP address or MAC address, or a host in a cluster\nmight be out of compliance. The meanings of the configStatus values are:\n- red: A problem has been detected involving the entity.\n- yellow: A problem is about to occur or a transient condition\n has occurred (For example, reconfigure fail-over policy).\n- green: No configuration issues have...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getVmwareDistributedVirtualSwitchMoIdConfigStatus" }, "task": true }, { "name": "getVmwareDistributedVirtualSwitchMoIdCustomValue", "summary": "Custom field values.", "description": "Custom field values.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getVmwareDistributedVirtualSwitchMoIdCustomValue" }, "task": true }, { "name": "getVmwareDistributedVirtualSwitchMoIdDeclaredAlarmState", "summary": "A set of alarm states for alarms that apply to this managed entity.", "description": "A set of alarm states for alarms that apply to this managed entity.\n\nThe set includes alarms defined on this entity\nand alarms inherited from the parent entity,\nor from any ancestors in the inventory hierarchy.\n\nAlarms are inherited if they can be triggered by this entity or its descendants.\nThis set does not include alarms that are defined on descendants of this entity.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getVmwareDistributedVirtualSwitchMoIdDeclaredAlarmState" }, "task": true }, { "name": "getVmwareDistributedVirtualSwitchMoIdDisabledMethod", "summary": "List of operations that are disabled, given the current runtime\nstate of the entity.", "description": "List of operations that are disabled, given the current runtime\nstate of the entity.\n\nFor example, a power-on operation always fails if a\nvirtual machine is already powered on. This list can be used by clients to\nenable or disable operations in a graphical user interface.\n\nNote: This list is determined by the current runtime state of an entity,\nnot by its permissions.\n\nThis list may include the following operations for a HostSystem:\n- *HostSystem.EnterMaintenanceMode_Task*\n- *HostSystem.ExitMain...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getVmwareDistributedVirtualSwitchMoIdDisabledMethod" }, "task": true }, { "name": "getVmwareDistributedVirtualSwitchMoIdEffectiveRole", "summary": "Access rights the current session has to this entity.", "description": "Access rights the current session has to this entity.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getVmwareDistributedVirtualSwitchMoIdEffectiveRole" }, "task": true }, { "name": "getVmwareDistributedVirtualSwitchMoIdName", "summary": "Name of this entity, unique relative to its parent.", "description": "Name of this entity, unique relative to its parent.\n\nAny / (slash), \\\\ (backslash), character used in this\nname element will be escaped. Similarly, any % (percent) character used in\nthis name element will be escaped, unless it is used to start an escape\nsequence. A slash is escaped as %2F or %2f. A backslash is escaped as %5C or\n%5c, and a percent is escaped as %25.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getVmwareDistributedVirtualSwitchMoIdName" }, "task": true }, { "name": "getVmwareDistributedVirtualSwitchMoIdNetworkResourcePool", "summary": "Network resource pool information for the switch.", "description": "Deprecated as of vSphere API 6.0\nUse *DVSConfigInfo.vmVnicNetworkResourcePool*\nto get the Virtual NIC resource pool information.\nUse *DVSConfigInfo.infrastructureTrafficResourceConfig*\nto get the host infrastructure resource information.\n\nNetwork resource pool information for the switch.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getVmwareDistributedVirtualSwitchMoIdNetworkResourcePool" }, "task": true }, { "name": "getVmwareDistributedVirtualSwitchMoIdOverallStatus", "summary": "General health of this managed entity.", "description": "General health of this managed entity.\n\nThe overall status of the managed entity is computed as the worst status\namong its alarms and the configuration issues detected on the entity.\nThe status is reported as one of the following values:\n- red: The entity has alarms or configuration issues with a red status.\n- yellow: The entity does not have alarms or configuration issues with a\n red status, and has at least one with a yellow status.\n- green: The entity does not have alarms or configuration is...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getVmwareDistributedVirtualSwitchMoIdOverallStatus" }, "task": true }, { "name": "getVmwareDistributedVirtualSwitchMoIdParent", "summary": "Parent of this entity.", "description": "Parent of this entity.\n\nThis value is null for the root object and for\n*VirtualMachine* objects that are part of\na *VirtualApp*.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getVmwareDistributedVirtualSwitchMoIdParent" }, "task": true }, { "name": "getVmwareDistributedVirtualSwitchMoIdPermission", "summary": "List of permissions defined for this entity.", "description": "List of permissions defined for this entity.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getVmwareDistributedVirtualSwitchMoIdPermission" }, "task": true }, { "name": "getVmwareDistributedVirtualSwitchMoIdPortgroup", "summary": "Portgroups that are defined on the switch.", "description": "Portgroups that are defined on the switch.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getVmwareDistributedVirtualSwitchMoIdPortgroup" }, "task": true }, { "name": "getVmwareDistributedVirtualSwitchMoIdRecentTask", "summary": "The set of recent tasks operating on this managed entity.", "description": "The set of recent tasks operating on this managed entity.\n\nThis is a subset\nof *TaskManager.recentTask* belong to this entity. A task in this\nlist could be in one of the four states: pending, running, success or error.\n\nThis property can be used to deduce intermediate power states for\na virtual machine entity. For example, if the current powerState is \"poweredOn\"\nand there is a running task performing the \"suspend\" operation, then the virtual\nmachine's intermediate state might be described as \"s...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getVmwareDistributedVirtualSwitchMoIdRecentTask" }, "task": true }, { "name": "getVmwareDistributedVirtualSwitchMoIdRuntime", "summary": "Runtime information of the distributed virtual switch.", "description": "Runtime information of the distributed virtual switch.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getVmwareDistributedVirtualSwitchMoIdRuntime" }, "task": true }, { "name": "getVmwareDistributedVirtualSwitchMoIdSummary", "summary": "Summary of the switch.", "description": "Summary of the switch.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getVmwareDistributedVirtualSwitchMoIdSummary" }, "task": true }, { "name": "getVmwareDistributedVirtualSwitchMoIdTag", "summary": "The set of tags associated with this managed entity.", "description": "The set of tags associated with this managed entity.\n\nExperimental. Subject to change.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getVmwareDistributedVirtualSwitchMoIdTag" }, "task": true }, { "name": "getVmwareDistributedVirtualSwitchMoIdTriggeredAlarmState", "summary": "A set of alarm states for alarms triggered by this entity\nor by its descendants.", "description": "A set of alarm states for alarms triggered by this entity\nor by its descendants.\n\nTriggered alarms are propagated up the inventory hierarchy\nso that a user can readily tell when a descendant has triggered an alarm.\nIn releases after vSphere API 5.0, vSphere Servers might not\ngenerate property collector update notifications for this property.\nTo obtain the latest value of the property, you can use\nPropertyCollector methods RetrievePropertiesEx or WaitForUpdatesEx.\nIf you use the PropertyCollector...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getVmwareDistributedVirtualSwitchMoIdTriggeredAlarmState" }, "task": true }, { "name": "getVmwareDistributedVirtualSwitchMoIdUuid", "summary": "Generated UUID of the switch.", "description": "Generated UUID of the switch.\n\nUnique across vCenter Server\ninventory and instances.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getVmwareDistributedVirtualSwitchMoIdUuid" }, "task": true }, { "name": "getVmwareDistributedVirtualSwitchMoIdValue", "summary": "List of custom field values.", "description": "List of custom field values.\n\nEach value uses a key to associate\nan instance of a *CustomFieldStringValue* with\na custom field definition.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/getVmwareDistributedVirtualSwitchMoIdValue" }, "task": true }, { "name": "postVsanUpgradeSystemMoIdPerformVsanUpgradeTask", "summary": "Start VSAN on-disk format upgrade process on a particular cluster.", "description": "Start VSAN on-disk format upgrade process on a particular cluster.\n\nIn order to perform this on-disk format upgrade, the upgrade process\nwill perform a rolling evacuation/remove/re-add operation to accomplish\nthe upgrade. In other words, one disk group at a time, it will evacuate\nthe data from the disk group, then remove the old format from the now\nempty disk group, then reformat the disk group with the new format.\nOnce all disk groups have been upgraded, and if the performObjectUpgrade\nparamete...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVsanUpgradeSystemMoIdPerformVsanUpgradeTask" }, "task": true }, { "name": "postVsanUpgradeSystemMoIdPerformVsanUpgradePreflightCheck", "summary": "Perform an upgrade pre-flight check on a cluster.", "description": "Perform an upgrade pre-flight check on a cluster.\n\n***Required privileges:*** System.Read", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVsanUpgradeSystemMoIdPerformVsanUpgradePreflightCheck" }, "task": true }, { "name": "postVsanUpgradeSystemMoIdQueryVsanUpgradeStatus", "summary": "Retrieve the latest status of a running, or the previously completed,\nupgrade process.", "description": "Retrieve the latest status of a running, or the previously completed,\nupgrade process.\n\nInformation about previous upgrade runs are not\nalways, e.g. when VC gets restarted.\n\n***Required privileges:*** System.Read", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postVsanUpgradeSystemMoIdQueryVsanUpgradeStatus" }, "task": true }, { "name": "agencyAddIssue", "summary": "Adds an issue to this agency.", "description": "Deprecated.\n\nAdds an issue to this agency.\n\n*Issue.key* and *Issue.time* is\noverwritten so that *Issue.key* becomes unique on this server and\n*Issue.time* is the current time.\n\nRequires modify privileges.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/agencyAddIssue" }, "task": true }, { "name": "agencyDestroyAgency", "summary": "Destroys this Agency.", "description": "Destroys this Agency.\n\nAny agents that the Agency has are\nremoved. Until the agents have been removed, it is possible to view the\nruntime state of this Agency but it is not possible to modify\nits configuration or change its goal state. After all agents have been\nremoved, any subsequent call on this Agency will throw a\n ManagedObjectNotFound exception.\n\nRequires modify privileges.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/agencyDestroyAgency" }, "task": true }, { "name": "agencyAgencyDisable", "summary": "Sets the goal state of this Agency to disabled .", "description": "Deprecated its definition is not consistent across agent VMs and VIBs.\nIt is impossible to be defined since there is no corresponding\nstate of ESXi vibs.\n\nSets the goal state of this Agency to disabled .\n\nThis powers off any powered on agent virtual machines, but continues\nprovisioning agents to hosts that are added to the compute resources in\nthe agency's scope, and removes agents from hosts that are taken out of\nthe scope.\n\nRequires modify privileges.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/agencyAgencyDisable" }, "task": true }, { "name": "agencyAgencyEnable", "summary": "Sets the goal state of this Agency to enabled .", "description": "Deprecated since agencies are always created as enabled. In addition,\nenabling already uninstalled agency is not supported.\n\nSets the goal state of this Agency to enabled .\n\nThis causes the agency to continuously deploy and monitor agents.\n\nRequires modify privileges.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/agencyAgencyEnable" }, "task": true }, { "name": "agencyQueryAgent", "summary": "An array of agents deployed by this agent manager.", "description": "Deprecated use *Agency.agent* instead.\n\nAn array of agents deployed by this agent manager.\n\nRequires view privileges.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/agencyQueryAgent" }, "task": true }, { "name": "agencyQueryConfig", "summary": "The configuration of this Agency .", "description": "Deprecated use *Agency.config* instead.\n\nThe configuration of this Agency .\n\nSpecifies how this\n Agency deploys its agents and VIBs.\n\nRequires view privileges.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/agencyQueryConfig" }, "task": true }, { "name": "agencyQueryIssue", "summary": "Current issues that have been detected for this entity.", "description": "Current issues that have been detected for this entity.\n\nEach issue can be remediated\nby invoking *EamObject.Resolve* or *EamObject.ResolveAll*.\n\nRequires view privileges.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/agencyQueryIssue" }, "task": true }, { "name": "agencyAgencyQueryRuntime", "summary": "Gets the runtime information for this agency.", "description": "Deprecated use *Agency.runtime* instead.\n\nGets the runtime information for this agency.\n\nRequires view privileges.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/agencyAgencyQueryRuntime" }, "task": true }, { "name": "agencyQuerySolutionId", "summary": "The ID of the solution that owns this Agency .", "description": "Deprecated use *Agency.solutionId* instead.\n\nThe ID of the solution that owns this Agency .\n\nIf the agency\nis owned by a VC extension, this is the extension's key. Otherwise, this\nis same as *Agency.owner*. The users in the latter case are\neither regular or solution users.\n\nRequires view privileges.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/agencyQuerySolutionId" }, "task": true }, { "name": "agencyRegisterAgentVm", "summary": "Adds an agent VM to this agency.", "description": "Deprecated use automatically provisioned VMs and register hooks to have\ncontrol post provisioning and power on.\n\nAdds an agent VM to this agency.\n\nUsed if\n*AgencyConfigInfo.manuallyProvisioned* is set to true. The method\ndoes nothing if the agent VM is already registered with this agency.\n\nRequires modify privileges.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/agencyRegisterAgentVm" }, "task": true }, { "name": "agencyResolve", "summary": "Resolves the issues specified in the input.", "description": "Resolves the issues specified in the input.\n\nIf an issue is remediable, ESX\nAgent Manager\ntries to resolve the misconfiguration that caused the issue. If it is not\nremediable, the offending issue is removed and ESX Agent Manager assumes that the issue has been\nresolved.\n\nRequires modify privileges.\n\nSee also *Issue*.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/agencyResolve" }, "task": true }, { "name": "agencyResolveAll", "summary": "Resolve all outstanding issues.", "description": "Resolve all outstanding issues.\n\nThe method calls *EamObject.Resolve*\nwith all issues the EsxAgentManager , Agency , or\n Agent have encountered. It is the equivalent of calling the following methods:\n- agent.resolve(getIssueKeys(agent.getRuntime().getIssue()));\n for Agent objects\n- agency.resolve(getIssueKeys(agency.getRuntime().getIssue()));\n for Agency objects\n- esxAgentManager.resolve(getIssueKeys(esxAgentManager.getIssue()));\n for the EsxAgentManager object.\n\nRequires mod...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/agencyResolveAll" }, "task": true }, { "name": "agencyUninstall", "summary": "Sets the goal state of this Agency to\n uninstalled .", "description": "Sets the goal state of this Agency to\n uninstalled .\n\nThis initiates the uninstallation of this\n Agency , which causes all agents to be removed.\n\nThe best practice when destroying an agency is to call\n uninstall , wait for the runtime status to turn green, and\nthen invoke *Agency.DestroyAgency*. When waiting for this\n Agency to be uninstalled the solution can then attend to and\nresolve any raised issues.\n\nRequires modify privileges.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/agencyUninstall" }, "task": true }, { "name": "agencyUnregisterAgentVm", "summary": "Removes an agent VM to this agency.", "description": "Deprecated use automatically provisioned VMs and register hooks to have\ncontrol post provisioning and power on.\n\nRemoves an agent VM to this agency.\n\nUsed if\n*AgencyConfigInfo.manuallyProvisioned* is set to true. The method\ndoes nothing if the agent VM is not registered with this agency.\n\nRequires modify privileges.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/agencyUnregisterAgentVm" }, "task": true }, { "name": "agencyUpdate", "summary": "Updates the agency configuration used by this Agency to\ndeploy agents and VIBs.", "description": "Updates the agency configuration used by this Agency to\ndeploy agents and VIBs.\n\nvSphere ESX Agent Manager generates a diff between\nthe old configuration and the new one and updates the Agency\naccordingly.\n\nRequires modify privileges.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/agencyUpdate" }, "task": true }, { "name": "agencyGetAgent", "summary": "An array of agents deployed by this agent manager.", "description": "An array of agents deployed by this agent manager.\n\nRequires view privileges.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/agencyGetAgent" }, "task": true }, { "name": "agencyGetConfig", "summary": "The configuration of this Agency .", "description": "The configuration of this Agency .\n\nSpecifies how this\n Agency deploys its agents and VIBs.\n\nRequires view privileges.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/agencyGetConfig" }, "task": true }, { "name": "agencyGetOwner", "summary": "The principal name of the user that owns this Agency .", "description": "The principal name of the user that owns this Agency .\n\nIf the\nagency is owned by a VC extension, this method returns null.\n\nRequires view privileges.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/agencyGetOwner" }, "task": true }, { "name": "agencyGetRuntime", "summary": "Gets the runtime information for this agency.", "description": "Gets the runtime information for this agency.\n\nRequires view privileges.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/agencyGetRuntime" }, "task": true }, { "name": "agencyGetSolutionId", "summary": "The ID of the solution that owns this Agency .", "description": "The ID of the solution that owns this Agency .\n\nIf the agency\nis owned by a VC extension, this is the extension's key. Otherwise, this\nis same as *Agency.owner*. The users in the latter case are\neither regular or solution users.\n\nRequires view privileges.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/agencyGetSolutionId" }, "task": true }, { "name": "agentMarkAsAvailable", "summary": "Mark this agent's VM as available.", "description": "Mark this agent's VM as available.\n\nUsed when the agency this agent belongs to\nhas\n*AgencyConfigInfo.manuallyMarkAgentVmAvailableAfterProvisioning* or\n*AgencyConfigInfo.manuallyMarkAgentVmAvailableAfterPowerOn* set to\n true and *AgentRuntimeInfo.vmHook* is present.\nSee *AgentRuntimeInfo.vmHook*", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/agentMarkAsAvailable" }, "task": true }, { "name": "agentAgentQueryConfig", "summary": "The configuration of this Agent .", "description": "Deprecated use *Agent.config* instead.\n\nThe configuration of this Agent .", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/agentAgentQueryConfig" }, "task": true }, { "name": "agentQueryIssue", "summary": "Current issues that have been detected for this entity.", "description": "Current issues that have been detected for this entity.\n\nEach issue can be remediated\nby invoking *EamObject.Resolve* or *EamObject.ResolveAll*.\n\nRequires view privileges.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/agentQueryIssue" }, "task": true }, { "name": "agentAgentQueryRuntime", "summary": "Runtime information for the agent.", "description": "Deprecated use *Agent.runtime* instead.\n\nRuntime information for the agent.\n\nThis includes important information\nabout the current deployment of the agent's VIB, virtual machine, and\nhost.\n\nRequires view privileges.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/agentAgentQueryRuntime" }, "task": true }, { "name": "agentResolve", "summary": "Resolves the issues specified in the input.", "description": "Resolves the issues specified in the input.\n\nIf an issue is remediable, ESX\nAgent Manager\ntries to resolve the misconfiguration that caused the issue. If it is not\nremediable, the offending issue is removed and ESX Agent Manager assumes that the issue has been\nresolved.\n\nRequires modify privileges.\n\nSee also *Issue*.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/agentResolve" }, "task": true }, { "name": "agentResolveAll", "summary": "Resolve all outstanding issues.", "description": "Resolve all outstanding issues.\n\nThe method calls *EamObject.Resolve*\nwith all issues the EsxAgentManager , Agency , or\n Agent have encountered. It is the equivalent of calling the following methods:\n- agent.resolve(getIssueKeys(agent.getRuntime().getIssue()));\n for Agent objects\n- agency.resolve(getIssueKeys(agency.getRuntime().getIssue()));\n for Agency objects\n- esxAgentManager.resolve(getIssueKeys(esxAgentManager.getIssue()));\n for the EsxAgentManager object.\n\nRequires mod...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/agentResolveAll" }, "task": true }, { "name": "agentGetConfig", "summary": "The configuration of this Agent .", "description": "The configuration of this Agent .", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/agentGetConfig" }, "task": true }, { "name": "agentGetRuntime", "summary": "Runtime information for this agent.", "description": "Runtime information for this agent.\n\nThis includes important information\nabout the current deployment of the agent's VIB, virtual machine, and\nhost.\n\nRequires view privileges.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/agentGetRuntime" }, "task": true }, { "name": "eamObjectQueryIssue", "summary": "Current issues that have been detected for this entity.", "description": "Current issues that have been detected for this entity.\n\nEach issue can be remediated\nby invoking *EamObject.Resolve* or *EamObject.ResolveAll*.\n\nRequires view privileges.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/eamObjectQueryIssue" }, "task": true }, { "name": "eamObjectResolve", "summary": "Resolves the issues specified in the input.", "description": "Resolves the issues specified in the input.\n\nIf an issue is remediable, ESX\nAgent Manager\ntries to resolve the misconfiguration that caused the issue. If it is not\nremediable, the offending issue is removed and ESX Agent Manager assumes that the issue has been\nresolved.\n\nRequires modify privileges.\n\nSee also *Issue*.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/eamObjectResolve" }, "task": true }, { "name": "eamObjectResolveAll", "summary": "Resolve all outstanding issues.", "description": "Resolve all outstanding issues.\n\nThe method calls *EamObject.Resolve*\nwith all issues the EsxAgentManager , Agency , or\n Agent have encountered. It is the equivalent of calling the following methods:\n- agent.resolve(getIssueKeys(agent.getRuntime().getIssue()));\n for Agent objects\n- agency.resolve(getIssueKeys(agency.getRuntime().getIssue()));\n for Agency objects\n- esxAgentManager.resolve(getIssueKeys(esxAgentManager.getIssue()));\n for the EsxAgentManager object.\n\nRequires mod...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/eamObjectResolveAll" }, "task": true }, { "name": "esxAgentManagerCreateAgency", "summary": "Creates an Agency.", "description": "Creates an Agency.\n\nThe initial goal state is given to the method by the\nsecond parameter. Throws InvalidArgument if the\n agencyName is not set in the agencyConfigInfo .\n\nRequires modify privileges.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/esxAgentManagerCreateAgency" }, "task": true }, { "name": "esxAgentManagerGetMaintenanceModePolicy", "summary": "Obtains maintenance policy for for clusters not managed by vSphere\nLifecycle Manasger.", "description": "Obtains maintenance policy for for clusters not managed by vSphere\nLifecycle Manasger.\n\nSee also *EsxAgentManagerMaintenanceModePolicy_enum*.\n\n***Since:*** vEAM API 7.4", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/esxAgentManagerGetMaintenanceModePolicy" }, "task": true }, { "name": "esxAgentManagerQueryAgency", "summary": "An array of all *Agency* objects.", "description": "Deprecated use *EsxAgentManager.agency* instead.\n\nAn array of all *Agency* objects.\n\nIf called by a vCenter user with\nthe vCenter EAM.View or EAM.Modify privilege,\nthis returns all agencies registered in vSphere ESX Agent Manager. If\ncalled by a solution, this property only returns the agencies created by\nthe solution (and only those which have not been destroyed).\n\nRequires view privileges.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/esxAgentManagerQueryAgency" }, "task": true }, { "name": "esxAgentManagerQueryIssue", "summary": "Current issues that have been detected for this entity.", "description": "Current issues that have been detected for this entity.\n\nEach issue can be remediated\nby invoking *EamObject.Resolve* or *EamObject.ResolveAll*.\n\nRequires view privileges.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/esxAgentManagerQueryIssue" }, "task": true }, { "name": "esxAgentManagerResolve", "summary": "Resolves the issues specified in the input.", "description": "Resolves the issues specified in the input.\n\nIf an issue is remediable, ESX\nAgent Manager\ntries to resolve the misconfiguration that caused the issue. If it is not\nremediable, the offending issue is removed and ESX Agent Manager assumes that the issue has been\nresolved.\n\nRequires modify privileges.\n\nSee also *Issue*.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/esxAgentManagerResolve" }, "task": true }, { "name": "esxAgentManagerResolveAll", "summary": "Resolve all outstanding issues.", "description": "Resolve all outstanding issues.\n\nThe method calls *EamObject.Resolve*\nwith all issues the EsxAgentManager , Agency , or\n Agent have encountered. It is the equivalent of calling the following methods:\n- agent.resolve(getIssueKeys(agent.getRuntime().getIssue()));\n for Agent objects\n- agency.resolve(getIssueKeys(agency.getRuntime().getIssue()));\n for Agency objects\n- esxAgentManager.resolve(getIssueKeys(esxAgentManager.getIssue()));\n for the EsxAgentManager object.\n\nRequires mod...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/esxAgentManagerResolveAll" }, "task": true }, { "name": "esxAgentManagerScanForUnknownAgentVm", "summary": "Scans the vCenter inventory for any unknown agent virtual machine.", "description": "Deprecated presence of unknown VMs is no more acceptable.\n\nScans the vCenter inventory for any unknown agent virtual machine.\n\nAn\nissue is generated for each unknown agent virtual machine found during\nthis scan.\n\nRequires view privileges.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/esxAgentManagerScanForUnknownAgentVm" }, "task": true }, { "name": "esxAgentManagerSetMaintenanceModePolicy", "summary": "Configures maintenance mode policy for clusters not managed by vSphere\nLifecycle Manasger.", "description": "Configures maintenance mode policy for clusters not managed by vSphere\nLifecycle Manasger.\n\nSee also *EsxAgentManagerMaintenanceModePolicy_enum*.\n\n***Since:*** vEAM API 7.4", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/esxAgentManagerSetMaintenanceModePolicy" }, "task": true }, { "name": "esxAgentManagerGetAgency", "summary": "An array of all *Agency* objects.", "description": "An array of all *Agency* objects.\n\nIf called by a vCenter user with\nthe vCenter EAM.View or EAM.Modify privilege,\nthis returns all agencies registered in vSphere ESX Agent Manager. If\ncalled by a solution, this property only returns the agencies created by\nthe solution (and only those which have not been destroyed).\n\nRequires view privileges.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/esxAgentManagerGetAgency" }, "task": true }, { "name": "esxAgentManagerGetIssue", "summary": "Current issues that have been detected for this entity.", "description": "Deprecated this method is deprecated since the EAM object does not\nhandles issue anymore. At the moment the implementation\nreturns an empty array of issues.\n\nCurrent issues that have been detected for this entity.\n\nEach issue can be\nremediated by invoking *EamObject.Resolve* or\n*EamObject.ResolveAll*.\n\nRequires view privileges.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/esxAgentManagerGetIssue" }, "task": true }, { "name": "pbmComplianceManagerPbmCheckCompliance", "summary": "Checks compliance of the profiles associated with one or more\nvirtual machines and/or virtual disks.", "description": "Checks compliance of the profiles associated with one or more\nvirtual machines and/or virtual disks.\n\nThe Server stores the compliance results for all of the storage entities\nassociated with the virtual machines and disks. You can call the\n*PbmComplianceManager.PbmFetchComplianceResult* method\nto retrieve the stored results. However, for storage entities placed on vSAN,\nboth fetchComplianceResult and checkCompliance methods have the same\nbehaviour of recomputing the compliance.\n\n***Required priv...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/pbmComplianceManagerPbmCheckCompliance" }, "task": true }, { "name": "pbmComplianceManagerPbmCheckRollupCompliance", "summary": "Checks rollup compliance of virtual machines and returns the results to your\nclient.", "description": "Checks rollup compliance of virtual machines and returns the results to your\nclient.\n\nFor a specified virtual machine, a rollup compliance check verifies\nthe storage requirements of the virtual machine and its virtual disks as\ncompared with the storage provider capabilities.\n\nThe Server stores the compliance results for all of the storage entities\nassociated with the virtual machines. You can call the\n*PbmComplianceManager.PbmFetchRollupComplianceResult* method\nto retrieve the stored results. Ho...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/pbmComplianceManagerPbmCheckRollupCompliance" }, "task": true }, { "name": "pbmComplianceManagerPbmFetchComplianceResult", "summary": "Retrieves the latest version of *PbmComplianceResult* objects that are\navailable for the specified", "description": "Retrieves the latest version of *PbmComplianceResult* objects that are\navailable for the specified entities.\n\n***Required privileges:*** StorageProfile.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/pbmComplianceManagerPbmFetchComplianceResult" }, "task": true }, { "name": "pbmComplianceManagerPbmFetchRollupComplianceResult", "summary": "Retrieves the rollup compliance (*PbmRollupComplianceResult*)\nof the given virtual machines if pres", "description": "Retrieves the rollup compliance (*PbmRollupComplianceResult*)\nof the given virtual machines if present.\n\nThe returned rollup compliance\nresult may be old. Invoke checkRollupCompliance API to compute and retrieve the\nlatest rollup compliance result. For storage entities placed on vSAN the\nreturned compliance is always the latest.\n\n***Required privileges:*** StorageProfile.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/pbmComplianceManagerPbmFetchRollupComplianceResult" }, "task": true }, { "name": "pbmComplianceManagerPbmQueryByRollupComplianceStatus", "summary": "Returns the virtual machines for the given rollup compliance status.", "description": "Returns the virtual machines for the given rollup compliance status.\n\n***Required privileges:*** StorageProfile.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/pbmComplianceManagerPbmQueryByRollupComplianceStatus" }, "task": true }, { "name": "pbmPlacementSolverPbmCheckCompatibility", "summary": "Performs placement compatibility checking based on a storage requirement\nprofile.", "description": "Deprecated as of vSphere 2016, use *PbmPlacementSolver.PbmCheckRequirements* instead in order to retrieve compatibility status on both compute and storage\nlocation.\n\nPerforms placement compatibility checking based on a storage requirement\nprofile.\n\nIf compatibility checking for a hub does not produce any errors,\nthe hub is considered a viable candidate for virtual machine file storage.\nIf this method is invoked for\n*VVolDefaultProfile*\nprofile, then all the VVOL containers are returned as matchi...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/pbmPlacementSolverPbmCheckCompatibility" }, "task": true }, { "name": "pbmPlacementSolverPbmCheckCompatibilityWithSpec", "summary": "Performs placement compatibility checking based on a storage profile\nspecification.", "description": "Deprecated as of vSphere 2016, use *PbmPlacementSolver.PbmCheckRequirements* instead in order to retrieve compatibility status for both\ncompute and storage location.\n\nPerforms placement compatibility checking based on a storage profile\nspecification.\n\nIf compatibility checking for a hub does not produce\nany errors, the hub is considered a viable candidate for virtual\nmachine file storage.\n\n***Required privileges:*** StorageProfile.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/pbmPlacementSolverPbmCheckCompatibilityWithSpec" }, "task": true }, { "name": "pbmPlacementSolverPbmCheckRequirements", "summary": "Performs placement compatibility checking for the specified object to be placed based on its\nspecif", "description": "Performs placement compatibility checking for the specified object to be placed based on its\nspecified set of requirements.\n\nIf compatibility checking for a hub does not produce any\nerrors, the hub is considered a viable candidate for virtual machine storage.\n\n***Required privileges:*** StorageProfile.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/pbmPlacementSolverPbmCheckRequirements" }, "task": true }, { "name": "pbmPlacementSolverPbmQueryMatchingHub", "summary": "Finds matching placement hubs for the specified requirements profile.", "description": "Deprecated as of vSphere 2016, use *PbmPlacementSolver.PbmCheckRequirements*\ninstead in order to retrieve both compatible compute and storage location.\n\nFinds matching placement hubs for the specified requirements profile.\n\nThis\nmethod returns only those hubs that match the profile. If this method is\ninvoked for\n*VVolDefaultProfile*\nprofile, then all the VVOL containers are returned as matching.\n\n***Required privileges:*** StorageProfile.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/pbmPlacementSolverPbmQueryMatchingHub" }, "task": true }, { "name": "pbmPlacementSolverPbmQueryMatchingHubWithSpec", "summary": "Finds matching placement hubs based on a profile creation specification.", "description": "Deprecated as of vSphere 2016, use *PbmPlacementSolver.PbmCheckRequirements* instead in order to retrieve both compatible compute and storage location.\n\nFinds matching placement hubs based on a profile creation specification.\n\nThis method returns only those hubs that match the specification.\n\n***Required privileges:*** StorageProfile.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/pbmPlacementSolverPbmQueryMatchingHubWithSpec" }, "task": true }, { "name": "pbmProfileProfileManagerPbmAssignDefaultRequirementProfile", "summary": "Assign the given profile as the default profile for the given datastores.", "description": "Assign the given profile as the default profile for the given datastores.\n\nThis is an atomic operation. Either all the datastores will be assigned\nthe default profile or none will be.\nIn addition to StorageProfile.Update privilege, it requires\nDatastore.UpdateVirtualMachineFiles privilege on the given datastores to\nchange the default profile for the datastores. Otherwise a NoPermission\nfault is thrown.\n\n***Required privileges:*** StorageProfile.Update", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/pbmProfileProfileManagerPbmAssignDefaultRequirementProfile" }, "task": true }, { "name": "pbmProfileProfileManagerPbmCreate", "summary": "Creates a capability-based storage profile.", "description": "Creates a capability-based storage profile.\n\nA capability-based profile\ncontains requirements that are derived from tag-defined capabilities\nor from VMware VSAN capabilities.\n- Use the vSphere Web Client to define tags for capabilities.\n- VSAN storage capabilities are system-defined.\n\nA profile is a collection of subprofiles\n(*PbmCapabilitySubProfile*).\nA subprofile references storage capabilities and defines requirements\nbased on those capabilities.\n\nTo define a storage requirement, you speci...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/pbmProfileProfileManagerPbmCreate" }, "task": true }, { "name": "pbmProfileProfileManagerPbmDelete", "summary": "Deletes one or more profiles.", "description": "Deletes one or more profiles.\n\nIf the method successfully deletes a\nprofile, its identifier is no longer valid.\n\n***Required privileges:*** StorageProfile.Update", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/pbmProfileProfileManagerPbmDelete" }, "task": true }, { "name": "pbmProfileProfileManagerPbmFetchCapabilityMetadata", "summary": "Retrieves capability metadata.", "description": "Retrieves capability metadata.\n\nEach capability metadata object has a unique identifier\n(*PbmCapabilityMetadata*.*PbmCapabilityMetadata.id*).\nThe identifier object (*PbmCapabilityMetadataUniqueId*)\ncontains the unique ID and it identifies the namespace to which\nthe capability metadata object belongs.\n\nEach registered namespace is required to be globally unique.\nYou can associate a capability metadata object with a unique vendor and\nresource type by using the namespace and the\n*PbmCapabilityVendo...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/pbmProfileProfileManagerPbmFetchCapabilityMetadata" }, "task": true }, { "name": "pbmProfileProfileManagerPbmFetchCapabilitySchema", "summary": "Returns the capability schema objects registered in the system.", "description": "Returns the capability schema objects registered in the system.\n\n***Required privileges:*** StorageProfile.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/pbmProfileProfileManagerPbmFetchCapabilitySchema" }, "task": true }, { "name": "pbmProfileProfileManagerPbmFetchResourceType", "summary": "Retrieves information about various resource types registered with the system.", "description": "Retrieves information about various resource types registered with the system.\n\n***Required privileges:*** StorageProfile.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/pbmProfileProfileManagerPbmFetchResourceType" }, "task": true }, { "name": "pbmProfileProfileManagerPbmFetchVendorInfo", "summary": "Retrieve information about various capability metadata owners/vendors\nregistered with the system, t", "description": "Retrieve information about various capability metadata owners/vendors\nregistered with the system, the resource type for which they are registered,\nand schema namespaces to which they belong.\n\n***Required privileges:*** StorageProfile.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/pbmProfileProfileManagerPbmFetchVendorInfo" }, "task": true }, { "name": "pbmProfileProfileManagerPbmFindApplicableDefaultProfile", "summary": "Returns the profiles that can be made as default profile for all the given datastores.", "description": "Returns the profiles that can be made as default profile for all the given datastores.\n\nA profile can be made as a default profile for a datastore only if it contains a ruleset\nfrom the namespace the datastore belongs to.\n\n***Required privileges:*** StorageProfile.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/pbmProfileProfileManagerPbmFindApplicableDefaultProfile" }, "task": true }, { "name": "pbmProfileProfileManagerPbmQueryAssociatedEntities", "summary": "Returns the virtual machine and disks that are associated with the given\nstorage policies.", "description": "Returns the virtual machine and disks that are associated with the given\nstorage policies.\n\nIf the profiles parameter is empty, then this API returns\nall the virtual machine and disks that are associated with some storage\npolicy.\n\n***Required privileges:*** StorageProfile.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/pbmProfileProfileManagerPbmQueryAssociatedEntities" }, "task": true }, { "name": "pbmProfileProfileManagerPbmQueryAssociatedEntity", "summary": "Retrieves entities associated with the specified profile.", "description": "Retrieves entities associated with the specified profile.\n\n***Required privileges:*** StorageProfile.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/pbmProfileProfileManagerPbmQueryAssociatedEntity" }, "task": true }, { "name": "pbmProfileProfileManagerPbmQueryAssociatedProfile", "summary": "Returns identifiers for profiles associated with a virtual machine,\nvirtual disk, or datastore.", "description": "Returns identifiers for profiles associated with a virtual machine,\nvirtual disk, or datastore.\n\n***Required privileges:*** StorageProfile.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/pbmProfileProfileManagerPbmQueryAssociatedProfile" }, "task": true }, { "name": "pbmProfileProfileManagerPbmQueryAssociatedProfiles", "summary": "Returns profiles associated with the specified entities.", "description": "Returns profiles associated with the specified entities.\n\n***Required privileges:*** StorageProfile.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/pbmProfileProfileManagerPbmQueryAssociatedProfiles" }, "task": true }, { "name": "pbmProfileProfileManagerPbmQueryDefaultRequirementProfile", "summary": "Returns the default requirement profile ID for the given datastore.", "description": "Returns the default requirement profile ID for the given datastore.\n\nFor\nlegacy hub the API returns `null`.\n\n***Required privileges:*** StorageProfile.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/pbmProfileProfileManagerPbmQueryDefaultRequirementProfile" }, "task": true }, { "name": "pbmProfileProfileManagerPbmQueryDefaultRequirementProfiles", "summary": "Returns the default profiles for the given datastores.", "description": "Returns the default profiles for the given datastores.\n\nFor legacy\ndatastores we set `DefaultProfileInfo.defaultProfile` to\n`null`.\n\n***Required privileges:*** StorageProfile.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/pbmProfileProfileManagerPbmQueryDefaultRequirementProfiles" }, "task": true }, { "name": "pbmProfileProfileManagerPbmQueryProfile", "summary": "Returns requirement profile ids or resource profile ids, or both.", "description": "Returns requirement profile ids or resource profile ids, or both.\n\n***Required privileges:*** StorageProfile.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/pbmProfileProfileManagerPbmQueryProfile" }, "task": true }, { "name": "pbmProfileProfileManagerPbmQuerySpaceStatsForStorageContainer", "summary": "Retrieves space statistics of a datastore.", "description": "Retrieves space statistics of a datastore.\n\n***Required privileges:*** StorageProfile.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/pbmProfileProfileManagerPbmQuerySpaceStatsForStorageContainer" }, "task": true }, { "name": "pbmProfileProfileManagerPbmResetDefaultRequirementProfile", "summary": "Not supported in this release.", "description": "Deprecated since it is not supported.\n\nNot supported in this release.\n\n***Required privileges:*** StorageProfile.Update", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/pbmProfileProfileManagerPbmResetDefaultRequirementProfile" }, "task": true }, { "name": "pbmProfileProfileManagerPbmResetVSanDefaultProfile", "summary": "Resets the system pre-created VSAN default profile to factory defaults.", "description": "Resets the system pre-created VSAN default profile to factory defaults.\n\n***Required privileges:*** StorageProfile.Update", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/pbmProfileProfileManagerPbmResetVSanDefaultProfile" }, "task": true }, { "name": "pbmProfileProfileManagerPbmRetrieveContent", "summary": "Returns one or more storage profiles.", "description": "Returns one or more storage profiles.\n\n***Required privileges:*** StorageProfile.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/pbmProfileProfileManagerPbmRetrieveContent" }, "task": true }, { "name": "pbmProfileProfileManagerPbmUpdate", "summary": "Updates a storage profile.", "description": "Updates a storage profile.\n\n***Required privileges:*** StorageProfile.Update", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/pbmProfileProfileManagerPbmUpdate" }, "task": true }, { "name": "pbmReplicationManagerPbmQueryReplicationGroups", "summary": "Returns identifiers for replication groups associated with virtual machines, virtual\ndisks or virtu", "description": "Returns identifiers for replication groups associated with virtual machines, virtual\ndisks or virtual machines and all their disks.\n\nIf the query is performed for a virtual machine\nand all it's disks *virtualMachineAndDisks*, an entry per\ndisk and one for the virtual machine config will be returned.\n\n***Required privileges:*** StorageProfile.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/pbmReplicationManagerPbmQueryReplicationGroups" }, "task": true }, { "name": "pbmServiceInstancePbmRetrieveServiceContent", "summary": "Retrieves the properties of the Storage Policy service instance.", "description": "Retrieves the properties of the Storage Policy service instance.\n\n***Required privileges:*** System.Anonymous", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/pbmServiceInstancePbmRetrieveServiceContent" }, "task": true }, { "name": "pbmServiceInstanceGetContent", "summary": "Contains references to Storage Policy managed objects.", "description": "Contains references to Storage Policy managed objects.\n\n***Required privileges:*** System.Anonymous", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/pbmServiceInstanceGetContent" }, "task": true }, { "name": "smsProviderQueryProviderInfo", "summary": "Get provider information.", "description": "Get provider information.\n\n***Required privileges:*** StorageViews.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/smsProviderQueryProviderInfo" }, "task": true }, { "name": "smsServiceInstanceQueryAboutInfo", "summary": "Retrieves information about the service.", "description": "Retrieves information about the service.\n\n***Required privileges:*** StorageViews.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/smsServiceInstanceQueryAboutInfo" }, "task": true }, { "name": "smsServiceInstanceQuerySessionManager", "summary": "Retrieves SMS Session Manager managed object.", "description": "Retrieves SMS Session Manager managed object.\n\n***Required privileges:*** System.Anonymous", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/smsServiceInstanceQuerySessionManager" }, "task": true }, { "name": "smsServiceInstanceQueryStorageManager", "summary": "Retrieves Storage Manager managed object.", "description": "Retrieves Storage Manager managed object.\n\n***Required privileges:*** StorageViews.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/smsServiceInstanceQueryStorageManager" }, "task": true }, { "name": "smsStorageManagerQueryArray", "summary": "Get the list of storage arrays managed by all the registered VASA providers.", "description": "Get the list of storage arrays managed by all the registered VASA providers.\n\n***Required privileges:*** StorageViews.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/smsStorageManagerQueryArray" }, "task": true }, { "name": "smsStorageManagerQueryArrayAssociatedWithLun", "summary": "Get the StorageArray object that is associated with the\nScsiLun.", "description": "Get the StorageArray object that is associated with the\nScsiLun.\n\n***Required privileges:*** StorageViews.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/smsStorageManagerQueryArrayAssociatedWithLun" }, "task": true }, { "name": "smsStorageManagerQueryAssociatedBackingStoragePool", "summary": "Query Backing Storage Pools for StorageLun or StorageFileSystem.", "description": "Query Backing Storage Pools for StorageLun or StorageFileSystem.\n\n***Required privileges:*** StorageViews.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/smsStorageManagerQueryAssociatedBackingStoragePool" }, "task": true }, { "name": "smsStorageManagerQueryDatastoreBackingPoolMapping", "summary": "Query BackingStoragePools for the given set of datastores.", "description": "Query BackingStoragePools for the given set of datastores.\n\nAvailable information for all types of BackingStoragePools*BackingStoragePoolType_enum*\nfor every input datastore is returned as part of the result.\nMore than one datastore can map to same set of BackingStoragePools.\n\n***Required privileges:*** StorageViews.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/smsStorageManagerQueryDatastoreBackingPoolMapping" }, "task": true }, { "name": "smsStorageManagerQueryDatastoreCapability", "summary": "Get the capability for the given datastore.", "description": "Get the capability for the given datastore.\n\n***Required privileges:*** StorageViews.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/smsStorageManagerQueryDatastoreCapability" }, "task": true }, { "name": "smsStorageManagerQueryDrsMigrationCapabilityForPerformance", "summary": "Query the provider to figure out whether Storage DRS should\nmigrate VMDKs between the two given dat", "description": "Deprecated as of SMS API 3.0, use *SmsStorageManager.QueryDrsMigrationCapabilityForPerformanceEx*.\n\nQuery the provider to figure out whether Storage DRS should\nmigrate VMDKs between the two given datastores.\n\n***Required privileges:*** StorageViews.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/smsStorageManagerQueryDrsMigrationCapabilityForPerformance" }, "task": true }, { "name": "smsStorageManagerQueryDrsMigrationCapabilityForPerformanceEx", "summary": "Query available VASA providers for I/O performance based migration recommendations\nfor all pair com", "description": "Deprecated as of SMS API 5.0.\n\nQuery available VASA providers for I/O performance based migration recommendations\nfor all pair combinations of the given set of datastores.\n\nDatastore pairs for which\na recommendation cannot be obtained are not included in the result.\n\n***Required privileges:*** StorageViews.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/smsStorageManagerQueryDrsMigrationCapabilityForPerformanceEx" }, "task": true }, { "name": "smsStorageManagerQueryFaultDomain", "summary": "Query for fault domains based on the query spec.", "description": "Query for fault domains based on the query spec.\n\nIf spec is null, SMS\nwill return all the root fault domains only.\n\n***Required privileges:*** StorageViews.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/smsStorageManagerQueryFaultDomain" }, "task": true }, { "name": "smsStorageManagerQueryFileSystemAssociatedWithArray", "summary": "Get the StorageFileSystem data objects for the Array.", "description": "Get the StorageFileSystem data objects for the Array.\n\n***Required privileges:*** StorageViews.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/smsStorageManagerQueryFileSystemAssociatedWithArray" }, "task": true }, { "name": "smsStorageManagerQueryHostAssociatedWithLun", "summary": "Get HostSystem managed entities that share the StorageLun.", "description": "Get HostSystem managed entities that share the StorageLun.\n\n***Required privileges:*** StorageViews.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/smsStorageManagerQueryHostAssociatedWithLun" }, "task": true }, { "name": "smsStorageManagerQueryLunAssociatedWithArray", "summary": "Get the list of StorageLun data objects that for the Array.", "description": "Get the list of StorageLun data objects that for the Array.\n\n***Required privileges:*** StorageViews.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/smsStorageManagerQueryLunAssociatedWithArray" }, "task": true }, { "name": "smsStorageManagerQueryLunAssociatedWithPort", "summary": "Get the StorageLun data objects that are associated with StoragePort.", "description": "Get the StorageLun data objects that are associated with StoragePort.\n\n***Required privileges:*** StorageViews.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/smsStorageManagerQueryLunAssociatedWithPort" }, "task": true }, { "name": "smsStorageManagerQueryNfsDatastoreAssociatedWithFileSystem", "summary": "Get NFS datastore managed entity that are associated with\nStorageFileSystem.", "description": "Get NFS datastore managed entity that are associated with\nStorageFileSystem.\n\n***Required privileges:*** StorageViews.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/smsStorageManagerQueryNfsDatastoreAssociatedWithFileSystem" }, "task": true }, { "name": "smsStorageManagerQueryPortAssociatedWithArray", "summary": "Get the StoragePort data objects that are associated with Array.", "description": "Get the StoragePort data objects that are associated with Array.\n\n***Required privileges:*** StorageViews.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/smsStorageManagerQueryPortAssociatedWithArray" }, "task": true }, { "name": "smsStorageManagerQueryPortAssociatedWithLun", "summary": "Get the StoragePort data object that is associated with LUN.", "description": "Get the StoragePort data object that is associated with LUN.\n\n***Required privileges:*** StorageViews.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/smsStorageManagerQueryPortAssociatedWithLun" }, "task": true }, { "name": "smsStorageManagerQueryPortAssociatedWithProcessor", "summary": "Get the StoragePort data objects that are associated with Processor.", "description": "Get the StoragePort data objects that are associated with Processor.\n\n***Required privileges:*** StorageViews.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/smsStorageManagerQueryPortAssociatedWithProcessor" }, "task": true }, { "name": "smsStorageManagerQueryProcessorAssociatedWithArray", "summary": "Get the StorageProcessor data objects that are associated with Array.", "description": "Get the StorageProcessor data objects that are associated with Array.\n\n***Required privileges:*** StorageViews.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/smsStorageManagerQueryProcessorAssociatedWithArray" }, "task": true }, { "name": "smsStorageManagerQueryProvider", "summary": "Get the list of Providers that are currently registered\nwith StorageManager.", "description": "Get the list of Providers that are currently registered\nwith StorageManager.\n\n***Required privileges:*** StorageViews.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/smsStorageManagerQueryProvider" }, "task": true }, { "name": "smsStorageManagerQueryReplicationGroupInfo", "summary": "Query for replication group details based on the query filter spec.", "description": "Query for replication group details based on the query filter spec.\n\nThe replication\ngroup id list in the filter spec cannot be null or empty.\n\n***Required privileges:*** StorageViews.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/smsStorageManagerQueryReplicationGroupInfo" }, "task": true }, { "name": "smsStorageManagerQueryStorageContainer", "summary": "Query storage containers that are retrieved from VASA providers.", "description": "Query storage containers that are retrieved from VASA providers.\n\nStretched container with\nUNREPORTED sync status is not included in returned result.\n\n***Required privileges:*** StorageViews.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/smsStorageManagerQueryStorageContainer" }, "task": true }, { "name": "smsStorageManagerQueryVmfsDatastoreAssociatedWithLun", "summary": "Get VMFS Datastore managed entity that are associated with\nStorageLun.", "description": "Get VMFS Datastore managed entity that are associated with\nStorageLun.\n\n***Required privileges:*** StorageViews.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/smsStorageManagerQueryVmfsDatastoreAssociatedWithLun" }, "task": true }, { "name": "smsStorageManagerSmsRefreshCACertificatesAndCRLsTask", "summary": "SMS pushes the latest CA root certificates and CRLs to all registered VASA providers.", "description": "SMS pushes the latest CA root certificates and CRLs to all registered VASA providers.\n\n***Required privileges:*** StorageViews.ConfigureService", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/smsStorageManagerSmsRefreshCACertificatesAndCRLsTask" }, "task": true }, { "name": "smsStorageManagerRegisterProviderTask", "summary": "Register the provider and issue a sync operation on it.", "description": "Register the provider and issue a sync operation on it.\n\n***Required privileges:*** StorageViews.ConfigureService", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/smsStorageManagerRegisterProviderTask" }, "task": true }, { "name": "smsStorageManagerUnregisterProviderTask", "summary": "Unregister the provider.", "description": "Unregister the provider.\n\n***Required privileges:*** StorageViews.ConfigureService", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/smsStorageManagerUnregisterProviderTask" }, "task": true }, { "name": "smsTaskQuerySmsTaskInfo", "summary": "Get detailed information about this task.", "description": "Get detailed information about this task.\n\n***Required privileges:*** StorageViews.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/smsTaskQuerySmsTaskInfo" }, "task": true }, { "name": "smsTaskQuerySmsTaskResult", "summary": "Get the result of the task.", "description": "Get the result of the task.\n\n***Required privileges:*** StorageViews.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/smsTaskQuerySmsTaskResult" }, "task": true }, { "name": "vasaProviderFailoverReplicationGroupTask", "summary": "Failover the specified device groups.", "description": "Failover the specified device groups.\n\nThis function will always be called\nat the replication target location.\n\n***Required privileges:*** StorageViews.ConfigureService", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/vasaProviderFailoverReplicationGroupTask" }, "task": true }, { "name": "vasaProviderPrepareFailoverReplicationGroupTask", "summary": "Prepare to fail over the specified replication groups.", "description": "Prepare to fail over the specified replication groups.\n\nThis function is always\ncalled at the replication source location.\n\n***Required privileges:*** StorageViews.ConfigureService", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/vasaProviderPrepareFailoverReplicationGroupTask" }, "task": true }, { "name": "vasaProviderPromoteReplicationGroupTask", "summary": "Promotes the replication groups currently *INTEST*\nto *FAILEDOVER*.", "description": "Promotes the replication groups currently *INTEST*\nto *FAILEDOVER*.\n\nThis\nfunction must be called at the replication target location.\n\n***Required privileges:*** StorageViews.ConfigureService", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/vasaProviderPromoteReplicationGroupTask" }, "task": true }, { "name": "vasaProviderQueryActiveAlarm", "summary": "Query for the currently active alarms known to this VASA provider.", "description": "Query for the currently active alarms known to this VASA provider.\n\nProvider is expected to return Red and Yellow types of alarms only.\nNo Green alarms should be included in the result for this API.\n\n***Required privileges:*** StorageViews.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/vasaProviderQueryActiveAlarm" }, "task": true }, { "name": "vasaProviderQueryPointInTimeReplica", "summary": "Query for the point-in-time replicas available at the target location.", "description": "Query for the point-in-time replicas available at the target location.\n\n***Required privileges:*** StorageViews.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/vasaProviderQueryPointInTimeReplica" }, "task": true }, { "name": "vasaProviderQueryProviderInfo", "summary": "Get provider information.", "description": "Get provider information.\n\n***Required privileges:*** StorageViews.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/vasaProviderQueryProviderInfo" }, "task": true }, { "name": "vasaProviderQueryReplicationGroup", "summary": "Query for the replication group details.", "description": "Query for the replication group details.\n\n***Required privileges:*** StorageViews.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/vasaProviderQueryReplicationGroup" }, "task": true }, { "name": "vasaProviderQueryReplicationPeer", "summary": "Query for the replication peer fault domains.", "description": "Query for the replication peer fault domains.\n\n***Required privileges:*** StorageViews.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/vasaProviderQueryReplicationPeer" }, "task": true }, { "name": "vasaProviderVasaProviderReconnectTask", "summary": "Reconnect to the provider.", "description": "Reconnect to the provider.\n\nThis API will be used to reconnect to a provider that\nis in \"disconnected\" state. If reconnecting fails due to InvalidCertificate exception,\nthat means the current provider certificate is expired or corrupted. Then user has to\nrecover the provider following these steps:\n1\\. Unregister the provider using *SmsStorageManager.UnregisterProvider_Task*\n2\\. Provision a new self signed certificate for the provider\n3\\. Register the provider using *SmsStorageManager.RegisterPro...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/vasaProviderVasaProviderReconnectTask" }, "task": true }, { "name": "vasaProviderVasaProviderRefreshCertificateTask", "summary": "Refresh a CA signed certificate for the provider.", "description": "Refresh a CA signed certificate for the provider.\n\nThis API will be used when provider\ncertificate is about to expire, but still within soft or hard limit window. If the\nprovider is in \"disconnected\" state, this operation will be a no-op.\nNote: This API works only for providers that support VASA 2.0 and onwards.\n\n***Required privileges:*** StorageViews.ConfigureService", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/vasaProviderVasaProviderRefreshCertificateTask" }, "task": true }, { "name": "vasaProviderReverseReplicateGroupTask", "summary": "Initiate replication in the reverse way, making the currently\n*FAILEDOVER* devices as sources.", "description": "Initiate replication in the reverse way, making the currently\n*FAILEDOVER* devices as sources.\n\n***Required privileges:*** StorageViews.ConfigureService", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/vasaProviderReverseReplicateGroupTask" }, "task": true }, { "name": "vasaProviderVasaProviderRevokeCertificateTask", "summary": "Revoke CA signed certificate of the provider.", "description": "Revoke CA signed certificate of the provider.\n\nThis API will unregister the\nprovider automatically.\nNote: This API works only for providers that support VASA 2.0 and onwards.\n\n***Required privileges:*** StorageViews.ConfigureService", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/vasaProviderVasaProviderRevokeCertificateTask" }, "task": true }, { "name": "vasaProviderVasaProviderSyncTask", "summary": "Issue a sync for the given Storage Array.", "description": "Issue a sync for the given Storage Array.\n\n***Required privileges:*** StorageViews.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/vasaProviderVasaProviderSyncTask" }, "task": true }, { "name": "vasaProviderSyncReplicationGroupTask", "summary": "Synchronize the data between source and replica for the specified\nreplication group.", "description": "Synchronize the data between source and replica for the specified\nreplication group.\n\nThis function will always be called at the replication\ntarget location.\n\n***Required privileges:*** StorageViews.ConfigureService", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/vasaProviderSyncReplicationGroupTask" }, "task": true }, { "name": "vasaProviderTestFailoverReplicationGroupStartTask", "summary": "Start a test failover for the specified replication groups.", "description": "Start a test failover for the specified replication groups.\n\nThis\nfunction will always be called at the replication target location.\n\n***Required privileges:*** StorageViews.ConfigureService", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/vasaProviderTestFailoverReplicationGroupStartTask" }, "task": true }, { "name": "vasaProviderTestFailoverReplicationGroupStopTask", "summary": "Stop the ongoing test failover.", "description": "Stop the ongoing test failover.\n\nThis function will always be called at\nthe replication target location.\n\n***Required privileges:*** StorageViews.ConfigureService", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/vasaProviderTestFailoverReplicationGroupStopTask" }, "task": true }, { "name": "vslmServiceInstanceRetrieveContent", "summary": "Retrieves the properties of the Storage Lifecycle Management service\ninstance.", "description": "Retrieves the properties of the Storage Lifecycle Management service\ninstance.\n\n***Required privileges:*** System.Anonymous", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/vslmServiceInstanceRetrieveContent" }, "task": true }, { "name": "vslmServiceInstanceGetContent", "summary": "Contains references to Storage Lifecycle Management managed objects.", "description": "Contains references to Storage Lifecycle Management managed objects.\n\n***Required privileges:*** System.Anonymous", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/vslmServiceInstanceGetContent" }, "task": true }, { "name": "vslmSessionManagerVslmLoginByToken", "summary": "Login to the VSLM service by using SSO token.", "description": "Login to the VSLM service by using SSO token.\n\nVSLM will validate the user\ntoken from the context. The delegated token passed as a parameter will be\nused by VSLM to login to VC for authorization purposes.\nOnce login successfully returns, a new session is established for the\nclient. This session is only valid for the lifetime of the supplied\ndelegated token. Any calls made on a session which exceeds this lifetime\nwill result in a SecurityError. The client is expected to logout of the\ncurrent sess...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/vslmSessionManagerVslmLoginByToken" }, "task": true }, { "name": "vslmSessionManagerVslmLogout", "summary": "Logs out of the VSLM Service.", "description": "Logs out of the VSLM Service.\n\n***Required privileges:*** StoragLifecycle.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/vslmSessionManagerVslmLogout" }, "task": true }, { "name": "vslmStorageLifecycleManagerVslmQueryDatastoreInfo", "summary": "Query the mapping of *Datacenter* and *Datastore*\nfor a specified datastore url.", "description": "Query the mapping of *Datacenter* and *Datastore*\nfor a specified datastore url.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/vslmStorageLifecycleManagerVslmQueryDatastoreInfo" }, "task": true }, { "name": "vslmStorageLifecycleManagerVslmSyncDatastore", "summary": "Sync the FCD info on the passed in datastore.", "description": "Sync the FCD info on the passed in datastore.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/vslmStorageLifecycleManagerVslmSyncDatastore" }, "task": true }, { "name": "vslmTaskVslmCancelTask", "summary": "Cancel a running or queued task.", "description": "Cancel a running or queued task.\n\nA task may only be canceled if it is\ncancelable. Multiple cancel requests will be treated as a single\ncancellation request. Canceling a completed task will throw an\nInvalidState exception.\n\nIf a task is canceled, its runtime state will be set to\n*error* and the *VslmTaskInfo.cancelled* flag will\nbe set to true.\n\nA cancel operation is asynchronous. The operation may return before the\ntask is canceled.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/vslmTaskVslmCancelTask" }, "task": true }, { "name": "vslmTaskVslmQueryInfo", "summary": "Get detailed information about this task.", "description": "Get detailed information about this task.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/vslmTaskVslmQueryInfo" }, "task": true }, { "name": "vslmTaskVslmQueryTaskResult", "summary": "Get the result of the task.", "description": "Get the result of the task.", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/vslmTaskVslmQueryTaskResult" }, "task": true }, { "name": "vslmVStorageObjectManagerVslmAttachDiskTask", "summary": "Attach an existing disk to this virtual machine.", "description": "Attach an existing disk to this virtual machine.\n\nA minimum virtual machine version of 'vmx-13' is required for this\noperation to succeed. If a compatible VM version is not satisfied,\na *DeviceUnsupportedForVmVersion* fault will be thrown.\n\n*VslmSyncFault* will set in the task error if the\nthe FCD was attached successfully in the backend, however, there\nwas a failure in syncing the datastore or FCD. The attach disk\noperation is not idempotent, implying, any attempt to re-attach\nthe FCD to the sa...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/vslmVStorageObjectManagerVslmAttachDiskTask" }, "task": true }, { "name": "vslmVStorageObjectManagerVslmAttachTagToVStorageObject", "summary": "Attach a tag to a virtual storage object.", "description": "Attach a tag to a virtual storage object.\n\nRequires privilege InventoryService.Tagging.AttachTag on root folder\n\n***Required privileges:*** System.Read", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/vslmVStorageObjectManagerVslmAttachTagToVStorageObject" }, "task": true }, { "name": "vslmVStorageObjectManagerVslmClearVStorageObjectControlFlags", "summary": "Clear control flags on VStorageObject.", "description": "Clear control flags on VStorageObject.\n\nThe control flags are defined in\n*vslmVStorageObjectControlFlag_enum*.\n\nRequires Datastore.FileManagement privilege on the datastore where the\nvirtual storage object is located.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/vslmVStorageObjectManagerVslmClearVStorageObjectControlFlags" }, "task": true }, { "name": "vslmVStorageObjectManagerVslmCloneVStorageObjectTask", "summary": "Clone a virtual storage object.", "description": "Clone a virtual storage object.\n\nRequires Datastore.FileManagement privilege on both source and\ndestination datastore.\n\n*VslmSyncFault* will set in the task error if the\ncloneVStorageObject completed successfully but the datastore\nsynchronization failed.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/vslmVStorageObjectManagerVslmCloneVStorageObjectTask" }, "task": true }, { "name": "vslmVStorageObjectManagerVslmCreateDiskTask", "summary": "Create a virtual disk, which is a storage object with\n*disk*\nas consumption type.", "description": "Create a virtual disk, which is a storage object with\n*disk*\nas consumption type.\n\nRequires Datastore.FileManagement privilege on the datastore where the\nvirtual disk object is created.\n\n*VslmSyncFault* will set in the task error if the\ncreateDisk completed successfully in the backed but the datastore\nsynchronization or FCD retrieval failed. The sync fault can be ignored\nwith the risk of Pandora not recognizing the FCD or Pandora DB\nmissing the FCD, consequently, affecting the return of\n*VslmVSt...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/vslmVStorageObjectManagerVslmCreateDiskTask" }, "task": true }, { "name": "vslmVStorageObjectManagerVslmCreateDiskFromSnapshotTask", "summary": "Creates a new Disk from given snapshot of a VStorageObject.", "description": "Creates a new Disk from given snapshot of a VStorageObject.\n\nRequires Datastore.FileManagement privilege.\n\n*VslmSyncFault* will set in the task error if the\ncreateDiskFromSnapshot completed successfully but the datastore\nsynchronization failed.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/vslmVStorageObjectManagerVslmCreateDiskFromSnapshotTask" }, "task": true }, { "name": "vslmVStorageObjectManagerVslmCreateSnapshotTask", "summary": "Creates a snapshot of a given VStorageObject.", "description": "Creates a snapshot of a given VStorageObject.\n\nRequires Datastore.FileManagement privilege.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/vslmVStorageObjectManagerVslmCreateSnapshotTask" }, "task": true }, { "name": "vslmVStorageObjectManagerVslmDeleteSnapshotTask", "summary": "Deletes a given snapshot of a VStorageObject.", "description": "Deletes a given snapshot of a VStorageObject.\n\nRequires Datastore.FileManagement privilege.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/vslmVStorageObjectManagerVslmDeleteSnapshotTask" }, "task": true }, { "name": "vslmVStorageObjectManagerVslmDeleteVStorageObjectTask", "summary": "Delete a virtual storage object and its associated backings.", "description": "Delete a virtual storage object and its associated backings.\n\nRequires Datastore.FileManagement privilege on the datastore where the\nvirtual storage object is located.\n\n*VslmSyncFault* will set in the task error if the\ndelete of the FCD succeeded in the backend, however, there was a\nissue with syncing the datastore. The error can be ignored with\nthe anticipation of Pandora resolving this automatically and the\nrisk of Pandora DB having stale FCDs consequently affecting the\nreturn of *VslmVStorage...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/vslmVStorageObjectManagerVslmDeleteVStorageObjectTask" }, "task": true }, { "name": "vslmVStorageObjectManagerVslmDetachTagFromVStorageObject", "summary": "Detach a tag from a virtual storage object.", "description": "Detach a tag from a virtual storage object.\n\nRequires privilege InventoryService.Tagging.AttachTag on root folder\n\n***Required privileges:*** System.Read", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/vslmVStorageObjectManagerVslmDetachTagFromVStorageObject" }, "task": true }, { "name": "vslmVStorageObjectManagerVslmExtendDiskTask", "summary": "Expand the capacity of a virtual disk, which is a storage object with\n*disk*, to the new\ncapacity.", "description": "Expand the capacity of a virtual disk, which is a storage object with\n*disk*, to the new\ncapacity.\n\nIf new capacity is smaller than current disk capacity, then\noperation fails due to invalid capacity. If new capacity is greater\nthan current disk capacity, then operation proceeds. If new capacity\nis equal to current disk ccapcity, then operation succeeds without\nany actual extension.\nThe extended disk region will be the same as the original disk:\n\\- For a zerothick disk, the extended disk region ...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/vslmVStorageObjectManagerVslmExtendDiskTask" }, "task": true }, { "name": "vslmVStorageObjectManagerVslmInflateDiskTask", "summary": "Inflate a sparse or thin-provisioned virtual disk up to the full size.", "description": "Inflate a sparse or thin-provisioned virtual disk up to the full size.\n\nAdditional space allocated to the disk as a result of this operation\nwill be filled with zeros.\n\nCurrently inflateDisk API only supports the following combinations:\nValid provisioning type: THIN;\nValid Datastore: VMFS, NFS.\nInflating a disk is not applicable for VVol/VSAN datastore.\n\nRequires Datastore.FileManagement privilege on the datastore where the\nvirtual storage object is located.\n\n***Required privileges:*** System.Vi...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/vslmVStorageObjectManagerVslmInflateDiskTask" }, "task": true }, { "name": "vslmVStorageObjectManagerVslmListTagsAttachedToVStorageObject", "summary": "Lists all tags attached to virtual storage object.", "description": "Lists all tags attached to virtual storage object.\n\n***Required privileges:*** System.Read", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/vslmVStorageObjectManagerVslmListTagsAttachedToVStorageObject" }, "task": true }, { "name": "vslmVStorageObjectManagerVslmListVStorageObjectsAttachedToTag", "summary": "Lists all virtual storage objects attached to the tag.", "description": "Lists all virtual storage objects attached to the tag.\n\n***Required privileges:*** System.Read", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/vslmVStorageObjectManagerVslmListVStorageObjectsAttachedToTag" }, "task": true }, { "name": "vslmVStorageObjectManagerVslmListVStorageObjectForSpec", "summary": "List virtual storage objects matching all the\n*VslmVsoVStorageObjectQuerySpec*.", "description": "List virtual storage objects matching all the\n*VslmVsoVStorageObjectQuerySpec*.\n\nThe results are determined\nby ANDing the *VslmVsoVStorageObjectQuerySpec* while ORing each\nof the values specified as a part of the\n*VslmVsoVStorageObjectQuerySpec.queryValue* field. Currently,\nonly a single value in *VslmVsoVStorageObjectQuerySpec.queryValue*\nis supported.\nExpect that not all results will be returned. If all results are not\nreturned, *VslmVsoVStorageObjectQueryResult.allRecordsReturned*\nflag will b...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/vslmVStorageObjectManagerVslmListVStorageObjectForSpec" }, "task": true }, { "name": "vslmVStorageObjectManagerVslmQueryChangedDiskAreas", "summary": "Get a list of areas of a virtual disk that have been modified since a\nwell-defined point in the pas", "description": "Get a list of areas of a virtual disk that have been modified since a\nwell-defined point in the past.\n\nThe beginning of the change interval is\nidentified by \"changeId\", while the end of the change interval is implied\nby the snapshot ID passed in.\n\nNote that the result of this function may contain \"false positives\"\n(i.e: flag areas of the disk as modified that are not). However, it is\nguaranteed that no changes will be missed.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/vslmVStorageObjectManagerVslmQueryChangedDiskAreas" }, "task": true }, { "name": "vslmVStorageObjectManagerVslmQueryGlobalCatalogSyncStatus", "summary": "Gets the synchronization status of the Global Catalog.", "description": "Gets the synchronization status of the Global Catalog.\n\nThis API returns an\narray of DatastoreSyncStatuses showing the synchronization status for each\ndatastore currently being tracked by the Global Catalog. This can be used\nto see if the Global Catalog search results are fully up-to-date and also to\ncheck if the Global Catalog is making progress on bringing a datastore's\ninformation up to date.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "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": "/vslmVStorageObjectManagerVslmQueryGlobalCatalogSyncStatus" }, "task": true }, { "name": "vslmVStorageObjectManagerVslmQueryGlobalCatalogSyncStatusForDatastore", "summary": "Gets the synchronization state of the Global Catalog for the specified datastore.", "description": "Gets the synchronization state of the Global Catalog for the specified datastore.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/vslmVStorageObjectManagerVslmQueryGlobalCatalogSyncStatusForDatastore" }, "task": true }, { "name": "vslmVStorageObjectManagerVslmReconcileDatastoreInventoryTask", "summary": "Reconcile the datastore inventory info of virtual storage objects.", "description": "Reconcile the datastore inventory info of virtual storage objects.\n\nRequires Datastore.FileManagement privilege.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/vslmVStorageObjectManagerVslmReconcileDatastoreInventoryTask" }, "task": true }, { "name": "vslmVStorageObjectManagerVslmRegisterDisk", "summary": "Promote a virtual disk to a First Class Disk.", "description": "Promote a virtual disk to a First Class Disk.\n\nRequires Datastore.FileManagement privilege on the datastore where the\nvirtual disk resides.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/vslmVStorageObjectManagerVslmRegisterDisk" }, "task": true }, { "name": "vslmVStorageObjectManagerVslmRelocateVStorageObjectTask", "summary": "Relocate a virtual storage object.", "description": "Relocate a virtual storage object.\n\nRequires Datastore.FileManagement privilege on both source and\ndestination datastore.\n\n*VslmSyncFault* will set in the task error if the\nrelocateVStorageObject completed successfully but the datastore\nsynchronization failed.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/vslmVStorageObjectManagerVslmRelocateVStorageObjectTask" }, "task": true }, { "name": "vslmVStorageObjectManagerVslmRenameVStorageObject", "summary": "Rename a virtual storage object.", "description": "Rename a virtual storage object.\n\n*VslmSyncFault* is thrown when\nthe underlying rename operation of the FCD succeeded, however, there\nwas a issue with syncing the datastore or FCD. Rename operation of the\nFCD is not idempotent, implying, any attempt to rename the FCD with it's\ncurrent name would result in a error. The sync fault can be ignored\nwith the risk of Pandora DB having stale name, consequently,\naffecting the return of *VslmVStorageObjectManager.VslmListVStorageObjectForSpec*\nand *VslmVS...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/vslmVStorageObjectManagerVslmRenameVStorageObject" }, "task": true }, { "name": "vslmVStorageObjectManagerVslmRetrieveSnapshotDetails", "summary": "Retrieves snapshot disk details of a given snapshot.", "description": "Retrieves snapshot disk details of a given snapshot.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/vslmVStorageObjectManagerVslmRetrieveSnapshotDetails" }, "task": true }, { "name": "vslmVStorageObjectManagerVslmRetrieveSnapshotInfo", "summary": "Retrieves snapshot information of a given VStorageObject.", "description": "Retrieves snapshot information of a given VStorageObject.\n\nRequires Datastore.FileManagement privilege.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/vslmVStorageObjectManagerVslmRetrieveSnapshotInfo" }, "task": true }, { "name": "vslmVStorageObjectManagerVslmRetrieveVStorageInfrastructureObjectPolicy", "summary": "Retrieve FCD infrastructure object SBPM policy on given datastore.", "description": "Retrieve FCD infrastructure object SBPM policy on given datastore.\n\nOnly support VSAN datastore.\n\nRequires Datastore.FileManagement privilege on the datastore where the\nvirtual storage infrastructure object is located.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/vslmVStorageObjectManagerVslmRetrieveVStorageInfrastructureObjectPolicy" }, "task": true }, { "name": "vslmVStorageObjectManagerVslmRetrieveVStorageObject", "summary": "Retrieve a virtual storage object.", "description": "Retrieve a virtual storage object.\n\nRequires Datastore.FileManagement privilege on the datastore where the\nvirtual storage object is located.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/vslmVStorageObjectManagerVslmRetrieveVStorageObject" }, "task": true }, { "name": "vslmVStorageObjectManagerVslmRetrieveVStorageObjectAssociations", "summary": "Retrieve vm associations for each virtual storage object in the query.", "description": "Retrieve vm associations for each virtual storage object in the query.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/vslmVStorageObjectManagerVslmRetrieveVStorageObjectAssociations" }, "task": true }, { "name": "vslmVStorageObjectManagerVslmRetrieveVStorageObjectMetadata", "summary": "Retrieve metadata KV pairs from a virtual storage object.", "description": "Retrieve metadata KV pairs from a virtual storage object.\n\nRequires Datastore.FileManagement privilege on the datastore where the\nvirtual storage object is located.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/vslmVStorageObjectManagerVslmRetrieveVStorageObjectMetadata" }, "task": true }, { "name": "vslmVStorageObjectManagerVslmRetrieveVStorageObjectMetadataValue", "summary": "Retrieve the metadata value by key from a virtual storage object.", "description": "Retrieve the metadata value by key from a virtual storage object.\n\nRequires Datastore.FileManagement privilege on the datastore where the\nvirtual storage object is located.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/vslmVStorageObjectManagerVslmRetrieveVStorageObjectMetadataValue" }, "task": true }, { "name": "vslmVStorageObjectManagerVslmRetrieveVStorageObjectState", "summary": "Retrieve a virtual storage object state.", "description": "Retrieve a virtual storage object state.\n\nRequires Datastore.FileManagement privilege on the datastore where the\nvirtual storage object is located.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/vslmVStorageObjectManagerVslmRetrieveVStorageObjectState" }, "task": true }, { "name": "vslmVStorageObjectManagerVslmRetrieveVStorageObjects", "summary": "Retrieves details of a list of virtual storage objects from cache.", "description": "Retrieves details of a list of virtual storage objects from cache.\n\nRequires Datastore.FileManagement privilege on the datastore where the\nvirtual storage object is located.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/vslmVStorageObjectManagerVslmRetrieveVStorageObjects" }, "task": true }, { "name": "vslmVStorageObjectManagerVslmRevertVStorageObjectTask", "summary": "Reverts to a given snapshot of a VStorageObject.", "description": "Reverts to a given snapshot of a VStorageObject.\n\nThis operation is supported on detached VirtualDisks\nDuring revert all the snapshots which were taken after the specified\nsnapshot would get deleted.\n\nE.g. Consider Disk with 4 snapshots\n\nBaseDisk -$gt; Snap-2 -$gt; Snap-3 -$gt; Snap-4 -$gt; Running-Point\n\nIf user chooses to revert to snap-2 then snap-4 and snap-3 would also\nbe deleted. After revert operation disk would have below configuration:\n\nBaseDisk -$gt; Snap-2 -$gt; Running-Point\n\nRequire...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/vslmVStorageObjectManagerVslmRevertVStorageObjectTask" }, "task": true }, { "name": "vslmVStorageObjectManagerVslmScheduleReconcileDatastoreInventory", "summary": "Schedules reconcile of the inventory info of virtual storage objects on\none of the hosts that is co", "description": "Schedules reconcile of the inventory info of virtual storage objects on\none of the hosts that is connected with the datastore.\n\nThis method just\nschedules the reconcile operation for the nearby future and returns. Note\nthat since the reconcile operation will be executed after this method\nalready returns the success of this method should not be considered as\nsuccess of the actual reconcile operation.\n\nRequires Datastore.FileManagement privilege.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/vslmVStorageObjectManagerVslmScheduleReconcileDatastoreInventory" }, "task": true }, { "name": "vslmVStorageObjectManagerVslmSetVStorageObjectControlFlags", "summary": "Set control flags on VStorageObject.", "description": "Set control flags on VStorageObject.\n\nThe control flags are defined in\n*vslmVStorageObjectControlFlag_enum*.\n\nRequires Datastore.FileManagement privilege on the datastore where the\nvirtual storage object is located.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/vslmVStorageObjectManagerVslmSetVStorageObjectControlFlags" }, "task": true }, { "name": "vslmVStorageObjectManagerVslmUpdateVStorageInfrastructureObjectPolicyTask", "summary": "Assigns specified SBPM policy to the given FCD infrastructure object.", "description": "Assigns specified SBPM policy to the given FCD infrastructure object.\n\nOnly support VSAN datastore.\n\nRequires Datastore.FileManagement privilege on the datastore where the\nvirtual storage infrastructure object is located.\n\n*VslmSyncFault* will set in the task error if the\nupdateVStorageInfrastructureObjectPolicy completed successfully\nbut the datastore synchronization failed.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/vslmVStorageObjectManagerVslmUpdateVStorageInfrastructureObjectPolicyTask" }, "task": true }, { "name": "vslmVStorageObjectManagerVslmUpdateVstorageObjectCryptoTask", "summary": "Update the storage crypto on a virtual storage object.", "description": "Update the storage crypto on a virtual storage object.\n\nRequires Datastore.FileManagement privilege on the datastore where the\nvirtual storage object is located.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/vslmVStorageObjectManagerVslmUpdateVstorageObjectCryptoTask" }, "task": true }, { "name": "vslmVStorageObjectManagerVslmUpdateVStorageObjectMetadataTask", "summary": "Update metadata KV pairs to a virtual storage object.", "description": "Update metadata KV pairs to a virtual storage object.\n\nAnd this API is by\ndesign supposed to be used for all of the addition, modification and\ndeletion operations of metadata KV pairs.\n\nRequires Datastore.FileManagement privilege on the datastore where the\nvirtual storage object is located.\n\n*VslmSyncFault* will set in the task error if the\nupdateVStorageObjectMetadata completed successfully but the datastore\nsynchronization or FCD retrieval failed. The sync fault can\nbe ignored with the risk of...(description truncated)", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/vslmVStorageObjectManagerVslmUpdateVStorageObjectMetadataTask" }, "task": true }, { "name": "vslmVStorageObjectManagerVslmUpdateVstorageObjectPolicyTask", "summary": "Update the storage policy on a virtual storage object.", "description": "Update the storage policy on a virtual storage object.\n\nRequires Datastore.FileManagement privilege on the datastore where the\nvirtual storage object is located.\n\n***Required privileges:*** System.View", "input": [ { "name": "moId", "type": "string", "info": "A unique identifier (within this vCenter Server instance) for a specific managed object such as `group-d1` or `vm-015` or `ServiceInstance`.: string", "required": true, "schema": { "title": "moId", "type": "string" } }, { "name": "body", "type": "object", "info": ": object", "required": true, "schema": { "type": "object", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/vslmVStorageObjectManagerVslmUpdateVstorageObjectPolicyTask" }, "task": true } ], "views": [] }